diff --git "a/txt-clean-pdf-without-outline-all2-onefile/feko.txt" "b/txt-clean-pdf-without-outline-all2-onefile/feko.txt" new file mode 100644--- /dev/null +++ "b/txt-clean-pdf-without-outline-all2-onefile/feko.txt" @@ -0,0 +1,216784 @@ +Intellectual Property Rights Notice +Copyright © 1986-2023 Altair Engineering Inc. All Rights Reserved. +This Intellectual Property Rights Notice is exemplary, and therefore not exhaustive, of intellectual +property rights held by Altair Engineering Inc. or its affiliates. Software, other products, and materials +of Altair Engineering Inc. or its affiliates are protected under laws of the United States and laws of +other jurisdictions. In addition to intellectual property rights indicated herein, such software, other +products, and materials of Altair Engineering Inc. or its affiliates may be further protected by patents, +additional copyrights, additional trademarks, trade secrets, and additional other intellectual property +rights. For avoidance of doubt, copyright notice does not imply publication. Copyrights in the below are +held by Altair Engineering Inc. or its affiliates. Additionally, all non-Altair marks are the property of their +respective owners. +This Intellectual Property Rights Notice does not give you any right to any product, such as software, +or underlying intellectual property rights of Altair Engineering Inc. or its affiliates. Usage, for example, +of software of Altair Engineering Inc. or its affiliates is governed by and dependent on a valid license +agreement. +Altair Simulation Products +Altair® AcuSolve® ©1997-2023 +Altair Activate® ©1989-2023 +Altair® Battery Designer™ ©2019-2023 +Altair Compose® ©2007-2023 +Altair® ConnectMe™ ©2014-2023 +Altair® EDEM™ ©2005-2023 +Altair® ElectroFlo™ ©1992-2023 +Altair Embed® ©1989-2023 +Altair Embed® SE ©1989-2023 +Altair Embed®/Digital Power Designer ©2012-2023 +Altair Embed® Viewer ©1996-2023 +Altair® ESAComp® ©1992-2023 +Altair® Feko® ©1999-2023 +Altair® Flow Simulator™ ©2016-2023 +Altair® Flux® ©1983-2023 +Altair® FluxMotor® ©2017-2023 +Altair® HyperCrash® ©2001-2023 +Altair® HyperGraph® ©1995-2023 +Altair® HyperLife® ©1990-2023 +p.iii +Altair Feko 2022.3 +Intellectual Property Rights Notice +Altair® HyperSpice™ ©2017-2023 +Altair® HyperStudy® ©1999-2023 +Altair® HyperView® ©1999-2023 +Altair® HyperViewPlayer® ©2022-2023 +Altair® HyperWorks® ©1990-2023 +Altair® HyperXtrude® ©1999-2023 +Altair® Inspire™ ©2009-2023 +Altair® Inspire™ Cast ©2011-2023 +Altair® Inspire™ Extrude Metal ©1996-2023 +Altair® Inspire™ Extrude Polymer ©1996-2023 +Altair® Inspire™ Form ©1998-2023 +Altair® Inspire™ Mold ©2009-2023 +Altair® Inspire™ PolyFoam ©2009-2023 +Altair® Inspire™ Print3D ©2021-2023 +Altair® Inspire™ Render ©1993-2023 +Altair® Inspire™ Studio ©1993-2023 +Altair® Material Data Center™ ©2019-2023 +Altair® MotionSolve® ©2002-2023 +Altair® MotionView® ©1993-2023 +Altair® Multiscale Designer® ©2011-2023 +Altair® nanoFluidX® ©2013-2023 +Altair® OptiStruct® ©1996-2023 +Altair® PollEx™ ©2003-2023 +Altair® PSIM™ ©2022-2023 +Altair® Pulse™ ©2020-2023 +Altair® Radioss® ©1986-2023 +Altair® romAI™ ©2022-2023 +Altair® S-FRAME® ©1995-2023 +Altair® S-STEEL™ ©1995-2023 +Altair® S-PAD™ ©1995-2023 +Altair® S-CONCRETE™ ©1995-2023 +Altair® S-LINE™ ©1995-2023 +Altair® S-TIMBER™ ©1995-2023 +p.iv +Altair Feko 2022.3 +Intellectual Property Rights Notice +Altair® S-FOUNDATION™ ©1995-2023 +Altair® S-CALC™ ©1995-2023 +Altair® S-VIEW™ ©1995-2023 +Altair® Structural Office™ ©2022-2023 +Altair® SEAM® ©1985-2023 +Altair® SimLab® ©2004-2023 +Altair® SimLab® ST ©2019-2023 +Altair SimSolid® ©2015-2023 +Altair® ultraFluidX® ©2010-2023 +Altair® Virtual Wind Tunnel™ ©2012-2023 +Altair® WinProp™ ©2000-2023 +Altair® WRAP™ ©1998-2023 +Altair® GateVision PRO™ ©2002-2023 +Altair® RTLvision PRO™ ©2002-2023 +Altair® SpiceVision PRO™ ©2002-2023 +Altair® StarVision PRO™ ©2002-2023 +Altair® EEvision™ ©2018-2023 +Altair Packaged Solution Offerings (PSOs) +Altair® Automated Reporting Director™ ©2008-2022 +Altair® e-Motor Director™ ©2019-2023 +Altair® Geomechanics Director™ ©2011-2022 +Altair® Impact Simulation Director™ ©2010-2022 +Altair® Model Mesher Director™ ©2010-2023 +Altair® NVH Director™ ©2010-2023 +Altair® NVH Full Vehicle™ ©2022-2023 +Altair® NVH Standard™ ©2022-2023 +Altair® Squeak and Rattle Director™ ©2012-2023 +Altair® Virtual Gauge Director™ ©2012-2023 +Altair® Weld Certification Director™ ©2014-2023 +Altair® Multi-Disciplinary Optimization Director™ ©2012-2023 +Altair HPC & Cloud Products +Altair® PBS Professional® ©1994-2023 +Altair® PBS Works™ ©2022-2023 +p.v +Altair Feko 2022.3 +Intellectual Property Rights Notice +Altair® Control™ ©2008-2023 +Altair® Access™ ©2008-2023 +Altair® Accelerator™ ©1995-2023 +Altair® Accelerator™ Plus ©1995-2023 +Altair® FlowTracer™ ©1995-2023 +Altair® Allocator™ ©1995-2023 +Altair® Monitor™ ©1995-2023 +Altair® Hero™ ©1995-2023 +Altair® Software Asset Optimization (SAO) ©2007-2023 +Altair Mistral™ ©2022-2023 +Altair® Grid Engine® ©2001, 2011-2023 +Altair® DesignAI™ ©2022-2023 +Altair Breeze™ ©2022-2023 +Altair® NavOps® ©2022-2023 +Altair® Unlimited™ ©2022-2023 +Altair Data Analytics Products +Altair Analytics Workbench™ © 2002-2023 +Altair® Knowledge Studio® ©1994-2023 +Altair® Knowledge Studio® for Apache Spark ©1994-2023 +Altair® Knowledge Seeker™ ©1994-2023 +Altair® Knowledge Hub™ ©2017-2023 +Altair® Monarch® ©1996-2023 +Altair® Panopticon™ ©2004-2023 +Altair® SmartWorks™ ©2021-2023 +Altair SLC™ ©2002-2023 +Altair SmartWorks Hub™ ©2002-2023 +Altair® RapidMiner® ©2001-2023 +Altair One™ ©1994-2023 +2022.3 +March 17, 2023 +Technical Support +Altair provides comprehensive software support via web FAQs, tutorials, training classes, telephone, and +e-mail. +Altair One Customer Portal +Altair One (https://altairone.com/) is Altair’s customer portal giving you access to product downloads, a +Knowledge Base, and customer support. We recommend that all users create an Altair One account and +use it as their primary portal for everything Altair. +When your Altair One account is set up, you can access the Altair support page via this link: +www.altair.com/customer-support/ +Altair Community +Participate in an online community where you can share insights, collaborate with colleagues and peers, +and find more ways to take full advantage of Altair’s products. +Visit the Altair Community (https://community.altair.com/community) where you can access online +discussions, a knowledge base of product information, and an online form to contact Support. After you +login to the Altair Community, subscribe to the forums and user groups to get up-to-date information +about release updates, upcoming events, and questions asked by your fellow members. +These valuable resources help you discover, learn and grow, all while having the opportunity to network +with fellow explorers like yourself. +Altair Training Classes +Altair’s in-person, online, and self-paced trainings provide hands-on introduction to our products, +focusing on overall functionality. Trainings are conducted at our corporate and regional offices or at your +facility. +For more information visit: https://learn.altair.com/ +If you are interested in training at your facility, contact your account manager for more details. If you +do not know who your account manager is, contact your local support office and they will connect you +with your account manager. +Telephone and E-mail +If you are unable to contact Altair support via the customer portal, you may reach out to technical +support via phone or e-mail. Use the following table as a reference to locate the support office for your +region. +Altair support portals are available 24x7 and our global support engineers are available during normal +Altair business hours in your region. +When contacting Altair support, specify the product and version number you are using along with +a detailed description of the problem. It is beneficial for the support engineer to know what type +of workstation, operating system, RAM, and graphics board you have, so include that in your +Altair Feko 2022.3 +Technical Support +p.vii +Location +Australia +Brazil +Canada +China +France +Germany +Greece +India +Israel +Italy +Japan +Malaysia +Mexico +New Zealand +South Africa +South Korea +Spain +Sweden +Telephone +E-mail ++61 3 9866 5557 +anzsupport@altair.com ++55 113 884 0414 +br_support@altair.com ++1 416 447 6463 +support@altairengineering.ca ++86 400 619 6186 +support@altair.com.cn ++33 141 33 0992 +francesupport@altair.com ++49 703 162 0822 +hwsupport@altair.de ++30 231 047 3311 +eesupport@altair.com ++91 806 629 4500 +support@india.altair.com ++1 800 425 0234 (toll free) ++39 800 905 595 +support@altairengineering.it +israelsupport@altair.com ++81 3 6225 5830 +jp-support@altair.com ++60 32 742 7890 +aseansupport@altair.com ++52 55 5658 6808 +mx-support@altair.com ++64 9 413 7981 +anzsupport@altair.com ++27 21 831 1500 +support@altair.co.za ++82 704 050 9200 +support@altair.co.kr ++34 910 810 080 +support-spain@altair.com ++46 46 460 2828 +support@altair.se +United Kingdom ++44 192 646 8600 +support@uk.altair.com +United States ++1 248 614 2425 +hwsupport@altair.com +If your company is being serviced by an Altair partner, you can find that information on our web site at +https://www.altair.com/PartnerSearch/. +See www.altair.com for complete information on Altair, our team, and our products. +Scripts and Application +Programming Interface (API) +1 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. +This chapter covers the following: +• 1.1 Introduction to Scripting and the API (p. 10) +• 1.2 Script Editor (p. 11) +• 1.3 Macro Recording (p. 13) +• 1.4 Scripting Basics (p. 14) +• 1.5 Script Types (p. 24) +• 1.6 Custom Dialogs (Forms) (p. 50) +• 1.7 Application Macros (p. 52) +1.1 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. +The scripting interface, or application programming interface (API), also allow you to control CADFEKO +and POSTFEKO from an external script. This interface is similar to Visual Basic for Applications (VBA). +Editing scripts is easy with the integrated script editor that includes many development tools such a +break points and the ability to pause an executing script. +There are many Lua modules available on the internet that can be installed and integrated into Feko. +By using the LuaCOM Lua module it is possible to control applications such as Excel and Word using the +component object model (COM) interface. There are also many modules for performing calculations on +results or reading (or writing) data from (or to) files in CSV or XML format (using LuaExpat). +It is recommended that you familiarise yourself with basic scripting before starting with a new scripting +project. There are a number of useful demonstrations to reduce development time. +Related concepts +CADFEKO API +POSTFEKO API +1.2 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. +On the Home tab, in the Scripting group, click the + Script editor icon. +The script editor includes the following IDE (integrated development environment) features: +1. Syntax highlighting. +2. +3. +Intelligent code completion. +Indentation for blocks to convey program structure, for example, loops and decision blocks in +scripts. +4. Use of breakpoints and stepping in scripts to debug code or control its execution. +5. An active console to query variables or execute simple commands. +Figure 1: The script editor in CADFEKO. +Figure 2: The script editor in POSTFEKO. +1.3 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. +On the Home tab, in the Scripting group, click the + Record Macro icon. +1.4 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. +1.4.1 Lua Language Essentials +Learn the basic Lua language concepts by viewing small extracts of executable Lua code. +These examples should not be considered an exhaustive description of the Lua language, but rather as +a very basic introduction. +View the following resource for more information: +• Lua 5.1 Reference Manual[1] +• Programming in Lua[2] +• Lua-users wiki[3] +Comments +There are two methods to add a comment to Lua code. +single line comment +The single line comment is started with “--” and terminates at the end of the line. +multi line comment +The multi line comment is started with “--[[” and terminates with “]]”. +-- This is a single line comment +--[[ This is +a multi line comment]] +Variable Assignments +Variable assignments in Lua are case sensitive. +Note: Variable definitions in CADFEKO and EDITFEKO are case insensitive. +-- Note: All number types are doubles. There are no integers. +print(type(42), type(42.0)) -- prints out "number number" +variable_one = 1 + 2 - 3 -- This will equal zero. +1. http://www.lua.org/manual/5.1/ +2. http://www.lua.org/pil/ +3. http://lua-users.org/wiki/ +variable_One = "Variables are case sensitive." +a, b = 42, 101 --multiple assignment +a, b = b, a --provides quick value swap +x, y, z = 1, 2, 3, "this value is discarded" +x, y, z, mytext = 1, 2, 3, "this value is discarded" +Strings +Simple string assignment and concatenation can be performed directly in Lua. More advanced string +manipulation is available using the string module (included as part of the Feko installation). +Strings are concatenated using two full stops (“..”). The “#” operator returns the length of the string. +The string module should be used for more advanced string manipulation such as substitutions. +print("Here is a string" .. ' concatenated with ' .. 2 .. ' other strings. ' ) +a = ' hello ' +print( ' The # operator says there are ' .. #a .. ' letters in " ' .. a .. ' ". ' ) +print(a .. ' becomes ' .. string.gsub(a, ' h ' , ' y ' )) +Boolean and Nil +Variables can be assigned the boolean values, true or false. Boolean arithmetic can be performed on +boolean values using not, and and or. +When variables are not assigned any value, they are equal to nil. Lua often complains about a nil +value when you tries to use a variable that has not yet been defined or initialised. +bool_variable = true and false or true and not false +print(uninitialised_variable == nil) -- prints true, all vars start as nil +print(nil == 0 or nil == "") -- prints false, nil is not the same as 0 or an empty + string +Tables +Tables in Lua can be dictionaries or arrays. +Arrays are special dictionaries where the index is automatically assigned and the first value is at index +1. The “#” operator also works for arrays, but it will not result in the correct value for tables such as +dictionaries in general. +An inspect function is available as part of Lua in Feko that allows you to easily view the contents of a +table. +an_array = {1,1,2,3,5,8,13} +print(#an_array) -- prints "7" +print(an_array[3]) -- prints "2" +a_table = {[ ' bread ' ] = "brown", [ ' eggs ' ] = 10} -- tables are dictionaries or + arrays +print(a_table[ ' bread ' ]) -- "prints brown" +print(a_table) -- prints "table: 0x7f63c8001200", the memory location of the table +inspect(a_table) -- prints the contents of the table +print(#a_table) -- prints "0" since it is not an array (take note) +IF Statement +An if statement executes a block of code if a specified condition is true. +a = math.random() +b = math.random() +if a < b then +print("Variable a (" .. a ..") is smaller than variable b (" .. b .. ").") +print( a == b ) -- prints false +print( a ~= b ) -- prints true +elseif a > b then +print("Variable a (" .. a ..") is larger than variable b (" .. b .. ").") +else +print("Variable a is equal to variable b.") +end +Note: This example uses another useful Lua module, math, to generate a random number +for two variables. +WHILE Loop +A While loop performs a test at the beginning of every loop. +m = 0 +while m < 5 do +print("While loop count " .. m) +m = m + 1 -- there is no m++ or m += 1 +end +REPEAT Loops +A repeat loop performs the test condition at the end of every loop and will execute at least one loop. +Note: Use a break statement to terminate a repeat loop before the end condition is +satisfied. +m = 0 +repeat +m = m+1 +print("Repeat loops check the condition at end, and stops if it is true.") +print("The value of m is " .. m) +if (math.random()*10 > 5) then +print("A random number larger than 5 was generated. Terminating the loop early.") +break -- breaks out of the loop early +end +until m == 5 +FOR Loops +A For loop is used to iterate over a predefined set of numbers, iterate over the key and value pairs of a +dictionary or the values of an array. +Note: The function, ForAllValues, is available for iterating of over all axes of a dataset. +for i = 1, 3 do + for j = 0, 9, 3 do + print("for loops add 1 to i and 3 to j during each iteration " .. i .. ' ' .. + j) + end +end +myDict = {["bread"] = "brown", ["eggs"] = 12} +for key, val in pairs(myDict) do + print(key .. " " .. val) +end +myArray = {1,1,2,3,5,8,13} +for key, val in pairs(myArray) do + print(key .. " " .. val) +end +Functions +A function is a group of statements that carry out a specific task (procedure) or a function can calculate +and return values. +function myFunction(name) +print( ' Hello ' .. name) +var1 = 100 +local var2 = 99 +return "returns nil if you don ' t have a return statement." +end +myFunction( ' Feko user ' ) +print(var1) -- prints 100 +print(var2) -- prints nil, since var2 does not exist outside the function +It is important to note the scope of any local and global variable definitions. +Tip: Use local variable definitions as far as possible. +Batch Modification of API Objects +Some API objects allow batch modification of properties. Objects that support batch modification will +have a SetProperties method that accepts a dictionary (Lua table) of properties. +Batch modifications are performed as a single operation and may be required in situations where there +are multiple properties that need to change and they have a dependency on each other. +Batch modification is best explained using examples. The examples below are equivalent and the result +is the same. The cuboid object is used as an example. +Example 1 +The code extract creates a cuboid and then modifies it by modifying each property individually. +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a cuboid with its base corner at the specified ' Point ' +corner = cf.Point(-0.25, -0.25, 0) +cube = project.Contents.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25) +-- Modify the cuboid +cube.Depth = 2 +cube.Height = 2 +cube.Depth = 2 +cube.Origin.U = 2.5 +cube.Origin.V = -0.5 +cube.Origin.N = 1 +Example 2 +The code extract performs the same operations as for Example 1, but the modification is done as a +single operation. A GetProperties method is available that allows you to get access to the settings of +an object, make the required changes and then set the properties using SetProperties. +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a cuboid with its base corner at the specified ' Point ' +corner = cf.Point(-0.25, -0.25, 0) +cube = project.Contents.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25) +-- Modify the cuboid +newSettings = cube:GetProperties() +newSettings.Depth = "2" +newSettings.Height = "2" +newSettings.LocalWorkplane.LocalDefinedWorkplane.Origin.X = "2.5" +newSettings.LocalWorkplane.LocalDefinedWorkplane.Origin.Y = "-0.5" +newSettings.LocalWorkplane.LocalDefinedWorkplane.Origin.Z = "1" +cube:SetProperties(newSettings) +Since the batch modification using the SetProperties method performs the validation and updates the +object in a single step, there is a performance gain (not visible for such a small example). The default +properties for an object can be accessed using the GetDefaultProperties method. +Default Lua Modules Included By Default +A number of Lua modules are included by default. +The following modules are included: +math +string +A math library that supports most common math functions. +A string manipulation library. +table +os +io +A table manipulation library. +A library that allows users to access the operating system environment and files. +A input-output module for reading and writing files. +debug +A debug module for locating problems in scripts. +Useful Lua Modules Not Included By Default +The Feko installation also includes a number of modules that are not included by default with all Lua +distributions, but are useful for many scripting applications +Although these modules are included as part of the installation, they still need to be loaded or required +when the are used in a script. Modules are included in a script by using the require command. +require( ' luacom ' ) +The modules available as part of the Feko installation includes the following: +LuaCOM +The Feko installation (Windows paltform) includes the “LuaCOM” module. The “LuaCOM” module +allows users to control applications that follow Microsoft’s Component Object Model (COM) +specification. The following two examples illustrate how “LuaCOM” is used to control Microsoft +Excel. These examples require a compatible version of Excel to be installed. For more information +regarding the COM interface for Microsoft Office components, consult the object model references +available at the Microsoft MSDN[4] website. +-- COM example 1 +require( ' luacom ' ) +excel = luacom.CreateObject("Excel.Application") +excel.Visible = true +wb = excel.Workbooks:Add() +ws = wb.Worksheets(1) +for i=1, 20 do +ws.Cells(i,1).Value2 = i +end +-- COM example 2 +require "luacom" +excel = luacom.CreateObject("Excel.Application") +local book = excel.Workbooks:Add() +local sheet = book.Worksheets(1) +excel.Visible = true +for row=1, 30 do +sheet.Cells(row, 1).Value2 = math.floor(math.random() * 100) +end +4. https://msdn.microsoft.com/en-us/ +local chart = excel.Charts:Add() +chart.ChartType = 4 +local range = sheet:Range("A1:A30") +chart:SetSourceData(range) +LuaFileSystem +LuaFileSystem offers a portable way to access the underlying directory structure and file +attributes. The module name that needs to be included is “ lfs ”. +LuaXml +LuaXML provides a minimal set of functions for the processing of XML data. The module name that +needs to be included is “ luaxml ”. +PenLight +The PenLight module is a collection of common lua code patterns for tables, arrays, strings, paths +and directories, data, and functional programming. The module name that needs to be included is +“ pl ”. +winapi +This module provides some basic tools for working with Windows systems such as accessing the +registry, finding out system resources, and gives you more control over process creation. +Global Keywords Recognised in the Lua Editor +A selection of global keywords recognised in the Lua editor, as well as additional functionality are +highlighted. +Complex +The “Complex” object adds complex number support to the scripting interface. +Matrix +The “Matrix” object adds support for fast matrix manipulation to the scripting interface. +ComplexMatrix +The “ComplexMatrix” object adds support for fast matrix manipulation for complex numbers to the +scripting interface. +There are several keywords (other than the standard Lua keywords) recognised by the editor. These +include, but are not limited to: +Table 1: Global keywords recognised in the Lua editor. +cf +pf +The main interface between the Lua scripting +environment and CADFEKO. The cf namespace is +used to pull the CADFEKO application into the Lua +environment for further processing. Type cf. to +get started. +The main interface between the Lua scripting +environment and POSTFEKO. The pf namespace +is used to pull the POSTFEKO application into the +inspect +printlist +i, j +cf.Complex, pf.Complex +cf.Point, pf.Point +SESSION_PATH +SESSION_NAME +FEKO_HOME +FEKO_USER_HOME +Lua environment for further processing. Type pf. +to get started. +A function similar to print that displays the +contents of any table that can be broken down +into basic components. Output can be seen in the +output window of the editor. +A function that prints out the contents of key/ +value pairs. Output can be seen in the output +window of the editor. +Predefined constants for +. +An object class that helps manage complex +numbers. +An object class that helps manage points in 3D +space. +The path to where the POSTFEKO session is stored +for a math script environment. +Name of the POSTFEKO session stored. +The Feko installation directory. +The Feko user directory. +API Scripts that Run In Both CADFEKO and POSTFEKO +Scripts can be written such that they work both in CADFEKO and POSTFEKO. +The following example is written so that it creates a Form dialog displaying the phrase “Hello world!” in +CADFEKO. +form = cf.Form.New("Demonstration") +label = cf.FormLabel.New("Hello world!") +form:Add(label) +form:Run() +Running the same script would fail in POSTFEKO, since the “cf” interface is not available. The script can +be extended to run in either application by prepending it with a single line: +cf = cf or pf +This tells the script that if the CADFEKO interface (“cf”) is unavailable, that the POSTFEKO interface +(“pf”) should be used instead. Any alias can be specified, meaning that an even more neutral name can +be given. +feko = cf or pf +form = feko.Form.New("Demonstration") +label = feko.FormLabel.New("Hello world!") +form:Add(label) +form:Run() +Here the alias “feko” was used. +Note: Text highlighting and auto-completion will only work on the interface that is defined +for a given application. +CADFEKO is not be able to interpret uniquely POSTFEKO commands, nor is POSTFEKO able to interpret +commands that are unique to CADFEKO. +External Lua Modules +External Lua modules can be installed and included in the Lua search path. +The search path for scripts and libraries are set on the Default settings dialog. Open the application +menu and click Settings > Preferences > Default settings > Scripting. +Figure 3: The Default settings dialog. +1.5 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. +1.5.1 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. +Example POSTFEKO API Script +The easiest way to understand and get started with scripting is by analysing a working example. As part +of the example, a number of important aspects are highlighted. The example can be copied into the +script editor and executed as part of the demonstration. +Open a Model +The first part of the example will get hold of the POSTFEKO application object, create a new project +session and load a model. Try to understand what the script does and then read the section that +explains the script. +app = pf.GetApplication() +app:NewProject() +FEKO_HOME = os.getenv("FEKO_HOME") +print("Feko is installed in " .. FEKO_HOME) +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +printlist(app.Models:Items()) +The code extract starts by accessing and storing the application object, using the GetApplication static +function that is available under the pf namespace . All functions, objects, constants and enumerations +are available in the pf namespace, although a subset of these are also globally available. These were +added in a namespace so that they will not be replaced when loading external libraries. The namespace +also makes it easier to use the auto completion feature in the editor (type pf. in the editor to see the +auto completion menu). The application objects are stored in a variable app to make it easier to access +further down in the script. +The NewProject() method of the Application object is then executed to create a new POSTFEKO +project (session). +Note: That the method is accessed using a colon (:) and to access the static function use a +full stop(.). +The FEKO_HOME environment variable is stored in a new variable by utilising the os (operating system) +module’s getenv method. The os module is included as part of the Feko installation. The value of the +variable is then printed to the screen for validation. +The OpenFile method of the Application object is then used to load the startup model (a +demonstration model that is part of all Feko installations). Finally the models that have been loaded are +printed to screen as confirmation that the model has indeed loaded correctly. +If the script is executed, POSTFEKO should have the startup model loaded. The rest of the example will +illustrate basic tasks that can be performed using the startup model. +Access the Model Configuration +The start and end frequency of the first (and only) configuration of the model is accessed and printed to +the console in the next script example. This example follows on the previous example and assumes that +it is executed in the same script. +c1 = app.Models["startup"].Configurations[1] +print(c1.EndFrequency) +print(c1.StartFrequency) +A variable, c1, is used to store a link to the first configuration of the model. The model that has +been loaded is accessed using the Models property of the Application object. Properties, like static +functions, are accessed using a full stop as indicated in the example. The Models property returns a +collection. There are many collections in the POSTFEKO API, but the collections work the same and have +the same methods and operators associated with them. An item in the collection is accessed by name or +by index using the square bracket indexing ([]). +The example uses both indexing methods since it indexes the model by name and the configuration by +number. The same result is achieved by accessing both the model and the configuration by name or by +number. +The start and end frequency for the configuration is printed to demonstrate the model information is +accessed. +Note: That it was not necessary to store the configuration in variable c1, but it makes it +easier and shorter to access the configuration further down in the script. +Create and Customise a Cartesian Graph +The following script extract creates a Cartesian graph, sets background and grid colours. The minor grid +is also enabled for the graph. +cg = app.CartesianGraphs:Add() +cg.BackColour = pf.Enums.ColourEnum.Transparent +cg.Grid.BackColour = pf.Enums.ColourEnum.LightGrey +cg.Grid.Minor.Visible = true +cg.Grid.Minor.HorizontalLine.Style = pf.Enums.LineStyleEnum.SolidLine +cg.Grid.Minor.VerticalLine.Style = pf.Enums.LineStyleEnum.DashDotDotLine +cg.Grid.Major.HorizontalLine.Colour = pf.Enums.ColourEnum.Black +cg.Grid.Major.VerticalLine.Colour = pf.Enums.ColourEnum.Black +The only new concept that is introduced in this script extract is the use of enumerations to access +predefined colours and line styles. Enumerations are accessed using the pf.Enums namespace. +Add a Trace to a Graph +The graph has been created, but it does not contain any data. The next script extract will add the first +near field in the model configuration to the Cartesian graph. The legend, horizontal and vertical titles +are also styled. +cg.Traces:Add(c1.NearFields[1]) +cg.Legend.Frame.BackColour = pf.Enums.ColourEnum.Transparent +cg.HorizontalAxis.Title.Frame.Line.Colour = pf.Enums.ColourEnum.Blue +cg.VerticalAxis.Title.Frame.Line.Colour = pf.Enums.ColourEnum.Blue +Generate a PDF Report +The final script extract will create a PDF report and save it to disk. Once the report has been generated +it will also be displayed. +report = + app:CreateQuickReport([[Example_report]], pf.Enums.ReportDocumentTypeEnum.PDF) +report.DocumentHeading = "Example report" +report:Generate() +This example only illustrates a small subset of what can be done using the POSTFEKO application +programming interface. Use this script as a starting point to explore other features that are available in +the API. +1.5.2 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. +It is like any other result that is imported or read from the result file (.bof file). An important +distinction between result scripts and general scripts are that result scripts are always stored as part of +the POSTFEKO session, almost like the data has been imported into the session. By default result scripts +runs each time one or more of the result files ( .bof files) change. This allows users to manipulate or +combine simulation results and imported data producing new results that is available for visualisation in +POSTFEKO. +Pulling Data Into the Math Scripting Environment +A common use for the scripting functionality is to modify existing POSTFEKO results. +As such, it is necessary to get a handle on a result, defined as a DataSet, into the scripting +environment. For example, to get a handle on either of the near fields in a session, the key string is +used in conjunction with the GetDataSet function. The key string is in the format: +"[Model].[Configuration].[Request Name]" +The following code prints a list of all near field results in the session. The name of the near field +contained in the Horn model is used to get a handle on the result, which is returned without any further +processing. The result can be displayed in POSTFEKO for further visualisation. +names = pf.NearField.GetNames() +printlist(names) +nearfield = pf.NearField.GetDataSet("Horn.StandardConfiguration1.NearFields") +return nearfield +1: "Horn.StandardConfiguration1.NearField1" +2: "startup.Configuration1.NearFields" +To create a near field math script. +1. Open the Horn.fek file in POSTFEKO +2. On the Home tab, in the Scripting group, click the +select the + Near field icon. +3. Modify the code (optional). +4. Click on the + Run script icon. +Structure of a DataSet + New script icon. From the drop-down list +In order to modify or generate a DataSet, it is important to understand how they are constructed. +The structure of a DataSet contains three types of data: +• Axes refer to the independent axes along which data can be plotted in a view. +• Quantities refer to the types of data that can be plotted along a specified axis. +• MetaData refers to additional data that pertains to a DataSet that affects how POSTFEKO interprets +the DataSet. +Figure 4: Visualisation of the DataSet. +The additional data field refers to the actual values of the results. The indexing of the data is dependent +on the structure of the axes and quantities that were defined. Since the data fields should not be +accessed directly, it is not discussed here. Rather, the discussion of the proper access methods will +follow. +Table 2 shows all of the base units currently supported by POSTFEKO. For all Axes and Quantities, +the units need to be specified to help ensure that POSTFEKO knows how to manage the values. More +complex units may be constructed out of the base unit from the table by using the operators / and ˆ. +For example, acceleration can be written as m/sˆ2. +Data can also consist of different types of data. Table 3 indicates the supported data types. +Table 2: Supported units +Quantity +Distance +Angle +Frequency +Time +Proprietary Information of Altair Engineering +Unit +inch +feet +mile +mil +deg +rad +Hz +min +Unit +Ohm +Description +Any real valued data. +Complex values; values containing real and +imaginary components. +Either a true or false value. +Quantity +Mass +Temperature +Current +Charge +Force +Potential difference +Resistance +Conductivity +Power +Capacitance +Inductance +Table 3: Supported data types +Data type +scalar +complex +boolean +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 4. 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 4: Axis types for the Axes field +Axis type +Position +Axes field +Theta +Phi +Rho +Axis type +Frequency axis +Other axes +Axes field +Frequency +Arbitrary +Index +MediumNames +PortNumber +Solution +S-parameter +Undefined +Time +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. +For example, the +complex quantities. All of these quantities are valid at the same physical position and frequency. +Looking again at the near field example of a horn antenna, the structure of Quantities are illustrated. + components of an electric near field would be stored as three separate + and + , +nf = pf.NearField.GetDataSet("Horn.StandardConfiguration1.NearField1") +for index, quantity in pairs(nf.Quantities) do + print(string.format("quantity[%d]: '%s' is a %s quantity that is measured in '%s'", + index, + quantity.Name, + quantity.QuantityType, + quantity.Unit)) +end +quantity[1]: ' EFieldComp1 ' is a Complex quantity that is measured in ' V/m ' +quantity[2]: ' EFieldComp2 ' is a Complex quantity that is measured in ' V/m ' +quantity[3]: ' EFieldComp3 ' is a Complex quantity that is measured in ' V/m ' +quantity[4]: ' HFieldComp1 ' is a Complex quantity that is measured in ' A/m ' +quantity[5]: ' HFieldComp2 ' is a Complex quantity that is measured in ' A/m ' +quantity[6]: ' HFieldComp3 ' is a Complex quantity that is measured in ' A/m ' +quantity[7]: ' MediumIndex ' is a Scalar quantity that is measured in '' +The quantities contained in this near field are the three components of both the electric and magnetic +field. These values are specified at every dimension for the specified Axes values. In order to specify a +near field component, complex values must be used. The units are specified as + for the electric near + for the magnetic components. If we were to inspect the entire DataSet , a +field components and +single data point would then contain values for each of the seven quantity fields stored in the DataSet. +A DataSet may contain any quantity. However, if the DataSet is to be used as an internal type, the +minimum quantities required for POSTFEKO to interpret the data correctly must be present. For +instance, a near field must contain either a complete set of electric field components or a complete set +of magnetic field components in order to be valid. This restriction only applies to a DataSet that will be +used as though it is a near field calculated by the Feko kernel. +MetaData +In addition to Axes and Quantities, it may be required to provide additional information about a +DataSet. +The MetaData help identify the following properties of a DataSet: +• Indicates if the DataSet was defined in a local coordinate system (for near and far fields) and the +format of the local system. +• Indicates if a near field calculation was defined, using the conical coordinate system and its radial +step size. +• The names of the media that pertain to the medium index stored in some near fields. +Note: These properties are not required to define a valid near field, only if the property in +question is relevant. +Processing and Modifying a DataSet +A typical use for the scripting functionality is to modify existing results. +The steps to process and modify a DataSet. +1. Create and simulate a model. +2. Create a math script: +i. +Pull a single result or multiple results into the script. +ii. Perform processing on the results in the scripting environment. +iii. Store the results of the script in a DataSet that is accessible in the POSTFEKO session. +3. Display and process the results. +These steps assume that a valid DataSet is pulled in and being manipulated. Therefore, it is not +necessary to create or modify any of the Axes, Quantities or MetaData fields. The data stored in +the DataSet must simply be accessed and modified. However, the data block in a DataSet cannot be +accessed directly. Instead, an indexing scheme is available with which to reach an element. +Related concepts +Structure of a DataSet +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. +Each axis in a DataSet contains a set number of values. By specifying the index of each value on an +axis, the values can be accessed. +nearField[1][1][1][1].EFieldComp1 = nearField[1][1][1][1].EFieldComp1 * 2 +The previous command multiplies the value + at the first frequency, at the first indexed point in space. +By iterating through all of the axes, it is possible to selectively modify specific values based on the index + from the Z axis is set to 0. Save the +of the axes. In the following example, all fields further than +script as modNF_indiv.lua for use in future examples. +-- Create the near field dataset +nf = pf.NearField.GetDataSet("Horn.StandardConfiguration1.NearField1") +for freq = 1, #nf.Axes[1] do + for xPos = 1, #nf.Axes[2] do + for yPos = 1, #nf.Axes[3] do + for zPos = 1, #nf.Axes[4] do + if ( math.sqrt(nf.Axes[2][xPos]^2 + nf.Axes[3][yPos]^2) >= 0.15 ) then + nfPoint = nf[freq][xPos][yPos][zPos]; + nfPoint.EFieldComp1 = 0 + 0*i + nfPoint.EFieldComp2 = 0 + 0*i + nfPoint.EFieldComp3 = 0 + 0*i + nfPoint.HFieldComp1 = 0 + 0*i + nfPoint.HFieldComp2 = 0 + 0*i + nfPoint.HFieldComp3 = 0 + 0*i + end + end + end + end +end +return nf +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. +Expressions can become difficult to work with, a simple pf.DataSet.ForAllValues method is provided +iterating through a DataSet. This method is particularly useful when a script should iterate over an +unknown number of axes. +The ForAllValues method accepts the following parameters: +Value function +This is the name of the function that will be executed while +looping over all the axes. The function used in ForAllValues +must adhere to a predefined format discussed below. +Target DataSet +Additional parameters +The target DataSet is used to determine the axes that will be +iterated over. All of the indices in the target DataSet will be +reached. It is also typically the result that will be modified. +Any number of additional parameters can be included and will be +passed on to the value function. The additional parameters can be +Lua values, tables or other DataSet results. +The value function used in the ForAllValues call must be defined with the following parameters: +Index +Target +This parameter is always required and its value will be determined +by the ForAllValues function. The index allows the DataSet to +be accessed as if it were reshaped into a 1D vector. This is as +opposed to the single element indexing described previously, +where the DataSet is indexed like a multidimensional array. The +value function is called by the ForAllValues function for each +axes entry and with every call the index parameter is updated. +The target DataSet that is supplied to the ForAllValues function +is passed on to the value function in this parameter. This is the +DataSet that determines the axes that will be looped over. +Additional parameters +Any additional parameters that were added to ForAllValues +function call will be passed on to the value function. +The following example illustrates the use of the ForAllValues function and its accompanying value +function definition. +nf1 = pf.NearField.GetDataSet("Horn.StandardConfiguration1.NearField1") +nf2 = pf.NearField.GetDataSet("modNF_indiv") +nfAverage = pf.NearField.GetDataSet("modNF_indiv") +function average(index, target, source1, source2) + target[index].EFieldComp1 = 0.5*(source1[index].EFieldComp1 + + source2[index].EFieldComp1) + target[index].EFieldComp2 = 0.5*(source1[index].EFieldComp2 + + source2[index].EFieldComp2) + target[index].EFieldComp3 = 0.5*(source1[index].EFieldComp3 + + source2[index].EFieldComp3) + target[index].HFieldComp1 = 0.5*(source1[index].HFieldComp1 + + source2[index].HFieldComp1) + target[index].HFieldComp2 = 0.5*(source1[index].HFieldComp2 + + source2[index].HFieldComp2) + target[index].HFieldComp3 = 0.5*(source1[index].HFieldComp3 + + source2[index].HFieldComp3) +end +pf.DataSet.ForAllValues(average, nfAverage, nf1, nf2) +return nfAverage +Note: That in this example, it was never necessary to define a loop. Instead, a function +is written that explains what should happen to a given element. Any number of DataSet +sources can be provided as source inputs. The result of the calculation is then stored in the +target DataSet. +Creating a Custom DataSet +Another use for scripting is when custom data objects are required. +The following workflow would typically be followed: +1. Create a POSTFEKO session. +2. Create a math script. +Note: A math script must not be of specific type, else POSTFEKO attempts to validate +the axes to make sure that the expected DataSet structure is returned. +1. Create a new DataSet. +2. Add all of the desired Axes and Quantities fields. In this case any quantity can be defined, +since POSTFEKO will not attempt to interpret them in any particular way. Axes are still +confined to the predefined values, where the arbitrary axis is used for any unspecified axis +type. +3. Perform processing on the results in the scripting environment. +4. Store the results of the script in a DataSet that is accessible in the POSTFEKO session. +3. Display and process the results. +Related tasks +Processing and Modifying a DataSet +Related reference +DataSet +Example of a Custom DataSet +Consider the following example where an existing near field is examined. When the magnitude of the +field at any point exceeds 5 + , the custom DataSet stores that value. For all other values it is zero. +nf1 = pf.NearField.GetDataSet("Horn.StandardConfiguration1.NearField1") +-- Create custom dataset +custom = pf.DataSet.New() +for axisNum = 1,nf1.Axes.Count do + sourceAxis = nf1.Axes[axisNum] + custom.Axes:Add(sourceAxis.Name, sourceAxis.Unit, sourceAxis.Values) +end +custom.Quantities:Add("above5V", "scalar", "V/m") +-- Populate the values +function process5Vthreshold(index, target, source1) + local magEx = source1[index].EFieldComp1:Magnitude() +local magEy = source1[index].EFieldComp2:Magnitude() + local magEz = source1[index].EFieldComp3:Magnitude() + local totalE = math.sqrt(magEx^2 + magEy^2 + magEz^2) + if (totalE >= 5) then + target[index].above5V = totalE + else + target[index].above5V = 0 + end +end +pf.DataSet.ForAllValues(process5Vthreshold, custom, nf1) +print(custom) +return custom +Here the DataSet called custom has the same spatial axes of the source near field. An arbitrarily +defined quantity was added. For each position on every axis, a scalar value must be defined in order for +the DataSet to be valid. The DataSet was created entirely within the script. The Axes and Quantities +were added to the DataSet and the data was populated. Results that were created in this way can also +be plotted on a 3D or 2D view, similar to any internal data type. +Structures for Internal DataSet Types +When creating a script that returns a predefined result type, it is necessary to add certain minimum +fields so that POSTFEKO can process it correctly. For each type, the minimum values are provided in the +following sections. +DataSet Structure: Far Field +Table 5: Required properties for far fields. +Property name +Property type +Description +Frequency +Spatial Axis 1 +Axes +Axes +Every far field requires a valid frequency axis. (Hz) +The first spatial axis, depending on the coordinate +system. +• Theta (when using spherical coordinates) is the +elevation angle component relative to the local +workplane. The vertical position is located at +(deg) +. +• X (when using Cartesian coordinates) is the +component of the unit vector relative to the local +workplane. +Spatial Axis 2 +Axes +The second spatial axis, depending on the coordinate +system. +Property name +Property type +Description +• Phi (when using spherical coordinates) is the +azimuthal angle component relative to the local +workplane. (deg) +• Y (when using Cartesian coordinates) is the +component of the unit vector relative to the local +workplane. +The theta direction from where an incident plane wave +originates. (deg) +The phi direction from where an incident plane wave +originates. (deg) +IncidentTheta +Axes +IncidentPhi +Axes +Theta +Quantities +This is a complex value indicating the theta component of +the electric field in the theta direction, or +. (V) +Phi +Quantities +This is a complex value indicating the phi component of +the electric field in this phi direction, or +. (V) +DirectivityFactor Quantities +A scaling factor that scale the magnitude of a field value +to the expected directivity in a given direction. +GainFactor +Quantities +A scaling factor that scale the magnitude of a field value +to the expected gain in a given direction. +RealisedGainFactor Quantities +A scaling factor that scale the magnitude of a field value +to the expected realised gain in a given direction. +RCS +Quantities +A scaling factor that scale the magnitude of a field +value to the expected radar cross section for a given +observation direction. +Origin +MetaData +The local origin for the workplane around which the far +field is defined. +UVector +MetaData +A point relative to the origin which indicates in which +direction the vector. +VVector +MetaData +A point relative to the origin which indicates in which +direction the vector. +DataSet Structure: Directivity +The directivity is a figure of merit indicating in which direction the most energy is radiated. Directivity +is the power density radiated in any direction versus an isotropic radiator which is radiating the same +amount of energy. +The formula used to calculate directivity is +DataSet Structure: Gain +Gain is calculated in the same way as directivity, except that the input power is used rather than the +radiated power. In other words, system losses are taken into account. +The formula used to calculate gain is +(1) +(2) +DataSet Structure: Realised Gain +Realised gain is calculated in the same way as gain, except that the power which is reflected back to the +input port is taken into account. In other words, system losses and mismatch effects are included. +The formula used to calculate realised gain is +(3) +DataSet Structure: Near Field +Near field results must contain a complete set of either electric field components, magnetic field +components, or both in order to be valid. +For each different coordinate system, a different set of spatial axes are required. See Table 6 for the +required properties for near fields. +Table 6: Required properties for near fields. +Property name +Property type +Description +Frequency +Axis 1...3 +Axes +Axes +MediumNames +Axes +EFieldComp1...3 +Quantities +Every near field requires a valid frequency axis. (Hz) +Every near field requires three independent spatial axes. +Depending on the coordinate system, these axes may +vary. Table 7 gives a breakdown of the required axes for +each system. +The value is an index into the MediumNames table in the +MetaData section of the DataSet. +Required quantity set for electric fields. All three complex +values must be defined for a complete electric field +definition. ( +) +HFieldComp1...3 +Quantities +Required quantity set for magnetic fields. All three +complex values must be defined for a complete magnetic +MediumIndex +Quantities +Conical +MetaData +MediumNames +MetaData +Origin +MetaData +field definition. ( +) +A scalar quantity that links to the list of media names +under the MetaData list MediumNames +A boolean flag indicating whether the near field is defined +in a conical coordinate system. The value may be either +true or false. +A list of names for the media in which a near field point +was calculated. An index to this list is provided for each +point under the MediumIndex quantity. +The local origin for the workplane around which the near +field is defined. +UVector +MetaData +A point relative to the origin which indicates in which +direction the vector. +VVector +MetaData +A point relative to the origin which indicates in which +direction the vector. +Property name +Property type +Description +RhoStepSize +MetaData +A scalar value indicating the increment with which the +cone’s rho axis increases. This effectively controls the +angle of the cone for a conical system. +Note: Only required if Conical is true. +Note: The conical coordinate system is an exception. Since it is technically not a complete +coordinate system, additional information is required. +For near fields defined in the conical coordinate system, the following must also be provided under the +MetaData fields: +Conical = true +RhoStepSize +This flag indicates to POSTFEKO that the DataSet fields must be +interpreted differently than other coordinate systems. +The step size indicates the intervals with which the rho axis +grows.f +Note: The rho axis only contains a single value which +corresponds to the starting point of the cone. +Table 7: Coordinate system axes. +Coordinate system +Axis 1 +Cartesian +Spherical +Cylindrical (X axis) +Cylindrical (Y axis) +Cylindrical +Conical +Rho +Rho +Rho +Rho +Axis 2 +Theta +Phi +Phi +Phi +Phi +Axis 3 +Phi +DataSet Structure: Source +Table 8: Required properties for sources. +Property name +Property type +Description +Frequency +Axes +Every source requires a valid frequency axis. (Hz) +Current +Quantities +Currents are complex values that are measured in +Ampere. (A) +Admittance +Quantities +The reciprocal of impedance and is measured in Siemens +and is a complex value. (S) +Power +Quantities +Type +Quantities +Impedance +Quantities +MismatchLoss +Quantities +The rate at which energy is expended. This is equal to +the current times the voltage and is measured in Watts, +which is a complex value. (W) +A value must be given to help indicate what type of +source the DataSet represents. A value of 0 represents a +voltage source, where a value of 1 represents a current +source. +The total opposition to current flow and the ratio of the +voltage to the current. It is measured using the complex +value Ohm. ( ) +The fraction of power that is reflected to or transmitted to +other ports, for example, the amount of power that does +not enter the system. This is a scalar value with no unit. +Voltage +Quantities +The potential difference over the port which is a complex +value measured in Volts. (V) +DataSet Structure: Load +Table 9: Required properties for loads. +Property name +Property type +Description +Frequency +Axes +Every loads DataSet requires a valid frequency axis. (Hz) +Current +Quantities +Currents are complex values that are measured in +Ampere. (A) +Power +Quantities +Impedance +Quantities +The rate at which energy is expended. This is equal to +the current times the voltage and is measured in Watts, +which is a complex value. (W) +The total opposition to current flow and the ratio of the +voltage to the current. It is measured using the complex +value Ohm. ( ) +Voltage +Quantities +The potential difference over the port which is a complex +value measured in Volts. (V) +DataSet Structure: Network +Table 10: Required properties for networks. +Property name +Property type +Description +Frequency +Axes +Every networks DataSet requires a valid frequency axis. +(Hz) +PortNumber +Axes +Current +Quantities +Power +Quantities +Impedance +Quantities +This is an axis that lists the port numbers for the network. +Currents are complex values that are measured in +Ampere. (A) +The rate at which energy is expended. This is equal to +the current times the voltage and is measured in Watts, +which is a complex value. (W) +The total opposition to current flow and the ratio of the +voltage to the current. It is measured using the complex +value Ohm. ( ) +Voltage +Quantities +The potential difference over the port which is a complex +value measured in Volts. (V) +DataSet Structure: S-Parameter +Table 11: Required properties for scattering matrices (s-parameters). +Property name +Property type +Description +Frequency +Axes +S-parameter +Axes +PortFlag +Quantities +Every S-parameter DataSet requires a valid frequency +axis. (Hz) +The string values here represent the scattering matrix +element definitions in the form +, which indicates the +ratio between the voltage wave measured at port x as a +result of the voltage wave excited at port y. +A value indicating whether the port is active or passive +(or both). If the value is 0, then the port is treated as a +passive port. If the value is 1, then the port is considered +to be adding and absorbing energy from the model. +Load +Quantities +A complex component that is added to a model that has +the property of being able to dissipate energy. ( ) +SParameter +Quantities +Complex scattering parameters relate (magnitude and +phase) the voltage wave measured at a port versus the +voltage wave that is inserted into port. +DataSet Structure: Power +Table 12: Required properties for power. +Property name +Property type +Description +Frequency +Axes +ActivePower +Quantities +Efficiency +Quantities +PowerLoss +Quantities +Every power DataSet requires a valid frequency axis. +(Hz) +The amount of power that is being inserted into the +system. This power could be radiated or absorbed by +other ports. (W) +A percentage value indicating the relationship +between the active power and the power provided to +the system. +The amount of power that is dissipated in the system. +This could refer to any power lost due to impurities in +the system, for example, lossy materials and metals. +(W) +RelativeSignalPhase +Quantities +A reference phase of the signal received by the +antenna. (deg) +DataSet Structure: Surface Currents and Charges +Table 13: Required properties for surface currents and charges. +Property name +Property type +Description +Frequency +Axes +MeshIndex +Axes +Every surface currents and charges DataSet requires a +valid frequency axis. (Hz) +The mesh index axis refers to the mesh element on which +a vertex lies. There will be duplicate entries in this list +due to the fact that each mesh element will have multiple +vertices. +ElectricX +Quantities +A complex current component in the global X-direction at +a vertex. ( +) +ElectricY +Quantities +A complex current component in the global Y-direction at +a vertex. ( +) +ElectricZ +Quantities +A complex current component in the global Z-direction at +a vertex. ( +) +Charge +Quantities +The complex charge build-up on a mesh element. ( +) +DataSet Structure: Wire Currents and Charges +Table 14: Required properties for wire currents and charges. +Property name +Property type +Description +Frequency +Axes +MeshIndex +Axes +Current +Charge +Quantities +Quantities +Every wire currents and charges DataSet requires a valid +frequency axis. (Hz) +The mesh index axis refers to the mesh element on which +a vertex lies. There will be duplicate entries in this list +due to the fact that each mesh element will have multiple +vertices. +A complex current component on the wire segment. (A) +The complex charge build-up on a mesh element. ( +) +DataSet Structure: Transmission and Reflection Coefficients +Table 15: Required properties for transmission and reflection coefficients. +Property name +Property type +Description +Frequency +Axes +CoPolarisedReflectionCoefficient +Quantities +CoPolarisedTransmissionCoefficient +Quantities +CrossPolarisedReflectionCoefficient +Quantities +CrossPolarisedTransmissionCoefficient +Quantities +A valid axis defining the +frequency range is required by +every transmission/reflection +coefficient DataSet. (Hz) +A complex value indicating the +ratio between the reflected +wave and the incident wave. +The co-polarised component is +defined in the direction of the +polarisation angle of the incident +plane wave. +A complex value indicating the +ratio between the transmitted +wave and the incident wave. +The co-polarised component is +defined in the direction of the +polarisation angle of the incident +plane wave. +A complex value indicating the +ratio between the reflected wave +and the incident wave. The +cross-polarised component is +defined in the direction of the +polarisation angle of the incident +plane wave. +A complex value indicating the +ratio between the transmitted +wave and the incident wave. The +cross-polarised component is +defined in the direction of the +polarisation angle of the incident +plane wave. +DataSet Structure: Specific Absorption Rate (SAR) +Table 16: Required properties for specific absorption rates (SAR). +Property name +Property type +Description +Frequency +Axes +HasAverageSAROverTotalVolume +Quantities +AverageSAROverTotalVolume +Quantities +HasAverageSAROverRequestedVolume Quantities +AverageSAROverRequestedVolume +Quantities +HasPeakSAR +Quantities +MassOfPeakSARCube +Quantities +Every specific absorption rate DataSet +requires a valid frequency axis. (Hz) +This is a boolean value. +If the flag is true, then +AverageSAROverTotalVolume must be +specified. +Average SAR over the total volume of +the model. This quantity is a scalar +value. ( +) +This is a boolean value. If +the flag is true, then the +AverageSAROverRequestedVolume is +required. +Average SAR over a specifically +requested sub-volume of the model. +This quantity is a scalar value. ( +) +This is a boolean value. If +the flag is true, then the +MassOfPeakSARCube , as well as the +AirFractionOfPeakSARCube and the +PeakSARInCube must be specified. +The mass of the SAR cube in +kilograms. The value is a scalar and is +typically + or +. ( +) +AirFractionOfPeakSARCube +Quantities +PeakSARInCube +Quantities +Air fraction in percent for this specific +cube. The value is a scalar. +Peak SAR in this specific cube. The +value is a scalar. ( +) +1.6 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. +Dialogs are constructed using the Forms object in the application automation scripting environment. A +form may contain the following elements (but not limited to): +• check box +• radio button group +• spin box +• drop-down list (combo box) +• line edit +A script can therefore behave differently depending on the decisions that you make during the execution +of the application macro. +Figure 5: An example dialog illustrating several of the form items that are available. +Related reference +Form +1.6.1 Example (Custom Dialogs) +A small example is considered to illustrate how to create a form dialog. +The script prompts the user for an S-parameter result and graph title. The result is plotted on a new +Smith chart. +app = pf.GetApplication() +-- ... +form = pf.Form.New("Simple Form Dialog") -- Create the dialog +-- Create the dialog's items +spResultSelector = pf.FormDataSelector.New("Select an S-parameter result", + pf.Enums.FormDataSelectorType.SParameter) +lineEdit = pf.FormLineEdit.New("The title of the chart") +lineEdit.Value = "Smith Chart" +-- Add the items to the dialog +form:Add(spResultSelector) +form:Add(lineEdit) +form:Run() -- Run the dialog +-- Extract and use the chosen values +smithChart = app.SmithCharts:Add() +smithChart.Title.Text = lineEdit.Value +smithChart.Traces:Add(spResultSelector.Value) +-- ... +The result of running the script is displayed in Figure 6 (when run with the “Horn” model from Feko +Getting Started Guide). +Figure 6: Example of a simple form dialog. +Tip: For more information on the objects, properties and methods available for form +dialogs, refer to Form and FormItem in the API reference. +Related reference +Form +FormItem +1.7 Application Macros +An application macro is a reference to an automation script, an icon file and associated metadata. +Application macros are available directly or can be added, removed, modified or executed from the +application macro library. +Tip: A large collection of application macros are available in CADFEKO and POSTFEKO. +On the Home tab, in the Scripting group, click the + Application macro icon. +1.8 Application Macro Library +The application macro library allows commonly used application macros to be stored in a repository. +The application macro library are stored at the following locations: +• Feko home directory for global access: \installedapplicationmacrolibrary +• Feko user directory for local access: \applicationmacrolibrary +Note: +• User defined application macros are stored and managed in the . +• Only application macros stored locally in may be modified or +removed. +1.8.1 Running a Macro from the Application Macro Library +Run a script that is located in the application macro library. +1. On the Home tab, in the Scripting group, click the + Application macro icon. From the drop- +down list, select the + Macro Library icon. +2. Select the application macro that you want to run by using one of the following workflows: +• In the Filter field, enter the macro name to narrow down the search. +• In the table select the relevant macro. +3. Run the script by selecting one of the following workflows: +• Click the + button. +• From the right-click context menu, click Run. +1.8.2 Adding a Macro to the Application Macro Library +Extend the application macro library by adding an application macro. +1. On the Home tab, in the Scripting group, click the + Application macro icon. From the drop- +down list, select the + Macro Library icon. +Figure 7: The Application macro library dialog. +2. On the Application macro library dialog, click Add. +3. +In the Script location field, browse to the location of the application macro that you want to add +to the library. +4. Under Description, add a comment to describe the purpose of the macro. +5. +In the Label field, specify the macro name. +6. From the Icon drop-down list select one of the following: +• Select a standard icon. +• Browse to the location of a custom image. +Note: +• The image may be any size as it is scaled +• Multiple image file formats are supported. +7. Click Create to add the application macro to the library and to close the dialog. +Figure 8: The Add application macro dialog. +Application Programming +Interface (API) +2 Application Programming Interface (API) +CADFEKO and POSTFEKO have a powerful, fast, lightweight scripting language integrated into the +application that allows you to create models, get hold of simulation results and model configuration +information and much more. +This chapter covers the following: +• 2.1 CADFEKO API (p. 56) +2.1 CADFEKO API +The CADFEKO application programming interface provides details regarding the hierarchy of the object +as well as the methods, functions and properties available for each object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +2.1.1 Objects (API) +p.57 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ADAPTFEKOLaunchOptions +ADAPTFEKO launch options. +Example +p.58 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Access the 'ADAPTFEKOLaunchOptions' object and check if temporary files are + deleted +deleteTemporaryFiles = + application.Launcher.Settings.ADAPTFEKO.DeleteTemporaryFilesEnabled +Inheritance +The ADAPTFEKOLaunchOptions object is derived from the CompositeValue object. +Usage locations +The ADAPTFEKOLaunchOptions object can be accessed from the following locations: +• Properties +◦ ComponentLaunchOptions object has property ADAPTFEKO. +• Methods +◦ ADAPTFEKOLaunchOptionsList object has method Append(). +◦ ADAPTFEKOLaunchOptionsList object has method Get(number). +Property List +AnalysisRestartNumber +Specifies the model number the analysis can be restarted at. (Read/Write number) +DebugEnabled +Output debug information. (Read/Write boolean) +DeleteTemporaryFilesEnabled +Enables/disables if the temporary files generated by the ADAPTFEKO run should be deleted. +(Read/Write boolean) +IncompleteAnalysisRestartEnabled +Enables/disables running the solver from the the first unfinished model if the run was +discontinued (and the temporary files were not deleted). (Read/Write boolean) +Property Details +AnalysisRestartNumber +Specifies the model number the analysis can be restarted at. +Type +number +Access +Read/Write +DebugEnabled +Output debug information. +Type +boolean +Access +Read/Write +DeleteTemporaryFilesEnabled +Enables/disables if the temporary files generated by the ADAPTFEKO run should be deleted. +Type +boolean +Access +Read/Write +IncompleteAnalysisRestartEnabled +Enables/disables running the solver from the the first unfinished model if the run was +discontinued (and the temporary files were not deleted). +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ADAPTFEKOLaunchOptionsList +A list of ADAPTFEKOLaunchOptions items. +Method List +Append () +p.60 +Appends a new item to the list. (Returns a ADAPTFEKOLaunchOptions object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a ADAPTFEKOLaunchOptions +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +ADAPTFEKOLaunchOptions +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +ADAPTFEKOLaunchOptions +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.61 +Altair Feko 2022.3 +2 Application Programming Interface (API) +AbstractAntennaArray +A finite antenna array which includes mutual coupling and edge-effects in the analysis. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The AbstractAntennaArray object is derived from the Object object. +The following objects are derived (specialisations) from the AbstractAntennaArray object: +p.62 +• CustomAntennaArray +• CylindricalAntennaArray +• LinearPlanarArray +Usage locations +The AbstractAntennaArray object can be accessed from the following locations: +• Methods +◦ AntennaArrayCollection collection has method Item(number). +◦ AntennaArrayCollection collection has method Item(string). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +AbstractFEMLinePort +An abstract (base) object for FEM line ports. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The AbstractFEMLinePort object is derived from the Port object. +The following objects are derived (specialisations) from the AbstractFEMLinePort object: +p.67 +• FEMLineMeshPort +• FEMLinePort +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +p.72 +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +AbstractIdealSource +An abstract (base) object for ideal sources. +Example +p.73 +-- This is an abstract object, see derived objects for examples +Inheritance +The AbstractIdealSource object is derived from the Source object. +The following objects are derived (specialisations) from the AbstractIdealSource object: +• AbstractPointSource +• ImpressedCurrent +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +AbstractMeshEdge +An abstract (base) object for mesh edges. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The AbstractMeshEdge object is derived from the Object object. +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +AbstractMeshPort +An abstract (base) object for mesh ports. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The AbstractMeshPort object is derived from the Port object. +The following objects are derived (specialisations) from the AbstractMeshPort object: +• MicrostripMeshPort +• WireMeshPort +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.83 +AbstractMeshTriangleFace +An abstract (base) object for mesh triangle faces. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The AbstractMeshTriangleFace object is derived from the Object object. +The following objects are derived (specialisations) from the AbstractMeshTriangleFace object: +• MeshCurvilinearTriangleFace +• MeshTriangleFace +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.86 +AbstractMeshWire +An abstract (base) object for mesh triangle wires. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The AbstractMeshWire object is derived from the Object object. +The following objects are derived (specialisations) from the AbstractMeshWire object: +• MeshCurvilinearWire +• MeshWire +Property List +AllowDifferentSegmentRadii +Allow modification of radii per segment. (Read/Write boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetRadiusOnAllSegments (radius Expression) +Set the segment radius. This is a helper method to update the Radius property on all the +segments simultaneously. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property Details +AllowDifferentSegmentRadii +Allow modification of radii per segment. +p.88 +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetRadiusOnAllSegments (radius Expression) +Set the segment radius. This is a helper method to update the Radius property on all the +segments simultaneously. +Input Parameters +radius(Expression) +The new radius. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +AbstractPointSource +An abstract (base) object for point sources. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The AbstractPointSource object is derived from the AbstractIdealSource object. +The following objects are derived (specialisations) from the AbstractPointSource object: +• ElectricDipole +• MagneticDipole +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Magnitude +The source magnitude. (Read/Write ParametricExpression) +Phase +Phi +The source phase (degrees). (Read/Write ParametricExpression) +The phi angle (degrees). (Read/Write ParametricExpression) +Position +The position of the source. (Read/Write LocalCoordinate) +Theta +Type +The theta angle (degrees). (Read/Write ParametricExpression) +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Magnitude +The source magnitude. +Type +ParametricExpression +Access +Read/Write +Phase +Phi +The source phase (degrees). +Type +ParametricExpression +Access +Read/Write +The phi angle (degrees). +Type +ParametricExpression +Access +Read/Write +Position +The position of the source. +Type +LocalCoordinate +Access +Read/Write +Theta +The theta angle (degrees). +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.95 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +AbstractSurfaceCurve +An abstract (base) object for curves. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The AbstractSurfaceCurve object is derived from the Geometry object. +The following objects are derived (specialisations) from the AbstractSurfaceCurve object: +p.96 +• SurfaceBezierCurve +• SurfaceLine +• SurfaceRegularLines +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +The object type string. (Read only string) +WorkSurface +The referenced work surface used to map the U'V' coordinates. (Read/Write WorkSurface) +Collection List +Edges +The collection of edges of the operator. (EdgeCollection of Edge.) +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.98 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +WorkSurface +The referenced work surface used to map the U'V' coordinates. +Type +WorkSurface +Access +Read/Write +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +p.101 +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +p.103 +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +AdaptiveRefinement +p.104 +An adaptive refinement meshing rule. Reads the error estimates from an earlier solution and adds Point +refinement rules in the areas where the errors are estimated to be the highest. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +diel_cube.cfx]]}) + -- Create an adaptive mesh refinement +project.Contents.MeshRefinementRules:AddAdaptiveRefinement() +Inheritance +The AdaptiveRefinement object is derived from the MeshRefinementRule object. +Usage locations +The AdaptiveRefinement object can be accessed from the following locations: +• Methods +◦ MeshRefinementRuleCollection collection has method AddAdaptiveRefinement(table). +◦ MeshRefinementRuleCollection collection has method AddAdaptiveRefinement(). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.108 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +AdvancedSolverSettings +Advanced solver settings. +Example +p.109 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Enable the compression for looped plane wave sources +project.Contents.SolutionSettings.SolverSettings.AdvancedSettings.LoopedPlaneWaveCompression + = + cf.Enums.LoopedPlaneWaveCompressionEnum.Enabled +Inheritance +The AdvancedSolverSettings object is derived from the CompositeValue object. +Usage locations +The AdvancedSolverSettings object can be accessed from the following locations: +• Properties +◦ SolverSettings object has property AdvancedSettings. +• Methods +◦ AdvancedSolverSettingsList object has method Append(). +◦ AdvancedSolverSettingsList object has method Get(number). +Property List +LoopedPlaneWaveCompression +The looped plane wave compression option to be used, specified by +LoopedPlaneWaveCompressionEnum, eg. Auto, Enabled, etc. (Read/Write +LoopedPlaneWaveCompressionEnum) +Property Details +LoopedPlaneWaveCompression +The looped plane wave compression option to be used, specified by +LoopedPlaneWaveCompressionEnum, eg. Auto, Enabled, etc. +Type +LoopedPlaneWaveCompressionEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +AdvancedSolverSettingsList +A list of AdvancedSolverSettings items. +Method List +Append () +p.110 +Appends a new item to the list. (Returns a AdvancedSolverSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a AdvancedSolverSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +AdvancedSolverSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +AdvancedSolverSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.111 +Align +An align transform. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a flare to align +flare = project.Contents.Geometry:AddFlare(cf.Point(0, 0, 0), 1, 1, 1, 0.5, 0.5) + -- Create variables to define the source workplane +srcOrigin = cf.Point(0, 0, 0) +srcUVec = cf.Point(1, 0, 0) +srcVVec = cf.Point(0, 1, 0) + -- Create variables to define the destination workplane +destOrigin = cf.Point(0, 0, 2) +destUVec = cf.Point(0, 0, 1) +destVVec = cf.Point(-1, -1, 0) + -- Align the flare +alignOne = flare.Transforms:AddAlign(destOrigin, destUVec, destVVec, srcOrigin, + srcUVec, srcVVec) +alignTwo = flare.Transforms:AddAlign(srcOrigin, srcUVec, srcVVec, destOrigin, + destUVec, destVVec) + -- Remove the first align transform +alignOne:Delete() +Inheritance +The Align object is derived from the Transform object. +Usage locations +The Align object can be accessed from the following locations: +• Methods +◦ TransformCollection collection has method AddAlign(table). +◦ TransformCollection collection has method AddAlign(Point, Vector, Vector, Point, Vector, +Vector). +Property List +DestinationWorkplane +The destination workplane. (Read/Write LocalWorkplane) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +SourceWorkplane +The source workplane. (Read/Write LocalWorkplane) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +DestinationWorkplane +The destination workplane. +Type +LocalWorkplane +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +SourceWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.117 +AnalyticalCurve +An analytical curve. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create an analytical curve +analyticalCurve = + project.Contents.Geometry:AddAnalyticalCurve(1, 15, "t/15", "sin(t)/t", "sin(t)") +Inheritance +The AnalyticalCurve object is derived from the Geometry object. +Usage locations +The AnalyticalCurve object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddAnalyticalCurve(table). +◦ GeometryCollection collection has method AddAnalyticalCurve(Expression, Expression, +Expression, Expression, Expression). +◦ GeometryCollection collection has method AddAnalyticalCurveCylindrical(Expression, +Expression, Expression, Expression, Expression). +◦ GeometryCollection collection has method AddAnalyticalCurveSpherical(Expression, +Expression, Expression, Expression, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CartesianDescription +The description of the curve using the Cartesian coordinate system. (Read/Write +CartesianDescription) +CylindricalDescription +The description of the curve using the cylindrical coordinate system. (Read/Write +CylindricalDescription) +DefinitionMethod +Analytical curve coordinate system as specified by the AnalyticalCurveDefinitionMethodEnum, e.g. +Cartesian, Spherical or Cylindrical. (Read/Write AnalyticalCurveDefinitionMethodEnum) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +LocalMeshSettingsEnabled +p.119 +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +ParametricEnd +The end of the interval over which the analytical curve is parametrically defined. (Read/Write +ParametricExpression) +ParametricStart +The start of the interval over which the analytical curve is parametrically defined. (Read/Write +ParametricExpression) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +SphericalDescription +The description of the curve using the spherical coordinate system. (Read/Write +SphericalDescription) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CartesianDescription +The description of the curve using the Cartesian coordinate system. +Type +CartesianDescription +Access +Read/Write +CylindricalDescription +The description of the curve using the cylindrical coordinate system. +Type +CylindricalDescription +Access +Read/Write +DefinitionMethod +Analytical curve coordinate system as specified by the AnalyticalCurveDefinitionMethodEnum, e.g. +Cartesian, Spherical or Cylindrical. +Type +AnalyticalCurveDefinitionMethodEnum +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +ParametricEnd +The end of the interval over which the analytical curve is parametrically defined. +Type +ParametricExpression +Access +Read/Write +ParametricStart +The start of the interval over which the analytical curve is parametrically defined. +Type +ParametricExpression +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +SphericalDescription +The description of the curve using the spherical coordinate system. +Type +SphericalDescription +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +p.126 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +AngularDimension +The degrees of an angle. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a cone with its base centre at the specified 'Point' +baseCentre = cf.Point(-0.25, -0.25, 0) +cone = project.Contents.Geometry:AddCone(baseCentre, 0.5, 0.1, 1.0) +Inheritance +The AngularDimension object is derived from the Dimension object. +Usage locations +The AngularDimension object can be accessed from the following locations: +• Properties +◦ Rotate object has property Angle. +◦ Cutplane object has property Phi. +◦ Cutplane object has property Theta. +◦ OpenRing object has property GapAngle. +◦ OpenRing object has property StartAngle. +◦ SplitRing object has property GapAngle. +◦ SplitRing object has property StartAngle. +◦ Cone object has property Angle. +◦ EllipticArc object has property EndAngle. +◦ EllipticArc object has property StartAngle. +◦ Flare object has property AngleU. +◦ Flare object has property AngleV. +◦ Spin object has property Angle. +• Methods +◦ AngularDimensionList object has method Append(). +◦ AngularDimensionList object has method Get(number). +Altair Feko 2022.3 +2 Application Programming Interface (API) +AngularDimensionList +A list of AngularDimension items. +Method List +Append () +p.128 +Appends a new item to the list. (Returns a AngularDimension object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a AngularDimension object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +AngularDimension +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +AngularDimension +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +AnisotropicDielectric +A 3D anisotropic medium. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Define media to be used in 3D anisotropic definition +dielectric1 = project.Definitions.Media.Dielectric:AddDielectric() +dielectric2 = project.Definitions.Media.Dielectric:AddDielectric() +dielectric3 = project.Definitions.Media.Dielectric:AddDielectric() +dielectric4 = project.Definitions.Media.Dielectric:AddDielectric() +dielectric5 = project.Definitions.Media.Dielectric:AddDielectric() +dielectric6 = project.Definitions.Media.Dielectric:AddDielectric() +dielectric7 = project.Definitions.Media.Dielectric:AddDielectric() +dielectric8 = project.Definitions.Media.Dielectric:AddDielectric() +dielectric9 = project.Definitions.Media.Dielectric:AddDielectric() + -- Create an anisotropic 3D medium +properties = cf.AnisotropicDielectric.GetDefaultProperties() +properties.MassDensity = "1000.0" +properties.TensorDescription = cf.Enums.TensorDescriptionMethodEnum.FullTensor +properties.FullTensor[1][1] = dielectric1 +properties.FullTensor[1][2] = dielectric2 +properties.FullTensor[1][3] = dielectric3 +properties.FullTensor[2][1] = dielectric4 +properties.FullTensor[2][2] = dielectric5 +properties.FullTensor[2][3] = dielectric6 +properties.FullTensor[3][1] = dielectric7 +properties.FullTensor[3][2] = dielectric8 +properties.FullTensor[3][3] = dielectric9 +anisotropicDielectric1 = + application.Project.Definitions.Media.AnisotropicDielectric:AddAnisotropicDielectric(properties) +-- Change the colour to Cyan +anisotropicDielectric1.Colour = "#00FFFF" +Inheritance +The AnisotropicDielectric object is derived from the Medium object. +Usage locations +The AnisotropicDielectric object can be accessed from the following locations: +• Methods +◦ AnisotropicDielectricCollection collection has method AddAnisotropicDielectric(table). +◦ AnisotropicDielectricCollection collection has method AddAnisotropicDielectric(Dielectric, +Dielectric, Dielectric). +◦ AnisotropicDielectricCollection collection has method Item(number). +◦ AnisotropicDielectricCollection collection has method Item(string). +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property List +Colour +The medium colour. (Read/Write string) +ComplexTensor +p.131 +Defines the complex permittivity and permeability tensors. (Read/Write ComplexTensor) +DiagonalTensor +Defines the media of the diagonal tensor definition. (Read/Write ObjectReferenceTable) +FullTensor +Defines the media of the full tensor definition. (Read/Write ObjectReferenceTable) +Label +The object label. (Read/Write string) +MassDensity +Medium's mass density (kg/m^3). (Read/Write ParametricExpression) +PolderTensor +Defines the parameters used to create a Polder tensor. (Read/Write PolderTensor) +TensorDescription +Sets the form of the tensor that defines the 3D anisotropic medium. (Read/Write +TensorDescriptionMethodEnum) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +ComplexTensor +Defines the complex permittivity and permeability tensors. +Type +ComplexTensor +Access +Read/Write +DiagonalTensor +Defines the media of the diagonal tensor definition. +Type +ObjectReferenceTable +Access +Read/Write +FullTensor +Defines the media of the full tensor definition. +Type +ObjectReferenceTable +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MassDensity +Medium's mass density (kg/m^3). +Type +ParametricExpression +Access +Read/Write +PolderTensor +Defines the parameters used to create a Polder tensor. +Type +PolderTensor +Access +Read/Write +TensorDescription +Sets the form of the tensor that defines the 3D anisotropic medium. +Type +TensorDescriptionMethodEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +AnisotropicDielectricLayers +Layer properties of the layered anisotropic dielectric medium. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +dielectric1 = project.Definitions.Media.Dielectric:AddDielectric() +dielectric2 = project.Definitions.Media.Dielectric:AddDielectric() +layeredAnisotropicDielectric = + project.Definitions.Media.LayeredDielectric:AddLayeredAnisotropicDielectric({0.1}, +{0.0},{dielectric1},{dielectric2}) + -- Modify the anisotropic dielectric layer +layeredAnisotropicDielectric.Layers[1].PrincipleDirection = 90 +layeredAnisotropicDielectric.Layers[1].PrincipleMedium = dielectric2 +layeredAnisotropicDielectric.Layers[1].OrthogonalMedium = dielectric1 +Inheritance +The AnisotropicDielectricLayers object is derived from the CompositeValue object. +Usage locations +The AnisotropicDielectricLayers object can be accessed from the following locations: +• Methods +◦ AnisotropicDielectricLayersList object has method Append(). +◦ AnisotropicDielectricLayersList object has method Get(number). +Property List +OrthogonalMedium +The dielectric medium of the material to be used in the orthogonal direction. (Read/Write +Dielectric) +PrincipleDirection +The angle (in degrees) from which the principle direction is obtained. (Read/Write +ParametricExpression) +PrincipleMedium +The dielectric medium of the material to be used in the principle direction. (Read/Write Dielectric) +Thickness +The thickness of the layer (in the model unit). (Read/Write ParametricExpression) +Property Details +OrthogonalMedium +The dielectric medium of the material to be used in the orthogonal direction. +Type +Dielectric +Access +Read/Write +PrincipleDirection +The angle (in degrees) from which the principle direction is obtained. +Type +ParametricExpression +Access +Read/Write +PrincipleMedium +The dielectric medium of the material to be used in the principle direction. +Type +Dielectric +Access +Read/Write +Thickness +The thickness of the layer (in the model unit). +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +AnisotropicDielectricLayersList +A list of AnisotropicDielectricLayers items. +Usage locations +p.137 +The AnisotropicDielectricLayersList object can be accessed from the following locations: +• Properties +◦ LayeredAnisotropicDielectric object has property Layers. +Method List +Append () +Appends a new item to the list. (Returns a AnisotropicDielectricLayers object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a AnisotropicDielectricLayers +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +AnisotropicDielectricLayers +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +AnisotropicDielectricLayers +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +AntennaArraySource +A finite antenna array element source. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a line to use as the base object in the array +startPoint = cf.Point(0, 0, 0) +endPoint = cf.Point(1, 1, 0) +line = project.Contents.Geometry:AddLine(startPoint, endPoint) + -- Use the GetProperties method to create the linear planar array +properties = cf.LinearPlanarArray.GetDefaultProperties() +properties.CountU = 4 +properties.CountV = 3 +properties.OffsetU = "1" + -- Disable UniformSourceDistribution to add an AntennaArraySourceList +properties.UniformSourceDistributionEnabled = false +properties.Distribution[1].MagnitudeScaling = "2" +properties.Distribution[1].PhaseOffset = "1" +properties.Distribution[2] = {} +properties.Distribution[2].MagnitudeScaling = "2" +properties.Distribution[2].PhaseOffset = "1" +properties.Distribution[3] = {} +properties.Distribution[3].MagnitudeScaling = "3" +properties.Distribution[3].PhaseOffset = "1" +properties.Distribution[4] = {} +properties.Distribution[4].MagnitudeScaling = "1.0" +properties.Distribution[4].PhaseOffset = "1" +properties.Distribution[5] = {} +properties.Distribution[5].MagnitudeScaling = "4" +properties.Distribution[5].PhaseOffset = "4" +properties.Distribution[6] = {} +properties.Distribution[6].MagnitudeScaling = "1.0" +properties.Distribution[6].PhaseOffset = "0.0" +properties.Distribution[7] = {} +properties.Distribution[7].MagnitudeScaling = "1.0" +properties.Distribution[7].PhaseOffset = "0.0" +properties.Distribution[8] = {} +properties.Distribution[8].MagnitudeScaling = "1.0" +properties.Distribution[8].PhaseOffset = "0.0" +properties.Distribution[9] = {} +properties.Distribution[9].MagnitudeScaling = "1.0" +properties.Distribution[9].PhaseOffset = "0.0" +properties.Distribution[10] = {} +properties.Distribution[10].MagnitudeScaling = "1.0" +properties.Distribution[10].PhaseOffset = "0.0" +properties.Distribution[11] = {} +properties.Distribution[11].MagnitudeScaling = "1.0" +properties.Distribution[11].PhaseOffset = "0.0" +properties.Distribution[12] = {} +properties.Distribution[12].MagnitudeScaling = "1.0" +properties.Distribution[12].PhaseOffset = "0.0" +Altair Feko 2022.3 +2 Application Programming Interface (API) + -- Create the linear planar array +p.140 +linearPlanarArray = + project.Contents.SolutionSettings.AntennaArrays:AddPlanarArray(properties) +Inheritance +The AntennaArraySource object is derived from the CompositeValue object. +Usage locations +The AntennaArraySource object can be accessed from the following locations: +• Methods +◦ AntennaArraySourceList object has method Append(). +◦ AntennaArraySourceList object has method Get(number). +Property List +MagnitudeScaling +The source magnitude for the respective element is scaled relative to the base element. (Read/ +Write ParametricExpression) +PhaseOffset +The phase offset (in degrees) for the respective element relative to the base element. (Read/Write +ParametricExpression) +Property Details +MagnitudeScaling +The source magnitude for the respective element is scaled relative to the base element. +Type +ParametricExpression +Access +Read/Write +PhaseOffset +The phase offset (in degrees) for the respective element relative to the base element. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +AntennaArraySourceList +A list of AntennaArraySource items. +Usage locations +p.141 +The AntennaArraySourceList object can be accessed from the following locations: +• Properties +◦ CylindricalAntennaArray object has property Distribution. +◦ LinearPlanarArray object has property Distribution. +Method List +Append () +Appends a new item to the list. (Returns a AntennaArraySource object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a AntennaArraySource object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +AntennaArraySource +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +AntennaArraySource +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Application +The CADFEKO Application. +Example + -- The "GetInstance" function lives in the "Application" namespace and + -- returns the current CADFEKO application object. +application = cf.Application.GetInstance() + -- Open an example file located in the FEKO_HOME folder +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) +Inheritance +The Application object is derived from the Object object. +Usage locations +The Application object can be accessed from the following locations: +• Static functions +◦ Application object has static function GetInstance(). +Property List +Label +The object label. (Read/Write string) +Launcher +The application launcher. (Read only Launcher) +MainWindow +The main window of the application. (Read only MainWindow) +MessageWindow +The application message window. (Read only MessageWindow) +Project +The application project. (Read only Model) +Type +The object type string. (Read only string) +Version +The application version. (Read only Version) +Collection List +MediaLibrary +The media library. (MediaLibrary of LibraryMedium.) +Method List +CloseProject () +Closes an open project. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Exit () +Exit the application. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Load (filename string) +Loads a new project. (Returns a Object object.) +NewProject () +Creates a new project. (Returns a Object object.) +Save () +Saves the current session. +SaveAs (filename string) +Saves the current model with the given name. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +GetInstance () +Returns an instance of the CADFEKO application object. (Returns a Application object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Launcher +The application launcher. +Type +Launcher +Access +Read only +MainWindow +The main window of the application. +Type +MainWindow +Access +Read only +MessageWindow +The application message window. +Type +MessageWindow +Access +Read only +Project +The application project. +Type +Model +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Version +The application version. +Type +Version +Access +Read only +Collection Details +MediaLibrary +The media library. +Type +MediaLibrary +Method Details +CloseProject () +Closes an open project. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Exit () +Exit the application. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Load (filename string) +Loads a new project. +Input Parameters +filename(string) +The name of the file to load. +Return +Object +The application project. +NewProject () +Creates a new project. +Return +Object +The application project. +Save () +Saves the current session. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SaveAs (filename string) +Saves the current model with the given name. +Input Parameters +filename(string) +The name of the cfx file. +SetProperties (properties Object) +p.147 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +GetInstance () +A table containing the default properties. +Returns an instance of the CADFEKO application object. +Return +Application +An instance of the CADFEKO application object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +BaseFieldReceivingAntenna +An base object for mesh triangle faces. +Example +p.148 +-- This is an base object, see derived objects for examples +Inheritance +The BaseFieldReceivingAntenna object is derived from the Object object. +The following objects are derived (specialisations) from the BaseFieldReceivingAntenna object: +• FarFieldReceivingAntenna +• NearFieldReceivingAntenna +• SphericalModeReceivingAntenna +Usage locations +The BaseFieldReceivingAntenna object can be accessed from the following locations: +• Properties +◦ ReceivingAntennaOptimisationGoal object has property FocusSource. +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +IncludeScatteredPart +Enable including only the scattered part of the field. (Read/Write boolean) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +IncludeScatteredPart +Enable including only the scattered part of the field. +Type +boolean +Access +Read/Write +The object label. +Type +string +Label +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +p.151 +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +BasisFunctionGlobalSolverSettings +Basis function control. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Active HOBF globally +p.153 +project.Contents.SolutionSettings.SolverSettings.GeneralSettings.BasisFunctionSettings. + HOBFEnabled = true +Inheritance +The BasisFunctionGlobalSolverSettings object is derived from the CompositeValue object. +Usage locations +The BasisFunctionGlobalSolverSettings object can be accessed from the following locations: +• Properties +◦ GeneralSolverSettings object has property BasisFunctionSettings. +• Methods +◦ BasisFunctionGlobalSolverSettingsList object has method Append(). +◦ BasisFunctionGlobalSolverSettingsList object has method Get(number). +Property List +ElementOrder +Specifies the desired order or allows the solution kernel to select the most appropriate order. Only +valid if global basis function control is enabled. (Read/Write HOBFElementOrderEnum) +HOBFEnabled +Activates higher order basis functions. (Read/Write boolean) +RangeSelection +Specifies whether higher, lower or normal orders should be preferred by the solver kernel. Only +valid if global basis function control is enabled. (Read/Write BasisFunctionAccuracyEnum) +Property Details +ElementOrder +Specifies the desired order or allows the solution kernel to select the most appropriate order. Only +valid if global basis function control is enabled. +Type +HOBFElementOrderEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +HOBFEnabled +Activates higher order basis functions. +Type +boolean +Access +Read/Write +RangeSelection +p.154 +Specifies whether higher, lower or normal orders should be preferred by the solver kernel. Only +valid if global basis function control is enabled. +Type +BasisFunctionAccuracyEnum +Access +Read/Write +BasisFunctionGlobalSolverSettingsList +A list of BasisFunctionGlobalSolverSettings items. +Method List +Append () +Appends a new item to the list. (Returns a BasisFunctionGlobalSolverSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +BasisFunctionGlobalSolverSettings object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +BasisFunctionGlobalSolverSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +BasisFunctionGlobalSolverSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.156 +Altair Feko 2022.3 +2 Application Programming Interface (API) +BasisFunctionLocalSolverSettings +p.157 +Solution basis function control properties. Only applies if basis function control has been enabled in the +global solver settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a cone +cone = project.Contents.Geometry:AddCone(cf.Cone.GetDefaultProperties()) +-- Set the cone face to use HOBF +cone.Faces[1].BasisFunctionSettings.HOBFEnabled = true +Inheritance +The BasisFunctionLocalSolverSettings object is derived from the CompositeValue object. +Usage locations +The BasisFunctionLocalSolverSettings object can be accessed from the following locations: +• Properties +◦ MeshCurvilinearTriangleFace object has property BasisFunctionSettings. +◦ MeshTriangleFace object has property BasisFunctionSettings. +◦ MeshPlate object has property BasisFunctionSettings. +◦ MeshTetrahedronRegion object has property BasisFunctionSettings. +◦ Face object has property BasisFunctionSettings. +◦ Region object has property BasisFunctionSettings. +• Methods +◦ BasisFunctionLocalSolverSettingsList object has method Append(). +◦ BasisFunctionLocalSolverSettingsList object has method Get(number). +Property List +ElementOrder +Specifies the desired order or allows the solution kernel to select the most appropriate order. Only +valid if local basis function control is enabled. (Read/Write HOBFElementOrderEnum) +HOBFEnabled +Activates higher order basis functions locally. (Read/Write boolean) +RangeSelection +Specifies whether higher, lower or normal orders should be preferred by the solver kernel. Only +valid if local basis function control is enabled. (Read/Write BasisFunctionAccuracyEnum) +Property Details +ElementOrder +Specifies the desired order or allows the solution kernel to select the most appropriate order. Only +valid if local basis function control is enabled. +Type +HOBFElementOrderEnum +Access +Read/Write +HOBFEnabled +Activates higher order basis functions locally. +Type +boolean +Access +Read/Write +RangeSelection +Specifies whether higher, lower or normal orders should be preferred by the solver kernel. Only +valid if local basis function control is enabled. +Type +BasisFunctionAccuracyEnum +Access +Read/Write +BasisFunctionLocalSolverSettingsList +A list of BasisFunctionLocalSolverSettings items. +Method List +Append () +Appends a new item to the list. (Returns a BasisFunctionLocalSolverSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +BasisFunctionLocalSolverSettings object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +BasisFunctionLocalSolverSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +BasisFunctionLocalSolverSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.160 +BezierCurve +A Bezier curve. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a Bezier curve +startPoint = cf.Point(1,0,0) +startTangent = cf.Point(0.5,0.5,0) +endTangent = cf.Point(-0.5,0.5,0) +endPoint = cf.Point(0,1,0) +bezierCurve = project.Contents.Geometry:AddBezierCurve(startPoint, startTangent, + endTangent, endPoint) +Inheritance +The BezierCurve object is derived from the Geometry object. +Usage locations +The BezierCurve object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddBezierCurve(table). +◦ GeometryCollection collection has method AddBezierCurve(Point, Point, Point, Point). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +p.163 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +p.168 +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Box +A box in 3D space. The box is defined by its two corners. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +corner = cf.Point(0,0,0) +Rectangle1 = project.Contents.Geometry:AddRectangle(corner, 1, 1) + -- Retrieve the 'BoundingBox' of the rectangle +boundingBox = Rectangle1.Faces["Face1"].BoundingBox + -- Access the 'Width' of the rectangle's 'BoundingBox' +width = boundingBox.Width + -- Access the corner of the 'BoundingBox' furthest from the origin +boundingBoxCorner = boundingBox.Corner2 +Usage locations +The Box object can be accessed from the following locations: +• Properties +◦ AntennaArrayCollection collection has property BoundingBox. +◦ CableConnectorCollection collection has property BoundingBox. +◦ CableInstanceCollection collection has property BoundingBox. +◦ CablePathCollection collection has property BoundingBox. +◦ GeometryCollection collection has property BoundingBox. +◦ GeometryGroup collection has property BoundingBox. +◦ SolutionConfigurationCollection collection has property BoundingBox. +◦ SourceCollection collection has property BoundingBox. +◦ ProtectedModels collection has property BoundingBox. +◦ Model object has property BoundingBox. +◦ AbstractAntennaArray object has property BoundingBox. +◦ CylindricalAntennaArray object has property BoundingBox. +◦ LinearPlanarArray object has property BoundingBox. +◦ CustomAntennaArray object has property BoundingBox. +◦ CableConnector object has property BoundingBox. +◦ CableHarness object has property BoundingBox. +◦ CableInstance object has property BoundingBox. +◦ CablePath object has property BoundingBox. +◦ CablePathTerminal object has property BoundingBox. +◦ Cables object has property BoundingBox. +◦ AbstractMeshEdge object has property BoundingBox. +◦ AbstractMeshTriangleFace object has property BoundingBox. +◦ MeshCurvilinearTriangleFace object has property BoundingBox. +◦ MeshTriangleFace object has property BoundingBox. +◦ MeshCurvilinearWire object has property BoundingBox. +◦ MeshCurvilinearSegmentWire object has property BoundingBox. +◦ MeshWire object has property BoundingBox. +◦ MeshSegmentWire object has property BoundingBox. +◦ MeshCylinder object has property BoundingBox. +◦ MeshPlate object has property BoundingBox. +◦ MeshRegion object has property BoundingBox. +◦ MeshTetrahedronRegion object has property BoundingBox. +◦ MeshRefinementRule object has property BoundingBox. +◦ AdaptiveRefinement object has property BoundingBox. +◦ PointRefinement object has property BoundingBox. +◦ PolylineRefinement object has property BoundingBox. +◦ Mesh object has property BoundingBox. +◦ Geometry object has property BoundingBox. +◦ SpiralCross object has property BoundingBox. +◦ Ring object has property BoundingBox. +◦ OpenRing object has property BoundingBox. +◦ SplitRing object has property BoundingBox. +◦ Cross object has property BoundingBox. +◦ StripCross object has property BoundingBox. +◦ Trifilar object has property BoundingBox. +◦ AnalyticalCurve object has property BoundingBox. +◦ BezierCurve object has property BoundingBox. +◦ Cone object has property BoundingBox. +◦ ConstrainedSurface object has property BoundingBox. +◦ Cuboid object has property BoundingBox. +◦ Cylinder object has property BoundingBox. +◦ Ellipse object has property BoundingBox. +◦ EllipticArc object has property BoundingBox. +◦ FittedSpline object has property BoundingBox. +◦ Flare object has property BoundingBox. +◦ Helix object has property BoundingBox. +◦ Hexagon object has property BoundingBox. +◦ StripHexagon object has property BoundingBox. +◦ HyperbolicArc object has property BoundingBox. +◦ +◦ +ImprintPoints object has property BoundingBox. +Intersect object has property BoundingBox. +◦ Loft object has property BoundingBox. +◦ PathSweep object has property BoundingBox. +◦ ProjectGeometry object has property BoundingBox. +◦ RepairAndSewFaces object has property BoundingBox. +◦ RepairPart object has property BoundingBox. +◦ Spin object has property BoundingBox. +◦ Split object has property BoundingBox. +◦ Stitch object has property BoundingBox. +◦ Subtract object has property BoundingBox. +◦ Sweep object has property BoundingBox. +◦ Union object has property BoundingBox. +◦ Simplify object has property BoundingBox. +◦ Line object has property BoundingBox. +◦ NurbsSurface object has property BoundingBox. +◦ ParabolicArc object has property BoundingBox. +◦ Paraboloid object has property BoundingBox. +◦ Polygon object has property BoundingBox. +◦ Polyline object has property BoundingBox. +◦ Primitive object has property BoundingBox. +◦ Rectangle object has property BoundingBox. +◦ Sphere object has property BoundingBox. +◦ AbstractSurfaceCurve object has property BoundingBox. +◦ SurfaceBezierCurve object has property BoundingBox. +◦ SurfaceLine object has property BoundingBox. +◦ SurfaceRegularLines object has property BoundingBox. +◦ TCross object has property BoundingBox. +◦ Edge object has property BoundingBox. +◦ Face object has property BoundingBox. +◦ Region object has property BoundingBox. +◦ WorkSurface object has property BoundingBox. +◦ FDTDBoundaryConditions object has property BoundingBox. +◦ Port object has property BoundingBox. +◦ CablePort object has property BoundingBox. +◦ EdgeMeshPort object has property BoundingBox. +◦ EdgePort object has property BoundingBox. +◦ AbstractFEMLinePort object has property BoundingBox. +◦ FEMLineMeshPort object has property BoundingBox. +◦ FEMLinePort object has property BoundingBox. +◦ FEMModalMeshPort object has property BoundingBox. +◦ FEMModalPort object has property BoundingBox. +◦ AbstractMeshPort object has property BoundingBox. +◦ MicrostripMeshPort object has property BoundingBox. +◦ WireMeshPort object has property BoundingBox. +◦ MicrostripPort object has property BoundingBox. +◦ WaveguideMeshPort object has property BoundingBox. +◦ WaveguidePort object has property BoundingBox. +◦ WirePort object has property BoundingBox. +◦ StandardConfiguration object has property BoundingBox. +◦ CurrentSource object has property BoundingBox. +◦ FEMModalSource object has property BoundingBox. +◦ VoltageSource object has property BoundingBox. +◦ WaveguideSource object has property BoundingBox. +◦ AbstractIdealSource object has property BoundingBox. +◦ AbstractPointSource object has property BoundingBox. +◦ ElectricDipole object has property BoundingBox. +◦ MagneticDipole object has property BoundingBox. +◦ +ImpressedCurrent object has property BoundingBox. +◦ FarFieldSource object has property BoundingBox. +◦ NearFieldSource object has property BoundingBox. +◦ PCBSource object has property BoundingBox. +◦ SolutionCoefficientSource object has property BoundingBox. +◦ SphericalModeSource object has property BoundingBox. +◦ PlaneWave object has property BoundingBox. +◦ FarField object has property BoundingBox. +◦ BaseFieldReceivingAntenna object has property BoundingBox. +◦ FarFieldReceivingAntenna object has property BoundingBox. +◦ NearFieldReceivingAntenna object has property BoundingBox. +◦ SphericalModeReceivingAntenna object has property BoundingBox. +◦ Load object has property BoundingBox. +◦ NearField object has property BoundingBox. +◦ SolutionSettings object has property BoundingBox. +◦ ModelContents object has property BoundingBox. +◦ ModelDefinitions object has property BoundingBox. +◦ ProtectedModel object has property BoundingBox. +• Static functions +Property List +Centre +The centre of the box. (Read only Point) +Corner1 +The corner of the box closest to the origin. (Read only Point) +Corner2 +The second corner of the box farthest from the origin. (Read only Point) +Depth +The depth of the box (how long it is along the Y axis). (Read only number) +Height +The Height of the box (how long it is along the Z axis). (Read only number) +Type +Width +The object type string. (Read only string) +The width of the box (how long it is along the X axis). (Read only number) +Property Details +Centre +The centre of the box. +Type +Point +Access +Read only +Corner1 +The corner of the box closest to the origin. +Type +Point +Access +Read only +Corner2 +The second corner of the box farthest from the origin. +Type +Point +Access +Read only +Depth +The depth of the box (how long it is along the Y axis). +Type +number +Access +Read only +Height +The Height of the box (how long it is along the Z axis). +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Width +The width of the box (how long it is along the X axis). +Type +number +Access +Read only +CFXModelImportSettings +The CADFEKO model (*.cfx file) import settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Set some CFX import settings +cfxImporter = project.Importer.CFXModel +cfxImporter.Settings.ImportMeshRulesEnabled = false +cfxImporter.Settings.MergeIdenticalMediaEnabled = true + -- Use the 'CFXImporter' to import a model +cfxImporter:Import(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.cfx]]) +Inheritance +The CFXModelImportSettings object is derived from the Object object. +Usage locations +The CFXModelImportSettings object can be accessed from the following locations: +• Properties +◦ CFXModelImporter object has property Settings. +Property List +ImportCableDefinitionsEnabled +Enable the importing of cable definitions from the CADFEKO model. (Read/Write boolean) +ImportGeometryEnabled +Enable the importing of geometry from the CADFEKO model. (Read/Write boolean) +ImportMeshEnabled +Enable the importing of meshes from the CADFEKO model. (Read/Write boolean) +ImportMeshRulesEnabled +Enable the importing of mesh rules from the CADFEKO model. (Read/Write boolean) +ImportOptimisationSearchesEnabled +Enable the importing of optimisation searches from the CADFEKO model. (Read/Write boolean) +ImportSolutionEntitiesEnabled +Enable the importing of solution entities from the CADFEKO model. (Read/Write boolean) +Label +The object label. (Read/Write string) +MergeIdenticalMediaEnabled +Enable the merging of identical media imported from the CADFEKO model. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +MergeIdenticalVariablesEnabled +p.176 +Enable the merging of identical variables imported from the CADFEKO model. (Read/Write +boolean) +MergeIdenticalWorkplanesEnabled +Enable the merging of identical workplanes imported from the CADFEKO model. (Read/Write +boolean) +Prefix +Type +The prefix to prepend. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RestoreDefaults () +Restores all the settings to their default values. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ImportCableDefinitionsEnabled +Enable the importing of cable definitions from the CADFEKO model. +Type +boolean +Access +Read/Write +ImportGeometryEnabled +Enable the importing of geometry from the CADFEKO model. +Type +boolean +Access +Read/Write +ImportMeshEnabled +Enable the importing of meshes from the CADFEKO model. +Type +boolean +Access +Read/Write +ImportMeshRulesEnabled +Enable the importing of mesh rules from the CADFEKO model. +Type +boolean +Access +Read/Write +ImportOptimisationSearchesEnabled +Enable the importing of optimisation searches from the CADFEKO model. +Type +boolean +Access +Read/Write +ImportSolutionEntitiesEnabled +Enable the importing of solution entities from the CADFEKO model. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MergeIdenticalMediaEnabled +Enable the merging of identical media imported from the CADFEKO model. +Type +boolean +Access +Read/Write +MergeIdenticalVariablesEnabled +Enable the merging of identical variables imported from the CADFEKO model. +Type +boolean +Access +Read/Write +MergeIdenticalWorkplanesEnabled +Enable the merging of identical workplanes imported from the CADFEKO model. +Type +boolean +Access +Read/Write +Prefix +The prefix to prepend. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RestoreDefaults () +Restores all the settings to their default values. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CFXModelImporter +The CADFEKO model (*.cfx file) importer. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Use the 'CFXImporter' to import a model +p.180 +project.Importer.CFXModel:Import(FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]) +Inheritance +The CFXModelImporter object is derived from the Object object. +Usage locations +The CFXModelImporter object can be accessed from the following locations: +• Properties +Property List +Label +The object label. (Read/Write string) +Settings +The settings to be used when importing the CADFEKO model. (Read only +CFXModelImportSettings) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Import (filename string) +Import the specified file using default settings. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +p.181 +Property Details +Label +The object label. +Type +string +Access +Read/Write +Settings +The settings to be used when importing the CADFEKO model. +Type +CFXModelImportSettings +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Import (filename string) +Import the specified file using default settings. +Input Parameters +filename(string) +The name of the file to be imported. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableBundleCableSpecification +The type and position of a cable in a cable bundle. +Example +p.183 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a cable bundle cross section +bundledCables = + { + project.Definitions.Cables.CrossSections["SingleConductor1"], + project.Definitions.Cables.CrossSections["TwistedPair1"] + } +bundle = project.Definitions.Cables.CrossSections:AddBundle(bundledCables) + -- Manually specify the position of the cables in the bundle +bundle.AutoBundleEnabled = false +bundle.BundledCables[1].OffsetX = 0.0 +bundle.BundledCables[1].OffsetY = -0.002 +bundle.BundledCables[2].OffsetX = 0.0 +bundle.BundledCables[2].OffsetY = 0.004 +Inheritance +The CableBundleCableSpecification object is derived from the CompositeValue object. +Usage locations +The CableBundleCableSpecification object can be accessed from the following locations: +• Methods +◦ CableBundleCableSpecificationList object has method Append(). +◦ CableBundleCableSpecificationList object has method Get(number). +Property List +Cable +The internal cable cross section. (Read/Write CableCrossSection) +OffsetX +The X offset of the cable. (Read/Write ParametricExpression) +OffsetY +The Y offset of the cable. (Read/Write ParametricExpression) +Rotation +The cable rotation in degrees. (Read/Write ParametricExpression) +Property Details +Cable +The internal cable cross section. +Type +CableCrossSection +Access +Read/Write +OffsetX +The X offset of the cable. +Type +ParametricExpression +Access +Read/Write +OffsetY +The Y offset of the cable. +Type +ParametricExpression +Access +Read/Write +Rotation +The cable rotation in degrees. +Type +ParametricExpression +Access +Read/Write +CableBundleCableSpecificationList +A list of CableBundleCableSpecification items. +Usage locations +The CableBundleCableSpecificationList object can be accessed from the following locations: +• Properties +◦ CableBundleCrossSection object has property BundledCables. +Method List +Append () +Appends a new item to the list. (Returns a CableBundleCableSpecification object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +CableBundleCableSpecification object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +CableBundleCableSpecification +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +CableBundleCableSpecification +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableBundleCrossSection +A cable bundle cross section. +Example +p.187 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a cable bundle cross section +bundledCables = + { + project.Definitions.Cables.CrossSections["SingleConductor1"], + project.Definitions.Cables.CrossSections["TwistedPair1"] + } +bundle = project.Definitions.Cables.CrossSections:AddBundle(bundledCables) + -- Apply a sheath around the bundle +properties = bundle:GetProperties() +properties.ShieldType = cf.Enums.CableBundleShieldTypeEnum.SheathInBackgroundMedium +properties.InsulationMedium = project.Definitions.Media.Dielectric["Insulation"] +bundle:SetProperties(properties) +Inheritance +The CableBundleCrossSection object is derived from the CableCrossSection object. +Usage locations +The CableBundleCrossSection object can be accessed from the following locations: +• Methods +◦ CableCrossSectionCollection collection has method AddBundle(table). +◦ CableCrossSectionCollection collection has method AddBundle(List of CableCrossSection). +Property List +AutoBundleEnabled +True if the cables must be auto-bundled. (Read/Write boolean) +AutoCalculateOuterRadius +True if the outer radius must be automatically calculated. It is available except when 'ShieldType' +is 'InBackgroundMedium' . (Read/Write boolean) +BundledCables +The internal cables contained in the bundle. (Read/Write CableBundleCableSpecificationList) +CablePerUnitLengthAccuracy +Select a higher accuracy when calculating cable per-unit-length parameters. (Read/Write +CablePerUnitLengthAccuracyEnum) +Coated +True if the shield is coated. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +CoatingMedium +p.188 +The shield coating medium. Only applies if the Coated property is true. (Read/Write Medium) +CoatingThickness +The coating thickness. Only applies if the Coated property is true. (Read/Write +ParametricExpression) +InsulationMedium +The internal insulation medium. It is available except when 'ShieldType' is 'InBackgroundMedium'. +(Read/Write Medium) +Label +The object label. (Read/Write string) +MinimumOuterRadius +The minimum outer radius. (Read only number) +OuterRadius +The bundle outer radius. It is available except when 'ShieldType' is 'InBackgroundMedium'. (Read/ +Write ManuallySpecifiedOrDerivedValue) +SheathThickness +The sheath thickness. It is only available when 'ShieldType' is 'SheathInBackgroundMedium' . +(Read/Write ParametricExpression) +Shield +The shield type around the bundle. It is only available when 'ShieldType' is +'InDielectricWithShield'. (Read/Write CableShield) +ShieldType +The shield type. (Read/Write CableBundleShieldTypeEnum) +TwistDirection +The cable bundle twist direction. (Read/Write CableBundleTwistDirectionEnum) +TwistPitchLength +The cable bundle twist pitch length. It is not available when 'TwistDirection' is 'NoTwist'. (Read/ +Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Rearrange () +Rearranges the cables in the bundle. +Rearrange (seed number) +p.189 +Rearranges the cables in the bundle using the given seed. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AutoBundleEnabled +True if the cables must be auto-bundled. +Type +boolean +Access +Read/Write +AutoCalculateOuterRadius +True if the outer radius must be automatically calculated. It is available except when 'ShieldType' +is 'InBackgroundMedium' . +Type +boolean +Access +Read/Write +BundledCables +The internal cables contained in the bundle. +Type +CableBundleCableSpecificationList +Access +Read/Write +CablePerUnitLengthAccuracy +Select a higher accuracy when calculating cable per-unit-length parameters. +Type +CablePerUnitLengthAccuracyEnum +Access +Read/Write +Coated +True if the shield is coated. +Type +boolean +Access +Read/Write +CoatingMedium +The shield coating medium. Only applies if the Coated property is true. +Type +Medium +Access +Read/Write +CoatingThickness +The coating thickness. Only applies if the Coated property is true. +Type +ParametricExpression +Access +Read/Write +InsulationMedium +The internal insulation medium. It is available except when 'ShieldType' is 'InBackgroundMedium'. +Type +Medium +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MinimumOuterRadius +The minimum outer radius. +Type +number +Access +Read only +OuterRadius +The bundle outer radius. It is available except when 'ShieldType' is 'InBackgroundMedium'. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +ManuallySpecifiedOrDerivedValue +Access +Read/Write +SheathThickness +p.191 +The sheath thickness. It is only available when 'ShieldType' is 'SheathInBackgroundMedium' . +Type +ParametricExpression +Access +Read/Write +Shield +The shield type around the bundle. It is only available when 'ShieldType' is +'InDielectricWithShield'. +Type +CableShield +Access +Read/Write +ShieldType +The shield type. +Type +CableBundleShieldTypeEnum +Access +Read/Write +TwistDirection +The cable bundle twist direction. +Type +CableBundleTwistDirectionEnum +Access +Read/Write +TwistPitchLength +The cable bundle twist pitch length. It is not available when 'TwistDirection' is 'NoTwist'. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Rearrange () +Rearranges the cables in the bundle. +Rearrange (seed number) +Rearranges the cables in the bundle using the given seed. +Input Parameters +seed(number) +The seed to use to perform the random rearrange. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableCoaxialCrossSection +A coaxial cable cross section. +Example +p.194 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a coaxial cross section +coaxial = project.Definitions.Cables.CrossSections:AddCoaxialUsingDimensions( + project.Definitions.Media.PerfectElectricConductor, + 0.001, + project.Definitions.Media.Dielectric:Item("Insulation"), + 0.001, + project.Definitions.Cables.Shields["CableShield1"]) + -- Modify the insulation radius +coaxial.CoreInsulatingLayers[1].Thickness = 0.002 +Inheritance +The CableCoaxialCrossSection object is derived from the CableCrossSection object. +Usage locations +The CableCoaxialCrossSection object can be accessed from the following locations: +• Methods +◦ CableCrossSectionCollection collection has method AddCoaxial(table). +◦ CableCrossSectionCollection collection has method AddCoaxialUsingDimensions(Medium, +Expression, Medium, Expression, CableShield). +◦ CableCrossSectionCollection collection has method +AddCoaxialUsingDimensionsWithCoating(Medium, Expression, Medium, Expression, +CableShield, Medium, Expression). +◦ CableCrossSectionCollection collection has method +AddCoaxialUsingPropagationCharacteristics(Expression, Expression, Expression, Expression, +CableShield). +◦ CableCrossSectionCollection collection has method +AddCoaxialUsingPropagationCharacteristicsWithCoating(Expression, Expression, Expression, +Expression, CableShield, Medium, Expression). +◦ CableCrossSectionCollection collection has method +AddPredefinedCoaxial(CablePredefinedCoaxialTypeEnum). +Property List +Attenuation +Attenuation (dB/m). (Read/Write ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +CablePerUnitLengthAccuracy +p.195 +Select a higher accuracy when calculating cable per-unit-length parameters. (Read/Write +CablePerUnitLengthAccuracyEnum) +Coated +True if the shield is coated. (Read/Write boolean) +CoatingMedium +The shield coating medium. Only applies if the Coated property is true. (Read/Write Medium) +CoatingThickness +The coating thickness. Only applies if the Coated property is true. (Read/Write +ParametricExpression) +CoreInsulatingLayers +The core insulating layers. Only applies if the 'DefinitionMethod' is 'SpecifyDimensions'. (Read/ +Write CoaxialInsulationLayerList) +CoreMedium +The core conductor medium. Only applies if the 'DefinitionMethod' is'SpecifyDimensions'. (Read/ +Write Medium) +CoreRadius +The core radius. Only applies if the 'DefinitionMethod' is'SpecifyDimensions'. (Read/Write +ParametricExpression) +DefinitionMethod +The definition method for the coaxial cable. (Read/Write CableCoaxialDefinitionEnum) +Label +The object label. (Read/Write string) +Magnitude +Magnitude of characteristic imp (Ohm). Only applies if the 'DefinitionMethod' +is'SpecifyCharacteristics'. (Read/Write ParametricExpression) +OuterRadius +The outer radius of the coaxial cable. Only applies if the 'DefinitionMethod' +is'SpecifyCharacteristics'. (Read/Write ParametricExpression) +PredefinedType +The predefined cable type. Only applies if 'DefinitionMethod' is 'Predefined'. (Read/Write +CablePredefinedCoaxialTypeEnum) +PropagationVelocity +Velocity of propagation as a percentage. (Read/Write ParametricExpression) +Shield +The coaxial shield. Only applies if the 'DefinitionMethod' is'SpecifyDimensions' or +'SpecifyCharacteristic'. (Read/Write CableShield) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Attenuation +Attenuation (dB/m). +Type +ParametricExpression +Access +Read/Write +CablePerUnitLengthAccuracy +Select a higher accuracy when calculating cable per-unit-length parameters. +Type +CablePerUnitLengthAccuracyEnum +Access +Read/Write +Coated +True if the shield is coated. +Type +boolean +Access +Read/Write +CoatingMedium +The shield coating medium. Only applies if the Coated property is true. +Type +Medium +Access +Read/Write +CoatingThickness +The coating thickness. Only applies if the Coated property is true. +Type +ParametricExpression +Access +Read/Write +CoreInsulatingLayers +The core insulating layers. Only applies if the 'DefinitionMethod' is 'SpecifyDimensions'. +Type +CoaxialInsulationLayerList +Access +Read/Write +CoreMedium +The core conductor medium. Only applies if the 'DefinitionMethod' is'SpecifyDimensions'. +Type +Medium +Access +Read/Write +CoreRadius +The core radius. Only applies if the 'DefinitionMethod' is'SpecifyDimensions'. +Type +ParametricExpression +Access +Read/Write +DefinitionMethod +The definition method for the coaxial cable. +Type +CableCoaxialDefinitionEnum +Label +Access +Read/Write +The object label. +Type +string +Access +Read/Write +Magnitude +Magnitude of characteristic imp (Ohm). Only applies if the 'DefinitionMethod' +is'SpecifyCharacteristics'. +Type +ParametricExpression +Access +Read/Write +OuterRadius +The outer radius of the coaxial cable. Only applies if the 'DefinitionMethod' +is'SpecifyCharacteristics'. +Type +ParametricExpression +Access +Read/Write +PredefinedType +The predefined cable type. Only applies if 'DefinitionMethod' is 'Predefined'. +Type +CablePredefinedCoaxialTypeEnum +Access +Read/Write +PropagationVelocity +Velocity of propagation as a percentage. +Type +ParametricExpression +Access +Read/Write +Shield +The coaxial shield. Only applies if the 'DefinitionMethod' is'SpecifyDimensions' or +'SpecifyCharacteristic'. +Type +CableShield +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CableConnector +A cable connector. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Retrieve a 'CableHarness' +cableHarness = project.Contents.CableHarnesses["CableHarness1"] + -- Retrieve the 'PathTerminal' from a 'CableConnector' +pathTerminal = cableHarness.Connectors["CableConnector1"].PathTerminal + -- Retrieve a 'CableConnectorPin' from a 'CableConnector' +cablePin = cableHarness.Connectors["CableConnector2"].Pins["Pin2"] +Inheritance +The CableConnector object is derived from the Object object. +Usage locations +The CableConnector object can be accessed from the following locations: +• Properties +◦ CableInstance object has property SourceConnector. +◦ CableInstance object has property DestinationConnector. +• Methods +◦ CableConnectorCollection collection has method Add(table). +◦ CableConnectorCollection collection has method Add(Point, string). +◦ CableConnectorCollection collection has method Add(CablePathTerminal, string). +◦ CableConnectorCollection collection has method Add(table, string). +◦ CableConnectorCollection collection has method Item(number). +◦ CableConnectorCollection collection has method Item(string). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +PathTerminal +The path terminal that this connector is connected to. This is only available when +'PositionDefinition' is set to 'PathTerminal'. (Read/Write CablePathTerminal) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Position +p.201 +The position of the connector if the Coordinate PositionDefinition is used. (Read/Write +GlobalCoordinates) +PositionDefinition +The position definition method used to define the connector. This is only available when +'PositionDefinition' is set to 'Coordinate'. (Read/Write CableConnectorPositionDefinitionEnum) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Collection List +Pins +The collection of connector pins that can be connected to cable signals and cable schematic +components. (CableConnectorPinCollection of CableConnectorPin.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +p.202 +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +PathTerminal +The path terminal that this connector is connected to. This is only available when +'PositionDefinition' is set to 'PathTerminal'. +Type +CablePathTerminal +Access +Read/Write +Position +The position of the connector if the Coordinate PositionDefinition is used. +Type +GlobalCoordinates +Access +Read/Write +PositionDefinition +The position definition method used to define the connector. This is only available when +'PositionDefinition' is set to 'Coordinate'. +Type +CableConnectorPositionDefinitionEnum +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Pins +The collection of connector pins that can be connected to cable signals and cable schematic +components. +Type +CableConnectorPinCollection +Method Details +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.204 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CableConnectorPin +A cable connector pin. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Retrieve a 'CableHarness' +cableHarness = project.Contents.CableHarnesses:Item("CableHarness1") + -- Retrieve a 'CableConnectorPin' from a 'CableConnector' +cableConnectorPin = cableHarness.Connectors["CableConnector2"].Pins["Pin2"] + -- Retrieve the terminal associated with the 'CableConnectorPin' +terminal = cableConnectorPin.Terminal +Inheritance +The CableConnectorPin object is derived from the Object object. +Usage locations +The CableConnectorPin object can be accessed from the following locations: +• Properties +◦ CableSignal object has property Destination. +◦ CableSignal object has property Source. +• Methods +◦ CableConnectorPinCollection collection has method Item(number). +◦ CableConnectorPinCollection collection has method Item(string). +Property List +Label +The object label. (Read/Write string) +Terminal +The terminal associated with the pin used to connect to circuit components. (Read only Terminal) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.206 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Terminal +The terminal associated with the pin used to connect to circuit components. +Type +Terminal +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.207 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CableCrossSection +A cable cross section. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Rename SingleConductor1 to MyConductor +project.Definitions.Cables.CrossSections["SingleConductor1"].Label = "MyConductor" +Inheritance +The CableCrossSection object is derived from the Object object. +The following objects are derived (specialisations) from the CableCrossSection object: +• CableBundleCrossSection +• CableCoaxialCrossSection +• CableNonConductingElementCrossSection +• CableRibbonCrossSection +• CableSingleConductorCrossSection +• CableTwistedPairCrossSection +Usage locations +The CableCrossSection object can be accessed from the following locations: +• Properties +◦ CableInstance object has property CrossSection. +◦ CableBundleCableSpecification object has property Cable. +• Methods +◦ CableCrossSectionCollection collection has method Item(number). +◦ CableCrossSectionCollection collection has method Item(string). +Property List +CablePerUnitLengthAccuracy +Select a higher accuracy when calculating cable per-unit-length parameters. (Read/Write +CablePerUnitLengthAccuracyEnum) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CablePerUnitLengthAccuracy +Select a higher accuracy when calculating cable per-unit-length parameters. +Type +CablePerUnitLengthAccuracyEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.210 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableGeneralNetwork +A cable general network component. +Example +p.211 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add 'CableGeneralNetwork' with 4 ports referencing a file +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +network = + cableHarness.CableSchematic.Components:AddGeneralNetwork(4, "GeneralCircuitFile") + -- Change the number of pins the 'CableGeneralNetwork' has to 2 +cableHarness.CableSchematic.Components["Circuit1"].NumberOfPorts = 4 +Inheritance +The CableGeneralNetwork object is derived from the Object object. +Usage locations +The CableGeneralNetwork object can be accessed from the following locations: +• Methods +◦ CableSchematicComponentCollection collection has method AddGeneralNetwork(table). +◦ CableSchematicComponentCollection collection has method AddGeneralNetwork(number, +string). +Property List +Filename +The file containing the contents of the general circuit touchstone file. (Read/Write FileReference) +Label +The object label. (Read/Write string) +NumberOfPorts +The number of ports on the general networks. (Read/Write number) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.212 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Filename +The file containing the contents of the general circuit touchstone file. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +NumberOfPorts +The number of ports on the general networks. +Type +number +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.214 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CableHarness +A cable harness. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Access an existing 'CableHarness' +cableHarness = project.Contents.CableHarnesses["CableHarness1"] + -- Change the cable coupling property +cableHarness.CableCoupling + = cf.Enums.CableHarnessCouplingEnum.RadiatingWithIrradiating + -- Access a "Connector" on the 'CableHarness' +connector = cableHarness.Connectors[1] +Inheritance +The CableHarness object is derived from the Object object. +Usage locations +The CableHarness object can be accessed from the following locations: +• Properties +◦ CablePort object has property Harness. +• Methods +◦ CableHarnessCollection collection has method Add(). +◦ CableHarnessCollection collection has method Add(table). +◦ CableHarnessCollection collection has method Item(number). +◦ CableHarnessCollection collection has method Item(string). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CableCoupling +The cable coupling properties. e.g. Irradiating, Radiating, ... (Read/Write +CableHarnessCouplingEnum) +ConnectorsVisible +Controls the visibility of cable harness connectors on the 3D View. (Read/Write boolean) +Label +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SolutionMethod +p.216 +The solution method for the outer cable problem (shielded/external ground). (Read/Write +CableHarnessSolutionMethodEnum) +Type +The object type string. (Read only string) +Collection List +CableInstances +The collection of cable instances in the cable harness. (CableInstanceCollection of CableInstance.) +Connectors +The collection of cable connectors in the cable harness. (CableConnectorCollection of +CableConnector.) +Probes +The collection of cable probes on the cable harness. (CableProbeCollection of CableProbe.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RearrangeCrossSections () +Randomly rearranges the cable harness cross sections. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CableCoupling +The cable coupling properties. e.g. Irradiating, Radiating, ... +Type +CableHarnessCouplingEnum +Access +Read/Write +ConnectorsVisible +Controls the visibility of cable harness connectors on the 3D View. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +SolutionMethod +The solution method for the outer cable problem (shielded/external ground). +Type +CableHarnessSolutionMethodEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +CableInstances +The collection of cable instances in the cable harness. +Type +Connectors +CableInstanceCollection +The collection of cable connectors in the cable harness. +Type +Probes +CableConnectorCollection +The collection of cable probes on the cable harness. +Type +CableProbeCollection +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RearrangeCrossSections () +Randomly rearranges the cable harness cross sections. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CableInstance +A cable instance. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Get an existing 'CableHarness' +cableHarness = project.Contents.CableHarnesses["CableHarness1"] + -- Get a 'CableInstance' +cableInstance = cableHarness.CableInstances["Cable1"] +Inheritance +The CableInstance object is derived from the Object object. +Usage locations +The CableInstance object can be accessed from the following locations: +• Properties +• Methods +◦ CableInstanceCollection collection has method Add(table). +◦ CableInstanceCollection collection has method Add(CableCrossSection, CableConnector, +CableConnector). +◦ CableInstanceCollection collection has method Item(number). +◦ CableInstanceCollection collection has method Item(string). +Property List +AvailableRoutes +The available cable path routes between the source and destination connectors. (Read only List of +CableRoute) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CrossSection +The cable cross section type for the cable. (Read/Write CableCrossSection) +DestinationConnector +The destination connector where the cable ends. (Read/Write CableConnector) +Label +Route +The object label. (Read/Write string) +The route the cable follows. Setting this property will adjust the ShortestRouteEnabled property to +false. (Read/Write CableRoute) +SourceConnector +The source connector where the cable starts. (Read/Write CableConnector) +Type +The object type string. (Read only string) +Collection List +Signals +The cable signal settings. (CableSignalCollection of CableSignal.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AvailableRoutes +The available cable path routes between the source and destination connectors. +Access +Read only +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CrossSection +The cable cross section type for the cable. +Type +CableCrossSection +Access +Read/Write +DestinationConnector +The destination connector where the cable ends. +Type +CableConnector +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Route +The route the cable follows. Setting this property will adjust the ShortestRouteEnabled property to +false. +Type +CableRoute +Access +Read/Write +SourceConnector +The source connector where the cable starts. +Type +CableConnector +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Signals +The cable signal settings. +Type +CableSignalCollection +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CableNonConductingElementCrossSection +A non conducting element cable cross section. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a non-conducting element cross section +element = + project.Definitions.Cables.CrossSections:AddNonConductingElementFromParameters( + project.Definitions.Media.Dielectric["Insulation"], 0.002) + -- Modify the label of the cross section +element.Label = "Spacer" +Inheritance +The CableNonConductingElementCrossSection object is derived from the CableCrossSection object. +Usage locations +The CableNonConductingElementCrossSection object can be accessed from the following locations: +• Methods +◦ CableCrossSectionCollection collection has method AddNonConductingElement(table). +◦ CableCrossSectionCollection collection has method +AddNonConductingElementFromParameters(Medium, Expression). +Property List +CablePerUnitLengthAccuracy +Select a higher accuracy when calculating cable per-unit-length parameters. (Read/Write +CablePerUnitLengthAccuracyEnum) +FibreMedium +The fibre medium. (Read/Write Medium) +FibreRadius +The fibre radius. (Read/Write ParametricExpression) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +p.224 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CablePerUnitLengthAccuracy +Select a higher accuracy when calculating cable per-unit-length parameters. +Type +CablePerUnitLengthAccuracyEnum +Access +Read/Write +FibreMedium +The fibre medium. +Type +Medium +Access +Read/Write +FibreRadius +The fibre radius. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CablePath +A cable path. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a cable path to the model +corners = {cf.Point(0,0,0), cf.Point(0,1,0), cf.Point(1,1,0), cf.Point(1,0,0)} +path = project.Definitions.Cables.Paths:Add(corners) + -- Change the label of the path +path.Label = "MyPath" +Inheritance +The CablePath object is derived from the Object object. +Usage locations +The CablePath object can be accessed from the following locations: +• Properties +◦ CableProbe object has property Path. +• Methods +◦ CablePathCollection collection has method Add(table). +◦ CablePathCollection collection has method Add(List of Point). +◦ CablePathCollection collection has method Item(number). +◦ CablePathCollection collection has method Item(string). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Corners +A collection of corner coordinates. (Read/Write LocalInternalCoordinateList) +EndTerminal +The cable path end terminal. (Read only CablePathTerminal) +ExportCableParametersEnabled +When enabled, cable parameters such as inductance/capacitance matrices and transfer +impedance/admittance are exported to the .out file. (Read/Write boolean) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +ManuallySetReferenceVector +Enables manual specification of the reference vector. (Read/Write boolean) +MaxSeparationDistance +The maximum separation distance used when the SamplingPointDensityOption is +'SpecifyMaximumSeparationDistance'. (Read/Write ParametricExpression) +MeshRefinementEnabled +Refine the mesh close to the cable terminals. (Read/Write boolean) +ReferenceVector +The reference vector for cross section orientation on the cable path. (Read/Write LocalCoordinate) +SamplingPointDensityOption +Specify the sampling point density option. (Read/Write SamplingPointDensityEnum) +StartTerminal +The cable path start terminal. (Read only CablePathTerminal) +TwistAngle +The twist angle applied to the reference vector along the cable path. (Read/Write +ParametricExpression) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.228 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Corners +A collection of corner coordinates. +Type +LocalInternalCoordinateList +Access +Read/Write +EndTerminal +The cable path end terminal. +Type +CablePathTerminal +Access +Read only +ExportCableParametersEnabled +When enabled, cable parameters such as inductance/capacitance matrices and transfer +impedance/admittance are exported to the .out file. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +ManuallySetReferenceVector +Enables manual specification of the reference vector. +Type +boolean +Access +Read/Write +MaxSeparationDistance +The maximum separation distance used when the SamplingPointDensityOption is +'SpecifyMaximumSeparationDistance'. +Type +ParametricExpression +Access +Read/Write +MeshRefinementEnabled +Refine the mesh close to the cable terminals. +Type +boolean +Access +Read/Write +ReferenceVector +The reference vector for cross section orientation on the cable path. +Type +LocalCoordinate +Access +Read/Write +SamplingPointDensityOption +Specify the sampling point density option. +Type +SamplingPointDensityEnum +Access +Read/Write +StartTerminal +The cable path start terminal. +Type +CablePathTerminal +Access +Read only +TwistAngle +The twist angle applied to the reference vector along the cable path. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CablePathTerminal +A cable path terminal. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Retrieve the 'StartTerminal' from a 'CablePath' +pathTerminal = project.Definitions.Cables.Paths["CablePath1"].StartTerminal + -- Retrieve 'PathTerminal' from the end cable connector +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +connectorPathTerminal = cableHarness.Connectors["CableConnector2"].PathTerminal +Inheritance +The CablePathTerminal object is derived from the Object object. +Usage locations +The CablePathTerminal object can be accessed from the following locations: +• Properties +◦ CableConnector object has property PathTerminal. +◦ CablePath object has property EndTerminal. +◦ CablePath object has property StartTerminal. +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.234 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +table +A table defining the properties. +SetProperties (properties Object) +p.235 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CablePort +A cable port is created on a cable harness schematic. +Example +p.236 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a voltageSource with a magnitude of 1, 50 Ohm impedance and zero phase +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +terminal1 = cableHarness.Connectors["CableConnector1"].Pins["Pin2"].Terminal +terminal2 = cableHarness.Connectors["CableConnector2"].Pins["Pin1"].Terminal +port2 = project.Contents.Ports:AddCablePort(cableHarness, terminal1, terminal2) +voltageSource1 = + project.Contents.SolutionConfigurations.GlobalSources:AddVoltageSource(port2) + -- Change and existing voltageSource's impedance +voltageSource1.Impedance = 75 +Inheritance +The CablePort object is derived from the Port object. +Usage locations +The CablePort object can be accessed from the following locations: +• Methods +◦ PortCollection collection has method AddCablePort(CableHarness). +◦ PortCollection collection has method AddCablePort(CableHarness, Terminal, Terminal). +◦ PortCollection collection has method AddCablePort(table). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Harness +The cable harness. (Read/Write CableHarness) +Label +The object label. (Read/Write string) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Harness +The cable harness. +Type +CableHarness +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CableProbe +A cable probe. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Get an existing 'CableProbe' +cableProbe = project.Contents.CableHarnesses["CableHarness1"].Probes["CableProbe1"] + -- Change the 'CableProbe' to measure both current and voltage +cableProbe.ProbeType = cf.Enums.CableProbeTypeEnum.CurrentAndVoltage + -- Change the 'CableProbe' to be positioned at a specified distance +properties = {} +properties.LocationType = cf.Enums.CableProbeLocationTypeEnum.DistanceOnPath +properties.PositionDistance = 3 +cableProbe:SetProperties(properties) +Inheritance +The CableProbe object is derived from the Object object. +Usage locations +The CableProbe object can be accessed from the following locations: +• Methods +◦ CableProbeCollection collection has method Add(table). +◦ CableProbeCollection collection has method Add(CablePath). +◦ CableProbeCollection collection has method Item(number). +◦ CableProbeCollection collection has method Item(string). +Property List +Label +The object label. (Read/Write string) +LocationType +The location option for the probe. (Read/Write CableProbeLocationTypeEnum) +Path +The cable path that the probe is on. (Read/Write CablePath) +PositionDistance +The distance along the cable path if the LocationType is DistanceOnPath. (Read/Write +ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +PositionPercentage +p.242 +The percentage along the cable path if the LocationType is PercentageOnPath. (Read/Write +ParametricExpression) +ProbeType +The type of the probe. (Read/Write CableProbeTypeEnum) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +LocationType +The location option for the probe. +Type +CableProbeLocationTypeEnum +Access +Read/Write +Path +The cable path that the probe is on. +Type +CablePath +Access +Read/Write +PositionDistance +The distance along the cable path if the LocationType is DistanceOnPath. +Type +ParametricExpression +Access +Read/Write +PositionPercentage +The percentage along the cable path if the LocationType is PercentageOnPath. +Type +ParametricExpression +Access +Read/Write +ProbeType +The type of the probe. +Type +CableProbeTypeEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.244 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableRibbonCrossSection +A ribbon cross section. +Example +p.245 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a ribbon cross section +ribbon = project.Definitions.Cables.CrossSections:AddRibbonWithInsulation( + project.Definitions.Media.PerfectElectricConductor, 0.001, + project.Definitions.Media.Dielectric["Insulation"], 0.0005, 5, 0.003) + -- Adjust the number of cores to 3 +ribbon.CoreCount = 3 +Inheritance +The CableRibbonCrossSection object is derived from the CableCrossSection object. +Usage locations +The CableRibbonCrossSection object can be accessed from the following locations: +• Methods +◦ CableCrossSectionCollection collection has method AddRibbon(table). +◦ CableCrossSectionCollection collection has method AddRibbon(Medium, Expression, +Expression, Expression). +◦ CableCrossSectionCollection collection has method AddRibbonWithInsulation(Medium, +Expression, Medium, Expression, Expression, Expression). +Property List +CablePerUnitLengthAccuracy +Select a higher accuracy when calculating cable per-unit-length parameters. (Read/Write +CablePerUnitLengthAccuracyEnum) +CoreCount +The number of cores. (Read/Write ParametricExpression) +CoreMedium +The conductor core medium. (Read/Write Medium) +CoreRadius +The core radius. (Read/Write ParametricExpression) +CoreSpacing +The core spacing. (Read/Write ParametricExpression) +Insulated +True if the conductor is insulated. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +InsulationMedium +p.246 +The conductor insulation medium. Only applies if the 'Insulated' property is true. (Read/Write +Medium) +InsulationThickness +The insulation thickness. Only applies if the 'Insulated' property is true. (Read/Write +ParametricExpression) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CablePerUnitLengthAccuracy +Select a higher accuracy when calculating cable per-unit-length parameters. +Type +CablePerUnitLengthAccuracyEnum +Access +Read/Write +CoreCount +The number of cores. +Type +ParametricExpression +Access +Read/Write +CoreMedium +The conductor core medium. +Type +Medium +Access +Read/Write +CoreRadius +The core radius. +Type +ParametricExpression +Access +Read/Write +CoreSpacing +The core spacing. +Type +ParametricExpression +Access +Read/Write +Insulated +True if the conductor is insulated. +Type +boolean +Access +Read/Write +InsulationMedium +The conductor insulation medium. Only applies if the 'Insulated' property is true. +Type +Medium +Access +Read/Write +InsulationThickness +The insulation thickness. Only applies if the 'Insulated' property is true. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableSchematicCurrentProbe +A cable voltage current component. +Example +p.250 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a 'CableSchematicCurrentProbe' +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +terminal1 = cableHarness.CableSchematic.Components["R1"].Terminals[2] +terminal2 = cableHarness.Connectors["CableConnector2"].Pins["Pin2"].Terminal +currentProbe = cableHarness.CableSchematic.Components:AddCurrentProbe(terminal1, + terminal2) + -- Get the terminals that the 'CableSchematicCurrentProbe' is connected to +terminalList = cableHarness.CableSchematic.Components["P1"].Terminals +Inheritance +The CableSchematicCurrentProbe object is derived from the Object object. +Usage locations +The CableSchematicCurrentProbe object can be accessed from the following locations: +• Methods +◦ CableSchematicComponentCollection collection has method AddCurrentProbe(Terminal, +Terminal). +◦ CableSchematicComponentCollection collection has method AddCurrentProbe(table). +Property List +Label +The object label. (Read/Write string) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableSchematicVoltageProbe +A cable voltage probe component. +Example +p.254 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a 'CableSchematicVoltageProbe' +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +terminal1 = cableHarness.Connectors["CableConnector2"].Pins["Pin2"].Terminal +terminal2 = cableHarness.Connectors["CableConnector2"].Pins["Pin1"].Terminal +voltageProbe = cableHarness.CableSchematic.Components:AddVoltageProbe(terminal1, + terminal2) + -- Get the terminals that the 'CableSchematicVoltageProbe' is connected to +terminalList = cableHarness.CableSchematic.Components["P1"].Terminals +Inheritance +The CableSchematicVoltageProbe object is derived from the Object object. +Usage locations +The CableSchematicVoltageProbe object can be accessed from the following locations: +• Methods +◦ CableSchematicComponentCollection collection has method AddVoltageProbe(Terminal, +Terminal). +◦ CableSchematicComponentCollection collection has method AddVoltageProbe(table). +Property List +Label +The object label. (Read/Write string) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CableShield +A cable shield. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a solid shield +shield = + project.Definitions.Cables.Shields:AddSingleLayerSolidShield(project.Definitions.Media.PerfectElectricConductor, 0.0005) + -- Modify the label of the shield +shield.Label = "MyLabel" +Inheritance +The CableShield object is derived from the Object object. +Usage locations +The CableShield object can be accessed from the following locations: +• Properties +◦ CableBundleCrossSection object has property Shield. +◦ CableCoaxialCrossSection object has property Shield. +• Methods +◦ CableShieldCollection collection has method AddSingleLayerBraidedDemoulinShield(Expression, +Expression, Expression, Expression, Medium). +◦ CableShieldCollection collection has method AddSingleLayerBraidedKleyShield(Expression, +Expression, Expression, Expression, Medium). +◦ CableShieldCollection collection has method AddSingleLayerBraidedTyniShield(Expression, +Expression, Expression, Expression, Medium). +◦ CableShieldCollection collection has method AddSingleLayerBraidedVanceShield(Expression, +Expression, Expression, Expression, Medium). +◦ CableShieldCollection collection has method AddSingleLayerSolidShield(Medium, Expression). +◦ CableShieldCollection collection has method AddShield(table). +◦ CableShieldCollection collection has method Item(number). +◦ CableShieldCollection collection has method Item(string). +Property List +GapBetweenLayers +The gap between shield layers. (Read/Write ParametricExpression) +InnerLayer +The inner shield layer settings. (Read/Write ShieldLayerSettings) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Label +The object label. (Read/Write string) +OuterLayer +The outer shield layer settings. (Read/Write ShieldLayerSettings) +ShieldLayerType +The shield layer type: single or double layered. (Read/Write CableShieldLayerOptionsEnum) +p.259 +StretchingOptimisationMethod +The shield stretching optimisation method. (Read/Write +CableShieldStretchingOptimisationMethodEnum) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +GapBetweenLayers +The gap between shield layers. +Type +ParametricExpression +Access +Read/Write +InnerLayer +The inner shield layer settings. +Type +ShieldLayerSettings +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +OuterLayer +The outer shield layer settings. +Type +ShieldLayerSettings +Access +Read/Write +ShieldLayerType +The shield layer type: single or double layered. +Type +CableShieldLayerOptionsEnum +Access +Read/Write +StretchingOptimisationMethod +The shield stretching optimisation method. +Type +CableShieldStretchingOptimisationMethodEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.261 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CableSignal +The cable signal. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Get an existing 'CableHarness' +cableHarness = project.Contents.CableHarnesses["CableHarness1"] + -- Get a 'CableInstance' +cableInstance = cableHarness.CableInstances["Cable1"] + -- Change the signal name +cableInstance.Signals[1].Label = "UnconnectedSignal" + -- Swap source connection pins +cableInstance.Signals[1].Source = + cableHarness.Connectors["CableConnector1"].Pins["Pin2"] +cableInstance.Signals[2].Source = + cableHarness.Connectors["CableConnector1"].Pins["Pin1"] +Inheritance +The CableSignal object is derived from the Object object. +Usage locations +The CableSignal object can be accessed from the following locations: +• Methods +◦ CableSignalCollection collection has method Item(number). +◦ CableSignalCollection collection has method Item(string). +Property List +Destination +The destination connector pin this signal is attached to. (Read/Write CableConnectorPin) +Label +The object label. (Read/Write string) +Source +The source connector pin this signal is attached to. (Read/Write CableConnectorPin) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Destination +The destination connector pin this signal is attached to. +Type +CableConnectorPin +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Source +The source connector pin this signal is attached to. +Type +CableConnectorPin +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableSingleConductorCrossSection +A single conductor cable cross section. +Example +p.265 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a single conductor cross section +conductor = + project.Definitions.Cables.CrossSections:AddSingleConductorWithInsulation( + project.Definitions.Media.PerfectElectricConductor, 0.001, + project.Definitions.Media.Dielectric["Insulation"], 0.0005) + -- Remove the insulation from the conductor +conductor.Insulated = false +Inheritance +The CableSingleConductorCrossSection object is derived from the CableCrossSection object. +Usage locations +The CableSingleConductorCrossSection object can be accessed from the following locations: +• Methods +◦ CableCrossSectionCollection collection has method AddSingleConductor(table). +◦ CableCrossSectionCollection collection has method AddSingleConductor(Medium, Expression). +◦ CableCrossSectionCollection collection has method AddSingleConductorWithInsulation(Medium, +Expression, Medium, Expression). +Property List +CablePerUnitLengthAccuracy +Select a higher accuracy when calculating cable per-unit-length parameters. (Read/Write +CablePerUnitLengthAccuracyEnum) +CoreMedium +The conductor core medium. (Read/Write Medium) +CoreRadius +The code radius. (Read/Write ParametricExpression) +Insulated +True if the conductor is insulated. (Read/Write boolean) +InsulationMedium +The conductor insulation medium. Only applies if the 'Insulated' property is true. (Read/Write +Medium) +Altair Feko 2022.3 +2 Application Programming Interface (API) +InsulationThickness +The insulation thickness. Only applies if the 'Insulated' property is true. (Read/Write +ParametricExpression) +p.266 +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CablePerUnitLengthAccuracy +Select a higher accuracy when calculating cable per-unit-length parameters. +Type +CablePerUnitLengthAccuracyEnum +Access +Read/Write +CoreMedium +The conductor core medium. +Type +Medium +Access +Read/Write +CoreRadius +The code radius. +Type +ParametricExpression +Access +Read/Write +Insulated +True if the conductor is insulated. +Type +boolean +Access +Read/Write +InsulationMedium +The conductor insulation medium. Only applies if the 'Insulated' property is true. +Type +Medium +Access +Read/Write +InsulationThickness +The insulation thickness. Only applies if the 'Insulated' property is true. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.268 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableSpiceNetwork +A cable spice network component. +Example +p.269 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add 'CableSpiceNetwork' with 4 pins referencing a file +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +resistor = + cableHarness.CableSchematic.Components:AddSpiceNetworkFromFile(4, "SPICECircuitFile") + -- Change the number of pins the 'CableSpiceNetwork' has to 2 +cableHarness.CableSchematic.Components["Circuit1"].NumberOfPins = 2 +Inheritance +The CableSpiceNetwork object is derived from the Object object. +Usage locations +The CableSpiceNetwork object can be accessed from the following locations: +• Methods +◦ CableSchematicComponentCollection collection has method AddSpiceNetwork(table). +◦ CableSchematicComponentCollection collection has method AddSpiceNetworkFromFile(number, +string). +◦ CableSchematicComponentCollection collection has method AddSpiceNetwork(number, string). +Property List +Filename +The file containing the contents of the spice circuit. This is only valid if the SpiceCircuitSource has +the type File. (Read/Write FileReference) +Label +The object label. (Read/Write string) +ManualSource +The contents of the spice circuit of the source is Manual. This is only valid if SpiceCircuitSource +has the type Manual. (Read/Write string) +NumberOfPins +The number of pins in the spice networks. (Read/Write number) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +SpiceCircuitSource +The source of the spice network circuit. (Read/Write CableSpiceNetworkSourceTypeEnum) +SubCircuitName +The sub circuit name. (Read/Write string) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Filename +The file containing the contents of the spice circuit. This is only valid if the SpiceCircuitSource has +the type File. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +ManualSource +The contents of the spice circuit of the source is Manual. This is only valid if SpiceCircuitSource +has the type Manual. +Type +string +Access +Read/Write +NumberOfPins +The number of pins in the spice networks. +Type +number +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +SpiceCircuitSource +The source of the spice network circuit. +Type +CableSpiceNetworkSourceTypeEnum +Access +Read/Write +SubCircuitName +The sub circuit name. +Type +string +Access +Read/Write +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +p.273 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableTwistedPairCrossSection +A twisted pair cable cross section. +Example +p.274 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a twisted pair cross section +twistedPair = project.Definitions.Cables.CrossSections:AddTwistedPairWithInsulation( + project.Definitions.Media.PerfectElectricConductor, 0.001, + project.Definitions.Media.Dielectric["Insulation"], 0.0005, + cf.Enums.TwistDirectionEnum.Left, 0.003, 0.01) + -- Reverse the twist direction +twistedPair.TwistDirection = cf.Enums.TwistDirectionEnum.Right +Inheritance +The CableTwistedPairCrossSection object is derived from the CableCrossSection object. +Usage locations +The CableTwistedPairCrossSection object can be accessed from the following locations: +• Methods +◦ CableCrossSectionCollection collection has method AddTwistedPair(table). +◦ CableCrossSectionCollection collection has method AddTwistedPair(Medium, Expression, +TwistDirectionEnum, Expression, Expression). +◦ CableCrossSectionCollection collection has method AddTwistedPairWithInsulation(Medium, +Expression, Dielectric, Expression, TwistDirectionEnum, Expression, Expression). +Property List +CablePerUnitLengthAccuracy +Select a higher accuracy when calculating cable per-unit-length parameters. (Read/Write +CablePerUnitLengthAccuracyEnum) +CoreMedium +The conductor core medium. (Read/Write Medium) +CoreRadius +The core radius. (Read/Write ParametricExpression) +Insulated +True is the conductor is insulated. (Read/Write boolean) +InsulationMedium +The conductor insulation medium. Only applies if the 'Insulated' property is true. (Read/Write +Medium) +Altair Feko 2022.3 +2 Application Programming Interface (API) +InsulationThickness +The insulation thickness. Only applies if the 'Insulated' property is true. (Read/Write +ParametricExpression) +p.275 +Label +The object label. (Read/Write string) +TwistDirection +The twist direction. (Read/Write TwistDirectionEnum) +TwistPitchLength +The twist pitch length. (Read/Write ParametricExpression) +TwistRadius +The twist radius. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CablePerUnitLengthAccuracy +Select a higher accuracy when calculating cable per-unit-length parameters. +Type +CablePerUnitLengthAccuracyEnum +Access +Read/Write +CoreMedium +The conductor core medium. +Type +Medium +Access +Read/Write +CoreRadius +The core radius. +Type +ParametricExpression +Access +Read/Write +Insulated +True is the conductor is insulated. +Type +boolean +Access +Read/Write +InsulationMedium +The conductor insulation medium. Only applies if the 'Insulated' property is true. +Type +Medium +Access +Read/Write +InsulationThickness +The insulation thickness. Only applies if the 'Insulated' property is true. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +TwistDirection +The twist direction. +Type +TwistDirectionEnum +Access +Read/Write +TwistPitchLength +The twist pitch length. +Type +ParametricExpression +Access +Read/Write +TwistRadius +The twist radius. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Cables +Cable definitions and harnesses. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Get an existing 'CableHarness' +cableHarness = project.Contents.CableHarnesses["CableHarness1"] + -- Get an existing 'CablePath' +cablePath = project.Definitions.Cables.Paths["CablePath1"] +Inheritance +The Cables object is derived from the Object object. +Usage locations +The Cables object can be accessed from the following locations: +• Properties +◦ ModelDefinitions object has property Cables. +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Collection List +CrossSections +A collection of cable cross sections. (CableCrossSectionCollection of CableCrossSection.) +Paths +The collection of cable paths in the model. (CablePathCollection of CablePath.) +Shields +The collection of cable shields in the model. (CableShieldCollection of CableShield.) +Method List +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +p.280 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +CrossSections +A collection of cable cross sections. +Type +CableCrossSectionCollection +Paths +The collection of cable paths in the model. +Type +CablePathCollection +Shields +The collection of cable shields in the model. +Type +CableShieldCollection +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Capacitor +A cable capacitor component. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a 1nF capacitor +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +cableHarnessView = + application.MainWindow.MdiArea:CreateCableSchematicView(cableHarness) +terminal1 = cableHarness.Connectors["CableConnector2"].Pins["Pin2"].Terminal +terminal2 = cableHarness.Connectors["CableConnector2"].Pins["Pin1"].Terminal +capacitor = cableHarness.CableSchematic.Components:AddCapacitor(terminal1, terminal2, + 1e-9) + -- Change the capacitor's capacitance +cableHarness.CableSchematic.Components["C1"].Capacitance = 5e-6 +Inheritance +The Capacitor object is derived from the Object object. +Usage locations +The Capacitor object can be accessed from the following locations: +• Methods +◦ CableSchematicComponentCollection collection has method AddCapacitor(). +◦ CableSchematicComponentCollection collection has method AddCapacitor(table). +◦ CableSchematicComponentCollection collection has method AddCapacitor(Terminal, Terminal, +Expression). +Property List +Capacitance +The capacitance of the capacitor in Farad. (Read/Write ParametricExpression) +CurrentProbeEnabled +True if a current probe must be applied to the component. (Read/Write boolean) +Label +The object label. (Read/Write string) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +VoltageProbeEnabled +True if a current probe must be applied to the component. (Read/Write boolean) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Capacitance +The capacitance of the capacitor in Farad. +Type +ParametricExpression +Access +Read/Write +CurrentProbeEnabled +True if a current probe must be applied to the component. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VoltageProbeEnabled +True if a current probe must be applied to the component. +Type +boolean +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CartesianDescription +p.287 +The description of an analytical curve using the Cartesian coordinate system. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +analyticalCurve = project.Contents.Geometry:AddAnalyticalCurve(0, 1, "t", "t^2", 0) + -- Access the Cartesian description +analyticalCurve.CartesianDescription.U = 0 +analyticalCurve.CartesianDescription.N = "t" +Inheritance +The CartesianDescription object is derived from the CompositeValue object. +Usage locations +The CartesianDescription object can be accessed from the following locations: +• Properties +◦ AnalyticalCurve object has property CartesianDescription. +• Methods +◦ CartesianDescriptionList object has method Append(). +◦ CartesianDescriptionList object has method Get(number). +Property List +The curve description in the N dimension as a function of variable t. (Read/Write +ParametricExpression) +The curve description in the U dimension as a function of variable t. (Read/Write +ParametricExpression) +The curve description in the V dimension as a function of variable t. (Read/Write +ParametricExpression) +Property Details +The curve description in the N dimension as a function of variable t. +Type +ParametricExpression +Access +Read/Write +The curve description in the U dimension as a function of variable t. +Type +ParametricExpression +Access +Read/Write +The curve description in the V dimension as a function of variable t. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +CartesianDescriptionList +A list of CartesianDescription items. +Method List +Append () +p.289 +Appends a new item to the list. (Returns a CartesianDescription object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a CartesianDescription object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +CartesianDescription +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +CartesianDescription +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CartesianRequestPoints +The Cartesian request point positions. +Example +p.291 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a NearField starting at (1,0,0) ending at (0,0,0) with 11 points along X +nearField = project.Contents.SolutionConfigurations[1].NearFields:AddCartesian(1,0,0, + 0,0,0, + 11,1,1) +cartesianRequestPoints = nearField.CartesianRequestPoints + -- Get the U coordinate of the start of the NearField, which is 1 +startU = cartesianRequestPoints.U.Start + -- Get the U coordinate of the end of the NearField, which is 0 +endU = cartesianRequestPoints.U.End +Inheritance +The CartesianRequestPoints object is derived from the CompositeValue object. +Usage locations +The CartesianRequestPoints object can be accessed from the following locations: +• Properties +◦ NearField object has property CartesianRequestPoints. +• Methods +◦ CartesianRequestPointsList object has method Append(). +◦ CartesianRequestPointsList object has method Get(number). +Property List +The N range of points. (Read/Write PointRange) +The U range of points. (Read/Write PointRange) +The V range of points. (Read/Write PointRange) +Property Details +The N range of points. +Type +PointRange +Access +Read/Write +The U range of points. +Type +PointRange +Access +Read/Write +The V range of points. +Type +PointRange +Access +Read/Write +CartesianRequestPointsList +A list of CartesianRequestPoints items. +Method List +Append () +Appends a new item to the list. (Returns a CartesianRequestPoints object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a CartesianRequestPoints +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +CartesianRequestPoints +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +CartesianRequestPoints +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.294 +Altair Feko 2022.3 +2 Application Programming Interface (API) +CartesianStructure +The cartesian coordinate system source description. +Example +p.295 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a 'NearFieldFileStructure' from a set of default properties +properties = cf.NearFieldDataFileStructure.GetDefaultProperties() +properties.CoordinateType = cf.Enums.NearFieldDataCoordinateTypeEnum.Cartesian +properties.CartesianStructure.Height = "2" +properties.CartesianStructure.Width = "2" +properties.CartesianStructure.UPoints = "11" +properties.CartesianStructure.VPoints = "11" +properties.EFieldFilename = [[EFieldFileName]] +properties.HFieldFilename = [[HFieldFileName]] +nearFieldData = + project.Definitions.FieldDataList:AddNearFieldDataFileStructure(properties) + -- Change the height of the cartesian face +nearFieldData.CartesianStructure.Height = "4" +Inheritance +The CartesianStructure object is derived from the CompositeValue object. +Usage locations +The CartesianStructure object can be accessed from the following locations: +• Properties +◦ NearFieldDataFileStructure object has property CartesianStructure. +• Methods +◦ CartesianStructureList object has method Append(). +◦ CartesianStructureList object has method Get(number). +Property List +Height +The height of the Cartesian face. (Read/Write Dimension) +UPoints +The number of points along U. (Read/Write ParametricExpression) +VPoints +The number of points along V. (Read/Write ParametricExpression) +Width +The width of the Cartesian face. (Read/Write Dimension) +Property Details +Height +The height of the Cartesian face. +Type +Dimension +Access +Read/Write +UPoints +The number of points along U. +Type +ParametricExpression +Access +Read/Write +VPoints +The number of points along V. +Type +ParametricExpression +Access +Read/Write +Width +The width of the Cartesian face. +Type +Dimension +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +CartesianStructureList +A list of CartesianStructure items. +Method List +Append () +p.297 +Appends a new item to the list. (Returns a CartesianStructure object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a CartesianStructure object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +CartesianStructure +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +CartesianStructure +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +CharacterisedSurface +A characterised surface medium. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create an characterised surface +characterisedSurface = + project.Definitions.Media.CharacterisedSurface:AddCharacterisedSurface("dummyFile") +Inheritance +The CharacterisedSurface object is derived from the Medium object. +Usage locations +The CharacterisedSurface object can be accessed from the following locations: +• Methods +◦ CharacterisedSurfaceCollection collection has method AddCharacterisedSurface(table). +◦ CharacterisedSurfaceCollection collection has method AddCharacterisedSurface(string). +◦ CharacterisedSurfaceCollection collection has method Item(number). +◦ CharacterisedSurfaceCollection collection has method Item(string). +Property List +Colour +The medium colour. (Read/Write string) +Filename +The file describing the medium properties in XML format. (Read/Write FileReference) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.300 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +Filename +The file describing the medium properties in XML format. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.301 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CharacteristicModes +A solution characteristic modes analysis request. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Request a characteristic modes analysis +p.302 +characteristicModesConfiguration = + project.Contents.SolutionConfigurations:AddCharacteristicModes(6) + -- Change the number of characteristic modes to calculate +characteristicModesRequest = characteristicModesConfiguration.CharacteristicModes +characteristicModesRequest.NumberOfModes = 5 +Inheritance +The CharacteristicModes object is derived from the Object object. +Usage locations +The CharacteristicModes object can be accessed from the following locations: +• Properties +◦ CharacteristicModesConfiguration object has property CharacteristicModes. +Property List +CoefficientsComputed +Compute the source coefficients. (Read/Write boolean) +Label +The object label. (Read/Write string) +NumberOfModes +The number of characteristic modes to calculate. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.303 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CoefficientsComputed +Compute the source coefficients. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +NumberOfModes +The number of characteristic modes to calculate. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.304 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CharacteristicModesConfiguration +A characteristic modes configuration. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add new characteristic modes configuration +p.305 +properties = cf.CharacteristicModesConfiguration.GetDefaultProperties() +properties.Label = "CharacteristicModesConfiguration1" +characteristicModesConfiguration = + project.Contents.SolutionConfigurations:AddCharacteristicModesConfiguration(properties) +Inheritance +The CharacteristicModesConfiguration object is derived from the SolutionConfiguration object. +Usage locations +The CharacteristicModesConfiguration object can be accessed from the following locations: +• Methods +◦ SolutionConfigurationCollection collection has method AddCharacteristicModes(Expression). +Property List +CharacteristicModes +The characteristic modes request. (Read only CharacteristicModes) +Frequency +The configuration solution frequency. (Read only Frequency) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Collection List +Currents +The collection of currents requests in the configuration. (CurrentsCollection of Currents.) +FarFields +The collection of far field requests in the configuration. (FarFieldCollection of FarField.) +Loads +The collection of loads in the configuration. (LoadCollection of Load.) +NearFields +The collection of near field requests in the configuration. (NearFieldCollection of NearField.) +Sources +The collection of sources in the configuration. (SourceCollection of Source.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CharacteristicModes +The characteristic modes request. +Type +CharacteristicModes +Access +Read only +Frequency +The configuration solution frequency. +Type +Frequency +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Currents +The collection of currents requests in the configuration. +Type +CurrentsCollection +FarFields +The collection of far field requests in the configuration. +Type +FarFieldCollection +Loads +The collection of loads in the configuration. +Type +LoadCollection +NearFields +The collection of near field requests in the configuration. +Type +NearFieldCollection +Sources +The collection of sources in the configuration. +Type +SourceCollection +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.308 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CoaxialInsulationLayer +A core insulating layer for a CoaxialCableCrossSection. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add dielectrics to be as the insulation +dielectric1 = project.Definitions.Media.Dielectric:AddDielectric() +dielectric2 = project.Definitions.Media.Dielectric:AddDielectric() + -- Add a cable shield +perfectElectricConductor = project.Definitions.Media.PerfectElectricConductor +shield = + project.Definitions.Cables.Shields:AddSingleLayerSolidShield(perfectElectricConductor, 0.002) + -- Add coaxial cross section +coaxialCable = + project.Definitions.Cables.CrossSections:AddCoaxialUsingDimensions(perfectElectricConductor, 0.001, + dielectric1, 0.001, shield) + -- Add a second insulating layer to the coaxial cross section using the + GetProperties and SetProperties method +properties = coaxialCable:GetProperties() +properties.CoreInsulatingLayers[2] = {} +properties.CoreInsulatingLayers[2].Medium = dielectric2 +properties.CoreInsulatingLayers[2].Thickness = "0.005" +coaxialCable:SetProperties(properties) +Inheritance +The CoaxialInsulationLayer object is derived from the IsotropicDielectricLayers object. +Usage locations +The CoaxialInsulationLayer object can be accessed from the following locations: +• Methods +◦ CoaxialInsulationLayerList object has method Append(). +◦ CoaxialInsulationLayerList object has method Get(number). +Property List +Medium +The dielectric medium of the material to be used for the layer. (Read/Write Dielectric) +Thickness +The thickness (in the model unit) of the layer. (Read/Write ParametricExpression) +Property Details +Medium +The dielectric medium of the material to be used for the layer. +Type +Dielectric +Access +Read/Write +Thickness +The thickness (in the model unit) of the layer. +Type +ParametricExpression +Access +Read/Write +CoaxialInsulationLayerList +A list of CoaxialInsulationLayer items. +Usage locations +The CoaxialInsulationLayerList object can be accessed from the following locations: +• Properties +◦ CableCoaxialCrossSection object has property CoreInsulatingLayers. +Method List +Append () +Appends a new item to the list. (Returns a CoaxialInsulationLayer object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a CoaxialInsulationLayer +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +CoaxialInsulationLayer +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +CoaxialInsulationLayer +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Complex +A complex number. +Example + -- Create a complex number +c1 = pf.Complex(3,4) + -- Determine magnitude and phase of the complex number +mag = c1:Magnitude() +phase = c1:Phase() + -- Some of the valid operators for 'Complex' +c2 = 2 + j*1 +c3 = c1 * 2 +c4 = c1 / 2 +c5 = c1 - c2 +c6 = c1 + c2 +c7 = c1 * c2 +c8 = c1.re * c2.re +Usage locations +The Complex object can be accessed from the following locations: +• Properties +• Methods +◦ Complex object has method Conjugate(). +◦ Complex object has method Conj(). +• Static functions +◦ Complex object has static function Conj(number). +◦ Complex object has static function Conj(Complex). +◦ Complex object has static function Conjugate(number). +◦ Complex object has static function Conjugate(Complex). +◦ Complex object has static function Tan(Complex). +◦ Complex object has static function Sqrt(Complex). +◦ Complex object has static function Sin(Complex). +◦ Complex object has static function Power(Complex, Complex). +◦ Complex object has static function Power(Complex, number). +◦ Complex object has static function Log10(Complex). +◦ Complex object has static function Log(Complex). +◦ Complex object has static function Floor(Complex). +◦ Complex object has static function Exponent(Complex). +◦ Complex object has static function Ceil(Complex). +◦ Complex object has static function Cos(Complex). +◦ Complex object has static function Atan(Complex). +◦ Complex object has static function Asin(Complex). +◦ Complex object has static function Acos(Complex). +◦ Complex object has static function New(number, number). +◦ Complex object has static function New(number). +◦ Complex object has static function New(). +Property List +Type +im +re +The object type string. (Read only string) +The imaginary value of the complex number. (Read/Write number) +The real value of the complex number. (Read/Write number) +Method List +Abs () +Returns the absolute value of the complex value. Same as the magnitude. (Returns a number +object.) +Angle () +Returns the angle of the complex value in radians. Same as the phase. (Returns a number +object.) +Conj () +Returns the complex conjugate of the complex value. (Returns a Complex object.) +Conjugate () +Returns the complex conjugate of the complex value. (Returns a Complex object.) +Imag () +Returns the imaginary component of the complex value. (Returns a number object.) +IsInfinite () +Returns true if either the real or imaginary part is infinite, returns false if both parts are finite. +(Returns a boolean object.) +IsNotANumber () +Returns true if either the real or imaginary part is not a number, returns false if both parts are +valid. (Returns a boolean object.) +Magnitude () +Returns the magnitude of the complex value. (Returns a number object.) +Phase () +Returns the phase of the complex value in radians. (Returns a number object.) +Real () +Returns the real component of the complex value. (Returns a number object.) +Constructor Function List +New (real number, imag number) +Creates a new complex. (Returns a Complex object.) +New (real number) +Creates a new complex. (Returns a Complex object.) +New () +Creates a new complex. (Returns a Complex object.) +Static Function List +Abs (real number) +Calculates the absolute value of the complex value. (Returns a number object.) +Abs (complex Complex) +Calculates the absolute value of the complex value. (Returns a number object.) +Acos (complex Complex) +Calculates arc cosine of a complex value. (Returns a Complex object.) +Angle (real number) +Returns the angle of the complex value in radians. (Returns a number object.) +Angle (complex Complex) +Returns the angle of the complex value in radians. (Returns a number object.) +Asin (complex Complex) +Calculates arc sine of a complex value. (Returns a Complex object.) +Atan (complex Complex) +Calculates arc tan of a complex value. (Returns a Complex object.) +Ceil (complex Complex) +Calculates the ceiling of each component of a complex value. (Returns a Complex object.) +Conj (real number) +Returns the complex conjugate of the complex value. (Returns a Complex object.) +Conj (complex Complex) +Returns the complex conjugate of the complex value. (Returns a Complex object.) +Conjugate (real number) +Calculates the complex conjugate of the complex value. (Returns a Complex object.) +Conjugate (complex Complex) +Calculates the complex conjugate of the complex value. (Returns a Complex object.) +Cos (complex Complex) +Calculates cosine of a complex value. (Returns a Complex object.) +Exponent (complex Complex) +Calculates exponent of a complex value. (Returns a Complex object.) +Floor (complex Complex) +Calculates the floor of each component a complex value. (Returns a Complex object.) +Imag (complex number) +Returns the imaginary component of the complex value. (Returns a number object.) +Imag (complex Complex) +Returns the imaginary component of the complex value. (Returns a number object.) +IsEqual (param complex1 Complex, param complex2 Complex) +Compares two complex numbers. (Returns a boolean object.) +IsEqual (param complex Complex, param value number) +Compares a complex number with a real number. (Returns a boolean object.) +IsInfinite (complex Complex) +Returns true if either the real or imaginary part is infinite, returns false if both parts are finite. +(Returns a boolean object.) +IsNotANumber (complex Complex) +Returns true if either the real or imaginary part is not a number, returns false if both parts are +valid. (Returns a boolean object.) +Log (complex Complex) +Calculates the log of a complex value. (Returns a Complex object.) +Log10 (complex Complex) +Calculates the log10 of a the complex value. (Returns a Complex object.) +Magnitude (real number) +Calculates the magnitude of the complex value. (Returns a number object.) +Magnitude (complex Complex) +Calculates the magnitude of the complex value. (Returns a number object.) +Phase (real number) +Calculates the phase of the complex value in radians. (Returns a number object.) +Phase (complex Complex) +Calculates the phase of the complex value in radians. (Returns a number object.) +Power (complex Complex, complex Complex) +Calculates the power of a the complex value with a complex exponent. (Returns a Complex +object.) +Power (complex Complex, value number) +Calculates the power of a complex value with a real exponent. (Returns a Complex object.) +Real (real number) +Returns the real component of the complex value. (Returns a number object.) +Real (complex Complex) +Returns the real component of the complex value. (Returns a number object.) +Sin (complex Complex) +Calculates the sine value of the complex value. (Returns a Complex object.) +Sqrt (complex Complex) +Calculates the square root value of the complex value. (Returns a Complex object.) +Tan (complex Complex) +Calculates the tan value of the complex value. (Returns a Complex object.) +Index List +[number] +Index a component of the complex value.The real component has index 1 and the complex +component index 2. (Read number) +[number] +Index a component of the complex value.The real component has index 1 and the complex +component index 2. (Write number) +Property Details +Type +The object type string. +Type +string +Access +Read only +im +re +The imaginary value of the complex number. +Type +number +Access +Read/Write +The real value of the complex number. +Type +number +Access +Read/Write +Method Details +Abs () +Returns the absolute value of the complex value. Same as the magnitude. +Return +number +The absolute value of the complex value. +Angle () +Returns the angle of the complex value in radians. Same as the phase. +Return +number +The angle of the complex value. +Conj () +Returns the complex conjugate of the complex value. +Return +Complex +The complex conjugate of the complex value. +Conjugate () +Returns the complex conjugate of the complex value. +Return +Complex +The complex conjugate of the complex value. +Imag () +Returns the imaginary component of the complex value. +Return +number +The imaginary component of the complex value. +IsInfinite () +Returns true if either the real or imaginary part is infinite, returns false if both parts are finite. +Return +boolean +True if either part is Inf. +IsNotANumber () +Returns true if either the real or imaginary part is not a number, returns false if both parts are +valid. +Return +boolean +True if either part is NaN. +Magnitude () +Returns the magnitude of the complex value. +Return +number +The magnitude of the complex value. +Phase () +Returns the phase of the complex value in radians. +Return +number +The phase of the complex value. +Real () +Returns the real component of the complex value. +Return +number +The real component of the complex value. +Static Function Details +Abs (real number) +Calculates the absolute value of the complex value. +Input Parameters +real(number) +The real part of a complex number. +Return +number +The result complex value. +Abs (complex Complex) +Calculates the absolute value of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +number +The result complex value. +Acos (complex Complex) +Calculates arc cosine of a complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Angle (real number) +Returns the angle of the complex value in radians. +Input Parameters +real(number) +The real part of a complex number. +Return +number +The result complex value. +Angle (complex Complex) +Returns the angle of the complex value in radians. +Input Parameters +complex(Complex) +A complex number. +Return +number +The result complex value. +Asin (complex Complex) +Calculates arc sine of a complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Atan (complex Complex) +Calculates arc tan of a complex value. +Input Parameters +complex(Complex) +Complex number. +Return +Complex +The result complex value. +Ceil (complex Complex) +Calculates the ceiling of each component of a complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Conj (real number) +Returns the complex conjugate of the complex value. +Input Parameters +real(number) +The real part of a complex number. +Return +Complex +The complex conjugate of the complex value. +Conj (complex Complex) +Returns the complex conjugate of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The complex conjugate of the complex value. +Conjugate (real number) +Calculates the complex conjugate of the complex value. +Input Parameters +real(number) +The real part of a complex number. +Return +Complex +The result complex value. +Conjugate (complex Complex) +Calculates the complex conjugate of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Cos (complex Complex) +Calculates cosine of a complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Exponent (complex Complex) +Calculates exponent of a complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Floor (complex Complex) +Calculates the floor of each component a complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Imag (complex number) +Returns the imaginary component of the complex value. +Input Parameters +complex(number) +The real part of a complex number. +Return +number +The result complex value. +Imag (complex Complex) +Returns the imaginary component of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +number +The result complex value. +IsEqual (param complex1 Complex, param complex2 Complex) +Compares two complex numbers. +Input Parameters +param complex1(Complex) +The first complex number. +param complex2(Complex) +The second complex number. +Return +boolean +True if the two complex numbers are equal, else false. +IsEqual (param complex Complex, param value number) +Compares a complex number with a real number. +Input Parameters +param complex(Complex) +A complex number. +param value(number) +A value to compare to. +Return +boolean +True if the complex number only has a real component which is equal to the +parameter, else false. +IsInfinite (complex Complex) +Returns true if either the real or imaginary part is infinite, returns false if both parts are finite. +Input Parameters +complex(Complex) +A complex number. +Return +boolean +True if either part is Inf. +Altair Feko 2022.3 +2 Application Programming Interface (API) +IsNotANumber (complex Complex) +p.324 +Returns true if either the real or imaginary part is not a number, returns false if both parts are +valid. +Input Parameters +complex(Complex) +A complex number. +Return +boolean +True if either part is NaN. +Log (complex Complex) +Calculates the log of a complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Log10 (complex Complex) +Calculates the log10 of a the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Magnitude (real number) +Calculates the magnitude of the complex value. +Input Parameters +real(number) +The real part of a complex number. +Return +number +The result complex value. +Magnitude (complex Complex) +Calculates the magnitude of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +number +The result complex value. +New (real number, imag number) +Creates a new complex. +Input Parameters +real(number) +The real component. +imag(number) +The imaginary component. +Return +Complex +The new complex. +New (real number) +Creates a new complex. +Input Parameters +real(number) +The real component. +Return +Complex +The new complex. +New () +Creates a new complex. +Return +Complex +The new complex. +Phase (real number) +Calculates the phase of the complex value in radians. +Input Parameters +real(number) +The real part of a complex number. +Return +number +The result complex value. +Phase (complex Complex) +Calculates the phase of the complex value in radians. +Input Parameters +complex(Complex) +A complex number. +Return +number +The result complex value. +Power (complex Complex, complex Complex) +Calculates the power of a the complex value with a complex exponent. +Input Parameters +complex(Complex) +A complex number. +complex(Complex) +A complex exponent. +Return +Complex +The result complex value. +Power (complex Complex, value number) +Calculates the power of a complex value with a real exponent. +Input Parameters +complex(Complex) +A complex number. +value(number) +A real exponent number. +Return +Complex +The result complex value. +Real (real number) +Returns the real component of the complex value. +Input Parameters +real(number) +The real part of a complex number. +Return +number +The result complex value. +Real (complex Complex) +Returns the real component of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +number +The result complex value. +Sin (complex Complex) +Calculates the sine value of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Sqrt (complex Complex) +Calculates the square root value of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Tan (complex Complex) +Calculates the tan value of the complex value. +Input Parameters +complex(Complex) +A complex number. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Complex +The result complex value. +p.328 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ComplexLoad +A cable complex load component. +Example +p.329 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add 'CableComplexLoad' with 50 Ohms real and -25 Ohms imaginary impedance +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +cableHarnessView = + application.MainWindow.MdiArea:CreateCableSchematicView(cableHarness) +terminal1 = cableHarness.Connectors["CableConnector2"].Pins["Pin2"].Terminal +terminal2 = cableHarness.Connectors["CableConnector2"].Pins["Pin1"].Terminal +resistor = cableHarness.CableSchematic.Components:AddComplexLoad(terminal1, + terminal2, 50, 25) + -- Change the load's real impedance to 75 Ohms +cableHarness.CableSchematic.Components["Z1"].ImpedanceReal = 75 +Inheritance +The ComplexLoad object is derived from the Object object. +Usage locations +The ComplexLoad object can be accessed from the following locations: +• Methods +◦ CableSchematicComponentCollection collection has method AddComplexLoad(FAIL - +unsupported type). +◦ CableSchematicComponentCollection collection has method AddComplexLoad(Terminal, +Terminal, Expression, Expression). +◦ CableSchematicComponentCollection collection has method AddComplexLoad(table). +Property List +ComplexLoadType +Select whether to use a complex number or a single port Touchstone file. (Read/Write +ComplexLoadTypeEnum) +CurrentProbeEnabled +True if a current probe must be applied to the component. (Read/Write boolean) +Filename +The Touchstone file. This is only valid if the CableComplexLoadType has the type +SinglePortTouchstone. (Read/Write FileReference) +ImpedanceImaginary +The imaginary impedance of the complex load. (Read/Write ParametricExpression) +ImpedanceReal +The real impedance of the complex load. (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +VoltageProbeEnabled +True if a current probe must be applied to the component. (Read/Write boolean) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ComplexLoadType +Select whether to use a complex number or a single port Touchstone file. +Type +ComplexLoadTypeEnum +Access +Read/Write +CurrentProbeEnabled +True if a current probe must be applied to the component. +Type +boolean +Access +Read/Write +Filename +The Touchstone file. This is only valid if the CableComplexLoadType has the type +SinglePortTouchstone. +Type +FileReference +Access +Read/Write +ImpedanceImaginary +The imaginary impedance of the complex load. +Type +ParametricExpression +Access +Read/Write +ImpedanceReal +The real impedance of the complex load. +Type +ParametricExpression +Label +Access +Read/Write +The object label. +Type +string +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VoltageProbeEnabled +True if a current probe must be applied to the component. +Type +boolean +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ComplexTensor +The rows of the tensor defined using complex expressions. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create an anisotropic 3D medium using a complex tensor definition +properties = cf.AnisotropicDielectric.GetDefaultProperties() +properties.TensorDescription = cf.Enums.TensorDescriptionMethodEnum.ComplexTensor +-- Permittivity +properties.ComplexTensor.Permittivity[1][1] = "14.5 + j*0.0" +properties.ComplexTensor.Permittivity[1][2] = "0.0 + j*0.0" +properties.ComplexTensor.Permittivity[1][3] = "0.0 + j*0.0" +properties.ComplexTensor.Permittivity[2][1] = "0.0 + j*0.0" +properties.ComplexTensor.Permittivity[2][2] = "14.5 + j*0.0" +properties.ComplexTensor.Permittivity[2][3] = "0.0 + j*0.0" +properties.ComplexTensor.Permittivity[3][1] = "0.0 + j*0.0" +properties.ComplexTensor.Permittivity[3][2] = "0.0 + j*0.0" +properties.ComplexTensor.Permittivity[3][3] = "14.5 + j*0.0" +-- Permeability +properties.ComplexTensor.Permeability[1][1] = "0.998 + j*0.0" +properties.ComplexTensor.Permeability[1][2] = "0.0 - j*0.008" +properties.ComplexTensor.Permeability[1][3] = "0.0 + j*0.0" +properties.ComplexTensor.Permeability[2][1] = "0.0 + j*0.008" +properties.ComplexTensor.Permeability[2][2] = "0.998 + j*0.0" +properties.ComplexTensor.Permeability[2][3] = "0.0 + j*0.0" +properties.ComplexTensor.Permeability[3][1] = "0.0 + j*0.0" +properties.ComplexTensor.Permeability[3][2] = "0.0 + j*0.0" +properties.ComplexTensor.Permeability[3][3] = "1.0 + j*0.0" +anisotropicDielectric = + project.Definitions.Media.AnisotropicDielectric:AddAnisotropicDielectric(properties) + -- Change the colour to Cyan +anisotropicDielectric.Colour = "#00FFFF" +Inheritance +The ComplexTensor object is derived from the CompositeValue object. +Usage locations +The ComplexTensor object can be accessed from the following locations: +• Properties +◦ AnisotropicDielectric object has property ComplexTensor. +• Methods +◦ ComplexTensorList object has method Append(). +◦ ComplexTensorList object has method Get(number). +Property List +Permeability +Defines the complex expressions of the permeability tensor definition. (Read/Write +ParametricComplexExpressionTable) +Permittivity +Defines the complex expressions of the permittivity tensor definition. (Read/Write +ParametricComplexExpressionTable) +Property Details +Permeability +Defines the complex expressions of the permeability tensor definition. +Type +ParametricComplexExpressionTable +Access +Read/Write +Permittivity +Defines the complex expressions of the permittivity tensor definition. +Type +ParametricComplexExpressionTable +Access +Read/Write +ComplexTensorList +A list of ComplexTensor items. +Method List +Append () +Appends a new item to the list. (Returns a ComplexTensor object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a ComplexTensor object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +ComplexTensor +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +ComplexTensor +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ComponentLaunchOptions +p.339 +The components launch options that specifies the command line parameters for the various Altair Feko +components. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Access the 'ComponentLaunchOptions' object and check the environment variables +environmentVariables = application.Launcher.Settings.Environment +Inheritance +The ComponentLaunchOptions object is derived from the Object object. +Usage locations +The ComponentLaunchOptions object can be accessed from the following locations: +• Properties +◦ Launcher object has property Settings. +Property List +ADAPTFEKO +The object containing the ADAPTFEKO options to be used when it is launched. (Read/Write +ADAPTFEKOLaunchOptions) +Environment +The string to define ENVIRONMENT variables to be used during the launching of processes. The +format is VARIABLE=VALUE. (Read/Write string) +FEKO +Label +The object containing the Feko Solver options to be used when it is launched. (Read/Write +FEKOLaunchOptions) +The object label. (Read/Write string) +OPTFEKO +The object containing the OPTFEKO options to be used when it is launched. (Read/Write +OPTFEKOLaunchOptions) +PREFEKO +The object containing the PREFEKO options to be used when it is launched. (Read/Write +PREFEKOLaunchOptions) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ADAPTFEKO +The object containing the ADAPTFEKO options to be used when it is launched. +Type +ADAPTFEKOLaunchOptions +Access +Read/Write +Environment +The string to define ENVIRONMENT variables to be used during the launching of processes. The +format is VARIABLE=VALUE. +Type +string +Access +Read/Write +FEKO +The object containing the Feko Solver options to be used when it is launched. +Type +FEKOLaunchOptions +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +OPTFEKO +The object containing the OPTFEKO options to be used when it is launched. +Type +OPTFEKOLaunchOptions +Access +Read/Write +PREFEKO +The object containing the PREFEKO options to be used when it is launched. +Type +PREFEKOLaunchOptions +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.342 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CompositeValue +A group or collection of properties. +Example +p.343 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) +-- Access the 'ADAPTFEKOLaunchOptions' object and check if temporary files are + deleted +deleteTemporaryFiles = + application.Launcher.Settings.ADAPTFEKO.DeleteTemporaryFilesEnabled +Inheritance +The following objects are derived (specialisations) from the CompositeValue object: +• ADAPTFEKOLaunchOptions +• AdvancedSolverSettings +• AnisotropicDielectricLayers +• AntennaArraySource +• BasisFunctionGlobalSolverSettings +• BasisFunctionLocalSolverSettings +• CableBundleCableSpecification +• CartesianDescription +• CartesianRequestPoints +• CartesianStructure +• ComplexTensor +• ConicalRequestPoints +• ConstrainedSurfacePoint +• CurrentsExportSettings +• CylindricalDescription +• CylindricalRequestPoints +• CylindricalStructure +• CylindricalXRequestPoints +• CylindricalYRequestPoints +• DielectricFrequencyPoint +• DielectricModelling +• DomainDecompositionSettings +• FDTDBoundarySettings +• FDTDSettings +• FEKOGPUOptions +• FEKOLaunchOptions +• FEKOParallelDiagnosticTests +• FEKOParallelExecutionOptions +• FEKORemoteExecutionOptions +• FEMSettings +• FarFieldAdvancedSettings +• FarFieldExportSettings +• FarFieldPBCSettings +• FarFieldSphericalModeSettings +• FileReference +• FrequencyAdvancedSettings +• FrequencyContinuousQuantities +• FrequencyContinuousSettings +• FrequencyExportSettings +• FrequencyFDTDSettings +• FundamentalModeOptions +• GeneralSolverSettings +• GlobalCoordinates +• GlobalPlane +• HighFrequencySettings +• IntegralEquation +• IsotropicDielectricLayers +• IterativeSolverSettings +• LocalCoordinate +• LocalWorkplane +• MLFMMACASettings +• MLFMMSolverSettings +• MagneticFrequencyPoint +• MagneticModelling +• ManuallySpecifiedOrDerivedValue +• MeshAdvancedSettings +• MetallicFrequencyPoint +• NearFieldAdvancedSettings +• NearFieldBoundarySurface +• NearFieldExportSettings +• NurbsControlPoint +• OPTFEKOLaunchOptions +• OptimisationConstraint +• OptimisationGoalProcessingSteps +• OptimisationMaskValues +• OptimisationVariable +• OutputFileSolverSettings +• PREFEKOLaunchOptions +• PREFEKOVariableExportOptions +• ParametricComplexExpression +• ParametricExpression +• PeriodicBoundaryBeamSquintAngle +• PeriodicBoundaryPhaseShift +• PlanarSubstrate +• PointAngleRange +• PointRange +• PolderTensor +• PortProperties +• PreconditionerSettings +• RLGOFaceAbsorbingSettings +• RayContributionsFacetedUTD +• RayContributionsRLGO +• RayContributionsUTD +• ReferenceDirection +• ScopeSettings +• ShieldLayerSettings +• SimplifyEdgeSettings +• SimplifyFaceSettings +• SimplifyPointSettings +• SimplifyRegionSettings +• SpecifiedRequestPoints +• SphericalDescription +• SphericalModeOptions +• SphericalRequestPoints +• SphericalStructure +• SurfaceCoordinate +• SurfaceImpedanceFrequencyPoint +• UTDCylinderTerminationType +• UnitCellLayer +• View3DAxesFormat +• ViewDisplayMode +• ViewRenderingOptions +• VoxelAdvancedSettings +• VoxelGridSummary +• WaveguideModeOptions +• WindscreenSolutionMethod +Usage locations +The CompositeValue object can be accessed from the following locations: +• Methods +◦ CompositeValueHierarchyList object has method Append(). +◦ CompositeValueHierarchyList object has method Get(number). +Altair Feko 2022.3 +2 Application Programming Interface (API) +CompositeValueHierarchyList +A list of CompositeValue items. +Method List +Append () +p.347 +Appends a new item to the list. (Returns a CompositeValue object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a CompositeValue object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +CompositeValue +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +CompositeValue +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Cone +A cone. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a cone with its base centre at the specified 'Point' +baseCentre = cf.Point(-0.25, -0.25, 0) +cone = project.Contents.Geometry:AddCone(baseCentre, 0.5, 0.1, 1.0) +Inheritance +The Cone object is derived from the Geometry object. +Usage locations +The Cone object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddCone(table). +◦ GeometryCollection collection has method AddCone(Point, Expression, Expression, Expression). +◦ GeometryCollection collection has method AddConeWithAngleAndHeight(Point, Expression, +Expression, Expression). +◦ GeometryCollection collection has method AddConeWithAngleAndTopCentre(Point, Expression, +Expression, Point). +◦ GeometryCollection collection has method AddConeWithTopRadiusAndTopCentre(Point, +Expression, Expression, Point). +Property List +Angle +The cone side angle (degrees). Only valid if DefinitionMethod is AngleAndHeight or +AngleAndTopCentre. (Read/Write AngularDimension) +BaseCentre +The cone base centre point. (Read/Write LocalCoordinate) +BaseRadius +The cone base radius. (Read/Write Dimension) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +DefinitionMethod +Cone definition method as specified by the ConeDefinitionMethodEnum, e.g. TopRadiusAndHeight, +TopRadiusAndTopCentre, etc. (Read/Write ConeDefinitionMethodEnum) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Height +p.350 +The cone height. Only valid if DefinitionMethod is TopRadiusAndHeight or AngleAndHeight. (Read/ +Write NormalDimension) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +TopCentre +The cone top centre point. Only valid if DefinitionMethod is TopRadiusAndTopCentre or +AngleAndTopCentre. (Read/Write LocalCoordinate) +TopRadius +The cone top radius. Only valid if DefinitionMethod is TopRadiusAndHeight or +TopRadiusAndTopCentre. (Read/Write Dimension) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +CopyAndMirror (properties table) +p.351 +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Angle +The cone side angle (degrees). Only valid if DefinitionMethod is AngleAndHeight or +AngleAndTopCentre. +Type +AngularDimension +Access +Read/Write +BaseCentre +The cone base centre point. +Type +LocalCoordinate +Access +Read/Write +BaseRadius +The cone base radius. +Type +Dimension +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +DefinitionMethod +Cone definition method as specified by the ConeDefinitionMethodEnum, e.g. TopRadiusAndHeight, +TopRadiusAndTopCentre, etc. +Type +ConeDefinitionMethodEnum +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Height +The cone height. Only valid if DefinitionMethod is TopRadiusAndHeight or AngleAndHeight. +Type +NormalDimension +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +TopCentre +The cone top centre point. Only valid if DefinitionMethod is TopRadiusAndTopCentre or +AngleAndTopCentre. +Type +LocalCoordinate +Access +Read/Write +TopRadius +The cone top radius. Only valid if DefinitionMethod is TopRadiusAndHeight or +TopRadiusAndTopCentre. +Type +Dimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method Details +ConvertToPrimitive () +p.355 +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ConicalRequestPoints +The conical request point positions. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +nearField = project.Contents.SolutionConfigurations[1].NearFields: + AddConical("0","0","0","1","360","1","21","11") + -- Get the 'ConicalRequestPoints' for the near field +conicalRequestPoints = nearField.ConicalRequestPoints + -- Get the Z coordinate of the start of the NearField in Z which is 0 +startZ = conicalRequestPoints.Z.Start + -- Get the Z coordinate of the end of the NearField in Z which is 1 +endZ = conicalRequestPoints.Z.End +Inheritance +The ConicalRequestPoints object is derived from the CompositeValue object. +Usage locations +The ConicalRequestPoints object can be accessed from the following locations: +• Properties +◦ NearField object has property ConicalRequestPoints. +• Methods +◦ ConicalRequestPointsList object has method Append(). +◦ ConicalRequestPointsList object has method Get(number). +Property List +Phi +Rho +The Phi range of points. (Read/Write PointAngleRange) +The Rho range of points. (Read/Write PointRange) +The Z range of points. (Read/Write PointRange) +Property Details +Phi +The Phi range of points. +Rho +Type +PointAngleRange +Access +Read/Write +The Rho range of points. +Type +PointRange +Access +Read/Write +The Z range of points. +Type +PointRange +Access +Read/Write +ConicalRequestPointsList +A list of ConicalRequestPoints items. +Method List +Append () +Appends a new item to the list. (Returns a ConicalRequestPoints object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a ConicalRequestPoints +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +ConicalRequestPoints +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +ConicalRequestPoints +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.362 +ConstrainedSurface +A constrained surface. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create the tables for the surface values +points = {} +normals = {} +uvSurfaceParams = {} + -- Initialise the surface values +for v = 0, 2 do + for u = 1, 5 do + points[u+v*5] = cf.Point(u, math.sin(((u-1)/4) * math.pi) + 0.5 - v, 0) + normals[u+v*5] = cf.Point(0,0,1) + uvSurfaceParams[u+v*5] = cf.UVPoint((u-1)/4, v) + end +end + -- Create the constrained surface +project.Contents.Geometry:AddConstrainedSurface(points, normals, uvSurfaceParams) +Inheritance +The ConstrainedSurface object is derived from the Geometry object. +Usage locations +The ConstrainedSurface object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddConstrainedSurface(table). +◦ GeometryCollection collection has method AddConstrainedSurface(List of Point, List of Point, +List of UVPoint). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Points +The collection of points that define the constrained surface. (Read/Write +ConstrainedSurfacePointList) +SymmetryEnabled +Use symmetry to mirror points with respect to the symmetry plane specified by SymmetryPlane. +(Read/Write boolean) +SymmetryPlane +Symmetry plane orientation. (Read/Write ConstrainedSurfSymmetryPlaneEnum) +SymmetryPlaneConstantSurfaceParameter +Constant surface parameter at the plane of symmetry. (Read/Write +ConstrainedSurfSymmetryPlaneConstParamEnum) +SymmetryPlaneUValue +U' value at symmetry plane. Only enabled if SymmetryPlaneConstantSurfaceParameter is set to U. +(Read/Write ParametricExpression) +SymmetryPlaneVValue +V' value at symmetry plane. Only enabled if SymmetryPlaneConstantSurfaceParameter is set to V. +(Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Points +The collection of points that define the constrained surface. +Type +ConstrainedSurfacePointList +Access +Read/Write +SymmetryEnabled +Use symmetry to mirror points with respect to the symmetry plane specified by SymmetryPlane. +Type +boolean +Access +Read/Write +SymmetryPlane +Symmetry plane orientation. +Type +ConstrainedSurfSymmetryPlaneEnum +Access +Read/Write +SymmetryPlaneConstantSurfaceParameter +Constant surface parameter at the plane of symmetry. +Type +ConstrainedSurfSymmetryPlaneConstParamEnum +Access +Read/Write +SymmetryPlaneUValue +U' value at symmetry plane. Only enabled if SymmetryPlaneConstantSurfaceParameter is set to U. +Type +ParametricExpression +Access +Read/Write +SymmetryPlaneVValue +V' value at symmetry plane. Only enabled if SymmetryPlaneConstantSurfaceParameter is set to V. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method Details +ConvertToPrimitive () +p.369 +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ConstrainedSurfacePoint +A point used to define a constrained surface. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create the tables for the surface values +points = {} +normals = {} +uvSurfaceParams = {} + -- Initialise the surface values +for v = 0, 2 do + for u = 1, 5 do + points[u+v*5] = cf.Point(u, math.sin(((u-1)/4) * math.pi) + 0.5 - v, 0) + normals[u+v*5] = cf.Point(0,0,1) + uvSurfaceParams[u+v*5] = cf.UVPoint((u-1)/4, v) + end +end + -- Create the constrained surface +surface = project.Contents.Geometry:AddConstrainedSurface(points, normals, + uvSurfaceParams) + -- Modify the first point +surface.Points[1].Position.U = 0.4 +Inheritance +The ConstrainedSurfacePoint object is derived from the CompositeValue object. +Usage locations +The ConstrainedSurfacePoint object can be accessed from the following locations: +• Methods +◦ ConstrainedSurfacePointList object has method Append(). +◦ ConstrainedSurfacePointList object has method Get(number). +Property List +Normal +The normal direction of the point. (Read/Write LocalInternalCoordinate) +Position +The position of the point. (Read/Write LocalInternalCoordinate) +Surface +The expression for the surface U' and V' coordinate of the point. (Read/Write SurfaceCoordinate) +Property Details +Normal +The normal direction of the point. +Type +LocalInternalCoordinate +Access +Read/Write +Position +The position of the point. +Type +LocalInternalCoordinate +Access +Read/Write +Surface +The expression for the surface U' and V' coordinate of the point. +Type +SurfaceCoordinate +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ConstrainedSurfacePointList +A list of ConstrainedSurfacePoint items. +Usage locations +p.375 +The ConstrainedSurfacePointList object can be accessed from the following locations: +• Properties +◦ ConstrainedSurface object has property Points. +Method List +Append () +Appends a new item to the list. (Returns a ConstrainedSurfacePoint object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a ConstrainedSurfacePoint +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +ConstrainedSurfacePoint +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +ConstrainedSurfacePoint +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Cross +A cross. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a cross at the specified 'Point' +center = cf.Point(-0.25, -0.25, 0) +cross = project.Contents.Geometry:AddCross(center, 1.5, 1.2, 0.5) +Inheritance +The Cross object is derived from the Geometry object. +The following objects are derived (specialisations) from the Cross object: +• StripCross +Usage locations +The Cross object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddCross(table). +◦ GeometryCollection collection has method AddCross(Point, Expression, Expression, +Expression). +Property List +ArmLengthU +The cross arm length (U). (Read/Write Dimension) +ArmLengthV +The cross arm length (V). (Read/Write Dimension) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The cross centre point. (Read/Write LocalCoordinate) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +StripWidth +The cross strip width. (Read/Write Dimension) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +p.379 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ArmLengthU +The cross arm length (U). +Type +Dimension +Access +Read/Write +ArmLengthV +The cross arm length (V). +Type +Dimension +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +The cross centre point. +Type +LocalCoordinate +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +StripWidth +The cross strip width. +Type +Dimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +p.382 +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +Explode () +p.384 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CrossShape +A cross shape. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a cross shape +cross = project.Definitions.PeriodicStructures.Shapes:AddCross(1.5, 1.2, 0.5) +Inheritance +The CrossShape object is derived from the Shape object. +The following objects are derived (specialisations) from the CrossShape object: +• StripCrossShape +Usage locations +The CrossShape object can be accessed from the following locations: +• Methods +◦ ShapeCollection collection has method AddCross(table). +◦ ShapeCollection collection has method AddCross(Expression, Expression, Expression). +Property List +ArmLengthU +The cross arm length (U). (Read/Write ParametricExpression) +ArmLengthV +The cross arm length (V). (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +StripWidth +The cross strip width. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +BuildGeometry () +Creates the full geometry representation of the shape. (Returns a Geometry object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.387 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ArmLengthU +The cross arm length (U). +Type +ParametricExpression +Access +Read/Write +ArmLengthV +The cross arm length (V). +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +StripWidth +The cross strip width. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +BuildGeometry () +Creates the full geometry representation of the shape. +Return +Geometry +The shape geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Cuboid +A cuboid. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a cuboid with its base corner at the specified 'Point' +corner = cf.Point(-0.25, -0.25, 0) +cube = project.Contents.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25) +Inheritance +The Cuboid object is derived from the Geometry object. +Usage locations +The Cuboid object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddCuboid(table). +◦ GeometryCollection collection has method AddCuboid(Point, Expression, Expression, +Expression). +◦ GeometryCollection collection has method AddCuboidAtCentre(Point, Expression, Expression, +Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +DefinitionMethod +Cuboid base corner type definition specified by the CuboidDefinitionMethodEnum, e.g. +BaseAtCorner or BaseAtCentre. (Read/Write CuboidDefinitionMethodEnum) +Depth +The cuboid depth. (Read/Write Dimension) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Height +The cuboid height. (Read/Write NormalDimension) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Origin +The cuboid base corner/centre origin point. (Read/Write LocalCoordinate) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +Width +The object type string. (Read only string) +The cuboid width. (Read/Write Dimension) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +DefinitionMethod +Cuboid base corner type definition specified by the CuboidDefinitionMethodEnum, e.g. +BaseAtCorner or BaseAtCentre. +Type +CuboidDefinitionMethodEnum +Access +Read/Write +Depth +The cuboid depth. +Type +Dimension +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Height +The cuboid height. +Type +NormalDimension +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Origin +The cuboid base corner/centre origin point. +Type +LocalCoordinate +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Width +Type +string +Access +Read only +The cuboid width. +Type +Dimension +Access +Read/Write +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CurrentSource +A current source, similar to a voltage source, but the current is impressed in the model. +p.398 +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a FEM line port +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0,0,0), 1, 1, 1) +cuboid.Regions[1].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.FEM +dielectric = project.Definitions.Media.Dielectric:AddDielectric() +cuboid.Regions[1].Medium = dielectric +FEMLinePort = project.Contents.Ports:AddFEMLinePort({cuboid.Edges[1]}) + -- Add a current source to the FEM line port +source = + project.Contents.SolutionConfigurations.GlobalSources:AddCurrentSource(FEMLinePort) +Inheritance +The CurrentSource object is derived from the Source object. +Usage locations +The CurrentSource object can be accessed from the following locations: +• Methods +◦ SourceCollection collection has method AddCurrentSource(table). +◦ SourceCollection collection has method AddCurrentSource(FEMLinePort). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Impedance +The reference impedance (Ohm). (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +Magnitude +The source magnitude. (Read/Write ParametricExpression) +Phase +Type +The source phase (degrees). (Read/Write ParametricExpression) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Impedance +The reference impedance (Ohm). +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Magnitude +The source magnitude. +Type +ParametricExpression +Access +Read/Write +Phase +The source phase (degrees). +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Currents +A solution currents request. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Request the calculation of all currents +currentsRequest = project.Contents.SolutionConfigurations[1].Currents:Add() +Inheritance +The Currents object is derived from the Object object. +Usage locations +The Currents object can be accessed from the following locations: +• Methods +◦ CurrentsCollection collection has method Add(table). +◦ CurrentsCollection collection has method Add(). +◦ CurrentsCollection collection has method Item(number). +◦ CurrentsCollection collection has method Item(string). +Property List +CalculationScope +The calculation scope. (Read/Write CurrentsScopeTypeEnum) +ExportSettings +Currents export options. (Read/Write CurrentsExportSettings) +Label +The object label. (Read/Write string) +ScopedEntities +The entities for which the currents calculation will be done. (Read/Write ObjectReferenceList) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.403 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CalculationScope +The calculation scope. +Type +CurrentsScopeTypeEnum +Access +Read/Write +ExportSettings +Currents export options. +Type +CurrentsExportSettings +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +ScopedEntities +The entities for which the currents calculation will be done. +Type +ObjectReferenceList +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CurrentsExportSettings +Currents export options. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +currentsRequest = project.Contents.SolutionConfigurations[1].Currents:Add() + -- Modify the export settings for the currents request +currentsRequest.ExportSettings.ASCIIEnabled = true +Inheritance +The CurrentsExportSettings object is derived from the CompositeValue object. +Usage locations +The CurrentsExportSettings object can be accessed from the following locations: +• Properties +◦ Currents object has property ExportSettings. +• Methods +◦ CurrentsExportSettingsList object has method Append(). +◦ CurrentsExportSettingsList object has method Get(number). +Property List +ASCIIEnabled +Export currents to ASCII file (*.os/*.ol). (Read/Write boolean) +OutFileEnabled +Export currents to *.out file. (Read/Write boolean) +Property Details +ASCIIEnabled +Export currents to ASCII file (*.os/*.ol). +Type +boolean +Access +Read/Write +OutFileEnabled +Export currents to *.out file. +Type +boolean +Access +Read/Write +CurrentsExportSettingsList +A list of CurrentsExportSettings items. +Method List +Append () +Appends a new item to the list. (Returns a CurrentsExportSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a CurrentsExportSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +CurrentsExportSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +CurrentsExportSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.408 +CustomAntennaArray +A finite antenna array element. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +antennaArrays = project.Contents.SolutionSettings.AntennaArrays + -- Create an antenna array element +magnitudeScaling = 2.5 +phaseOffset = 45 +position = cf.Point(1, 2, 1) +array = antennaArrays:AddArrayElement(position, magnitudeScaling, phaseOffset) +Inheritance +The CustomAntennaArray object is derived from the AbstractAntennaArray object. +Usage locations +The CustomAntennaArray object can be accessed from the following locations: +• Methods +◦ AntennaArrayCollection collection has method AddArrayElement(table). +◦ AntennaArrayCollection collection has method AddArrayElement(Point, Expression, +Expression). +◦ CylindricalAntennaArray object has method ConvertToCustomArray(). +◦ LinearPlanarArray object has method ConvertToCustomArray(). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MagnitudeScaling +The source magnitude for the respective element is scaled relative to the base element. (Read/ +Write ParametricExpression) +Origin +The finite antenna array element origin point. (Read/Write LocalCoordinate) +PhaseOffset +The phase offset (in degrees) for the respective element relative to the base element. (Read/Write +ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Collection List +Transforms +p.410 +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MagnitudeScaling +The source magnitude for the respective element is scaled relative to the base element. +Type +ParametricExpression +Access +Read/Write +Origin +The finite antenna array element origin point. +Type +LocalCoordinate +Access +Read/Write +PhaseOffset +The phase offset (in degrees) for the respective element relative to the base element. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +table +A table defining the properties. +SetProperties (properties Object) +p.414 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Cutplane +The cutplane object that will cut various items in the 3D View. +Example +application = cf.Application.GetInstance() + -- Add +properties = cf.Cutplane.GetDefaultProperties() +properties.Theta = "45" +properties.Phi = "45" +properties.Offset = "1" +properties.Label = "Cutplane2" +cutplane1 = application.Project.Contents.Cutplanes:Add(properties) +Inheritance +The Cutplane object is derived from the Object object. +Usage locations +The Cutplane object can be accessed from the following locations: +• Methods +◦ CutplaneCollection collection has method Add(table). +◦ CutplaneCollection collection has method Item(number). +◦ CutplaneCollection collection has method Item(string). +Property List +FilteredEntities +A list of items that will not be cut by the cutplane. (Read/Write ObjectReferenceList) +Flipped +True if the cutplane is flipped. (Read/Write boolean) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Offset +Phi +Theta +Type +The offset of the cutplane in the theta and phi direction. (Read/Write NormalDimension) +The phi direction of the cutplane in degrees. (Read/Write AngularDimension) +The theta direction of the cutplane. (Read/Write AngularDimension) +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +FilteredEntities +A list of items that will not be cut by the cutplane. +Type +ObjectReferenceList +Access +Read/Write +Flipped +True if the cutplane is flipped. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Offset +The offset of the cutplane in the theta and phi direction. +Type +NormalDimension +Access +Read/Write +Phi +The phi direction of the cutplane in degrees. +Type +AngularDimension +Access +Read/Write +Theta +The theta direction of the cutplane. +Type +AngularDimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.420 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Cylinder +A cylinder. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Use 'Point' to create a cylinder specified by height. +base = cf.Point(-0.25,-0.25,0) +cylinder = project.Contents.Geometry:AddCylinder(base, 0.5, 1.0) +Inheritance +The Cylinder object is derived from the Geometry object. +Usage locations +The Cylinder object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddCylinder(table). +◦ GeometryCollection collection has method AddCylinder(Point, Expression, Expression). +◦ GeometryCollection collection has method AddCylinderWithTopCentre(Point, Expression, Point). +Property List +Base +The cylinder base centre point. (Read/Write LocalCoordinate) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +DefinitionMethod +Cylinder construction type definition specified by the CylinderDefinitionMethodEnum, e.g. with +Height or with TopCoordinate. (Read/Write CylinderDefinitionMethodEnum) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Height +The cylinder height. Only valid if DefinitionMethod is Height. (Read/Write NormalDimension) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Radius +The cylinder radius. (Read/Write Dimension) +Top +Type +The cylinder top centre point. Only valid if DefinitionMethod is TopCoordinate. (Read/Write +LocalCoordinate) +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Base +The cylinder base centre point. +Type +LocalCoordinate +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +DefinitionMethod +p.424 +Cylinder construction type definition specified by the CylinderDefinitionMethodEnum, e.g. with +Height or with TopCoordinate. +Type +CylinderDefinitionMethodEnum +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Height +The cylinder height. Only valid if DefinitionMethod is Height. +Type +NormalDimension +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Radius +The cylinder radius. +Type +Dimension +Access +Read/Write +Top +The cylinder top centre point. Only valid if DefinitionMethod is TopCoordinate. +Type +LocalCoordinate +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CylindricalAntennaArray +A finite antenna array with a cylindrical or circular distribution. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +antennaArrays = project.Contents.SolutionSettings.AntennaArrays + -- Create a 6x3 circular array with radius of 3 +phiIncrement = 25 +offsetN = 2 +array = antennaArrays:AddCylindricalArray(3, 6, phiIncrement, 3, offsetN, false) + -- Set a non-uniform source distribution +array.UniformSourceDistributionEnabled = false +array.Distribution[1].MagnitudeScaling = "1.5" +array.Distribution[1].PhaseOffset = "45" +array.Distribution[6].MagnitudeScaling = "1.5" +array.Distribution[6].PhaseOffset = "90" +Inheritance +The CylindricalAntennaArray object is derived from the AbstractAntennaArray object. +Usage locations +The CylindricalAntennaArray object can be accessed from the following locations: +• Methods +◦ AntennaArrayCollection collection has method AddCylindricalArray(table). +◦ AntennaArrayCollection collection has method AddCylindricalArray(Expression, number, +number, Expression, boolean). +◦ AntennaArrayCollection collection has method AddCylindricalArray(Expression, number, +Expression, number, Expression, boolean). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CountN +The number of finite antenna array elements in the N dimension. (Read/Write number) +CountPhi +The number of finite antenna array elements in the Phi dimension. (Read/Write number) +Distribution +The collection of finite antenna array element sources. Only applicable if +UniformSourceDistributionEnabled is false. (Read/Write AntennaArraySourceList) +Altair Feko 2022.3 +2 Application Programming Interface (API) +ElementsRotated +p.431 +Rotate each element by the same angle used to determine its new position. (Read/Write boolean) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +OffsetN +The distance between the finite antenna array elements along the N axis. (Read/Write +ParametricExpression) +PhiAngle +The angle (in degrees) between the finite antenna array elements in the Phi dimension. Only +applicable if PhiSpacingType is Specified. (Read/Write ParametricExpression) +PhiSpacingType +"The element spacing type in the Phi dimension. A uniform spacing will ensure that each element +are equally spaced from each other. (Read/Write ElementDistributionEnum) +Radius +The radius of the cylindrical/circular antenna array. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +UniformSourceDistributionEnabled +The finite array elements will either have an uniform distribution or the distribution will be +calculated from the plane wave if a plane wave is present in the model. If it is set to false, the +source of each element can be specified. (Read/Write boolean) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +ConvertToCustomArray () +Convert the finite antenna array into a collection of individual custom array elements. (Returns a +List of CustomAntennaArray object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CountN +The number of finite antenna array elements in the N dimension. +Type +number +Access +Read/Write +CountPhi +The number of finite antenna array elements in the Phi dimension. +Type +number +Access +Read/Write +Distribution +The collection of finite antenna array element sources. Only applicable if +UniformSourceDistributionEnabled is false. +Type +AntennaArraySourceList +Access +Read/Write +ElementsRotated +Rotate each element by the same angle used to determine its new position. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +OffsetN +The distance between the finite antenna array elements along the N axis. +Type +ParametricExpression +Access +Read/Write +PhiAngle +The angle (in degrees) between the finite antenna array elements in the Phi dimension. Only +applicable if PhiSpacingType is Specified. +Type +ParametricExpression +Access +Read/Write +PhiSpacingType +"The element spacing type in the Phi dimension. A uniform spacing will ensure that each element +are equally spaced from each other. +Type +ElementDistributionEnum +Access +Read/Write +Radius +The radius of the cylindrical/circular antenna array. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +UniformSourceDistributionEnabled +The finite array elements will either have an uniform distribution or the distribution will be +calculated from the plane wave if a plane wave is present in the model. If it is set to false, the +source of each element can be specified. +Type +boolean +Access +Read/Write +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +ConvertToCustomArray () +Convert the finite antenna array into a collection of individual custom array elements. +Return +List of CustomAntennaArray +The list of antenna array elements. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.437 +Altair Feko 2022.3 +2 Application Programming Interface (API) +CylindricalDescription +p.438 +The description of an analytical curve using the cylindrical coordinate system. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Define two local variables used to create a cylindrical analytical curve +rho = "t*sqrt(1+t^2)" +phi = "deg(arctan(t))" +analyticalCurve = project.Contents.Geometry:AddAnalyticalCurveCylindrical(0, 1, rho, + phi, 0) + -- Access the cylindrical description and change Phi +analyticalCurve.CylindricalDescription.Phi = "t*deg(arctan(t))" +Inheritance +The CylindricalDescription object is derived from the CompositeValue object. +Usage locations +The CylindricalDescription object can be accessed from the following locations: +• Properties +◦ AnalyticalCurve object has property CylindricalDescription. +• Methods +◦ CylindricalDescriptionList object has method Append(). +◦ CylindricalDescriptionList object has method Get(number). +Property List +Phi +Rho +The curve description in the N dimension as a function of variable t. (Read/Write +ParametricExpression) +The curve description in the phi dimension as a function of variable t. (Read/Write +ParametricExpression) +The curve description in the rho dimension as a function of variable t. (Read/Write +ParametricExpression) +Property Details +The curve description in the N dimension as a function of variable t. +Type +ParametricExpression +Access +Read/Write +Phi +Rho +The curve description in the phi dimension as a function of variable t. +Type +ParametricExpression +Access +Read/Write +The curve description in the rho dimension as a function of variable t. +Type +ParametricExpression +Access +Read/Write +CylindricalDescriptionList +A list of CylindricalDescription items. +Method List +Append () +Appends a new item to the list. (Returns a CylindricalDescription object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a CylindricalDescription +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +CylindricalDescription +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +CylindricalDescription +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.441 +Altair Feko 2022.3 +2 Application Programming Interface (API) +CylindricalRequestPoints +The cylindrical request point positions. +Example +p.442 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a Cylindrical NearFiled starting at (0,0,0) extending up to a height of 1, + -- an inner radius of 1 and an outer radius of 2. +nearField = + project.Contents.SolutionConfigurations[1].NearFields:AddCylindrical(1,0,0, + 2,360,1, + 3,21,11) +cylindricalRequestPoints = nearField.CylindricalRequestPoints + -- Get the Phi coordinate of the start of the NearField, which is 0 degrees +startPhi = cylindricalRequestPoints.Phi.Start + -- Get the Phi coordinate of the end of the NearField, which is 360 degrees +endPhi = cylindricalRequestPoints.Phi.End +Inheritance +The CylindricalRequestPoints object is derived from the CompositeValue object. +Usage locations +The CylindricalRequestPoints object can be accessed from the following locations: +• Properties +◦ NearField object has property CylindricalRequestPoints. +• Methods +◦ CylindricalRequestPointsList object has method Append(). +◦ CylindricalRequestPointsList object has method Get(number). +Property List +Phi +Rho +The Phi range of points. (Read/Write PointAngleRange) +The Rho range of points. (Read/Write PointRange) +The Z range of points. (Read/Write PointRange) +Property Details +Phi +The Phi range of points. +Rho +Type +PointAngleRange +Access +Read/Write +The Rho range of points. +Type +PointRange +Access +Read/Write +The Z range of points. +Type +PointRange +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +CylindricalRequestPointsList +A list of CylindricalRequestPoints items. +Method List +Append () +p.444 +Appends a new item to the list. (Returns a CylindricalRequestPoints object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a CylindricalRequestPoints +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +CylindricalRequestPoints +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +CylindricalRequestPoints +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.445 +Altair Feko 2022.3 +2 Application Programming Interface (API) +CylindricalStructure +The cylindrical coordinate system source description. +Example +p.446 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a 'NearFieldFileStructure' from a set of default properties +properties = cf.NearFieldDataFileStructure.GetDefaultProperties() +properties.CoordinateType = cf.Enums.NearFieldDataCoordinateTypeEnum.Cylindrical +properties.CylindricalStructure.Height = "2" +properties.CylindricalStructure.Radius = "2" +properties.CylindricalStructure.NPoints = "11" +properties.CylindricalStructure.PhiPoints = "11" +properties.EFieldFilename = [[EFieldFileName]] +properties.HFieldFilename = [[HFieldFileName]] +nearFieldData = + project.Definitions.FieldDataList:AddNearFieldDataFileStructure(properties) + -- Change the height of the cylindrical face +nearFieldData.CylindricalStructure.Height = "4" +Inheritance +The CylindricalStructure object is derived from the CompositeValue object. +Usage locations +The CylindricalStructure object can be accessed from the following locations: +• Properties +◦ NearFieldDataFileStructure object has property CylindricalStructure. +• Methods +◦ CylindricalStructureList object has method Append(). +◦ CylindricalStructureList object has method Get(number). +Property List +Height +The height of the cylindrical face. (Read/Write NormalDimension) +NPoints +The number of points along N. (Read/Write ParametricExpression) +PhiPoints +The number of points along Phi. (Read/Write ParametricExpression) +Property Details +Height +The height of the cylindrical face. +Type +NormalDimension +Access +Read/Write +NPoints +The number of points along N. +Type +ParametricExpression +Access +Read/Write +PhiPoints +The number of points along Phi. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +CylindricalStructureList +A list of CylindricalStructure items. +Method List +Append () +p.448 +Appends a new item to the list. (Returns a CylindricalStructure object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a CylindricalStructure object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +CylindricalStructure +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +CylindricalStructure +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CylindricalXRequestPoints +The cylindrical (X axis) request point positions. +Example +p.450 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a Cylindrical NearFiled starting at (0,0,0) extending along X to a width + of 1, + -- an inner radius of 1 and an outer radius of 2. +nearField = + project.Contents.SolutionConfigurations[1].NearFields:AddCylindricalX(1,0,0, + 2,360,1, + 3,21,11) +cylindricalXRequestPoints = nearField.CylindricalXRequestPoints + -- Get the Phi coordinate of the start of the NearField, which is 0 degrees +startPhi = cylindricalXRequestPoints.Phi.Start + -- Get the Phi coordinate of the end of the NearField, which is 360 degrees +endPhi = cylindricalXRequestPoints.Phi.End +Inheritance +The CylindricalXRequestPoints object is derived from the CompositeValue object. +Usage locations +The CylindricalXRequestPoints object can be accessed from the following locations: +• Properties +◦ NearField object has property CylindricalXRequestPoints. +• Methods +◦ CylindricalXRequestPointsList object has method Append(). +◦ CylindricalXRequestPointsList object has method Get(number). +Property List +Phi +Rho +The Phi range of points. (Read/Write PointAngleRange) +The Rho range of points. (Read/Write PointRange) +The X range of points. (Read/Write PointRange) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property Details +p.451 +Phi +Rho +The Phi range of points. +Type +PointAngleRange +Access +Read/Write +The Rho range of points. +Type +PointRange +Access +Read/Write +The X range of points. +Type +PointRange +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +CylindricalXRequestPointsList +A list of CylindricalXRequestPoints items. +Method List +Append () +p.452 +Appends a new item to the list. (Returns a CylindricalXRequestPoints object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a CylindricalXRequestPoints +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +CylindricalXRequestPoints +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +CylindricalXRequestPoints +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.453 +Altair Feko 2022.3 +2 Application Programming Interface (API) +CylindricalYRequestPoints +The cylindrical (Y axis) request point positions. +Example +p.454 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a Cylindrical NearFiled starting at (0,0,0) extending along Y to a width + of 1, + -- an inner radius of 1 and an outer radius of 2. +nearField = + project.Contents.SolutionConfigurations[1].NearFields:AddCylindricalY(1,0,0, + 2,360,1, + 3,21,11) +cylindricalYRequestPoints = nearField.CylindricalYRequestPoints + -- Get the Phi coordinate of the start of the NearField, which is 0 degrees +startPhi = cylindricalYRequestPoints.Phi.Start + -- Get the Phi coordinate of the end of the NearField, which is 360 degrees +endPhi = cylindricalYRequestPoints.Phi.End +Inheritance +The CylindricalYRequestPoints object is derived from the CompositeValue object. +Usage locations +The CylindricalYRequestPoints object can be accessed from the following locations: +• Properties +◦ NearField object has property CylindricalYRequestPoints. +• Methods +◦ CylindricalYRequestPointsList object has method Append(). +◦ CylindricalYRequestPointsList object has method Get(number). +Property List +Phi +Rho +The Phi range of points. (Read/Write PointAngleRange) +The Rho range of points. (Read/Write PointRange) +The Y range of points. (Read/Write PointRange) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property Details +p.455 +Phi +Rho +The Phi range of points. +Type +PointAngleRange +Access +Read/Write +The Rho range of points. +Type +PointRange +Access +Read/Write +The Y range of points. +Type +PointRange +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +CylindricalYRequestPointsList +A list of CylindricalYRequestPoints items. +Method List +Append () +p.456 +Appends a new item to the list. (Returns a CylindricalYRequestPoints object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a CylindricalYRequestPoints +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +CylindricalYRequestPoints +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +CylindricalYRequestPoints +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.457 +Altair Feko 2022.3 +2 Application Programming Interface (API) +DefaultMedium +p.458 +A non-physical medium that can be applied to a face or region. It allows the properties to be inferred +from the surrounding face or region settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a cuboid +cube1 = project.Contents.Geometry:AddCuboid(cf.Cuboid.GetDefaultProperties()) + -- Set the face media to default +cube1.Faces[1].Medium = project.Definitions.Media.DefaultMedium +Inheritance +The DefaultMedium object is derived from the Medium object. +Usage locations +The DefaultMedium object can be accessed from the following locations: +• Properties +◦ Media object has property DefaultMedium. +Property List +Colour +The medium colour. (Read/Write string) +The object label. (Read/Write string) +Label +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.459 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +table +A table defining the properties. +SetProperties (properties Object) +p.460 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Dielectric +A dielectric medium. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a dielectric medium +dielectric = project.Definitions.Media.Dielectric:AddDielectric(2.16, 0.001, 1000) + -- Change the colour to Cyan +dielectric.Colour = "#00FFFF" +Inheritance +The Dielectric object is derived from the Medium object. +The following objects are derived (specialisations) from the Dielectric object: +• FreeSpace +• GroundPlaneMedium +• Zero +Usage locations +The Dielectric object can be accessed from the following locations: +• Properties +◦ AnisotropicDielectricLayers object has property OrthogonalMedium. +◦ AnisotropicDielectricLayers object has property PrincipleMedium. +◦ +IsotropicDielectricLayers object has property Medium. +◦ CoaxialInsulationLayer object has property Medium. +◦ PlanarSubstrate object has property Medium. +◦ UnitCellLayer object has property Medium. +• Methods +◦ DielectricCollection collection has method AddDielectric(table). +◦ DielectricCollection collection has method AddDielectric(Expression, Expression, Expression). +◦ DielectricCollection collection has method AddDielectric(). +◦ DielectricCollection collection has method Item(number). +◦ DielectricCollection collection has method Item(string). +Property List +Colour +The medium colour. (Read/Write string) +DielectricModelling +The medium dielectric modelling properties. (Read/Write DielectricModelling) +Filename +The file describing the medium properties in XML format. (Read/Write FileReference) +Label +The object label. (Read/Write string) +MagneticModelling +The medium magnetic modelling properties. (Read/Write MagneticModelling) +MassDensity +Medium's mass density (kg/m^3). (Read/Write ParametricExpression) +SourceDefinitionMethod +Specifies the method used for defining the medium. (Read/Write +MediumSourceDefinitionMethodEnum) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +DielectricModelling +The medium dielectric modelling properties. +Type +DielectricModelling +Access +Read/Write +Filename +The file describing the medium properties in XML format. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MagneticModelling +The medium magnetic modelling properties. +Type +MagneticModelling +Access +Read/Write +MassDensity +Medium's mass density (kg/m^3). +Type +ParametricExpression +Access +Read/Write +SourceDefinitionMethod +Specifies the method used for defining the medium. +Type +MediumSourceDefinitionMethodEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +DielectricBoundaryMedium +p.465 +A non-physical medium that can be applied to a face to describe the separation between two dielectric +regions. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a cuboid and set the region to dielectric +cube1 = project.Contents.Geometry:AddCuboid(cf.Cuboid.GetDefaultProperties()) +dielectric = + project.Definitions.Media.Dielectric:AddDielectric(cf.Dielectric.GetDefaultProperties()) +cube1.Regions[1].Medium = dielectric + -- Set the face media to dielectric boundary +cube1.Faces[1].Medium = project.Definitions.Media.DielectricBoundaryMedium +Inheritance +The DielectricBoundaryMedium object is derived from the Medium object. +Usage locations +The DielectricBoundaryMedium object can be accessed from the following locations: +• Properties +◦ Media object has property DielectricBoundaryMedium. +Property List +Colour +The medium colour. (Read/Write string) +DielectricModelling +The medium boundary dielectric modelling properties. (Read/Write DielectricModelling) +Label +The object label. (Read/Write string) +MagneticModelling +The medium boundary magnetic modelling properties. (Read/Write MagneticModelling) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.466 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +DielectricModelling +The medium boundary dielectric modelling properties. +Type +DielectricModelling +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MagneticModelling +The medium boundary magnetic modelling properties. +Type +MagneticModelling +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +DielectricFrequencyPoint +The dielectric modelling frequency point properties. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a dielectric medium +dielectric = application.MediaLibrary:AddToModel("Construction_glass") + -- Get the loss tangent for the second frequency point +lossTangent = dielectric.DielectricModelling.FrequencyPoints[2].LossTangent +Inheritance +The DielectricFrequencyPoint object is derived from the CompositeValue object. +Usage locations +The DielectricFrequencyPoint object can be accessed from the following locations: +• Methods +◦ DielectricFrequencyPointList object has method Append(). +◦ DielectricFrequencyPointList object has method Get(number). +Property List +Conductivity +Dielectric conductivity value (S/m). (Read/Write ParametricExpression) +Frequency +Dielectric frequency value (Hz). (Read/Write ParametricExpression) +LossTangent +Dielectric loss tangent value. (Read/Write ParametricExpression) +RelativePermittivity +Dielectric relative permittivity value. (Read/Write ParametricExpression) +Property Details +Conductivity +Dielectric conductivity value (S/m). +Type +ParametricExpression +Access +Read/Write +Frequency +Dielectric frequency value (Hz). +Type +ParametricExpression +Access +Read/Write +LossTangent +Dielectric loss tangent value. +Type +ParametricExpression +Access +Read/Write +RelativePermittivity +Dielectric relative permittivity value. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +DielectricFrequencyPointList +A list of DielectricFrequencyPoint items. +Usage locations +The DielectricFrequencyPointList object can be accessed from the following locations: +p.470 +• Properties +Method List +Append () +Appends a new item to the list. (Returns a DielectricFrequencyPoint object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a DielectricFrequencyPoint +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +DielectricFrequencyPoint +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +DielectricFrequencyPoint +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.471 +DielectricModelling +Dielectric modelling properties. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a dielectric medium +dielectric = project.Definitions.Media.Dielectric:AddDielectric(2.16, 0.001, 1000) + -- Modify the loss tangent of the dielectric +dielectric.DielectricModelling.LossTangent = 0.002 +Inheritance +The DielectricModelling object is derived from the CompositeValue object. +Usage locations +The DielectricModelling object can be accessed from the following locations: +• Properties +◦ Dielectric object has property DielectricModelling. +◦ FreeSpace object has property DielectricModelling. +◦ GroundPlaneMedium object has property DielectricModelling. +◦ Zero object has property DielectricModelling. +◦ DielectricBoundaryMedium object has property DielectricModelling. +• Methods +◦ DielectricModellingList object has method Append(). +◦ DielectricModellingList object has method Get(number). +Property List +AngularFrequencyLowerLimit +Medium's angular frequency lower limit. Only applicable if DielectricModelling DefinitionMethod is +Djordjevic-Sarkar. (Read/Write ParametricExpression) +AngularFrequencyUpperLimit +Medium's angular frequency upper limit. Only applicable if DielectricModelling DefinitionMethod is +Djordjevic-Sarkar. (Read/Write ParametricExpression) +AttenuationFactor +Medium's attenuation factor. Only applicable if DielectricModelling DefinitionMethod is ColeCole or +Havriliak-Negami. (Read/Write ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Conductivity +p.473 +Medium's conductivity (S/m). Only applicable if DielectricModelling DefinitionMethod is +FrequencyIndependent or Djordjevic-Sarkar and ConductivityType is set to Conductivity. (Read/ +Write ParametricExpression) +ConductivityType +Medium's conductivity type. Only applicable if DielectricModelling DefinitionMethod is +FrequencyIndependent or FrequencyList. (Read/Write MediumDielectricConductivityTypeEnum) +DefinitionMethod +Dielectric definition method. (Read/Write MediumDielectricDefinitionMethodEnum) +LossTangent +Medium's loss tangent. Only applicable if DielectricModelling DefinitionMethod is +FrequencyIndependent and ConductivityType is set to LossTangent. (Read/Write +ParametricExpression) +PhaseFactor +Medium's phase factor. Only applicable if DielectricModelling DefinitionMethod is Havriliak-Negami. +(Read/Write ParametricExpression) +RealPermittivityVariation +Medium's real permittivity variation.Only applicable if DielectricModelling DefinitionMethod is +Djordjevic-Sarkar. (Read/Write ParametricExpression) +RelativeHighFrequencyPermittivity +Medium's relative high frequency permittivity. Only applicable if DielectricModelling +DefinitionMethod is DebyeRelaxation, ColeCole, Havriliak-Negami or Djordjevic-Sarkar. (Read/ +Write ParametricExpression) +RelativePermittivity +Medium's frequency independent, relative permittivity. Only applicable if DielectricModelling +DefinitionMethod is FrequencyIndependent. (Read/Write ParametricExpression) +RelativeStaticPermittivity +Medium's relative static permittivity. Only applicable if DielectricModelling DefinitionMethod is +DebyeRelaxation, ColeCole or Havriliak-Negami. (Read/Write ParametricExpression) +RelaxationFrequency +Medium's relaxation frequency. Only applicable if DielectricModelling DefinitionMethod is +DebyeRelaxation, ColeCole or Havriliak-Negami. (Read/Write ParametricExpression) +Property Details +AngularFrequencyLowerLimit +Medium's angular frequency lower limit. Only applicable if DielectricModelling DefinitionMethod is +Djordjevic-Sarkar. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +AngularFrequencyUpperLimit +p.474 +Medium's angular frequency upper limit. Only applicable if DielectricModelling DefinitionMethod is +Djordjevic-Sarkar. +Type +ParametricExpression +Access +Read/Write +AttenuationFactor +Medium's attenuation factor. Only applicable if DielectricModelling DefinitionMethod is ColeCole or +Havriliak-Negami. +Type +ParametricExpression +Access +Read/Write +Conductivity +Medium's conductivity (S/m). Only applicable if DielectricModelling DefinitionMethod is +FrequencyIndependent or Djordjevic-Sarkar and ConductivityType is set to Conductivity. +Type +ParametricExpression +Access +Read/Write +ConductivityType +Medium's conductivity type. Only applicable if DielectricModelling DefinitionMethod is +FrequencyIndependent or FrequencyList. +Type +MediumDielectricConductivityTypeEnum +Access +Read/Write +DefinitionMethod +Dielectric definition method. +Type +MediumDielectricDefinitionMethodEnum +Access +Read/Write +LossTangent +Medium's loss tangent. Only applicable if DielectricModelling DefinitionMethod is +FrequencyIndependent and ConductivityType is set to LossTangent. +Type +ParametricExpression +Access +Read/Write +PhaseFactor +Medium's phase factor. Only applicable if DielectricModelling DefinitionMethod is Havriliak-Negami. +Type +ParametricExpression +Access +Read/Write +RealPermittivityVariation +Medium's real permittivity variation.Only applicable if DielectricModelling DefinitionMethod is +Djordjevic-Sarkar. +Type +ParametricExpression +Access +Read/Write +RelativeHighFrequencyPermittivity +Medium's relative high frequency permittivity. Only applicable if DielectricModelling +DefinitionMethod is DebyeRelaxation, ColeCole, Havriliak-Negami or Djordjevic-Sarkar. +Type +ParametricExpression +Access +Read/Write +RelativePermittivity +Medium's frequency independent, relative permittivity. Only applicable if DielectricModelling +DefinitionMethod is FrequencyIndependent. +Type +ParametricExpression +Access +Read/Write +RelativeStaticPermittivity +Medium's relative static permittivity. Only applicable if DielectricModelling DefinitionMethod is +DebyeRelaxation, ColeCole or Havriliak-Negami. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +RelaxationFrequency +Medium's relaxation frequency. Only applicable if DielectricModelling DefinitionMethod is +DebyeRelaxation, ColeCole or Havriliak-Negami. +p.476 +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +DielectricModellingList +A list of DielectricModelling items. +Method List +Append () +p.477 +Appends a new item to the list. (Returns a DielectricModelling object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a DielectricModelling object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +DielectricModelling +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +DielectricModelling +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Dimension +p.479 +A dimension is a measurable extent of some kind, such as height or length. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a 'NearFieldFileStructure' from a set of default properties +properties = cf.NearFieldDataFileStructure.GetDefaultProperties() +properties.CoordinateType = cf.Enums.NearFieldDataCoordinateTypeEnum.Cartesian +properties.CartesianStructure.Height = "2" +properties.CartesianStructure.Width = "2" +properties.CartesianStructure.UPoints = "11" +properties.CartesianStructure.VPoints = "11" +properties.EFieldFilename = [[EFieldFileName]] +properties.HFieldFilename = [[HFieldFileName]] +nearFieldData = +project.Definitions.FieldDataList:AddNearFieldDataFileStructure(properties) + -- Change the height of the cartesian face +nearFieldData.CartesianStructure.Height = "4" +Inheritance +The Dimension object is derived from the ParametricExpression object. +The following objects are derived (specialisations) from the Dimension object: +• AngularDimension +• NormalDimension +Usage locations +The Dimension object can be accessed from the following locations: +• Properties +◦ PointRefinement object has property Radius. +◦ SpiralCross object has property StripWidth. +◦ SpiralCross object has property ArmLength. +◦ SpiralCross object has property EdgeLength. +◦ SpiralCross object has property SpiralLength. +◦ Ring object has property OuterRadius. +◦ Ring object has property InnerRadius. +◦ OpenRing object has property OuterRadius. +◦ OpenRing object has property InnerRadius. +◦ SplitRing object has property OuterRadius. +◦ SplitRing object has property InnerRadius. +◦ Cross object has property StripWidth. +◦ Cross object has property ArmLengthU. +◦ Cross object has property ArmLengthV. +◦ StripCross object has property SlotWidth. +◦ StripCross object has property StripWidth. +◦ StripCross object has property ArmLengthU. +◦ StripCross object has property ArmLengthV. +◦ Trifilar object has property Length. +◦ Trifilar object has property StripWidth. +◦ Cone object has property BaseRadius. +◦ Cone object has property TopRadius. +◦ Cuboid object has property Depth. +◦ Cuboid object has property Width. +◦ Cylinder object has property Radius. +◦ Ellipse object has property RadiusU. +◦ Ellipse object has property RadiusV. +◦ EllipticArc object has property ApertureRadius. +◦ EllipticArc object has property Depth. +◦ EllipticArc object has property RadiusU. +◦ EllipticArc object has property RadiusV. +◦ Flare object has property BottomWidth. +◦ Flare object has property BottomDepth. +◦ Flare object has property TopWidth. +◦ Flare object has property TopDepth. +◦ Helix object has property BaseRadius. +◦ Helix object has property EndRadius. +◦ Hexagon object has property Width. +◦ StripHexagon object has property StripWidth. +◦ StripHexagon object has property Width. +◦ HyperbolicArc object has property Depth. +◦ HyperbolicArc object has property Radius. +◦ ParabolicArc object has property Radius. +◦ ParabolicArc object has property FocalDepth. +◦ ParabolicArc object has property Depth. +◦ Paraboloid object has property Radius. +◦ Rectangle object has property Depth. +◦ Rectangle object has property Width. +◦ Sphere object has property Radius. +◦ Sphere object has property RadiusU. +◦ Sphere object has property RadiusV. +◦ TCross object has property StripWidth. +◦ TCross object has property ArmLength. +◦ TCross object has property EdgeLength. +◦ GlobalCoordinates object has property X. +◦ GlobalCoordinates object has property Y. +◦ GlobalCoordinates object has property Z. +◦ GlobalOrigin object has property X. +◦ GlobalOrigin object has property Y. +◦ GlobalOrigin object has property Z. +◦ GlobalVector object has property X. +◦ GlobalVector object has property Y. +◦ GlobalVector object has property Z. +◦ LocalCoordinate object has property N. +◦ LocalCoordinate object has property U. +◦ LocalCoordinate object has property V. +◦ LocalInternalCoordinate object has property N. +◦ LocalInternalCoordinate object has property U. +◦ LocalInternalCoordinate object has property V. +◦ SurfaceCoordinate object has property U. +◦ SurfaceCoordinate object has property V. +◦ SphericalStructure object has property Radius. +◦ CartesianStructure object has property Height. +◦ CartesianStructure object has property Width. +◦ FarFieldPBCSettings object has property ArrayElementsVectorOne. +◦ FarFieldPBCSettings object has property ArrayElementsVectorTwo. +◦ FarFieldSphericalModeSettings object has property ModeMaximumIndex. +• Methods +◦ DimensionList object has method Append(). +◦ DimensionList object has method Get(number). +DimensionList +A list of Dimension items. +Method List +Append () +Appends a new item to the list. (Returns a Dimension object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a Dimension object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +Dimension +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +Dimension +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +DomainDecompositionSettings +Domain decomposition solver settings. +Example +p.484 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Activate the Domain Green's Function Method (DGFM) +project.Contents.SolutionSettings.SolverSettings.DomainDecompositionSettings.DGFMEnabled + = true +Inheritance +The DomainDecompositionSettings object is derived from the CompositeValue object. +Usage locations +The DomainDecompositionSettings object can be accessed from the following locations: +• Properties +◦ SolverSettings object has property DomainDecompositionSettings. +• Methods +◦ DomainDecompositionSettingsList object has method Append(). +◦ DomainDecompositionSettingsList object has method Get(number). +Property List +CouplingDisabled +Ignores coupling between antenna array elements (not recommended). (Read/Write boolean) +DGFMEnabled +Activates the Domain Green's Function Method (DGFM). (Read/Write boolean) +Property Details +CouplingDisabled +Ignores coupling between antenna array elements (not recommended). +Type +boolean +Access +Read/Write +DGFMEnabled +Activates the Domain Green's Function Method (DGFM). +Type +boolean +Access +Read/Write +DomainDecompositionSettingsList +A list of DomainDecompositionSettings items. +Method List +Append () +Appends a new item to the list. (Returns a DomainDecompositionSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +DomainDecompositionSettings object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +DomainDecompositionSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +DomainDecompositionSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.487 +Altair Feko 2022.3 +2 Application Programming Interface (API) +Edge +p.488 +A geometry edge entity. When the edge is not connected to any faces it is considered to be a wire. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create geometry which contains edges/wires +polyline = + project.Contents.Geometry:AddPolyline({cf.Point(0, 0, 0), cf.Point(1, 1, 1), cf.Point(1,0,0)}) + -- Remove the first wire from the polyline +polyline.Wires["Wire1"]:Delete() +Inheritance +The Edge object is derived from the TopologyEntity object. +Usage locations +The Edge object can be accessed from the following locations: +• Properties +◦ WirePort object has property Wire. +• Methods +◦ TopologyEntityCollectionOf_Edge collection has method Item(number). +◦ TopologyEntityCollectionOf_Edge collection has method Item(string). +◦ EdgeCollection collection has method Item(number). +◦ EdgeCollection collection has method Item(string). +◦ WireCollection collection has method Item(number). +◦ WireCollection collection has method Item(string). +◦ Find object has method EdgeLoop(List of Edge). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CentreOfGravity +A point indicating the centre of gravity of this entity. (Read only Point) +Coating +The wire (free edge) coating specified by a predefined Layered dielectric medium. Changing this +property will set CoatingEnabled to true. Only applicable for wires (free edges). (Read/Write +Medium) +Altair Feko 2022.3 +2 Application Programming Interface (API) +CoatingEnabled +p.489 +Specifies if a coating should be applied to the wire.Only applicable for wires (free edges). (Read/ +Write boolean) +CoreMedium +The wire core medium.Only applicable for wires (free edges). (Read/Write Medium) +EdgeType +The type of edge. (Read only GeometryEdgeEnum) +Faulty +Indicates whether the geometry entity has faults. (Read only boolean) +Geometry +The geometry operator that the region belongs to. (Read only Geometry) +Label +The object label. (Read/Write string) +Length +The length of the edge. (Read only number) +LocalIntrinsicWireRadiusEnabled +Specifies if the local intrinsic wire radius should be used for the wire. Only applicable for wires +(free edges). (Read/Write boolean) +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. (Read/Write ParametricExpression) +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. (Read/Write boolean) +LocalWireRadius +The local radius for the wire. Changing this property will set LocalWireRadiusEnabled to true. Only +applicable for wires (free edges). (Read/Write ParametricExpression) +LocalWireRadiusEnabled +Specifies if the local wire radius should be used for the wire. Only applicable for wires (free +edges). (Read/Write boolean) +SolutionMethod +The local solution method used for the wire. (Read/Write EdgeSolutionMethodEnum) +SurroundingMedium +The medium in which the wire (free edge) is embedded.Only applicable for wires (free edges). +(Read only Medium) +Type +The object type string. (Read only string) +Windscreen +The windscreen solution method settings for the wire. Only applies if the SolutionMethod is set to +Windscreen. (Read/Write WindscreenSolutionMethod) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CentreOfGravity +A point indicating the centre of gravity of this entity. +Type +Point +Access +Read only +Coating +The wire (free edge) coating specified by a predefined Layered dielectric medium. Changing this +property will set CoatingEnabled to true. Only applicable for wires (free edges). +Type +Medium +Access +Read/Write +CoatingEnabled +Specifies if a coating should be applied to the wire.Only applicable for wires (free edges). +Type +boolean +Access +Read/Write +CoreMedium +The wire core medium.Only applicable for wires (free edges). +Type +Medium +Access +Read/Write +EdgeType +The type of edge. +Type +GeometryEdgeEnum +Access +Read only +Faulty +Indicates whether the geometry entity has faults. +Type +boolean +Access +Read only +Geometry +The geometry operator that the region belongs to. +Type +Geometry +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Length +The length of the edge. +Type +number +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read only +LocalIntrinsicWireRadiusEnabled +p.492 +Specifies if the local intrinsic wire radius should be used for the wire. Only applicable for wires +(free edges). +Type +boolean +Access +Read/Write +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. +Type +ParametricExpression +Access +Read/Write +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. +Type +boolean +Access +Read/Write +LocalWireRadius +The local radius for the wire. Changing this property will set LocalWireRadiusEnabled to true. Only +applicable for wires (free edges). +Type +ParametricExpression +Access +Read/Write +LocalWireRadiusEnabled +Specifies if the local wire radius should be used for the wire. Only applicable for wires (free +edges). +Type +boolean +Access +Read/Write +SolutionMethod +The local solution method used for the wire. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +EdgeSolutionMethodEnum +Access +Read/Write +SurroundingMedium +p.493 +The medium in which the wire (free edge) is embedded.Only applicable for wires (free edges). +Type +Medium +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Windscreen +The windscreen solution method settings for the wire. Only applies if the SolutionMethod is set to +Windscreen. +Type +WindscreenSolutionMethod +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.494 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +EdgeMeshPort +p.495 +An edge mesh port which is created along an edge defining the boundary between two sets of mesh +faces. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +MeshPorts.cfx]]}) +union1 = project.Contents.Geometry['Union1'] + -- Unlink the Mesh. 'EdgeMeshPorts' are generated automatically from 'EdgePorts' +union1:UnlinkMesh() + -- Get the 'EdgeMeshPort' associated with the 'EdgePort' labelled 'EdgePort1' +edgeMeshPort = project.Contents.Ports['EdgePort1_1'] + -- Query whether the EdgeMeshPort is faulty +isFaulty = edgeMeshPort.Faulty +Inheritance +The EdgeMeshPort object is derived from the Port object. +Usage locations +The EdgeMeshPort object can be accessed from the following locations: +• Methods +◦ PortCollection collection has method AddEdgeMeshPort(table). +◦ PortCollection collection has method AddEdgeMeshPort(List of AbstractMeshTriangleFace, List of +AbstractMeshTriangleFace). +◦ PortCollection collection has method AddEdgeMeshPortConnectedToGround(List of +AbstractMeshTriangleFace, EdgePortGroundConnectionEnum). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +NegativeFaces +The collection of negative faces connected to the port. (Read/Write ObjectReferenceList) +NegativeTerminalGrounded +The option to connect the negative side of the port to ground. (Read/Write boolean) +PositiveFaces +The collection of positive faces connected to the port. (Read/Write ObjectReferenceList) +PositiveTerminalGrounded +The option to connect the positive side of the port to ground. (Read/Write boolean) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +NegativeFaces +The collection of negative faces connected to the port. +Type +ObjectReferenceList +Access +Read/Write +NegativeTerminalGrounded +The option to connect the negative side of the port to ground. +Type +boolean +Access +Read/Write +PositiveFaces +The collection of positive faces connected to the port. +Type +ObjectReferenceList +Access +Read/Write +PositiveTerminalGrounded +The option to connect the positive side of the port to ground. +Type +boolean +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +p.499 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +EdgePort +p.500 +An edge port is created along an edge defining the boundary between two sets of faces. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +corner = cf.Point(-0.25, -0.25, 0) +cube = project.Contents.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25) +-- Add an 'EdgePort' to the edge of the cube between face 1 and 2 +port = project.Contents.Ports:AddEdgePort({cube.Faces[1]},{cube.Faces[2]}) +Inheritance +The EdgePort object is derived from the Port object. +Usage locations +The EdgePort object can be accessed from the following locations: +• Methods +◦ PortCollection collection has method AddEdgePort(table). +◦ PortCollection collection has method AddEdgePort(List of Face, List of Face). +◦ PortCollection collection has method AddEdgePortConnectedToGround(List of Face, +EdgePortGroundConnectionEnum). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +NegativeFaces +The collection of negative faces connected to the port. (Read/Write ObjectReferenceList) +NegativeTerminalGrounded +The option to connect the negative side of the port to ground. (Read/Write boolean) +PositiveFaces +The collection of positive faces connected to the port. (Read/Write ObjectReferenceList) +PositiveTerminalGrounded +The option to connect the positive side of the port to ground. (Read/Write boolean) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +NegativeFaces +The collection of negative faces connected to the port. +Type +ObjectReferenceList +Access +Read/Write +NegativeTerminalGrounded +The option to connect the negative side of the port to ground. +Type +boolean +Access +Read/Write +PositiveFaces +The collection of positive faces connected to the port. +Type +ObjectReferenceList +Access +Read/Write +PositiveTerminalGrounded +The option to connect the positive side of the port to ground. +Type +boolean +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ElectricDipole +p.505 +The electric dipole source represents an elementary dipole element with the specified orientation, +magnitude and phase. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create an electric dipole at (0,0,0) oriented with + -- Theta = 0 degrees and Phi = 0 degrees +electricDipole = + project.Contents.SolutionConfigurations.GlobalSources:AddElectricDipole(cf.Point(0,0,0),0,0) +Inheritance +The ElectricDipole object is derived from the AbstractPointSource object. +Usage locations +The ElectricDipole object can be accessed from the following locations: +• Methods +◦ SourceCollection collection has method AddElectricDipole(table). +◦ SourceCollection collection has method AddElectricDipole(Point, Expression, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Magnitude +The source magnitude. (Read/Write ParametricExpression) +Phase +Phi +The source phase (degrees). (Read/Write ParametricExpression) +The phi angle (degrees). (Read/Write ParametricExpression) +Position +The position of the source. (Read/Write LocalCoordinate) +Theta +The theta angle (degrees). (Read/Write ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Collection List +Transforms +p.506 +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Magnitude +The source magnitude. +Phase +Phi +Type +ParametricExpression +Access +Read/Write +The source phase (degrees). +Type +ParametricExpression +Access +Read/Write +The phi angle (degrees). +Type +ParametricExpression +Access +Read/Write +Position +The position of the source. +Type +LocalCoordinate +Access +Read/Write +Theta +The theta angle (degrees). +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.510 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Ellipse +An ellipse. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create an ellipse with its centre at the specified 'Point' +centre = cf.Point(-0.25,-0.25,0) +ellipse = project.Contents.Geometry:AddEllipse(centre,1,0.5) +Inheritance +The Ellipse object is derived from the Geometry object. +Usage locations +The Ellipse object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddEllipse(table). +◦ GeometryCollection collection has method AddEllipse(Point, Expression, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The ellipse centre point. (Read/Write LocalCoordinate) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +RadiusU +The ellipse width. (Read/Write Dimension) +Altair Feko 2022.3 +2 Application Programming Interface (API) +RadiusV +The ellipse depth. (Read/Write Dimension) +Type +The object type string. (Read only string) +Collection List +p.512 +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.513 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +The ellipse centre point. +Type +LocalCoordinate +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +RadiusU +The ellipse width. +Type +Dimension +Access +Read/Write +RadiusV +The ellipse depth. +Type +Dimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.518 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +EllipseShape +An ellipse shape. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create an ellipse shape +ellipse = project.Definitions.PeriodicStructures.Shapes:AddEllipse(1.5, 1.2) +Inheritance +The EllipseShape object is derived from the Shape object. +Usage locations +The EllipseShape object can be accessed from the following locations: +• Methods +◦ ShapeCollection collection has method AddEllipse(table). +◦ ShapeCollection collection has method AddEllipse(Expression, Expression). +Property List +Label +The object label. (Read/Write string) +RadiusU +The ellipse shape radius (U). (Read/Write ParametricExpression) +RadiusV +The ellipse shape radius (V). (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +BuildGeometry () +Creates the full geometry representation of the shape. (Returns a Geometry object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.520 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +RadiusU +The ellipse shape radius (U). +Type +ParametricExpression +Access +Read/Write +RadiusV +The ellipse shape radius (V). +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +BuildGeometry () +Creates the full geometry representation of the shape. +Return +Geometry +The shape geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +EllipticArc +An elliptic arc. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create an elliptic arc with the ellipse's centre at the specified 'Point' +ellipseCentre = cf.Point(0, 0, 0) +ellipticArc = + project.Contents.Geometry:AddEllipticArc(ellipseCentre, 1.0, 0.5, 0, 360) +Inheritance +The EllipticArc object is derived from the Geometry object. +Usage locations +The EllipticArc object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddEllipticArc(table). +◦ GeometryCollection collection has method AddEllipticArc(Point, Expression, Expression, +Expression, Expression). +◦ GeometryCollection collection has method AddEllipticArcWithAperture(Point, Expression, +Expression, Expression, EllipticArcMajorAxisDirectionEnum). +Property List +ApertureRadius +The radius of the aperture of the elliptic arc. Only valid if DefinitionMethod is ApertureCentrePoint. +(Read/Write Dimension) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +A box indicating the bounding box of this entity. (Read/Write LocalCoordinate) +DefinitionMethod +Elliptic arc definition method as specified by the EllipticArcDefinitionMethodEnum, e.g. +EllipseCentrePoint or ApertureCentrePoint. (Read/Write EllipticArcDefinitionMethodEnum) +Depth +The distance from the aperture centre point to the apex of the elliptical arc section. Only valid if +DefinitionMethod is ApertureCentrePoint. (Read/Write Dimension) +Eccentricity +The eccentricity of the ellipse on which the elliptical arc section lies. The eccentricity must be less +than 1 to specify a valid ellipse. Only valid if DefinitionMethod is ApertureCentrePoint. (Read/Write +ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +EndAngle +p.523 +The angle (degrees), from the positive U axis direction where the arc ends. Only valid if +DefinitionMethod is EllipseCentrePoint. (Read/Write AngularDimension) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MajorAxisDirection +The major axis direction of the ellipse specified by the EllipticArcMajorAxisDirectionEnum, e.g. U +or V. (Read/Write EllipticArcMajorAxisDirectionEnum) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +RadiusU +The U radius of the ellipse on which the arc lies. Only valid if DefinitionMethod is +EllipseCentrePoint. (Read/Write Dimension) +RadiusV +The V radius of the ellipse on which the arc lies. Only valid if DefinitionMethod is +EllipseCentrePoint. (Read/Write Dimension) +StartAngle +The angle (degrees), from the positive U axis direction where the arc begins. Only valid if +DefinitionMethod is EllipseCentrePoint. (Read/Write AngularDimension) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +p.525 +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ApertureRadius +The radius of the aperture of the elliptic arc. Only valid if DefinitionMethod is ApertureCentrePoint. +Type +Dimension +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +A box indicating the bounding box of this entity. +Type +LocalCoordinate +Access +Read/Write +DefinitionMethod +Elliptic arc definition method as specified by the EllipticArcDefinitionMethodEnum, e.g. +EllipseCentrePoint or ApertureCentrePoint. +Type +EllipticArcDefinitionMethodEnum +Access +Read/Write +Depth +The distance from the aperture centre point to the apex of the elliptical arc section. Only valid if +DefinitionMethod is ApertureCentrePoint. +Type +Dimension +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Eccentricity +p.526 +The eccentricity of the ellipse on which the elliptical arc section lies. The eccentricity must be less +than 1 to specify a valid ellipse. Only valid if DefinitionMethod is ApertureCentrePoint. +Type +ParametricExpression +Access +Read/Write +EndAngle +The angle (degrees), from the positive U axis direction where the arc ends. Only valid if +DefinitionMethod is EllipseCentrePoint. +Type +AngularDimension +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +MajorAxisDirection +p.527 +The major axis direction of the ellipse specified by the EllipticArcMajorAxisDirectionEnum, e.g. U +or V. +Type +EllipticArcMajorAxisDirectionEnum +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +RadiusU +The U radius of the ellipse on which the arc lies. Only valid if DefinitionMethod is +EllipseCentrePoint. +Type +Dimension +Access +Read/Write +RadiusV +The V radius of the ellipse on which the arc lies. Only valid if DefinitionMethod is +EllipseCentrePoint. +Type +Dimension +Access +Read/Write +StartAngle +The angle (degrees), from the positive U axis direction where the arc begins. Only valid if +DefinitionMethod is EllipseCentrePoint. +Type +AngularDimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ErrorEstimation +p.532 +Error estimation is an a-posteriori error indicator which gives feedback on the mesh quality. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +standardConfiguration = + project.Contents.SolutionConfigurations:AddStandardConfiguration() + -- Create a new 'ErrorEstimation' request +errorEstimation1 = standardConfiguration.ErrorEstimations:Add() +Inheritance +The ErrorEstimation object is derived from the Object object. +Usage locations +The ErrorEstimation object can be accessed from the following locations: +• Methods +◦ ErrorEstimationCollection collection has method Add(). +◦ ErrorEstimationCollection collection has method Add(table). +◦ ErrorEstimationCollection collection has method Item(number). +◦ ErrorEstimationCollection collection has method Item(string). +Property List +CalculationScope +Control which type of elements should be considered for error estimate calculation. (Read/Write +ErrorEstimationCalculationScopeEnum) +ExportEnabled +Export error estimates to the *.out file. (Read/Write boolean) +Label +The object label. (Read/Write string) +ScopedEntities +The entities that will be considered for the error estimate calculation. (Read/Write +ObjectReferenceList) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +p.533 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CalculationScope +Control which type of elements should be considered for error estimate calculation. +Type +ErrorEstimationCalculationScopeEnum +Access +Read/Write +ExportEnabled +Export error estimates to the *.out file. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +ScopedEntities +The entities that will be considered for the error estimate calculation. +Type +ObjectReferenceList +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Exporter +The model (geometry and mesh) exporter. +Example +p.535 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Export all geometry to an ACIS file +project.Exporter.Geometry.ExportFileFormat + = cf.Enums.ExportGeometryFileFormatEnum.ACIS +project.Exporter.Geometry:Export([[temp_Export.sat]]) + -- Export all mesh to a Nastran file +project.Exporter.Mesh.ExportFileFormat = cf.Enums.ExportMeshFileFormatEnum.NASTRAN +project.Exporter.Mesh:Export([[temp_Export.nas]]) +Inheritance +The Exporter object is derived from the Object object. +Usage locations +The Exporter object can be accessed from the following locations: +• Properties +◦ Model object has property Exporter. +Property List +Geometry +The geometry exporter. (Read only GeometryExporter) +Label +Mesh +Type +The object label. (Read/Write string) +The mesh exporter. (Read only MeshExporter) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.536 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Geometry +The geometry exporter. +Type +GeometryExporter +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Mesh +The mesh exporter. +Type +MeshExporter +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ExpressionList +A list of Expression items. +Method List +Append () +Appends a new item to the list. (Returns a Expression object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a Expression object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +Expression +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +Expression +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ExpressionTable +A table (2 dimensional list) of Expression items. +Method List +AddColumn () +Appends a new column to the table. +AddRow () +Appends a new row to the table. +ColumnCount () +p.540 +Returns the number columns in the table. (Returns a number object.) +Get (rowIndex number, columnIndex number) +Returns the item at the given row and column indices. Indexing starts at 1. (Returns a Expression +object.) +RowCount () +Returns the number of rows in the table. (Returns a number object.) +Set (rowIndex number, columnIndex number, value Expression) +Set item at the given row and column indices. Indexing starts at 1. +SetDimensions (rowCount number, columnCount number) +Sets the number of rows and columns in the table. +Method Details +AddColumn () +Appends a new column to the table. +AddRow () +Appends a new row to the table. +ColumnCount () +Returns the number columns in the table. +Return +number +The number of columns in the table. +Get (rowIndex number, columnIndex number) +Returns the item at the given row and column indices. Indexing starts at 1. +Input Parameters +rowIndex(number) +The row index of the item to return. +columnIndex(number) +The column index of the item to return. +Return +Expression +The Expression at the given indices. +RowCount () +Returns the number of rows in the table. +Return +number +The number of rows in the table. +Set (rowIndex number, columnIndex number, value Expression) +Set item at the given row and column indices. Indexing starts at 1. +Input Parameters +rowIndex(number) +The row index of the item to return. +columnIndex(number) +The column index of the item to return. +value(Expression) +The Expression item to be assigned to the table at the given indices. +SetDimensions (rowCount number, columnCount number) +Sets the number of rows and columns in the table. +Input Parameters +rowCount(number) +The number of rows. +columnCount(number) +The number of columns. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FDTDBoundaryConditions +An FDTDBoundaryConditions request. +Example +p.542 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Enable the FDTD solver +project.Contents.SolutionSettings.SolverSettings.FDTDSettings.FDTDEnabled = true + -- Access the 'FDTDBoundaryConditions' object and adjust the PositiveX boundary +project.Contents.SolutionSettings.FDTDBoundary.PositiveX.BoundaryType = + cf.Enums.BoundaryFaceDefinitionEnum.PEC +Inheritance +The FDTDBoundaryConditions object is derived from the Object object. +Usage locations +The FDTDBoundaryConditions object can be accessed from the following locations: +• Properties +◦ SolutionSettings object has property FDTDBoundary. +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +NegativeX +The -X boundary settings. (Read/Write FDTDBoundarySettings) +NegativeY +The -Y boundary settings. (Read/Write FDTDBoundarySettings) +NegativeZ +The bottom (-Z) boundary settings. (Read/Write FDTDBoundarySettings) +PositiveX +The +X boundary settings. (Read/Write FDTDBoundarySettings) +PositiveY +The +Y boundary settings. (Read/Write FDTDBoundarySettings) +PositiveZ +The top (+Z) boundary settings. (Read/Write FDTDBoundarySettings) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.543 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +NegativeX +The -X boundary settings. +Type +FDTDBoundarySettings +Access +Read/Write +NegativeY +The -Y boundary settings. +Type +FDTDBoundarySettings +Access +Read/Write +NegativeZ +The bottom (-Z) boundary settings. +Type +FDTDBoundarySettings +Access +Read/Write +PositiveX +The +X boundary settings. +Type +FDTDBoundarySettings +Access +Read/Write +PositiveY +The +Y boundary settings. +Type +FDTDBoundarySettings +Access +Read/Write +PositiveZ +The top (+Z) boundary settings. +Type +FDTDBoundarySettings +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FDTDBoundarySettings +The settings for an FDTD boundary. +Example +p.546 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Enable the FDTD solver +project.Contents.SolutionSettings.SolverSettings.FDTDSettings.FDTDEnabled = true + -- Access the 'FDTDBoundarySettings' object and adjust the PositiveX boundary +xBoundarySettings = project.Contents.SolutionSettings.FDTDBoundary.PositiveX +xBoundarySettings.BoundaryType = cf.Enums.BoundaryFaceDefinitionEnum.PEC +Inheritance +The FDTDBoundarySettings object is derived from the CompositeValue object. +Usage locations +The FDTDBoundarySettings object can be accessed from the following locations: +• Properties +◦ FDTDBoundaryConditions object has property NegativeX. +◦ FDTDBoundaryConditions object has property NegativeY. +◦ FDTDBoundaryConditions object has property NegativeZ. +◦ FDTDBoundaryConditions object has property PositiveX. +◦ FDTDBoundaryConditions object has property PositiveY. +◦ FDTDBoundaryConditions object has property PositiveZ. +• Methods +◦ FDTDBoundarySettingsList object has method Append(). +◦ FDTDBoundarySettingsList object has method Get(number). +Property List +BoundaryType +Specifies the type of boundary. (Read/Write BoundaryFaceDefinitionEnum) +BufferOption +Specifies the boundary buffer option. (Read/Write BoundaryFacePropertiesEnum) +BufferPosition +The position of the free space buffer boundary if the BufferOption is SpecifyPosition. (Read/Write +ParametricExpression) +BufferSize +The free space buffer size if the BufferOption is SpecifyBufferSize. (Read/Write +ParametricExpression) +Property Details +BoundaryType +Specifies the type of boundary. +Type +BoundaryFaceDefinitionEnum +Access +Read/Write +BufferOption +Specifies the boundary buffer option. +Type +BoundaryFacePropertiesEnum +Access +Read/Write +BufferPosition +The position of the free space buffer boundary if the BufferOption is SpecifyPosition. +Type +ParametricExpression +Access +Read/Write +BufferSize +The free space buffer size if the BufferOption is SpecifyBufferSize. +Type +ParametricExpression +Access +Read/Write +FDTDBoundarySettingsList +A list of FDTDBoundarySettings items. +Method List +Append () +Appends a new item to the list. (Returns a FDTDBoundarySettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a FDTDBoundarySettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FDTDBoundarySettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FDTDBoundarySettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.549 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FDTDSettings +Settings for the finite difference time domain solver. +Example +p.550 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Activate the finite difference time domain solver +project.Contents.SolutionSettings.SolverSettings.FDTDSettings.FDTDEnabled = true +Inheritance +The FDTDSettings object is derived from the CompositeValue object. +Usage locations +The FDTDSettings object can be accessed from the following locations: +• Properties +◦ SolverSettings object has property FDTDSettings. +• Methods +◦ FDTDSettingsList object has method Append(). +◦ FDTDSettingsList object has method Get(number). +Property List +FDTDEnabled +Activates the finite difference time domain solver. (Read/Write boolean) +Property Details +FDTDEnabled +Activates the finite difference time domain solver. +Type +boolean +Access +Read/Write +FDTDSettingsList +A list of FDTDSettings items. +Method List +Append () +Appends a new item to the list. (Returns a FDTDSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a FDTDSettings object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FDTDSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FDTDSettings +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +FEKOGPUOptions +Feko Solver graphical processing units (GPU) launch options. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Access the 'FEKOGPUOptions' object and inspect if NVidia CUDA devices are + enabled +cudaEnabled = application.Launcher.Settings.FEKO.GPU.NVIDIAEnabled +Inheritance +The FEKOGPUOptions object is derived from the CompositeValue object. +Usage locations +The FEKOGPUOptions object can be accessed from the following locations: +• Properties +◦ FEKOLaunchOptions object has property GPU. +• Methods +◦ FEKOGPUOptionsList object has method Append(). +◦ FEKOGPUOptionsList object has method Get(number). +Property List +Count +List +Number of GPUs (empty = all). (Read/Write string) +List of GPUs (optional comma separated list). (Read/Write string) +NVIDIAEnabled +Enables/disables GPU for NVIDIA CUDA devices. (Read/Write boolean) +NotificationEnabled +Enables/disables GPU notification. (Read/Write boolean) +Property Details +Count +Number of GPUs (empty = all). +Type +string +Access +Read/Write +List +List of GPUs (optional comma separated list). +Type +string +Access +Read/Write +NVIDIAEnabled +Enables/disables GPU for NVIDIA CUDA devices. +Type +boolean +Access +Read/Write +NotificationEnabled +Enables/disables GPU notification. +Type +boolean +Access +Read/Write +FEKOGPUOptionsList +A list of FEKOGPUOptions items. +Method List +Append () +Appends a new item to the list. (Returns a FEKOGPUOptions object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a FEKOGPUOptions object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FEKOGPUOptions +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FEKOGPUOptions +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FEKOLaunchOptions +p.557 +The components launch options that specifies the command line parameters for the various Altair Feko +components. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Access the 'ComponentLaunchOptions' object and check the environment variables +environmentVariables = application.Launcher.Settings.Environment +Inheritance +The FEKOLaunchOptions object is derived from the CompositeValue object. +Usage locations +The FEKOLaunchOptions object can be accessed from the following locations: +• Properties +◦ ComponentLaunchOptions object has property FEKO. +• Methods +◦ FEKOLaunchOptionsList object has method Append(). +◦ FEKOLaunchOptionsList object has method Get(number). +Property List +Advanced +Advanced command line options for launching the Feko Solver. (Read/Write string) +DebugEnabled +Output debug information. (Read/Write boolean) +ExportSPICEMTLCircuitFilesEnabled +Special execution mode to export SPICE MTL circuit files. (Read/Write boolean) +GPU +Graphical processing units launch options. (Read/Write FEKOGPUOptions) +OnlyCheckGeometryEnabled +Enables/disables if the Feko Solver will perform all the geometry checks and exit before any +computations commence. (Read/Write boolean) +Parallel +Parallel execution launch options. (Read/Write FEKOParallelExecutionOptions) +ProcessPriority +The priority of the Feko Solver run. When set to Low the run will take slightly longer, but the +computer will still be responsive for other work. (Read/Write ProcessPriorityTypeEnum) +Remote +Remote execution launch options. (Read/Write FEKORemoteExecutionOptions) +Property Details +Advanced +Advanced command line options for launching the Feko Solver. +Type +string +Access +Read/Write +DebugEnabled +Output debug information. +Type +boolean +Access +Read/Write +ExportSPICEMTLCircuitFilesEnabled +Special execution mode to export SPICE MTL circuit files. +Type +boolean +Access +Read/Write +GPU +Graphical processing units launch options. +Type +FEKOGPUOptions +Access +Read/Write +OnlyCheckGeometryEnabled +Enables/disables if the Feko Solver will perform all the geometry checks and exit before any +computations commence. +Type +boolean +Access +Read/Write +Parallel +Parallel execution launch options. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +FEKOParallelExecutionOptions +Access +Read/Write +ProcessPriority +The priority of the Feko Solver run. When set to Low the run will take slightly longer, but the +computer will still be responsive for other work. +p.559 +Type +ProcessPriorityTypeEnum +Access +Read/Write +Remote +Remote execution launch options. +Type +FEKORemoteExecutionOptions +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FEKOLaunchOptionsList +A list of FEKOLaunchOptions items. +Method List +Append () +p.560 +Appends a new item to the list. (Returns a FEKOLaunchOptions object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a FEKOLaunchOptions object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FEKOLaunchOptions +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FEKOLaunchOptions +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FEKOParallelDiagnosticTests +p.562 +Feko Solver parallel diagnostic test launch options. These settings should be disabled for normal Feko +Solver runs to not degrade performance. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Access the 'FEKOParallelDiagnosticTests' and check if network diagnostics are + enabled +networkDiagnostics = + application.Launcher.Settings.FEKO.Parallel.DiagnosticTests.NetworkEnabled +Inheritance +The FEKOParallelDiagnosticTests object is derived from the CompositeValue object. +Usage locations +The FEKOParallelDiagnosticTests object can be accessed from the following locations: +• Properties +◦ FEKOParallelExecutionOptions object has property DiagnosticTests. +• Methods +◦ FEKOParallelDiagnosticTestsList object has method Append(). +◦ FEKOParallelDiagnosticTestsList object has method Get(number). +Property List +CPURunTimesEnabled +Enables/disables full CPU report with run times for individual processes. (Read/Write boolean) +MFLOPSRateEnabled +Enables/disables output of the MFLOPS rate of each process (without network communication +time). (Read/Write boolean) +NetworkEnabled +Enables/disables output of network latency and bandwidth. (Read/Write boolean) +Property Details +CPURunTimesEnabled +Enables/disables full CPU report with run times for individual processes. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +MFLOPSRateEnabled +p.563 +Enables/disables output of the MFLOPS rate of each process (without network communication +time). +Type +boolean +Access +Read/Write +NetworkEnabled +Enables/disables output of network latency and bandwidth. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FEKOParallelDiagnosticTestsList +A list of FEKOParallelDiagnosticTests items. +Method List +Append () +p.564 +Appends a new item to the list. (Returns a FEKOParallelDiagnosticTests object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a FEKOParallelDiagnosticTests +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FEKOParallelDiagnosticTests +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FEKOParallelDiagnosticTests +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.565 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FEKOParallelExecutionOptions +Feko Solver parallel execution launch options. +Example +p.566 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Access the 'FEKOParallelExecutionOptions' and check if parallel execution is + enabled +parallelEnabled = application.Launcher.Settings.FEKO.Parallel.Enabled +Inheritance +The FEKOParallelExecutionOptions object is derived from the CompositeValue object. +Usage locations +The FEKOParallelExecutionOptions object can be accessed from the following locations: +• Properties +◦ FEKOLaunchOptions object has property Parallel. +• Methods +◦ FEKOParallelExecutionOptionsList object has method Append(). +◦ FEKOParallelExecutionOptionsList object has method Get(number). +Property List +AuthenticationMethod +Specifies the mechanism to be used for authenticating the parallel processes on the individual +machines. (Read/Write ParallelAuthenticationMethodEnum) +DiagnosticTests +Feko Solver parallel diagnostic test options. (Read/Write FEKOParallelDiagnosticTests) +Enabled +Enables/disables parallel execution for the Feko Solver runs. (Read/Write boolean) +NumberOfProcessesEnabled +Enables/disables the specification of the number of processes to be used for parallel launching. +(Read/Write boolean) +ProcessCount +Specifies the total number of parallel processes to be launched. Changing this property will set +NumberOfProcessesEnabled to true. (Read/Write number) +Property Details +AuthenticationMethod +Specifies the mechanism to be used for authenticating the parallel processes on the individual +machines. +Type +ParallelAuthenticationMethodEnum +Access +Read/Write +DiagnosticTests +Feko Solver parallel diagnostic test options. +Type +FEKOParallelDiagnosticTests +Access +Read/Write +Enabled +Enables/disables parallel execution for the Feko Solver runs. +Type +boolean +Access +Read/Write +NumberOfProcessesEnabled +Enables/disables the specification of the number of processes to be used for parallel launching. +Type +boolean +Access +Read/Write +ProcessCount +Specifies the total number of parallel processes to be launched. Changing this property will set +NumberOfProcessesEnabled to true. +Type +number +Access +Read/Write +FEKOParallelExecutionOptionsList +A list of FEKOParallelExecutionOptions items. +Method List +Append () +Appends a new item to the list. (Returns a FEKOParallelExecutionOptions object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +FEKOParallelExecutionOptions object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FEKOParallelExecutionOptions +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FEKOParallelExecutionOptions +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.569 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FEKORemoteExecutionOptions +Feko Solver remote execution launch options. +Example +p.570 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Access the 'FEKORemoteExecutionOptions' object and check for remote execution +remoteExecutionEnabled = application.Launcher.Settings.FEKO.Remote.Enabled +Inheritance +The FEKORemoteExecutionOptions object is derived from the CompositeValue object. +Usage locations +The FEKORemoteExecutionOptions object can be accessed from the following locations: +• Properties +◦ FEKOLaunchOptions object has property Remote. +• Methods +◦ FEKORemoteExecutionOptionsList object has method Append(). +◦ FEKORemoteExecutionOptionsList object has method Get(number). +Property List +Enabled +Enables/disables running Feko Solver on a remote machine. (Read/Write boolean) +ExecutionMethod +Remote execution method. MPI is only supported between windows machines where ssh/rsh can +be used between different platforms. (Read/Write RemoteExecutionMethodEnum) +Host +The remote host (hostname of IP address). (Read/Write string) +Property Details +Enabled +Enables/disables running Feko Solver on a remote machine. +Type +boolean +Access +Read/Write +ExecutionMethod +Remote execution method. MPI is only supported between windows machines where ssh/rsh can +be used between different platforms. +Type +RemoteExecutionMethodEnum +Access +Read/Write +Host +The remote host (hostname of IP address). +Type +string +Access +Read/Write +FEKORemoteExecutionOptionsList +A list of FEKORemoteExecutionOptions items. +Method List +Append () +Appends a new item to the list. (Returns a FEKORemoteExecutionOptions object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +FEKORemoteExecutionOptions object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FEKORemoteExecutionOptions +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FEKORemoteExecutionOptions +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.573 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FEMLineMeshPort +p.574 +A FEM line mesh port is used to define the location of an impressed current source and load in the FEM +region. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a 'FEMLineMeshPort' between the points (0,0,0) and (1,1,0) +femLineMeshPort = + project.Contents.Ports:AddFEMLineMeshPortBetweenPoints(cf.Point(0,0,0) ,cf.Point(1,1,0) ) +Inheritance +The FEMLineMeshPort object is derived from the AbstractFEMLinePort object. +Usage locations +The FEMLineMeshPort object can be accessed from the following locations: +• Methods +◦ PortCollection collection has method AddFEMLineMeshPort(table). +◦ PortCollection collection has method AddFEMLineMeshPortBetweenPoints(Point, Point). +◦ PortCollection collection has method AddFEMLineMeshPort(MeshVertexReference, +MeshVertexReference). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +DefinitionMethod +The FEM line mesh port type definition. (Read/Write FEMLineMeshPortDefinitionMethodEnum) +End +The end point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/Write +GlobalCoordinates) +EndVertex +The end vertex of the port. Only valid if DefinitionMethod is UsingVertices. (Read/Write +MeshVertexReference) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Start +The start point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/Write +GlobalCoordinates) +StartVertex +The start vertex of the port. Only valid if DefinitionMethod is UsingVertices. (Read/Write +MeshVertexReference) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.576 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +DefinitionMethod +The FEM line mesh port type definition. +Type +FEMLineMeshPortDefinitionMethodEnum +Access +Read/Write +End +The end point of the port. Only valid if DefinitionMethod is UsingPoints. +Type +GlobalCoordinates +Access +Read/Write +EndVertex +The end vertex of the port. Only valid if DefinitionMethod is UsingVertices. +Type +MeshVertexReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Start +The start point of the port. Only valid if DefinitionMethod is UsingPoints. +Type +GlobalCoordinates +Access +Read/Write +StartVertex +The start vertex of the port. Only valid if DefinitionMethod is UsingVertices. +Type +MeshVertexReference +Access +Read/Write +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +p.579 +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.581 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FEMLinePort +p.582 +A FEM line port is used to define the location of an impressed current source and load in the FEM region. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +corner = cf.Point(-0.25, -0.25, 0) +cube = project.Contents.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25) +dielectric = project.Definitions.Media.Dielectric:AddDielectric() +project.Contents.Geometry[1].Regions[1].Medium = dielectric +project.Contents.Geometry[1].Regions[1].SolutionMethod + = cf.Enums.RegionSolutionMethodEnum.FEM + -- Add a 'FEMLinePort' to the edge of the cuboid +port = project.Contents.Ports:AddFEMLinePort({cube.Edges[1]}) +Inheritance +The FEMLinePort object is derived from the AbstractFEMLinePort object. +Usage locations +The FEMLinePort object can be accessed from the following locations: +• Methods +◦ PortCollection collection has method AddFEMLinePort(table). +◦ PortCollection collection has method AddFEMLinePortBetweenPoints(Point, Point). +◦ PortCollection collection has method AddFEMLinePort(List of Edge). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +DefinitionMethod +The FEM line port type definition. (Read/Write FEMLinePortDefinitionMethodEnum) +Edges +End +Label +The collection of port edges. Only valid if DefinitionMethod is UsingEdges. (Read/Write +ObjectReferenceList) +The end point. Only valid if DefinitionMethod is UsingPoints. (Read/Write GlobalCoordinates) +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +PolarityReversed +The option to reverse polarity of the port. (Read/Write boolean) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Start +The start point. Only valid if DefinitionMethod is UsingPoints. (Read/Write GlobalCoordinates) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.584 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +DefinitionMethod +The FEM line port type definition. +Type +FEMLinePortDefinitionMethodEnum +Access +Read/Write +Edges +End +The collection of port edges. Only valid if DefinitionMethod is UsingEdges. +Type +ObjectReferenceList +Access +Read/Write +The end point. Only valid if DefinitionMethod is UsingPoints. +Type +GlobalCoordinates +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +PolarityReversed +The option to reverse polarity of the port. +Type +boolean +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Start +The start point. Only valid if DefinitionMethod is UsingPoints. +Type +GlobalCoordinates +Access +Read/Write +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +p.587 +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.589 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FEMModalMeshPort +p.590 +A FEM modal mesh port is used to apply a modal port boundary condition on the boundary of a finite +element (FEM) region. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a 'FEMModalMeshPort' spanning the points (0,0,0), (0,1,0) and (1,1,0) +femLineMeshPort = project.Contents.Ports:AddFEMModalMeshPortFromPoints( +cf.Point(0,0,0) ,cf.Point(0,1,0), cf.Point(1,1,0) ) +Inheritance +The FEMModalMeshPort object is derived from the Port object. +Usage locations +The FEMModalMeshPort object can be accessed from the following locations: +• Methods +◦ PortCollection collection has method AddFEMModalMeshPort(table). +◦ PortCollection collection has method AddFEMModalMeshPortFromPoints(Point, Point, Point). +◦ PortCollection collection has method AddFEMModalMeshPort(MeshVertexReference, +MeshVertexReference, MeshVertexReference). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Corner1 +The first construction point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/Write +LocalCoordinate) +Corner2 +The second construction point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/ +Write LocalCoordinate) +Corner3 +The third construction point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/Write +LocalCoordinate) +DefinitionMethod +The FEM modal port definition type. (Read/Write FEMModalMeshPortDefinitionMethodEnum) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Collection List +Transforms +p.591 +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Corner1 +The first construction point of the port. Only valid if DefinitionMethod is UsingPoints. +Type +LocalCoordinate +Access +Read/Write +Corner2 +The second construction point of the port. Only valid if DefinitionMethod is UsingPoints. +Type +LocalCoordinate +Access +Read/Write +Corner3 +The third construction point of the port. Only valid if DefinitionMethod is UsingPoints. +Type +LocalCoordinate +Access +Read/Write +DefinitionMethod +The FEM modal port definition type. +Type +FEMModalMeshPortDefinitionMethodEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.595 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FEMModalPort +p.596 +A FEM modal port is used to apply a modal port boundary condition on the boundary of a finite element +(FEM) region. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +corner = cf.Point(-0.25, -0.25, 0) +cube = project.Contents.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25) +cube.Regions[1].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.FEM + -- Add a 'FEMModalPort' around the top face of the cube. +port = project.Contents.Ports:AddFEMModalPort({cube.Faces[1]}) +Inheritance +The FEMModalPort object is derived from the Port object. +Usage locations +The FEMModalPort object can be accessed from the following locations: +• Methods +◦ PortCollection collection has method AddFEMModalPort(table). +◦ PortCollection collection has method AddFEMModalPort(List of Face). +◦ PortCollection collection has method AddFEMModalPortFromPoints(Point, Point, Point). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Corner1 +The first construction point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/Write +LocalCoordinate) +Corner2 +The second construction point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/ +Write LocalCoordinate) +Corner3 +The third construction point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/Write +LocalCoordinate) +DefinitionMethod +The FEM modal port definition type. (Read/Write FEMModalPortDefinitionMethodEnum) +Faces +The collection of port faces. Only valid if DefinitionMethod is UsingFaces. (Read/Write +ObjectReferenceList) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Type +The object type string. (Read only string) +Collection List +Transforms +p.597 +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Corner1 +The first construction point of the port. Only valid if DefinitionMethod is UsingPoints. +Type +LocalCoordinate +Access +Read/Write +Corner2 +The second construction point of the port. Only valid if DefinitionMethod is UsingPoints. +Type +LocalCoordinate +Access +Read/Write +Corner3 +The third construction point of the port. Only valid if DefinitionMethod is UsingPoints. +Type +LocalCoordinate +Access +Read/Write +DefinitionMethod +The FEM modal port definition type. +Type +FEMModalPortDefinitionMethodEnum +Access +Read/Write +Faces +The collection of port faces. Only valid if DefinitionMethod is UsingFaces. +Type +ObjectReferenceList +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +p.600 +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +FEMModalSource +A FEM modal source. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a FEM modal port +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(1,1,0), 1, 1, 1) +cuboid.Regions[1].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.FEM +FEMModalPort = project.Contents.Ports:AddFEMModalPort({cuboid.Faces[1]}) + -- Add a FEM modal source to the FEM line port +FEMModalSource = + project.Contents.SolutionConfigurations.GlobalSources:AddFEMModalSource(FEMModalPort) +Inheritance +The FEMModalSource object is derived from the Source object. +Usage locations +The FEMModalSource object can be accessed from the following locations: +• Methods +◦ SourceCollection collection has method AddFEMModalSource(table). +◦ SourceCollection collection has method AddFEMModalSource(FEMModalPort). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +Magnitude +The source magnitude. (Read/Write ParametricExpression) +Phase +Type +The source phase (degrees). (Read/Write ParametricExpression) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.603 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Magnitude +The source magnitude. +Type +ParametricExpression +Access +Read/Write +Phase +The source phase (degrees). +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +FEMSettings +FEM solver settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Decouple the FEM regions from MoM regions +project.Contents.SolutionSettings.SolverSettings.FEMSettings.DecoupleFEMFromMoM + = true +Inheritance +The FEMSettings object is derived from the CompositeValue object. +Usage locations +The FEMSettings object can be accessed from the following locations: +• Properties +◦ SolverSettings object has property FEMSettings. +• Methods +◦ FEMSettingsList object has method Append(). +◦ FEMSettingsList object has method Get(number). +Property List +DecoupleFEMFromMoM +Specifies whether FEM regions should be decoupled from MoM regions. (Read/Write boolean) +ElementOrder +Specifies the desired order or allows the solution kernel to select the most appropriate order, +specified by FEMElementOrderEnum, eg. Auto, First, etc. (Read/Write FEMElementOrderEnum) +Property Details +DecoupleFEMFromMoM +Specifies whether FEM regions should be decoupled from MoM regions. +Type +boolean +Access +Read/Write +ElementOrder +Specifies the desired order or allows the solution kernel to select the most appropriate order, +specified by FEMElementOrderEnum, eg. Auto, First, etc. +Type +FEMElementOrderEnum +Access +Read/Write +FEMSettingsList +A list of FEMSettings items. +Method List +Append () +Appends a new item to the list. (Returns a FEMSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a FEMSettings object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FEMSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FEMSettings +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Face +A geometry face entity. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create geometry which contains faces +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) + -- Remove some faces from the cuboid +cuboid.Faces["Face1"]:Delete() +cuboid.Faces["Face4"]:Delete() +cuboid.Faces["Face6"]:Delete() + -- Rename the bottom face entity +cuboid.Faces["Face5"].Label = "BottomFace" +Inheritance +The Face object is derived from the TopologyEntity object. +Usage locations +The Face object can be accessed from the following locations: +• Properties +◦ WorkSurface object has property ReferenceFace. +◦ WaveguidePort object has property Face. +• Methods +◦ FaceCollection collection has method Item(number). +◦ FaceCollection collection has method Item(string). +Property List +BasisFunctionSettings +Local basis function solver settings for the face. (Read/Write BasisFunctionLocalSolverSettings) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CentreOfGravity +A point indicating the centre of gravity of this entity. (Read only Point) +CharacterisedSurfaceReferenceDirection +Reference direction of the coating. (Read/Write ReferenceDirection) +Coating +The face coating specified by a predefined Layered dielectric medium. An electrically thin coating +is applied on both sides of the face, while an electrically thick coating is applied on the normal +side of the face. The face should be set up to have free space on at least one of the sides, while +the other side can be free space or PEC. Changing this property will set CoatingEnabled to true. +(Read/Write Medium) +CoatingEnabled +Specifies if a coating should be applied to the face. (Read/Write boolean) +CoatingThickness +The thickness of the coaitng. (Read/Write ParametricExpression) +FaceAbsorbingSettings +The face absorption, reflection and transmission properties with regards to rays. Only applies if +the SolutionMethod is set to RLGO. (Read/Write RLGOFaceAbsorbingSettings) +Faulty +Indicates whether the geometry entity has faults. (Read only boolean) +Geometry +The geometry operator that the region belongs to. (Read only Geometry) +IntegralEquation +The type of integral equation for perfectly conducting metallic surfaces. Only applies when +SolutionMethod is set to None. (Read/Write IntegralEquationTypeEnum) +Label +The object label. (Read/Write string) +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. (Read/Write ParametricExpression) +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. (Read/Write boolean) +Medium +The face medium. (Read/Write Medium) +SolutionMethod +The local solution method used for the face. (Read/Write FaceSolutionMethodEnum) +SurfaceCoatingType +The surface coating type for the face. (Read/Write SurfaceCoatingTypeEnum) +Thickness +The face medium thickness. Only applies when the Medium is defined as a Metallic. (Read/Write +ParametricExpression) +Type +The object type string. (Read only string) +Windscreen +The windscreen solution method settings for the face. Only applies if the SolutionMethod is set to +Windscreen. (Read/Write WindscreenSolutionMethod) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BasisFunctionSettings +Local basis function solver settings for the face. +Type +BasisFunctionLocalSolverSettings +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CentreOfGravity +A point indicating the centre of gravity of this entity. +Type +Point +Access +Read only +CharacterisedSurfaceReferenceDirection +Reference direction of the coating. +Type +ReferenceDirection +Access +Read/Write +Coating +The face coating specified by a predefined Layered dielectric medium. An electrically thin coating +is applied on both sides of the face, while an electrically thick coating is applied on the normal +side of the face. The face should be set up to have free space on at least one of the sides, while +the other side can be free space or PEC. Changing this property will set CoatingEnabled to true. +Type +Medium +Access +Read/Write +CoatingEnabled +Specifies if a coating should be applied to the face. +Type +boolean +Access +Read/Write +CoatingThickness +The thickness of the coaitng. +Type +ParametricExpression +Access +Read/Write +FaceAbsorbingSettings +The face absorption, reflection and transmission properties with regards to rays. Only applies if +the SolutionMethod is set to RLGO. +Type +RLGOFaceAbsorbingSettings +Access +Read/Write +Faulty +Indicates whether the geometry entity has faults. +Type +boolean +Access +Read only +Geometry +The geometry operator that the region belongs to. +Type +Geometry +Access +Read only +IntegralEquation +The type of integral equation for perfectly conducting metallic surfaces. Only applies when +SolutionMethod is set to None. +Type +IntegralEquationTypeEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. +Type +ParametricExpression +Access +Read/Write +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. +Type +boolean +Access +Read/Write +Medium +The face medium. +Type +Medium +Access +Read/Write +SolutionMethod +The local solution method used for the face. +Type +FaceSolutionMethodEnum +Access +Read/Write +SurfaceCoatingType +The surface coating type for the face. +Type +SurfaceCoatingTypeEnum +Access +Read/Write +Thickness +The face medium thickness. Only applies when the Medium is defined as a Metallic. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Windscreen +The windscreen solution method settings for the face. Only applies if the SolutionMethod is set to +Windscreen. +Type +WindscreenSolutionMethod +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.615 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +FarField +A solution far field request. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a far field request +farFieldRequest = + project.Contents.SolutionConfigurations[1].FarFields:Add(0,0,90,180,30,60) +Inheritance +The FarField object is derived from the Object object. +Usage locations +The FarField object can be accessed from the following locations: +• Properties +◦ FarFieldOptimisationGoal object has property FocusSource. +• Methods +◦ FarFieldCollection collection has method Add(table). +◦ FarFieldCollection collection has method Add3DPattern(). +◦ FarFieldCollection collection has method AddHorizontalCutUVPlane(). +◦ FarFieldCollection collection has method AddRequestInPlaneWaveIncidentDirection(). +◦ FarFieldCollection collection has method AddSquareGrid(). +◦ FarFieldCollection collection has method AddVerticalCutUNPlane(). +◦ FarFieldCollection collection has method AddVerticalCutVNPlane(). +◦ FarFieldCollection collection has method Add(Expression, Expression, Expression, Expression, +Expression, Expression). +◦ FarFieldCollection collection has method Item(number). +◦ FarFieldCollection collection has method Item(string). +Property List +Advanced +Advanced properties for the far field request. (Read/Write FarFieldAdvancedSettings) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CalculationDirection +The fields calculation direction type. (Read/Write FarFieldCalculationDirectionEnum) +CoordinateSystem +The fields coordinate system direction type. (Read/Write FarFieldCoordinateSystemEnum) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Phi +The range of phi values. (Read/Write PointAngleRange) +ScopeSettings +Far field scope settings. (Read/Write ScopeSettings) +Theta +Type +The range of theta values. (Read/Write PointAngleRange) +The object type string. (Read only string) +U. (Read/Write PointRange) +V. (Read/Write PointRange) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.618 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Advanced +Advanced properties for the far field request. +Type +FarFieldAdvancedSettings +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CalculationDirection +The fields calculation direction type. +Type +FarFieldCalculationDirectionEnum +Access +Read/Write +CoordinateSystem +The fields coordinate system direction type. +Type +FarFieldCoordinateSystemEnum +Label +Access +Read/Write +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Phi +The range of phi values. +Type +PointAngleRange +Access +Read/Write +ScopeSettings +Far field scope settings. +Type +ScopeSettings +Access +Read/Write +Theta +The range of theta values. +Type +PointAngleRange +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +U. +Type +PointRange +Access +Read/Write +V. +Type +PointRange +Access +Read/Write +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.622 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldAdvancedSettings +The advanced far field settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a far field request +p.623 +farFieldRequest = project.Contents.SolutionConfigurations[1].FarFields:Add3DPattern() + -- Enable the calculation of continuous far field data +farFieldRequest.Advanced.AdaptiveSamplingEnabled = true +Inheritance +The FarFieldAdvancedSettings object is derived from the CompositeValue object. +Usage locations +The FarFieldAdvancedSettings object can be accessed from the following locations: +• Properties +◦ FarField object has property Advanced. +• Methods +◦ FarFieldAdvancedSettingsList object has method Append(). +◦ FarFieldAdvancedSettingsList object has method Get(number). +Property List +AdaptiveSamplingEnabled +Calculate continuous far field data. (Read/Write boolean) +ExportSettings +Far field export settings. (Read/Write FarFieldExportSettings) +FieldOnlyIntegrated +Only determine radiated far field power by integration. (Read/Write boolean) +OnlyScatteredPartCalculationEnabled +Calculate only the scattered part of the field. (Read/Write boolean) +PBC +Far field periodic boundary condition settings. (Read/Write FarFieldPBCSettings) +RequestType +The calculation of directivity or gain (when not calculating RCS). (Read/Write +FarFieldRequestTypeEnum) +SphericalModes +Far field spherical mode settings. (Read/Write FarFieldSphericalModeSettings) +Property Details +AdaptiveSamplingEnabled +Calculate continuous far field data. +Type +boolean +Access +Read/Write +ExportSettings +Far field export settings. +Type +FarFieldExportSettings +Access +Read/Write +FieldOnlyIntegrated +Only determine radiated far field power by integration. +Type +boolean +Access +Read/Write +OnlyScatteredPartCalculationEnabled +Calculate only the scattered part of the field. +Type +boolean +Access +Read/Write +PBC +Far field periodic boundary condition settings. +Type +FarFieldPBCSettings +Access +Read/Write +RequestType +The calculation of directivity or gain (when not calculating RCS). +Type +FarFieldRequestTypeEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SphericalModes +Far field spherical mode settings. +Type +FarFieldSphericalModeSettings +Access +Read/Write +p.625 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldAdvancedSettingsList +A list of FarFieldAdvancedSettings items. +Method List +Append () +p.626 +Appends a new item to the list. (Returns a FarFieldAdvancedSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a FarFieldAdvancedSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FarFieldAdvancedSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FarFieldAdvancedSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.627 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldData +A far field data using file structure import. +Example +p.628 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Import 'FarFieldData' from previously a exported 'FarField' +farFieldData = + project.Definitions.FieldDataList:AddFarFieldDataUsingKnownFileFormat([[FarFieldData.ffe]]) +Inheritance +The FarFieldData object is derived from the FieldData object. +Usage locations +The FarFieldData object can be accessed from the following locations: +• Properties +◦ FarFieldReceivingAntenna object has property FieldData. +• Methods +◦ FieldDataCollection collection has method AddFarFieldData(table). +◦ FieldDataCollection collection has method AddFarFieldDataUsingKnownFileFormat(string). +◦ FieldDataCollection collection has method AddFarFieldDataUsingStructure(string, Expression, +Expression). +Property List +DataBlockNumber +The data block that is first read from. (Read/Write ParametricExpression) +FieldDataFileImportDefinitionTypeEnum +The definition type used to import the file. (Read/Write FieldDataFileImportDefinitionEnum) +FileType +Select the file type. (Read/Write FarFieldDataFileTypeEnum) +Filename +Import file containing the far field data. (Read/Write FileReference) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +NumberPhiPoints +The number of points along Phi. (Read/Write ParametricExpression) +NumberThetaPoints +The number of points along Theta. (Read/Write ParametricExpression) +StartFromPoint +The initial point to start with. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +DataBlockNumber +The data block that is first read from. +Type +ParametricExpression +Access +Read/Write +FieldDataFileImportDefinitionTypeEnum +The definition type used to import the file. +Type +FieldDataFileImportDefinitionEnum +Access +Read/Write +FileType +Select the file type. +Type +FarFieldDataFileTypeEnum +Access +Read/Write +Filename +Import file containing the far field data. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +NumberPhiPoints +The number of points along Phi. +Type +ParametricExpression +Access +Read/Write +NumberThetaPoints +The number of points along Theta. +Type +ParametricExpression +Access +Read/Write +StartFromPoint +The initial point to start with. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldExportSettings +Far field export settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a far field request +p.634 +farFieldRequest = project.Contents.SolutionConfigurations[1].FarFields:Add3DPattern() + -- Export fields to ASCII file (*.ffe) +farFieldRequest.Advanced.ExportSettings.ASCIIEnabled = true +Inheritance +The FarFieldExportSettings object is derived from the CompositeValue object. +Usage locations +The FarFieldExportSettings object can be accessed from the following locations: +• Properties +◦ FarFieldAdvancedSettings object has property ExportSettings. +• Methods +◦ FarFieldExportSettingsList object has method Append(). +◦ FarFieldExportSettingsList object has method Get(number). +Property List +ASCIIEnabled +Export fields to ASCII file (*.ffe). (Read/Write boolean) +OutFileEnabled +Export fields to *.out file. (Read/Write boolean) +Property Details +ASCIIEnabled +Export fields to ASCII file (*.ffe). +Type +boolean +Access +Read/Write +OutFileEnabled +Export fields to *.out file. +Type +boolean +Access +Read/Write +FarFieldExportSettingsList +A list of FarFieldExportSettings items. +Method List +Append () +Appends a new item to the list. (Returns a FarFieldExportSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a FarFieldExportSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FarFieldExportSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FarFieldExportSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.637 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldOptimisationGoal +A far field optimisation goal. +Example +p.638 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Horn_error_estimates.cfx]]}) +farField = project.Contents.SolutionConfigurations[1].FarFields[1] +search = + project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) + -- Create a far field optimisation goal with focus on the far field request +properties = cf.FarFieldOptimisationGoal.GetDefaultProperties() +properties.FocusSource = farField +properties.GoalOperator = cf.Enums.OptimisationGoalOperatorEnum.Maximise +properties.ProcessingSteps[1].Operation + = cf.Enums.OptimisationGoalProcessingStepsEnum.Average +farFieldGoal = search.Goals:AddFarFieldGoal(properties) + -- Set the polarisation type to Horizontal +properties = farFieldGoal:GetProperties() +properties.PolarisationType + = cf.Enums.OptimisationFarFieldPolarisationTypeEnum.Horizontal +properties.ProcessingSteps[1].Operation + = cf.Enums.OptimisationGoalProcessingStepsEnum.Real +farFieldGoal:SetProperties(properties) +Inheritance +The FarFieldOptimisationGoal object is derived from the OptimisationGoal object. +Usage locations +The FarFieldOptimisationGoal object can be accessed from the following locations: +• Methods +◦ OptimisationGoalCollection collection has method AddFarFieldGoal(table). +Property List +FocusSource +Set the focus source to a specified source object. The intended usage is for when the source is +defined in CADFEKO. (Read/Write FarField) +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. (Read/Write string) +FocusType +Sets the focus type. (Read/Write OptimisationFarFieldFocusTypeEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GoalOperator +p.639 +The goal operator indicates the desired relationship between the goal focus and the objective. +(Read/Write OptimisationGoalOperatorEnum) +Label +The object label. (Read/Write string) +Objective +The objective describes a state that the optimisation process should attempt to achieve. (Read +only OptimisationGoalObjective) +PolarisationType +Sets the polarisation. (Read/Write OptimisationFarFieldPolarisationTypeEnum) +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. (Read/Write OptimisationGoalProcessingStepsList) +Type +The object type string. (Read only string) +Weight +Specify the optimisation weight. (Read/Write ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +FocusSource +Set the focus source to a specified source object. The intended usage is for when the source is +defined in CADFEKO. +Type +FarField +Access +Read/Write +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. +Type +string +Access +Read/Write +FocusType +Sets the focus type. +Type +OptimisationFarFieldFocusTypeEnum +Access +Read/Write +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +Type +OptimisationGoalOperatorEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Objective +The objective describes a state that the optimisation process should attempt to achieve. +Type +OptimisationGoalObjective +Access +Read only +PolarisationType +Sets the polarisation. +Type +OptimisationFarFieldPolarisationTypeEnum +Access +Read/Write +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. +Type +OptimisationGoalProcessingStepsList +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Weight +Specify the optimisation weight. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.642 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldPBCSettings +Far field periodic boundary condition settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a far field request +p.643 +farFieldRequest = project.Contents.SolutionConfigurations[1].FarFields:Add3DPattern() + -- Enable the far field calculation for an array of elements +farFieldRequest.Advanced.PBC.CalculateArrayElementsEnabled = true +farFieldRequest.Advanced.PBC.ArrayElementsVectorOne = 2 +farFieldRequest.Advanced.PBC.ArrayElementsVectorTwo = 1 +Inheritance +The FarFieldPBCSettings object is derived from the CompositeValue object. +Usage locations +The FarFieldPBCSettings object can be accessed from the following locations: +• Properties +◦ FarFieldAdvancedSettings object has property PBC. +• Methods +◦ FarFieldPBCSettingsList object has method Append(). +◦ FarFieldPBCSettingsList object has method Get(number). +Property List +ArrayElementsVectorOne +Number of elements along vector 1. This property is only valid if CalculateArrayElementsEnabled +is true. (Read/Write Dimension) +ArrayElementsVectorTwo +Number of elements along vector 2. This property is only valid if CalculateArrayElementsEnabled +is true. (Read/Write Dimension) +CalculateArrayElementsEnabled +Calculate far field for an array of elements. (Read/Write boolean) +Property Details +ArrayElementsVectorOne +Number of elements along vector 1. This property is only valid if CalculateArrayElementsEnabled +is true. +Type +Dimension +Access +Read/Write +ArrayElementsVectorTwo +Number of elements along vector 2. This property is only valid if CalculateArrayElementsEnabled +is true. +Type +Dimension +Access +Read/Write +CalculateArrayElementsEnabled +Calculate far field for an array of elements. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldPBCSettingsList +A list of FarFieldPBCSettings items. +Method List +Append () +p.645 +Appends a new item to the list. (Returns a FarFieldPBCSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a FarFieldPBCSettings object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FarFieldPBCSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FarFieldPBCSettings +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldReceivingAntenna +A solution far field receiving antenna request. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +p.647 +standardConfiguration = + project.Contents.SolutionConfigurations['StandardConfiguration1'] +farFieldData = + project.Definitions.FieldDataList:AddFarFieldDataUsingKnownFileFormat([[FarFieldData.ffe]]) + -- Create a 'FarFieldReceivingAntenna' from farFieldData +farFieldReceivingAntenna = + standardConfiguration.FarFieldReceivingAntennas:Add(farFieldData) + -- Specify that scattered parts of the 'FarField' should be included +farFieldReceivingAntenna.IncludeScatteredPart = true + -- Delete this 'FarFieldReceivingAntenna' +farFieldReceivingAntenna:Delete() +Inheritance +The FarFieldReceivingAntenna object is derived from the BaseFieldReceivingAntenna object. +Usage locations +The FarFieldReceivingAntenna object can be accessed from the following locations: +• Methods +◦ FarFieldReceivingAntennaCollection collection has method Add(table). +◦ FarFieldReceivingAntennaCollection collection has method Add(FarFieldData). +◦ FarFieldReceivingAntennaCollection collection has method Item(number). +◦ FarFieldReceivingAntennaCollection collection has method Item(string). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +FieldData +The field data that defines the receiving antenna. (Read/Write FarFieldData) +IncludeScatteredPart +Enable including only the scattered part of the field. (Read/Write boolean) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Phi +The far field request phi orientation (degrees). (Read/Write ParametricExpression) +Position +The position of the source. (Read/Write LocalCoordinate) +Theta +Type +The far field request theta orientation (degrees). (Read/Write ParametricExpression) +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +p.649 +Type +Box +Access +Read only +FieldData +The field data that defines the receiving antenna. +Type +FarFieldData +Access +Read/Write +IncludeScatteredPart +Enable including only the scattered part of the field. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Phi +The far field request phi orientation (degrees). +Type +ParametricExpression +Access +Read/Write +Position +The position of the source. +Type +LocalCoordinate +Access +Read/Write +Theta +The far field request theta orientation (degrees). +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +FarFieldSource +A solution far field source. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +farFieldData = + project.Definitions.FieldDataList:AddFarFieldDataUsingKnownFileFormat([[FarFieldData.ffe]]) + -- Create a 'FarFieldSource' from farFieldData +farFieldSource = + project.Contents.SolutionConfigurations.GlobalSources:AddFarFieldSource(farFieldData) + -- Set the phase of the NearFieldSource to 30 degrees +farFieldSource.Phase = 30 + -- Delete this FarFieldSource +farFieldSource:Delete() +Inheritance +The FarFieldSource object is derived from the Source object. +Usage locations +The FarFieldSource object can be accessed from the following locations: +• Methods +◦ SourceCollection collection has method AddFarFieldSource(table). +◦ SourceCollection collection has method AddFarFieldSource(FarFieldData). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +FieldData +The field data that defines the source. (Read/Write FieldData) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Magnitude +The source magnitude scaling factor. (Read/Write ParametricExpression) +Phase +The source phase offset (degrees). (Read/Write ParametricExpression) +Phi +The far field source Phi orientation (degrees). (Read/Write ParametricExpression) +Position +The position of the source. (Read/Write LocalCoordinate) +Theta +Type +The far field source Theta orientation (degrees). (Read/Write ParametricExpression) +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +FieldData +The field data that defines the source. +Type +FieldData +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Magnitude +The source magnitude scaling factor. +Type +ParametricExpression +Access +Read/Write +Phase +The source phase offset (degrees). +Type +ParametricExpression +Access +Read/Write +Phi +The far field source Phi orientation (degrees). +Type +ParametricExpression +Access +Read/Write +Position +The position of the source. +Type +LocalCoordinate +Access +Read/Write +Theta +The far field source Theta orientation (degrees). +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.659 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldSphericalModeSettings +Far field spherical mode settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a far field request +p.660 +farFieldRequest = project.Contents.SolutionConfigurations[1].FarFields:Add3DPattern() + -- Calculate spherical expansion mode coefficients +farFieldRequest.Advanced.SphericalModes.CalculationEnabled = true +Inheritance +The FarFieldSphericalModeSettings object is derived from the CompositeValue object. +Usage locations +The FarFieldSphericalModeSettings object can be accessed from the following locations: +• Properties +◦ FarFieldAdvancedSettings object has property SphericalModes. +• Methods +◦ FarFieldSphericalModeSettingsList object has method Append(). +◦ FarFieldSphericalModeSettingsList object has method Get(number). +Property List +CalculationEnabled +Calculate spherical expansion mode coefficients. (Read/Write boolean) +ExportToASCIIEnabled +Export spherical expansion coefficients to ASCII file. This property is only valid if +CalculationEnabled is true. (Read/Write boolean) +ModeMaximumIndex +Specify maximum mode index N. Changing this property will set ModeMaximumIndexEnabled to +true. (Read/Write Dimension) +ModeMaximumIndexEnabled +Specify number of spherical modes. This property is only valid if CalculationEnabled is true. +(Read/Write boolean) +Property Details +CalculationEnabled +Calculate spherical expansion mode coefficients. +Type +boolean +Access +Read/Write +ExportToASCIIEnabled +Export spherical expansion coefficients to ASCII file. This property is only valid if +CalculationEnabled is true. +Type +boolean +Access +Read/Write +ModeMaximumIndex +Specify maximum mode index N. Changing this property will set ModeMaximumIndexEnabled to +true. +Type +Dimension +Access +Read/Write +ModeMaximumIndexEnabled +Specify number of spherical modes. This property is only valid if CalculationEnabled is true. +Type +boolean +Access +Read/Write +FarFieldSphericalModeSettingsList +A list of FarFieldSphericalModeSettings items. +Method List +Append () +Appends a new item to the list. (Returns a FarFieldSphericalModeSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +FarFieldSphericalModeSettings object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FarFieldSphericalModeSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FarFieldSphericalModeSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.663 +FieldData +A field data definition. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +farFieldData = + project.Definitions.FieldDataList:AddFarFieldDataUsingKnownFileFormat([[FarFieldData.ffe]]) + -- Duplicate a specific 'FieldData' type to get the general 'FieldData' type. +fieldData = farFieldData:Duplicate() +Inheritance +The FieldData object is derived from the Object object. +The following objects are derived (specialisations) from the FieldData object: +• FarFieldData +• NearFieldDataFileStructure +• NearFieldDataFullImport +• PCBCurrentData +• SolutionCoefficientData +• SphericalModeDataFromFile +• SphericalModeDataManuallySpecified +Usage locations +The FieldData object can be accessed from the following locations: +• Properties +◦ FarFieldSource object has property FieldData. +◦ NearFieldSource object has property FieldData. +◦ PCBSource object has property FieldData. +◦ SolutionCoefficientSource object has property FieldData. +◦ SphericalModeSource object has property FieldData. +◦ SphericalModeReceivingAntenna object has property FieldData. +• Methods +◦ FieldDataCollection collection has method Item(number). +◦ FieldDataCollection collection has method Item(string). +Property List +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +p.667 +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +FileReference +A reference to a file. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Import 'SphericalModeDataFromFile' from previously a exported 'FarField' +sphericalModesData = project.Definitions.FieldDataList: +AddSphericalModeDataFullImport([[SphericalModesData.sph]]) +Inheritance +The FileReference object is derived from the CompositeValue object. +Usage locations +The FileReference object can be accessed from the following locations: +• Properties +◦ CharacterisedSurface object has property Filename. +◦ Dielectric object has property Filename. +◦ FreeSpace object has property Filename. +◦ GroundPlaneMedium object has property Filename. +◦ Zero object has property Filename. +◦ +ImpedanceSheet object has property Filename. +◦ Metal object has property Filename. +◦ CableGeneralNetwork object has property Filename. +◦ CableSpiceNetwork object has property Filename. +◦ ComplexLoad object has property Filename. +◦ SolutionCoefficientData object has property Filename. +◦ PCBCurrentData object has property Filename. +◦ SphericalModeDataFromFile object has property Filename. +◦ NearFieldDataFullImport object has property Filename. +◦ NearFieldDataFullImport object has property EFieldFilename. +◦ NearFieldDataFullImport object has property HFieldFilename. +◦ NearFieldDataFullImport object has property Directory. +◦ NearFieldDataFileStructure object has property EFieldFilename. +◦ NearFieldDataFileStructure object has property HFieldFilename. +◦ FarFieldData object has property Filename. +◦ GeneralNetwork object has property Filename. +◦ Load object has property Filename. +◦ ProtectedModel object has property Filename. +◦ ShieldLayerSettings object has property SurfaceImpedanceFrequencyPropertiesFile. +◦ ShieldLayerSettings object has property TransferAdmittanceFrequencyPropertiesFile. +◦ ShieldLayerSettings object has property TransferImpedanceFrequencyPropertiesFile. +• Methods +◦ FileReferenceList object has method Append(). +◦ FileReferenceList object has method Get(number). +FileReferenceList +A list of FileReference items. +Method List +Append () +Appends a new item to the list. (Returns a FileReference object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a FileReference object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FileReference +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FileReference +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +FillHoleSettings +A settings object for filling a geometry hole. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Get the settings for filling a geometry hole +fillHoleSettings = project.Contents.Geometry.Rebuild.FillHoleSettings + -- Enable smooth internal edges when filling a geometry hole +fillHoleSettings.SmoothInternalEdgesEnabled = true + -- Restore the default settings for 'FillHoleSettings' +fillHoleSettings:RestoreDefaults() +Inheritance +The FillHoleSettings object is derived from the Object object. +Usage locations +The FillHoleSettings object can be accessed from the following locations: +• Properties +◦ GeometryRebuild object has property FillHoleSettings. +Property List +HoleBoundaryTransition +Specifies the hole boundary transition from the hole boundary faces to the hole fill faces. (Read/ +Write FillHoleBoundaryTransitionTypeEnum) +Label +The object label. (Read/Write string) +PatchTopology +The topology surface options for the patch filling the hole. (Read/Write +FillHolePatchTopologyTypeEnum) +SmoothInternalEdgesEnabled +If this option is selected, the internal edges of the faces used to fill the hole will be smooth and +without discontinuities. (Read/Write boolean) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +p.674 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RestoreDefaults () +Restores all the settings to their default values. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +HoleBoundaryTransition +Specifies the hole boundary transition from the hole boundary faces to the hole fill faces. +Type +FillHoleBoundaryTransitionTypeEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +PatchTopology +The topology surface options for the patch filling the hole. +Type +FillHolePatchTopologyTypeEnum +Access +Read/Write +SmoothInternalEdgesEnabled +If this option is selected, the internal edges of the faces used to fill the hole will be smooth and +without discontinuities. +Type +boolean +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RestoreDefaults () +Restores all the settings to their default values. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Find +The find tools. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +project.Contents.Geometry:AddEllipse(cf.Point(), 2, 2) +project.Contents.Geometry:AddRectangle(cf.Point(), 1, 1) + -- Find the geometry that clashes +clashingGeometry = project.Contents.Geometry.Find:GetClashingGeometry() +Inheritance +The Find object is derived from the Object object. +Usage locations +The Find object can be accessed from the following locations: +• Properties +◦ GeometryCollection collection has property Find. +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +EdgeLoop (edges List of Edge) +Find the smallest closed loop from the specified list of edges. (Returns a List of Edge object.) +GetClashingGeometry () +Find parts where geometry clashes or where one part is completely inside another. (Returns a List +of Geometry object.) +GetClashingGeometry (geometrylist List of Geometry) +Find parts where geometry clashes or where one part is completely inside another from the given +list of geometry parts. (Returns a List of Geometry object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.677 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +EdgeLoop (edges List of Edge) +Find the smallest closed loop from the specified list of edges. +Input Parameters +edges(List of Edge) +The list of edges which forms part of the closed loop. +Return +List of Edge +The list of edges forming a closed loop. +GetClashingGeometry () +Find parts where geometry clashes or where one part is completely inside another. +Return +List of Geometry +The list of clashing geometry. +GetClashingGeometry (geometrylist List of Geometry) +Find parts where geometry clashes or where one part is completely inside another from the given +list of geometry parts. +Input Parameters +geometrylist(List of Geometry) +The list of geometry parts from which a search for clashes is conducted. +Return +List of Geometry +The list of clashing geometry. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +FittedSpline +A fitted spline. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a fitted spline from a 'Point' list +points = {} +points[1] = cf.Point(1,0,0) +points[2] = cf.Point(1,1,0) +points[3] = cf.Point(1,1,1) +fittedSpline = project.Contents.Geometry:AddFittedSpline(points) +Inheritance +The FittedSpline object is derived from the Geometry object. +Usage locations +The FittedSpline object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddFittedSpline(table). +◦ GeometryCollection collection has method AddFittedSpline(List of Point). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Points +The collection of point coordinates of the fitted spline. (Read/Write LocalInternalCoordinateList) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +p.681 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Points +The collection of point coordinates of the fitted spline. +Type +LocalInternalCoordinateList +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Flare +A flare. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a flare with its base centre at the specified 'Point' +baseCentre = cf.Point(-0.25, -0.25, 0) +flare = project.Contents.Geometry:AddFlare(baseCentre, 0.5, 0.5, 1.0, 0.3, 0.3) +Inheritance +The Flare object is derived from the Geometry object. +Usage locations +The Flare object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddFlare(table). +◦ GeometryCollection collection has method AddFlare(Point, Expression, Expression, Expression, +Expression, Expression). +◦ GeometryCollection collection has method AddFlareWithBaseCentreAndFlareAngles(Point, +Expression, Expression, Expression, Expression, Expression). +◦ GeometryCollection collection has method AddFlareWithBaseCorner(Point, Expression, +Expression, Expression, Expression, Expression). +◦ GeometryCollection collection has method AddFlareWithBaseCornerAndTopCorner(Point, Point, +Expression, Expression). +Property List +AngleU +The flare angle from the UN plane (degrees). Only valid if DefinitionMethod is +BaseCentreAndFlareAngles. (Read/Write AngularDimension) +AngleV +The flare angle from the VN plane (degrees). Only valid if DefinitionMethod is +BaseCentreAndFlareAngles. (Read/Write AngularDimension) +Base +The flare base corner/centre origin point. (Read/Write LocalCoordinate) +BottomDepth +The flare bottom depth. (Read/Write Dimension) +BottomWidth +The flare bottom width. (Read/Write Dimension) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +DefinitionMethod +Flare definition method specified by the FlareDefinitionMethodEnum, e.g. +BaseCentreAndAllDimensions, BaseCornerAndAllDimensions, etc. (Read/Write +FlareDefinitionMethodEnum) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Height +The flare height. Only valid if DefinitionMethod is BaseCentreAndAllDimensions, +BaseCornerAndAllDimensions or BaseCentreAndFlareAngles. (Read/Write NormalDimension) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Top +The flare top corner point. Only valid if DefinitionMethod is BaseCornerAndTopCorner. (Read/Write +LocalCoordinate) +TopDepth +The flare top depth. Only valid if DefinitionMethod is BaseCentreAndAllDimensions or +BaseCornerAndAllDimensions. (Read/Write Dimension) +TopWidth +The flare top width. Only valid if DefinitionMethod is BaseCentreAndAllDimensions or +BaseCornerAndAllDimensions. (Read/Write Dimension) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AngleU +The flare angle from the UN plane (degrees). Only valid if DefinitionMethod is +BaseCentreAndFlareAngles. +Type +AngularDimension +Access +Read/Write +AngleV +The flare angle from the VN plane (degrees). Only valid if DefinitionMethod is +BaseCentreAndFlareAngles. +Type +AngularDimension +Access +Read/Write +Base +The flare base corner/centre origin point. +Type +LocalCoordinate +Access +Read/Write +BottomDepth +The flare bottom depth. +Type +Dimension +Access +Read/Write +BottomWidth +The flare bottom width. +Type +Dimension +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +DefinitionMethod +Flare definition method specified by the FlareDefinitionMethodEnum, e.g. +BaseCentreAndAllDimensions, BaseCornerAndAllDimensions, etc. +Type +FlareDefinitionMethodEnum +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Height +The flare height. Only valid if DefinitionMethod is BaseCentreAndAllDimensions, +BaseCornerAndAllDimensions or BaseCentreAndFlareAngles. +Type +NormalDimension +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Top +The flare top corner point. Only valid if DefinitionMethod is BaseCornerAndTopCorner. +Type +LocalCoordinate +Access +Read/Write +TopDepth +The flare top depth. Only valid if DefinitionMethod is BaseCentreAndAllDimensions or +BaseCornerAndAllDimensions. +Type +Dimension +Access +Read/Write +TopWidth +The flare top width. Only valid if DefinitionMethod is BaseCentreAndAllDimensions or +BaseCornerAndAllDimensions. +Type +Dimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.696 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Form +p.697 +A fully customisable dialog. The form can be used as the base component for facilitating feedback from +interactive scripts. +Example + -- Create a 'Form' and a 'Label' to put on it +form = cf.Form.New("My Custom Dialog") +label = cf.FormLabel.New("Hello world!") + -- Add the label to the form's layout +form:Add(label) + -- Execute the form, potentially waiting for user input from buttons and widgets + added + -- to the form +form:Run() +Usage locations +The Form object can be accessed from the following locations: +• Static functions +◦ Form object has static function New(string, FormLayoutEnum). +◦ Form object has static function New(string). +◦ Form object has static function New(). +Property List +Buttons +A grouping that contains the OK and Cancel buttons. (Read only FormButtons) +Height +The height in pixels of the form window. (Read only number) +Title +Type +Width +The title that will be displayed in the title bar at the top of the form. (Read/Write string) +The object type string. (Read only string) +The width in pixels of the form window. (Read only number) +Collection List +FormItems +The collection of item widgets contained in the form. (FormItemCollection of FormItem.) +Method List +Accept () +Close the dialog and return true as return code for the Run() method. +Add (item FormItem) +Adds the given item to the form. Items can be any of the defined form item types. +Add (item FormItem, row number, column number) +Adds the given item to the form at the specified position. Positions are defined as a row and +column, starting at (1,1). +Reject () +Close the dialog and return false as return code for the Run() method. +Remove (item FormItem) +Removes the given item from the form. The item can be any of the items that resides in the +collection of the form items. +Resize () +Resize form to fit visible contents. +Run () +Executes the form. The values of any items will be modified and made accessible in a script once +the OK button on the form is pressed. (Returns a boolean object.) +SetSize (width number, height number) +Set the width and height of the form in pixels. Ensure that width and height are larger than zero. +Constructor Function List +Critical (title string, message string) +Creates a new critical message form and displays it. Further execution of the script is halted. +Info (title string, message string) +Creates an information message form and displays it. +New (title string, layout FormLayoutEnum) +Creates a new form with a specified label and layout. (Returns a Form object.) +New (title string) +Creates a new form with a specified label and vertical layout. (Returns a Form object.) +New () +Creates a new form with a vertical layout. (Returns a Form object.) +Warning (title string, message string) +Creates a new warning message form and displays it. +Property Details +Buttons +A grouping that contains the OK and Cancel buttons. +Type +FormButtons +Access +Read only +Height +The height in pixels of the form window. +Type +number +Access +Read only +Title +The title that will be displayed in the title bar at the top of the form. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Width +The width in pixels of the form window. +Type +number +Access +Read only +Collection Details +FormItems +The collection of item widgets contained in the form. +Type +FormItemCollection +Method Details +Accept () +Close the dialog and return true as return code for the Run() method. +Add (item FormItem) +Adds the given item to the form. Items can be any of the defined form item types. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +item(FormItem) +The form item to add to the form. +Add (item FormItem, row number, column number) +Adds the given item to the form at the specified position. Positions are defined as a row and +column, starting at (1,1). +p.700 +Input Parameters +item(FormItem) +The form item to add to the form. +row(number) +The layout row position. +column(number) +The layout column position. +Reject () +Close the dialog and return false as return code for the Run() method. +Remove (item FormItem) +Removes the given item from the form. The item can be any of the items that resides in the +collection of the form items. +Input Parameters +item(FormItem) +The form item to remove from the form. +Resize () +Resize form to fit visible contents. +Run () +Executes the form. The values of any items will be modified and made accessible in a script once +the OK button on the form is pressed. +Return +boolean +True for the OK button and false for the Cancel button. +SetSize (width number, height number) +Set the width and height of the form in pixels. Ensure that width and height are larger than zero. +Input Parameters +width(number) +Width of the form in pixels. +height(number) +Height of the form in pixels. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +Critical (title string, message string) +p.701 +Creates a new critical message form and displays it. Further execution of the script is halted. +Input Parameters +title(string) +The form window title. +message(string) +The critical message to display on the form. +Info (title string, message string) +Creates an information message form and displays it. +Input Parameters +title(string) +The form window title. +message(string) +The information message to display on the form. +New (title string, layout FormLayoutEnum) +Creates a new form with a specified label and layout. +Input Parameters +title(string) +The form window title. +layout(FormLayoutEnum) +A value indicating how new items will be arranged. +Return +Form +New (title string) +The newly created form. +Creates a new form with a specified label and vertical layout. +Input Parameters +title(string) +The form window title. +Return +Form +The newly created form. +New () +Creates a new form with a vertical layout. +Return +Form +The newly created form. +Warning (title string, message string) +Creates a new warning message form and displays it. +Input Parameters +title(string) +The form window title. +message(string) +The warning message to display on the form. +FormButtons +The form buttons. +Example +form = cf.Form.New("Default buttons") + -- Retrieve which button the user pressed +okPressed = form:Run() +Usage locations +The FormButtons object can be accessed from the following locations: +• Properties +◦ Form object has property Buttons. +Property List +Cancel +The Cancel button. (Read only FormPushButton) +OK +The OK button. (Read only FormPushButton) +Property Details +Cancel +The Cancel button. +OK +Type +FormPushButton +Access +Read only +The OK button. +Type +FormPushButton +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormCheckBox +p.704 +A check box item. Check boxes are used mainly in two cases. The first case is when a simple yes/no +response is required. The second case is when multiple selections from a number options is permitted. +In this case each option will be presented by a separate check box. +Example +form = cf.Form.New("Export settings") + -- Create check boxes +checkbox1 = cf.FormCheckBox.New("Export electric near fields.") +checkbox1.Checked = true +checkbox2 = cf.FormCheckBox.New("Export magnetic near fields.") + -- Add check boxes to 'Form' layout +form:Add(checkbox1) +form:Add(checkbox2) + -- Run the form and retrieve the user input +form:Run() +mustExportEFields = checkbox1.Checked +mustExportHFields = checkbox2.Checked +Inheritance +The FormCheckBox object is derived from the FormItem object. +Usage locations +The FormCheckBox object can be accessed from the following locations: +• Static functions +◦ FormCheckBox object has static function New(string). +◦ FormCheckBox object has static function New(). +Property List +Checked +The state of the check box. True indicates that the box is checked, false indicates that it is +unchecked. (Read/Write boolean) +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +Label +The label of the push button. (Read/Write string) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +The object type string. (Read only string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +SetCallBack (callback function) +Set the function that will be called when the check box state changes. +Constructor Function List +New (label string) +Create a new check box item. The text describing the check box is determined by the specified +label. (Returns a FormCheckBox object.) +New () +Create a new check box item. (Returns a FormCheckBox object.) +Property Details +Checked +The state of the check box. True indicates that the box is checked, false indicates that it is +unchecked. +Type +boolean +Access +Read/Write +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +Label +The label of the push button. +Type +string +Access +Read/Write +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +Visible +p.708 +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +SetCallBack (callback function) +Set the function that will be called when the check box state changes. +Input Parameters +callback(function) +The function call back. +Static Function Details +New (label string) +Create a new check box item. The text describing the check box is determined by the specified +label. +Input Parameters +label(string) +The label describing the check box. +Return +FormCheckBox +A check box form item created with the specified label. +New () +Create a new check box item. +Return +FormCheckBox +A check box form item created with the specified label. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormComboBox +p.709 +A combo box item. A combo box provides a list of options of which at least one must be selected. +Example +form = cf.Form.New("Export settings") + -- Prepare input parameter and create combo box +options = {} +table.insert(options, "Only electric near fields") +table.insert(options, "Only magnetic near fields") +table.insert(options, "Both electric and magnetic near fields") +combobox = cf.FormComboBox.New("Results to export:", options) +form:Add(combobox) + -- Run the form and retrieve the user input +form:Run() +exportOptionSelected = combobox.Value +Inheritance +The FormComboBox object is derived from the FormLabelledItem object. +Usage locations +The FormComboBox object can be accessed from the following locations: +• Static functions +◦ FormComboBox object has static function New(string, Map of number:Expression). +◦ FormComboBox object has static function New(Map of number:Expression). +Property List +Count +The number of combo box items. (Read only number) +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +Index +The index of the selected item in the combo box item. (Read/Write number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Options +The options available in the combo box. (Read/Write Map of number:Expression) +Type +Value +The object type string. (Read only string) +The text of the selected item in the combo box item. (Read/Write Expression) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Constructor Function List +New (label string, map Map of number:Expression) +Create a new combo box item. (Returns a FormComboBox object.) +New (map Map of number:Expression) +Create a new combo box item. (Returns a FormComboBox object.) +p.711 +Property Details +Count +The number of combo box items. +Type +number +Access +Read only +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +Index +The index of the selected item in the combo box item. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Options +The options available in the combo box. +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The text of the selected item in the combo box item. +Type +Expression +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Return +FormLabel +The form label item. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Input Parameters +callback(function) +The function call back. +Static Function Details +New (label string, map Map of number:Expression) +Create a new combo box item. +Input Parameters +label(string) +The text description that will appear next to the combo box. +map(Map of number:Expression) +The combo box value index map. The map refers to a standard Lua table with numeric +indexing. +Return +FormComboBox +The combo box item created. +New (map Map of number:Expression) +Create a new combo box item. +Input Parameters +map(Map of number:Expression) +The combo box value index map. The map refers to a standard Lua table with numeric +indexing. +Return +FormComboBox +The combo box item created. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormDirectoryBrowser +p.715 +A directory browser item. When working with multiple files, it is often simplest to specify only the +directory where the files are located. When generating multiple files, it is also useful to specify where +the files should be stored. The directory browser is then a tool for navigating through the operating +system's directory structures to set an active directory of interest. +Example +form = cf.Form.New("Export data") +dirBrowser = cf.FormDirectoryBrowser.New("Output directory:") +form:Add(dirBrowser) + -- Run the form and retrieve the selection +form:Run() +selectedPath = dirBrowser.Value +Inheritance +The FormDirectoryBrowser object is derived from the FormLabelledItem object. +Usage locations +The FormDirectoryBrowser object can be accessed from the following locations: +• Static functions +◦ FormDirectoryBrowser object has static function New(string). +◦ FormDirectoryBrowser object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The directory path. (Read/Write string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Constructor Function List +New (label string) +Create a new directory browser item. (Returns a FormDirectoryBrowser object.) +New () +Create a new directory browser item. (Returns a FormDirectoryBrowser object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The directory path. +Type +string +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +FormLabel +The form label item. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +p.719 +Input Parameters +callback(function) +The function call back. +Static Function Details +New (label string) +Create a new directory browser item. +Input Parameters +label(string) +The item label. +Return +FormDirectoryBrowser +The directory browser item created. +New () +Create a new directory browser item. +Return +FormDirectoryBrowser +The directory browser item created. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormDoubleSpinBox +p.720 +A spin box item supporting doubles. Spin boxes are sometimes also referred to as numeric steppers +or spinners. Spin boxes are used to obtain a numerical value. Up and down arrows are provided to +increment or decrement the value respectively. Alternatively, the numerical value can be typed into the +input field. +Example +form = cf.Form.New("Generate views") + -- Create 'FormDoubleSpinBox' and adjust its initial settings +spinbox = cf.FormDoubleSpinBox.New("Frequency step between views:") +spinbox:SetMinimum(12.5) +spinbox:SetMaximum(250) +spinbox:SetSingleStep(12.5) +form:Add(spinbox) + -- Run the form and retrieve the user input +form:Run() +selectedFrequency = spinbox.Value +Inheritance +The FormDoubleSpinBox object is derived from the FormLabelledItem object. +Usage locations +The FormDoubleSpinBox object can be accessed from the following locations: +• Static functions +◦ FormDoubleSpinBox object has static function New(string). +◦ FormDoubleSpinBox object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The starting value of the spin box. (Read/Write number) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +SetDecimals (decimals number) +The precision of the spin box, in decimals. +SetMaximum (maximum number) +Set the maximum value of the spin box. +SetMinimum (minimum number) +Set the minimum value of the spin box. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetSingleStep (step number) +p.722 +The single step size of the spin box item. When the user uses the arrows to change the spin box's +value the value will be incremented/decremented by the amount of the single step. The default +value is 1.0. Setting a step size value of less than 0 does nothing. +Constructor Function List +New (label string) +Create a new spin box item. (Returns a FormDoubleSpinBox object.) +New () +Create a new spin box item. (Returns a FormDoubleSpinBox object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +p.723 +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The starting value of the spin box. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Visible +p.724 +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Return +FormLabel +The form label item. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Input Parameters +callback(function) +The function call back. +SetDecimals (decimals number) +The precision of the spin box, in decimals. +Input Parameters +decimals(number) +The precision. +SetMaximum (maximum number) +Set the maximum value of the spin box. +Input Parameters +maximum(number) +The maximum value. +SetMinimum (minimum number) +Set the minimum value of the spin box. +Input Parameters +minimum(number) +The minimum value. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetSingleStep (step number) +p.725 +The single step size of the spin box item. When the user uses the arrows to change the spin box's +value the value will be incremented/decremented by the amount of the single step. The default +value is 1.0. Setting a step size value of less than 0 does nothing. +Input Parameters +step(number) +The step size. +Static Function Details +New (label string) +Create a new spin box item. +Input Parameters +label(string) +The label next to the spin box describing the meaning of the value. +Return +FormDoubleSpinBox +The newly created spin box item. +New () +Create a new spin box item. +Return +FormDoubleSpinBox +The newly created spin box item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormFileBrowser +p.726 +A file browser item. The file browser can be used to navigate an operating system's directory structure +to look for and select a file. +Example +form = cf.Form.New("Process model") + --- Create 'FormFileBrowser' and adjust its initial settings +fileBrowser = cf.FormFileBrowser.New("Model:") +fileBrowser:SetFilter("*.fek") +fileBrowser.MultiSelect = false +form:Add(fileBrowser) + -- Run the form and retrieve the user input +form:Run() +selectedPath = fileBrowser.Value +Inheritance +The FormFileBrowser object is derived from the FormLabelledItem object. +Usage locations +The FormFileBrowser object can be accessed from the following locations: +• Static functions +◦ FormFileBrowser object has static function New(string). +◦ FormFileBrowser object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +MultiSelect +Set multiple selection for file browsing. (Read/Write boolean) +Type +Value +The object type string. (Read only string) +The path of the file(s) separated by “;”. (Read/Write List of string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +Run () +Displays the file open dialog and places the resulting file selection into the Value property. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +SetFilter (filter string) +Sets a filter for the file types. It must be in the standard Qt form, i.e. File type name (*.ex1 +*.ex2);;Second type (*.*). +Altair Feko 2022.3 +2 Application Programming Interface (API) +Constructor Function List +New (label string) +Create a new file browser item. (Returns a FormFileBrowser object.) +New () +Create a new file browser item. (Returns a FormFileBrowser object.) +p.728 +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +MultiSelect +Set multiple selection for file browsing. +Type +boolean +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The path of the file(s) separated by “;”. +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Visible +p.730 +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Return +FormLabel +The form label item. +Run () +Displays the file open dialog and places the resulting file selection into the Value property. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Input Parameters +callback(function) +The function call back. +SetFilter (filter string) +Sets a filter for the file types. It must be in the standard Qt form, i.e. File type name (*.ex1 +*.ex2);;Second type (*.*). +Input Parameters +filter(string) +The file filter. +Static Function Details +New (label string) +Create a new file browser item. +Input Parameters +label(string) +The item label. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +FormFileBrowser +The file browser item created. +New () +Create a new file browser item. +Return +FormFileBrowser +The file browser item created. +p.731 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormFileSaveAsBrowser +p.732 +A file browser item. The file browser can be used to navigate an operating system's directory structure +to look for and select a file. +Example +form = cf.Form.New() + -- Create a 'FormFileSaveAsBrowser' form item +formFileSaveAsBrowser = cf.FormFileSaveAsBrowser.New("File name") + -- Add 'FormFileSaveAsBrowser' item to the form +form:Add(formFileSaveAsBrowser) + -- Show and run the form +form:Run() +Inheritance +The FormFileSaveAsBrowser object is derived from the FormLabelledItem object. +Usage locations +The FormFileSaveAsBrowser object can be accessed from the following locations: +• Static functions +◦ FormFileSaveAsBrowser object has static function New(string). +◦ FormFileSaveAsBrowser object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The path of the file. (Read/Write string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +Run () +Displays the file open dialog and places the resulting file selection into the Value property. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +SetFilter (filter string) +Sets a filter for the file types. It must be in the standard Qt form, i.e. File type name (*.ex1 +*.ex2);;Second type (*.*). +Constructor Function List +New (label string) +Create a new file save as browser item. (Returns a FormFileSaveAsBrowser object.) +New () +Create a new file save as browser item. (Returns a FormFileSaveAsBrowser object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The path of the file. +Type +string +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Return +FormLabel +The form label item. +Run () +Displays the file open dialog and places the resulting file selection into the Value property. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Input Parameters +callback(function) +The function call back. +SetFilter (filter string) +Sets a filter for the file types. It must be in the standard Qt form, i.e. File type name (*.ex1 +*.ex2);;Second type (*.*). +Input Parameters +filter(string) +The file filter. +Static Function Details +New (label string) +Create a new file save as browser item. +Input Parameters +label(string) +The item label. +Return +FormFileSaveAsBrowser +The file browser item created. +New () +Create a new file save as browser item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +FormFileSaveAsBrowser +The file browser item created. +p.737 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormGroupBox +p.738 +A group box is a type of frame that contains other items. Group boxes are often used to make logical +groupings of items and are therefore mainly design components. Functionally, group boxes make it +easier to hide or disable several items simultaneously by simply modifying the properties of the group +box container. +Example +form = cf.Form.New("Convert format") +inputFile = cf.FormFileBrowser.New("Input filename") +group = cf.FormGroupBox.New("Output options") +outputFile = cf.FormLineEdit.New("Output filename") +checkbox1 = cf.FormCheckBox.New("Export angles in degrees") + -- Add items into the 'FormGroupBox' layout +group:Add(outputFile) +group:Add(checkbox1) + -- Add the 'FormGroupBox' and other items into the top level 'Form' layout +form:Add(inputFile) +form:Add(group) +form:Run() +Inheritance +The FormGroupBox object is derived from the FormItem object. +Usage locations +The FormGroupBox object can be accessed from the following locations: +• Static functions +◦ FormGroupBox object has static function New(string, FormLayoutEnum). +◦ FormGroupBox object has static function New(string). +◦ FormGroupBox object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +Altair Feko 2022.3 +2 Application Programming Interface (API) +FixedWidth +p.739 +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +The object type string. (Read only string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Collection List +FormItems +The collection of item widgets contained in the group box. (FormGroupBoxItemCollection of +FormItem.) +Method List +Add (item FormItem) +Adds the given item to the group box. Items can be any of the defined form item types. +Add (item FormItem, row number, column number) +Adds the given item to the group box at the specified position. Positions are defined as a row and +column, starting at (1,1). +Remove (item FormItem) +Removes the given item from the group box. The item can be any of the items that resides in the +collection of the form items contained in the group box. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Constructor Function List +New (label string, layout FormLayoutEnum) +p.740 +Create a new group box item with a specified label and layout. (Returns a FormGroupBox object.) +New (label string) +Create a new group box item with a specified label and vertical layout. (Returns a FormGroupBox +object.) +New () +Create a new group box item with a vertical layout. (Returns a FormGroupBox object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +p.741 +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Collection Details +FormItems +The collection of item widgets contained in the group box. +Type +FormGroupBoxItemCollection +Method Details +Add (item FormItem) +Adds the given item to the group box. Items can be any of the defined form item types. +Input Parameters +item(FormItem) +The item widget to add to the group. +Add (item FormItem, row number, column number) +Adds the given item to the group box at the specified position. Positions are defined as a row and +column, starting at (1,1). +Input Parameters +item(FormItem) +The form item to add to the group. +row(number) +The layout row position. +column(number) +The layout column position. +Remove (item FormItem) +Removes the given item from the group box. The item can be any of the items that resides in the +collection of the form items contained in the group box. +Input Parameters +item(FormItem) +The form item to remove from the group. +Static Function Details +New (label string, layout FormLayoutEnum) +Create a new group box item with a specified label and layout. +Input Parameters +label(string) +The item label. +layout(FormLayoutEnum) +A value indicating how new items will be arranged. +Return +FormGroupBox +The newly created group box item. +New (label string) +Create a new group box item with a specified label and vertical layout. +Input Parameters +label(string) +The item label. +Return +FormGroupBox +The newly created group box item. +New () +Create a new group box item with a vertical layout. +Return +FormGroupBox +The newly created group box item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormImage +p.744 +An image item. Images can be added to any form or group box. Supported formats include PNG, BMP +and JPG/JPEG files. +Example +form = cf.Form.New() +item1 = cf.FormLabel.New("Coordinate system:") +form:Add(item1); + -- Load an image from file and add it to the form +image = cf.FormImage.New(FEKO_HOME..[[/shared/Resources/Automation/axisar.png]]) +form:Add(image) +form:Run() +Inheritance +The FormImage object is derived from the FormItem object. +Usage locations +The FormImage object can be accessed from the following locations: +• Static functions +◦ FormImage object has static function New(string). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +Height +Height of the image in pixels. (Read only number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The path location of source file that will be used for the image. (Read/Write string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Width +Width of the image in pixels. (Read only number) +Method List +ResetSize () +Reset the width/height to the image's default. +SetSize (width number, height number) +Set the width and height of the image in pixels. Ensure that width and height are larger than zero. +Constructor Function List +New (path string) +Create a new image. (Returns a FormImage object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +Height +Height of the image in pixels. +Type +number +Access +Read only +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +MinimumHeight +p.747 +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The path location of source file that will be used for the image. +Type +string +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Width +Width of the image in pixels. +Type +number +Access +Read only +Method Details +ResetSize () +Reset the width/height to the image's default. +SetSize (width number, height number) +Set the width and height of the image in pixels. Ensure that width and height are larger than zero. +Input Parameters +width(number) +Width of the image in pixels. +height(number) +Height of the image in pixels. +Static Function Details +New (path string) +Create a new image. +Input Parameters +path(string) +The file path of the source image. +Return +FormImage +The newly created image item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormIntegerSpinBox +p.749 +A spin box item. Spin boxes are sometimes also referred to as numeric steppers or spinners. Spin boxes +can be used to obtain an integer value. Up and down arrows are provided to increment or decrement +the value respectively. Alternatively, the numerical value can be typed into the input field. +Example +form = cf.Form.New("Re-sample data") + -- Create 'FormIntegerSpinBox' and adjust its initial settings +spinbox = cf.FormIntegerSpinBox.New("Number of samples:") +spinbox:SetMinimum(3) +spinbox:SetMaximum(101) +form:Add(spinbox) + -- Run the form and retrieve the user input +form:Run() +numberOfSamplesSelected = spinbox.Value +Inheritance +The FormIntegerSpinBox object is derived from the FormLabelledItem object. +Usage locations +The FormIntegerSpinBox object can be accessed from the following locations: +• Static functions +◦ FormIntegerSpinBox object has static function New(string). +◦ FormIntegerSpinBox object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The starting value of the spin box. (Read/Write number) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +SetMaximum (maximum number) +Set the maximum value of the spin box. +SetMinimum (minimum number) +Set the minimum value of the spin box. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetSingleStep (step number) +p.751 +The single step size of the spin box item. When the user uses the arrows to change the spin box's +value the value will be incremented/decremented by the amount of the single step. The default +value is 1. Setting a step size value of less than 0 does nothing. +Constructor Function List +New (label string) +Create a new spin box item. (Returns a FormIntegerSpinBox object.) +New () +Create a new spin box item. (Returns a FormIntegerSpinBox object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +p.752 +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The starting value of the spin box. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Visible +p.753 +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Return +FormLabel +The form label item. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Input Parameters +callback(function) +The function call back. +SetMaximum (maximum number) +Set the maximum value of the spin box. +Input Parameters +maximum(number) +The maximum value. +SetMinimum (minimum number) +Set the minimum value of the spin box. +Input Parameters +minimum(number) +The minimum value. +SetSingleStep (step number) +The single step size of the spin box item. When the user uses the arrows to change the spin box's +value the value will be incremented/decremented by the amount of the single step. The default +value is 1. Setting a step size value of less than 0 does nothing. +Input Parameters +step(number) +The step size. +Static Function Details +New (label string) +Create a new spin box item. +Input Parameters +label(string) +The label next to the spin box describing the meaning of the value. +Return +FormIntegerSpinBox +The newly created spin box item. +New () +Create a new spin box item. +Return +FormIntegerSpinBox +The newly created spin box item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormItem +p.755 +The structure of all form items. All form items share a set of common properties that are listed here. +Example +form = cf.Form.New() + -- Create a variety of form items +checkbox = cf.FormCheckBox.New("Export electric near fields.") +label = cf.FormLabel.New("Item 1") +dirBrowser = cf.FormDirectoryBrowser.New("Output directory:") +form:Add(checkbox) +form:Add(label) +form:Add(dirBrowser) + -- All form items share the Enabled and Visible properties +checkbox.Enabled = false +label.Enabled = false +dirBrowser.Visible = false +form:Run() +Inheritance +The following objects are derived (specialisations) from the FormItem object: +• FormCheckBox +• FormGroupBox +• FormImage +• FormLabel +• FormLabelledItem +• FormLayout +• FormPushButton +• FormRadioButtonGroup +• FormScrollArea +• FormSeparator +• FormTree +Usage locations +The FormItem object can be accessed from the following locations: +• Methods +◦ FormScrollAreaItemCollection collection has method Items(). +◦ FormScrollAreaItemCollection collection has method Item(number). +◦ FormScrollAreaItemCollection collection has method Item(string). +◦ FormLayoutItemCollection collection has method Items(). +◦ FormLayoutItemCollection collection has method Item(number). +◦ FormLayoutItemCollection collection has method Item(string). +◦ FormGroupBoxItemCollection collection has method Items(). +◦ FormGroupBoxItemCollection collection has method Item(number). +◦ FormGroupBoxItemCollection collection has method Item(string). +◦ FormItemCollection collection has method Items(). +◦ FormItemCollection collection has method Item(number). +◦ FormItemCollection collection has method Item(string). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Visible +p.757 +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormLabel +p.759 +A label item or a simple string of text. Labels are typically used to explain the contents of a form. Note +that most form items already have a built-in label associated with it. +Example +form = cf.Form.New("Dialog with label") +label = cf.FormLabel.New("Hello world!") +form:Add(label) +form:Run() +Inheritance +The FormLabel object is derived from the FormItem object. +Usage locations +The FormLabel object can be accessed from the following locations: +• Methods +◦ FormDirectoryBrowser object has method LabelItem(). +◦ FormFileSaveAsBrowser object has method LabelItem(). +◦ FormFileBrowser object has method LabelItem(). +◦ FormComboBox object has method LabelItem(). +◦ FormDoubleSpinBox object has method LabelItem(). +◦ FormIntegerSpinBox object has method LabelItem(). +◦ FormLineEdit object has method LabelItem(). +◦ FormLabelledItem object has method LabelItem(). +• Static functions +◦ FormLabel object has static function New(string). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +Altair Feko 2022.3 +2 Application Programming Interface (API) +FixedWidth +p.760 +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The text that should be displayed in the label. (Read/Write string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Constructor Function List +New (label string) +Create a new label item. (Returns a FormLabel object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FixedHeight +p.761 +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +MinimumWidth +p.762 +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The text that should be displayed in the label. +Type +string +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Static Function Details +New (label string) +Create a new label item. +Input Parameters +label(string) +The text that should be displayed. +Return +FormLabel +The newly created label item. +FormLabelledItem +Allows access to built-in label objects associated with the derived form item. +Example +form = cf.Form.New() + -- Create a form item that are derived from 'FormLabelItem' +formFileSaveAsBrowser = cf.FormFileSaveAsBrowser.New("File name") + -- Add item to the form +form:Add(formFileSaveAsBrowser) + -- Obtain the 'FormLabelledItem' +formLabelledItem = formFileSaveAsBrowser:LabelItem() + -- Set the label invisible +formLabelledItem.Visible = false +form:Run() +Inheritance +The FormLabelledItem object is derived from the FormItem object. +The following objects are derived (specialisations) from the FormLabelledItem object: +• FormComboBox +• FormDirectoryBrowser +• FormDoubleSpinBox +• FormFileBrowser +• FormFileSaveAsBrowser +• FormIntegerSpinBox +• FormLineEdit +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +Altair Feko 2022.3 +2 Application Programming Interface (API) +FixedWidth +p.764 +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Return +FormLabel +The form label item. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Input Parameters +callback(function) +The function call back. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormLayout +p.767 +A layout is a type of frame that contains other items. Layouts are often used to make logical groupings +of items and are therefore mainly design components. Functionally, layouts make it easier to hide or +disable several items simultaneously by simply modifying the properties of the layout. +Example +form = cf.Form.New() + -- Create a few form items +checkbox = cf.FormCheckBox.New("Include currents.") +lineEdit = cf.FormLineEdit.New("Frequency:") + -- Create a 'FormLayout' item +formLayout = cf.FormLayout.New(cf.Enums.FormLayoutEnum.Horizontal) + -- Add items to the layout +formLayout:Add(checkbox) +formLayout:Add(lineEdit) + -- Add the layout to the form +form:Add(formLayout) +form:Run() +Inheritance +The FormLayout object is derived from the FormItem object. +Usage locations +The FormLayout object can be accessed from the following locations: +• Static functions +◦ FormLayout object has static function New(FormLayoutEnum). +◦ FormLayout object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +Altair Feko 2022.3 +2 Application Programming Interface (API) +FixedWidth +p.768 +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +The object type string. (Read only string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Collection List +FormItems +The collection of item widgets contained in the layout. (FormLayoutItemCollection of FormItem.) +Method List +Add (item FormItem) +Adds the given item to the layout. Items can be any of the defined form item types. +Add (item FormItem, row number, column number) +Adds the given item to the layout at the specified position. Positions are defined as a row and +column, starting at (1,1). +Remove (item FormItem) +Removes the given item from the layout. The item can be any of the items that resides in the +collection of the form items contained in the layout. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Constructor Function List +New (layout FormLayoutEnum) +p.769 +Create a new layout item with a specified item arrangement. (Returns a FormLayout object.) +New () +Create a new layout item with a vertical item arrangement. (Returns a FormLayout object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Collection Details +FormItems +The collection of item widgets contained in the layout. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +FormLayoutItemCollection +Method Details +Add (item FormItem) +p.771 +Adds the given item to the layout. Items can be any of the defined form item types. +Input Parameters +item(FormItem) +The item widget to add to the layout. +Add (item FormItem, row number, column number) +Adds the given item to the layout at the specified position. Positions are defined as a row and +column, starting at (1,1). +Input Parameters +item(FormItem) +The form item to add to the layout. +row(number) +The layout row position. +column(number) +The layout column position. +Remove (item FormItem) +Removes the given item from the layout. The item can be any of the items that resides in the +collection of the form items contained in the layout. +Input Parameters +item(FormItem) +The form item to remove from the layout. +Static Function Details +New (layout FormLayoutEnum) +Create a new layout item with a specified item arrangement. +Input Parameters +layout(FormLayoutEnum) +A value indicating how new items will be arranged. +Return +FormLayout +The newly created layout item. +New () +Create a new layout item with a vertical item arrangement. +Return +FormLayout +The newly created layout item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormLineEdit +p.773 +A line edit item; also known as a text box or text field. A line edit is used to obtain text-based input +from a user. +Example +form = cf.Form.New("My Custom Dialog") + -- Create line edit and initialise default contents if desired +lineEdit = cf.FormLineEdit.New("Project name") +lineEdit.Value = "Default name" +form:Add(lineEdit) + -- Run the form and retrieve the user input +form:Run() +userTypedInput = lineEdit.Value +Inheritance +The FormLineEdit object is derived from the FormLabelledItem object. +Usage locations +The FormLineEdit object can be accessed from the following locations: +• Static functions +◦ FormLineEdit object has static function New(string). +◦ FormLineEdit object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The default text that will be contained in the line edit when the form is run. (Read/Write string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Constructor Function List +New (label string) +Create a new line edit item. (Returns a FormLineEdit object.) +New () +Create a new line edit item. (Returns a FormLineEdit object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +MinimumHeight +p.776 +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The default text that will be contained in the line edit when the form is run. +Type +string +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Return +FormLabel +The form label item. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Input Parameters +callback(function) +The function call back. +Static Function Details +New (label string) +Create a new line edit item. +Input Parameters +label(string) +A label describing the purpose and/or contents of a line edit. +Return +FormLineEdit +The newly created line edit item. +New () +Create a new line edit item. +Return +FormLineEdit +The newly created line edit item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormProgressDialog +p.778 +A progress dialog provides feedback for actions that take a long time to execute.When the progress +value reaches 100 the dialog automatically closes. +Example +form = cf.Form.New() + -- Create a 'FormProgressDialog' item +formProgressDialog = cf.FormProgressDialog.New("Loop example","Progress") + -- Log the progress while work is done +for i = 1, 100 do + for j = 1, 1000 do + -- Do some interesting calculations or work + end + -- formProgressDialog:LogProgress(i) +end +Usage locations +The FormProgressDialog object can be accessed from the following locations: +• Static functions +◦ FormProgressDialog object has static function New(string, string). +◦ FormProgressDialog object has static function New(). +Property List +Cancelled +This property is true if the cancel button was pressed, else it remains false.It is reset when the +Reset method is called. (Read only boolean) +Height +The height in pixels of the form window. (Read only number) +Label +Title +Type +Value +Width +The label of the progress dialog. (Read/Write string) +The title that will be displayed in the title bar at the top of the form. (Read/Write string) +The object type string. (Read only string) +The progress bar's current progress value from 0 to 100. (Read only number) +The width in pixels of the form window. (Read only number) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method List +LogProgress (progress number) +p.779 +This method shows the progress dialog form and updates the progress value. Pressing the Cancel +button will close the form. +LogProgress (progress number, label string) +This method shows the progress dialog form and updates the progress value and caption. +Pressing the Cancel button will close the form. +Reset () +Resets the progress dialog. This sets the progress value back to zero, resets the cancelled status +and hides the dialog.The label of the dialog remains unchanged. +SetSize (width number, height number) +Set the width and height of the form in pixels. The width and height must be larger than zero and +they cannot exceed the current screen resolution. If the size is set the dialog will no longer auto- +resize. +Constructor Function List +New (title string, label string) +Creates a new progress dialog form with a specified label. (Returns a FormProgressDialog object.) +New () +Creates a new progress dialog form. (Returns a FormProgressDialog object.) +Property Details +Cancelled +This property is true if the cancel button was pressed, else it remains false.It is reset when the +Reset method is called. +Type +boolean +Access +Read only +Height +The height in pixels of the form window. +Type +number +Access +Read only +Label +The label of the progress dialog. +Type +string +Access +Read/Write +Title +The title that will be displayed in the title bar at the top of the form. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +The progress bar's current progress value from 0 to 100. +Type +number +Access +Read only +Value +Width +The width in pixels of the form window. +Type +number +Access +Read only +Method Details +LogProgress (progress number) +This method shows the progress dialog form and updates the progress value. Pressing the Cancel +button will close the form. +Input Parameters +progress(number) +Updates the progress value of the progress bar on the dialog. Progress is only valid +from 0 to 100. If values outside this range are given an error will be thrown. +LogProgress (progress number, label string) +This method shows the progress dialog form and updates the progress value and caption. +Pressing the Cancel button will close the form. +Input Parameters +progress(number) +Updates the progress value of the progress bar on the dialog. Progress is only valid +from 0 to 100. If values outside this range are given an error will be thrown. +label(string) +Updates the label of the progress dialog. +Reset () +Resets the progress dialog. This sets the progress value back to zero, resets the cancelled status +and hides the dialog.The label of the dialog remains unchanged. +SetSize (width number, height number) +Set the width and height of the form in pixels. The width and height must be larger than zero and +they cannot exceed the current screen resolution. If the size is set the dialog will no longer auto- +resize. +Input Parameters +width(number) +Width of the form in pixels. +height(number) +Height of the form in pixels. +Static Function Details +New (title string, label string) +Creates a new progress dialog form with a specified label. +Input Parameters +title(string) +The form window title. +label(string) +The form label. +Return +FormProgressDialog +The newly created progress dialog form. +New () +Creates a new progress dialog form. +Return +FormProgressDialog +The newly created progress dialog form. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormPushButton +p.782 +A push button item. Push button are used to trigger a function/call back that is associated with the +button. +Example + -- Call back function for the button on the form. +function exampleCallBack() + print("Hello!") +end +form = cf.Form.New() + -- Create a 'FormPushButton' form item +formPushButton = cf.FormPushButton.New(exampleCallBack,"Hello") + -- Add button to the form +form:Add(formPushButton) + -- Show and run the form +form:Run() +Inheritance +The FormPushButton object is derived from the FormItem object. +Usage locations +The FormPushButton object can be accessed from the following locations: +• Properties +◦ FormButtons object has property OK. +◦ FormButtons object has property Cancel. +• Static functions +◦ FormPushButton object has static function New(function, string, string). +◦ FormPushButton object has static function New(function, string). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +IconPath +The icon of the push button. (Read/Write string) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +Label +The label of the push button. (Read/Write string) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +The object type string. (Read only string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the button is pressed. +SetCallBack (callback function) +Set the function that will be called when the button is pressed. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Constructor Function List +New (callBack function, label string, path string) +p.784 +Create a new push button item with an icon. (Returns a FormPushButton object.) +New (callBack function, label string) +Create a new push button item. (Returns a FormPushButton object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +IconPath +The icon of the push button. +Type +string +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +Label +The label of the push button. +Type +string +Access +Read/Write +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the button is pressed. +SetCallBack (callback function) +Set the function that will be called when the button is pressed. +Input Parameters +callback(function) +The function call back. +Static Function Details +New (callBack function, label string, path string) +Create a new push button item with an icon. +Input Parameters +callBack(function) +The function call back. +label(string) +The item label. +path(string) +The file path of the icon image. +Return +FormPushButton +The newly created push button item. +New (callBack function, label string) +Create a new push button item. +Input Parameters +callBack(function) +The function call back. +label(string) +The item label. +Return +FormPushButton +The newly created push button item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormRadioButtonGroup +p.788 +A radio button group item. Radio button groups are used when precisely one option out of a set of +options can be selected. +Example +form = cf.Form.New("Export settings") + -- Prepare input parameter and radio button group +options = {} +table.insert(options, "Only electric near fields") +table.insert(options, "Only magnetic near fields") +table.insert(options, "Both electric and magnetic near fields") +radioButtonGroup = cf.FormRadioButtonGroup.New("Results to export:", options) +form:Add(radioButtonGroup) + -- Run the form and retrieve the user input +form:Run() +selectedOptionIndexNumber = radioButtonGroup.Value +Inheritance +The FormRadioButtonGroup object is derived from the FormItem object. +Usage locations +The FormRadioButtonGroup object can be accessed from the following locations: +• Static functions +◦ FormRadioButtonGroup object has static function New(string, Map of number:Expression). +◦ FormRadioButtonGroup object has static function New(Map of number:Expression). +Property List +Count +The number of radio buttons. (Read only number) +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +Altair Feko 2022.3 +2 Application Programming Interface (API) +FixedWidth +p.789 +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Options +The options available in the radio group. (Read/Write Map of number:Expression) +Type +Value +The object type string. (Read only string) +The index of the selected radio button item in the index map table. (Read/Write number) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +SetCallBack (callback function) +Set the function that will be called when a radiobutton is pressed. +Constructor Function List +New (label string, map Map of number:Expression) +Create a new radio button group item. (Returns a FormRadioButtonGroup object.) +New (map Map of number:Expression) +Create a new radio button group item. (Returns a FormRadioButtonGroup object.) +Property Details +Count +The number of radio buttons. +Type +number +Access +Read only +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +p.791 +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Options +The options available in the radio group. +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The index of the selected radio button item in the index map table. +Type +number +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +SetCallBack (callback function) +Set the function that will be called when a radiobutton is pressed. +Input Parameters +callback(function) +The function call back. +Static Function Details +New (label string, map Map of number:Expression) +Create a new radio button group item. +Input Parameters +label(string) +The item label. +map(Map of number:Expression) +A list of values that will be available for selection in the button group. The index map +is a Lua table containing an array of indexed values. +Return +FormRadioButtonGroup +The newly created radio button group item. +New (map Map of number:Expression) +Create a new radio button group item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +map(Map of number:Expression) +p.793 +A list of values that will be available for selection in the button group. The index map +is a Lua table containing an array of indexed values. +Return +FormRadioButtonGroup +The newly created radio button group item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormScrollArea +p.794 +A scroll area is a type of frame that contains a scrolling view of other items. Scroll areas are often used +to make logical groupings of items where many items need to be displayed. +Example +form = cf.Form.New() + -- Create a 'FormScrollArea' form item +formScrollArea = cf.FormScrollArea.New() + -- Create a few form items +formScrollArea:Add(cf.FormLabel.New("A lot of text.")) +formScrollArea:Add(cf.FormLabel.New("even more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("lost more text")) + -- Add scroll area item to the form +form:Add(formScrollArea) + -- Show and run the form +form:Run() +Inheritance +The FormScrollArea object is derived from the FormItem object. +Usage locations +The FormScrollArea object can be accessed from the following locations: +• Static functions +◦ FormScrollArea object has static function New(FormLayoutEnum). +◦ FormScrollArea object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +The object type string. (Read only string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Collection List +FormItems +The collection of item widgets contained in the scroll area. (FormScrollAreaItemCollection of +FormItem.) +Method List +Add (item FormItem) +Adds the given item to the scroll area. Items can be any of the defined form item types. +Add (item FormItem, row number, column number) +Adds the given item to the scroll area at the specified position. Positions are defined as a row and +column, starting at (1,1). +Remove (item FormItem) +Removes the given item from the scroll area. The item can be any of the items that resides in the +collection of the form items contained in the scroll area. +Constructor Function List +New (layout FormLayoutEnum) +Create a new scroll area item with a specified layout. (Returns a FormScrollArea object.) +New () +Create a new scroll area item with a vertical layout. (Returns a FormScrollArea object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +Visible +p.798 +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Collection Details +FormItems +The collection of item widgets contained in the scroll area. +Type +FormScrollAreaItemCollection +Method Details +Add (item FormItem) +Adds the given item to the scroll area. Items can be any of the defined form item types. +Input Parameters +item(FormItem) +The item widget to add to the scroll area. +Add (item FormItem, row number, column number) +Adds the given item to the scroll area at the specified position. Positions are defined as a row and +column, starting at (1,1). +Input Parameters +item(FormItem) +The form item to add to the scroll area. +row(number) +The layout row position. +column(number) +The layout column position. +Remove (item FormItem) +Removes the given item from the scroll area. The item can be any of the items that resides in the +collection of the form items contained in the scroll area. +Input Parameters +item(FormItem) +The form item to remove from the scroll area. +Static Function Details +New (layout FormLayoutEnum) +Create a new scroll area item with a specified layout. +Input Parameters +layout(FormLayoutEnum) +A value indicating how new items will be arranged. +Return +FormScrollArea +The newly created scroll area item. +New () +Create a new scroll area item with a vertical layout. +Return +FormScrollArea +The newly created scroll area item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormSeparator +p.800 +A Separator item. Separators are used to visually group (or separate) items on a form. Both horizontal +and vertical separators are available. +Example +form = cf.Form.New() +checkbox1 = cf.FormCheckBox.New("Check box 1.") +checkbox2 = cf.FormCheckBox.New("Check box 2.") +checkbox3 = cf.FormCheckBox.New("Check box 3.") +checkbox4 = cf.FormCheckBox.New("Check box 4.") +checkbox5 = cf.FormCheckBox.New("Check box 5.") + -- Create separators initialised to horizontal +horizontalSeparator1 = cf.FormSeparator.New(cf.Enums.FormSeparatorEnum.Horizontal) +horizontalSeparator2 = cf.FormSeparator.New(cf.Enums.FormSeparatorEnum.Horizontal) + -- Add items to form layout +form:Add(checkbox1) +form:Add(horizontalSeparator1) +form:Add(checkbox2) +form:Add(checkbox3) +form:Add(horizontalSeparator2) +form:Add(checkbox4) +form:Add(checkbox5) +form:Run() +Inheritance +The FormSeparator object is derived from the FormItem object. +Usage locations +The FormSeparator object can be accessed from the following locations: +• Static functions +◦ FormSeparator object has static function New(FormSeparatorEnum). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +The object type string. (Read only string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Constructor Function List +New (orientation FormSeparatorEnum) +Create a new separator item. (Returns a FormSeparator object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FixedHeight +p.802 +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +MinimumWidth +p.803 +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Static Function Details +New (orientation FormSeparatorEnum) +Create a new separator item. +Input Parameters +orientation(FormSeparatorEnum) +The separator orientation which is either Horizontal or Vertical. +Return +FormSeparator +The newly created Separator item. +FormTree +A tree. +Example +form = cf.Form.New("Tree structure") + -- Prepare input parameter and tree items +treeWidget = cf.FormTree.New() +treeItem1 = cf.FormTreeItem.New("A", FEKO_HOME..[[/shared/Resources/Automation/ +axisar.png]]) +treeItem1:AddChild(cf.FormTreeItem.New("A1")) +treeWidget:AddChild(treeItem1) +treeItem2 = cf.FormTreeItem.New("B") +treeWidget:AddChild(treeItem2) + -- Expands the tree item +treeItem1.Expanded = true + -- Call back function for item selection in the tree. +function exampleCallBack() + local path = tostring(treeWidget.CurrentSelectedItem) + parentItem = treeWidget.CurrentSelectedItem.Parent + while ( parentItem ) do + path = tostring(parentItem) .. "." .. path + parentItem = parentItem.Parent + end + print(path) +end +treeWidget:SetCallBack(exampleCallBack) +form:Add(treeWidget) + -- Run the form and retrieve the user input +form:Run() +Inheritance +The FormTree object is derived from the FormItem object. +Usage locations +The FormTree object can be accessed from the following locations: +• Static functions +◦ FormTree object has static function New(). +◦ FormTree object has static function New(string). +Property List +CurrentSelectedItem +The current selected tree item. (Read/Write FormTreeItem) +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +The object type string. (Read only string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +AddChild (item FormTreeItem) +Adds the given FormTreeItem as a child. +ClearCallBack () +Clear the function that will be called when the tree selection changes. +SetCallBack (callback function) +Set the function that will be called when a tree item is selected. +Constructor Function List +New () +Create a new tree. (Returns a FormTree object.) +New (label string) +Create a new tree. (Returns a FormTree object.) +Property Details +CurrentSelectedItem +The current selected tree item. +Type +FormTreeItem +Access +Read/Write +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +AddChild (item FormTreeItem) +Adds the given FormTreeItem as a child. +Input Parameters +item(FormTreeItem) +The child item. +ClearCallBack () +Clear the function that will be called when the tree selection changes. +SetCallBack (callback function) +Set the function that will be called when a tree item is selected. +Input Parameters +callback(function) +The function call back. +Static Function Details +New () +Create a new tree. +Return +FormTree +The newly created tree. +New (label string) +Create a new tree. +Input Parameters +label(string) +The tree column header. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +FormTree +The newly created tree. +p.809 +FormTreeItem +A tree item. +Example +form = cf.Form.New("Tree structure") + -- Prepare input parameter and tree items +treeWidget = cf.FormTree.New("Tree") +treeItem1 = cf.FormTreeItem.New("A", FEKO_HOME..[[/shared/Resources/Automation/ +axisar.png]]) +treeItem1:AddChild(cf.FormTreeItem.New("A1")) +treeWidget:AddChild(treeItem1) +treeItem2 = cf.FormTreeItem.New("B") +treeWidget:AddChild(treeItem2) + -- Expands the tree item +treeItem1.Expanded = true + -- Call back function for item selection in the tree. +function exampleCallBack() + local path = tostring(treeWidget.CurrentSelectedItem) + parentItem = treeWidget.CurrentSelectedItem.Parent + while ( parentItem ) do + path = tostring(parentItem) .. "." .. path + parentItem = parentItem.Parent + end + print(path) +end +treeWidget:SetCallBack(exampleCallBack) +form:Add(treeWidget) + -- Run the form and retrieve the user input +form:Run() +Usage locations +The FormTreeItem object can be accessed from the following locations: +• Properties +◦ FormTreeItem object has property Parent. +◦ FormTree object has property CurrentSelectedItem. +• Static functions +◦ FormTreeItem object has static function New(string, string). +◦ FormTreeItem object has static function New(string). +Property List +Expanded +Controls the tree item's expanded state. Setting it expand/collapse only the item. (Read/Write +boolean) +Parent +The tree item parent. (Read only FormTreeItem) +Type +The object type string. (Read only string) +Method List +AddChild (item FormTreeItem) +Adds the given FormTreeItem as a child. +Constructor Function List +New (label string, path string) +Create a new tree item with an icon. (Returns a FormTreeItem object.) +New (label string) +Create a new tree item. (Returns a FormTreeItem object.) +Property Details +Expanded +Controls the tree item's expanded state. Setting it expand/collapse only the item. +Type +boolean +Access +Read/Write +Parent +The tree item parent. +Type +FormTreeItem +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +AddChild (item FormTreeItem) +Adds the given FormTreeItem as a child. +Input Parameters +item(FormTreeItem) +The child item. +Static Function Details +New (label string, path string) +Create a new tree item with an icon. +Input Parameters +label(string) +The tree item label. +path(string) +The file path of the icon image. +Return +FormTreeItem +The newly created tree item. +New (label string) +Create a new tree item. +Input Parameters +label(string) +The tree item label. +Return +FormTreeItem +The newly created tree item. +FreeSpace +The default free space medium. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a cuboid +cube1 = project.Contents.Geometry:AddCuboid(cf.Cuboid.GetDefaultProperties()) + -- Set the region medium to free space +cube1.Regions[1].Medium = project.Definitions.Media.FreeSpace +Inheritance +The FreeSpace object is derived from the Dielectric object. +Usage locations +The FreeSpace object can be accessed from the following locations: +• Properties +◦ Media object has property FreeSpace. +Property List +Colour +The medium colour. (Read/Write string) +DielectricModelling +The medium dielectric modelling properties. (Read/Write DielectricModelling) +Filename +The file describing the medium properties in XML format. (Read/Write FileReference) +Label +The object label. (Read/Write string) +MagneticModelling +The medium magnetic modelling properties. (Read/Write MagneticModelling) +MassDensity +Medium's mass density (kg/m^3). (Read/Write ParametricExpression) +SourceDefinitionMethod +Specifies the method used for defining the medium. (Read/Write +MediumSourceDefinitionMethodEnum) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +DielectricModelling +The medium dielectric modelling properties. +Type +DielectricModelling +Access +Read/Write +Filename +The file describing the medium properties in XML format. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MagneticModelling +The medium magnetic modelling properties. +Type +MagneticModelling +Access +Read/Write +MassDensity +Medium's mass density (kg/m^3). +Type +ParametricExpression +Access +Read/Write +SourceDefinitionMethod +Specifies the method used for defining the medium. +Type +MediumSourceDefinitionMethodEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +table +A table defining the properties. +SetProperties (properties Object) +p.816 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Frequency +A solution frequency range. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Set a frequency range between 100MHz to 500MHz with 9 discrete frequencies +frequencyRange = project.Contents.SolutionConfigurations.GlobalFrequency +properties = frequencyRange:GetProperties() +properties.RangeType = cf.Enums.FrequencyRangeTypeEnum.LinearSpacedDiscrete +properties.Start = "100e6" +properties.End = "500e6" +properties.NumberOfDiscreteValues = "9" +frequencyRange:SetProperties(properties) +Inheritance +The Frequency object is derived from the Object object. +Usage locations +The Frequency object can be accessed from the following locations: +• Properties +◦ SolutionConfigurationCollection collection has property GlobalFrequency. +◦ SolutionConfiguration object has property Frequency. +◦ CharacteristicModesConfiguration object has property Frequency. +◦ SParameterConfiguration object has property Frequency. +◦ StandardConfiguration object has property Frequency. +Property List +Advanced +Advanced frequency settings. (Read/Write FrequencyAdvancedSettings) +DiscreteFrequencies +The collection of discrete frequencies. Only valid when Type is DiscreteList. (Read/Write +ParametricExpressionList) +End +The last frequency value (Hz). (Read/Write ParametricExpression) +Export +Continuous frequency export settings. (Read/Write FrequencyExportSettings) +Label +The object label. (Read/Write string) +NumberOfDiscreteValues +The number of discrete frequency values. Only valid when Type is LogarithmicSpacedDiscrete or +LinearSpacedDiscrete. (Read/Write ParametricExpression) +RangeType +The frequency range type. (Read/Write FrequencyRangeTypeEnum) +Start +Type +The first frequency value (Hz). (Read/Write ParametricExpression) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Advanced +Advanced frequency settings. +Type +FrequencyAdvancedSettings +Access +Read/Write +DiscreteFrequencies +The collection of discrete frequencies. Only valid when Type is DiscreteList. +Type +ParametricExpressionList +Access +Read/Write +End +The last frequency value (Hz). +Type +ParametricExpression +Access +Read/Write +Export +Continuous frequency export settings. +Type +FrequencyExportSettings +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +NumberOfDiscreteValues +The number of discrete frequency values. Only valid when Type is LogarithmicSpacedDiscrete or +LinearSpacedDiscrete. +Type +ParametricExpression +Access +Read/Write +RangeType +The frequency range type. +Type +FrequencyRangeTypeEnum +Access +Read/Write +Start +The first frequency value (Hz). +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +FrequencyAdvancedSettings +Advanced frequency properties. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Initialise the frequency to a continuous band +frequency = project.Contents.SolutionConfigurations.GlobalFrequency +properties = frequency:GetProperties() +properties.Start = "100e6" +properties.End = "200e6" +properties.RangeType = cf.Enums.FrequencyRangeTypeEnum.Continuous +frequency:SetProperties(properties) + -- Exclude near fields from adaptive frequency sampling +frequency.Advanced.Continuous.Quantities.NearFieldIncluded = false +Inheritance +The FrequencyAdvancedSettings object is derived from the CompositeValue object. +Usage locations +The FrequencyAdvancedSettings object can be accessed from the following locations: +• Properties +◦ Frequency object has property Advanced. +• Methods +◦ FrequencyAdvancedSettingsList object has method Append(). +◦ FrequencyAdvancedSettingsList object has method Get(number). +Property List +Continuous +Advanced settings applicable to continuous frequencies. (Read/Write +FrequencyContinuousSettings) +FDTD +Advanced settings applicable when the FDTD solver is activated. (Read/Write +FrequencyFDTDSettings) +Property Details +Continuous +Advanced settings applicable to continuous frequencies. +Type +FrequencyContinuousSettings +Access +Read/Write +FDTD +Advanced settings applicable when the FDTD solver is activated. +Type +FrequencyFDTDSettings +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FrequencyAdvancedSettingsList +A list of FrequencyAdvancedSettings items. +Method List +Append () +p.823 +Appends a new item to the list. (Returns a FrequencyAdvancedSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a FrequencyAdvancedSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FrequencyAdvancedSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FrequencyAdvancedSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.824 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FrequencyContinuousQuantities +p.825 +Quantities to include for adaptive frequency sampling.Quantities not included will be calculated at +discrete solution frequency points. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Initialise the frequency to a continuous band +frequency = project.Contents.SolutionConfigurations.GlobalFrequency +properties = frequency:GetProperties() +properties.Start = 100e6 +properties.End = 200e6 +properties.RangeType = cf.Enums.FrequencyRangeTypeEnum.Continuous +frequency:SetProperties(properties) + -- Exclude near fields from adaptive frequency sampling +frequency.Advanced.Continuous.Quantities.NearFieldIncluded = false +Inheritance +The FrequencyContinuousQuantities object is derived from the CompositeValue object. +Usage locations +The FrequencyContinuousQuantities object can be accessed from the following locations: +• Properties +◦ FrequencyContinuousSettings object has property Quantities. +• Methods +◦ FrequencyContinuousQuantitiesList object has method Append(). +◦ FrequencyContinuousQuantitiesList object has method Get(number). +Property List +CurrentsIncluded +Include currents and charges. (Read/Write boolean) +FarFieldIncluded +Include far fields. (Read/Write boolean) +ImpedanceIncluded +Include impedances. (Read/Write boolean) +NearFieldIncluded +Include near fields. (Read/Write boolean) +NetworksIncluded +Include non-radiating networks and loads. (Read/Write boolean) +PowerIncluded +Include power. (Read/Write boolean) +ProbesIncluded +Include voltage and current probes. (Read/Write boolean) +SParameterIncluded +Include S-parameters. (Read/Write boolean) +TransmissionReflectionIncluded +Include transmission / reflection coefficients. (Read/Write boolean) +Property Details +CurrentsIncluded +Include currents and charges. +Type +boolean +Access +Read/Write +FarFieldIncluded +Include far fields. +Type +boolean +Access +Read/Write +ImpedanceIncluded +Include impedances. +Type +boolean +Access +Read/Write +NearFieldIncluded +Include near fields. +Type +boolean +Access +Read/Write +NetworksIncluded +Include non-radiating networks and loads. +Type +boolean +Access +Read/Write +PowerIncluded +Include power. +Type +boolean +Access +Read/Write +ProbesIncluded +Include voltage and current probes. +Type +boolean +Access +Read/Write +SParameterIncluded +Include S-parameters. +Type +boolean +Access +Read/Write +TransmissionReflectionIncluded +Include transmission / reflection coefficients. +Type +boolean +Access +Read/Write +FrequencyContinuousQuantitiesList +A list of FrequencyContinuousQuantities items. +Method List +Append () +Appends a new item to the list. (Returns a FrequencyContinuousQuantities object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +FrequencyContinuousQuantities object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FrequencyContinuousQuantities +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FrequencyContinuousQuantities +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.829 +FrequencyContinuousSettings +Advanced continuous frequency properties. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Initialise the frequency to a continuous band +frequency = project.Contents.SolutionConfigurations.GlobalFrequency +properties = frequency:GetProperties() +properties.Start = 100e6 +properties.End = 200e6 +properties.RangeType = cf.Enums.FrequencyRangeTypeEnum.Continuous +frequency:SetProperties(properties) + -- Set the maximum number of samples + -- As the properties need to be modified in one step, + -- a properties table is used +properties = frequency:GetProperties() +properties.Advanced.Continuous.MaxSamplesEnabled = true +properties.Advanced.Continuous.MaxSamples = 10 +frequency:SetProperties(properties) +Inheritance +The FrequencyContinuousSettings object is derived from the CompositeValue object. +Usage locations +The FrequencyContinuousSettings object can be accessed from the following locations: +• Properties +◦ FrequencyAdvancedSettings object has property Continuous. +• Methods +◦ FrequencyContinuousSettingsList object has method Append(). +◦ FrequencyContinuousSettingsList object has method Get(number). +Property List +ConvergenceAccuracy +Control the speed and accuracy of convergence. (Read/Write +FrequencyConvergenceAccuracyTypeEnum) +MaxSamples +A limit to the maximum number of solutions. Only valid if MaxSamplesEnabled is true. (Read/ +Write ParametricExpression) +MaxSamplesEnabled +Apply a limit to the maximum number of solutions when using continuous frequency. (Read/Write +boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +MinIncrement +p.831 +A limit to how far the Feko Solver refines the frequency (Hz). Only valid if MinIncrementEnabled is +true. (Read/Write ParametricExpression) +MinIncrementEnabled +Apply a limit to how far the Feko Solver refines the frequency when using continuous frequency. +(Read/Write boolean) +Quantities +Quantities to include for adaptive frequency sampling. (Read/Write +FrequencyContinuousQuantities) +Property Details +ConvergenceAccuracy +Control the speed and accuracy of convergence. +Type +FrequencyConvergenceAccuracyTypeEnum +Access +Read/Write +MaxSamples +A limit to the maximum number of solutions. Only valid if MaxSamplesEnabled is true. +Type +ParametricExpression +Access +Read/Write +MaxSamplesEnabled +Apply a limit to the maximum number of solutions when using continuous frequency. +Type +boolean +Access +Read/Write +MinIncrement +A limit to how far the Feko Solver refines the frequency (Hz). Only valid if MinIncrementEnabled is +true. +Type +ParametricExpression +Access +Read/Write +MinIncrementEnabled +Apply a limit to how far the Feko Solver refines the frequency when using continuous frequency. +Type +boolean +Access +Read/Write +Quantities +Quantities to include for adaptive frequency sampling. +Type +FrequencyContinuousQuantities +Access +Read/Write +FrequencyContinuousSettingsList +A list of FrequencyContinuousSettings items. +Method List +Append () +Appends a new item to the list. (Returns a FrequencyContinuousSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +FrequencyContinuousSettings object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FrequencyContinuousSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FrequencyContinuousSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.834 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FrequencyExportSettings +p.835 +Properties that control how continuous frequency is sampled for exporting. These properties are only +valid when Frequency Type is Continuous. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Initialise the frequency to a continuous band +frequency = project.Contents.SolutionConfigurations.GlobalFrequency +properties = frequency:GetProperties() +properties.Start = 100e6 +properties.End = 200e6 +properties.RangeType = cf.Enums.FrequencyRangeTypeEnum.Continuous +frequency:SetProperties(properties) + -- Set the number of samples for export + -- As the properties need to be modified in one step, + -- a properties table is used +properties = frequency:GetProperties() +properties.Export.NumberOfSamplesEnabled = true +properties.Export.NumberOfSamples = 10 +frequency:SetProperties(properties) +Inheritance +The FrequencyExportSettings object is derived from the CompositeValue object. +Usage locations +The FrequencyExportSettings object can be accessed from the following locations: +• Properties +◦ Frequency object has property Export. +• Methods +◦ FrequencyExportSettingsList object has method Append(). +◦ FrequencyExportSettingsList object has method Get(number). +Property List +NumberOfSamples +Number of frequency samples for exported continuous data. Only valid when +NumberOfSamplesEnabled is true. (Read/Write ParametricExpression) +NumberOfSamplesEnabled +Specify the number of samples to use when exporting data with continuous frequency. (Read/ +Write boolean) +Stepping +Control how exported continuous frequency samples are spaced. (Read/Write +FrequencyExportSamplingTypeEnum) +Property Details +NumberOfSamples +Number of frequency samples for exported continuous data. Only valid when +NumberOfSamplesEnabled is true. +Type +ParametricExpression +Access +Read/Write +NumberOfSamplesEnabled +Specify the number of samples to use when exporting data with continuous frequency. +Type +boolean +Access +Read/Write +Stepping +Control how exported continuous frequency samples are spaced. +Type +FrequencyExportSamplingTypeEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FrequencyExportSettingsList +A list of FrequencyExportSettings items. +Method List +Append () +p.837 +Appends a new item to the list. (Returns a FrequencyExportSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a FrequencyExportSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FrequencyExportSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FrequencyExportSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.838 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FrequencyFDTDSettings +Advanced FDTD time interval properties. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Enable the FDTD solver +p.839 +project.Contents.SolutionSettings.SolverSettings.FDTDSettings.FDTDEnabled = true + -- Set the initial frequency +frequency = project.Contents.SolutionConfigurations.GlobalFrequency +frequency.Start = 100e6 + -- Modify the FDTD time interval settings + -- A properties table is used as both the modifications + -- must be done together +properties = frequency:GetProperties() +properties.Advanced.FDTD.TimeIntervalType + = cf.Enums.FrequencyFDTDTimeIntervalTypeEnum.Seconds +properties.Advanced.FDTD.MaximumTimeIntervalEnabled = true +properties.Advanced.FDTD.MaximumTimeInterval = 1e-5 +frequency:SetProperties(properties) +Inheritance +The FrequencyFDTDSettings object is derived from the CompositeValue object. +Usage locations +The FrequencyFDTDSettings object can be accessed from the following locations: +• Properties +◦ FrequencyAdvancedSettings object has property FDTD. +• Methods +◦ FrequencyFDTDSettingsList object has method Append(). +◦ FrequencyFDTDSettingsList object has method Get(number). +Property List +ConvergenceThreshold +Specify a value between (0,1). The simulation will be terminated if the threshold has been +reached and the simulation time is larger or equal to the MinimumTimeInterval. Only valid if +ConvergenceThresholdEnabled. (Read/Write ParametricExpression) +ConvergenceThresholdEnabled +Apply a convergence threshold. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +MaximumTimeInterval +p.840 +Set the maximum time interval duration for which the model is simulated. Only valid if +MaximumTimeIntervalEnabled and TimeIntervalType is Periods or Seconds, which implies a unit of +either (dimensionless) or (s). (Read/Write ParametricExpression) +MaximumTimeIntervalEnabled +Apply a maximum limit to the time interval duration.Only valid if TimeIntervalType is Periods or +Seconds. (Read/Write boolean) +MinimumTimeInterval +Set the minimum time interval duration for which the model is simulated. Only valid if +MinimumTimeIntervalEnabled and TimeIntervalType is Periods or Seconds, which implies a unit of +either (dimensionless) or (s). (Read/Write ParametricExpression) +MinimumTimeIntervalEnabled +Apply a minimum limit to the time interval duration.Only valid if TimeIntervalType is Periods or +Seconds. (Read/Write boolean) +TimeIntervalType +Control the determination of the time duration for which the model is simulated. (Read/Write +FrequencyFDTDTimeIntervalTypeEnum) +Property Details +ConvergenceThreshold +Specify a value between (0,1). The simulation will be terminated if the threshold has been +reached and the simulation time is larger or equal to the MinimumTimeInterval. Only valid if +ConvergenceThresholdEnabled. +Type +ParametricExpression +Access +Read/Write +ConvergenceThresholdEnabled +Apply a convergence threshold. +Type +boolean +Access +Read/Write +MaximumTimeInterval +Set the maximum time interval duration for which the model is simulated. Only valid if +MaximumTimeIntervalEnabled and TimeIntervalType is Periods or Seconds, which implies a unit of +either (dimensionless) or (s). +Type +ParametricExpression +Access +Read/Write +MaximumTimeIntervalEnabled +Apply a maximum limit to the time interval duration.Only valid if TimeIntervalType is Periods or +Seconds. +Type +boolean +Access +Read/Write +MinimumTimeInterval +Set the minimum time interval duration for which the model is simulated. Only valid if +MinimumTimeIntervalEnabled and TimeIntervalType is Periods or Seconds, which implies a unit of +either (dimensionless) or (s). +Type +ParametricExpression +Access +Read/Write +MinimumTimeIntervalEnabled +Apply a minimum limit to the time interval duration.Only valid if TimeIntervalType is Periods or +Seconds. +Type +boolean +Access +Read/Write +TimeIntervalType +Control the determination of the time duration for which the model is simulated. +Type +FrequencyFDTDTimeIntervalTypeEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FrequencyFDTDSettingsList +A list of FrequencyFDTDSettings items. +Method List +Append () +p.842 +Appends a new item to the list. (Returns a FrequencyFDTDSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a FrequencyFDTDSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FrequencyFDTDSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FrequencyFDTDSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.843 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FundamentalModeOptions +The waveguide source fundamental mode options. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a waveguide port +p.844 +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(-1,1,0), 1, 1, 1) +cuboid.Regions[1].Medium = project.Definitions.Media.FreeSpace +waveguidePort = project.Contents.Ports:AddWaveguidePort(cuboid.Faces[1]) + -- Add a waveguide source to the waveguide port +source = + project.Contents.SolutionConfigurations.GlobalSources:AddWaveguideSource(waveguidePort) + -- Modify the magnitude of the fundamental mode +source.FundamentalModeOptions.Magnitude = 2.0 +Inheritance +The FundamentalModeOptions object is derived from the CompositeValue object. +Usage locations +The FundamentalModeOptions object can be accessed from the following locations: +• Properties +◦ WaveguideSource object has property FundamentalModeOptions. +• Methods +◦ FundamentalModeOptionsList object has method Append(). +◦ FundamentalModeOptionsList object has method Get(number). +Property List +Magnitude +The fundamental mode magnitude (V). (Read/Write ParametricExpression) +Phase +The fundamental mode phase (degrees). (Read/Write ParametricExpression) +Rotation +The fundamental mode rotation (degrees). (Read/Write ParametricExpression) +Property Details +Magnitude +The fundamental mode magnitude (V). +Type +ParametricExpression +Access +Read/Write +Phase +The fundamental mode phase (degrees). +Type +ParametricExpression +Access +Read/Write +Rotation +The fundamental mode rotation (degrees). +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FundamentalModeOptionsList +A list of FundamentalModeOptions items. +Method List +Append () +p.846 +Appends a new item to the list. (Returns a FundamentalModeOptions object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a FundamentalModeOptions +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +FundamentalModeOptions +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +FundamentalModeOptions +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.847 +GeneralNetwork +A general non-radiating network. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a 'GeneralNetwork' with two terminals +properties = cf.GeneralNetwork.GetDefaultProperties() +properties.Source = cf.Enums.GeneralNetworkSourceEnum.Manual +properties.ReferenceImpedance[1] = "50" +properties.ReferenceImpedance[2] = "50" +networks = project.Contents.SolutionConfigurations.GlobalNetworks +networks:AddGeneralNetwork(properties) + -- Configure the 'GeneralNetwork' to use a SPICENetwork +properties = networks["GeneralNetwork1"]:GetProperties() +properties.DataType = cf.Enums.GeneralNetworkDataTypeEnum.SPICENetwork +properties.Filename = "SPICE_file.cir" +networks["GeneralNetwork1"]:SetProperties(properties) +Inheritance +The GeneralNetwork object is derived from the Network object. +Usage locations +The GeneralNetwork object can be accessed from the following locations: +• Methods +◦ NetworkCollection collection has method AddGeneralNetwork(table). +◦ NetworkCollection collection has method AddGeneralNetwork(GeneralNetworkDataTypeEnum, +number, string). +Property List +CircuitName +The SPICE Circuit name. Setting disables the automatic generation of the name. (Read/Write +string) +CouplingParameters +The general network's coupling parameters when specified manually. (Read/Write +ParametricComplexExpressionTable) +DataType +The type of data for the general network. (Read/Write GeneralNetworkDataTypeEnum) +Filename +The Touchstone or SPICE filename that describes the network. (Read/Write FileReference) +Label +The object label. (Read/Write string) +SPICEPortReference +Specifies the port reference of the SPICE file. (Read/Write +GeneralNetworkSPICEPortReferenceEnum) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Source +Specifies the source of the data for the general network. (Read/Write +GeneralNetworkSourceEnum) +TerminalCount +The number of terminals. (Read/Write number) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CircuitName +The SPICE Circuit name. Setting disables the automatic generation of the name. +p.850 +Type +string +Access +Read/Write +CouplingParameters +The general network's coupling parameters when specified manually. +Type +ParametricComplexExpressionTable +Access +Read/Write +DataType +The type of data for the general network. +Type +GeneralNetworkDataTypeEnum +Access +Read/Write +Filename +The Touchstone or SPICE filename that describes the network. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +SPICEPortReference +Specifies the port reference of the SPICE file. +Type +GeneralNetworkSPICEPortReferenceEnum +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Source +Specifies the source of the data for the general network. +Type +GeneralNetworkSourceEnum +Access +Read/Write +TerminalCount +The number of terminals. +Type +number +Access +Read/Write +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GeneralSolverSettings +General solution solver settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Change the solver to use double precision +p.854 +project.Contents.SolutionSettings.SolverSettings.GeneralSettings.DataStoragePrecision + = + cf.Enums.PrecisionSettingsEnum.Double +Inheritance +The GeneralSolverSettings object is derived from the CompositeValue object. +Usage locations +The GeneralSolverSettings object can be accessed from the following locations: +• Properties +◦ SolverSettings object has property GeneralSettings. +• Methods +◦ GeneralSolverSettingsList object has method Append(). +◦ GeneralSolverSettingsList object has method Get(number). +Property List +BasisFunctionSettings +Basis function solver settings. (Read/Write BasisFunctionGlobalSolverSettings) +CharacteristicBasisFunctionMethodEnabled +Activates characteristic basis function methods. (Read/Write boolean) +CharacteristicBasisFunctionMethodType +The base method type for characteristic basis function methods. (Read/Write +CharacteristicBasisFunctionMethodTypeEnum) +DataStoragePrecision +The precision to be used specified by the PrecisionSettingsEnum, e.g. Single or Double. (Read/ +Write PrecisionSettingsEnum) +ExportGeometryToOutFile +Specifies whether the geometry data should be written to the Feko *.out file. (Read/Write +boolean) +GeometryCheckingEnabled +Activates geometry element checking for typical user errors. (Read/Write boolean) +LowFrequencyStabilisationEnabled +Activates low frequency stabilisation for MoM. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +LowFrequencyStabilisationMode +p.855 +The low frequency stabilisation mode. (Read/Write LowFrequencyStabilisationModeEnum) +MeshElementSizeCheckingEnabled +Activates the verification of the mesh size in relation to the frequency. (Read/Write boolean) +OutputFileSettings +Output file solver settings. (Read/Write OutputFileSolverSettings) +PreFileWritingEnabled +Update *.pre file when saving. (Read/Write boolean) +Property Details +BasisFunctionSettings +Basis function solver settings. +Type +BasisFunctionGlobalSolverSettings +Access +Read/Write +CharacteristicBasisFunctionMethodEnabled +Activates characteristic basis function methods. +Type +boolean +Access +Read/Write +CharacteristicBasisFunctionMethodType +The base method type for characteristic basis function methods. +Type +CharacteristicBasisFunctionMethodTypeEnum +Access +Read/Write +DataStoragePrecision +The precision to be used specified by the PrecisionSettingsEnum, e.g. Single or Double. +Type +PrecisionSettingsEnum +Access +Read/Write +ExportGeometryToOutFile +Specifies whether the geometry data should be written to the Feko *.out file. +Type +boolean +Access +Read/Write +GeometryCheckingEnabled +Activates geometry element checking for typical user errors. +Type +boolean +Access +Read/Write +LowFrequencyStabilisationEnabled +Activates low frequency stabilisation for MoM. +Type +boolean +Access +Read/Write +LowFrequencyStabilisationMode +The low frequency stabilisation mode. +Type +LowFrequencyStabilisationModeEnum +Access +Read/Write +MeshElementSizeCheckingEnabled +Activates the verification of the mesh size in relation to the frequency. +Type +boolean +Access +Read/Write +OutputFileSettings +Output file solver settings. +Type +OutputFileSolverSettings +Access +Read/Write +PreFileWritingEnabled +Update *.pre file when saving. +Type +boolean +Access +Read/Write +GeneralSolverSettingsList +A list of GeneralSolverSettings items. +Method List +Append () +Appends a new item to the list. (Returns a GeneralSolverSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a GeneralSolverSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +GeneralSolverSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +GeneralSolverSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.859 +Altair Feko 2022.3 +2 Application Programming Interface (API) +Geometry +p.860 +A geometry object. All derived geometry objects share a set of common properties and methods that +are listed here. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create various geometry objects +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(1,0,0),1,1,1) +line = project.Contents.Geometry:AddLine(cf.Point(0,0,0),cf.Point(1,1,1)) +sphere = project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1) +union = project.Contents.Geometry:Union({sphere, cuboid}) + -- Modify various properties of the union +union:ReverseFaceNormals() +union.Label = "LockedGeometry" +union.Locked = true + -- Duplicate the sphere and convert it to primitive geometry +geometry = sphere:Duplicate():ConvertToPrimitive() +Inheritance +The Geometry object is derived from the Object object. +The following objects are derived (specialisations) from the Geometry object: +• AbstractSurfaceCurve +• AnalyticalCurve +• BezierCurve +• Cone +• ConstrainedSurface +• Cross +• Cuboid +• Cylinder +• Ellipse +• EllipticArc +• FittedSpline +• Flare +• Helix +• Hexagon +• HyperbolicArc +• ImprintPoints +• Intersect +• Line +• Loft +• NurbsSurface +• ParabolicArc +• Paraboloid +• PathSweep +• Polygon +• Polyline +• Primitive +• ProjectGeometry +• Rectangle +• RepairAndSewFaces +• RepairPart +• Ring +• Simplify +• Sphere +• Spin +• SpiralCross +• Split +• Stitch +• Subtract +• Sweep +• TCross +• Trifilar +• Union +Usage locations +The Geometry object can be accessed from the following locations: +• Properties +◦ GeometryCollection collection has property FaultyParts. +◦ Geometry object has property Parent. +◦ SpiralCross object has property Parent. +◦ Ring object has property Parent. +◦ OpenRing object has property Parent. +◦ SplitRing object has property Parent. +◦ Cross object has property Parent. +◦ StripCross object has property Parent. +◦ Trifilar object has property Parent. +◦ AnalyticalCurve object has property Parent. +◦ BezierCurve object has property Parent. +◦ Cone object has property Parent. +◦ ConstrainedSurface object has property Parent. +◦ Cuboid object has property Parent. +◦ Cylinder object has property Parent. +◦ Ellipse object has property Parent. +◦ EllipticArc object has property Parent. +◦ FittedSpline object has property Parent. +◦ Flare object has property Parent. +◦ Helix object has property Parent. +◦ Hexagon object has property Parent. +◦ StripHexagon object has property Parent. +◦ HyperbolicArc object has property Parent. +◦ +◦ +ImprintPoints object has property Parent. +Intersect object has property Parent. +◦ Loft object has property Parent. +◦ PathSweep object has property Parent. +◦ ProjectGeometry object has property Parent. +◦ RepairAndSewFaces object has property Parent. +◦ RepairPart object has property Parent. +◦ Spin object has property Parent. +◦ Split object has property Parent. +◦ Stitch object has property Parent. +◦ Subtract object has property Parent. +◦ Sweep object has property Parent. +◦ Union object has property Parent. +◦ Simplify object has property Parent. +◦ Line object has property Parent. +◦ NurbsSurface object has property Parent. +◦ ParabolicArc object has property Parent. +◦ Paraboloid object has property Parent. +◦ Polygon object has property Parent. +◦ Polyline object has property Parent. +◦ Primitive object has property Parent. +◦ Rectangle object has property Parent. +◦ Sphere object has property Parent. +◦ AbstractSurfaceCurve object has property Parent. +◦ SurfaceBezierCurve object has property Parent. +◦ SurfaceLine object has property Parent. +◦ SurfaceRegularLines object has property Parent. +◦ TCross object has property Parent. +◦ TopologyEntity object has property Geometry. +◦ Edge object has property Geometry. +◦ Face object has property Geometry. +◦ Region object has property Geometry. +• Methods +◦ OperatorCollection collection has method Item(number). +◦ OperatorCollection collection has method Item(string). +◦ GeometryCollection collection has method Item(number). +◦ GeometryCollection collection has method Item(string). +◦ GeometryGroup collection has method Item(number). +◦ GeometryGroup collection has method Item(string). +◦ Geometry object has method Explode(). +◦ Geometry object has method ConvertToPrimitive(). +◦ SpiralCross object has method Explode(). +◦ SpiralCross object has method ConvertToPrimitive(). +◦ Ring object has method Explode(). +◦ Ring object has method ConvertToPrimitive(). +◦ OpenRing object has method Explode(). +◦ OpenRing object has method ConvertToPrimitive(). +◦ SplitRing object has method Explode(). +◦ SplitRing object has method ConvertToPrimitive(). +◦ Cross object has method Explode(). +◦ Cross object has method ConvertToPrimitive(). +◦ StripCross object has method Explode(). +◦ StripCross object has method ConvertToPrimitive(). +◦ Trifilar object has method Explode(). +◦ Trifilar object has method ConvertToPrimitive(). +◦ AnalyticalCurve object has method Explode(). +◦ AnalyticalCurve object has method ConvertToPrimitive(). +◦ BezierCurve object has method Explode(). +◦ BezierCurve object has method ConvertToPrimitive(). +◦ Cone object has method Explode(). +◦ Cone object has method ConvertToPrimitive(). +◦ ConstrainedSurface object has method Explode(). +◦ ConstrainedSurface object has method ConvertToPrimitive(). +◦ Cuboid object has method Explode(). +◦ Cuboid object has method ConvertToPrimitive(). +◦ Cylinder object has method Explode(). +◦ Cylinder object has method ConvertToPrimitive(). +◦ Ellipse object has method Explode(). +◦ Ellipse object has method ConvertToPrimitive(). +◦ EllipticArc object has method Explode(). +◦ EllipticArc object has method ConvertToPrimitive(). +◦ FittedSpline object has method Explode(). +◦ FittedSpline object has method ConvertToPrimitive(). +◦ Flare object has method Explode(). +◦ Flare object has method ConvertToPrimitive(). +◦ Helix object has method Explode(). +◦ Helix object has method ConvertToPrimitive(). +◦ Hexagon object has method Explode(). +◦ Hexagon object has method ConvertToPrimitive(). +◦ StripHexagon object has method Explode(). +◦ StripHexagon object has method ConvertToPrimitive(). +◦ HyperbolicArc object has method Explode(). +◦ HyperbolicArc object has method ConvertToPrimitive(). +◦ +◦ +◦ +◦ +ImprintPoints object has method Explode(). +ImprintPoints object has method ConvertToPrimitive(). +Intersect object has method Explode(). +Intersect object has method ConvertToPrimitive(). +◦ Loft object has method Explode(). +◦ Loft object has method ConvertToPrimitive(). +◦ PathSweep object has method Explode(). +◦ PathSweep object has method ConvertToPrimitive(). +◦ ProjectGeometry object has method Explode(). +◦ ProjectGeometry object has method ConvertToPrimitive(). +◦ RepairAndSewFaces object has method Explode(). +◦ RepairAndSewFaces object has method ConvertToPrimitive(). +◦ RepairPart object has method Explode(). +◦ RepairPart object has method ConvertToPrimitive(). +◦ Spin object has method Explode(). +◦ Spin object has method ConvertToPrimitive(). +◦ Split object has method Explode(). +◦ Split object has method ConvertToPrimitive(). +◦ Stitch object has method Explode(). +◦ Stitch object has method ConvertToPrimitive(). +◦ Subtract object has method Explode(). +◦ Subtract object has method ConvertToPrimitive(). +◦ Sweep object has method Explode(). +◦ Sweep object has method ConvertToPrimitive(). +◦ Union object has method Explode(). +◦ Union object has method ConvertToPrimitive(). +◦ Simplify object has method Explode(). +◦ Simplify object has method ConvertToPrimitive(). +◦ Line object has method Explode(). +◦ Line object has method ConvertToPrimitive(). +◦ NurbsSurface object has method Explode(). +◦ NurbsSurface object has method ConvertToPrimitive(). +◦ ParabolicArc object has method Explode(). +◦ ParabolicArc object has method ConvertToPrimitive(). +◦ Paraboloid object has method Explode(). +◦ Paraboloid object has method ConvertToPrimitive(). +◦ Polygon object has method Explode(). +◦ Polygon object has method ConvertToPrimitive(). +◦ Polyline object has method Explode(). +◦ Polyline object has method ConvertToPrimitive(). +◦ Primitive object has method Explode(). +◦ Primitive object has method ConvertToPrimitive(). +◦ Rectangle object has method Explode(). +◦ Rectangle object has method ConvertToPrimitive(). +◦ Sphere object has method Explode(). +◦ Sphere object has method ConvertToPrimitive(). +◦ AbstractSurfaceCurve object has method Explode(). +◦ AbstractSurfaceCurve object has method ConvertToPrimitive(). +◦ SurfaceBezierCurve object has method Explode(). +◦ SurfaceBezierCurve object has method ConvertToPrimitive(). +◦ SurfaceLine object has method Explode(). +◦ SurfaceLine object has method ConvertToPrimitive(). +◦ SurfaceRegularLines object has method Explode(). +◦ SurfaceRegularLines object has method ConvertToPrimitive(). +◦ TCross object has method Explode(). +◦ TCross object has method ConvertToPrimitive(). +◦ Find object has method GetClashingGeometry(). +◦ Find object has method GetClashingGeometry(List of Geometry). +◦ Shape object has method BuildGeometry(). +◦ CrossShape object has method BuildGeometry(). +◦ StripCrossShape object has method BuildGeometry(). +◦ EllipseShape object has method BuildGeometry(). +◦ HexagonShape object has method BuildGeometry(). +◦ StripHexagonShape object has method BuildGeometry(). +◦ PlaneShape object has method BuildGeometry(). +◦ RingShape object has method BuildGeometry(). +◦ OpenRingShape object has method BuildGeometry(). +◦ SplitRingShape object has method BuildGeometry(). +◦ SpiralCrossShape object has method BuildGeometry(). +◦ TCrossShape object has method BuildGeometry(). +◦ TrifilarShape object has method BuildGeometry(). +◦ UnitCell object has method BuildGeometry(boolean). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +p.868 +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Explode () +p.872 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +GeometryExporter +The geometry exporter. Geometry can be exported to a variety of formats. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add geometry to export and then export it to an ACIS file +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +project.Exporter.Geometry.ExportFileFormat + = cf.Enums.ExportGeometryFileFormatEnum.ACIS +project.Exporter.Geometry:Export([[temp_Export.sat]]) +Inheritance +The GeometryExporter object is derived from the Object object. +Usage locations +The GeometryExporter object can be accessed from the following locations: +• Properties +◦ Exporter object has property Geometry. +Property List +ACISVersion +Controls which file version to export to when exporting ACIS files. Only valid if ExportFileFormat is +ACIS. (Read/Write ExportACISVersionEnum) +CATIAV5Version +Controls which file version to export to when exporting CATIAV5 files. Only valid if +ExportFileFormat is CATIAV5. (Read/Write ExportCATIAV5VersionEnum) +ExportFileFormat +The export file format. (Read/Write ExportGeometryFileFormatEnum) +Label +The object label. (Read/Write string) +ParasolidFileFormat +The Parasolid topology type. Only valid if ExportFileFormat is Parasolid. (Read/Write +ParasolidExportFileFormatEnum) +ParasolidTopologyType +The Parasolid topology type. Only valid if ExportFileFormat is Parasolid. (Read/Write +ParasolidTopologyTypeEnum) +ParasolidVersion +Controls which file version to export to when exporting Parasolid files. Only valid if +ExportFileFormat is Parasolid. (Read/Write ExportParasolidVersionEnum) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Export (filename string) +Export all geometry. +ExportParts (filename string, geometrylist List of Geometry) +Export only the specified geometry. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ACISVersion +Controls which file version to export to when exporting ACIS files. Only valid if ExportFileFormat is +ACIS. +Type +ExportACISVersionEnum +Access +Read/Write +CATIAV5Version +Controls which file version to export to when exporting CATIAV5 files. Only valid if +ExportFileFormat is CATIAV5. +Type +ExportCATIAV5VersionEnum +Access +Read/Write +ExportFileFormat +The export file format. +Type +ExportGeometryFileFormatEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +ParasolidFileFormat +The Parasolid topology type. Only valid if ExportFileFormat is Parasolid. +Type +ParasolidExportFileFormatEnum +Access +Read/Write +ParasolidTopologyType +The Parasolid topology type. Only valid if ExportFileFormat is Parasolid. +Type +ParasolidTopologyTypeEnum +Access +Read/Write +ParasolidVersion +Controls which file version to export to when exporting Parasolid files. Only valid if +ExportFileFormat is Parasolid. +Type +ExportParasolidVersionEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Export (filename string) +Export all geometry. +Input Parameters +filename(string) +The name of the file to be exported. +ExportParts (filename string, geometrylist List of Geometry) +Export only the specified geometry. +Input Parameters +filename(string) +The name of the file to be exported. +geometrylist(List of Geometry) +The list of geometry that must be exported. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +GeometryImporter +The geometry importer. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Auto determine the CAD file type and import it into the current project +project.Importer.Geometry:ImportFile(FEKO_HOME..[[/shared/Resources/Automation/ +car_geometry.x_b]]) +Inheritance +The GeometryImporter object is derived from the Object object. +Usage locations +The GeometryImporter object can be accessed from the following locations: +• Properties +◦ +Importer object has property Geometry. +Property List +AutoMergeWires +Enables auto-merging of wires which touch. (Read/Write boolean) +AutoStitchFaces +Enables auto-stitching of faces which touch. (Read/Write boolean) +ExtrudeEnabled +Enables the extrusion option. (Read/Write boolean) +HealingType +The type of healing to be applied. (Read/Write ImportHealingTypeEnum) +ImportScaleFactor +The factor by which the imported geometry will be scaled. This value must be greater than 0. +(Read/Write number) +Label +The object label. (Read/Write string) +SimplifyModelEnabled +Enables model simplification during importing. (Read/Write boolean) +StitchTrimmedFacesEnabled +Enables stitching of trimmed faces during importing. (Read/Write boolean) +Type +The object type string. (Read only string) +UseTwoStepImportEnabled +Enables the legacy two step import process during conversion. (Read/Write boolean) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AutoMergeWires +Enables auto-merging of wires which touch. +Type +boolean +Access +Read/Write +AutoStitchFaces +Enables auto-stitching of faces which touch. +Type +boolean +Access +Read/Write +ExtrudeEnabled +Enables the extrusion option. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +HealingType +The type of healing to be applied. +Type +ImportHealingTypeEnum +Access +Read/Write +ImportScaleFactor +p.881 +The factor by which the imported geometry will be scaled. This value must be greater than 0. +Type +number +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +SimplifyModelEnabled +Enables model simplification during importing. +Type +boolean +Access +Read/Write +StitchTrimmedFacesEnabled +Enables stitching of trimmed faces during importing. +Type +boolean +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +UseTwoStepImportEnabled +Enables the legacy two step import process during conversion. +Type +boolean +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +GeometryRebuild +The rebuild tools. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create some geometry with a hole to fill +ellipse = project.Contents.Geometry:AddEllipse(cf.Point(), 2, 2) +rectangle = project.Contents.Geometry:AddRectangle(cf.Point(), 1, 1) +subtract = project.Contents.Geometry:Subtract(ellipse, {rectangle}) + -- Convert the geometry to primitive before it can be rebuild +geometry = subtract:ConvertToPrimitive() + -- Find one of the inner edges to construct an edge loop to fill +centreEdge = geometry.Edges:ClosestTo(cf.Point()) +edgeLoop = project.Contents.Geometry.Find:EdgeLoop({centreEdge}) + -- Fill the hole with the found inner edge loop +project.Contents.Geometry.Rebuild:FillHole(edgeLoop) +Inheritance +The GeometryRebuild object is derived from the Object object. +Usage locations +The GeometryRebuild object can be accessed from the following locations: +• Properties +◦ GeometryCollection collection has property Rebuild. +Property List +FillHoleSettings +The settings to be used during the hole filling operation. (Read only FillHoleSettings) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +FillHole (edges List of Edge) +Fill the hole using the specified bounding edges. +GetProperties () +p.884 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +FillHoleSettings +The settings to be used during the hole filling operation. +Type +FillHoleSettings +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +FillHole (edges List of Edge) +Fill the hole using the specified bounding edges. +Input Parameters +edges(List of Edge) +The list of edges forming a closed loop, which defines the hole which must be filled. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GeometryRepair +A grouping of various geometry repair tools. +Example +p.886 +application = cf.Application.GetInstance() +project = application:NewProject() +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0,0,0),1,1,1) +primitive = cuboid:ConvertToPrimitive() + -- Retrieve the RemoveSmallEdgesEnabled repair parts setting +removeSmallEdgesEnabled = + project.Contents.Geometry.Repair.RepairPartsSettings.RemoveSmallEdgesEnabled + -- Repair the geometry primitive +project.Contents.Geometry.Repair:RepairParts({primitive}) +Inheritance +The GeometryRepair object is derived from the Object object. +Usage locations +The GeometryRepair object can be accessed from the following locations: +• Properties +◦ GeometryCollection collection has property Repair. +Property List +Label +The object label. (Read/Write string) +RemoveSmallFeaturesSettings +The settings to be used while doing the remove small features operation. (Read only +RemoveSmallFeaturesSettings) +RepairAndSewFacesSettings +The settings to be used while doing the repair and sew faces operation. (Read only +RepairAndSewFacesSettings) +RepairEdgesSettings +The settings to be used while doing the repair edges operation. (Read only RepairEdgesSettings) +RepairPartsSettings +The settings to be used while doing the repair part operation. (Read only RepairPartsSettings) +SimplifyPartRepresentationSettings +The settings to be used while doing the simplify part representation operation. (Read only +SimplifyPartRepresentationSettings) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.887 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RemoveSmallFeatures (geometrylist List of Geometry) +Removes the small features of the specified geometry parts. +RepairAndSewFaces (geometrylist List of Geometry) +Repair and sew the faces of the specified geometry parts. (Returns a List of RepairAndSewFaces +object.) +RepairEdges (geometrylist List of Geometry) +Repair the edges of the specified geometry parts. +RepairParts (geometrylist List of Geometry) +Repair the specified geometry parts. (Returns a List of RepairPart object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SimplifyParts (geometrylist List of Geometry) +Simplify the representation of the specified geometry parts. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +RemoveSmallFeaturesSettings +The settings to be used while doing the remove small features operation. +Type +RemoveSmallFeaturesSettings +Access +Read only +RepairAndSewFacesSettings +The settings to be used while doing the repair and sew faces operation. +Type +RepairAndSewFacesSettings +Access +Read only +RepairEdgesSettings +The settings to be used while doing the repair edges operation. +Type +RepairEdgesSettings +Access +Read only +RepairPartsSettings +The settings to be used while doing the repair part operation. +Type +RepairPartsSettings +Access +Read only +SimplifyPartRepresentationSettings +The settings to be used while doing the simplify part representation operation. +Type +SimplifyPartRepresentationSettings +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.889 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RemoveSmallFeatures (geometrylist List of Geometry) +Removes the small features of the specified geometry parts. +Input Parameters +geometrylist(List of Geometry) +The list of geometry to be cleaned. +RepairAndSewFaces (geometrylist List of Geometry) +Repair and sew the faces of the specified geometry parts. +Input Parameters +geometrylist(List of Geometry) +The list of geometry that must be repaired. +Return +List of RepairAndSewFaces +void. +RepairEdges (geometrylist List of Geometry) +Repair the edges of the specified geometry parts. +Input Parameters +geometrylist(List of Geometry) +The list of geometry that must be repaired. +RepairParts (geometrylist List of Geometry) +Repair the specified geometry parts. +Input Parameters +geometrylist(List of Geometry) +The list of geometry that must be repaired. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +List of RepairPart +void. +SetProperties (properties Object) +p.890 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SimplifyParts (geometrylist List of Geometry) +Simplify the representation of the specified geometry parts. +Input Parameters +geometrylist(List of Geometry) +The list of geometry that must be simplified. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +GlobalCoordinates +Global coordinates define positions relative to the global coordinate system. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) + -- Modify the workplane origin (global coordinates) of the cuboid +cuboid.LocalWorkplane.WorkplaneDefinitionOption + = cf.Enums.LocalWorkplaneDefinitionEnum.UseCustomDefinedWorkplane +cuboid.LocalWorkplane.LocalDefinedWorkplane.Origin.X = 2.5 +cuboid.LocalWorkplane.LocalDefinedWorkplane.Origin.Y = -0.5 +cuboid.LocalWorkplane.LocalDefinedWorkplane.Origin.Z = 1 +Inheritance +The GlobalCoordinates object is derived from the CompositeValue object. +The following objects are derived (specialisations) from the GlobalCoordinates object: +• GlobalOrigin +• GlobalVector +Usage locations +The GlobalCoordinates object can be accessed from the following locations: +• Properties +◦ Scale object has property Origin. +◦ CableConnector object has property Position. +◦ FEMLineMeshPort object has property Start. +◦ FEMLineMeshPort object has property End. +◦ FEMLinePort object has property Start. +◦ FEMLinePort object has property End. +◦ WaveguideMeshPort object has property ManualReferenceVector. +◦ WaveguidePort object has property ManualReferenceVector. +◦ SAR object has property SpecifiedPosition. +◦ TransmissionReflection object has property Position. +◦ ReferenceDirection object has property End. +◦ ReferenceDirection object has property Start. +• Methods +◦ GlobalCoordinatesList object has method Append(). +◦ GlobalCoordinatesList object has method Get(number). +Property List +The X coordinate. (Read/Write Dimension) +The Y coordinate. (Read/Write Dimension) +The Z coordinate. (Read/Write Dimension) +Property Details +The X coordinate. +Type +Dimension +Access +Read/Write +The Y coordinate. +Type +Dimension +Access +Read/Write +The Z coordinate. +Type +Dimension +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +GlobalCoordinatesList +A list of GlobalCoordinates items. +Method List +Append () +p.893 +Appends a new item to the list. (Returns a GlobalCoordinates object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a GlobalCoordinates object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +GlobalCoordinates +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +GlobalCoordinates +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +GlobalMeshSettings +The global mesher settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Set the frequency +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08" + -- Create geometry +points = {} +points[1] = cf.Point(-0.25, 1.25, 0) +points[2] = cf.Point(1.5, 0.3, 0) +points[3] = cf.Point(0.8, -1.3, 0) +points[4] = cf.Point(-1.5, 0.3, 0) +points[5] = cf.Point(0.8, -0.3, 0) +points[6] = cf.Point(-0.25, 1, 0) +polyline = application.Project.Contents.Geometry:AddPolyline(points) + -- Set the wire radius on the 'GlobalMeshSettings' +project.Mesher.Settings.WireRadius = "0.01" + -- Mesh +project.Mesher:Mesh() +Inheritance +The GlobalMeshSettings object is derived from the MeshSettings object. +Usage locations +The GlobalMeshSettings object can be accessed from the following locations: +• Properties +◦ Mesher object has property Settings. +Property List +Advanced +Advanced meshing settings. (Read/Write MeshAdvancedSettings) +Label +The object label. (Read/Write string) +MeshSizeOption +Mesh size option. (Read/Write MeshSizeOptionEnum) +TetrahedronEdgeLength +Mesh tetrahedron edge length. Only applied if MeshSizeOption is Custom and there is at least one +volume in the model. (Read/Write ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +TriangleEdgeLength +p.896 +Mesh triangle edge length. Only applied if MeshSizeOption is Custom and there is at least one +surface in the model. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +WireRadius +Mesh wire segment radius. Only applied if there is at least one wire in the model. (Read/Write +ParametricExpression) +WireSegmentLength +Mesh wire segment length. Only applied if MeshSizeOption is Custom and there is at least one +wire in the model. (Read/Write ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Advanced +Advanced meshing settings. +Type +MeshAdvancedSettings +Label +Access +Read/Write +The object label. +Type +string +Access +Read/Write +MeshSizeOption +Mesh size option. +Type +MeshSizeOptionEnum +Access +Read/Write +TetrahedronEdgeLength +Mesh tetrahedron edge length. Only applied if MeshSizeOption is Custom and there is at least one +volume in the model. +Type +ParametricExpression +Access +Read/Write +TriangleEdgeLength +Mesh triangle edge length. Only applied if MeshSizeOption is Custom and there is at least one +surface in the model. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +WireRadius +Mesh wire segment radius. Only applied if there is at least one wire in the model. +Type +ParametricExpression +Access +Read/Write +WireSegmentLength +Mesh wire segment length. Only applied if MeshSizeOption is Custom and there is at least one +wire in the model. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GlobalOrigin +Global origin defines an origin position relative to the global coordinate system. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a cuboid with its base corner at the specified 'Point' +corner = cf.Point(-0.25, -0.25, 0) +cube = project.Contents.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25) +p.899 +Inheritance +The GlobalOrigin object is derived from the GlobalCoordinates object. +Usage locations +The GlobalOrigin object can be accessed from the following locations: +• Properties +◦ GlobalPlane object has property Origin. +• Methods +◦ GlobalOriginList object has method Append(). +◦ GlobalOriginList object has method Get(number). +Property List +The X coordinate. (Read/Write Dimension) +The Y coordinate. (Read/Write Dimension) +The Z coordinate. (Read/Write Dimension) +Property Details +The X coordinate. +Type +Dimension +Access +Read/Write +The Y coordinate. +Type +Dimension +Access +Read/Write +The Z coordinate. +Type +Dimension +Access +Read/Write +GlobalOriginList +A list of GlobalOrigin items. +Method List +Append () +Appends a new item to the list. (Returns a GlobalOrigin object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a GlobalOrigin object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +GlobalOrigin +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +GlobalOrigin +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +GlobalPlane +The global coordinate system plane. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a flare +baseCentre = cf.Point(-0.25, -0.25, 0) +flare = project.Contents.Geometry:AddFlare(baseCentre, 0.5, 0.5, 1.0, 0.3, 0.3) + -- Modify the local workplane of the flare +flare.LocalWorkplane.WorkplaneDefinitionOption + = cf.Enums.LocalWorkplaneDefinitionEnum.UseCustomDefinedWorkplane +lwp = flare.LocalWorkplane.LocalDefinedWorkplane +lwp.Origin.X = 1 +lwp.Origin.Z = .3 +lwp.UVector.Y = 1 +lwp.VVector.Z = -2 +assert("TODO") +Inheritance +The GlobalPlane object is derived from the CompositeValue object. +Usage locations +The GlobalPlane object can be accessed from the following locations: +• Properties +◦ LocalWorkplane object has property LocalDefinedWorkplane. +• Methods +◦ GlobalPlaneList object has method Append(). +◦ GlobalPlaneList object has method Get(number). +Property List +Origin +The plane origin. (Read/Write GlobalOrigin) +UVector +The plane U vector orientation. (Read/Write GlobalVector) +VVector +The plane V vector orientation. (Read/Write GlobalVector) +Property Details +Origin +The plane origin. +Type +GlobalOrigin +Access +Read/Write +UVector +The plane U vector orientation. +Type +GlobalVector +Access +Read/Write +VVector +The plane V vector orientation. +Type +GlobalVector +Access +Read/Write +GlobalPlaneList +A list of GlobalPlane items. +Method List +Append () +Appends a new item to the list. (Returns a GlobalPlane object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a GlobalPlane object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +GlobalPlane +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +GlobalPlane +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GlobalVector +Global vector defines a vector relative to the global coordinate system. +p.907 +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a flare +baseCentre = cf.Point(-0.25, -0.25, 0) +flare = project.Contents.Geometry:AddFlare(baseCentre, 0.5, 0.5, 1.0, 0.3, 0.3) + -- Modify the local workplane of the flare +flare.LocalWorkplane.WorkplaneDefinitionOption + = cf.Enums.LocalWorkplaneDefinitionEnum.UseCustomDefinedWorkplane +lwp = flare.LocalWorkplane.LocalDefinedWorkplane +lwp.Origin.X = 1 +lwp.Origin.Z = .3 +lwp.UVector.Y = 1 +lwp.VVector.Z = -2 +assert("TODO") +Inheritance +The GlobalVector object is derived from the GlobalCoordinates object. +Usage locations +The GlobalVector object can be accessed from the following locations: +• Properties +◦ GlobalPlane object has property UVector. +◦ GlobalPlane object has property VVector. +• Methods +◦ GlobalVectorList object has method Append(). +◦ GlobalVectorList object has method Get(number). +Property List +The X coordinate. (Read/Write Dimension) +The Y coordinate. (Read/Write Dimension) +The Z coordinate. (Read/Write Dimension) +Property Details +The X coordinate. +Type +Dimension +Access +Read/Write +The Y coordinate. +Type +Dimension +Access +Read/Write +The Z coordinate. +Type +Dimension +Access +Read/Write +GlobalVectorList +A list of GlobalVector items. +Method List +Append () +Appends a new item to the list. (Returns a GlobalVector object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a GlobalVector object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +GlobalVector +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +GlobalVector +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Ground +A cable ground component. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a ground to the schematic +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +terminal1 = cableHarness.Connectors["CableConnector2"].Pins["Pin2"].Terminal +ground = cableHarness.CableSchematic.Components:AddGround(terminal1) + -- Get the terminals that the ground component is connected to +terminalList = cableHarness.CableSchematic.Components["Ground1"].Terminals +Inheritance +The Ground object is derived from the Object object. +Usage locations +The Ground object can be accessed from the following locations: +• Methods +◦ CableSchematicComponentCollection collection has method AddGround(). +◦ CableSchematicComponentCollection collection has method AddGround(Terminal). +◦ CableSchematicComponentCollection collection has method AddGround(table). +Property List +Label +The object label. (Read/Write string) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +p.912 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GroundPlane +p.915 +The model's infinite plane/ground. The following may be defined: PEC, PMC ground planes, +homogeneous half space and planar multilayer substrate (finite and infinite). +Example +application = cf.Application.GetInstance() +project = application:NewProject() +dielectric = project.Definitions.Media.Dielectric:AddDielectric() + -- Modify the ground plane +project.Contents.SolutionSettings.GroundPlane.DefinitionMethod + = cf.Enums.GroundPlaneDefinitionMethodEnum.MultilayerSubstrate +layer = project.Contents.SolutionSettings.GroundPlane.Layers:append() +layer.GroundBottom = cf.Enums.GroundBottomTypeEnum.None +layer.Thickness = 0.1 +layer.Medium = dielectric +Inheritance +The GroundPlane object is derived from the Object object. +Usage locations +The GroundPlane object can be accessed from the following locations: +• Properties +◦ SolutionSettings object has property GroundPlane. +Property List +DefinitionMethod +Infinite plane/ground definition method (environment type). (Read/Write +GroundPlaneDefinitionMethodEnum) +Label +The object label. (Read/Write string) +Layers +The collection of planar layers for the multilayer substrate. Only applies when the +DefinitionMethod is MultilayerSubstrate. By default three layers are created where the top and +bottom layers are infinitely thick. (Read/Write PlanarSubstrateList) +Medium +The ground medium for homogeneous half space in region Z < 0. This property is only valid +when the DefinitionMethod is HalfspaceReflectionCoefficient or HalfspaceSommerfeld. (Read/Write +Medium) +Type +The object type string. (Read only string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +ZValue +Z value at the top of layer 1. This property is only valid when the DefinitionMethod is +MultilayerSubstrate. (Read/Write ParametricExpression) +p.916 +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +DefinitionMethod +Infinite plane/ground definition method (environment type). +Type +GroundPlaneDefinitionMethodEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Layers +The collection of planar layers for the multilayer substrate. Only applies when the +DefinitionMethod is MultilayerSubstrate. By default three layers are created where the top and +bottom layers are infinitely thick. +Type +PlanarSubstrateList +Access +Read/Write +Medium +The ground medium for homogeneous half space in region Z < 0. This property is only valid +when the DefinitionMethod is HalfspaceReflectionCoefficient or HalfspaceSommerfeld. +Type +Medium +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +ZValue +Z value at the top of layer 1. This property is only valid when the DefinitionMethod is +MultilayerSubstrate. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.918 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +GroundPlaneMedium +The finite ground plane medium. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +dielectric = project.Definitions.Media.Dielectric:AddDielectric() +project.Contents.SolutionSettings.GroundPlane.DefinitionMethod + = cf.Enums.GroundPlaneDefinitionMethodEnum.MultilayerSubstrate +layer = project.Contents.SolutionSettings.GroundPlane.Layers:append() +layer.GroundBottom = cf.Enums.GroundBottomTypeEnum.None +layer.Thickness = 0.1 +layer.Medium = dielectric + -- Retrieve the ground plane medium +groundPlaneMedium = project.Definitions.Media.GroundPlaneMedium +Inheritance +The GroundPlaneMedium object is derived from the Dielectric object. +Usage locations +The GroundPlaneMedium object can be accessed from the following locations: +• Properties +◦ Media object has property GroundPlaneMedium. +Property List +Colour +The medium colour. (Read/Write string) +DielectricModelling +The medium dielectric modelling properties. (Read/Write DielectricModelling) +Filename +The file describing the medium properties in XML format. (Read/Write FileReference) +Label +The object label. (Read/Write string) +MagneticModelling +The medium magnetic modelling properties. (Read/Write MagneticModelling) +MassDensity +Medium's mass density (kg/m^3). (Read/Write ParametricExpression) +SourceDefinitionMethod +Specifies the method used for defining the medium. (Read/Write +MediumSourceDefinitionMethodEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.920 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +DielectricModelling +The medium dielectric modelling properties. +Type +DielectricModelling +Access +Read/Write +Filename +The file describing the medium properties in XML format. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MagneticModelling +The medium magnetic modelling properties. +Type +MagneticModelling +Access +Read/Write +MassDensity +Medium's mass density (kg/m^3). +Type +ParametricExpression +Access +Read/Write +SourceDefinitionMethod +Specifies the method used for defining the medium. +Type +MediumSourceDefinitionMethodEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.922 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Helix +A helix. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a helix with the helix's base centre at the specified 'Point' +helixCentre = cf.Point(0, 0, 0) +helix = project.Contents.Geometry:AddHelix(helixCentre, 0.1, 0.1, 1.0, 5.0, false) +Inheritance +The Helix object is derived from the Geometry object. +Usage locations +The Helix object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddHelix(table). +◦ GeometryCollection collection has method AddHelixWithHeight(Point, Expression, Expression, +Expression, boolean). +◦ GeometryCollection collection has method AddHelix(Point, Expression, Expression, Expression, +Expression, boolean). +◦ GeometryCollection collection has method AddHelixWithTurns(Point, Expression, Expression, +Expression, boolean). +Property List +BaseRadius +The radius of the helix base (parallel to the UV plane). If DefinitionMethod is not +VariableRadiusAndTurns, the base radius applies along the entire helix length. (Read/Write +Dimension) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The centre point of the helix base. (Read/Write LocalCoordinate) +DefinitionMethod +Helix definition method as specified by the HelixDefinitionMethodEnum, e.g. BaseCentre or +ApertureCentre. (Read/Write HelixDefinitionMethodEnum) +EndRadius +The radius of the helix top (parallel to the UV plane). Only valid if DefinitionMethod is +VariableRadiusAndTurns. (Read/Write Dimension) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Height +p.924 +The height of the helix, in the N axis direction. Only valid if DefinitionMethod is +VariableRadiusAndTurns or ConstantRadiusAndHeight. (Read/Write NormalDimension) +Label +The object label. (Read/Write string) +LeftHandRotationEnabled +The rotation direction of the helix. Left handed if true, else right handed. (Read/Write boolean) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +PitchAngle +The angle (degrees) formed between the tangent of the curve and the UV plane -- constant +along the length of the helix. Only valid if DefinitionMethod is ConstantRadiusAndTurns or +ConstantRadiusAndHeight. (Read/Write ParametricExpression) +Turns +Type +The number of turns of the helix. Only valid if DefinitionMethod is VariableRadiusAndTurns or +ConstantRadiusAndTurns. (Read/Write ParametricExpression) +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BaseRadius +The radius of the helix base (parallel to the UV plane). If DefinitionMethod is not +VariableRadiusAndTurns, the base radius applies along the entire helix length. +Type +Dimension +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +The centre point of the helix base. +Type +LocalCoordinate +Access +Read/Write +DefinitionMethod +Helix definition method as specified by the HelixDefinitionMethodEnum, e.g. BaseCentre or +ApertureCentre. +Type +HelixDefinitionMethodEnum +Access +Read/Write +EndRadius +The radius of the helix top (parallel to the UV plane). Only valid if DefinitionMethod is +VariableRadiusAndTurns. +Type +Dimension +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Height +The height of the helix, in the N axis direction. Only valid if DefinitionMethod is +VariableRadiusAndTurns or ConstantRadiusAndHeight. +Type +NormalDimension +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LeftHandRotationEnabled +The rotation direction of the helix. Left handed if true, else right handed. +Type +boolean +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +PitchAngle +The angle (degrees) formed between the tangent of the curve and the UV plane -- constant +along the length of the helix. Only valid if DefinitionMethod is ConstantRadiusAndTurns or +ConstantRadiusAndHeight. +Type +ParametricExpression +Access +Read/Write +Turns +The number of turns of the helix. Only valid if DefinitionMethod is VariableRadiusAndTurns or +ConstantRadiusAndTurns. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +p.930 +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +p.932 +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Hexagon +A hexagon. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a hexagon at the specified 'Point' +centre = cf.Point(-0.25, -0.25, 0) +hexagon = project.Contents.Geometry:AddHexagon(centre, 1.3) +Inheritance +The Hexagon object is derived from the Geometry object. +The following objects are derived (specialisations) from the Hexagon object: +• StripHexagon +Usage locations +The Hexagon object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddHexagon(table). +◦ GeometryCollection collection has method AddHexagon(Point, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The hexagon centre point. (Read/Write LocalCoordinate) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Parent +p.934 +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +Width +The object type string. (Read only string) +The hexagon width. (Read/Write Dimension) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Explode () +p.935 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +The hexagon centre point. +Type +LocalCoordinate +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Width +The hexagon width. +Type +Dimension +Access +Read/Write +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +HexagonShape +A hexagon shape. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a hexagon shape +properties = cf.HexagonShape.GetDefaultProperties() +properties.Width = "1.5" +hexagonShape1 = + application.Project.Definitions.PeriodicStructures.Shapes:AddHexagon(properties) +Inheritance +The HexagonShape object is derived from the Shape object. +The following objects are derived (specialisations) from the HexagonShape object: +• StripHexagonShape +Usage locations +The HexagonShape object can be accessed from the following locations: +• Methods +◦ ShapeCollection collection has method AddHexagon(table). +Property List +Label +Type +Width +The object label. (Read/Write string) +The object type string. (Read only string) +The hexagon width. (Read/Write ParametricExpression) +Method List +BuildGeometry () +Creates the full geometry representation of the shape. (Returns a Geometry object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.942 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Width +The hexagon width. +Type +ParametricExpression +Access +Read/Write +Method Details +BuildGeometry () +Creates the full geometry representation of the shape. +Return +Geometry +The shape geometry. +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.943 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +HighFrequencySettings +High frequency solver settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Set the maximum number of iterations +p.944 +project.Contents.SolutionSettings.SolverSettings.HighFrequencySettings.MaxIterations + = 10 +Inheritance +The HighFrequencySettings object is derived from the CompositeValue object. +Usage locations +The HighFrequencySettings object can be accessed from the following locations: +• Properties +◦ SolverSettings object has property HighFrequencySettings. +• Methods +◦ HighFrequencySettingsList object has method Append(). +◦ HighFrequencySettingsList object has method Get(number). +Property List +AdaptiveRayLaunchingAccuracy +The adaptive RL-GO algorithm convergence criteria. Only valid if RLGOIncrementType is +Automatic. (Read/Write RLGOConvergenceAccuracyTypeEnum) +DecoupleRLGOFromMoM +Specifies whether RLGO and MoM solutions should be decoupled. (Read/Write boolean) +DecoupleUTDFromMoM +Specifies whether UTD and MoM solutions should be decoupled. (Read/Write boolean) +EnableFacetedUTDAcceleration +Specifies whether faceted UTD acceleration is determined automatically, +specified by FacetedUTDAccelerationEnum, eg. Automatic, On or Off. (Read/Write +FacetedUTDAccelerationEnum) +HighFrequencyPOMoMCouplingType +The coupling between PO and MoM, specified by HighFrequencyPOMoMCouplingTypeEnum, eg. +Iterative, Full, etc. (Read/Write HighFrequencyPOMoMCouplingTypeEnum) +MaxIterations +Maximum number of iterations. Only valid if HighFrequencyPOMoMCouplingType is Iterative. +(Read/Write ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +MaxRLGORayInteractions +p.945 +The maximum number of reflections/transmission interactions to be taken into account +for each RL-GO ray. Only valid if MaxRLGORayInteractionsEnabled is true. (Read/Write +ParametricExpression) +MaxRLGORayInteractionsEnabled +Specifies whether the number of ray interactions should be specified for RL-GO. (Read/Write +boolean) +MaxUTDRayInteractions +The maximum number of reflections/transmission interactions to be taken into account for each +UTD ray. (Read/Write ParametricExpression) +MaxUTDRayInteractionsEnabled +Specifies whether the number of ray interactions should be specified for UTD. (Read/Write +boolean) +PhiIncrement +The phi increment in degrees (spherical ray launching). Only valid if RLGOIncrementType is +SpecifyIncrements. (Read/Write ParametricExpression) +RLGOIncrementType +Specifies whether the ray launch increments are determined automatically or user specified, +specified by RLGOIncrementTypeEnum, eg. Automatic or SpecifyIncrements. (Read/Write +RLGOIncrementTypeEnum) +RayContributionsFacetedUTD +Ray contribution settings. (Read/Write RayContributionsFacetedUTD) +RayContributionsRLGO +Ray contribution settings. (Read/Write RayContributionsRLGO) +RayContributionsUTD +Ray contribution settings. (Read/Write RayContributionsUTD) +RayTraceSymmetryEnabled +Specifies whether symmetry should be used in ray-tracing (when possible). (Read/Write boolean) +StoppingCriterion +Stopping criterion for the residuum. Only valid if HighFrequencyPOMoMCouplingType is Iterative. +(Read/Write ParametricExpression) +StoreShadowingInfoEnabled +Specifies whether the shadowing information should be stored / re-used. (Read/Write boolean) +ThetaIncrement +The theta increment in degrees (spherical ray launching). Only valid if RLGOIncrementType is +SpecifyIncrements. (Read/Write ParametricExpression) +UIncrement +The U increment in metres (parallel ray front). Only valid if RLGOIncrementType is +SpecifyIncrements. (Read/Write ParametricExpression) +UTDRayContributionsType +Specifies whether the ray contributions are determined automatically or user specified, +specified by UTDRayContributionsTypeEnum, eg. Default or Advanced. (Read/Write +UTDRayContributionsTypeEnum) +VIncrement +The V increment in metres (parallel ray front). Only valid if RLGOIncrementType is +SpecifyIncrements. (Read/Write ParametricExpression) +Property Details +AdaptiveRayLaunchingAccuracy +The adaptive RL-GO algorithm convergence criteria. Only valid if RLGOIncrementType is +Automatic. +Type +RLGOConvergenceAccuracyTypeEnum +Access +Read/Write +DecoupleRLGOFromMoM +Specifies whether RLGO and MoM solutions should be decoupled. +Type +boolean +Access +Read/Write +DecoupleUTDFromMoM +Specifies whether UTD and MoM solutions should be decoupled. +Type +boolean +Access +Read/Write +EnableFacetedUTDAcceleration +Specifies whether faceted UTD acceleration is determined automatically, specified by +FacetedUTDAccelerationEnum, eg. Automatic, On or Off. +Type +FacetedUTDAccelerationEnum +Access +Read/Write +HighFrequencyPOMoMCouplingType +The coupling between PO and MoM, specified by HighFrequencyPOMoMCouplingTypeEnum, eg. +Iterative, Full, etc. +Type +HighFrequencyPOMoMCouplingTypeEnum +Access +Read/Write +MaxIterations +Maximum number of iterations. Only valid if HighFrequencyPOMoMCouplingType is Iterative. +Type +ParametricExpression +Access +Read/Write +MaxRLGORayInteractions +The maximum number of reflections/transmission interactions to be taken into account for each +RL-GO ray. Only valid if MaxRLGORayInteractionsEnabled is true. +Type +ParametricExpression +Access +Read/Write +MaxRLGORayInteractionsEnabled +Specifies whether the number of ray interactions should be specified for RL-GO. +Type +boolean +Access +Read/Write +MaxUTDRayInteractions +The maximum number of reflections/transmission interactions to be taken into account for each +UTD ray. +Type +ParametricExpression +Access +Read/Write +MaxUTDRayInteractionsEnabled +Specifies whether the number of ray interactions should be specified for UTD. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +PhiIncrement +p.948 +The phi increment in degrees (spherical ray launching). Only valid if RLGOIncrementType is +SpecifyIncrements. +Type +ParametricExpression +Access +Read/Write +RLGOIncrementType +Specifies whether the ray launch increments are determined automatically or user specified, +specified by RLGOIncrementTypeEnum, eg. Automatic or SpecifyIncrements. +Type +RLGOIncrementTypeEnum +Access +Read/Write +RayContributionsFacetedUTD +Ray contribution settings. +Type +RayContributionsFacetedUTD +Access +Read/Write +RayContributionsRLGO +Ray contribution settings. +Type +RayContributionsRLGO +Access +Read/Write +RayContributionsUTD +Ray contribution settings. +Type +RayContributionsUTD +Access +Read/Write +RayTraceSymmetryEnabled +Specifies whether symmetry should be used in ray-tracing (when possible). +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +StoppingCriterion +p.949 +Stopping criterion for the residuum. Only valid if HighFrequencyPOMoMCouplingType is Iterative. +Type +ParametricExpression +Access +Read/Write +StoreShadowingInfoEnabled +Specifies whether the shadowing information should be stored / re-used. +Type +boolean +Access +Read/Write +ThetaIncrement +The theta increment in degrees (spherical ray launching). Only valid if RLGOIncrementType is +SpecifyIncrements. +Type +ParametricExpression +Access +Read/Write +UIncrement +The U increment in metres (parallel ray front). Only valid if RLGOIncrementType is +SpecifyIncrements. +Type +ParametricExpression +Access +Read/Write +UTDRayContributionsType +Specifies whether the ray contributions are determined automatically or user specified, specified +by UTDRayContributionsTypeEnum, eg. Default or Advanced. +Type +UTDRayContributionsTypeEnum +Access +Read/Write +VIncrement +The V increment in metres (parallel ray front). Only valid if RLGOIncrementType is +SpecifyIncrements. +Type +ParametricExpression +Access +Read/Write +HighFrequencySettingsList +A list of HighFrequencySettings items. +Method List +Append () +Appends a new item to the list. (Returns a HighFrequencySettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a HighFrequencySettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +HighFrequencySettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +HighFrequencySettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.952 +HyperbolicArc +A hyperbolic arc. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a hyperbolic arc with the hyperbola's base centre at the specified + 'Point' +hyperbolaCentre = cf.Point(0, 0, 0) +hyperbolicArc = + project.Contents.Geometry:AddHyperbolicArc(hyperbolaCentre, 1.0, 1.0, 1.1) +Inheritance +The HyperbolicArc object is derived from the Geometry object. +Usage locations +The HyperbolicArc object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddHyperbolicArc(table). +◦ GeometryCollection collection has method AddHyperbolicArcAtApertureCentre(Point, +Expression, Expression, Expression). +◦ GeometryCollection collection has method AddHyperbolicArc(Point, Expression, Expression, +Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The centre of either the underlying hyperbola's base or the arc aperture, depending on the value +of HyperbolicArcDefinitionMethodEnum. (Read/Write LocalCoordinate) +DefinitionMethod +Hyperbolic arc definition method as specified by the HyperbolicArcDefinitionMethodEnum, e.g. +BaseCentre or ApertureCentre. (Read/Write HyperbolicArcDefinitionMethodEnum) +Depth +The distance from the apex of the hyperbola to the centre of the aperture. (Read/Write +Dimension) +Eccentricity +The eccentricity of the hyperbola on which the hyperbolic arc section lies. (Read/Write +ParametricExpression) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +p.954 +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Radius +The radius of the Hyperbolic arc's aperture. (Read/Write Dimension) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +The centre of either the underlying hyperbola's base or the arc aperture, depending on the value +of HyperbolicArcDefinitionMethodEnum. +Type +LocalCoordinate +Access +Read/Write +DefinitionMethod +Hyperbolic arc definition method as specified by the HyperbolicArcDefinitionMethodEnum, e.g. +BaseCentre or ApertureCentre. +Type +HyperbolicArcDefinitionMethodEnum +Access +Read/Write +Depth +The distance from the apex of the hyperbola to the centre of the aperture. +Type +Dimension +Access +Read/Write +Eccentricity +The eccentricity of the hyperbola on which the hyperbolic arc section lies. +Type +ParametricExpression +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Radius +The radius of the Hyperbolic arc's aperture. +Type +Dimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.961 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ImpedanceOptimisationGoal +An impedance optimisation goal. +Example +p.962 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) +voltageSource = + project.Contents.SolutionConfigurations.GlobalSources["VoltageSource1"] +search = + project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) + -- Create an impedance optimisation goal with focus on the 'VoltageSource' +properties = cf.ImpedanceOptimisationGoal.GetDefaultProperties() +properties.FocusSource = voltageSource +properties.GoalOperator = cf.Enums.OptimisationGoalOperatorEnum.LessThan +properties.Objective.TargetValue = "1.5" +impedanceGoal = search.Goals:AddImpedanceGoal(properties) + -- Change the focus type to transmission coefficient and reference impedance of + 75 ohm +impedanceGoal.FocusType + = cf.Enums.OptimisationImpedanceFocusTypeEnum.TransmissionCoefficient +impedanceGoal.ReferenceImpedance = 75 +Inheritance +The ImpedanceOptimisationGoal object is derived from the OptimisationGoal object. +Usage locations +The ImpedanceOptimisationGoal object can be accessed from the following locations: +• Methods +◦ OptimisationGoalCollection collection has method AddImpedanceGoal(table). +Property List +FocusSource +Set the focus source to a specified source object. The intended usage is for when the source is +defined in CADFEKO. (Read/Write VoltageSource) +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. (Read/Write string) +FocusType +Set the focus type. (Read/Write OptimisationImpedanceFocusTypeEnum) +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +(Read/Write OptimisationGoalOperatorEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Label +The object label. (Read/Write string) +Objective +p.963 +The objective describes a state that the optimisation process should attempt to achieve. (Read +only OptimisationGoalObjective) +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. (Read/Write OptimisationGoalProcessingStepsList) +ReferenceImpedance +Reference impedance. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Weight +Specify the optimisation weight. (Read/Write ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +FocusSource +Set the focus source to a specified source object. The intended usage is for when the source is +defined in CADFEKO. +Type +VoltageSource +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. +p.964 +Type +string +Access +Read/Write +FocusType +Set the focus type. +Type +OptimisationImpedanceFocusTypeEnum +Access +Read/Write +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +Type +OptimisationGoalOperatorEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Objective +The objective describes a state that the optimisation process should attempt to achieve. +Type +OptimisationGoalObjective +Access +Read only +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. +Type +OptimisationGoalProcessingStepsList +Access +Read/Write +ReferenceImpedance +Reference impedance. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Weight +Specify the optimisation weight. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ImpedanceSheet +An impedance sheet medium. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create an impedance sheet +impedanceSheet = project.Definitions.Media.ImpedanceSheet:AddImpedanceSheet() +Inheritance +The ImpedanceSheet object is derived from the Medium object. +Usage locations +The ImpedanceSheet object can be accessed from the following locations: +• Methods +◦ +◦ +◦ +◦ +◦ +ImpedanceSheetCollection collection has method AddImpedanceSheet(table). +ImpedanceSheetCollection collection has method AddImpedanceSheet(Expression, +Expression). +ImpedanceSheetCollection collection has method AddImpedanceSheet(). +ImpedanceSheetCollection collection has method Item(number). +ImpedanceSheetCollection collection has method Item(string). +Property List +Colour +The medium colour. (Read/Write string) +DefinitionMethod +Impedance sheet definition method. (Read/Write MediumImpedanceDefinitionMethodEnum) +Filename +The file describing the medium properties in XML format. (Read/Write FileReference) +FrequencyPoints +The collection of linear interpolated frequency points of impedance sheet properties. Only +applicable if DefinitionMethod is FrequencyList. (Read/Write SurfaceImpedanceFrequencyPointList) +ImpedanceImaginary +Medium's imaginary impedance (Ohm). Only applicable if DefinitionMethod is +FrequencyIndependent. (Read/Write ParametricExpression) +ImpedanceReal +Medium's real impedance (Ohm). Only applicable if DefinitionMethod is FrequencyIndependent. +(Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +SourceDefinitionMethod +Specifies the method used for defining the medium. (Read/Write +MediumSourceDefinitionMethodEnum) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +DefinitionMethod +Impedance sheet definition method. +Type +MediumImpedanceDefinitionMethodEnum +Access +Read/Write +Filename +The file describing the medium properties in XML format. +Type +FileReference +Access +Read/Write +FrequencyPoints +The collection of linear interpolated frequency points of impedance sheet properties. Only +applicable if DefinitionMethod is FrequencyList. +Type +SurfaceImpedanceFrequencyPointList +Access +Read/Write +ImpedanceImaginary +Medium's imaginary impedance (Ohm). Only applicable if DefinitionMethod is +FrequencyIndependent. +Type +ParametricExpression +Access +Read/Write +ImpedanceReal +Medium's real impedance (Ohm). Only applicable if DefinitionMethod is FrequencyIndependent. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +SourceDefinitionMethod +Specifies the method used for defining the medium. +Type +MediumSourceDefinitionMethodEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Importer +The model (geometry and mesh) importer. +Example +p.971 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Import a Parasolid geometry model and a Nastran mesh +project.Importer.Geometry:ImportFile(FEKO_HOME..[[/shared/Resources/Automation/ +car_geometry.x_b]]) +project.Importer.MeshImporter:Import(FEKO_HOME..[[/shared/Resources/Automation/ +demo_RM.nas]]) +Inheritance +The Importer object is derived from the Object object. +Usage locations +The Importer object can be accessed from the following locations: +• Properties +◦ Model object has property Importer. +Property List +Geometry +The geometry importer. (Read only GeometryImporter) +KBL +Label +The KBL file importer. (Read only KBL) +The object label. (Read/Write string) +MeshImporter +The mesh importer. (Read only MeshImporter) +PCB +Type +The PCB file importer. (Read only PCB) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.972 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Geometry +The geometry importer. +Type +GeometryImporter +Access +Read only +KBL +The KBL file importer. +Type +KBL +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +MeshImporter +The mesh importer. +Type +MeshImporter +Access +Read only +PCB +The PCB file importer. +Type +PCB +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ImpressedCurrent +An impressed current may be defined as a source in a model. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create an impressed current +sourceCollection = project.Contents.SolutionConfigurations.GlobalSources +impressedCurrent = + sourceCollection:AddImpressedCurrent(cf.Point(0,0,0),cf.Point(1,1,0),0.01) +Inheritance +The ImpressedCurrent object is derived from the AbstractIdealSource object. +Usage locations +The ImpressedCurrent object can be accessed from the following locations: +• Methods +◦ SourceCollection collection has method AddImpressedCurrent(table). +◦ SourceCollection collection has method AddImpressedCurrent(Point, Point, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ConnectEndToClosestVertex +The option to connect the end point to the closest vertex. (Read/Write boolean) +EndMagnitude +The magnitude at the end position. (Read/Write ParametricExpression) +EndPhase +The phase (degrees) at the end position. (Read/Write ParametricExpression) +EndPosition +The end position of the source. (Read/Write LocalCoordinate) +ImpressedCurrentClosestVertexType +The mesh element type to connect to. (Read/Write ImpressedCurrentClosestVertexTypeEnum) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Radius +The radius of the impressed current. (Read/Write ParametricExpression) +StartMagnitude +The magnitude at the start position. (Read/Write ParametricExpression) +StartPhase +The phase (degrees) at the start position. (Read/Write ParametricExpression) +StartPosition +The start position of the source. (Read/Write LocalCoordinate) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ConnectEndToClosestVertex +The option to connect the end point to the closest vertex. +Type +boolean +Access +Read/Write +EndMagnitude +The magnitude at the end position. +Type +ParametricExpression +Access +Read/Write +EndPhase +The phase (degrees) at the end position. +Type +ParametricExpression +Access +Read/Write +EndPosition +The end position of the source. +Type +LocalCoordinate +Access +Read/Write +ImpressedCurrentClosestVertexType +The mesh element type to connect to. +Type +ImpressedCurrentClosestVertexTypeEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Radius +The radius of the impressed current. +Type +ParametricExpression +Access +Read/Write +StartMagnitude +The magnitude at the start position. +Type +ParametricExpression +Access +Read/Write +StartPhase +The phase (degrees) at the start position. +Type +ParametricExpression +Access +Read/Write +StartPosition +The start position of the source. +Type +LocalCoordinate +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.980 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ImprintPoints +Imprint points onto geometry. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a rectangle to imprint on +rect = project.Contents.Geometry:AddRectangle(cf.Point(0, 0, 0), 2, 2) + -- Create a set of points to imprint +points = {} +points[1] = cf.Point(1, 1, 0) +points[2] = cf.Point(0.25, 0.75, 0.3) +points[3] = cf.Point(0.75, 0.25, -1) + -- Imprint the points on the rectangle +imprinted = project.Contents.Geometry:ImprintPoints(rect, points) +Inheritance +The ImprintPoints object is derived from the Geometry object. +Usage locations +The ImprintPoints object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method ImprintPoints(Geometry, table). +◦ GeometryCollection collection has method ImprintPoints(Geometry, List of Point). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ChildReferences +The geometry items to be transformed. (Read/Write ObjectReferenceList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Points +The collection of points to imprint. (Read/Write LocalInternalCoordinateList) +Type +The object type string. (Read only string) +Collection List +Children +The collection of child operators of the operator. (OperatorCollection of Geometry.) +The collection of edges of the operator. (EdgeCollection of Edge.) +Edges +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ChildReferences +The geometry items to be transformed. +Type +ObjectReferenceList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Points +The collection of points to imprint. +Type +LocalInternalCoordinateList +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Children +The collection of child operators of the operator. +Type +OperatorCollection +Edges +Faces +The collection of edges of the operator. +Type +EdgeCollection +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method Details +ConvertToPrimitive () +p.986 +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Inductor +A cable inductor component. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a 1mH inductor +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +terminal1 = cableHarness.Connectors["CableConnector2"].Pins["Pin2"].Terminal +terminal2 = cableHarness.Connectors["CableConnector2"].Pins["Pin1"].Terminal +inductor = cableHarness.CableSchematic.Components:AddInductor(terminal1, terminal2, + 1e-3) + -- Change the inductor's inductance +cableHarness.CableSchematic.Components["L1"].Inductance = 5e-3 +Inheritance +The Inductor object is derived from the Object object. +Usage locations +The Inductor object can be accessed from the following locations: +• Methods +◦ CableSchematicComponentCollection collection has method AddInductor(). +◦ CableSchematicComponentCollection collection has method AddInductor(table). +◦ CableSchematicComponentCollection collection has method AddInductor(Terminal, Terminal, +Expression). +Property List +CurrentProbeEnabled +True if a current probe must be applied to the component. (Read/Write boolean) +Inductance +The inductance of the inductor in Henry. (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +VoltageProbeEnabled +True if a current probe must be applied to the component. (Read/Write boolean) +p.991 +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CurrentProbeEnabled +True if a current probe must be applied to the component. +Type +boolean +Access +Read/Write +Inductance +The inductance of the inductor in Henry. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VoltageProbeEnabled +True if a current probe must be applied to the component. +Type +boolean +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +IntegralEquation +Integral equation settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Specify a custom combined field integral equation factor +project.Contents.SolutionSettings.SolverSettings.IntegralEquation.CFIEFactor = "0.3" +Inheritance +The IntegralEquation object is derived from the CompositeValue object. +Usage locations +The IntegralEquation object can be accessed from the following locations: +• Properties +◦ SolverSettings object has property IntegralEquation. +• Methods +◦ +◦ +IntegralEquationList object has method Append(). +IntegralEquationList object has method Get(number). +Property List +CFIEFactor +This factor is used when combining electric and magnetic terms in the CFIE formulation. Changing +this property will set CFIEFactorEnabled to true. (Read/Write ParametricExpression) +CFIEFactorEnabled +Specifies if a factor should be used for the CFIE formulation. (Read/Write boolean) +Property Details +CFIEFactor +This factor is used when combining electric and magnetic terms in the CFIE formulation. Changing +this property will set CFIEFactorEnabled to true. +Type +ParametricExpression +Access +Read/Write +CFIEFactorEnabled +Specifies if a factor should be used for the CFIE formulation. +Type +boolean +Access +Read/Write +IntegralEquationList +A list of IntegralEquation items. +Method List +Append () +Appends a new item to the list. (Returns a IntegralEquation object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a IntegralEquation object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +IntegralEquation +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +IntegralEquation +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Intersect +An intersect operator. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create three cuboid operators to intersect +cube1 = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +cube2 = project.Contents.Geometry:AddCuboid(cf.Point(0.5, 0.5, 0.5), 1, 1, 1) +cube3 = project.Contents.Geometry:AddCuboid(cf.Point(0.5, 0, 0), 1, 1 ,1) + -- Intersect cube1, cube2 and cube3 +intersect = project.Contents.Geometry:Intersect({cube1, cube2, cube3}) +Inheritance +The Intersect object is derived from the Geometry object. +Usage locations +The Intersect object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method Intersect(List of Geometry). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ChildReferences +The geometry items to be transformed. (Read/Write ObjectReferenceList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Collection List +Children +p.1000 +The collection of child operators of the operator. (OperatorCollection of Geometry.) +The collection of edges of the operator. (EdgeCollection of Edge.) +Edges +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1001 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ChildReferences +The geometry items to be transformed. +Type +ObjectReferenceList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Children +The collection of child operators of the operator. +Type +OperatorCollection +Edges +Faces +The collection of edges of the operator. +Type +EdgeCollection +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +p.1006 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +IsotropicDielectricLayers +Layer properties of the layered dielectric medium. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +p.1007 +dielectric = project.Definitions.Media.Dielectric:AddDielectric() +layeredDielectric = + project.Definitions.Media.LayeredDielectric:AddLayeredDielectric({0.1},{dielectric}) + -- Modify the isotropic dielectric layer +layeredDielectric.Layers[1].Thickness = 0.05 +Inheritance +The IsotropicDielectricLayers object is derived from the CompositeValue object. +The following objects are derived (specialisations) from the IsotropicDielectricLayers object: +• CoaxialInsulationLayer +Usage locations +The IsotropicDielectricLayers object can be accessed from the following locations: +• Methods +◦ +◦ +IsotropicDielectricLayersList object has method Append(). +IsotropicDielectricLayersList object has method Get(number). +Property List +Medium +The dielectric medium of the material to be used for the layer. (Read/Write Dielectric) +Thickness +The thickness (in the model unit) of the layer. (Read/Write ParametricExpression) +Property Details +Medium +The dielectric medium of the material to be used for the layer. +Type +Dielectric +Access +Read/Write +Thickness +The thickness (in the model unit) of the layer. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +IsotropicDielectricLayersList +A list of IsotropicDielectricLayers items. +Usage locations +p.1009 +The IsotropicDielectricLayersList object can be accessed from the following locations: +• Properties +◦ LayeredIsotropicDielectric object has property Layers. +Method List +Append () +Appends a new item to the list. (Returns a IsotropicDielectricLayers object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a IsotropicDielectricLayers +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +IsotropicDielectricLayers +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +IsotropicDielectricLayers +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +IterativeSolverSettings +Settings for the iterative solver. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Change the advanced solver type to iterative +p.1011 +project.Contents.SolutionSettings.SolverSettings.PreconditionerSettings.AdvancedSolverType + = + cf.Enums.AdvancedSolverTypeEnum.Iterative + -- Change the preconditioner type to BlockJacobiLU +project.Contents.SolutionSettings.SolverSettings.PreconditionerSettings.IterativeSolverSettings. + PreconditionerType = cf.Enums.PreconditionerTypeEnum.BlockJacobiLU_64 +Inheritance +The IterativeSolverSettings object is derived from the CompositeValue object. +Usage locations +The IterativeSolverSettings object can be accessed from the following locations: +• Properties +◦ PreconditionerSettings object has property IterativeSolverSettings. +• Methods +◦ +◦ +IterativeSolverSettingsList object has method Append(). +IterativeSolverSettingsList object has method Get(number). +Property List +AcceleratedSPAIEnabled +Specifies whether SPAI is accelerated (faster, possibly more iterations). Only valid if +PreconditionerType is SparseApproxInverse. (Read/Write boolean) +BlockSize +The Block-Jacobi block size. Only valid if PreconditionerType is BlockJacobiLU. (Read/Write +ParametricExpression) +FillInPerRow +The Multilevel ILU controlled fill-in parameter. Only valid if PreconditionerType is MultiLevelILU. +(Read/Write ParametricExpression) +LevelOfFill +The incomplete LU decomposition level-of-fill. Only valid if PreconditionerType is IncompleteLU. +(Read/Write ParametricExpression) +MaxIterations +The maximum number of iterations. (Read/Write ParametricExpression) +MaxResiduum +The V increment in metres (parallel ray front). (Read/Write ParametricExpression) +PreconditionerType +The preconditioner type, specified by PreconditionerTypeEnum, eg. Default, BlockJacobiLU, etc. +(Read/Write PreconditionerTypeEnum) +StabilisationFactor +The stabilisation factor. Only valid if PreconditionerType is MultiLevelILU. (Read/Write +ParametricExpression) +StoppingCriterion +The V increment in metres (parallel ray front). (Read/Write ParametricExpression) +Property Details +AcceleratedSPAIEnabled +Specifies whether SPAI is accelerated (faster, possibly more iterations). Only valid if +PreconditionerType is SparseApproxInverse. +Type +boolean +Access +Read/Write +BlockSize +The Block-Jacobi block size. Only valid if PreconditionerType is BlockJacobiLU. +Type +ParametricExpression +Access +Read/Write +FillInPerRow +The Multilevel ILU controlled fill-in parameter. Only valid if PreconditionerType is MultiLevelILU. +Type +ParametricExpression +Access +Read/Write +LevelOfFill +The incomplete LU decomposition level-of-fill. Only valid if PreconditionerType is IncompleteLU. +Type +ParametricExpression +Access +Read/Write +MaxIterations +The maximum number of iterations. +Type +ParametricExpression +Access +Read/Write +MaxResiduum +The V increment in metres (parallel ray front). +Type +ParametricExpression +Access +Read/Write +PreconditionerType +The preconditioner type, specified by PreconditionerTypeEnum, eg. Default, BlockJacobiLU, etc. +Type +PreconditionerTypeEnum +Access +Read/Write +StabilisationFactor +The stabilisation factor. Only valid if PreconditionerType is MultiLevelILU. +Type +ParametricExpression +Access +Read/Write +StoppingCriterion +The V increment in metres (parallel ray front). +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +IterativeSolverSettingsList +A list of IterativeSolverSettings items. +Method List +Append () +p.1014 +Appends a new item to the list. (Returns a IterativeSolverSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a IterativeSolverSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +IterativeSolverSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +IterativeSolverSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1015 +KBL +The KBL file importer. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +project.Importer.KBL:Import(FEKO_HOME..[[/shared/Resources/Automation/sample.kbl]]) +Inheritance +The KBL object is derived from the Object object. +Usage locations +The KBL object can be accessed from the following locations: +• Properties +◦ +Importer object has property KBL. +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Import (filename string) +Import the specified file. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Import (filename string) +Import the specified file. +Input Parameters +filename(string) +The name of the file to be imported. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +LaunchResult +The result of last Feko or external process run. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Save a copy of the file before running PREFEKO +p.1019 +application:SaveAs("temp_Dipole_Example.cfx") + -- Launch PREFEKO on the model +results = application.Launcher:RunPREFEKO() + -- Check the result of the run +success = results.Succeeded +Inheritance +The LaunchResult object is derived from the Object object. +Usage locations +The LaunchResult object can be accessed from the following locations: +• Methods +◦ Launcher object has method Run(string, string). +◦ Launcher object has method Run(string). +◦ Launcher object has method RunFEKO(). +◦ Launcher object has method RunOPTFEKO(). +◦ Launcher object has method RunPREFEKO(). +Property List +Errors +The error messages for the process run. (Read/Write string) +ExitCode +The exit code of the process run. (Read/Write number) +Label +The object label. (Read/Write string) +Output +The standard output for the process run. (Read/Write string) +Succeeded +The success of the process run. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.1020 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Errors +The error messages for the process run. +Type +string +Access +Read/Write +ExitCode +The exit code of the process run. +Type +number +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Output +The standard output for the process run. +Type +string +Access +Read/Write +Succeeded +The success of the process run. +Type +boolean +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Launcher +The object coordinating the launching of Feko and external processes. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Save a copy of the file before running PREFEKO +p.1023 +application:SaveAs("temp_Dipole_Example.cfx") + -- Launch PREFEKO on the model +results = application.Launcher:RunPREFEKO() + -- Check the result of the run +success = results.Succeeded +Inheritance +The Launcher object is derived from the Object object. +Usage locations +The Launcher object can be accessed from the following locations: +• Properties +◦ Application object has property Launcher. +Property List +CommandStringCADFEKO +Get the command that will be executed by the RunCADFEKO method. (Read only string) +CommandStringEDITFEKO +Get the command that will be executed by the RunEDITFEKO method. (Read only string) +CommandStringFEKO +Get the command that will be executed by the RunFEKO method. (Read only string) +CommandStringOPTFEKO +Get the command that will be executed by the RunOPTFEKO method. (Read only string) +CommandStringPOSTFEKO +Get the command that will be executed by the RunPOSTFEKO method. (Read only string) +CommandStringPREFEKO +Get the command that will be executed by the RunPREFEKO method. (Read only string) +Label +The object label. (Read/Write string) +Settings +The components launch options. (Read only ComponentLaunchOptions) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Run (executable string, arguments string) +Launch the given executable with a list of arguments and process the output. CAUTION, the +process that is called could be blocking and will halt your program execution until it is complete. +(Returns a LaunchResult object.) +Run (command string) +Launch the given command and process the output. CAUTION, the process that is called could +be blocking and will halt your program execution until it is complete. (Returns a LaunchResult +object.) +RunCADFEKO () +Run CADFEKO. +RunEDITFEKO () +Run EDITFEKO. +RunFEKO () +Run Feko Solver. (Returns a LaunchResult object.) +RunOPTFEKO () +Run OPTFEKO. (Returns a LaunchResult object.) +RunPOSTFEKO () +Run CADFEKO. +RunPREFEKO () +Rum PREFEKO. (Returns a LaunchResult object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CommandStringCADFEKO +Get the command that will be executed by the RunCADFEKO method. +p.1025 +Type +string +Access +Read only +CommandStringEDITFEKO +Get the command that will be executed by the RunEDITFEKO method. +Type +string +Access +Read only +CommandStringFEKO +Get the command that will be executed by the RunFEKO method. +Type +string +Access +Read only +CommandStringOPTFEKO +Get the command that will be executed by the RunOPTFEKO method. +Type +string +Access +Read only +CommandStringPOSTFEKO +Get the command that will be executed by the RunPOSTFEKO method. +Type +string +Access +Read only +CommandStringPREFEKO +Get the command that will be executed by the RunPREFEKO method. +Type +string +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Settings +The components launch options. +Type +ComponentLaunchOptions +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Run (executable string, arguments string) +p.1027 +Launch the given executable with a list of arguments and process the output. CAUTION, the +process that is called could be blocking and will halt your program execution until it is complete. +Input Parameters +executable(string) +The program to execute. +arguments(string) +The arguments send to the executable. +Return +LaunchResult +A LaunchResult containing the results of this run. +Run (command string) +Launch the given command and process the output. CAUTION, the process that is called could be +blocking and will halt your program execution until it is complete. +Input Parameters +command(string) +The command to execute. +Return +LaunchResult +Returns a LaunchResult object. +RunCADFEKO () +Run CADFEKO. +RunEDITFEKO () +Run EDITFEKO. +RunFEKO () +Run Feko Solver. +Return +LaunchResult +Returns a LaunchResult object. +RunOPTFEKO () +Run OPTFEKO. +Return +LaunchResult +Returns a LaunchResult object. +RunPOSTFEKO () +Run CADFEKO. +RunPREFEKO () +Rum PREFEKO. +Return +LaunchResult +Returns a LaunchResult object. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +LayeredAnisotropicDielectric +A layered anisotropic dielectric medium. +Example +p.1029 +application = cf.Application.GetInstance() +project = application:NewProject() +dielectric1 = project.Definitions.Media.Dielectric:AddDielectric() +dielectric2 = project.Definitions.Media.Dielectric:AddDielectric() + -- Create a layered dielectric (anisotropic) medium +project.Definitions.Media.LayeredDielectric:AddLayeredAnisotropicDielectric({0.1}, +{0.0},{dielectric1},{dielectric2}) +Inheritance +The LayeredAnisotropicDielectric object is derived from the LayeredDielectric object. +Usage locations +The LayeredAnisotropicDielectric object can be accessed from the following locations: +• Methods +◦ LayeredDielectricCollection collection has method AddLayeredAnisotropicDielectric(table). +◦ LayeredDielectricCollection collection has method +AddLayeredAnisotropicDielectric(ExpressionList, ExpressionList, List of Dielectric, List of +Dielectric). +Property List +Colour +The medium colour. (Read/Write string) +Label +The object label. (Read/Write string) +Layers +The collection of layers for the layered anisotropic dielectric medium. (Read/Write +AnisotropicDielectricLayersList) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1030 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Layers +The collection of layers for the layered anisotropic dielectric medium. +Type +AnisotropicDielectricLayersList +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +LayeredDielectric +A layered isotropic dielectric medium. +Example +p.1032 +application = cf.Application.GetInstance() +project = application:NewProject() +dielectric = project.Definitions.Media.Dielectric:AddDielectric() + -- Create a layered dielectric medium +project.Definitions.Media.LayeredDielectric:AddLayeredDielectric({0.1},{dielectric}) +Inheritance +The LayeredDielectric object is derived from the Medium object. +The following objects are derived (specialisations) from the LayeredDielectric object: +• LayeredAnisotropicDielectric +• LayeredIsotropicDielectric +Usage locations +The LayeredDielectric object can be accessed from the following locations: +• Methods +◦ LayeredDielectricCollection collection has method Item(number). +◦ LayeredDielectricCollection collection has method Item(string). +Property List +Colour +The medium colour. (Read/Write string) +The object label. (Read/Write string) +Label +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1033 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +table +A table defining the properties. +SetProperties (properties Object) +p.1034 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +LayeredIsotropicDielectric +A layered isotropic dielectric medium. +Example +p.1035 +application = cf.Application.GetInstance() +project = application:NewProject() +dielectric = project.Definitions.Media.Dielectric:AddDielectric() + -- Create a layered dielectric medium +project.Definitions.Media.LayeredDielectric:AddLayeredDielectric({0.1},{dielectric}) +Inheritance +The LayeredIsotropicDielectric object is derived from the LayeredDielectric object. +Usage locations +The LayeredIsotropicDielectric object can be accessed from the following locations: +• Properties +◦ Windscreen object has property LayerDefinition. +• Methods +◦ LayeredDielectricCollection collection has method AddLayeredDielectric(table). +◦ LayeredDielectricCollection collection has method AddLayeredDielectric(ExpressionList, List of +Dielectric). +Property List +Colour +The medium colour. (Read/Write string) +Label +The object label. (Read/Write string) +Layers +The collection of layers for the layered anisotropic dielectric medium. (Read/Write +IsotropicDielectricLayersList) +Thickness +The thickness (in the model unit) of the layer. (Read only number) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Layers +The collection of layers for the layered anisotropic dielectric medium. +Type +IsotropicDielectricLayersList +Access +Read/Write +Thickness +The thickness (in the model unit) of the layer. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +LibraryMedium +A medium from the MediaLibrary. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a medium from the media library +diel1 = application.MediaLibrary:AddToModel("Aluminium") +Inheritance +The LibraryMedium object is derived from the Object object. +Usage locations +The LibraryMedium object can be accessed from the following locations: +• Methods +◦ MediaLibrary collection has method Item(number). +◦ MediaLibrary collection has method Item(string). +Property List +Label +The object label. (Read/Write string) +Medium +The medium. (Read/Write Medium) +MediumType +The type of medium. (Read/Write LibraryMediumTypeEnum) +Source +The source of the medium, either AltairFeko or User. (Read/Write LibraryMediumSourceEnum) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1039 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Medium +The medium. +Type +Medium +Access +Read/Write +MediumType +The type of medium. +Type +LibraryMediumTypeEnum +Access +Read/Write +Source +The source of the medium, either AltairFeko or User. +Type +LibraryMediumSourceEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Line +A straight line. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Use 'Point' to create some lines +startPoint = cf.Point(0,1,0) +endPoint = cf.Point(1,0,0) +for count = 1, 3 do + project.Contents.Geometry:AddLine(startPoint*count,endPoint*count) +end + -- Use 'NamedPoint' to create a line +var = project.Definitions.Variables:Add("a", 1.5) +startPoint = project.Definitions.NamedPoints:Add("startPt", 0, 0, "a") +endPoint = project.Definitions.NamedPoints:Add("endPt", var.EvaluatedValue, + var.EvaluatedValue, 0) +line = project.Contents.Geometry:AddLine(startPoint,endPoint) +Inheritance +The Line object is derived from the Geometry object. +Usage locations +The Line object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddLine(table). +◦ GeometryCollection collection has method AddLine(Point, Point). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +EndPoint +The line operator end point. (Read/Write LocalCoordinate) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +StartPoint +The line operator start point. (Read/Write LocalCoordinate) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +EndPoint +The line operator end point. +Type +LocalCoordinate +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +StartPoint +The line operator start point. +Type +LocalCoordinate +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +LinearPlanarArray +A finite antenna array with a planar or linear distribution. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +antennaArrays = project.Contents.SolutionSettings.AntennaArrays + -- Create a 2x3 planar array +offsetU = 3 +offsetV = 4 +array = antennaArrays:AddPlanarArray(2, offsetU, 3, offsetV) + -- Set a non-uniform source distribution +array.UniformSourceDistributionEnabled = false +array.Distribution[1].MagnitudeScaling = "1.5" +array.Distribution[1].PhaseOffset = "45" +array.Distribution[6].MagnitudeScaling = "1.5" +array.Distribution[6].PhaseOffset = "90" +Inheritance +The LinearPlanarArray object is derived from the AbstractAntennaArray object. +Usage locations +The LinearPlanarArray object can be accessed from the following locations: +• Methods +◦ AntennaArrayCollection collection has method AddPlanarArray(table). +◦ AntennaArrayCollection collection has method AddPlanarArray(number, Expression, number, +Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CountU +The number of finite antenna array elements in the U dimension. (Read/Write number) +CountV +The number of finite antenna array elements in the V dimension. (Read/Write number) +Distribution +The collection of finite antenna array element sources. Only applicable if +UniformSourceDistributionEnabled is false. (Read/Write AntennaArraySourceList) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Altair Feko 2022.3 +2 Application Programming Interface (API) +OffsetU +p.1050 +The distance between the finite antenna array elements along the U axis. (Read/Write +ParametricExpression) +OffsetV +The distance between the finite antenna array elements along the V axis. (Read/Write +ParametricExpression) +Type +The object type string. (Read only string) +UniformSourceDistributionEnabled +The finite array elements will either have an uniform distribution or the distribution will be +calculated from the plane wave if a plane wave is present in the model. If it is set to false, the +source of each element can be specified. (Read/Write boolean) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +ConvertToCustomArray () +Convert the finite antenna array into a collection of individual custom array elements. (Returns a +List of CustomAntennaArray object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1051 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CountU +The number of finite antenna array elements in the U dimension. +Type +number +Access +Read/Write +CountV +The number of finite antenna array elements in the V dimension. +Type +number +Access +Read/Write +Distribution +The collection of finite antenna array element sources. Only applicable if +UniformSourceDistributionEnabled is false. +Type +AntennaArraySourceList +Label +Access +Read/Write +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +OffsetU +The distance between the finite antenna array elements along the U axis. +Type +ParametricExpression +Access +Read/Write +OffsetV +The distance between the finite antenna array elements along the V axis. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +UniformSourceDistributionEnabled +The finite array elements will either have an uniform distribution or the distribution will be +calculated from the plane wave if a plane wave is present in the model. If it is set to false, the +source of each element can be specified. +Type +boolean +Access +Read/Write +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +ConvertToCustomArray () +Convert the finite antenna array into a collection of individual custom array elements. +Return +List of CustomAntennaArray +The list of antenna array elements. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1055 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Load +A solution load. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +dielectric = project.Definitions.Media.Dielectric:AddDielectric() +cube = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +cube.Regions[1].Medium = dielectric +cube.Regions[1].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.FEM +femLinePort = + project.Contents.Ports:AddFEMLinePortBetweenPoints(cf.Point(0,0,0) ,cf.Point(1,1,0) ) + -- Add a complex load to the terminal of the line port. +complexLoad = + project.Contents.SolutionConfigurations.GlobalLoads:AddComplex(femLinePort,"220","0") + -- Do not include the load +complexLoad.Included = false +Inheritance +The Load object is derived from the Object object. +Usage locations +The Load object can be accessed from the following locations: +• Methods +◦ LoadCollection collection has method AddComplex(Port, Expression, Expression). +◦ LoadCollection collection has method AddLoad(table). +◦ LoadCollection collection has method AddParallel(Port, Expression, Expression, Expression). +◦ LoadCollection collection has method AddSeries(Port, Expression, Expression, Expression). +◦ LoadCollection collection has method AddSinglePortTouchstone(Port, string). +◦ LoadCollection collection has method AddSpiceCircuit(Port, string). +◦ LoadCollection collection has method Item(number). +◦ LoadCollection collection has method Item(string). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Capacitance +The capacitive aspect of the series or parallel circuit load definition (F). Changing this property will +set CapacitanceEnabled to true. (Read/Write ParametricExpression) +CapacitanceEnabled +Specifies if the Capacitance property should be used. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +CircuitName +p.1057 +The SPICE Circuit name. Setting disables the automatic generation of the name. (Read/Write +string) +Filename +The single port Touchstone or SPICE filename that describes the load. (Read/Write FileReference) +ImpedanceImaginary +The reactive part of the complex impedance (Ohm). (Read/Write ParametricExpression) +ImpedanceReal +The real part of the complex impedance (Ohm). (Read/Write ParametricExpression) +Inductance +The inductive aspect of the series or parallel circuit load definition (H). Changing this property will +set InductanceEnabled to true. (Read/Write ParametricExpression) +InductanceEnabled +Specifies if the Inductance property should be used. (Read/Write boolean) +Label +The object label. (Read/Write string) +LoadType +The load construction type. (Read/Write LoadTypeEnum) +Resistance +The resistive aspect of the series or parallel circuit load definition (Ohm). Changing this property +will set ResistanceEnabled to true. (Read/Write ParametricExpression) +ResistanceEnabled +Specifies if the Resistance property should be used. (Read/Write boolean) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +p.1058 +Type +Box +Access +Read only +Capacitance +The capacitive aspect of the series or parallel circuit load definition (F). Changing this property will +set CapacitanceEnabled to true. +Type +ParametricExpression +Access +Read/Write +CapacitanceEnabled +Specifies if the Capacitance property should be used. +Type +boolean +Access +Read/Write +CircuitName +The SPICE Circuit name. Setting disables the automatic generation of the name. +Type +string +Access +Read/Write +Filename +The single port Touchstone or SPICE filename that describes the load. +Type +FileReference +Access +Read/Write +ImpedanceImaginary +The reactive part of the complex impedance (Ohm). +Type +ParametricExpression +Access +Read/Write +ImpedanceReal +The real part of the complex impedance (Ohm). +Type +ParametricExpression +Access +Read/Write +Inductance +The inductive aspect of the series or parallel circuit load definition (H). Changing this property will +set InductanceEnabled to true. +Type +ParametricExpression +Access +Read/Write +InductanceEnabled +Specifies if the Inductance property should be used. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LoadType +The load construction type. +Type +LoadTypeEnum +Access +Read/Write +Resistance +The resistive aspect of the series or parallel circuit load definition (Ohm). Changing this property +will set ResistanceEnabled to true. +Type +ParametricExpression +Access +Read/Write +ResistanceEnabled +Specifies if the Resistance property should be used. +Type +boolean +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.1061 +Altair Feko 2022.3 +2 Application Programming Interface (API) +LocalCoordinate +p.1062 +Local coordinates typically define positions relative to the coordinate system of a 'LocalWorkplane'. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) + -- Modify the origin (local coordinates) of the cuboid +cuboid.Origin.U = 2.5 +cuboid.Origin.V = -0.5 +cuboid.Origin.N = 1 +Inheritance +The LocalCoordinate object is derived from the CompositeValue object. +The following objects are derived (specialisations) from the LocalCoordinate object: +• LocalInternalCoordinate +Usage locations +The LocalCoordinate object can be accessed from the following locations: +• Properties +◦ Mirror object has property Origin. +◦ Rotate object has property Origin. +◦ Translate object has property From. +◦ Translate object has property To. +◦ NamedPoint object has property Point. +◦ CustomAntennaArray object has property Origin. +◦ CablePath object has property ReferenceVector. +◦ PointRefinement object has property Position. +◦ SpiralCross object has property Centre. +◦ Ring object has property Centre. +◦ OpenRing object has property Centre. +◦ SplitRing object has property Centre. +◦ Cross object has property Centre. +◦ StripCross object has property Centre. +◦ Trifilar object has property Centre. +◦ Cone object has property BaseCentre. +◦ Cone object has property TopCentre. +◦ Cuboid object has property Origin. +◦ Cylinder object has property Base. +◦ Cylinder object has property Top. +◦ Ellipse object has property Centre. +◦ EllipticArc object has property Centre. +◦ Flare object has property Base. +◦ Flare object has property Top. +◦ Helix object has property Centre. +◦ Hexagon object has property Centre. +◦ StripHexagon object has property Centre. +◦ HyperbolicArc object has property Centre. +◦ Spin object has property Origin. +◦ Spin object has property AxisDirection. +◦ Split object has property Origin. +◦ Sweep object has property From. +◦ Sweep object has property To. +◦ Line object has property EndPoint. +◦ Line object has property StartPoint. +◦ ParabolicArc object has property Centre. +◦ Paraboloid object has property Base. +◦ Rectangle object has property Origin. +◦ Sphere object has property Centre. +◦ TCross object has property Centre. +◦ FEMModalMeshPort object has property Corner1. +◦ FEMModalMeshPort object has property Corner2. +◦ FEMModalMeshPort object has property Corner3. +◦ FEMModalPort object has property Corner1. +◦ FEMModalPort object has property Corner2. +◦ FEMModalPort object has property Corner3. +◦ AbstractPointSource object has property Position. +◦ ElectricDipole object has property Position. +◦ MagneticDipole object has property Position. +◦ +◦ +ImpressedCurrent object has property StartPosition. +ImpressedCurrent object has property EndPosition. +◦ FarFieldSource object has property Position. +◦ NearFieldSource object has property BoxReferencePoint. +◦ PCBSource object has property Position. +◦ SolutionCoefficientSource object has property Position. +◦ SphericalModeSource object has property Position. +◦ FarFieldReceivingAntenna object has property Position. +◦ NearFieldReceivingAntenna object has property BoxReferencePoint. +◦ SphericalModeReceivingAntenna object has property Position. +◦ PeriodicBoundary object has property StartPoint. +◦ PeriodicBoundary object has property EndPointVectorOne. +◦ PeriodicBoundary object has property EndPointVectorTwo. +◦ NurbsControlPoint object has property Position. +• Methods +◦ LocalCoordinateList object has method Append(). +◦ LocalCoordinateList object has method Get(number). +Property List +The local N coordinate. (Read/Write Dimension) +The local U coordinate. (Read/Write Dimension) +The local V coordinate. (Read/Write Dimension) +Property Details +The local N coordinate. +Type +Dimension +Access +Read/Write +The local U coordinate. +Type +Dimension +Access +Read/Write +The local V coordinate. +Type +Dimension +Access +Read/Write +LocalCoordinateList +A list of LocalCoordinate items. +Method List +Append () +Appends a new item to the list. (Returns a LocalCoordinate object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a LocalCoordinate object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +LocalCoordinate +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +LocalCoordinate +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +LocalInternalCoordinate +p.1067 +Local coordinates typically define positions relative to the coordinate system of a 'LocalWorkplane'. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a fitted spline from a list of LocalInternalCoordinate +points = {} +points[1] = cf.Point(1,0,0) +points[2] = cf.Point(1,1,0) +points[3] = cf.Point(1,1,1) +fittedSpline = project.Contents.Geometry:AddFittedSpline(points) +Inheritance +The LocalInternalCoordinate object is derived from the LocalCoordinate object. +Usage locations +The LocalInternalCoordinate object can be accessed from the following locations: +• Properties +◦ ConstrainedSurfacePoint object has property Normal. +◦ ConstrainedSurfacePoint object has property Position. +• Methods +◦ LocalInternalCoordinateList object has method Append(). +◦ LocalInternalCoordinateList object has method Get(number). +Property List +The local N coordinate. (Read/Write Dimension) +The local U coordinate. (Read/Write Dimension) +The local V coordinate. (Read/Write Dimension) +Property Details +The local N coordinate. +Type +Dimension +Access +Read/Write +The local U coordinate. +Type +Dimension +Access +Read/Write +The local V coordinate. +Type +Dimension +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +LocalInternalCoordinateList +A list of LocalInternalCoordinate items. +Usage locations +p.1069 +The LocalInternalCoordinateList object can be accessed from the following locations: +• Properties +◦ CablePath object has property Corners. +◦ PolylineRefinement object has property Corners. +◦ FittedSpline object has property Points. +◦ +ImprintPoints object has property Points. +◦ Polygon object has property Corners. +◦ Polyline object has property Corners. +◦ SpecifiedRequestPoints object has property Points. +Method List +Append () +Appends a new item to the list. (Returns a LocalInternalCoordinate object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a LocalInternalCoordinate +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +LocalInternalCoordinate +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +LocalInternalCoordinate +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +LocalMeshSettings +p.1071 +Mesh settings that can be applied to root-level geometry or mesh parts. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Add new mesh setting definion +localMeshSettings = + project.Definitions.MeshSettings:Add(cf.Enums.MeshSizeOptionEnum.Standard) +-- Modify mesh settings definition +properties = localMeshSettings:GetProperties() +properties.MeshSizeOption = cf.Enums.MeshSizeOptionEnum.Coarse +properties.WireRadius = "5e-3" +localMeshSettings:SetProperties(properties) +Inheritance +The LocalMeshSettings object is derived from the MeshSettings object. +Usage locations +The LocalMeshSettings object can be accessed from the following locations: +• Methods +◦ MeshSettingsCollection collection has method Add(table). +◦ MeshSettingsCollection collection has method Add(MeshSizeOptionEnum). +◦ MeshSettingsCollection collection has method Item(number). +◦ MeshSettingsCollection collection has method Item(string). +Property List +Advanced +Advanced meshing settings. (Read/Write MeshAdvancedSettings) +Label +The object label. (Read/Write string) +MeshSizeOption +Mesh size option. (Read/Write MeshSizeOptionEnum) +TetrahedronEdgeLength +Mesh tetrahedron edge length. Only applied if MeshSizeOption is Custom and there is at least one +volume in the model. (Read/Write ParametricExpression) +TriangleEdgeLength +Mesh triangle edge length. Only applied if MeshSizeOption is Custom and there is at least one +surface in the model. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +WireRadius +p.1072 +Mesh wire segment radius. Only applied if there is at least one wire in the model. (Read/Write +ParametricExpression) +WireSegmentLength +Mesh wire segment length. Only applied if MeshSizeOption is Custom and there is at least one +wire in the model. (Read/Write ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Advanced +Advanced meshing settings. +Type +MeshAdvancedSettings +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MeshSizeOption +Mesh size option. +Type +MeshSizeOptionEnum +Access +Read/Write +TetrahedronEdgeLength +Mesh tetrahedron edge length. Only applied if MeshSizeOption is Custom and there is at least one +volume in the model. +Type +ParametricExpression +Access +Read/Write +TriangleEdgeLength +Mesh triangle edge length. Only applied if MeshSizeOption is Custom and there is at least one +surface in the model. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +WireRadius +Mesh wire segment radius. Only applied if there is at least one wire in the model. +Type +ParametricExpression +Access +Read/Write +WireSegmentLength +Mesh wire segment length. Only applied if MeshSizeOption is Custom and there is at least one +wire in the model. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.1074 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +LocalWorkplane +The workplane. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a flare +baseCentre = cf.Point(-0.25, -0.25, 0) +flare = project.Contents.Geometry:AddFlare(baseCentre, 0.5, 0.5, 1.0, 0.3, 0.3) + -- Modify the local workplane of the flare +flare.LocalWorkplane.WorkplaneDefinitionOption + = cf.Enums.LocalWorkplaneDefinitionEnum.UseCustomDefinedWorkplane +lwp = flare.LocalWorkplane.LocalDefinedWorkplane +lwp.Origin.X = 1 +lwp.Origin.Z = .3 +lwp.UVector.Y = 1 +lwp.VVector.Z = -2 +Inheritance +The LocalWorkplane object is derived from the CompositeValue object. +Usage locations +The LocalWorkplane object can be accessed from the following locations: +• Properties +◦ GeometryGroup collection has property LocalWorkplane. +◦ Transform object has property LocalWorkplane. +◦ Align object has property DestinationWorkplane. +◦ Align object has property SourceWorkplane. +◦ Align object has property LocalWorkplane. +◦ Mirror object has property LocalWorkplane. +◦ Rotate object has property LocalWorkplane. +◦ Scale object has property LocalWorkplane. +◦ Translate object has property LocalWorkplane. +◦ NamedPoint object has property LocalWorkplane. +◦ Workplane object has property LocalWorkplane. +◦ AbstractAntennaArray object has property LocalWorkplane. +◦ CylindricalAntennaArray object has property LocalWorkplane. +◦ LinearPlanarArray object has property LocalWorkplane. +◦ CustomAntennaArray object has property LocalWorkplane. +◦ Cutplane object has property LocalWorkplane. +◦ CablePath object has property LocalWorkplane. +◦ MeshRefinementRule object has property LocalWorkplane. +◦ AdaptiveRefinement object has property LocalWorkplane. +◦ PointRefinement object has property LocalWorkplane. +◦ PolylineRefinement object has property LocalWorkplane. +◦ Mesh object has property LocalWorkplane. +◦ Geometry object has property LocalWorkplane. +◦ SpiralCross object has property LocalWorkplane. +◦ Ring object has property LocalWorkplane. +◦ OpenRing object has property LocalWorkplane. +◦ SplitRing object has property LocalWorkplane. +◦ Cross object has property LocalWorkplane. +◦ StripCross object has property LocalWorkplane. +◦ Trifilar object has property LocalWorkplane. +◦ AnalyticalCurve object has property LocalWorkplane. +◦ BezierCurve object has property LocalWorkplane. +◦ Cone object has property LocalWorkplane. +◦ ConstrainedSurface object has property LocalWorkplane. +◦ Cuboid object has property LocalWorkplane. +◦ Cylinder object has property LocalWorkplane. +◦ Ellipse object has property LocalWorkplane. +◦ EllipticArc object has property LocalWorkplane. +◦ FittedSpline object has property LocalWorkplane. +◦ Flare object has property LocalWorkplane. +◦ Helix object has property LocalWorkplane. +◦ Hexagon object has property LocalWorkplane. +◦ StripHexagon object has property LocalWorkplane. +◦ HyperbolicArc object has property LocalWorkplane. +◦ +◦ +ImprintPoints object has property LocalWorkplane. +Intersect object has property LocalWorkplane. +◦ Loft object has property LocalWorkplane. +◦ PathSweep object has property LocalWorkplane. +◦ ProjectGeometry object has property LocalWorkplane. +◦ RepairAndSewFaces object has property LocalWorkplane. +◦ RepairPart object has property LocalWorkplane. +◦ Spin object has property LocalWorkplane. +◦ Split object has property LocalWorkplane. +◦ Stitch object has property LocalWorkplane. +◦ Subtract object has property LocalWorkplane. +◦ Sweep object has property LocalWorkplane. +◦ Union object has property LocalWorkplane. +◦ Simplify object has property LocalWorkplane. +◦ Line object has property LocalWorkplane. +◦ NurbsSurface object has property LocalWorkplane. +◦ ParabolicArc object has property LocalWorkplane. +◦ Paraboloid object has property LocalWorkplane. +◦ Polygon object has property LocalWorkplane. +◦ Polyline object has property LocalWorkplane. +◦ Primitive object has property LocalWorkplane. +◦ Rectangle object has property LocalWorkplane. +◦ Sphere object has property LocalWorkplane. +◦ AbstractSurfaceCurve object has property LocalWorkplane. +◦ SurfaceBezierCurve object has property LocalWorkplane. +◦ SurfaceLine object has property LocalWorkplane. +◦ SurfaceRegularLines object has property LocalWorkplane. +◦ TCross object has property LocalWorkplane. +◦ FieldData object has property LocalWorkplane. +◦ SolutionCoefficientData object has property LocalWorkplane. +◦ PCBCurrentData object has property LocalWorkplane. +◦ SphericalModeDataManuallySpecified object has property LocalWorkplane. +◦ SphericalModeDataFromFile object has property LocalWorkplane. +◦ NearFieldDataFullImport object has property LocalWorkplane. +◦ NearFieldDataFileStructure object has property LocalWorkplane. +◦ FarFieldData object has property LocalWorkplane. +◦ AbstractFEMLinePort object has property LocalWorkplane. +◦ FEMLineMeshPort object has property LocalWorkplane. +◦ FEMLinePort object has property LocalWorkplane. +◦ FEMModalMeshPort object has property LocalWorkplane. +◦ FEMModalPort object has property LocalWorkplane. +◦ AbstractIdealSource object has property LocalWorkplane. +◦ AbstractPointSource object has property LocalWorkplane. +◦ ElectricDipole object has property LocalWorkplane. +◦ MagneticDipole object has property LocalWorkplane. +◦ +ImpressedCurrent object has property LocalWorkplane. +◦ FarFieldSource object has property LocalWorkplane. +◦ NearFieldSource object has property LocalWorkplane. +◦ PCBSource object has property LocalWorkplane. +◦ SolutionCoefficientSource object has property LocalWorkplane. +◦ SphericalModeSource object has property LocalWorkplane. +◦ PlaneWave object has property LocalWorkplane. +◦ FarField object has property LocalWorkplane. +◦ BaseFieldReceivingAntenna object has property LocalWorkplane. +◦ FarFieldReceivingAntenna object has property LocalWorkplane. +◦ NearFieldReceivingAntenna object has property LocalWorkplane. +◦ SphericalModeReceivingAntenna object has property LocalWorkplane. +◦ NearField object has property LocalWorkplane. +◦ PeriodicBoundary object has property LocalWorkplane. +◦ ProtectedModel object has property LocalWorkplane. +• Methods +◦ LocalWorkplaneList object has method Append(). +◦ LocalWorkplaneList object has method Get(number). +Property List +LocalDefinedWorkplane +The local defined workplane. (Read/Write GlobalPlane) +ReferencedWorkplane +The referenced workplane. (Read/Write Workplane) +WorkplaneDefinitionOption +Options for defining a workplane. (Read/Write LocalWorkplaneDefinitionEnum) +Property Details +LocalDefinedWorkplane +The local defined workplane. +Type +GlobalPlane +Access +Read/Write +ReferencedWorkplane +The referenced workplane. +Type +Workplane +Access +Read/Write +WorkplaneDefinitionOption +Options for defining a workplane. +Type +LocalWorkplaneDefinitionEnum +Access +Read/Write +LocalWorkplaneList +A list of LocalWorkplane items. +Method List +Append () +Appends a new item to the list. (Returns a LocalWorkplane object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a LocalWorkplane object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +LocalWorkplane +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +LocalWorkplane +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Loft +A loft operator. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create two lines to loft between +line1 = project.Contents.Geometry:AddLine(cf.Point(1, -1, 0), cf.Point(1, 0, 0)) +line2 = project.Contents.Geometry:AddLine(cf.Point(0, 0, 0), cf.Point(0, 0, 0.5)) + -- Create the loft between the two lines +project.Contents.Geometry:Loft(line1, line2) +Inheritance +The Loft object is derived from the Geometry object. +Usage locations +The Loft object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method Loft(Geometry, Geometry). +◦ GeometryCollection collection has method Loft(table). +◦ GeometryCollection collection has method Loft(Geometry, Geometry, boolean). +◦ GeometryCollection collection has method Loft(Geometry, Geometry, table). +◦ GeometryCollection collection has method LoftEdges(Edge, Edge). +◦ GeometryCollection collection has method LoftEdges(Edge, Edge, table). +◦ GeometryCollection collection has method LoftFaces(Face, Face). +◦ GeometryCollection collection has method LoftFaces(Face, Face, table). +Property List +AlignmentIndex +The index determines the vertex association between the loft profiles. Only applicable for closed +edges and faces. (Read/Write number) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ChildReferences +The geometry items to be transformed. (Read/Write ObjectReferenceList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +LocalMeshSettingsEnabled +p.1083 +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Reversed +Reverse the orientation of the loft operations. (Read/Write boolean) +Type +The object type string. (Read only string) +Collection List +Children +The collection of child operators of the operator. (OperatorCollection of Geometry.) +The collection of edges of the operator. (EdgeCollection of Edge.) +Edges +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AlignmentIndex +The index determines the vertex association between the loft profiles. Only applicable for closed +edges and faces. +Type +number +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ChildReferences +The geometry items to be transformed. +Type +ObjectReferenceList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Reversed +Reverse the orientation of the loft operations. +Type +boolean +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Children +The collection of child operators of the operator. +Type +OperatorCollection +The collection of edges of the operator. +Type +EdgeCollection +Edges +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +p.1090 +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MLFMMACASettings +MLFMM / ACA solver settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Activate the MLFMM solver +project.Contents.SolutionSettings.SolverSettings.MLFMMACASettings.ModelSolutionSolveType + = + cf.Enums.ModelSolutionSolveTypeEnum.MLFMM +Inheritance +The MLFMMACASettings object is derived from the CompositeValue object. +Usage locations +The MLFMMACASettings object can be accessed from the following locations: +• Properties +◦ SolverSettings object has property MLFMMACASettings. +• Methods +◦ MLFMMACASettingsList object has method Append(). +◦ MLFMMACASettingsList object has method Get(number). +Property List +MLFMMSettings +MLFMM solver settings. Only valid if ModelSolutionSolveType is MLFMM. (Read/Write +MLFMMSolverSettings) +ModelSolutionSolveType +Activates the MLFMM or ACA solvers, specified by ModelSolutionSolveTypeEnum, eg. None, +MLFMM, etc. (Read/Write ModelSolutionSolveTypeEnum) +Property Details +MLFMMSettings +MLFMM solver settings. Only valid if ModelSolutionSolveType is MLFMM. +Type +MLFMMSolverSettings +Access +Read/Write +ModelSolutionSolveType +Activates the MLFMM or ACA solvers, specified by ModelSolutionSolveTypeEnum, eg. None, +MLFMM, etc. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +ModelSolutionSolveTypeEnum +Access +Read/Write +p.1092 +Altair Feko 2022.3 +2 Application Programming Interface (API) +MLFMMACASettingsList +A list of MLFMMACASettings items. +Method List +Append () +p.1093 +Appends a new item to the list. (Returns a MLFMMACASettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a MLFMMACASettings object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +MLFMMACASettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +MLFMMACASettings +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MLFMMSolverSettings +MLFMM solver settings. +Example +p.1095 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Keep a local reference to the 'MLFMMACASettings' for readability +settings = project.Contents.SolutionSettings.SolverSettings.MLFMMACASettings + -- Active the MLFMM solver +settings.ModelSolutionSolveType = cf.Enums.ModelSolutionSolveTypeEnum.MLFMM + -- Modify the far field calculation method +settings.MLFMMSettings.FarFieldCalculationMethod = + cf.Enums.MLFMMFarFieldCalculationMethodEnum.TraditionalIntegrationScheme +Inheritance +The MLFMMSolverSettings object is derived from the CompositeValue object. +Usage locations +The MLFMMSolverSettings object can be accessed from the following locations: +• Properties +◦ MLFMMACASettings object has property MLFMMSettings. +• Methods +◦ MLFMMSolverSettingsList object has method Append(). +◦ MLFMMSolverSettingsList object has method Get(number). +Property List +BoxSizeSpecificationType +Specifies whether the default box size should be used or whether it is specified manually, +specified by BoxSizeSpecificationTypeEnum, eg. Default or SpecifiedManually. (Read/Write +BoxSizeSpecificationTypeEnum) +FarFieldCalculationMethod +The far field calculation method, specified by MLFMMFarFieldCalculationMethodEnum, eg. Default +or TraditionalIntegrationScheme. (Read/Write MLFMMFarFieldCalculationMethodEnum) +ManuallySpecifiedBoxSize +Box size in wave lengths. Only valid if BoxSizeSpecificationType is SpecifiedManually. (Read/Write +ParametricExpression) +NearFieldCalculationMethod +The near field calculation method, specified by MLFMMNearFieldCalculationMethodEnum, eg. +Default or TraditionalIntegrationScheme. (Read/Write MLFMMNearFieldCalculationMethodEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property Details +BoxSizeSpecificationType +p.1096 +Specifies whether the default box size should be used or whether it is specified manually, specified +by BoxSizeSpecificationTypeEnum, eg. Default or SpecifiedManually. +Type +BoxSizeSpecificationTypeEnum +Access +Read/Write +FarFieldCalculationMethod +The far field calculation method, specified by MLFMMFarFieldCalculationMethodEnum, eg. Default +or TraditionalIntegrationScheme. +Type +MLFMMFarFieldCalculationMethodEnum +Access +Read/Write +ManuallySpecifiedBoxSize +Box size in wave lengths. Only valid if BoxSizeSpecificationType is SpecifiedManually. +Type +ParametricExpression +Access +Read/Write +NearFieldCalculationMethod +The near field calculation method, specified by MLFMMNearFieldCalculationMethodEnum, eg. +Default or TraditionalIntegrationScheme. +Type +MLFMMNearFieldCalculationMethodEnum +Access +Read/Write +MLFMMSolverSettingsList +A list of MLFMMSolverSettings items. +Method List +Append () +Appends a new item to the list. (Returns a MLFMMSolverSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a MLFMMSolverSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +MLFMMSolverSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +MLFMMSolverSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1098 +Altair Feko 2022.3 +2 Application Programming Interface (API) +MagneticDipole +p.1099 +A magnetic dipole source can be either an electric ring current or a magnetic line current. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a magnetic dipole +magneticDipole = + project.Contents.SolutionConfigurations.GlobalSources:AddMagneticDipole(cf.Point(0,0,0),0,0) +Inheritance +The MagneticDipole object is derived from the AbstractPointSource object. +Usage locations +The MagneticDipole object can be accessed from the following locations: +• Methods +◦ SourceCollection collection has method AddMagneticDipole(table). +◦ SourceCollection collection has method AddMagneticDipole(Point, Expression, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Magnitude +The source magnitude. (Read/Write ParametricExpression) +Phase +Phi +The source phase (degrees). (Read/Write ParametricExpression) +The phi angle (degrees). (Read/Write ParametricExpression) +Position +The position of the source. (Read/Write LocalCoordinate) +SourceType +The magnetic source type. (Read/Write MagneticDipoleCurrentTypeEnum) +Theta +The theta angle (degrees). (Read/Write ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Collection List +Transforms +p.1100 +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Magnitude +The source magnitude. +Phase +Phi +Type +ParametricExpression +Access +Read/Write +The source phase (degrees). +Type +ParametricExpression +Access +Read/Write +The phi angle (degrees). +Type +ParametricExpression +Access +Read/Write +Position +The position of the source. +Type +LocalCoordinate +Access +Read/Write +SourceType +The magnetic source type. +Type +MagneticDipoleCurrentTypeEnum +Access +Read/Write +Theta +The theta angle (degrees). +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MagneticFrequencyPoint +The magnetic modelling frequency point properties. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +dielectric = project.Definitions.Media.Dielectric:AddDielectric() +properties = dielectric:GetProperties() +properties.MagneticModelling.DefinitionMethod = + cf.Enums.MediumMagneticDefinitionMethodEnum.FrequencyList +properties.MagneticModelling.FrequencyPoints[1].Frequency = 1e3 +properties.MagneticModelling.FrequencyPoints[1].RelativePermeability = 1.0 +properties.MagneticModelling.FrequencyPoints[1].LossTangent = 1e7 +dielectric:SetProperties(properties) + -- Modify the frequency of the first magnetic modelling frequency point +magneticFrequencyPoint = dielectric.MagneticModelling.FrequencyPoints[1] +magneticFrequencyPoint.Frequency = 1.5e3 +Inheritance +The MagneticFrequencyPoint object is derived from the CompositeValue object. +Usage locations +The MagneticFrequencyPoint object can be accessed from the following locations: +• Methods +◦ MagneticFrequencyPointList object has method Append(). +◦ MagneticFrequencyPointList object has method Get(number). +Property List +Frequency +Magnetic frequency value (Hz). (Read/Write ParametricExpression) +LossTangent +Magnetic loss tangent value. (Read/Write ParametricExpression) +RelativePermeability +Magnetic relative permittivity value. (Read/Write ParametricExpression) +Property Details +Frequency +Magnetic frequency value (Hz). +Type +ParametricExpression +Access +Read/Write +LossTangent +Magnetic loss tangent value. +Type +ParametricExpression +Access +Read/Write +RelativePermeability +Magnetic relative permittivity value. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +MagneticFrequencyPointList +A list of MagneticFrequencyPoint items. +Usage locations +p.1107 +The MagneticFrequencyPointList object can be accessed from the following locations: +• Properties +◦ MagneticModelling object has property FrequencyPoints. +Method List +Append () +Appends a new item to the list. (Returns a MagneticFrequencyPoint object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a MagneticFrequencyPoint +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +MagneticFrequencyPoint +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +MagneticFrequencyPoint +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +MagneticModelling +Magnetic modelling properties. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +dielectric = project.Definitions.Media.Dielectric:AddDielectric() + -- Modify the dielectric to use frequency independent magnetic modelling +dielectric.MagneticModelling.DefinitionMethod = + cf.Enums.MediumMagneticDefinitionMethodEnum.FrequencyIndependent +Inheritance +The MagneticModelling object is derived from the CompositeValue object. +Usage locations +The MagneticModelling object can be accessed from the following locations: +• Properties +◦ Dielectric object has property MagneticModelling. +◦ FreeSpace object has property MagneticModelling. +◦ GroundPlaneMedium object has property MagneticModelling. +◦ Zero object has property MagneticModelling. +◦ DielectricBoundaryMedium object has property MagneticModelling. +• Methods +◦ MagneticModellingList object has method Append(). +◦ MagneticModellingList object has method Get(number). +Property List +DefinitionMethod +Magnetic definition method. (Read/Write MediumMagneticDefinitionMethodEnum) +FrequencyPoints +The collection of linear interpolated frequency points of magnetic properties. Only applicable if +MagneticModelling DefinitionMethod is FrequencyList. (Read/Write MagneticFrequencyPointList) +LossTangent +Medium's loss tangent. Only applicable if MagneticModelling DefinitionMethod is +FrequencyIndependent. (Read/Write ParametricExpression) +RelativePermeability +Medium's relative permittivity. Only applicable if MagneticModelling DefinitionMethod is +FrequencyIndependent. (Read/Write ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property Details +DefinitionMethod +Magnetic definition method. +Type +MediumMagneticDefinitionMethodEnum +Access +Read/Write +FrequencyPoints +p.1110 +The collection of linear interpolated frequency points of magnetic properties. Only applicable if +MagneticModelling DefinitionMethod is FrequencyList. +Type +MagneticFrequencyPointList +Access +Read/Write +LossTangent +Medium's loss tangent. Only applicable if MagneticModelling DefinitionMethod is +FrequencyIndependent. +Type +ParametricExpression +Access +Read/Write +RelativePermeability +Medium's relative permittivity. Only applicable if MagneticModelling DefinitionMethod is +FrequencyIndependent. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +MagneticModellingList +A list of MagneticModelling items. +Method List +Append () +p.1111 +Appends a new item to the list. (Returns a MagneticModelling object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a MagneticModelling object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +MagneticModelling +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +MagneticModelling +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +MainWindow +The main window of the application. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a large cuboid +cube = project.Contents.Geometry:AddCuboid(cf.Point(0,0,0), 10, 10, 10) + -- Get the first view +view1 = application.MainWindow.MdiArea[1] + -- Zoom to extents on the view +view1.ViewWindow.View:ZoomToExtents() +Inheritance +The MainWindow object is derived from the Object object. +Usage locations +The MainWindow object can be accessed from the following locations: +• Properties +◦ Application object has property MainWindow. +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Collection List +MdiArea +The collection of views in the application. (MdiArea of MdiSubWindow.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1114 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +MdiArea +The collection of views in the application. +Type +MdiArea +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1115 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ManuallySpecifiedOrDerivedValue +p.1116 +A ManuallySpecifiedOrDerivedValue is a value that can be specified by a user or calculated +automatically. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a cable bundle cross section +bundledCables = +{ +project.Definitions.Cables.CrossSections["SingleConductor1"], +project.Definitions.Cables.CrossSections["TwistedPair1"] +} +bundle = +project.Definitions.Cables.CrossSections:AddBundle(bundledCables) + -- Apply a sheath around the bundle +properties = bundle:GetProperties() +properties.ShieldType = cf.Enums.CableBundleShieldTypeEnum.InBackgroundMedium +properties.OuterRadius = "0.005" +properties.InsulationMedium = project.Definitions.Media.Dielectric["Insulation"] +bundle:SetProperties(properties) +Inheritance +The ManuallySpecifiedOrDerivedValue object is derived from the CompositeValue object. +Usage locations +The ManuallySpecifiedOrDerivedValue object can be accessed from the following locations: +• Properties +◦ CableBundleCrossSection object has property OuterRadius. +• Methods +◦ ManuallySpecifiedOrDerivedValueList object has method Append(). +◦ ManuallySpecifiedOrDerivedValueList object has method Get(number). +Property List +DerivedDoubleValue +The calculated value. (Read only number) +ManuallySpecifiedExpression +The user specified expression. (Read/Write ParametricExpression) +Property Details +DerivedDoubleValue +The calculated value. +Type +number +Access +Read only +ManuallySpecifiedExpression +The user specified expression. +Type +ParametricExpression +Access +Read/Write +ManuallySpecifiedOrDerivedValueList +A list of ManuallySpecifiedOrDerivedValue items. +Method List +Append () +Appends a new item to the list. (Returns a ManuallySpecifiedOrDerivedValue object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +ManuallySpecifiedOrDerivedValue object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +ManuallySpecifiedOrDerivedValue +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +ManuallySpecifiedOrDerivedValue +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1119 +MdiSubWindow +A 3D model view window. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a large cuboid +cube = project.Contents.Geometry:AddCuboid(cf.Point(0,0,0), 10, 10, 10) + -- Get the first view +view1 = application.MainWindow.MdiArea[1] + -- Zoom to extents on the view +view1.ViewWindow.View:ZoomToExtents() +Inheritance +The MdiSubWindow object is derived from the Object object. +Property List +Height +The height of the view window. (Read/Write number) +Label +Type +Width +The object label. (Read/Write string) +The object type string. (Read only string) +The width of the view window. (Read/Write number) +WindowActive +True if this window is the active window. (Read only boolean) +XPosition +The X position of the view window. (Read/Write number) +YPosition +The Y position of the view window. (Read/Write number) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1121 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Maximise () +Maximise the view window. +Minimise () +Minimise the view window. +Restore () +Restore the view window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSize (imagewidth number, imageheight number) +Sets the view window size. Note that the view is restored when this function is called. +Show () +Shows the view window. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Height +The height of the view window. +Type +number +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Width +The width of the view window. +Type +number +Access +Read/Write +WindowActive +True if this window is the active window. +Type +boolean +Access +Read only +XPosition +The X position of the view window. +Type +number +Access +Read/Write +YPosition +The Y position of the view window. +Type +number +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1123 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Maximise () +Maximise the view window. +Minimise () +Minimise the view window. +Restore () +Restore the view window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +Input Parameters +xposition(number) +The view window X position. +yposition(number) +The view window Y position. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSize (imagewidth number, imageheight number) +Sets the view window size. Note that the view is restored when this function is called. +Input Parameters +imagewidth(number) +The view window width in pixels. +imageheight(number) +The view window height in pixels. +Show () +Shows the view window. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Media +The media section of the definitions of the CADFEKO model. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a dielectric to the project media +project.Definitions.Media.Dielectric:AddDielectric() +Inheritance +The Media object is derived from the Object object. +Usage locations +The Media object can be accessed from the following locations: +• Properties +◦ ModelDefinitions object has property Media. +Property List +DefaultMedium +A non-physical medium that can be applied to a face or region. It allows the properties to be +inferred from the surrounding face or region settings. (Read only DefaultMedium) +DielectricBoundaryMedium +A non-physical medium that can be applied to a face to describe the separation between two +dielectric regions. (Read only DielectricBoundaryMedium) +FreeSpace +The standard free space medium. (Read only FreeSpace) +GroundPlaneMedium +The finite ground plane medium. Only applies if a Planar multilayer substrate has been defined. +(Read only GroundPlaneMedium) +Label +The object label. (Read/Write string) +PerfectElectricConductor +The standard perfect electric conductor medium. (Read only PerfectElectricConductor) +PerfectMagneticConductor +The standard perfect magnetic conductor medium. (Read only PerfectMagneticConductor) +Type +The object type string. (Read only string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Zero +p.1126 +A non-physical medium that can be used with 3D anisotropic media. It represents no coupling to +the particular tensor component. (Read only Zero) +Collection List +AnisotropicDielectric +The 3D anisotropic media. (AnisotropicDielectricCollection of AnisotropicDielectric.) +CharacterisedSurface +The characterised surface media. (CharacterisedSurfaceCollection of CharacterisedSurface.) +Dielectric +The dielectric media. (DielectricCollection of Dielectric.) +ImpedanceSheet +The impedance sheet media. (ImpedanceSheetCollection of ImpedanceSheet.) +LayeredDielectric +he layered dielectric media. (LayeredDielectricCollection of LayeredDielectric.) +Metallic +The non-default metallic media. (MetalCollection of Metal.) +Windscreen +The windscreen media. (WindscreenCollection of Windscreen.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +DefaultMedium +A non-physical medium that can be applied to a face or region. It allows the properties to be +inferred from the surrounding face or region settings. +Type +DefaultMedium +Access +Read only +DielectricBoundaryMedium +A non-physical medium that can be applied to a face to describe the separation between two +dielectric regions. +Type +DielectricBoundaryMedium +Access +Read only +FreeSpace +The standard free space medium. +Type +FreeSpace +Access +Read only +GroundPlaneMedium +The finite ground plane medium. Only applies if a Planar multilayer substrate has been defined. +Type +GroundPlaneMedium +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +PerfectElectricConductor +The standard perfect electric conductor medium. +Type +PerfectElectricConductor +Access +Read only +PerfectMagneticConductor +The standard perfect magnetic conductor medium. +Type +PerfectMagneticConductor +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Zero +A non-physical medium that can be used with 3D anisotropic media. It represents no coupling to +the particular tensor component. +Type +Zero +Access +Read only +Collection Details +AnisotropicDielectric +The 3D anisotropic media. +Type +AnisotropicDielectricCollection +CharacterisedSurface +The characterised surface media. +Type +CharacterisedSurfaceCollection +Dielectric +The dielectric media. +Type +DielectricCollection +ImpedanceSheet +The impedance sheet media. +Type +ImpedanceSheetCollection +LayeredDielectric +he layered dielectric media. +Type +Metallic +LayeredDielectricCollection +The non-default metallic media. +Type +MetalCollection +Windscreen +The windscreen media. +Type +WindscreenCollection +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Medium +A medium. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a dielectric medium +dielectric = project.Definitions.Media.Dielectric:AddDielectric(2.16, 0.001, 1000) + -- Delete the dielectric medium +dielectric:Delete() +Inheritance +The Medium object is derived from the Object object. +The following objects are derived (specialisations) from the Medium object: +• AnisotropicDielectric +• CharacterisedSurface +• DefaultMedium +• Dielectric +• DielectricBoundaryMedium +• ImpedanceSheet +• LayeredDielectric +• Metal +• PerfectElectricConductor +• PerfectMagneticConductor +• Windscreen +Usage locations +The Medium object can be accessed from the following locations: +• Properties +◦ CableBundleCrossSection object has property InsulationMedium. +◦ CableBundleCrossSection object has property CoatingMedium. +◦ CableCoaxialCrossSection object has property CoreMedium. +◦ CableCoaxialCrossSection object has property CoatingMedium. +◦ CableNonConductingElementCrossSection object has property FibreMedium. +◦ CableRibbonCrossSection object has property CoreMedium. +◦ CableRibbonCrossSection object has property InsulationMedium. +◦ CableSingleConductorCrossSection object has property CoreMedium. +◦ CableSingleConductorCrossSection object has property InsulationMedium. +◦ CableTwistedPairCrossSection object has property CoreMedium. +◦ CableTwistedPairCrossSection object has property InsulationMedium. +◦ MeshCurvilinearTriangleFace object has property MeshBackMedium. +◦ MeshCurvilinearTriangleFace object has property MeshFrontMedium. +◦ MeshCurvilinearTriangleFace object has property Medium. +◦ MeshCurvilinearTriangleFace object has property Coating. +◦ MeshTriangleFace object has property Medium. +◦ MeshTriangleFace object has property Coating. +◦ MeshCurvilinearSegmentWire object has property SurroundingMedium. +◦ MeshCurvilinearSegmentWire object has property CoreMedium. +◦ MeshCurvilinearSegmentWire object has property Coating. +◦ MeshSegmentWire object has property SurroundingMedium. +◦ MeshSegmentWire object has property CoreMedium. +◦ MeshSegmentWire object has property Coating. +◦ MeshPlate object has property Medium. +◦ MeshPlate object has property Coating. +◦ MeshTetrahedronRegion object has property Medium. +◦ MeshTetrahedronRegion object has property SolutionMedium. +◦ Edge object has property SurroundingMedium. +◦ Edge object has property CoreMedium. +◦ Edge object has property Coating. +◦ Face object has property Medium. +◦ Face object has property Coating. +◦ Region object has property Medium. +◦ Region object has property SolutionMedium. +◦ TransmissionLine object has property Medium. +◦ GroundPlane object has property Medium. +◦ SAR object has property SpecifiedMedium. +◦ LibraryMedium object has property Medium. +◦ ShieldLayerSettings object has property FilamentMedium. +◦ ShieldLayerSettings object has property ShieldMedium. +◦ ShieldLayerSettings object has property InsideBraidFixingMedium. +◦ ShieldLayerSettings object has property OutsideBraidFixingMedium. +• Methods +◦ MediaLibrary collection has method AddToModel(string). +◦ MediaLibrary collection has method AddToModelWithLabel(string, string). +Property List +Colour +The medium colour. (Read/Write string) +The object label. (Read/Write string) +Label +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Mesh +An editable mesh object. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +sphere = project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1) +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e06" +project.Mesher:Mesh() +sphere:UnlinkMesh() + -- Delete the created mesh +mesh = project.Contents.Meshes[1] +mesh:Delete() +Inheritance +The Mesh object is derived from the Object object. +Usage locations +The Mesh object can be accessed from the following locations: +• Properties +• Methods +◦ CollectionOf_Mesh collection has method Item(number). +◦ CollectionOf_Mesh collection has method Item(string). +◦ Mesh object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Mesh object has method Replace(Mesh). +◦ MeshFind object has method GetIntersectingMeshes(). +◦ MeshFind object has method GetIntersectingMeshes(List of Mesh). +◦ Geometry object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ SpiralCross object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Ring object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ OpenRing object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ SplitRing object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Cross object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ StripCross object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Trifilar object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ AnalyticalCurve object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ BezierCurve object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Cone object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ ConstrainedSurface object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Cuboid object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Cylinder object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Ellipse object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ EllipticArc object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ FittedSpline object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Flare object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Helix object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Hexagon object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ StripHexagon object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ HyperbolicArc object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ +◦ +ImprintPoints object has method UnlinkMesh(UnlinkMeshOptionEnum). +Intersect object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Loft object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ PathSweep object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ ProjectGeometry object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ RepairAndSewFaces object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ RepairPart object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Spin object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Split object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Stitch object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Subtract object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Sweep object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Union object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Simplify object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Line object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ NurbsSurface object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ ParabolicArc object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Paraboloid object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Polygon object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Polyline object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Primitive object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Rectangle object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ Sphere object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ AbstractSurfaceCurve object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ SurfaceBezierCurve object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ SurfaceLine object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ SurfaceRegularLines object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ TCross object has method UnlinkMesh(UnlinkMeshOptionEnum). +◦ MeshImporter object has method Import(string). +◦ Mesher object has method UnlinkMeshes(List of Object). +◦ Mesher object has method UnlinkMeshes(List of Object, UnlinkMeshOptionEnum). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Type +The object type string. (Read only string) +Collection List +CurvilinearFaces +The collection of faces meshed with curvilinear triangles. The faces form part of the mesh model. +(MeshCurvilinearTriangleFaceCollection of MeshCurvilinearTriangleFace.) +CurvilinearWires +The collection of wires meshed with curvilinear segments. The wires form part of the mesh model. +(MeshSegmentCurvilinearWireCollection of MeshCurvilinearWire.) +Cylinders +The collection of unmeshed cylinders that form part of the mesh model. (MeshCylinderCollection +of MeshCylinder.) +Faces +Plates +The collection of faces meshed with flat triangles. The faces form part of the mesh model. +(MeshTriangleFaceCollection of MeshTriangleFace.) +The collection of unmeshed plates that form part of the mesh model. (MeshPlateCollection of +MeshPlate.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires meshed with segments. The wires form part of the mesh model. +(MeshSegmentWireCollection of MeshWire.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method List +p.1137 +AddTriangle (face MeshTriangleFace, vertex1 Point, vertex2 Point, vertex3 Point) +Adds a mesh triangle to an existing mesh face. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +CreateTriangle (vertex1 Point, vertex2 Point, vertex3 Point) +Creates a mesh triangle in a new mesh face. (Returns a MeshTriangleFace object.) +Delete () +Deletes the entity. +DeleteSegments (segments List of MeshSegmentReference) +Delete segments from a mesh. +DeleteTriangles (triangles List of MeshTriangleReference) +Delete triangles from a mesh. +DeleteVertices (vertices List of MeshVertexReference, vertex MeshVertexReference) +Delete mesh vertices and merge to a common vertex. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ModifySegmentRadius (segment MeshSegmentReference, radius number) +Modify the radius of a mesh segment. +ModifyVertex (vertex MeshVertexReference, position Point) +Modify the position of a mesh vertex. +Replace (replacementMesh Mesh) +Replace the the mesh with another mesh transferring the properties and ports to the new mesh. +(Returns a Mesh object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +CurvilinearFaces +The collection of faces meshed with curvilinear triangles. The faces form part of the mesh model. +Type +MeshCurvilinearTriangleFaceCollection +CurvilinearWires +The collection of wires meshed with curvilinear segments. The wires form part of the mesh model. +Type +Cylinders +MeshSegmentCurvilinearWireCollection +The collection of unmeshed cylinders that form part of the mesh model. +Type +MeshCylinderCollection +Faces +The collection of faces meshed with flat triangles. The faces form part of the mesh model. +Type +Plates +MeshTriangleFaceCollection +The collection of unmeshed plates that form part of the mesh model. +Type +MeshPlateCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires meshed with segments. The wires form part of the mesh model. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +MeshSegmentWireCollection +Method Details +AddTriangle (face MeshTriangleFace, vertex1 Point, vertex2 Point, vertex3 Point) +Adds a mesh triangle to an existing mesh face. +Input Parameters +face(MeshTriangleFace) +The mesh face that the triangle should be added to. +p.1140 +vertex1(Point) +The first vertex of the triangle. +vertex2(Point) +The second vertex of the triangle. +vertex3(Point) +The third vertex of the triangle. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +CreateTriangle (vertex1 Point, vertex2 Point, vertex3 Point) +Creates a mesh triangle in a new mesh face. +Input Parameters +vertex1(Point) +The first vertex of the triangle. +vertex2(Point) +The first vertex of the triangle. +vertex3(Point) +The first vertex of the triangle. +Return +MeshTriangleFace +Returns a mesh triangle. +Delete () +Deletes the entity. +DeleteSegments (segments List of MeshSegmentReference) +Delete segments from a mesh. +Input Parameters +segments(List of MeshSegmentReference) +The list of segments to be deleted. +DeleteTriangles (triangles List of MeshTriangleReference) +Delete triangles from a mesh. +Input Parameters +triangles(List of MeshTriangleReference) +The list of triangles to be deleted. +DeleteVertices (vertices List of MeshVertexReference, vertex MeshVertexReference) +Delete mesh vertices and merge to a common vertex. +Input Parameters +vertices(List of MeshVertexReference) +Vertices that will be deleted. +vertex(MeshVertexReference) +Vertex that will be merged to. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ModifySegmentRadius (segment MeshSegmentReference, radius number) +Modify the radius of a mesh segment. +Input Parameters +segment(MeshSegmentReference) +The segment to be modified. +radius(number) +The radius to set the segment to. +ModifyVertex (vertex MeshVertexReference, position Point) +Modify the position of a mesh vertex. +Input Parameters +vertex(MeshVertexReference) +The vertex to be modified. +position(Point) +The new position of the vertex. +Replace (replacementMesh Mesh) +Replace the the mesh with another mesh transferring the properties and ports to the new mesh. +Input Parameters +replacementMesh(Mesh) +The target replacement mesh. +Return +Mesh +The resulting mesh. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +p.1144 +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MeshAdvancedSettings +Properties controlling advanced mesh creation. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e06" + -- Obtain the 'MeshAdvancedSettings' +advancedMeshSettings = project.Mesher.Settings.Advanced + -- Set the 'GrowthRate' to 20.0 +advancedMeshSettings.GrowthRate = 20.0 + -- Create geometry and mesh +project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1) +project.Mesher:Mesh() +Inheritance +The MeshAdvancedSettings object is derived from the CompositeValue object. +Usage locations +The MeshAdvancedSettings object can be accessed from the following locations: +• Properties +◦ MeshSettings object has property Advanced. +◦ LocalMeshSettings object has property Advanced. +◦ GlobalMeshSettings object has property Advanced. +• Methods +◦ MeshAdvancedSettingsList object has method Append(). +◦ MeshAdvancedSettingsList object has method Get(number). +Property List +CurvilinearSegments +Control the use of wire segment curvilinear meshing. (Read/Write MeshCurvilinearOptionsEnum) +CurvilinearTriangles +Control the use of triangular curvilinear meshing. (Read/Write MeshCurvilinearOptionsEnum) +ElongatedTrianglesAllowed +Allow use of long, thin triangles where required. (Read/Write boolean) +GrowthRate +Controls how quickly the mesh size changes. A dimensionless number in the range [0 (Slow), 100 +(Fast)], rounded to the nearest 20. (Read/Write number) +Altair Feko 2022.3 +2 Application Programming Interface (API) +InsufficientMemoryProtectionEnabled +p.1146 +Stops meshing if there is insufficient memory based on the estimated requirements. (Read/Write +boolean) +MinElementSize +A lower limit on the size of mesh refinements compared to the average edge length of the part. A +dimensionless number in the range [0 (Small),100 (Medium)]. (Read/Write number) +RefinementFactor +Controls how closely mesh conforms to geometry. A dimensionless number in the range [0 (Fine), +100 (Coarse)]. (Read/Write number) +SmallGeometrySuppression +Control how small geometry details are handled. (Read/Write MeshSmallGeometryOptionsEnum) +SmallGeometryThreshold +Specifies the limit of what is considered a small geometry feature as a percentage of the size of +the part that it belongs to (%). (Read/Write ParametricExpression) +SmoothingEnabled +If enabled, an additional smoothing algorithm is applied which increases mesh quality but also +meshing time. (Read/Write boolean) +Property Details +CurvilinearSegments +Control the use of wire segment curvilinear meshing. +Type +MeshCurvilinearOptionsEnum +Access +Read/Write +CurvilinearTriangles +Control the use of triangular curvilinear meshing. +Type +MeshCurvilinearOptionsEnum +Access +Read/Write +ElongatedTrianglesAllowed +Allow use of long, thin triangles where required. +Type +boolean +Access +Read/Write +GrowthRate +Controls how quickly the mesh size changes. A dimensionless number in the range [0 (Slow), 100 +(Fast)], rounded to the nearest 20. +Type +number +Access +Read/Write +InsufficientMemoryProtectionEnabled +Stops meshing if there is insufficient memory based on the estimated requirements. +Type +boolean +Access +Read/Write +MinElementSize +A lower limit on the size of mesh refinements compared to the average edge length of the part. A +dimensionless number in the range [0 (Small),100 (Medium)]. +Type +number +Access +Read/Write +RefinementFactor +Controls how closely mesh conforms to geometry. A dimensionless number in the range [0 (Fine), +100 (Coarse)]. +Type +number +Access +Read/Write +SmallGeometrySuppression +Control how small geometry details are handled. +Type +MeshSmallGeometryOptionsEnum +Access +Read/Write +SmallGeometryThreshold +Specifies the limit of what is considered a small geometry feature as a percentage of the size of +the part that it belongs to (%). +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SmoothingEnabled +p.1148 +If enabled, an additional smoothing algorithm is applied which increases mesh quality but also +meshing time. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshAdvancedSettingsList +A list of MeshAdvancedSettings items. +Method List +Append () +p.1149 +Appends a new item to the list. (Returns a MeshAdvancedSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a MeshAdvancedSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +MeshAdvancedSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +MeshAdvancedSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1150 +MeshCurvilinearSegmentWire +A mesh entity representing a wire meshed using curvilinear segments. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Settings for curvilinear meshing +project.Contents.SolutionSettings.SolverSettings.GeneralSettings.BasisFunctionSettings.HOBFEnabled + = true +advancedMeshSettings = project.Mesher.Settings.Advanced +advancedMeshSettings.CurvilinearSegments + = cf.Enums.MeshCurvilinearOptionsEnum.Enabled +advancedMeshSettings.CurvilinearTriangles + = cf.Enums.MeshCurvilinearOptionsEnum.Disabled +frequency = project.Contents.SolutionConfigurations.GlobalFrequency +frequency.Start = "1e08" + -- Create geometry and mesh +project.Contents.Geometry:AddHelix(cf.Point(0,0,0), 0.1, 0.1, 1.0, 5.0, false) +project.Mesher.Settings.WireRadius = "0.01" +project.Mesher:Mesh() +project.Contents.Geometry["Helix1"]:UnlinkMesh() +meshCurvilinearSegmentWires = project.Contents.Meshes["Helix1_1"].CurvilinearWires + -- Obtain a 'MeshCurvilinearSegmentWire' +meshCurvilinearSegmentWire = meshCurvilinearSegmentWires["Wire1"] + -- Set the radius on all the segments +meshCurvilinearSegmentWire:SetRadiusOnAllSegments(0.1) +Inheritance +The MeshCurvilinearSegmentWire object is derived from the MeshCurvilinearWire object. +Property List +AllowDifferentSegmentRadii +Allow modification of radii per segment. (Read/Write boolean) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Coating +The wire (free edge) coating specified by a predefined Layered dielectric medium. Changing this +property will set CoatingEnabled to true. Only applicable for wires (free edges). (Read/Write +Medium) +Altair Feko 2022.3 +2 Application Programming Interface (API) +CoatingEnabled +p.1152 +Specifies if a coating should be applied to the wire.Only applicable for wires (free edges). (Read/ +Write boolean) +CoreMedium +The wire core medium.Only applicable for wires (free edges). (Read/Write Medium) +EdgeType +The type of edge. (Read only GeometryEdgeEnum) +Label +The object label. (Read/Write string) +Length +The accumulative length of all the segments of the wire. (Read only number) +LocalIntrinsicWireRadiusEnabled +Specifies if the local intrinsic wire radius should be used for the wire. Only applicable for wires +(free edges). (Read/Write boolean) +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. (Read/Write ParametricExpression) +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. (Read/Write boolean) +LocalWireRadius +The local radius for the wire. Changing this property will set LocalWireRadiusEnabled to true. Only +applicable for wires (free edges). (Read/Write ParametricExpression) +LocalWireRadiusEnabled +Specifies if the local wire radius should be used for the wire. Only applicable for wires (free +edges). (Read/Write boolean) +SolutionMethod +The local solution method used for the wire. (Read/Write EdgeSolutionMethodEnum) +SurroundingMedium +The surrounding region medium. (Read/Write Medium) +Type +The object type string. (Read only string) +Windscreen +The windscreen solution method settings for the wire. Only applies if the SolutionMethod is set to +Windscreen. (Read/Write WindscreenSolutionMethod) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1153 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetRadiusOnAllSegments (radius Expression) +Set the segment radius. This is a helper method to update the Radius property on all the +segments simultaneously. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AllowDifferentSegmentRadii +Allow modification of radii per segment. +Type +boolean +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Coating +The wire (free edge) coating specified by a predefined Layered dielectric medium. Changing this +property will set CoatingEnabled to true. Only applicable for wires (free edges). +Type +Medium +Access +Read/Write +CoatingEnabled +Specifies if a coating should be applied to the wire.Only applicable for wires (free edges). +Type +boolean +Access +Read/Write +CoreMedium +The wire core medium.Only applicable for wires (free edges). +Type +Medium +Access +Read/Write +EdgeType +The type of edge. +Type +GeometryEdgeEnum +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Length +The accumulative length of all the segments of the wire. +Type +number +Access +Read only +LocalIntrinsicWireRadiusEnabled +Specifies if the local intrinsic wire radius should be used for the wire. Only applicable for wires +(free edges). +Type +boolean +Access +Read/Write +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. +Type +ParametricExpression +Access +Read/Write +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. +Type +boolean +Access +Read/Write +LocalWireRadius +The local radius for the wire. Changing this property will set LocalWireRadiusEnabled to true. Only +applicable for wires (free edges). +Type +ParametricExpression +Access +Read/Write +LocalWireRadiusEnabled +Specifies if the local wire radius should be used for the wire. Only applicable for wires (free +edges). +Type +boolean +Access +Read/Write +SolutionMethod +The local solution method used for the wire. +Type +EdgeSolutionMethodEnum +Access +Read/Write +SurroundingMedium +The surrounding region medium. +Type +Medium +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Windscreen +The windscreen solution method settings for the wire. Only applies if the SolutionMethod is set to +Windscreen. +Type +WindscreenSolutionMethod +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetRadiusOnAllSegments (radius Expression) +Set the segment radius. This is a helper method to update the Radius property on all the +segments simultaneously. +Input Parameters +radius(Expression) +The new radius. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.1157 +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshCurvilinearTriangleFace +A mesh entity representing a face meshed using curvilinear triangles. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Settings for curvilinear meshing +p.1158 +project.Contents.SolutionSettings.SolverSettings.GeneralSettings.BasisFunctionSettings.HOBFEnabled + = true +advancedMeshSettings = project.Mesher.Settings.Advanced +advancedMeshSettings.CurvilinearSegments + = cf.Enums.MeshCurvilinearOptionsEnum.Disabled +advancedMeshSettings.CurvilinearTriangles + = cf.Enums.MeshCurvilinearOptionsEnum.Enabled +frequency = project.Contents.SolutionConfigurations.GlobalFrequency +frequency.Start = "1e08" + -- Create geometry and mesh +project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1.0) +project.Mesher:Mesh() +project.Contents.Geometry["Sphere1"]:UnlinkMesh() +meshCurvilinearTriangleFaces = project.Contents.Meshes["Sphere1_1"].CurvilinearFaces + -- Retrieve a specific 'MeshCurvilinearTriangleFace' from the collection. +meshCurvilinearTriangleFace = meshCurvilinearTriangleFaces["Face1"] + -- Reverse all the face normals +meshCurvilinearTriangleFace:ReverseElementNormals() +Inheritance +The MeshCurvilinearTriangleFace object is derived from the AbstractMeshTriangleFace object. +Usage locations +The MeshCurvilinearTriangleFace object can be accessed from the following locations: +• Methods +◦ MeshCurvilinearTriangleFaceCollection collection has method Item(number). +◦ MeshCurvilinearTriangleFaceCollection collection has method Item(string). +Property List +BasisFunctionSettings +Local basis function solver settings for the face. (Read/Write BasisFunctionLocalSolverSettings) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CharacterisedSurfaceReferenceDirection +Reference direction of the coating. (Read/Write ReferenceDirection) +Coating +The face coating specified by a predefined Layered dielectric medium. An electrically thin coating +is applied on both sides of the face, while an electrically thick coating is applied on the normal +side of the face. The face should be set up to have free space on at least one of the sides, while +the other side can be free space or PEC. Changing this property will set CoatingEnabled to true. +(Read/Write Medium) +CoatingEnabled +Specifies if a coating should be applied to the face. (Read/Write boolean) +CoatingThickness +The thickness of the coaitng. (Read/Write ParametricExpression) +FaceAbsorbingSettings +The face absorption, reflection and transmission properties with regards to rays. Only applies if +the SolutionMethod is set to RLGO. (Read/Write RLGOFaceAbsorbingSettings) +IntegralEquation +The type of integral equation for perfectly conducting metallic surfaces. Only applies when +SolutionMethod is set to None. (Read/Write IntegralEquationTypeEnum) +Label +The object label. (Read/Write string) +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. (Read/Write ParametricExpression) +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. (Read/Write boolean) +Medium +The face medium. (Read/Write Medium) +MeshBackMedium +The surrounding region medium on the back side of the face. (Read/Write Medium) +MeshFrontMedium +The surrounding region medium on the front side of the face. (Read/Write Medium) +SolutionMethod +The local solution method used for the face. (Read/Write FaceSolutionMethodEnum) +SurfaceCoatingType +The surface coating type for the face. (Read/Write SurfaceCoatingTypeEnum) +Thickness +The face medium thickness. Only applies when the Medium is defined as a Metallic. (Read/Write +ParametricExpression) +Type +The object type string. (Read only string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Windscreen +p.1160 +The windscreen solution method settings for the face. Only applies if the SolutionMethod is set to +Windscreen. (Read/Write WindscreenSolutionMethod) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseElementNormals () +Reverses the element normals of the mesh face. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BasisFunctionSettings +Local basis function solver settings for the face. +Type +BasisFunctionLocalSolverSettings +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CharacterisedSurfaceReferenceDirection +Reference direction of the coating. +Type +ReferenceDirection +Access +Read/Write +Coating +The face coating specified by a predefined Layered dielectric medium. An electrically thin coating +is applied on both sides of the face, while an electrically thick coating is applied on the normal +side of the face. The face should be set up to have free space on at least one of the sides, while +the other side can be free space or PEC. Changing this property will set CoatingEnabled to true. +Type +Medium +Access +Read/Write +CoatingEnabled +Specifies if a coating should be applied to the face. +Type +boolean +Access +Read/Write +CoatingThickness +The thickness of the coaitng. +Type +ParametricExpression +Access +Read/Write +FaceAbsorbingSettings +The face absorption, reflection and transmission properties with regards to rays. Only applies if +the SolutionMethod is set to RLGO. +Type +RLGOFaceAbsorbingSettings +Access +Read/Write +IntegralEquation +The type of integral equation for perfectly conducting metallic surfaces. Only applies when +SolutionMethod is set to None. +Type +IntegralEquationTypeEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. +Type +ParametricExpression +Access +Read/Write +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. +Type +boolean +Access +Read/Write +Medium +The face medium. +Type +Medium +Access +Read/Write +MeshBackMedium +The surrounding region medium on the back side of the face. +Type +Medium +Access +Read/Write +MeshFrontMedium +The surrounding region medium on the front side of the face. +Type +Medium +Access +Read/Write +SolutionMethod +The local solution method used for the face. +Type +FaceSolutionMethodEnum +Access +Read/Write +SurfaceCoatingType +The surface coating type for the face. +Type +SurfaceCoatingTypeEnum +Access +Read/Write +Thickness +The face medium thickness. Only applies when the Medium is defined as a Metallic. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Windscreen +The windscreen solution method settings for the face. Only applies if the SolutionMethod is set to +Windscreen. +Type +WindscreenSolutionMethod +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.1164 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseElementNormals () +Reverses the element normals of the mesh face. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MeshCurvilinearWire +An abstract (base) object for curvilinear mesh segment wires. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The MeshCurvilinearWire object is derived from the AbstractMeshWire object. +The following objects are derived (specialisations) from the MeshCurvilinearWire object: +• MeshCurvilinearSegmentWire +Usage locations +The MeshCurvilinearWire object can be accessed from the following locations: +• Methods +◦ MeshSegmentCurvilinearWireCollection collection has method Item(number). +◦ MeshSegmentCurvilinearWireCollection collection has method Item(string). +Property List +AllowDifferentSegmentRadii +Allow modification of radii per segment. (Read/Write boolean) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetRadiusOnAllSegments (radius Expression) +Set the segment radius. This is a helper method to update the Radius property on all the +segments simultaneously. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AllowDifferentSegmentRadii +Allow modification of radii per segment. +Type +boolean +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.1167 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetRadiusOnAllSegments (radius Expression) +Set the segment radius. This is a helper method to update the Radius property on all the +segments simultaneously. +Input Parameters +radius(Expression) +The new radius. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshCylinder +p.1168 +A mesh entity representing one or more unmeshed cylinders. This type of mesh is typically solved using +a solution method that does not require fine subdivision, like the uniform theory of diffraction. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Set the frequency +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08" + -- Create geometry, set the solution method to UTD +cylinder = project.Contents.Geometry:AddCylinder(cf.Point(-0.25,-0.25,0), 0.5, 1.0) +cylinder.Regions["Region1"].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.UTD + -- Mesh +project.Mesher:Mesh() +project.Contents.Geometry["Cylinder1"]:UnlinkMesh() + -- Obtain the MeshCylinder +meshCylinder = project.Contents.Meshes["Cylinder1_1"].Cylinders[1] +Inheritance +The MeshCylinder object is derived from the Object object. +Usage locations +The MeshCylinder object can be accessed from the following locations: +• Methods +◦ MeshCylinderCollection collection has method Item(number). +◦ MeshCylinderCollection collection has method Item(string). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.1170 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MeshExporter +The mesh exporter. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Helix_dipole.cfx]]}) + -- Export the entire mesh to a NASTRAN file +project.Exporter.Mesh.ExportFileFormat = cf.Enums.ExportMeshFileFormatEnum.NASTRAN +project.Mesher:Mesh() +project.Exporter.Mesh:Export([[temp_Export_all.nas]]) + -- Export a single mesh part to a NASTRAN file +project.Contents.Geometry[1]:UnlinkMesh() +project.Exporter.Mesh.ExportFileFormat = cf.Enums.ExportMeshFileFormatEnum.NASTRAN +project.Mesher:Mesh() +project.Exporter.Mesh:ExportParts([[temp_Export_part1.nas]], {}, + {project.Contents.Meshes[1]}) +Inheritance +The MeshExporter object is derived from the Object object. +Usage locations +The MeshExporter object can be accessed from the following locations: +• Properties +◦ Exporter object has property Mesh. +Property List +ExportFileFormat +The export file format. (Read/Write ExportMeshFileFormatEnum) +ExportMeshType +The type of mesh to export. (Read/Write ExportMeshTypeEnum) +ExportOnlyBoundingFacesEnabled +Export only the bounding faces of volume meshes. (Read/Write boolean) +Label +The object label. (Read/Write string) +MirrorHorizontallyAroundYAxisEnabled +Mirror geometry horizontally around Y-axis. Only valid if ExportFileFormat is Gerber. (Read/Write +boolean) +ProjectOntoXYPlaneEnabled +Project the 3D geometry on a 2D plane. Only valid if ExportFileFormat is DXF. (Read/Write +boolean) +ScaleToMetreEnabled +Scale the mesh to metre before export. (Read/Write boolean) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Export (filename string) +Export to the specified file. +ExportParts (filename string, geomoperatorlist List of Geometry, meshentitylist List of Mesh) +Export only the specified meshes to the specified file. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ExportFileFormat +The export file format. +Type +ExportMeshFileFormatEnum +Access +Read/Write +ExportMeshType +The type of mesh to export. +Type +ExportMeshTypeEnum +Access +Read/Write +ExportOnlyBoundingFacesEnabled +Export only the bounding faces of volume meshes. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MirrorHorizontallyAroundYAxisEnabled +Mirror geometry horizontally around Y-axis. Only valid if ExportFileFormat is Gerber. +Type +boolean +Access +Read/Write +ProjectOntoXYPlaneEnabled +Project the 3D geometry on a 2D plane. Only valid if ExportFileFormat is DXF. +Type +boolean +Access +Read/Write +ScaleToMetreEnabled +Scale the mesh to metre before export. +Type +boolean +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Export (filename string) +Export to the specified file. +Input Parameters +filename(string) +The name of the file to be exported. +ExportParts (filename string, geomoperatorlist List of Geometry, meshentitylist List of Mesh) +Export only the specified meshes to the specified file. +Input Parameters +filename(string) +The name of the file to be exported. +geomoperatorlist(List of Geometry) +The list of geometry parts that must be exported. +meshentitylist(List of Mesh) +The list of mesh entities that must be exported. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MeshFind +The mesh find tools. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Settings for normal meshing +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08" + -- Create geometry +cuboid1 = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +cuboid1:UnlinkMesh() + -- Obtain the 'MeshFind' object +meshFind = project.Contents.Meshes.Find + -- Check there are no intersecting meshes +intersectingMeshes = meshFind:GetIntersectingMeshes() +if #intersectingMeshes > 0 then + print("There are intersecting mesh elements.") +else + print("There are no intersecting mesh elements.") +end + -- Add another cuboid +cuboid2 = project.Contents.Geometry:AddCuboid(cf.Point(0.5, 0.5, 0.5), 1, 1, 1) +cuboid2:UnlinkMesh() + -- Check for intersecting meshes +intersectingMeshes = meshFind:GetIntersectingMeshes() +if #intersectingMeshes > 0 then + print("There are intersecting mesh elements.") +else + print("There are no intersecting mesh elements.") +end +Inheritance +The MeshFind object is derived from the Object object. +Property List +Label +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.1177 +Duplicates the entity. (Returns a Object object.) +GetIntersectingMeshes () +Returns meshes with mesh triangles that intersect but are not connected. (Returns a List of Mesh +object.) +GetIntersectingMeshes (meshpartlist List of Mesh) +Returns meshes with mesh triangles that intersect but are not connected within a subset of mesh +parts. (Returns a List of Mesh object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetIntersectingMeshes () +Returns meshes with mesh triangles that intersect but are not connected. +Return +List of Mesh +The list of meshes with intersecting elements. +GetIntersectingMeshes (meshpartlist List of Mesh) +Returns meshes with mesh triangles that intersect but are not connected within a subset of mesh +parts. +Input Parameters +meshpartlist(List of Mesh) +A list of mesh elements used for search. +Return +List of Mesh +The list of meshes with intersecting elements. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MeshImporter +The mesh importer. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Auto determine the mesh file type and import it into the current project +project.Importer.MeshImporter:Import(FEKO_HOME..[[/shared/Resources/Automation/ +demo_RM.nas]]) +Inheritance +The MeshImporter object is derived from the Object object. +Usage locations +The MeshImporter object can be accessed from the following locations: +• Properties +◦ +Importer object has property MeshImporter. +Property List +ConversionType +Conversion type. Only valid when the file format is Voxel mesh. (Read/Write +ImportMeshConversionTypeEnum) +CylinderImportingEnabled +Enables mesh cylinder importing. Only applicable when the file format is ABAQUS, ASCII, +AutoCAD, CADFEKO mesh, CDB, CFM, FEMAP, Feko HyperMesh, GID, I-DEAS UNV, NASTRAN, +NEC, PATRAN or UNV. (Read/Write boolean) +GroupPartsByLabelEnabled +Group into separate parts (using labels). (Read/Write boolean) +Label +The object label. (Read/Write string) +MeshMergingMediaEnabled +Enables merging identical media while importing mesh. Only applicable when the file format is +Voxel mesh. (Read/Write boolean) +MeshRelabelingEnabled +Re-label mesh using the *.map file (when available). Only applicable when the file format is +NASTRAN. (Read/Write boolean) +PolygonImportingEnabled +Enables mesh polygon importing. Only applicable when the file format is ASCII, CADFEKO mesh, +FEMAP or Feko HyperMesh. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Prefix +p.1181 +Merge identical media with a prefix. Only applicable when the file format is Voxel mesh. (Read/ +Write string) +QuadrangleImportingEnabled +Enables mesh quadrangle importing. Only applicable when the file format is ABAQUS, ANSYS, +FEMAP, Feko HyperMesh, GID, NASTRAN or PATRAN. For the AutoCAD file format, use the +TriangleImportingEnabled property to import quadrangles. (Read/Write boolean) +ScaleFactor +Scale factor if the imported mesh is not in metres. Only applicable when the file format is +ABAQUS, ANSYS, ASCII, AutoCAD, CONCEPT, FEMAP, GID, NASTRAN, PATRAN, STL or Voxel mesh. +(Read/Write ParametricExpression) +SegmentImportingEnabled +Enables mesh segment importing. Only applicable when the file format is ABAQUS, ANSYS, +ASCII, AutoCAD, CADFEKO mesh, FEMAP, Feko HyperMesh, GID, I-DEAS UNV, NASTRAN, NEC or +PATRAN. (Read/Write boolean) +SegmentLength +Line elements divided in segments according to this length. Only applicable when the file format is +AutoCAD. (Read/Write ParametricExpression) +TetrahedronImportingEnabled +Enables mesh tetrahedron importing. Only applicable when the file format is ABAQUS, ANSYS, +ASCII, CADFEKO mesh, FEMAP, Feko HyperMesh, GID, NASTRAN or PATRAN. (Read/Write +boolean) +TriangleImportingEnabled +Enables mesh triangle importing. Only applicable when the file format is ABAQUS, ANSYS, ASCII, +AutoCAD, CADFEKO mesh, FEMAP, Feko HyperMesh, GID, I-DEAS UNV, NASTRAN or PATRAN. For +the AutoCAD file format, quadrangles are imported as well. (Read/Write boolean) +Type +The object type string. (Read only string) +VertexTolerance +The mesh vertex tolerance. Only applicable when the file format is ABAQUS, ANSYS, +ASCII, AutoCAD, CONCEPT, FEMAP, GID, NASTRAN, NEC, PATRAN or STL. (Read/Write +ParametricExpression) +WireRadius +The default wire radius. Only applicable when the file format is ABAQUS, ANSYS, ASCII, AutoCAD, +CONCEPT, FEMAP, GID, NASTRAN, PATRAN, STL or UNV. (Read/Write ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1182 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Import (filename string) +Import the specified file. (Returns a List of Mesh object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ConversionType +Conversion type. Only valid when the file format is Voxel mesh. +Type +ImportMeshConversionTypeEnum +Access +Read/Write +CylinderImportingEnabled +Enables mesh cylinder importing. Only applicable when the file format is ABAQUS, ASCII, +AutoCAD, CADFEKO mesh, CDB, CFM, FEMAP, Feko HyperMesh, GID, I-DEAS UNV, NASTRAN, +NEC, PATRAN or UNV. +Type +boolean +Access +Read/Write +GroupPartsByLabelEnabled +Group into separate parts (using labels). +Type +boolean +Access +Read/Write +The object label. +Type +string +Label +Access +Read/Write +MeshMergingMediaEnabled +Enables merging identical media while importing mesh. Only applicable when the file format is +Voxel mesh. +Type +boolean +Access +Read/Write +MeshRelabelingEnabled +Re-label mesh using the *.map file (when available). Only applicable when the file format is +NASTRAN. +Type +boolean +Access +Read/Write +PolygonImportingEnabled +Enables mesh polygon importing. Only applicable when the file format is ASCII, CADFEKO mesh, +FEMAP or Feko HyperMesh. +Type +boolean +Access +Read/Write +Prefix +Merge identical media with a prefix. Only applicable when the file format is Voxel mesh. +Type +string +Access +Read/Write +QuadrangleImportingEnabled +Enables mesh quadrangle importing. Only applicable when the file format is ABAQUS, ANSYS, +FEMAP, Feko HyperMesh, GID, NASTRAN or PATRAN. For the AutoCAD file format, use the +TriangleImportingEnabled property to import quadrangles. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ScaleFactor +p.1184 +Scale factor if the imported mesh is not in metres. Only applicable when the file format is +ABAQUS, ANSYS, ASCII, AutoCAD, CONCEPT, FEMAP, GID, NASTRAN, PATRAN, STL or Voxel mesh. +Type +ParametricExpression +Access +Read/Write +SegmentImportingEnabled +Enables mesh segment importing. Only applicable when the file format is ABAQUS, ANSYS, +ASCII, AutoCAD, CADFEKO mesh, FEMAP, Feko HyperMesh, GID, I-DEAS UNV, NASTRAN, NEC or +PATRAN. +Type +boolean +Access +Read/Write +SegmentLength +Line elements divided in segments according to this length. Only applicable when the file format is +AutoCAD. +Type +ParametricExpression +Access +Read/Write +TetrahedronImportingEnabled +Enables mesh tetrahedron importing. Only applicable when the file format is ABAQUS, ANSYS, +ASCII, CADFEKO mesh, FEMAP, Feko HyperMesh, GID, NASTRAN or PATRAN. +Type +boolean +Access +Read/Write +TriangleImportingEnabled +Enables mesh triangle importing. Only applicable when the file format is ABAQUS, ANSYS, ASCII, +AutoCAD, CADFEKO mesh, FEMAP, Feko HyperMesh, GID, I-DEAS UNV, NASTRAN or PATRAN. For +the AutoCAD file format, quadrangles are imported as well. +Type +boolean +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +VertexTolerance +The mesh vertex tolerance. Only applicable when the file format is ABAQUS, ANSYS, ASCII, +AutoCAD, CONCEPT, FEMAP, GID, NASTRAN, NEC, PATRAN or STL. +Type +ParametricExpression +Access +Read/Write +WireRadius +The default wire radius. Only applicable when the file format is ABAQUS, ANSYS, ASCII, AutoCAD, +CONCEPT, FEMAP, GID, NASTRAN, PATRAN, STL or UNV. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Import (filename string) +Import the specified file. +Input Parameters +filename(string) +The name of the file to be imported. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +List of Mesh +The imported mesh. +SetProperties (properties Object) +p.1186 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshInfo +The quality of the mesh can be examined through these properties. +Example +p.1187 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Helix_dipole.cfx]]}) +geometry = project.Contents.Geometry[1] + -- Get the triangle count of the simulation mesh +triangleCount = geometry.SimulationMeshInfo.TriangleCount + -- Ensure the average edge length of the model mesh is smaller than 0.1 +mesh = geometry:UnlinkMesh() +assert(mesh.ModelMeshInfo.AverageCurvilinearSegmentLength < 0.1) +Inheritance +The MeshInfo object is derived from the Object object. +Property List +AverageCurvilinearEdgeLength +The average mesh curvilinear edge length. (Read only number) +AverageCurvilinearSegmentLength +The average mesh curvilinear segment length. (Read only number) +AverageEdgeLength +The average mesh edge length. (Read only number) +AverageSegmentLength +The average mesh segment length. (Read only number) +AverageTetrahedronEdgeLength +The average mesh tetrahedron edge length. (Read only number) +AverageVoxelLength +The average mesh voxel length. (Read only number) +CableSegmentCount +Get the total number of cable segment elements. (Read only number) +CurvilinearEdgeStandardDeviation +The standard deviation of curvilinear mesh edge length. (Read only number) +CurvilinearSegmentCount +The number of curvilinear line segments in the mesh. (Read only number) +CurvilinearSegmentStandardDeviation +The standard deviation of mesh curvilinear segment length. (Read only number) +CurvilinearTriangleCount +The number of curvilinear triangles in the mesh. (Read only number) +EdgeStandardDeviation +The standard deviation of mesh edge length. (Read only number) +Label +The object label. (Read/Write string) +MaximumCurvilinearEdgeLength +The maximum mesh curvilinear edge length. (Read only number) +MaximumCurvilinearSegmentLength +The maximum mesh curvilinear segment length. (Read only number) +MaximumEdgeLength +The maximum mesh edge length. (Read only number) +MaximumElementAngle +The maximum mesh element angle. (Read only number) +MaximumSegmentLength +The maximum mesh segment length. (Read only number) +MaximumTetrahedronEdgeLength +The maximum mesh tetrahedron edge length. (Read only number) +MaximumVoxelLength +The maximum mesh voxel length. (Read only number) +MeshElementCount +Get the total number of mesh elements. (Read only number) +MinimumCurvilinearEdgeLength +The minimum mesh curvilinear edge length. (Read only number) +MinimumCurvilinearSegmentLength +The minimum mesh curvilinear segment length. (Read only number) +MinimumEdgeLength +The minimum mesh edge length. (Read only number) +MinimumElementAngle +The minimum mesh element angle. (Read only number) +MinimumSegmentLength +The minimum mesh segment length. (Read only number) +MinimumTetrahedronEdgeLength +The minimum mesh tetrahedron edge length. (Read only number) +MinimumVoxelLength +The minimum mesh voxel length. (Read only number) +PolygonCount +The total number of polygons in the mesh. (Read only number) +SegmentCount +The total number of segments in the mesh. (Read only number) +SegmentStandardDeviation +The standard deviation of mesh segment length. (Read only number) +TetrahedronCount +The total number of tetrahedra in the mesh. (Read only number) +TetrahedronEdgeStandardDeviation +The standard deviation of mesh tetradron edge length. (Read only number) +TriangleCount +The number of triangles in the mesh. This is including both flat and curvilinear triangles. (Read +only number) +Type +The object type string. (Read only string) +VoxelCount +The number of FDTD voxels in the mesh. (Read only number) +VoxelStandardDeviation +The standard deviation of mesh voxel length. (Read only number) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AverageCurvilinearEdgeLength +The average mesh curvilinear edge length. +Type +number +Access +Read only +AverageCurvilinearSegmentLength +The average mesh curvilinear segment length. +Type +number +Access +Read only +AverageEdgeLength +The average mesh edge length. +Type +number +Access +Read only +AverageSegmentLength +The average mesh segment length. +Type +number +Access +Read only +AverageTetrahedronEdgeLength +The average mesh tetrahedron edge length. +Type +number +Access +Read only +AverageVoxelLength +The average mesh voxel length. +Type +number +Access +Read only +CableSegmentCount +Get the total number of cable segment elements. +Type +number +Access +Read only +CurvilinearEdgeStandardDeviation +The standard deviation of curvilinear mesh edge length. +Type +number +Access +Read only +CurvilinearSegmentCount +The number of curvilinear line segments in the mesh. +Type +number +Access +Read only +CurvilinearSegmentStandardDeviation +The standard deviation of mesh curvilinear segment length. +Type +number +Access +Read only +CurvilinearTriangleCount +The number of curvilinear triangles in the mesh. +Type +number +Access +Read only +EdgeStandardDeviation +The standard deviation of mesh edge length. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +MaximumCurvilinearEdgeLength +The maximum mesh curvilinear edge length. +Type +number +Access +Read only +MaximumCurvilinearSegmentLength +The maximum mesh curvilinear segment length. +Type +number +Access +Read only +MaximumEdgeLength +The maximum mesh edge length. +Type +number +Access +Read only +MaximumElementAngle +The maximum mesh element angle. +Type +number +Access +Read only +MaximumSegmentLength +The maximum mesh segment length. +Type +number +Access +Read only +MaximumTetrahedronEdgeLength +The maximum mesh tetrahedron edge length. +Type +number +Access +Read only +MaximumVoxelLength +The maximum mesh voxel length. +Type +number +Access +Read only +MeshElementCount +Get the total number of mesh elements. +Type +number +Access +Read only +MinimumCurvilinearEdgeLength +The minimum mesh curvilinear edge length. +Type +number +Access +Read only +MinimumCurvilinearSegmentLength +The minimum mesh curvilinear segment length. +Type +number +Access +Read only +MinimumEdgeLength +The minimum mesh edge length. +Type +number +Access +Read only +MinimumElementAngle +The minimum mesh element angle. +Type +number +Access +Read only +MinimumSegmentLength +The minimum mesh segment length. +Type +number +Access +Read only +MinimumTetrahedronEdgeLength +The minimum mesh tetrahedron edge length. +Type +number +Access +Read only +MinimumVoxelLength +The minimum mesh voxel length. +Type +number +Access +Read only +PolygonCount +The total number of polygons in the mesh. +Type +number +Access +Read only +SegmentCount +The total number of segments in the mesh. +Type +number +Access +Read only +SegmentStandardDeviation +The standard deviation of mesh segment length. +Type +number +Access +Read only +TetrahedronCount +The total number of tetrahedra in the mesh. +Type +number +Access +Read only +TetrahedronEdgeStandardDeviation +The standard deviation of mesh tetradron edge length. +Type +number +Access +Read only +TriangleCount +The number of triangles in the mesh. This is including both flat and curvilinear triangles. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VoxelCount +The number of FDTD voxels in the mesh. +Type +number +Access +Read only +VoxelStandardDeviation +The standard deviation of mesh voxel length. +Type +number +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshPlate +p.1197 +A mesh entity representing one or more unmeshed polygons. This type of mesh is typically solved using +a solution method that does not require fine subdivision, like the uniform theory of diffraction. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Set the frequency +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08" + -- Create geometry, set solution method to UTD +polygons = project.Contents.Geometry:AddRectangle(cf.Point(-0.25,-0.25,0), 0.5, 1.0) +polygons.Faces["Face1"].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.UTD + -- Mesh +project.Mesher:Mesh() +project.Contents.Geometry["Rectangle1"]:UnlinkMesh() +meshPlates = project.Contents.Meshes["Rectangle1_1"].Plates +for i in ipairs(meshPlates) do + -- Obtain the 'MeshPlate' + meshPlate = meshPlates[i] + -- Reverse the element normals on the plate + meshPlate:ReverseElementNormals() +end +Inheritance +The MeshPlate object is derived from the Object object. +Usage locations +The MeshPlate object can be accessed from the following locations: +• Methods +◦ MeshPlateCollection collection has method Item(number). +◦ MeshPlateCollection collection has method Item(string). +Property List +BasisFunctionSettings +Local basis function solver settings for the face. (Read/Write BasisFunctionLocalSolverSettings) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CharacterisedSurfaceReferenceDirection +Reference direction of the coating. (Read/Write ReferenceDirection) +Coating +The face coating specified by a predefined Layered dielectric medium. An electrically thin coating +is applied on both sides of the face, while an electrically thick coating is applied on the normal +side of the face. The face should be set up to have free space on at least one of the sides, while +the other side can be free space or PEC. Changing this property will set CoatingEnabled to true. +(Read/Write Medium) +CoatingEnabled +Specifies if a coating should be applied to the face. (Read/Write boolean) +CoatingThickness +The thickness of the coaitng. (Read/Write ParametricExpression) +FaceAbsorbingSettings +The face absorption, reflection and transmission properties with regards to rays. Only applies if +the SolutionMethod is set to RLGO. (Read/Write RLGOFaceAbsorbingSettings) +IntegralEquation +The type of integral equation for perfectly conducting metallic surfaces. Only applies when +SolutionMethod is set to None. (Read/Write IntegralEquationTypeEnum) +Label +The object label. (Read/Write string) +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. (Read/Write ParametricExpression) +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. (Read/Write boolean) +Medium +The face medium. (Read/Write Medium) +SolutionMethod +The local solution method used for the face. (Read/Write FaceSolutionMethodEnum) +SurfaceCoatingType +The surface coating type for the face. (Read/Write SurfaceCoatingTypeEnum) +Thickness +The face medium thickness. Only applies when the Medium is defined as a Metallic. (Read/Write +ParametricExpression) +Type +The object type string. (Read only string) +Windscreen +The windscreen solution method settings for the face. Only applies if the SolutionMethod is set to +Windscreen. (Read/Write WindscreenSolutionMethod) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseElementNormals () +Reverses each polygon's normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BasisFunctionSettings +Local basis function solver settings for the face. +Type +BasisFunctionLocalSolverSettings +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CharacterisedSurfaceReferenceDirection +Reference direction of the coating. +Type +ReferenceDirection +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Coating +p.1200 +The face coating specified by a predefined Layered dielectric medium. An electrically thin coating +is applied on both sides of the face, while an electrically thick coating is applied on the normal +side of the face. The face should be set up to have free space on at least one of the sides, while +the other side can be free space or PEC. Changing this property will set CoatingEnabled to true. +Type +Medium +Access +Read/Write +CoatingEnabled +Specifies if a coating should be applied to the face. +Type +boolean +Access +Read/Write +CoatingThickness +The thickness of the coaitng. +Type +ParametricExpression +Access +Read/Write +FaceAbsorbingSettings +The face absorption, reflection and transmission properties with regards to rays. Only applies if +the SolutionMethod is set to RLGO. +Type +RLGOFaceAbsorbingSettings +Access +Read/Write +IntegralEquation +The type of integral equation for perfectly conducting metallic surfaces. Only applies when +SolutionMethod is set to None. +Type +IntegralEquationTypeEnum +Label +Access +Read/Write +The object label. +Type +string +Access +Read/Write +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. +Type +ParametricExpression +Access +Read/Write +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. +Type +boolean +Access +Read/Write +Medium +The face medium. +Type +Medium +Access +Read/Write +SolutionMethod +The local solution method used for the face. +Type +FaceSolutionMethodEnum +Access +Read/Write +SurfaceCoatingType +The surface coating type for the face. +Type +SurfaceCoatingTypeEnum +Access +Read/Write +Thickness +The face medium thickness. Only applies when the Medium is defined as a Metallic. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Windscreen +The windscreen solution method settings for the face. Only applies if the SolutionMethod is set to +Windscreen. +Type +WindscreenSolutionMethod +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseElementNormals () +Reverses each polygon's normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.1203 +MeshRefinementRule +A mesh refinement rule. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Add an adaptive refinement rule +project.Contents.MeshRefinementRules:AddPointRefinement(cf.Point(0,0,0),0.01,0.01) + -- Obtain the 'MeshRefinementRulesCollection' +meshRefinementRules = project.Contents.MeshRefinementRules + -- Obtain the mesh refinement rule and change mesh size to 0.02 +meshRefinementRule = meshRefinementRules[1] +meshRefinementRule.MeshSize = 0.02 +Inheritance +The MeshRefinementRule object is derived from the Object object. +The following objects are derived (specialisations) from the MeshRefinementRule object: +• AdaptiveRefinement +• PointRefinement +• PolylineRefinement +Usage locations +The MeshRefinementRule object can be accessed from the following locations: +• Methods +◦ MeshRefinementRuleCollection collection has method Item(number). +◦ MeshRefinementRuleCollection collection has method Item(string). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MeshRegion +An abstract (base) object for mesh regions. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The MeshRegion object is derived from the Object object. +The following objects are derived (specialisations) from the MeshRegion object: +• MeshTetrahedronRegion +Usage locations +The MeshRegion object can be accessed from the following locations: +• Methods +◦ MeshTetrahedronRegionCollection collection has method Item(number). +◦ MeshTetrahedronRegionCollection collection has method Item(string). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +p.1210 +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1211 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshSegmentReference +A reference to a mesh segment. +Example +p.1212 +local application = cf.Application.GetInstance() +local project = application:NewProject() +advancedMeshSettings = project.Mesher.Settings.Advanced +advancedMeshSettings.CurvilinearSegments + = cf.Enums.MeshCurvilinearOptionsEnum.Disabled +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "100e5" + -- Construct a port and add it to the collection +line = project.Contents.Geometry:AddLine(cf.Point(0, 0, 0), cf.Point(1, 1, 1)) +project.Mesher.Settings.WireRadius = "0.01" +project.Mesher:Mesh() +mesh = line:UnlinkMesh() + -- Add a WireMeshPort +port = project.Contents.Ports:AddWireMeshPort(mesh.Wires[1].SegmentElements[1]) +Inheritance +The MeshSegmentReference object is derived from the object. +Usage locations +The MeshSegmentReference object can be accessed from the following locations: +• Properties +◦ MeshSegmentReference object has property Value. +Property List +Index +Value +Returns the index of this element in the element collection. (Read only number) +Returns the MeshSegmentReference associated with this element. (Read only +MeshSegmentReference) +Property Details +Index +Returns the index of this element in the element collection. +Type +number +Access +Read only +Value +Returns the MeshSegmentReference associated with this element. +Type +MeshSegmentReference +Access +Read only +MeshSegmentWire +A mesh entity representing a wire meshed using segments. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Settings for normal meshing +advancedMeshSettings = project.Mesher.Settings.Advanced +advancedMeshSettings.CurvilinearSegments + = cf.Enums.MeshCurvilinearOptionsEnum.Disabled +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08" + -- Create geometry and mesh +project.Contents.Geometry:AddHelix(cf.Point(0,0,0), 0.1, 0.1, 1.0, 5.0, false) +project.Mesher.Settings.WireRadius = "0.01" +project.Mesher:Mesh() +project.Contents.Geometry["Helix1"]:UnlinkMesh() +meshSegmentWires = project.Contents.Meshes["Helix1_1"].Wires + -- Retrieve a specific wire from the collection. +meshSegmentWire = meshSegmentWires["Wire1"] + -- Set the radius on all the segments +meshSegmentWire:SetRadiusOnAllSegments(0.1) +Inheritance +The MeshSegmentWire object is derived from the MeshWire object. +Property List +AllowDifferentSegmentRadii +Allow modification of radii per segment. (Read/Write boolean) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Coating +The wire (free edge) coating specified by a predefined Layered dielectric medium. Changing this +property will set CoatingEnabled to true. Only applicable for wires (free edges). (Read/Write +Medium) +CoatingEnabled +Specifies if a coating should be applied to the wire.Only applicable for wires (free edges). (Read/ +Write boolean) +CoreMedium +The wire core medium.Only applicable for wires (free edges). (Read/Write Medium) +EdgeType +The type of edge. (Read only GeometryEdgeEnum) +Label +The object label. (Read/Write string) +Length +The accumulative length of all the segments of the wire. (Read only number) +LocalIntrinsicWireRadiusEnabled +Specifies if the local intrinsic wire radius should be used for the wire. Only applicable for wires +(free edges). (Read/Write boolean) +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. (Read/Write ParametricExpression) +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. (Read/Write boolean) +LocalWireRadius +The local radius for the wire. Changing this property will set LocalWireRadiusEnabled to true. Only +applicable for wires (free edges). (Read/Write ParametricExpression) +LocalWireRadiusEnabled +Specifies if the local wire radius should be used for the wire. Only applicable for wires (free +edges). (Read/Write boolean) +SolutionMethod +The local solution method used for the wire. (Read/Write EdgeSolutionMethodEnum) +SurroundingMedium +The surrounding region medium. (Read/Write Medium) +Type +The object type string. (Read only string) +Windscreen +The windscreen solution method settings for the wire. Only applies if the SolutionMethod is set to +Windscreen. (Read/Write WindscreenSolutionMethod) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1216 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetRadiusOnAllSegments (radius Expression) +Set the segment radius. This is a helper method to update the Radius property on all the +segments simultaneously. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AllowDifferentSegmentRadii +Allow modification of radii per segment. +Type +boolean +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Coating +The wire (free edge) coating specified by a predefined Layered dielectric medium. Changing this +property will set CoatingEnabled to true. Only applicable for wires (free edges). +Type +Medium +Access +Read/Write +CoatingEnabled +Specifies if a coating should be applied to the wire.Only applicable for wires (free edges). +Type +boolean +Access +Read/Write +CoreMedium +The wire core medium.Only applicable for wires (free edges). +Type +Medium +Access +Read/Write +EdgeType +The type of edge. +Type +GeometryEdgeEnum +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Length +The accumulative length of all the segments of the wire. +Type +number +Access +Read only +LocalIntrinsicWireRadiusEnabled +Specifies if the local intrinsic wire radius should be used for the wire. Only applicable for wires +(free edges). +Type +boolean +Access +Read/Write +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. +Type +ParametricExpression +Access +Read/Write +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. +Type +boolean +Access +Read/Write +LocalWireRadius +The local radius for the wire. Changing this property will set LocalWireRadiusEnabled to true. Only +applicable for wires (free edges). +Type +ParametricExpression +Access +Read/Write +LocalWireRadiusEnabled +Specifies if the local wire radius should be used for the wire. Only applicable for wires (free +edges). +Type +boolean +Access +Read/Write +SolutionMethod +The local solution method used for the wire. +Type +EdgeSolutionMethodEnum +Access +Read/Write +SurroundingMedium +The surrounding region medium. +Type +Medium +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +Windscreen +p.1219 +The windscreen solution method settings for the wire. Only applies if the SolutionMethod is set to +Windscreen. +Type +WindscreenSolutionMethod +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetRadiusOnAllSegments (radius Expression) +Set the segment radius. This is a helper method to update the Radius property on all the +segments simultaneously. +Input Parameters +radius(Expression) +The new radius. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MeshSettings +The model mesher. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Set the frequency +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08" + -- Create geometry +project.Contents.Geometry:AddHelix(cf.Point(0,0,0), 0.1, 0.1, 1.0, 5.0, false) + -- Set the wire radius on the 'MeshSettings' +project.Mesher.Settings.WireRadius = "0.01" + -- Mesh +project.Mesher:Mesh() +Inheritance +The MeshSettings object is derived from the Object object. +The following objects are derived (specialisations) from the MeshSettings object: +• GlobalMeshSettings +• LocalMeshSettings +Usage locations +The MeshSettings object can be accessed from the following locations: +• Properties +◦ Mesh object has property MeshSettings. +◦ Geometry object has property MeshSettings. +◦ SpiralCross object has property MeshSettings. +◦ Ring object has property MeshSettings. +◦ OpenRing object has property MeshSettings. +◦ SplitRing object has property MeshSettings. +◦ Cross object has property MeshSettings. +◦ StripCross object has property MeshSettings. +◦ Trifilar object has property MeshSettings. +◦ AnalyticalCurve object has property MeshSettings. +◦ BezierCurve object has property MeshSettings. +◦ Cone object has property MeshSettings. +◦ ConstrainedSurface object has property MeshSettings. +◦ Cuboid object has property MeshSettings. +◦ Cylinder object has property MeshSettings. +◦ Ellipse object has property MeshSettings. +◦ EllipticArc object has property MeshSettings. +◦ FittedSpline object has property MeshSettings. +◦ Flare object has property MeshSettings. +◦ Helix object has property MeshSettings. +◦ Hexagon object has property MeshSettings. +◦ StripHexagon object has property MeshSettings. +◦ HyperbolicArc object has property MeshSettings. +◦ +◦ +ImprintPoints object has property MeshSettings. +Intersect object has property MeshSettings. +◦ Loft object has property MeshSettings. +◦ PathSweep object has property MeshSettings. +◦ ProjectGeometry object has property MeshSettings. +◦ RepairAndSewFaces object has property MeshSettings. +◦ RepairPart object has property MeshSettings. +◦ Spin object has property MeshSettings. +◦ Split object has property MeshSettings. +◦ Stitch object has property MeshSettings. +◦ Subtract object has property MeshSettings. +◦ Sweep object has property MeshSettings. +◦ Union object has property MeshSettings. +◦ Simplify object has property MeshSettings. +◦ Line object has property MeshSettings. +◦ NurbsSurface object has property MeshSettings. +◦ ParabolicArc object has property MeshSettings. +◦ Paraboloid object has property MeshSettings. +◦ Polygon object has property MeshSettings. +◦ Polyline object has property MeshSettings. +◦ Primitive object has property MeshSettings. +◦ Rectangle object has property MeshSettings. +◦ Sphere object has property MeshSettings. +◦ AbstractSurfaceCurve object has property MeshSettings. +◦ SurfaceBezierCurve object has property MeshSettings. +◦ SurfaceLine object has property MeshSettings. +◦ SurfaceRegularLines object has property MeshSettings. +◦ TCross object has property MeshSettings. +Property List +Advanced +Advanced meshing settings. (Read/Write MeshAdvancedSettings) +Label +The object label. (Read/Write string) +MeshSizeOption +Mesh size option. (Read/Write MeshSizeOptionEnum) +TetrahedronEdgeLength +Mesh tetrahedron edge length. Only applied if MeshSizeOption is Custom and there is at least one +volume in the model. (Read/Write ParametricExpression) +TriangleEdgeLength +Mesh triangle edge length. Only applied if MeshSizeOption is Custom and there is at least one +surface in the model. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +WireRadius +Mesh wire segment radius. Only applied if there is at least one wire in the model. (Read/Write +ParametricExpression) +WireSegmentLength +Mesh wire segment length. Only applied if MeshSizeOption is Custom and there is at least one +wire in the model. (Read/Write ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Advanced +Advanced meshing settings. +Type +MeshAdvancedSettings +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MeshSizeOption +Mesh size option. +Type +MeshSizeOptionEnum +Access +Read/Write +TetrahedronEdgeLength +Mesh tetrahedron edge length. Only applied if MeshSizeOption is Custom and there is at least one +volume in the model. +Type +ParametricExpression +Access +Read/Write +TriangleEdgeLength +Mesh triangle edge length. Only applied if MeshSizeOption is Custom and there is at least one +surface in the model. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +WireRadius +Mesh wire segment radius. Only applied if there is at least one wire in the model. +Type +ParametricExpression +Access +Read/Write +WireSegmentLength +Mesh wire segment length. Only applied if MeshSizeOption is Custom and there is at least one +wire in the model. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.1226 +MeshTetrahedronRegion +A mesh entity representing a region meshed with tetrahedra. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Set the frequency +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08" + -- Create geometry, set the solution method to FEM +cuboid = project.Contents.Geometry:AddCuboidAtCentre(cf.Point(0,0,0), 1.0, 1.0, 1.0) +dielectric = project.Definitions.Media.Dielectric:AddDielectric(0.01,0.01,0.01) +cuboid.Regions["Region1"].Medium = dielectric +cuboid.Regions["Region1"].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.FEM + -- Mesh +project.Mesher:Mesh() +project.Contents.Geometry["Cuboid1"]:UnlinkMesh() +tetrahedronRegions = project.Contents.Meshes["Cuboid1_1"].Regions +for i in ipairs(tetrahedronRegions) do + -- Obtain the 'MeshTetrahedronRegion' and set its local size + meshTetrahedronRegion = tetrahedronRegions[i] + meshTetrahedronRegion.LocalMeshSize = 0.01; + meshTetrahedronRegion.LocalMeshSizeEnabled = true; +end +Inheritance +The MeshTetrahedronRegion object is derived from the MeshRegion object. +Property List +BasisFunctionSettings +Local basis function solver settings for the region. Only applies if the SolutionMethod is set to SEP. +(Read/Write BasisFunctionLocalSolverSettings) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +DefinitionMethod +The definition method for the 3D anisotropic reference direction. (Read/Write +RegionDefinitionMethodEnum) +Label +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +LocalMeshSize +p.1228 +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. (Read/Write ParametricExpression) +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. (Read/Write boolean) +Medium +The region medium. (Read/Write Medium) +ReferenceWorkplane +The workplane for the 3D anisotropic reference direction. (Read/Write Workplane) +SolutionMedium +The local solution method used for the region. (Read only Medium) +SolutionMethod +The local solution method used for the region. (Read/Write RegionSolutionMethodEnum) +Type +The object type string. (Read only string) +UTDCylinder +The cylinder region's uniform theory of diffraction (UTD) solution settings. Only applies if the +SolutionMethod is set to UTD. (Read/Write UTDCylinderTerminationType) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BasisFunctionSettings +Local basis function solver settings for the region. Only applies if the SolutionMethod is set to SEP. +Type +BasisFunctionLocalSolverSettings +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +DefinitionMethod +The definition method for the 3D anisotropic reference direction. +Type +RegionDefinitionMethodEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. +Type +ParametricExpression +Access +Read/Write +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. +Type +boolean +Access +Read/Write +Medium +The region medium. +Type +Medium +Access +Read/Write +ReferenceWorkplane +The workplane for the 3D anisotropic reference direction. +Type +Workplane +Access +Read/Write +SolutionMedium +The local solution method used for the region. +Type +Medium +Access +Read only +SolutionMethod +The local solution method used for the region. +Type +RegionSolutionMethodEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +UTDCylinder +The cylinder region's uniform theory of diffraction (UTD) solution settings. Only applies if the +SolutionMethod is set to UTD. +Type +UTDCylinderTerminationType +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.1231 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MeshTriangleFace +A mesh entity representing a face meshed using triangles. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Set the frequency +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e06" + -- Create geometry and mesh +project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1.0) +project.Mesher:Mesh() +project.Contents.Geometry["Sphere1"]:UnlinkMesh() +meshTriangleFaces = project.Contents.Meshes["Sphere1_1"].Faces + -- Retrieve a specific 'MeshTriangleFace' from the collection. +meshTriangleFace = meshTriangleFaces["Face1"] + -- Reverse all the face normals +meshTriangleFace:ReverseElementNormals() +Inheritance +The MeshTriangleFace object is derived from the AbstractMeshTriangleFace object. +Usage locations +The MeshTriangleFace object can be accessed from the following locations: +• Properties +◦ WaveguideMeshPort object has property Face. +• Methods +◦ MeshTriangleFaceCollection collection has method Item(number). +◦ MeshTriangleFaceCollection collection has method Item(string). +◦ Mesh object has method CreateTriangle(Point, Point, Point). +Property List +BasisFunctionSettings +Local basis function solver settings for the face. (Read/Write BasisFunctionLocalSolverSettings) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CharacterisedSurfaceReferenceDirection +Reference direction of the coating. (Read/Write ReferenceDirection) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Coating +p.1233 +The face coating specified by a predefined Layered dielectric medium. An electrically thin coating +is applied on both sides of the face, while an electrically thick coating is applied on the normal +side of the face. The face should be set up to have free space on at least one of the sides, while +the other side can be free space or PEC. Changing this property will set CoatingEnabled to true. +(Read/Write Medium) +CoatingEnabled +Specifies if a coating should be applied to the face. (Read/Write boolean) +CoatingThickness +The thickness of the coaitng. (Read/Write ParametricExpression) +FaceAbsorbingSettings +The face absorption, reflection and transmission properties with regards to rays. Only applies if +the SolutionMethod is set to RLGO. (Read/Write RLGOFaceAbsorbingSettings) +IntegralEquation +The type of integral equation for perfectly conducting metallic surfaces. Only applies when +SolutionMethod is set to None. (Read/Write IntegralEquationTypeEnum) +Label +The object label. (Read/Write string) +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. (Read/Write ParametricExpression) +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. (Read/Write boolean) +Medium +The face medium. (Read/Write Medium) +SolutionMethod +The local solution method used for the face. (Read/Write FaceSolutionMethodEnum) +SurfaceCoatingType +The surface coating type for the face. (Read/Write SurfaceCoatingTypeEnum) +Thickness +The face medium thickness. Only applies when the Medium is defined as a Metallic. (Read/Write +ParametricExpression) +Type +The object type string. (Read only string) +Windscreen +The windscreen solution method settings for the face. Only applies if the SolutionMethod is set to +Windscreen. (Read/Write WindscreenSolutionMethod) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseElementNormals () +Reverses the element normals of the mesh face. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BasisFunctionSettings +Local basis function solver settings for the face. +Type +BasisFunctionLocalSolverSettings +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CharacterisedSurfaceReferenceDirection +Reference direction of the coating. +Type +ReferenceDirection +Access +Read/Write +Coating +The face coating specified by a predefined Layered dielectric medium. An electrically thin coating +is applied on both sides of the face, while an electrically thick coating is applied on the normal +side of the face. The face should be set up to have free space on at least one of the sides, while +the other side can be free space or PEC. Changing this property will set CoatingEnabled to true. +Type +Medium +Access +Read/Write +CoatingEnabled +Specifies if a coating should be applied to the face. +Type +boolean +Access +Read/Write +CoatingThickness +The thickness of the coaitng. +Type +ParametricExpression +Access +Read/Write +FaceAbsorbingSettings +The face absorption, reflection and transmission properties with regards to rays. Only applies if +the SolutionMethod is set to RLGO. +Type +RLGOFaceAbsorbingSettings +Access +Read/Write +IntegralEquation +The type of integral equation for perfectly conducting metallic surfaces. Only applies when +SolutionMethod is set to None. +Type +IntegralEquationTypeEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +LocalMeshSize +p.1236 +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. +Type +ParametricExpression +Access +Read/Write +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. +Type +boolean +Access +Read/Write +Medium +The face medium. +Type +Medium +Access +Read/Write +SolutionMethod +The local solution method used for the face. +Type +FaceSolutionMethodEnum +Access +Read/Write +SurfaceCoatingType +The surface coating type for the face. +Type +SurfaceCoatingTypeEnum +Access +Read/Write +Thickness +The face medium thickness. Only applies when the Medium is defined as a Metallic. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Windscreen +The windscreen solution method settings for the face. Only applies if the SolutionMethod is set to +Windscreen. +Type +WindscreenSolutionMethod +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseElementNormals () +Reverses the element normals of the mesh face. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.1238 +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshVertexReference +A reference to a mesh vertex. +Example +p.1239 +local application = cf.Application.GetInstance() +local project = application:NewProject() +advancedMeshSettings = project.Mesher.Settings.Advanced +advancedMeshSettings.CurvilinearSegments + = cf.Enums.MeshCurvilinearOptionsEnum.Disabled +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "100e5" + -- Construct a port and add it to the collection +line = project.Contents.Geometry:AddLine(cf.Point(0, 0, 0), cf.Point(1, 1, 1)) +project.Mesher.Settings.WireRadius = "0.01" +project.Mesher:Mesh() +mesh = line:UnlinkMesh() + -- Add a WireMeshPort +properties = cf.WireMeshPort.GetDefaultProperties() +properties.DefinitionMethod = cf.Enums.WirePortDefinitionMethodEnum.UsingVertex +properties.Vertex = mesh.Vertices[1] +port = project.Contents.Ports:AddWireMeshPort(properties) +Inheritance +The MeshVertexReference object is derived from the object. +Usage locations +The MeshVertexReference object can be accessed from the following locations: +• Properties +◦ FEMLineMeshPort object has property StartVertex. +◦ FEMLineMeshPort object has property EndVertex. +◦ MicrostripMeshPort object has property StartVertex. +◦ MicrostripMeshPort object has property EndVertex. +◦ MeshVertexReference object has property Value. +Property List +Index +Value +Returns the index of this element in the element collection. (Read only number) +Returns the MeshVertexReference associated with this element. (Read only MeshVertexReference) +Property Details +Index +Returns the index of this element in the element collection. +Type +number +Access +Read only +Value +Returns the MeshVertexReference associated with this element. +Type +MeshVertexReference +Access +Read only +MeshWire +An abstract (base) object for mesh segment wires. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The MeshWire object is derived from the AbstractMeshWire object. +The following objects are derived (specialisations) from the MeshWire object: +• MeshSegmentWire +Usage locations +The MeshWire object can be accessed from the following locations: +• Methods +◦ MeshSegmentWireCollection collection has method Item(number). +◦ MeshSegmentWireCollection collection has method Item(string). +Property List +AllowDifferentSegmentRadii +Allow modification of radii per segment. (Read/Write boolean) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetRadiusOnAllSegments (radius Expression) +Set the segment radius. This is a helper method to update the Radius property on all the +segments simultaneously. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AllowDifferentSegmentRadii +Allow modification of radii per segment. +Type +boolean +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.1243 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetRadiusOnAllSegments (radius Expression) +Set the segment radius. This is a helper method to update the Radius property on all the +segments simultaneously. +Input Parameters +radius(Expression) +The new radius. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Mesher +The model mesher. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +sphere = project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1) +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e06" + -- Mesh all geometry in the model +project.Mesher:Mesh() +Inheritance +The Mesher object is derived from the Object object. +Usage locations +The Mesher object can be accessed from the following locations: +• Properties +◦ Model object has property Mesher. +Property List +Label +The object label. (Read/Write string) +Settings +Settings applicable to the creation of the mesh. (Read only GlobalMeshSettings) +Type +The object type string. (Read only string) +VoxelSettings +Settings applicable only to the creation of the voxel mesh. (Read only VoxelSettings) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Mesh () +Mesh the model. The type of mesh created will depend on the solver settings. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1245 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMeshes (items List of Object) +Unlinks the simulation mesh from the given items. (Returns a List of Mesh object.) +UnlinkMeshes (items List of Object, option UnlinkMeshOptionEnum) +Unlinks the simulation mesh from the given items. (Returns a List of Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Settings +Settings applicable to the creation of the mesh. +Type +GlobalMeshSettings +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VoxelSettings +Settings applicable only to the creation of the voxel mesh. +Type +VoxelSettings +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +Mesh () +A table defining the properties. +Mesh the model. The type of mesh created will depend on the solver settings. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMeshes (items List of Object) +Unlinks the simulation mesh from the given items. +Input Parameters +items(List of Object) +The items to unlink the simulation mesh from. +Return +List of Mesh +A list of mesh items created. +UnlinkMeshes (items List of Object, option UnlinkMeshOptionEnum) +Unlinks the simulation mesh from the given items. +Input Parameters +items(List of Object) +The items to unlink the simulation mesh from. +option(UnlinkMeshOptionEnum) +Controls how ports a handled during the unlink process. +Return +List of Mesh +A list of mesh items created. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MessageWindow +p.1248 +The application message window. Messages with various formatting can be written to the message +window. +Example +app = cf.Application.GetInstance() + -- Get the 'MessageWindow' object +messageWindow = app.MessageWindow + -- Log a message and a heading +messageWindow:LogHeading('MessageWindow example') +messageWindow:LogMessage('A message from the example') + -- Show the message window +messageWindow:Show() +Inheritance +The MessageWindow object is derived from the Object object. +Usage locations +The MessageWindow object can be accessed from the following locations: +• Properties +◦ Application object has property MessageWindow. +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +LogError (message string) +Log an error message to the message window. +Altair Feko 2022.3 +2 Application Programming Interface (API) +LogHeading (heading string) +Log a heading to the message window. +LogMessage (message string) +Log a message to the message window. +LogNote (message string) +Log a note to the message window. +LogWarning (message string) +Log a warning message to the message window. +SetProperties (properties Object) +p.1249 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Show () +Show this message window. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.1250 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +LogError (message string) +Log an error message to the message window. +Input Parameters +message(string) +The error message. +LogHeading (heading string) +Log a heading to the message window. +Input Parameters +heading(string) +The heading. +LogMessage (message string) +Log a message to the message window. +Input Parameters +message(string) +The message. +LogNote (message string) +Log a note to the message window. +Input Parameters +message(string) +The note message. +LogWarning (message string) +Log a warning message to the message window. +Input Parameters +message(string) +The warning message. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1251 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Show () +Show this message window. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Metal +A metallic medium. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a metallic medium +metallic = project.Definitions.Media.Metallic:AddMetal() + -- Modify the medium to be imported from a file +properties = {} +properties.SourceDefinitionMethod + = cf.Enums.MediumSourceDefinitionMethodEnum.ImportFromFile +properties.Filename = FEKO_HOME..[[/shared/Resources/Automation/medium.xml]] +metallic:SetProperties(properties) +Inheritance +The Metal object is derived from the Medium object. +Usage locations +The Metal object can be accessed from the following locations: +• Methods +◦ MetalCollection collection has method AddMetal(table). +◦ MetalCollection collection has method AddMetal(Expression, Expression, Expression). +◦ MetalCollection collection has method AddMetal(). +◦ MetalCollection collection has method Item(number). +◦ MetalCollection collection has method Item(string). +Property List +Colour +The medium colour. (Read/Write string) +Conductivity +Medium's conductivity (S/m). Only applicable if DefinitionMethod is FrequencyIndependent. +(Read/Write ParametricExpression) +DefinitionMethod +Metallic definition method. (Read/Write MediumMetallicDefinitionMethodEnum) +Filename +The file describing the medium properties in XML format. (Read/Write FileReference) +FrequencyPoints +The collection of linear interpolated frequency points of metallic properties. Only applicable if +DefinitionMethod is FrequencyList. (Read/Write MetallicFrequencyPointList) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Label +The object label. (Read/Write string) +LossTangent +p.1253 +Medium's magnetic loss tangent. Only applicable if DefinitionMethod is FrequencyIndependent. +(Read/Write ParametricExpression) +RelativePermeability +Medium's relative permeability. Only applicable if DefinitionMethod is FrequencyIndependent. +(Read/Write ParametricExpression) +SourceDefinitionMethod +Specifies the method used for defining the medium. (Read/Write +MediumSourceDefinitionMethodEnum) +SurfaceRoughness +The surface roughness of the metallic medium (RMS value in m). Changing this property will set +SurfaceRoughnessEnabled to true. (Read/Write ParametricExpression) +SurfaceRoughnessEnabled +Specifies if the surface roughness should be used for the metallic medium. (Read/Write boolean) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +Conductivity +Medium's conductivity (S/m). Only applicable if DefinitionMethod is FrequencyIndependent. +Type +ParametricExpression +Access +Read/Write +DefinitionMethod +Metallic definition method. +Type +MediumMetallicDefinitionMethodEnum +Access +Read/Write +Filename +The file describing the medium properties in XML format. +Type +FileReference +Access +Read/Write +FrequencyPoints +The collection of linear interpolated frequency points of metallic properties. Only applicable if +DefinitionMethod is FrequencyList. +Type +MetallicFrequencyPointList +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LossTangent +Medium's magnetic loss tangent. Only applicable if DefinitionMethod is FrequencyIndependent. +Type +ParametricExpression +Access +Read/Write +RelativePermeability +Medium's relative permeability. Only applicable if DefinitionMethod is FrequencyIndependent. +Type +ParametricExpression +Access +Read/Write +SourceDefinitionMethod +Specifies the method used for defining the medium. +Type +MediumSourceDefinitionMethodEnum +Access +Read/Write +SurfaceRoughness +The surface roughness of the metallic medium (RMS value in m). Changing this property will set +SurfaceRoughnessEnabled to true. +Type +ParametricExpression +Access +Read/Write +SurfaceRoughnessEnabled +Specifies if the surface roughness should be used for the metallic medium. +Type +boolean +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.1256 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MetallicFrequencyPoint +Metallic medium frequency point properties. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +metal = project.Definitions.Media.Metallic:AddMetal() +properties = metal:GetProperties() +properties.DefinitionMethod + = cf.Enums.MediumMetallicDefinitionMethodEnum.FrequencyList +properties.FrequencyPoints[1].Frequency = 1e3 +properties.FrequencyPoints[1].RelativePermeability = 1.0 +properties.FrequencyPoints[1].LossTangent = 0 +properties.FrequencyPoints[1].Conductivity = 1e7 +metal:SetProperties(properties) + -- Modify the frequency of the first frequency point +metallicFrequencyPoint = metal.FrequencyPoints[1] +metallicFrequencyPoint.Frequency = 1.5e3 +Inheritance +The MetallicFrequencyPoint object is derived from the CompositeValue object. +Usage locations +The MetallicFrequencyPoint object can be accessed from the following locations: +• Methods +◦ MetallicFrequencyPointList object has method Append(). +◦ MetallicFrequencyPointList object has method Get(number). +Property List +Conductivity +Metallic conductivity value (S/m). (Read/Write ParametricExpression) +Frequency +Metallic frequency value (Hz). (Read/Write ParametricExpression) +LossTangent +Metallic magnetic loss tangent value. (Read/Write ParametricExpression) +RelativePermeability +Metallic relative permittivity value. (Read/Write ParametricExpression) +Property Details +Conductivity +Metallic conductivity value (S/m). +Type +ParametricExpression +Access +Read/Write +Frequency +Metallic frequency value (Hz). +Type +ParametricExpression +Access +Read/Write +LossTangent +Metallic magnetic loss tangent value. +Type +ParametricExpression +Access +Read/Write +RelativePermeability +Metallic relative permittivity value. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +MetallicFrequencyPointList +A list of MetallicFrequencyPoint items. +Usage locations +p.1259 +The MetallicFrequencyPointList object can be accessed from the following locations: +• Properties +◦ Metal object has property FrequencyPoints. +Method List +Append () +Appends a new item to the list. (Returns a MetallicFrequencyPoint object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a MetallicFrequencyPoint +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +MetallicFrequencyPoint +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +MetallicFrequencyPoint +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MicrostripMeshPort +p.1261 +A microstrip mesh port is used to represent a feed line on a microstrip structure. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +MeshPorts.cfx]]}) +union1 = project.Contents.Geometry['Union1'] + -- Unlink the Mesh. 'MicrostripMeshPorts' are automatically generated + -- from 'MicrostripPorts' +union1:UnlinkMesh() + -- Get the 'MicrostripMeshPort' associated with the 'MicrostripPort' labelled + 'MicrostripPort1' +microstripMeshPort = project.Contents.Ports['MicrostripPort1_1'] + -- Query if the mesh port is faulty +isFaulty = microstripMeshPort.Faulty +Inheritance +The MicrostripMeshPort object is derived from the AbstractMeshPort object. +Usage locations +The MicrostripMeshPort object can be accessed from the following locations: +• Methods +◦ PortCollection collection has method AddMicrostripMeshPort(table). +◦ PortCollection collection has method AddMicrostripMeshPort(MeshVertexReference, +MeshVertexReference). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +EndVertex +The end vertex of the port. (Read/Write MeshVertexReference) +Label +The object label. (Read/Write string) +PolarityReversed +The option to reverse polarity of the port. (Read/Write boolean) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +StartVertex +The start vertex of the port. (Read/Write MeshVertexReference) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +EndVertex +The end vertex of the port. +Type +MeshVertexReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +PolarityReversed +The option to reverse polarity of the port. +Type +boolean +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +StartVertex +The start vertex of the port. +Type +MeshVertexReference +Access +Read/Write +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MicrostripPort +A microstrip port is used to represent a feed line on a microstrip structure. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +corner = cf.Point(-0.25, -0.25, 0) +rectangle = project.Contents.Geometry:AddRectangle(corner, 0.5, 0.5) +port = project.Contents.Ports:AddMicrostripPort({rectangle.Edges[1]}) +Inheritance +The MicrostripPort object is derived from the Port object. +Usage locations +The MicrostripPort object can be accessed from the following locations: +• Methods +◦ PortCollection collection has method AddMicrostripPort(table). +◦ PortCollection collection has method AddMicrostripPort(List of Edge). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Edges +Label +The collection of port edges. (Read/Write ObjectReferenceList) +The object label. (Read/Write string) +PolarityReversed +The option to reverse polarity of the port. (Read/Write boolean) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Edges +The collection of port edges. +Type +ObjectReferenceList +Label +Access +Read/Write +The object label. +Type +string +Access +Read/Write +PolarityReversed +The option to reverse polarity of the port. +Type +boolean +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Mirror +The mirror transform. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a flare to mirror +flare = project.Contents.Geometry:AddFlare(cf.Point(0, 0, 0), 1, 1, 1, 0.5, 0.5) + -- Mirror the flare in the UV plane with a 10 degree U plane rotation +mirrorUV = flare.Transforms:AddMirrorInUVPlane(cf.Point(0, 0, 1.2), 10, 0) + -- Modify the mirror transform +mirrorUV.Plane = cf.Enums.MirrorPlaneEnum.UN +mirrorUV.RotationN = 15 +Inheritance +The Mirror object is derived from the Transform object. +Usage locations +The Mirror object can be accessed from the following locations: +• Methods +Property List +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Origin +The coordinates of the origin of the mirror plane. (Read/Write LocalCoordinate) +Plane +The mirror plane specified by the MirrorPlaneEnum, e.g. UV or VN or UN. (Read/Write +MirrorPlaneEnum) +RotationN +The mirror plane's N axis rotation angle (degrees). Only valid if Plane is UN or VN. (Read/Write +ParametricExpression) +RotationU +The mirror plane's U axis rotation angle (degrees). Only valid if Plane is UV or UN. (Read/Write +ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +RotationV +p.1272 +The mirror plane's V axis rotation angle (degrees). Only valid if Plane is UV or VN. (Read/Write +ParametricExpression) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Origin +The coordinates of the origin of the mirror plane. +Type +LocalCoordinate +Access +Read/Write +Plane +The mirror plane specified by the MirrorPlaneEnum, e.g. UV or VN or UN. +Type +MirrorPlaneEnum +Access +Read/Write +RotationN +The mirror plane's N axis rotation angle (degrees). Only valid if Plane is UN or VN. +Type +ParametricExpression +Access +Read/Write +RotationU +The mirror plane's U axis rotation angle (degrees). Only valid if Plane is UV or UN. +Type +ParametricExpression +Access +Read/Write +RotationV +The mirror plane's V axis rotation angle (degrees). Only valid if Plane is UV or VN. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.1276 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Model +The CADFEKO Model. +Example +application = cf.Application.GetInstance() + -- Open an existing project +application:Load({FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.cfx]]}) + -- Create a new project and set the model unit to feet +project = application:NewProject() +project.ModelAttributes.Unit = cf.Enums.ModelUnitEnum.Feet +Inheritance +The Model object is derived from the Object object. +Usage locations +The Model object can be accessed from the following locations: +• Properties +◦ Application object has property Project. +Property List +AbsoluteFilePath +The full path of the project file (directory path and file name including the file extension). (Read +only string) +AbsolutePath +The full directory path of the project file (directory path excluding the file name and extension). +(Read only string) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Contents +The contents section of the CADFEKO model. (Read only ModelContents) +Definitions +The definition section of the CADFEKO model. (Read only ModelDefinitions) +Exporter +The model (geometry and mesh) exporter. (Read only Exporter) +Importer +The model (geometry and mesh) importer. (Read only Importer) +Label +The object label. (Read/Write string) +Mesher +The model mesher. (Read only Mesher) +ModelAttributes +The model attributes. (Read only ModelAttributes) +Optimisation +The optimisation configuration. (Read only Optimisation) +Title +Type +The title of the model. (Read only string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +DeleteEntities (entities List of Object) +Deletes the given list of entities. The entities may be in different collections. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AbsoluteFilePath +The full path of the project file (directory path and file name including the file extension). +Type +string +Access +Read only +AbsolutePath +The full directory path of the project file (directory path excluding the file name and extension). +Type +string +Access +Read only +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Contents +The contents section of the CADFEKO model. +Type +ModelContents +Access +Read only +Definitions +The definition section of the CADFEKO model. +Type +ModelDefinitions +Access +Read only +Exporter +The model (geometry and mesh) exporter. +Type +Exporter +Access +Read only +Importer +The model (geometry and mesh) importer. +Type +Importer +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Mesher +The model mesher. +Type +Mesher +Access +Read only +ModelAttributes +The model attributes. +Type +ModelAttributes +Access +Read only +Optimisation +The optimisation configuration. +Type +Optimisation +Access +Read only +Title +The title of the model. +Type +string +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +DeleteEntities (entities List of Object) +Deletes the given list of entities. The entities may be in different collections. +Input Parameters +entities(List of Object) +The list of entities to delete. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ModelAttributes +The model attributes. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Modify the unit of the model to mm +project.ModelAttributes.Unit = cf.Enums.ModelUnitEnum.Millimetres +Inheritance +The ModelAttributes object is derived from the Object object. +Usage locations +The ModelAttributes object can be accessed from the following locations: +• Properties +◦ Model object has property ModelAttributes. +Property List +Label +Type +Unit +The object label. (Read/Write string) +The object type string. (Read only string) +The unit used for all distances and dimensions specified by the ModelUnitEnum, e.g. Meters, Feet, +etc. (Read/Write ModelUnitEnum) +UnitFactor +An arbitrary unit conversion factor with respect to metres. The value is only valid when ModelUnit +is set to Specified. (Read/Write ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1283 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Unit +The unit used for all distances and dimensions specified by the ModelUnitEnum, e.g. Meters, Feet, +etc. +Type +ModelUnitEnum +Access +Read/Write +UnitFactor +An arbitrary unit conversion factor with respect to metres. The value is only valid when ModelUnit +is set to Specified. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.1284 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ModelContents +The contents section of the CADFEKO model. +Example +p.1285 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a cuboid by accessing the model contents +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +Inheritance +The ModelContents object is derived from the Object object. +Usage locations +The ModelContents object can be accessed from the following locations: +• Properties +◦ Model object has property Contents. +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +SolutionSettings +The model solution settings. (Read only SolutionSettings) +Type +The object type string. (Read only string) +Collection List +CableHarnesses +The collection of cable harnesses in the model. (CableHarnessCollection of CableHarness.) +Cutplanes +The collection of cutplanes in the model. (CutplaneCollection of Cutplane.) +Geometry +The collection of geometry in the model. (GeometryCollection of Geometry.) +MeshRefinementRules +The collection of mesh refinement rules in the model. (MeshRefinementRuleCollection of +MeshRefinementRule.) +Meshes +The collection of editable (unlinked/imported) meshes in the model. (MeshCollection of Mesh.) +Ports +The collection of ports in the model. (PortCollection of Port.) +SolutionConfigurations +The collection of solution configurations in the model. (SolutionConfigurationCollection of +SolutionConfiguration.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +SolutionSettings +The model solution settings. +Type +SolutionSettings +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +CableHarnesses +The collection of cable harnesses in the model. +Type +Cutplanes +CableHarnessCollection +The collection of cutplanes in the model. +Type +CutplaneCollection +Geometry +The collection of geometry in the model. +Type +GeometryCollection +MeshRefinementRules +The collection of mesh refinement rules in the model. +Type +Meshes +MeshRefinementRuleCollection +The collection of editable (unlinked/imported) meshes in the model. +Type +MeshCollection +Ports +The collection of ports in the model. +Type +PortCollection +SolutionConfigurations +The collection of solution configurations in the model. +Type +SolutionConfigurationCollection +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ModelDefinitions +The definitions section of the CADFEKO model. +Example +p.1289 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a variable using the model definitions +frequencyVar = project.Definitions.Variables:Add("frequency", 100e6, "The operating + frequency") +Inheritance +The ModelDefinitions object is derived from the Object object. +Usage locations +The ModelDefinitions object can be accessed from the following locations: +• Properties +◦ Model object has property Definitions. +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Cables +A grouping of cable functionality. (Read only Cables) +Label +Media +Type +The object label. (Read/Write string) +The collection of media in the model. (Read only Media) +The object type string. (Read only string) +Collection List +FieldDataList +The collection of field data definitions in the model. (FieldDataCollection of FieldData.) +NamedPoints +The collection of named points in the model. (NamedPointCollection of NamedPoint.) +Variables +The collection of variables in the model. (VariableCollection of Variable.) +WorkSurfaces +The collection of work surfaces in the model. (WorkSurfaceCollection of WorkSurface.) +Workplanes +The collection of work planes in the model. (WorkplaneCollection of Workplane.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Cables +A grouping of cable functionality. +Type +Cables +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Media +The collection of media in the model. +Type +Media +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +FieldDataList +The collection of field data definitions in the model. +Type +FieldDataCollection +NamedPoints +The collection of named points in the model. +Type +Variables +NamedPointCollection +The collection of variables in the model. +Type +VariableCollection +WorkSurfaces +The collection of work surfaces in the model. +Type +WorkSurfaceCollection +Workplanes +The collection of work planes in the model. +Type +WorkplaneCollection +Method Details +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.1292 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ModelMeshInfo +The quality of the mesh can be examined through these properties. +Example +p.1293 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Waveguide_Divider.cfx]]}) +geometry = project.Contents.Geometry["Union2"] + -- Get the triangle count of the simulation mesh +triangleCount = geometry.TriangleCount + -- Ensure the average edge length of the model mesh is smaller than 2.0 +mesh = geometry:UnlinkMesh() +assert(mesh.ModelMeshInfo.AverageEdgeLength < 2.0) +Inheritance +The ModelMeshInfo object is derived from the Object object. +Usage locations +The ModelMeshInfo object can be accessed from the following locations: +• Properties +Property List +AverageCurvilinearEdgeLength +The average mesh curvilinear edge length. (Read only number) +AverageCurvilinearSegmentLength +The average mesh curvilinear segment length. (Read only number) +AverageEdgeLength +The average mesh edge length. (Read only number) +AverageSegmentLength +The average mesh segment length. (Read only number) +AverageTetrahedronEdgeLength +The average mesh tetrahedron edge length. (Read only number) +AverageVoxelLength +The average mesh voxel length. (Read only number) +CableSegmentCount +Get the total number of cable segment elements. (Read only number) +CurvilinearEdgeStandardDeviation +The standard deviation of curvilinear mesh edge length. (Read only number) +CurvilinearSegmentCount +The number of curvilinear line segments in the mesh. (Read only number) +CurvilinearSegmentStandardDeviation +The standard deviation of mesh curvilinear segment length. (Read only number) +CurvilinearTriangleCount +The number of curvilinear triangles in the mesh. (Read only number) +EdgeStandardDeviation +The standard deviation of mesh edge length. (Read only number) +Label +The object label. (Read/Write string) +MaximumCurvilinearEdgeLength +The maximum mesh curvilinear edge length. (Read only number) +MaximumCurvilinearSegmentLength +The maximum mesh curvilinear segment length. (Read only number) +MaximumEdgeLength +The maximum mesh edge length. (Read only number) +MaximumElementAngle +The maximum mesh element angle. (Read only number) +MaximumSegmentLength +The maximum mesh segment length. (Read only number) +MaximumTetrahedronEdgeLength +The maximum mesh tetrahedron edge length. (Read only number) +MaximumVoxelLength +The maximum mesh voxel length. (Read only number) +MeshElementCount +Get the total number of mesh elements. (Read only number) +MinimumCurvilinearEdgeLength +The minimum mesh curvilinear edge length. (Read only number) +MinimumCurvilinearSegmentLength +The minimum mesh curvilinear segment length. (Read only number) +MinimumEdgeLength +The minimum mesh edge length. (Read only number) +MinimumElementAngle +The minimum mesh element angle. (Read only number) +MinimumSegmentLength +The minimum mesh segment length. (Read only number) +MinimumTetrahedronEdgeLength +The minimum mesh tetrahedron edge length. (Read only number) +MinimumVoxelLength +The minimum mesh voxel length. (Read only number) +PolygonCount +The total number of polygons in the mesh. (Read only number) +SegmentCount +The total number of segments in the mesh. (Read only number) +SegmentStandardDeviation +The standard deviation of mesh segment length. (Read only number) +TetrahedronCount +The total number of tetrahedra in the mesh. (Read only number) +TetrahedronEdgeStandardDeviation +The standard deviation of mesh tetradron edge length. (Read only number) +TriangleCount +The number of triangles in the mesh. This is including both flat and curvilinear triangles. (Read +only number) +Type +The object type string. (Read only string) +VoxelCount +The number of FDTD voxels in the mesh. (Read only number) +VoxelStandardDeviation +The standard deviation of mesh voxel length. (Read only number) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AverageCurvilinearEdgeLength +The average mesh curvilinear edge length. +Type +number +Access +Read only +AverageCurvilinearSegmentLength +The average mesh curvilinear segment length. +Type +number +Access +Read only +AverageEdgeLength +The average mesh edge length. +Type +number +Access +Read only +AverageSegmentLength +The average mesh segment length. +Type +number +Access +Read only +AverageTetrahedronEdgeLength +The average mesh tetrahedron edge length. +Type +number +Access +Read only +AverageVoxelLength +The average mesh voxel length. +Type +number +Access +Read only +CableSegmentCount +Get the total number of cable segment elements. +Type +number +Access +Read only +CurvilinearEdgeStandardDeviation +The standard deviation of curvilinear mesh edge length. +Type +number +Access +Read only +CurvilinearSegmentCount +The number of curvilinear line segments in the mesh. +Type +number +Access +Read only +CurvilinearSegmentStandardDeviation +The standard deviation of mesh curvilinear segment length. +Type +number +Access +Read only +CurvilinearTriangleCount +The number of curvilinear triangles in the mesh. +Type +number +Access +Read only +EdgeStandardDeviation +The standard deviation of mesh edge length. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +MaximumCurvilinearEdgeLength +The maximum mesh curvilinear edge length. +Type +number +Access +Read only +MaximumCurvilinearSegmentLength +The maximum mesh curvilinear segment length. +Type +number +Access +Read only +MaximumEdgeLength +The maximum mesh edge length. +Type +number +Access +Read only +MaximumElementAngle +The maximum mesh element angle. +Type +number +Access +Read only +MaximumSegmentLength +The maximum mesh segment length. +Type +number +Access +Read only +MaximumTetrahedronEdgeLength +The maximum mesh tetrahedron edge length. +Type +number +Access +Read only +MaximumVoxelLength +The maximum mesh voxel length. +Type +number +Access +Read only +MeshElementCount +Get the total number of mesh elements. +Type +number +Access +Read only +MinimumCurvilinearEdgeLength +The minimum mesh curvilinear edge length. +Type +number +Access +Read only +MinimumCurvilinearSegmentLength +The minimum mesh curvilinear segment length. +Type +number +Access +Read only +MinimumEdgeLength +The minimum mesh edge length. +Type +number +Access +Read only +MinimumElementAngle +The minimum mesh element angle. +Type +number +Access +Read only +MinimumSegmentLength +The minimum mesh segment length. +Type +number +Access +Read only +MinimumTetrahedronEdgeLength +The minimum mesh tetrahedron edge length. +Type +number +Access +Read only +MinimumVoxelLength +The minimum mesh voxel length. +Type +number +Access +Read only +PolygonCount +The total number of polygons in the mesh. +Type +number +Access +Read only +SegmentCount +The total number of segments in the mesh. +Type +number +Access +Read only +SegmentStandardDeviation +The standard deviation of mesh segment length. +Type +number +Access +Read only +TetrahedronCount +The total number of tetrahedra in the mesh. +Type +number +Access +Read only +TetrahedronEdgeStandardDeviation +The standard deviation of mesh tetradron edge length. +Type +number +Access +Read only +TriangleCount +The number of triangles in the mesh. This is including both flat and curvilinear triangles. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VoxelCount +The number of FDTD voxels in the mesh. +Type +number +Access +Read only +VoxelStandardDeviation +The standard deviation of mesh voxel length. +Type +number +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ModelSymmetry +The model symmetry planes. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Access the 'ModelSymmetry' object and set the X plane symmetry to geometric +project.Contents.SolutionSettings.ModelSymmetry.PlaneX + = cf.Enums.ModelSymmetryTypeEnum.Geometric +Inheritance +The ModelSymmetry object is derived from the Object object. +Usage locations +The ModelSymmetry object can be accessed from the following locations: +• Properties +◦ SolutionSettings object has property ModelSymmetry. +Property List +Label +The object label. (Read/Write string) +PlaneX +X-plane symmetry type. (Read/Write ModelSymmetryTypeEnum) +PlaneY +Y-plane symmetry type. (Read/Write ModelSymmetryTypeEnum) +PlaneZ +Z-plane symmetry type. (Read/Write ModelSymmetryTypeEnum) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1304 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +PlaneX +X-plane symmetry type. +Type +ModelSymmetryTypeEnum +Access +Read/Write +PlaneY +Y-plane symmetry type. +Type +ModelSymmetryTypeEnum +Access +Read/Write +PlaneZ +Z-plane symmetry type. +Type +ModelSymmetryTypeEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +NamedPoint +p.1306 +A named point in 3D space. This object lives in the CADFEKO project. NamedPoints are defined by +expressions. Mathematical operations cannot be done on NamedPoints, use 'Point' instead. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a coordinate (x,y,z) for each plane +x = project.Definitions.Variables:Add("x", 1) +y = project.Definitions.Variables:Add("y", 1.1) +z = project.Definitions.Variables:Add("z", 0.9) + -- Create a named point variable from the coordinate variables +pt1 = project.Definitions.NamedPoints:Add("pt1", "x", "y", "z") + -- Create a named point variable using numbers and strings +pt2 = project.Definitions.NamedPoints:Add("pt2", x.EvaluatedValue * 2, 1.1, "z") + -- Modify various properties of pt2 +pt2.Label = "point2" +pt2.Point.V = pt1.Point.V +pt2.Point.N = x.EvaluatedValue * z.EvaluatedValue +Inheritance +The NamedPoint object is derived from the Object object. +Usage locations +The NamedPoint object can be accessed from the following locations: +• Methods +◦ NamedPointCollection collection has method Add(string, Expression, Expression, Expression). +◦ NamedPointCollection collection has method Item(number). +◦ NamedPointCollection collection has method Item(string). +Property List +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Point +Type +The named point local coordinates. (Read/Write LocalCoordinate) +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetPosition (X Expression, Y Expression, Z Expression) +Sets the position of the named point. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Point +The named point local coordinates. +Type +LocalCoordinate +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetPosition (X Expression, Y Expression, Z Expression) +Sets the position of the named point. +Input Parameters +X(Expression) +The X coordinate expression. +Y(Expression) +The Y coordinate expression. +Z(Expression) +The Z coordinate expression. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +NearField +A solution near field request. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a near field request +nearFieldRequest = + project.Contents.SolutionConfigurations[1].NearFields:AddCartesian(0,0,0,1,1,1,3,3,3) +Inheritance +The NearField object is derived from the Object object. +Usage locations +The NearField object can be accessed from the following locations: +• Properties +◦ NearFieldOptimisationGoal object has property FocusSource. +• Methods +◦ NearFieldCollection collection has method Add(table). +◦ NearFieldCollection collection has method AddSpecifiedPoints(List of Point). +◦ NearFieldCollection collection has method AddCartesian(Expression, Expression, Expression, +Expression, Expression, Expression, Expression, Expression, Expression). +◦ NearFieldCollection collection has method AddCartesianBoundary(Expression, Expression, +Expression, Expression, Expression, Expression, Expression, Expression, Expression). +◦ NearFieldCollection collection has method AddConical(Expression, Expression, Expression, +Expression, Expression, Expression, Expression, Expression). +◦ NearFieldCollection collection has method AddCylindrical(Expression, Expression, Expression, +Expression, Expression, Expression, Expression, Expression, Expression). +◦ NearFieldCollection collection has method AddCylindricalX(Expression, Expression, Expression, +Expression, Expression, Expression, Expression, Expression, Expression). +◦ NearFieldCollection collection has method AddCylindricalY(Expression, Expression, Expression, +Expression, Expression, Expression, Expression, Expression, Expression). +◦ NearFieldCollection collection has method AddSpherical(Expression, Expression, Expression, +Expression, Expression, Expression, Expression, Expression, Expression). +◦ NearFieldCollection collection has method Item(number). +◦ NearFieldCollection collection has method Item(string). +Property List +Advanced +Advanced properties for the near field request. (Read/Write NearFieldAdvancedSettings) +BoundarySurface +The near field Cartesian boundary surface settings. Only valid if DefinitionMethod is +CartesianBoundary. (Read/Write NearFieldBoundarySurface) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CartesianRequestPoints +The near field Cartesian request points. Only valid if DefinitionMethod is Cartesian. (Read/Write +CartesianRequestPoints) +ConicalRequestPoints +The near field Conical request points. Only valid if DefinitionMethod is Conical. (Read/Write +ConicalRequestPoints) +CylindricalRequestPoints +The near field Cylindrical request points. Only valid if DefinitionMethod is Cylindrical. (Read/Write +CylindricalRequestPoints) +CylindricalXRequestPoints +The near field Cylindrical (X axis) request points. Only valid if DefinitionMethod is CylindricalX. +(Read/Write CylindricalXRequestPoints) +CylindricalYRequestPoints +The near field Cylindrical (Y axis) request points. Only valid if DefinitionMethod is CylindricalY. +(Read/Write CylindricalYRequestPoints) +DefinitionMethod +The definition method/coordinate system. (Read/Write NearFieldDefinitionMethodEnum) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +PointSpecificationMethod +The point specification method. (Read/Write PointSpecificationEnum) +SampleOnEdgesEnabled +Activates sampling on edges. (Read/Write boolean) +ScopeSettings +Near field scope settings. (Read/Write ScopeSettings) +SpecifiedRequestPoints +The near field group for Specified request points. Only valid if DefinitionMethod is SpecifiedPoints. +(Read/Write SpecifiedRequestPoints) +SphericalRequestPoints +The near field Spherical request points. Only valid if DefinitionMethod is Spherical. (Read/Write +SphericalRequestPoints) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Advanced +Advanced properties for the near field request. +Type +NearFieldAdvancedSettings +Access +Read/Write +BoundarySurface +The near field Cartesian boundary surface settings. Only valid if DefinitionMethod is +CartesianBoundary. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +NearFieldBoundarySurface +Access +Read/Write +BoundingBox +p.1315 +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CartesianRequestPoints +The near field Cartesian request points. Only valid if DefinitionMethod is Cartesian. +Type +CartesianRequestPoints +Access +Read/Write +ConicalRequestPoints +The near field Conical request points. Only valid if DefinitionMethod is Conical. +Type +ConicalRequestPoints +Access +Read/Write +CylindricalRequestPoints +The near field Cylindrical request points. Only valid if DefinitionMethod is Cylindrical. +Type +CylindricalRequestPoints +Access +Read/Write +CylindricalXRequestPoints +The near field Cylindrical (X axis) request points. Only valid if DefinitionMethod is CylindricalX. +Type +CylindricalXRequestPoints +Access +Read/Write +CylindricalYRequestPoints +The near field Cylindrical (Y axis) request points. Only valid if DefinitionMethod is CylindricalY. +Type +CylindricalYRequestPoints +Access +Read/Write +DefinitionMethod +The definition method/coordinate system. +Type +NearFieldDefinitionMethodEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +PointSpecificationMethod +The point specification method. +Type +PointSpecificationEnum +Access +Read/Write +SampleOnEdgesEnabled +Activates sampling on edges. +Type +boolean +Access +Read/Write +ScopeSettings +Near field scope settings. +Type +ScopeSettings +Access +Read/Write +SpecifiedRequestPoints +The near field group for Specified request points. Only valid if DefinitionMethod is SpecifiedPoints. +Type +SpecifiedRequestPoints +Access +Read/Write +SphericalRequestPoints +The near field Spherical request points. Only valid if DefinitionMethod is Spherical. +Type +SphericalRequestPoints +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldAdvancedSettings +The advanced near field settings. +Example +p.1320 +application = cf.Application.GetInstance() +project = application:NewProject() +nearField = + project.Contents.SolutionConfigurations[1].NearFields:AddCartesian(1,0,0,0,0,0,11,1,1) + -- Get the NearFieldAdvancedSettings +nearFieldAdvancedSettings = nearField.Advanced + -- Activate the calculation of the electric fields +nearFieldAdvancedSettings.CalculateElectricFields = true +Inheritance +The NearFieldAdvancedSettings object is derived from the CompositeValue object. +Usage locations +The NearFieldAdvancedSettings object can be accessed from the following locations: +• Properties +◦ NearField object has property Advanced. +• Methods +◦ NearFieldAdvancedSettingsList object has method Append(). +◦ NearFieldAdvancedSettingsList object has method Get(number). +Property List +CalculateElectricFields +Activate the calculation of the electric field components. Only valid if CalculationType is Fields. +(Read/Write boolean) +CalculateMagneticFields +Activate the calculation of the magnetic field components. Only valid if CalculationType is Fields. +(Read/Write boolean) +CalculationType +The calculation type. (Read/Write NearFieldCalculationTypeEnum) +ExportSettings +Near field export settings. (Read/Write NearFieldExportSettings) +OnlyScatteredPartCalculationEnabled +Calculate only the scattered part of the field. (Read/Write boolean) +PotentialType +The potential type. Only valid if CalculationType is Potentials. (Read/Write +NearFieldPotentialTypeEnum) +Property Details +CalculateElectricFields +Activate the calculation of the electric field components. Only valid if CalculationType is Fields. +Type +boolean +Access +Read/Write +CalculateMagneticFields +Activate the calculation of the magnetic field components. Only valid if CalculationType is Fields. +Type +boolean +Access +Read/Write +CalculationType +The calculation type. +Type +NearFieldCalculationTypeEnum +Access +Read/Write +ExportSettings +Near field export settings. +Type +NearFieldExportSettings +Access +Read/Write +OnlyScatteredPartCalculationEnabled +Calculate only the scattered part of the field. +Type +boolean +Access +Read/Write +PotentialType +The potential type. Only valid if CalculationType is Potentials. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +NearFieldPotentialTypeEnum +Access +Read/Write +p.1322 +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldAdvancedSettingsList +A list of NearFieldAdvancedSettings items. +Method List +Append () +p.1323 +Appends a new item to the list. (Returns a NearFieldAdvancedSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a NearFieldAdvancedSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +NearFieldAdvancedSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +NearFieldAdvancedSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1324 +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldBoundarySurface +The near field Cartesian boundary surface settings. +Example +p.1325 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a NearFiled starting at (1,0,0) ending at (0,0,0) with 11 points along X +nearField = + project.Contents.SolutionConfigurations[1].NearFields:AddCartesianBoundary(0,0,0, + 1,1,1, + 11,11,11) +boundarySurface = nearField.BoundarySurface + -- Get enabled state of the positive U face of the Cartesian bounding box +positiveUEnabled = boundarySurface.PositiveUEnabled + -- Set the positive U face of the Cartesian bounding box to be disabled +boundarySurface.PositiveUEnabled = false +Inheritance +The NearFieldBoundarySurface object is derived from the CompositeValue object. +Usage locations +The NearFieldBoundarySurface object can be accessed from the following locations: +• Properties +◦ NearField object has property BoundarySurface. +• Methods +◦ NearFieldBoundarySurfaceList object has method Append(). +◦ NearFieldBoundarySurfaceList object has method Get(number). +Property List +NegativeNEnabled +Enables the negative N Cartesian boundary face. Only valid if DefinitionMethod is +CartesianBoundary. (Read/Write boolean) +NegativeUEnabled +Enables the negative U Cartesian boundary face. Only valid if DefinitionMethod is +CartesianBoundary. (Read/Write boolean) +NegativeVEnabled +Enables the negative V Cartesian boundary face. Only valid if DefinitionMethod is +CartesianBoundary. (Read/Write boolean) +PositiveNEnabled +Enables the positive N Cartesian boundary face. Only valid if DefinitionMethod is +CartesianBoundary. (Read/Write boolean) +PositiveUEnabled +Enables the positive U Cartesian boundary face. Only valid if DefinitionMethod is +CartesianBoundary. (Read/Write boolean) +PositiveVEnabled +Enables the positive V Cartesian boundary face. Only valid if DefinitionMethod is +CartesianBoundary. (Read/Write boolean) +Property Details +NegativeNEnabled +Enables the negative N Cartesian boundary face. Only valid if DefinitionMethod is +CartesianBoundary. +Type +boolean +Access +Read/Write +NegativeUEnabled +Enables the negative U Cartesian boundary face. Only valid if DefinitionMethod is +CartesianBoundary. +Type +boolean +Access +Read/Write +NegativeVEnabled +Enables the negative V Cartesian boundary face. Only valid if DefinitionMethod is +CartesianBoundary. +Type +boolean +Access +Read/Write +PositiveNEnabled +Enables the positive N Cartesian boundary face. Only valid if DefinitionMethod is +CartesianBoundary. +Type +boolean +Access +Read/Write +PositiveUEnabled +Enables the positive U Cartesian boundary face. Only valid if DefinitionMethod is +CartesianBoundary. +Type +boolean +Access +Read/Write +PositiveVEnabled +Enables the positive V Cartesian boundary face. Only valid if DefinitionMethod is +CartesianBoundary. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldBoundarySurfaceList +A list of NearFieldBoundarySurface items. +Method List +Append () +p.1328 +Appends a new item to the list. (Returns a NearFieldBoundarySurface object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a NearFieldBoundarySurface +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +NearFieldBoundarySurface +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +NearFieldBoundarySurface +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1329 +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldDataFileStructure +A near field data file structure specification. +Example +p.1330 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Created new NearFieldFileStructure from a set of default properties +properties = cf.NearFieldDataFileStructure.GetDefaultProperties() +properties.CartesianStructure.Height = "2" +properties.CartesianStructure.Width = "2" +properties.CartesianStructure.UPoints = "11" +properties.CartesianStructure.VPoints = "11" +properties.EFieldFilename = [[EFieldFileName]] +properties.HFieldFilename = [[HFieldFileName]] +nearFieldData = + project.Definitions.FieldDataList:AddNearFieldDataFileStructure(properties) +Inheritance +The NearFieldDataFileStructure object is derived from the FieldData object. +Usage locations +The NearFieldDataFileStructure object can be accessed from the following locations: +• Methods +◦ FieldDataCollection collection has method AddNearFieldDataFileStructure(table). +Property List +CartesianStructure +The near field data cartesian source definition. Only valid if CoordinateType is Cartesian. (Read/ +Write CartesianStructure) +CoordinateType +Select the coordinate type. (Read/Write NearFieldDataCoordinateTypeEnum) +CylindricalStructure +The near field data cartesian source definition. Only valid if CoordinateType is Cylindrical. (Read/ +Write CylindricalStructure) +DataBlockNumber +The data block that is first read from. (Read/Write ParametricExpression) +DataType +Select the data type. (Read/Write NearFieldDataFileStructureDataTypeEnum) +EFieldFilename +Import file containing the E-Field definition. (Read/Write FileReference) +HFieldFilename +Import directory containing H-Field definition. (Read/Write FileReference) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +ReadFromLine +Which line to start reading from. (Read/Write ParametricExpression) +SampleEdgesEnabled +Includes samples on edges of face if enabled. (Read/Write boolean) +SourceType +Select the source type. (Read/Write NearFieldDataSourceTypeEnum) +SphericalStructure +The near field data cartesian source definition. Only valid if CoordinateType is Spherical. (Read/ +Write SphericalStructure) +Type +The object type string. (Read only string) +ValidityRegionsSwapped +Consider the fields to be valid on the inside of the region when checked. (Read/Write boolean) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1332 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CartesianStructure +The near field data cartesian source definition. Only valid if CoordinateType is Cartesian. +Type +CartesianStructure +Access +Read/Write +CoordinateType +Select the coordinate type. +Type +NearFieldDataCoordinateTypeEnum +Access +Read/Write +CylindricalStructure +The near field data cartesian source definition. Only valid if CoordinateType is Cylindrical. +Type +CylindricalStructure +Access +Read/Write +DataBlockNumber +The data block that is first read from. +Type +ParametricExpression +Access +Read/Write +DataType +Select the data type. +Type +NearFieldDataFileStructureDataTypeEnum +Access +Read/Write +EFieldFilename +Import file containing the E-Field definition. +Type +FileReference +Access +Read/Write +HFieldFilename +Import directory containing H-Field definition. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +ReadFromLine +Which line to start reading from. +Type +ParametricExpression +Access +Read/Write +SampleEdgesEnabled +Includes samples on edges of face if enabled. +Type +boolean +Access +Read/Write +SourceType +Select the source type. +Type +NearFieldDataSourceTypeEnum +Access +Read/Write +SphericalStructure +The near field data cartesian source definition. Only valid if CoordinateType is Spherical. +Type +SphericalStructure +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +ValidityRegionsSwapped +Consider the fields to be valid on the inside of the region when checked. +Type +boolean +Access +Read/Write +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.1337 +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldDataFullImport +An aperture data using full file import. +Example +p.1338 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Import 'NearFieldDataFullImport' from previously a exported 'NearField' +nearFieldData = project.Definitions.FieldDataList: + AddNearFieldDataFullImportUsingKnownFileFormat([[NearFieldData.nfd]]) +Inheritance +The NearFieldDataFullImport object is derived from the FieldData object. +Usage locations +The NearFieldDataFullImport object can be accessed from the following locations: +• Properties +◦ NearFieldReceivingAntenna object has property FieldData. +• Methods +◦ FieldDataCollection collection has method AddNearFieldDataFullImport(table). +◦ FieldDataCollection collection has method +AddNearFieldDataFullImportUsingKnownFileFormat(string). +Property List +DataBlockNumber +The data block that is first read from. (Read/Write ParametricExpression) +DataType +Select the data type. (Read/Write NearFieldDataFullImportDataTypeEnum) +Directory +Import directory containing aperture data. (Read/Write FileReference) +EFieldFilename +Import file containing the E-Field aperture data. Only applicable when the source type is LoadEfe +or LoadEfeHfe. (Read/Write FileReference) +Filename +Import file containing the aperture data. (Read/Write FileReference) +HFieldFilename +Import file containing the H-Field aperture data. Only applicable when the source type is LoadHfe +or LoadEfeHfe. (Read/Write FileReference) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +SourceType +Select the source file type. Only applicable when the data type is CartesianBoundary. (Read/Write +NearFieldDataSourceTypeEnum) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +DataBlockNumber +The data block that is first read from. +Type +ParametricExpression +Access +Read/Write +DataType +Select the data type. +Type +NearFieldDataFullImportDataTypeEnum +Access +Read/Write +Directory +Import directory containing aperture data. +Type +FileReference +Access +Read/Write +EFieldFilename +Import file containing the E-Field aperture data. Only applicable when the source type is LoadEfe +or LoadEfeHfe. +Type +FileReference +Access +Read/Write +Filename +Import file containing the aperture data. +Type +FileReference +Access +Read/Write +HFieldFilename +Import file containing the H-Field aperture data. Only applicable when the source type is LoadHfe +or LoadEfeHfe. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +SourceType +Select the source file type. Only applicable when the data type is CartesianBoundary. +Type +NearFieldDataSourceTypeEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.1344 +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldExportSettings +Near field export options. +Example +p.1345 +application = cf.Application.GetInstance() +project = application:NewProject() +nearField = + project.Contents.SolutionConfigurations[1].NearFields:AddCartesian(1,0,0,0,0,0,11,1,1) + -- Get the 'NearFieldExportSettings' +nearFieldExportSettings = nearField.Advanced.ExportSettings + -- Specify that the data should be exported to an ASCII file +nearFieldExportSettings.ASCIIEnabled = true +Inheritance +The NearFieldExportSettings object is derived from the CompositeValue object. +Usage locations +The NearFieldExportSettings object can be accessed from the following locations: +• Properties +◦ NearFieldAdvancedSettings object has property ExportSettings. +• Methods +◦ NearFieldExportSettingsList object has method Append(). +◦ NearFieldExportSettingsList object has method Get(number). +Property List +ASCIIEnabled +Export fields to ASCII file (*.efe, *.hfe). (Read/Write boolean) +OutFileEnabled +Export fields to *.out file. (Read/Write boolean) +SEMCADEnabled +Export fields to SEMCAD *.dat file. (Read/Write boolean) +SPARK3DEnabled +Export fields to SPARK3D *.fse file. (Read/Write boolean) +Property Details +ASCIIEnabled +Export fields to ASCII file (*.efe, *.hfe). +Type +boolean +Access +Read/Write +OutFileEnabled +Export fields to *.out file. +Type +boolean +Access +Read/Write +SEMCADEnabled +Export fields to SEMCAD *.dat file. +Type +boolean +Access +Read/Write +SPARK3DEnabled +Export fields to SPARK3D *.fse file. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldExportSettingsList +A list of NearFieldExportSettings items. +Method List +Append () +p.1347 +Appends a new item to the list. (Returns a NearFieldExportSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a NearFieldExportSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +NearFieldExportSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +NearFieldExportSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1348 +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldOptimisationGoal +A near field optimisation goal. +Example +p.1349 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Horn_error_estimates.cfx]]}) +nearField = project.Contents.SolutionConfigurations[1].NearFields[1] +search = + project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) + -- Create a near field optimisation goal with focus on the near field request +properties = cf.NearFieldOptimisationGoal.GetDefaultProperties() +properties.FocusSource = nearField +properties.GoalOperator = cf.Enums.OptimisationGoalOperatorEnum.Maximise +properties.ProcessingSteps[1].Operation + = cf.Enums.OptimisationGoalProcessingStepsEnum.Log +nearFieldGoal = search.Goals:AddNearFieldGoal(properties) + -- Set the directional component in the X direction +properties = nearFieldGoal:GetProperties() +properties.DirectionalComponent = cf.Enums.OptimisationNearFieldDirectComponentEnum.X +properties.ProcessingSteps[1].Operation + = cf.Enums.OptimisationGoalProcessingStepsEnum.Real +nearFieldGoal:SetProperties(properties) +Inheritance +The NearFieldOptimisationGoal object is derived from the OptimisationGoal object. +Usage locations +The NearFieldOptimisationGoal object can be accessed from the following locations: +• Methods +◦ OptimisationGoalCollection collection has method AddNearFieldGoal(table). +Property List +CoordinateSystem +Sets the coordinate system. (Read/Write OptimisationNearFieldCoordSystemEnum) +DirectionalComponent +Sets the directional component. (Read/Write OptimisationNearFieldDirectComponentEnum) +FocusSource +Set the focus source to a specified source object. The intended usage is for when the source is +defined in CADFEKO. (Read/Write NearField) +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. (Read/Write string) +FocusType +Sets the focus type. (Read/Write OptimisationNearFieldFocusTypeEnum) +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +(Read/Write OptimisationGoalOperatorEnum) +Label +The object label. (Read/Write string) +Objective +The objective describes a state that the optimisation process should attempt to achieve. (Read +only OptimisationGoalObjective) +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. (Read/Write OptimisationGoalProcessingStepsList) +Type +The object type string. (Read only string) +Weight +Specify the optimisation weight. (Read/Write ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CoordinateSystem +Sets the coordinate system. +Type +OptimisationNearFieldCoordSystemEnum +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read/Write +DirectionalComponent +Sets the directional component. +Type +OptimisationNearFieldDirectComponentEnum +Access +Read/Write +FocusSource +p.1351 +Set the focus source to a specified source object. The intended usage is for when the source is +defined in CADFEKO. +Type +NearField +Access +Read/Write +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. +Type +string +Access +Read/Write +FocusType +Sets the focus type. +Type +OptimisationNearFieldFocusTypeEnum +Access +Read/Write +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +Type +OptimisationGoalOperatorEnum +Label +Access +Read/Write +The object label. +Type +string +Access +Read/Write +Objective +The objective describes a state that the optimisation process should attempt to achieve. +Type +OptimisationGoalObjective +Access +Read only +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. +Type +OptimisationGoalProcessingStepsList +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Weight +Specify the optimisation weight. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1353 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldReceivingAntenna +A solution near field receiving antenna request. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +p.1354 +standardConfiguration = + project.Contents.SolutionConfigurations['StandardConfiguration1'] +nearFieldData = project.Definitions.FieldDataList: + AddNearFieldDataFullImportUsingKnownFileFormat([[NearFieldData.nfd]]) + -- Create a 'NearFieldReceivingAntenna' from nearFieldData +properties = cf.NearFieldReceivingAntenna.GetDefaultProperties() +properties.DefinitionType + = cf.Enums.NearFieldReceivingAntennaDataTypeEnum.ReferenceEnclosedRegion +properties.FieldData = nearFieldData +nearFieldReceivingAntenna = + standardConfiguration.NearFieldReceivingAntennas:Add(properties) + -- Hide the 'NearFieldReceivingAntenna' +nearFieldReceivingAntenna.Visible = false + -- Delete this 'NearFieldReceivingAntenna' +nearFieldReceivingAntenna:Delete() +Inheritance +The NearFieldReceivingAntenna object is derived from the BaseFieldReceivingAntenna object. +Usage locations +The NearFieldReceivingAntenna object can be accessed from the following locations: +• Methods +◦ NearFieldReceivingAntennaCollection collection has method Add(table). +◦ NearFieldReceivingAntennaCollection collection has method Item(number). +◦ NearFieldReceivingAntennaCollection collection has method Item(string). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +BoxReferencePoint +The reference point of the definition. (Read/Write LocalCoordinate) +CombinedFacesFieldData +The collection of file structure, near field data that define the faces that make up this request. +(Read/Write ObjectReferenceList) +Altair Feko 2022.3 +2 Application Programming Interface (API) +DefinitionType +p.1355 +Choose between the different definition typed to be used by the receiving antenna. (Read/Write +NearFieldReceivingAntennaDataTypeEnum) +FieldData +The full import, aperture data that define the box that defines this request. (Read/Write +NearFieldDataFullImport) +IncludeScatteredPart +Enable including only the scattered part of the field. (Read/Write boolean) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +ReferencePointType +Select the reference point type. (Read/Write NearFieldDataReferencePointEnum) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1356 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +BoxReferencePoint +The reference point of the definition. +Type +LocalCoordinate +Access +Read/Write +CombinedFacesFieldData +The collection of file structure, near field data that define the faces that make up this request. +Type +ObjectReferenceList +Access +Read/Write +DefinitionType +Choose between the different definition typed to be used by the receiving antenna. +Type +NearFieldReceivingAntennaDataTypeEnum +Access +Read/Write +FieldData +The full import, aperture data that define the box that defines this request. +Type +NearFieldDataFullImport +Access +Read/Write +IncludeScatteredPart +Enable including only the scattered part of the field. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +ReferencePointType +Select the reference point type. +Type +NearFieldDataReferencePointEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +NearFieldSource +A solution aperture source. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +nearFieldData = + project.Definitions.FieldDataList:AddNearFieldDataFullImportUsingKnownFileFormat([[NearFieldData.nfd]]) + -- Create a 'NearFieldSource' from nearFieldData +nearFieldSource = + project.Contents.SolutionConfigurations.GlobalSources:AddNearFieldSource(nearFieldData) + -- Hide the 'NearFieldSource' +nearFieldSource.Visible = false + -- Delete this 'NearFieldSource' +nearFieldSource:Delete() +Inheritance +The NearFieldSource object is derived from the Source object. +Usage locations +The NearFieldSource object can be accessed from the following locations: +• Methods +◦ SourceCollection collection has method AddNearFieldSource(table). +◦ SourceCollection collection has method AddNearFieldSource(FieldData). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +BoxReferencePoint +The reference point of the definition. (Read/Write LocalCoordinate) +FieldData +The field data that defines the source. (Read/Write FieldData) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Magnitude +The source magnitude scaling factor. (Read/Write ParametricExpression) +Phase +The source phase offset (degrees). (Read/Write ParametricExpression) +ReferencePointType +Select the reference point type. (Read/Write NearFieldDataReferencePointEnum) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +BoxReferencePoint +The reference point of the definition. +Type +LocalCoordinate +Access +Read/Write +FieldData +The field data that defines the source. +Type +FieldData +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Magnitude +The source magnitude scaling factor. +Type +ParametricExpression +Access +Read/Write +Phase +The source phase offset (degrees). +Type +ParametricExpression +Access +Read/Write +ReferencePointType +Select the reference point type. +Type +NearFieldDataReferencePointEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +p.1365 +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Net +The wire that connects schematic terminals. +Example +p.1367 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Create the schematic view +harness = project.Contents.CableHarnesses[1] +schematicView = application.MainWindow.MdiArea:CreateCableSchematicView(harness) + -- Add some nets +net1 = harness.CableSchematic.Nets:AddNet({-8, -1}, {-8, 13}) +net2 = harness.CableSchematic.Nets:AddNet({-8, 13}, {-7, 13}) +Inheritance +The Net object is derived from the Object object. +Usage locations +The Net object can be accessed from the following locations: +• Properties +◦ Terminal object has property Nets. +• Methods +◦ NetCollection collection has method AddNet(GridLocation, GridLocation). +◦ NetCollection collection has method AddNet(Terminal, Terminal). +◦ NetCollection collection has method AddNet(List of GridLocation). +◦ NetCollection collection has method Item(number). +◦ NetCollection collection has method Item(string). +Property List +EndTerminal +The end terminal of the net. (Read only Terminal) +Label +Path +The object label. (Read/Write string) +A list of grid coordinates that the net follows. (Read only List of GridLocation) +StartTerminal +The start terminal of the net. (Read only Terminal) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UpdatePath (path List of GridLocation) +Updates the the path net follows. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +EndTerminal +The end terminal of the net. +Type +Terminal +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Path +A list of grid coordinates that the net follows. +Access +Read only +StartTerminal +The start terminal of the net. +Type +Terminal +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UpdatePath (path List of GridLocation) +Updates the the path net follows. +Input Parameters +path(List of GridLocation) +A list of grid coordinates that form the path. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Network +An abstract (base) object for non-radiating networks. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The Network object is derived from the Object object. +The following objects are derived (specialisations) from the Network object: +• GeneralNetwork +• TransmissionLine +Usage locations +The Network object can be accessed from the following locations: +�� Methods +◦ NetworkCollection collection has method Item(number). +◦ NetworkCollection collection has method Item(string). +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +p.1372 +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.1373 +NormalDimension +An amount measured in regular units, such as metres or feet. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a 'NearFieldFileStructure' from a set of default properties +properties = cf.NearFieldDataFileStructure.GetDefaultProperties() +properties.CoordinateType = cf.Enums.NearFieldDataCoordinateTypeEnum.Cartesian +properties.CartesianStructure.Height = "2" +properties.CartesianStructure.Width = "2" +properties.CartesianStructure.UPoints = "11" +properties.CartesianStructure.VPoints = "11" +properties.EFieldFilename = [[EFieldFileName]] +properties.HFieldFilename = [[HFieldFileName]] +nearFieldData = +project.Definitions.FieldDataList:AddNearFieldDataFileStructure(properties) + -- Change the height of the cartesian face +nearFieldData.CartesianStructure.Height = "4" +Inheritance +The NormalDimension object is derived from the Dimension object. +The following objects are derived (specialisations) from the NormalDimension object: +• PointRangeExpression +Usage locations +The NormalDimension object can be accessed from the following locations: +• Properties +◦ Cutplane object has property Offset. +◦ Cone object has property Height. +◦ Cuboid object has property Height. +◦ Cylinder object has property Height. +◦ Flare object has property Height. +◦ Helix object has property Height. +◦ Paraboloid object has property FocalDepth. +◦ Sphere object has property RadiusN. +◦ CylindricalStructure object has property Height. +• Methods +◦ NormalDimensionList object has method Append(). +◦ NormalDimensionList object has method Get(number). +NormalDimensionList +A list of NormalDimension items. +Method List +Append () +Appends a new item to the list. (Returns a NormalDimension object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a NormalDimension object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +NormalDimension +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +NormalDimension +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +NumericalGreensFunction +The numerical Green's function (NGF) applied to the model. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +cuboid = project.Contents.Geometry:AddCuboid(cf.Cuboid.GetDefaultProperties()) + -- Get the 'NumericalGreensFunction' from the 'SolutionSettings' +ngf = project.Contents.SolutionSettings.NumericalGreensFunction + -- Add the 'Cuboid' to the list of static parts and enable the numerical Green's + function +ngf.StaticParts = {cuboid} +ngf.Enabled = true +Inheritance +The NumericalGreensFunction object is derived from the Object object. +Usage locations +The NumericalGreensFunction object can be accessed from the following locations: +• Properties +◦ SolutionSettings object has property NumericalGreensFunction. +Property List +Enabled +Specifies if the numerical Green's function is active. (Read/Write boolean) +Label +The object label. (Read/Write string) +SolutionControl +Specifies the *.ngf file read/write behaviour. (Read/Write NGFControlTypeEnum) +StaticParts +The NGF will only apply to the specified entities. (Read/Write ObjectReferenceList) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1378 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Enabled +Specifies if the numerical Green's function is active. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +SolutionControl +Specifies the *.ngf file read/write behaviour. +Type +NGFControlTypeEnum +Access +Read/Write +StaticParts +The NGF will only apply to the specified entities. +Type +ObjectReferenceList +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +NurbsControlPoint +A weighted point used for controlling a NURB surface. +Example +p.1380 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a NURBS surface with 2 rows and 3 columns. +pointsTable = + {{cf.Point(0,0,0), cf.Point(-1,2,0), cf.Point(0,4,0)}, + {cf.Point(2,1,0), cf.Point(1,2,0) , cf.Point(2,4,0)}} +weightsTable = + {{1, 1, "2-1"}, + {1, 5, "1*1"}} +nurbs = project.Contents.Geometry:AddNurbsSurface(pointsTable, weightsTable) + -- Get a handle to the first point +firstPoint = nurbs.ControlPoints:Get(1, 1) +Inheritance +The NurbsControlPoint object is derived from the CompositeValue object. +Usage locations +The NurbsControlPoint object can be accessed from the following locations: +• Methods +◦ NurbsControlPointList object has method Append(). +◦ NurbsControlPointList object has method Get(number). +◦ NurbsControlPointTable object has method Get(number, number). +Property List +Position +The position of the point. (Read/Write LocalCoordinate) +Weight +The weight associated with the point. (Read/Write ParametricExpression) +Property Details +Position +The position of the point. +Type +LocalCoordinate +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Weight +The weight associated with the point. +Type +ParametricExpression +Access +Read/Write +p.1381 +Altair Feko 2022.3 +2 Application Programming Interface (API) +NurbsControlPointList +A list of NurbsControlPoint items. +Method List +Append () +p.1382 +Appends a new item to the list. (Returns a NurbsControlPoint object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a NurbsControlPoint object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +NurbsControlPoint +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +NurbsControlPoint +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +NurbsControlPointTable +A table (2 dimensional list) of NurbsControlPoint items. +Usage locations +The NurbsControlPointTable object can be accessed from the following locations: +• Properties +◦ NurbsSurface object has property ControlPoints. +Method List +AddColumn () +Appends a new column to the table. +AddRow () +Appends a new row to the table. +ColumnCount () +Returns the number columns in the table. (Returns a number object.) +Get (rowIndex number, columnIndex number) +Returns the item at the given row and column indices. Indexing starts at 1. (Returns a +NurbsControlPoint object.) +RowCount () +Returns the number of rows in the table. (Returns a number object.) +Set (rowIndex number, columnIndex number, value NurbsControlPoint) +Set item at the given row and column indices. Indexing starts at 1. +SetDimensions (rowCount number, columnCount number) +Sets the number of rows and columns in the table. +Method Details +AddColumn () +Appends a new column to the table. +AddRow () +Appends a new row to the table. +ColumnCount () +Returns the number columns in the table. +Return +number +The number of columns in the table. +Get (rowIndex number, columnIndex number) +Returns the item at the given row and column indices. Indexing starts at 1. +Input Parameters +rowIndex(number) +The row index of the item to return. +columnIndex(number) +The column index of the item to return. +Return +NurbsControlPoint +The NurbsControlPoint at the given indices. +RowCount () +Returns the number of rows in the table. +Return +number +The number of rows in the table. +Set (rowIndex number, columnIndex number, value NurbsControlPoint) +Set item at the given row and column indices. Indexing starts at 1. +Input Parameters +rowIndex(number) +The row index of the item to return. +columnIndex(number) +The column index of the item to return. +value(NurbsControlPoint) +The NurbsControlPoint item to be assigned to the table at the given indices. +SetDimensions (rowCount number, columnCount number) +Sets the number of rows and columns in the table. +Input Parameters +rowCount(number) +The number of rows. +columnCount(number) +The number of columns. +NurbsSurface +A NURBS surface. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a NURBS surface with 2 rows and 3 columns. +pointsTable = + {{cf.Point(0,0,0), cf.Point(-1,2,0), cf.Point(0,4,0)}, + {cf.Point(2,1,0), cf.Point(1,2,0) , cf.Point(2,4,0)}} +weightsTable = + {{1, 1, "2-1"}, + {1, 5, "1*1"}} +nurbs = project.Contents.Geometry:AddNurbsSurface(pointsTable, weightsTable) +Inheritance +The NurbsSurface object is derived from the Geometry object. +Usage locations +The NurbsSurface object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddNurbsSurface(table). +◦ GeometryCollection collection has method AddNurbsSurface(PointExpressionTable, +ExpressionTable). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ControlPoints +The table of control points for the surface. (Read/Write NurbsControlPointTable) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1388 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ControlPoints +The table of control points for the surface. +Type +NurbsControlPointTable +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1393 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +OPTFEKOLaunchOptions +OPTFEKO launch options. +Example +p.1394 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Access the 'OPTFEKOLaunchOptions' object and check if files are deleted +areFilesDeleted = application.Launcher.Settings.OPTFEKO.FilesDeleted +Inheritance +The OPTFEKOLaunchOptions object is derived from the CompositeValue object. +Usage locations +The OPTFEKOLaunchOptions object can be accessed from the following locations: +• Properties +◦ ComponentLaunchOptions object has property OPTFEKO. +• Methods +◦ OPTFEKOLaunchOptionsList object has method Append(). +◦ OPTFEKOLaunchOptionsList object has method Get(number). +Property List +DebugEnabled +Output debug information. (Read/Write boolean) +FarmOutEnabled +Enables/disables running OPTFEKO on multiple remote machines. (Read/Write boolean) +FilesDeleted +Enables/disables if the files generated by the optimisation run (except the optimum) should be +deleted. (Read/Write boolean) +ProcessFarmOutCount +Specifies the total number of processes to farm out. (Read/Write number) +RestartFromRunNumber +Specifies the number the optimisation can be restarted at from the last completed optimisation +iteration. (Read/Write number) +RestartRunEnabled +Enables/disables running the solver from the last completed optimisation iteration. No changes +whatsoever may be made to the model before restarting the optimisation process. (Read/Write +boolean) +Property Details +DebugEnabled +Output debug information. +Type +boolean +Access +Read/Write +FarmOutEnabled +Enables/disables running OPTFEKO on multiple remote machines. +Type +boolean +Access +Read/Write +FilesDeleted +Enables/disables if the files generated by the optimisation run (except the optimum) should be +deleted. +Type +boolean +Access +Read/Write +ProcessFarmOutCount +Specifies the total number of processes to farm out. +Type +number +Access +Read/Write +RestartFromRunNumber +Specifies the number the optimisation can be restarted at from the last completed optimisation +iteration. +Type +number +Access +Read/Write +RestartRunEnabled +Enables/disables running the solver from the last completed optimisation iteration. No changes +whatsoever may be made to the model before restarting the optimisation process. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +OPTFEKOLaunchOptionsList +A list of OPTFEKOLaunchOptions items. +Method List +Append () +p.1397 +Appends a new item to the list. (Returns a OPTFEKOLaunchOptions object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a OPTFEKOLaunchOptions +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +OPTFEKOLaunchOptions +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +OPTFEKOLaunchOptions +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1398 +Object +An object is anything that can be selected in CADFEKO. +Example +application = cf.Application.GetInstance() +Inheritance +The following objects are derived (specialisations) from the Object object: +• AbstractAntennaArray +• AbstractMeshEdge +• AbstractMeshTriangleFace +• AbstractMeshWire +• AnisotropicDielectricCollection +• AntennaArrayCollection +• Application +• BaseFieldReceivingAntenna +• CFXModelImportSettings +• CFXModelImporter +• CableConnector +• CableConnectorCollection +• CableConnectorPin +• CableConnectorPinCollection +• CableCrossSection +• CableCrossSectionCollection +• CableGeneralNetwork +• CableHarness +• CableHarnessCollection +• CableInstance +• CableInstanceCollection +• CablePath +• CablePathCollection +• CablePathTerminal +• CableProbe +• CableProbeCollection +• CableSchematicCurrentProbe +• CableSchematicVoltageProbe +• CableShield +• CableShieldCollection +• CableSignal +• CableSignalCollection +• CableSpiceNetwork +• Cables +• Capacitor +• CharacterisedSurfaceCollection +• CharacteristicModes +• CollectionOf_DomainEntity +• CollectionOf_Mesh +• ComplexLoad +• ComponentLaunchOptions +• Currents +• CurrentsCollection +• Cutplane +• CutplaneCollection +• DielectricCollection +• ErrorEstimation +• ErrorEstimationCollection +• Exporter +• FDTDBoundaryConditions +• FaceCollection +• FarField +• FarFieldCollection +• FarFieldReceivingAntennaCollection +• FieldData +• FieldDataCollection +• FillHoleSettings +• Find +• Frequency +• Geometry +• GeometryExporter +• GeometryGroup +• GeometryGroupCollection +• GeometryImporter +• GeometryRebuild +• GeometryRepair +• Ground +• GroundPlane +• ImpedanceSheetCollection +• Importer +• Inductor +• KBL +• LaunchResult +• Launcher +• LayeredDielectricCollection +• LibraryMedium +• Load +• LoadCollection +• MainWindow +• MdiSubWindow +• Media +• MediaLibrary +• Medium +• Mesh +• MeshCurvilinearTriangleFaceCollection +• MeshCylinder +• MeshCylinderCollection +• MeshExporter +• MeshFind +• MeshImporter +• MeshInfo +• MeshPlate +• MeshPlateCollection +• MeshRefinementRule +• MeshRefinementRuleCollection +• MeshRegion +• MeshSegmentCurvilinearWireCollection +• MeshSegmentWireCollection +• MeshSettings +• MeshSettingsCollection +• MeshTetrahedronRegionCollection +• MeshTriangleFaceCollection +• Mesher +• MessageWindow +• MetalCollection +• Model +• ModelAttributes +• ModelContents +• ModelDecompositionCollection +• ModelDefinitions +• ModelMeshInfo +• ModelSymmetry +• NamedPoint +• NamedPointCollection +• NearField +• NearFieldCollection +• NearFieldReceivingAntennaCollection +• Net +• NetCollection +• Network +• NetworkCollection +• NumericalGreensFunction +• OperatorCollection +• Optimisation +• OptimisationGoalCollection +• OptimisationGoalObjective +• OptimisationMask +• OptimisationMaskCollection +• OptimisationOperator +• OptimisationParameters +• OptimisationSearch +• OptimisationSearchAdvancedSettings +• OptimisationSearchCollection +• PCB +• PeriodicBoundary +• Port +• PortCollection +• Power +• ProtectedModel +• ProtectedModels +• RegionCollection +• RemoveSmallFeaturesSettings +• RepairAndSewFacesSettings +• RepairEdgesSettings +• RepairPartsSettings +• Resistor +• SAR +• SARCollection +• SParameter +• Schematic +• SchematicViewWindow +• Shape +• ShapeCollection +• SimplifyPartRepresentationSettings +• SimulationMeshInfo +• SolutionConfiguration +• SolutionConfigurationCollection +• SolutionSettings +• SolverSettings +• Source +• SourceCollection +• SphericalModeReceivingAntennaCollection +• Terminal +• TerminalCollection +• TopologyEntity +• TopologyEntityCollectionOf_Edge +• Transform +• TransformCollection +• Transformer +• TransmissionReflection +• TransmissionReflectionCollection +• UnitCell +• UnitCellCollection +• UnprotectedInformation +• Variable +• VariableCollection +• Version +• ViewXt +• ViewXtWindow +• VoltageControlledVoltageSource +• VoxelSettings +• WindscreenCollection +• WorkSurface +• WorkSurfaceCollection +• Workplane +• WorkplaneCollection +Usage locations +The Object object can be accessed from the following locations: +• Properties +◦ Schematic object has property SchematicItems. +◦ SParameterOptimisationGoal object has property FocusSource. +• Methods +◦ Object object has method Duplicate(). +◦ VariableCollection collection has method Duplicate(). +◦ NamedPointCollection collection has method Duplicate(). +◦ TransformCollection collection has method Duplicate(). +◦ WorkplaneCollection collection has method Duplicate(). +◦ AntennaArrayCollection collection has method Duplicate(). +◦ CutplaneCollection collection has method Duplicate(). +◦ AnisotropicDielectricCollection collection has method Duplicate(). +◦ CharacterisedSurfaceCollection collection has method Duplicate(). +◦ DielectricCollection collection has method Duplicate(). +◦ +ImpedanceSheetCollection collection has method Duplicate(). +◦ LayeredDielectricCollection collection has method Duplicate(). +◦ MetalCollection collection has method Duplicate(). +◦ WindscreenCollection collection has method Duplicate(). +◦ CollectionOf_DomainEntity collection has method Item(number). +◦ CollectionOf_DomainEntity collection has method Item(string). +◦ CollectionOf_DomainEntity collection has method Duplicate(). +◦ CableSchematicComponentCollection collection has method Item(number). +◦ CableSchematicComponentCollection collection has method Item(string). +◦ CableSchematicComponentCollection collection has method Duplicate(). +◦ NetCollection collection has method Duplicate(). +◦ CableConnectorCollection collection has method Duplicate(). +◦ CableConnectorPinCollection collection has method Duplicate(). +◦ CableCrossSectionCollection collection has method Duplicate(). +◦ CableHarnessCollection collection has method Duplicate(). +◦ CableInstanceCollection collection has method Duplicate(). +◦ CablePathCollection collection has method Duplicate(). +◦ CableProbeCollection collection has method Duplicate(). +◦ CableShieldCollection collection has method Duplicate(). +◦ CollectionOf_Mesh collection has method Duplicate(). +◦ MeshCurvilinearTriangleFaceCollection collection has method Duplicate(). +◦ MeshCylinderCollection collection has method Duplicate(). +◦ MeshPlateCollection collection has method Duplicate(). +◦ MeshRefinementRuleCollection collection has method Duplicate(). +◦ MeshSegmentCurvilinearWireCollection collection has method Duplicate(). +◦ MeshSegmentWireCollection collection has method Duplicate(). +◦ MeshTetrahedronRegionCollection collection has method Duplicate(). +◦ MeshTriangleFaceCollection collection has method Duplicate(). +◦ OperatorCollection collection has method Duplicate(). +◦ GeometryCollection collection has method Duplicate(). +◦ GeometryGroup collection has method CopyAndRotate(table, number). +◦ GeometryGroup collection has method CopyAndTranslate(table, number). +◦ GeometryGroup collection has method CopyAndRotate(Point, Vector, number, number). +◦ GeometryGroup collection has method CopyAndTranslate(Point, Point, number). +◦ GeometryGroup collection has method CopyAndMirror(table). +◦ GeometryGroup collection has method Duplicate(). +◦ WorkSurfaceCollection collection has method Duplicate(). +◦ GeometryGroupCollection collection has method Duplicate(). +◦ FieldDataCollection collection has method Duplicate(). +◦ ShapeCollection collection has method Duplicate(). +◦ MeshSettingsCollection collection has method Duplicate(). +◦ CurrentsCollection collection has method Duplicate(). +◦ ErrorEstimationCollection collection has method Duplicate(). +◦ FarFieldCollection collection has method Duplicate(). +◦ FarFieldReceivingAntennaCollection collection has method Duplicate(). +◦ LoadCollection collection has method Duplicate(). +◦ ModelDecompositionCollection collection has method Duplicate(). +◦ NearFieldCollection collection has method Duplicate(). +◦ NearFieldReceivingAntennaCollection collection has method Duplicate(). +◦ NetworkCollection collection has method Duplicate(). +◦ PortCollection collection has method Duplicate(). +◦ SARCollection collection has method Duplicate(). +◦ SolutionConfigurationCollection collection has method Duplicate(). +◦ SourceCollection collection has method Duplicate(). +◦ SphericalModeReceivingAntennaCollection collection has method Duplicate(). +◦ TransmissionReflectionCollection collection has method Duplicate(). +◦ UnitCellCollection collection has method Duplicate(). +◦ OptimisationGoalCollection collection has method Duplicate(). +◦ OptimisationMaskCollection collection has method Duplicate(). +◦ OptimisationSearchCollection collection has method Duplicate(). +◦ ProtectedModels collection has method Duplicate(). +◦ MediaLibrary collection has method Duplicate(). +◦ TerminalCollection collection has method Duplicate(). +◦ CableSignalCollection collection has method Duplicate(). +◦ TopologyEntityCollectionOf_Edge collection has method Duplicate(). +◦ EdgeCollection collection has method Duplicate(). +◦ WireCollection collection has method Duplicate(). +◦ FaceCollection collection has method Duplicate(). +◦ RegionCollection collection has method Duplicate(). +◦ Model object has method Duplicate(). +◦ Variable object has method Duplicate(). +◦ Transform object has method CopyAndRotate(table, number). +◦ Transform object has method CopyAndTranslate(table, number). +◦ Transform object has method CopyAndRotate(Point, Vector, number, number). +◦ Transform object has method CopyAndTranslate(Point, Point, number). +◦ Transform object has method CopyAndMirror(table). +◦ Transform object has method Duplicate(). +◦ Align object has method CopyAndRotate(table, number). +◦ Align object has method CopyAndTranslate(table, number). +◦ Align object has method CopyAndRotate(Point, Vector, number, number). +◦ Align object has method CopyAndTranslate(Point, Point, number). +◦ Align object has method CopyAndMirror(table). +◦ Align object has method Duplicate(). +◦ Mirror object has method CopyAndRotate(table, number). +◦ Mirror object has method CopyAndTranslate(table, number). +◦ Mirror object has method CopyAndRotate(Point, Vector, number, number). +◦ Mirror object has method CopyAndTranslate(Point, Point, number). +◦ Mirror object has method CopyAndMirror(table). +◦ Mirror object has method Duplicate(). +◦ Rotate object has method CopyAndRotate(table, number). +◦ Rotate object has method CopyAndTranslate(table, number). +◦ Rotate object has method CopyAndRotate(Point, Vector, number, number). +◦ Rotate object has method CopyAndTranslate(Point, Point, number). +◦ Rotate object has method CopyAndMirror(table). +◦ Rotate object has method Duplicate(). +◦ Scale object has method CopyAndRotate(table, number). +◦ Scale object has method CopyAndTranslate(table, number). +◦ Scale object has method CopyAndRotate(Point, Vector, number, number). +◦ Scale object has method CopyAndTranslate(Point, Point, number). +◦ Scale object has method CopyAndMirror(table). +◦ Scale object has method Duplicate(). +◦ Translate object has method CopyAndRotate(table, number). +◦ Translate object has method CopyAndTranslate(table, number). +◦ Translate object has method CopyAndRotate(Point, Vector, number, number). +◦ Translate object has method CopyAndTranslate(Point, Point, number). +◦ Translate object has method CopyAndMirror(table). +◦ Translate object has method Duplicate(). +◦ ModelAttributes object has method Duplicate(). +◦ NamedPoint object has method CopyAndRotate(table, number). +◦ NamedPoint object has method CopyAndTranslate(table, number). +◦ NamedPoint object has method CopyAndRotate(Point, Vector, number, number). +◦ NamedPoint object has method CopyAndTranslate(Point, Point, number). +◦ NamedPoint object has method CopyAndMirror(table). +◦ NamedPoint object has method Duplicate(). +◦ Workplane object has method CopyAndRotate(table, number). +◦ Workplane object has method CopyAndTranslate(table, number). +◦ Workplane object has method CopyAndRotate(Point, Vector, number, number). +◦ Workplane object has method CopyAndTranslate(Point, Point, number). +◦ Workplane object has method CopyAndMirror(table). +◦ Workplane object has method Duplicate(). +◦ AbstractAntennaArray object has method CopyAndRotate(table, number). +◦ AbstractAntennaArray object has method CopyAndTranslate(table, number). +◦ AbstractAntennaArray object has method CopyAndRotate(Point, Vector, number, number). +◦ AbstractAntennaArray object has method CopyAndTranslate(Point, Point, number). +◦ AbstractAntennaArray object has method CopyAndMirror(table). +◦ AbstractAntennaArray object has method Duplicate(). +◦ CylindricalAntennaArray object has method CopyAndRotate(table, number). +◦ CylindricalAntennaArray object has method CopyAndTranslate(table, number). +◦ CylindricalAntennaArray object has method CopyAndRotate(Point, Vector, number, number). +◦ CylindricalAntennaArray object has method CopyAndTranslate(Point, Point, number). +◦ CylindricalAntennaArray object has method CopyAndMirror(table). +◦ CylindricalAntennaArray object has method Duplicate(). +◦ LinearPlanarArray object has method CopyAndRotate(table, number). +◦ LinearPlanarArray object has method CopyAndTranslate(table, number). +◦ LinearPlanarArray object has method CopyAndRotate(Point, Vector, number, number). +◦ LinearPlanarArray object has method CopyAndTranslate(Point, Point, number). +◦ LinearPlanarArray object has method CopyAndMirror(table). +◦ LinearPlanarArray object has method Duplicate(). +◦ CustomAntennaArray object has method CopyAndRotate(table, number). +◦ CustomAntennaArray object has method CopyAndTranslate(table, number). +◦ CustomAntennaArray object has method CopyAndRotate(Point, Vector, number, number). +◦ CustomAntennaArray object has method CopyAndTranslate(Point, Point, number). +◦ CustomAntennaArray object has method CopyAndMirror(table). +◦ CustomAntennaArray object has method Duplicate(). +◦ Cutplane object has method CopyAndRotate(table, number). +◦ Cutplane object has method CopyAndTranslate(table, number). +◦ Cutplane object has method CopyAndRotate(Point, Vector, number, number). +◦ Cutplane object has method CopyAndTranslate(Point, Point, number). +◦ Cutplane object has method CopyAndMirror(table). +◦ Cutplane object has method Duplicate(). +◦ MdiSubWindow object has method Duplicate(). +◦ Application object has method Load(string). +◦ Application object has method NewProject(). +◦ Application object has method Duplicate(). +◦ MainWindow object has method Duplicate(). +◦ ViewXt object has method Duplicate(). +◦ ViewXtWindow object has method Duplicate(). +◦ MessageWindow object has method Duplicate(). +◦ Version object has method Duplicate(). +◦ Medium object has method Duplicate(). +◦ AnisotropicDielectric object has method Duplicate(). +◦ CharacterisedSurface object has method Duplicate(). +◦ DefaultMedium object has method Duplicate(). +◦ Dielectric object has method Duplicate(). +◦ FreeSpace object has method Duplicate(). +◦ GroundPlaneMedium object has method Duplicate(). +◦ Zero object has method Duplicate(). +◦ DielectricBoundaryMedium object has method Duplicate(). +◦ +ImpedanceSheet object has method Duplicate(). +◦ LayeredDielectric object has method Duplicate(). +◦ LayeredAnisotropicDielectric object has method Duplicate(). +◦ LayeredIsotropicDielectric object has method Duplicate(). +◦ Metal object has method Duplicate(). +◦ PerfectElectricConductor object has method Duplicate(). +◦ PerfectMagneticConductor object has method Duplicate(). +◦ Windscreen object has method Duplicate(). +◦ Media object has method Duplicate(). +◦ Capacitor object has method Duplicate(). +◦ Ground object has method Duplicate(). +◦ Net object has method Duplicate(). +◦ Resistor object has method Duplicate(). +◦ Schematic object has method Duplicate(). +◦ Terminal object has method Duplicate(). +◦ CableCrossSection object has method Duplicate(). +◦ CableBundleCrossSection object has method Duplicate(). +◦ CableCoaxialCrossSection object has method Duplicate(). +◦ CableNonConductingElementCrossSection object has method Duplicate(). +◦ CableRibbonCrossSection object has method Duplicate(). +◦ CableSingleConductorCrossSection object has method Duplicate(). +◦ CableTwistedPairCrossSection object has method Duplicate(). +◦ CableConnector object has method Duplicate(). +◦ CableConnectorPin object has method Duplicate(). +◦ CableGeneralNetwork object has method Duplicate(). +◦ CableHarness object has method Duplicate(). +◦ CableInstance object has method Duplicate(). +◦ CablePath object has method CopyAndRotate(table, number). +◦ CablePath object has method CopyAndTranslate(table, number). +◦ CablePath object has method CopyAndRotate(Point, Vector, number, number). +◦ CablePath object has method CopyAndTranslate(Point, Point, number). +◦ CablePath object has method CopyAndMirror(table). +◦ CablePath object has method Duplicate(). +◦ CablePathTerminal object has method Duplicate(). +◦ CableProbe object has method Duplicate(). +◦ Cables object has method Duplicate(). +◦ CableSchematicCurrentProbe object has method Duplicate(). +◦ CableSchematicVoltageProbe object has method Duplicate(). +◦ CableShield object has method Duplicate(). +◦ CableSignal object has method Duplicate(). +◦ CableSpiceNetwork object has method Duplicate(). +◦ ComplexLoad object has method Duplicate(). +◦ +Inductor object has method Duplicate(). +◦ Transformer object has method Duplicate(). +◦ VoltageControlledVoltageSource object has method Duplicate(). +◦ SchematicViewWindow object has method Duplicate(). +◦ KBL object has method Duplicate(). +◦ ComponentLaunchOptions object has method Duplicate(). +◦ Launcher object has method Duplicate(). +◦ AbstractMeshEdge object has method Duplicate(). +◦ AbstractMeshTriangleFace object has method Duplicate(). +◦ MeshCurvilinearTriangleFace object has method Duplicate(). +◦ MeshTriangleFace object has method Duplicate(). +◦ AbstractMeshWire object has method Duplicate(). +◦ MeshCurvilinearWire object has method Duplicate(). +◦ MeshCurvilinearSegmentWire object has method Duplicate(). +◦ MeshWire object has method Duplicate(). +◦ MeshSegmentWire object has method Duplicate(). +◦ MeshCylinder object has method Duplicate(). +◦ MeshPlate object has method Duplicate(). +◦ MeshRegion object has method Duplicate(). +◦ MeshTetrahedronRegion object has method Duplicate(). +◦ MeshRefinementRule object has method CopyAndRotate(table, number). +◦ MeshRefinementRule object has method CopyAndTranslate(table, number). +◦ MeshRefinementRule object has method CopyAndRotate(Point, Vector, number, number). +◦ MeshRefinementRule object has method CopyAndTranslate(Point, Point, number). +◦ MeshRefinementRule object has method CopyAndMirror(table). +◦ MeshRefinementRule object has method Duplicate(). +◦ AdaptiveRefinement object has method CopyAndRotate(table, number). +◦ AdaptiveRefinement object has method CopyAndTranslate(table, number). +◦ AdaptiveRefinement object has method CopyAndRotate(Point, Vector, number, number). +◦ AdaptiveRefinement object has method CopyAndTranslate(Point, Point, number). +◦ AdaptiveRefinement object has method CopyAndMirror(table). +◦ AdaptiveRefinement object has method Duplicate(). +◦ PointRefinement object has method CopyAndRotate(table, number). +◦ PointRefinement object has method CopyAndTranslate(table, number). +◦ PointRefinement object has method CopyAndRotate(Point, Vector, number, number). +◦ PointRefinement object has method CopyAndTranslate(Point, Point, number). +◦ PointRefinement object has method CopyAndMirror(table). +◦ PointRefinement object has method Duplicate(). +◦ PolylineRefinement object has method CopyAndRotate(table, number). +◦ PolylineRefinement object has method CopyAndTranslate(table, number). +◦ PolylineRefinement object has method CopyAndRotate(Point, Vector, number, number). +◦ PolylineRefinement object has method CopyAndTranslate(Point, Point, number). +◦ PolylineRefinement object has method CopyAndMirror(table). +◦ PolylineRefinement object has method Duplicate(). +◦ Mesh object has method CopyAndRotate(table, number). +◦ Mesh object has method CopyAndTranslate(table, number). +◦ Mesh object has method CopyAndRotate(Point, Vector, number, number). +◦ Mesh object has method CopyAndTranslate(Point, Point, number). +◦ Mesh object has method CopyAndMirror(table). +◦ Mesh object has method Duplicate(). +◦ MeshFind object has method Duplicate(). +◦ Geometry object has method CopyAndRotate(table, number). +◦ Geometry object has method CopyAndTranslate(table, number). +◦ Geometry object has method CopyAndRotate(Point, Vector, number, number). +◦ Geometry object has method CopyAndTranslate(Point, Point, number). +◦ Geometry object has method CopyAndMirror(table). +◦ Geometry object has method Duplicate(). +◦ SpiralCross object has method CopyAndRotate(table, number). +◦ SpiralCross object has method CopyAndTranslate(table, number). +◦ SpiralCross object has method CopyAndRotate(Point, Vector, number, number). +◦ SpiralCross object has method CopyAndTranslate(Point, Point, number). +◦ SpiralCross object has method CopyAndMirror(table). +◦ SpiralCross object has method Duplicate(). +◦ Ring object has method CopyAndRotate(table, number). +◦ Ring object has method CopyAndTranslate(table, number). +◦ Ring object has method CopyAndRotate(Point, Vector, number, number). +◦ Ring object has method CopyAndTranslate(Point, Point, number). +◦ Ring object has method CopyAndMirror(table). +◦ Ring object has method Duplicate(). +◦ OpenRing object has method CopyAndRotate(table, number). +◦ OpenRing object has method CopyAndTranslate(table, number). +◦ OpenRing object has method CopyAndRotate(Point, Vector, number, number). +◦ OpenRing object has method CopyAndTranslate(Point, Point, number). +◦ OpenRing object has method CopyAndMirror(table). +◦ OpenRing object has method Duplicate(). +◦ SplitRing object has method CopyAndRotate(table, number). +◦ SplitRing object has method CopyAndTranslate(table, number). +◦ SplitRing object has method CopyAndRotate(Point, Vector, number, number). +◦ SplitRing object has method CopyAndTranslate(Point, Point, number). +◦ SplitRing object has method CopyAndMirror(table). +◦ SplitRing object has method Duplicate(). +◦ Cross object has method CopyAndRotate(table, number). +◦ Cross object has method CopyAndTranslate(table, number). +◦ Cross object has method CopyAndRotate(Point, Vector, number, number). +◦ Cross object has method CopyAndTranslate(Point, Point, number). +◦ Cross object has method CopyAndMirror(table). +◦ Cross object has method Duplicate(). +◦ StripCross object has method CopyAndRotate(table, number). +◦ StripCross object has method CopyAndTranslate(table, number). +◦ StripCross object has method CopyAndRotate(Point, Vector, number, number). +◦ StripCross object has method CopyAndTranslate(Point, Point, number). +◦ StripCross object has method CopyAndMirror(table). +◦ StripCross object has method Duplicate(). +◦ Trifilar object has method CopyAndRotate(table, number). +◦ Trifilar object has method CopyAndTranslate(table, number). +◦ Trifilar object has method CopyAndRotate(Point, Vector, number, number). +◦ Trifilar object has method CopyAndTranslate(Point, Point, number). +◦ Trifilar object has method CopyAndMirror(table). +◦ Trifilar object has method Duplicate(). +◦ AnalyticalCurve object has method CopyAndRotate(table, number). +◦ AnalyticalCurve object has method CopyAndTranslate(table, number). +◦ AnalyticalCurve object has method CopyAndRotate(Point, Vector, number, number). +◦ AnalyticalCurve object has method CopyAndTranslate(Point, Point, number). +◦ AnalyticalCurve object has method CopyAndMirror(table). +◦ AnalyticalCurve object has method Duplicate(). +◦ BezierCurve object has method CopyAndRotate(table, number). +◦ BezierCurve object has method CopyAndTranslate(table, number). +◦ BezierCurve object has method CopyAndRotate(Point, Vector, number, number). +◦ BezierCurve object has method CopyAndTranslate(Point, Point, number). +◦ BezierCurve object has method CopyAndMirror(table). +◦ BezierCurve object has method Duplicate(). +◦ Cone object has method CopyAndRotate(table, number). +◦ Cone object has method CopyAndTranslate(table, number). +◦ Cone object has method CopyAndRotate(Point, Vector, number, number). +◦ Cone object has method CopyAndTranslate(Point, Point, number). +◦ Cone object has method CopyAndMirror(table). +◦ Cone object has method Duplicate(). +◦ ConstrainedSurface object has method CopyAndRotate(table, number). +◦ ConstrainedSurface object has method CopyAndTranslate(table, number). +◦ ConstrainedSurface object has method CopyAndRotate(Point, Vector, number, number). +◦ ConstrainedSurface object has method CopyAndTranslate(Point, Point, number). +◦ ConstrainedSurface object has method CopyAndMirror(table). +◦ ConstrainedSurface object has method Duplicate(). +◦ Cuboid object has method CopyAndRotate(table, number). +◦ Cuboid object has method CopyAndTranslate(table, number). +◦ Cuboid object has method CopyAndRotate(Point, Vector, number, number). +◦ Cuboid object has method CopyAndTranslate(Point, Point, number). +◦ Cuboid object has method CopyAndMirror(table). +◦ Cuboid object has method Duplicate(). +◦ Cylinder object has method CopyAndRotate(table, number). +◦ Cylinder object has method CopyAndTranslate(table, number). +◦ Cylinder object has method CopyAndRotate(Point, Vector, number, number). +◦ Cylinder object has method CopyAndTranslate(Point, Point, number). +◦ Cylinder object has method CopyAndMirror(table). +◦ Cylinder object has method Duplicate(). +◦ Ellipse object has method CopyAndRotate(table, number). +◦ Ellipse object has method CopyAndTranslate(table, number). +◦ Ellipse object has method CopyAndRotate(Point, Vector, number, number). +◦ Ellipse object has method CopyAndTranslate(Point, Point, number). +◦ Ellipse object has method CopyAndMirror(table). +◦ Ellipse object has method Duplicate(). +◦ EllipticArc object has method CopyAndRotate(table, number). +◦ EllipticArc object has method CopyAndTranslate(table, number). +◦ EllipticArc object has method CopyAndRotate(Point, Vector, number, number). +◦ EllipticArc object has method CopyAndTranslate(Point, Point, number). +◦ EllipticArc object has method CopyAndMirror(table). +◦ EllipticArc object has method Duplicate(). +◦ FittedSpline object has method CopyAndRotate(table, number). +◦ FittedSpline object has method CopyAndTranslate(table, number). +◦ FittedSpline object has method CopyAndRotate(Point, Vector, number, number). +◦ FittedSpline object has method CopyAndTranslate(Point, Point, number). +◦ FittedSpline object has method CopyAndMirror(table). +◦ FittedSpline object has method Duplicate(). +◦ Flare object has method CopyAndRotate(table, number). +◦ Flare object has method CopyAndTranslate(table, number). +◦ Flare object has method CopyAndRotate(Point, Vector, number, number). +◦ Flare object has method CopyAndTranslate(Point, Point, number). +◦ Flare object has method CopyAndMirror(table). +◦ Flare object has method Duplicate(). +◦ Helix object has method CopyAndRotate(table, number). +◦ Helix object has method CopyAndTranslate(table, number). +◦ Helix object has method CopyAndRotate(Point, Vector, number, number). +◦ Helix object has method CopyAndTranslate(Point, Point, number). +◦ Helix object has method CopyAndMirror(table). +◦ Helix object has method Duplicate(). +◦ Hexagon object has method CopyAndRotate(table, number). +◦ Hexagon object has method CopyAndTranslate(table, number). +◦ Hexagon object has method CopyAndRotate(Point, Vector, number, number). +◦ Hexagon object has method CopyAndTranslate(Point, Point, number). +◦ Hexagon object has method CopyAndMirror(table). +◦ Hexagon object has method Duplicate(). +◦ StripHexagon object has method CopyAndRotate(table, number). +◦ StripHexagon object has method CopyAndTranslate(table, number). +◦ StripHexagon object has method CopyAndRotate(Point, Vector, number, number). +◦ StripHexagon object has method CopyAndTranslate(Point, Point, number). +◦ StripHexagon object has method CopyAndMirror(table). +◦ StripHexagon object has method Duplicate(). +◦ HyperbolicArc object has method CopyAndRotate(table, number). +◦ HyperbolicArc object has method CopyAndTranslate(table, number). +◦ HyperbolicArc object has method CopyAndRotate(Point, Vector, number, number). +◦ HyperbolicArc object has method CopyAndTranslate(Point, Point, number). +◦ HyperbolicArc object has method CopyAndMirror(table). +◦ HyperbolicArc object has method Duplicate(). +◦ +◦ +◦ +◦ +◦ +◦ +◦ +◦ +◦ +◦ +◦ +◦ +ImprintPoints object has method CopyAndRotate(table, number). +ImprintPoints object has method CopyAndTranslate(table, number). +ImprintPoints object has method CopyAndRotate(Point, Vector, number, number). +ImprintPoints object has method CopyAndTranslate(Point, Point, number). +ImprintPoints object has method CopyAndMirror(table). +ImprintPoints object has method Duplicate(). +Intersect object has method CopyAndRotate(table, number). +Intersect object has method CopyAndTranslate(table, number). +Intersect object has method CopyAndRotate(Point, Vector, number, number). +Intersect object has method CopyAndTranslate(Point, Point, number). +Intersect object has method CopyAndMirror(table). +Intersect object has method Duplicate(). +◦ Loft object has method CopyAndRotate(table, number). +◦ Loft object has method CopyAndTranslate(table, number). +◦ Loft object has method CopyAndRotate(Point, Vector, number, number). +◦ Loft object has method CopyAndTranslate(Point, Point, number). +◦ Loft object has method CopyAndMirror(table). +◦ Loft object has method Duplicate(). +◦ PathSweep object has method CopyAndRotate(table, number). +◦ PathSweep object has method CopyAndTranslate(table, number). +��� PathSweep object has method CopyAndRotate(Point, Vector, number, number). +◦ PathSweep object has method CopyAndTranslate(Point, Point, number). +◦ PathSweep object has method CopyAndMirror(table). +◦ PathSweep object has method Duplicate(). +◦ ProjectGeometry object has method CopyAndRotate(table, number). +◦ ProjectGeometry object has method CopyAndTranslate(table, number). +◦ ProjectGeometry object has method CopyAndRotate(Point, Vector, number, number). +◦ ProjectGeometry object has method CopyAndTranslate(Point, Point, number). +◦ ProjectGeometry object has method CopyAndMirror(table). +◦ ProjectGeometry object has method Duplicate(). +◦ RepairAndSewFaces object has method CopyAndRotate(table, number). +◦ RepairAndSewFaces object has method CopyAndTranslate(table, number). +◦ RepairAndSewFaces object has method CopyAndRotate(Point, Vector, number, number). +◦ RepairAndSewFaces object has method CopyAndTranslate(Point, Point, number). +◦ RepairAndSewFaces object has method CopyAndMirror(table). +◦ RepairAndSewFaces object has method Duplicate(). +◦ RepairPart object has method CopyAndRotate(table, number). +◦ RepairPart object has method CopyAndTranslate(table, number). +◦ RepairPart object has method CopyAndRotate(Point, Vector, number, number). +◦ RepairPart object has method CopyAndTranslate(Point, Point, number). +◦ RepairPart object has method CopyAndMirror(table). +◦ RepairPart object has method Duplicate(). +◦ Spin object has method CopyAndRotate(table, number). +◦ Spin object has method CopyAndTranslate(table, number). +◦ Spin object has method CopyAndRotate(Point, Vector, number, number). +◦ Spin object has method CopyAndTranslate(Point, Point, number). +◦ Spin object has method CopyAndMirror(table). +◦ Spin object has method Duplicate(). +◦ Split object has method CopyAndRotate(table, number). +◦ Split object has method CopyAndTranslate(table, number). +◦ Split object has method CopyAndRotate(Point, Vector, number, number). +◦ Split object has method CopyAndTranslate(Point, Point, number). +◦ Split object has method CopyAndMirror(table). +◦ Split object has method Duplicate(). +◦ Stitch object has method CopyAndRotate(table, number). +◦ Stitch object has method CopyAndTranslate(table, number). +◦ Stitch object has method CopyAndRotate(Point, Vector, number, number). +◦ Stitch object has method CopyAndTranslate(Point, Point, number). +◦ Stitch object has method CopyAndMirror(table). +◦ Stitch object has method Duplicate(). +◦ Subtract object has method CopyAndRotate(table, number). +◦ Subtract object has method CopyAndTranslate(table, number). +◦ Subtract object has method CopyAndRotate(Point, Vector, number, number). +◦ Subtract object has method CopyAndTranslate(Point, Point, number). +◦ Subtract object has method CopyAndMirror(table). +◦ Subtract object has method Duplicate(). +◦ Sweep object has method CopyAndRotate(table, number). +◦ Sweep object has method CopyAndTranslate(table, number). +◦ Sweep object has method CopyAndRotate(Point, Vector, number, number). +◦ Sweep object has method CopyAndTranslate(Point, Point, number). +◦ Sweep object has method CopyAndMirror(table). +◦ Sweep object has method Duplicate(). +◦ Union object has method CopyAndRotate(table, number). +◦ Union object has method CopyAndTranslate(table, number). +◦ Union object has method CopyAndRotate(Point, Vector, number, number). +◦ Union object has method CopyAndTranslate(Point, Point, number). +◦ Union object has method CopyAndMirror(table). +◦ Union object has method Duplicate(). +◦ Simplify object has method CopyAndRotate(table, number). +◦ Simplify object has method CopyAndTranslate(table, number). +◦ Simplify object has method CopyAndRotate(Point, Vector, number, number). +◦ Simplify object has method CopyAndTranslate(Point, Point, number). +◦ Simplify object has method CopyAndMirror(table). +◦ Simplify object has method Duplicate(). +◦ Line object has method CopyAndRotate(table, number). +◦ Line object has method CopyAndTranslate(table, number). +◦ Line object has method CopyAndRotate(Point, Vector, number, number). +◦ Line object has method CopyAndTranslate(Point, Point, number). +◦ Line object has method CopyAndMirror(table). +◦ Line object has method Duplicate(). +◦ NurbsSurface object has method CopyAndRotate(table, number). +◦ NurbsSurface object has method CopyAndTranslate(table, number). +◦ NurbsSurface object has method CopyAndRotate(Point, Vector, number, number). +◦ NurbsSurface object has method CopyAndTranslate(Point, Point, number). +◦ NurbsSurface object has method CopyAndMirror(table). +◦ NurbsSurface object has method Duplicate(). +◦ ParabolicArc object has method CopyAndRotate(table, number). +◦ ParabolicArc object has method CopyAndTranslate(table, number). +◦ ParabolicArc object has method CopyAndRotate(Point, Vector, number, number). +◦ ParabolicArc object has method CopyAndTranslate(Point, Point, number). +◦ ParabolicArc object has method CopyAndMirror(table). +◦ ParabolicArc object has method Duplicate(). +◦ Paraboloid object has method CopyAndRotate(table, number). +◦ Paraboloid object has method CopyAndTranslate(table, number). +◦ Paraboloid object has method CopyAndRotate(Point, Vector, number, number). +◦ Paraboloid object has method CopyAndTranslate(Point, Point, number). +◦ Paraboloid object has method CopyAndMirror(table). +◦ Paraboloid object has method Duplicate(). +◦ Polygon object has method CopyAndRotate(table, number). +◦ Polygon object has method CopyAndTranslate(table, number). +◦ Polygon object has method CopyAndRotate(Point, Vector, number, number). +◦ Polygon object has method CopyAndTranslate(Point, Point, number). +◦ Polygon object has method CopyAndMirror(table). +◦ Polygon object has method Duplicate(). +◦ Polyline object has method CopyAndRotate(table, number). +◦ Polyline object has method CopyAndTranslate(table, number). +◦ Polyline object has method CopyAndRotate(Point, Vector, number, number). +◦ Polyline object has method CopyAndTranslate(Point, Point, number). +◦ Polyline object has method CopyAndMirror(table). +◦ Polyline object has method Duplicate(). +◦ Primitive object has method CopyAndRotate(table, number). +◦ Primitive object has method CopyAndTranslate(table, number). +◦ Primitive object has method CopyAndRotate(Point, Vector, number, number). +◦ Primitive object has method CopyAndTranslate(Point, Point, number). +◦ Primitive object has method CopyAndMirror(table). +◦ Primitive object has method Duplicate(). +◦ Rectangle object has method CopyAndRotate(table, number). +◦ Rectangle object has method CopyAndTranslate(table, number). +◦ Rectangle object has method CopyAndRotate(Point, Vector, number, number). +◦ Rectangle object has method CopyAndTranslate(Point, Point, number). +◦ Rectangle object has method CopyAndMirror(table). +◦ Rectangle object has method Duplicate(). +◦ Sphere object has method CopyAndRotate(table, number). +◦ Sphere object has method CopyAndTranslate(table, number). +◦ Sphere object has method CopyAndRotate(Point, Vector, number, number). +◦ Sphere object has method CopyAndTranslate(Point, Point, number). +◦ Sphere object has method CopyAndMirror(table). +◦ Sphere object has method Duplicate(). +◦ AbstractSurfaceCurve object has method CopyAndRotate(table, number). +◦ AbstractSurfaceCurve object has method CopyAndTranslate(table, number). +◦ AbstractSurfaceCurve object has method CopyAndRotate(Point, Vector, number, number). +◦ AbstractSurfaceCurve object has method CopyAndTranslate(Point, Point, number). +◦ AbstractSurfaceCurve object has method CopyAndMirror(table). +◦ AbstractSurfaceCurve object has method Duplicate(). +◦ SurfaceBezierCurve object has method CopyAndRotate(table, number). +◦ SurfaceBezierCurve object has method CopyAndTranslate(table, number). +◦ SurfaceBezierCurve object has method CopyAndRotate(Point, Vector, number, number). +◦ SurfaceBezierCurve object has method CopyAndTranslate(Point, Point, number). +◦ SurfaceBezierCurve object has method CopyAndMirror(table). +◦ SurfaceBezierCurve object has method Duplicate(). +◦ SurfaceLine object has method CopyAndRotate(table, number). +◦ SurfaceLine object has method CopyAndTranslate(table, number). +◦ SurfaceLine object has method CopyAndRotate(Point, Vector, number, number). +◦ SurfaceLine object has method CopyAndTranslate(Point, Point, number). +◦ SurfaceLine object has method CopyAndMirror(table). +◦ SurfaceLine object has method Duplicate(). +◦ SurfaceRegularLines object has method CopyAndRotate(table, number). +◦ SurfaceRegularLines object has method CopyAndTranslate(table, number). +◦ SurfaceRegularLines object has method CopyAndRotate(Point, Vector, number, number). +◦ SurfaceRegularLines object has method CopyAndTranslate(Point, Point, number). +◦ SurfaceRegularLines object has method CopyAndMirror(table). +◦ SurfaceRegularLines object has method Duplicate(). +◦ TCross object has method CopyAndRotate(table, number). +◦ TCross object has method CopyAndTranslate(table, number). +◦ TCross object has method CopyAndRotate(Point, Vector, number, number). +◦ TCross object has method CopyAndTranslate(Point, Point, number). +◦ TCross object has method CopyAndMirror(table). +◦ TCross object has method Duplicate(). +◦ TopologyEntity object has method Duplicate(). +◦ Edge object has method Duplicate(). +◦ Face object has method Duplicate(). +◦ Region object has method Duplicate(). +◦ FillHoleSettings object has method Duplicate(). +◦ GeometryExporter object has method Duplicate(). +◦ Find object has method Duplicate(). +◦ GeometryImporter object has method Duplicate(). +◦ GeometryRebuild object has method Duplicate(). +◦ GeometryRepair object has method Duplicate(). +◦ RemoveSmallFeaturesSettings object has method Duplicate(). +◦ RepairAndSewFacesSettings object has method Duplicate(). +◦ RepairEdgesSettings object has method Duplicate(). +◦ RepairPartsSettings object has method Duplicate(). +◦ SimplifyPartRepresentationSettings object has method Duplicate(). +◦ WorkSurface object has method Duplicate(). +◦ FieldData object has method CopyAndRotate(table, number). +◦ FieldData object has method CopyAndTranslate(table, number). +◦ FieldData object has method CopyAndRotate(Point, Vector, number, number). +◦ FieldData object has method CopyAndTranslate(Point, Point, number). +◦ FieldData object has method CopyAndMirror(table). +◦ FieldData object has method Duplicate(). +◦ SolutionCoefficientData object has method CopyAndRotate(table, number). +◦ SolutionCoefficientData object has method CopyAndTranslate(table, number). +◦ SolutionCoefficientData object has method CopyAndRotate(Point, Vector, number, number). +◦ SolutionCoefficientData object has method CopyAndTranslate(Point, Point, number). +◦ SolutionCoefficientData object has method CopyAndMirror(table). +◦ SolutionCoefficientData object has method Duplicate(). +◦ PCBCurrentData object has method CopyAndRotate(table, number). +◦ PCBCurrentData object has method CopyAndTranslate(table, number). +◦ PCBCurrentData object has method CopyAndRotate(Point, Vector, number, number). +◦ PCBCurrentData object has method CopyAndTranslate(Point, Point, number). +◦ PCBCurrentData object has method CopyAndMirror(table). +◦ PCBCurrentData object has method Duplicate(). +◦ SphericalModeDataManuallySpecified object has method CopyAndRotate(table, number). +◦ SphericalModeDataManuallySpecified object has method CopyAndTranslate(table, number). +◦ SphericalModeDataManuallySpecified object has method CopyAndRotate(Point, Vector, +number, number). +◦ SphericalModeDataManuallySpecified object has method CopyAndTranslate(Point, Point, +number). +◦ SphericalModeDataManuallySpecified object has method CopyAndMirror(table). +◦ SphericalModeDataManuallySpecified object has method Duplicate(). +◦ SphericalModeDataFromFile object has method CopyAndRotate(table, number). +◦ SphericalModeDataFromFile object has method CopyAndTranslate(table, number). +◦ SphericalModeDataFromFile object has method CopyAndRotate(Point, Vector, number, +number). +◦ SphericalModeDataFromFile object has method CopyAndTranslate(Point, Point, number). +◦ SphericalModeDataFromFile object has method CopyAndMirror(table). +◦ SphericalModeDataFromFile object has method Duplicate(). +◦ NearFieldDataFullImport object has method CopyAndRotate(table, number). +◦ NearFieldDataFullImport object has method CopyAndTranslate(table, number). +◦ NearFieldDataFullImport object has method CopyAndRotate(Point, Vector, number, number). +◦ NearFieldDataFullImport object has method CopyAndTranslate(Point, Point, number). +◦ NearFieldDataFullImport object has method CopyAndMirror(table). +◦ NearFieldDataFullImport object has method Duplicate(). +◦ NearFieldDataFileStructure object has method CopyAndRotate(table, number). +◦ NearFieldDataFileStructure object has method CopyAndTranslate(table, number). +◦ NearFieldDataFileStructure object has method CopyAndRotate(Point, Vector, number, number). +◦ NearFieldDataFileStructure object has method CopyAndTranslate(Point, Point, number). +◦ NearFieldDataFileStructure object has method CopyAndMirror(table). +◦ NearFieldDataFileStructure object has method Duplicate(). +◦ FarFieldData object has method CopyAndRotate(table, number). +◦ FarFieldData object has method CopyAndTranslate(table, number). +◦ FarFieldData object has method CopyAndRotate(Point, Vector, number, number). +◦ FarFieldData object has method CopyAndTranslate(Point, Point, number). +◦ FarFieldData object has method CopyAndMirror(table). +◦ FarFieldData object has method Duplicate(). +◦ Shape object has method Duplicate(). +◦ CrossShape object has method Duplicate(). +◦ StripCrossShape object has method Duplicate(). +◦ EllipseShape object has method Duplicate(). +◦ HexagonShape object has method Duplicate(). +◦ StripHexagonShape object has method Duplicate(). +◦ PlaneShape object has method Duplicate(). +◦ RingShape object has method Duplicate(). +◦ OpenRingShape object has method Duplicate(). +◦ SplitRingShape object has method Duplicate(). +◦ SpiralCrossShape object has method Duplicate(). +◦ TCrossShape object has method Duplicate(). +◦ TrifilarShape object has method Duplicate(). +◦ MeshSettings object has method Duplicate(). +◦ LocalMeshSettings object has method Duplicate(). +◦ GlobalMeshSettings object has method Duplicate(). +◦ VoxelSettings object has method Duplicate(). +◦ FDTDBoundaryConditions object has method Duplicate(). +◦ Port object has method Duplicate(). +◦ CablePort object has method Duplicate(). +◦ EdgeMeshPort object has method Duplicate(). +◦ EdgePort object has method Duplicate(). +◦ AbstractFEMLinePort object has method CopyAndRotate(table, number). +◦ AbstractFEMLinePort object has method CopyAndTranslate(table, number). +◦ AbstractFEMLinePort object has method CopyAndRotate(Point, Vector, number, number). +◦ AbstractFEMLinePort object has method CopyAndTranslate(Point, Point, number). +◦ AbstractFEMLinePort object has method CopyAndMirror(table). +◦ AbstractFEMLinePort object has method Duplicate(). +◦ FEMLineMeshPort object has method CopyAndRotate(table, number). +◦ FEMLineMeshPort object has method CopyAndTranslate(table, number). +◦ FEMLineMeshPort object has method CopyAndRotate(Point, Vector, number, number). +◦ FEMLineMeshPort object has method CopyAndTranslate(Point, Point, number). +◦ FEMLineMeshPort object has method CopyAndMirror(table). +◦ FEMLineMeshPort object has method Duplicate(). +◦ FEMLinePort object has method CopyAndRotate(table, number). +◦ FEMLinePort object has method CopyAndTranslate(table, number). +◦ FEMLinePort object has method CopyAndRotate(Point, Vector, number, number). +◦ FEMLinePort object has method CopyAndTranslate(Point, Point, number). +◦ FEMLinePort object has method CopyAndMirror(table). +◦ FEMLinePort object has method Duplicate(). +◦ FEMModalMeshPort object has method CopyAndRotate(table, number). +◦ FEMModalMeshPort object has method CopyAndTranslate(table, number). +◦ FEMModalMeshPort object has method CopyAndRotate(Point, Vector, number, number). +◦ FEMModalMeshPort object has method CopyAndTranslate(Point, Point, number). +◦ FEMModalMeshPort object has method CopyAndMirror(table). +◦ FEMModalMeshPort object has method Duplicate(). +◦ FEMModalPort object has method CopyAndRotate(table, number). +◦ FEMModalPort object has method CopyAndTranslate(table, number). +◦ FEMModalPort object has method CopyAndRotate(Point, Vector, number, number). +◦ FEMModalPort object has method CopyAndTranslate(Point, Point, number). +◦ FEMModalPort object has method CopyAndMirror(table). +◦ FEMModalPort object has method Duplicate(). +◦ AbstractMeshPort object has method Duplicate(). +◦ MicrostripMeshPort object has method Duplicate(). +◦ WireMeshPort object has method Duplicate(). +◦ MicrostripPort object has method Duplicate(). +◦ WaveguideMeshPort object has method Duplicate(). +◦ WaveguidePort object has method Duplicate(). +◦ WirePort object has method Duplicate(). +◦ CharacteristicModes object has method Duplicate(). +◦ SolutionConfiguration object has method Duplicate(). +◦ CharacteristicModesConfiguration object has method Duplicate(). +◦ SParameterConfiguration object has method Duplicate(). +◦ StandardConfiguration object has method Duplicate(). +◦ Source object has method Duplicate(). +◦ CurrentSource object has method Duplicate(). +◦ FEMModalSource object has method Duplicate(). +◦ VoltageSource object has method Duplicate(). +◦ WaveguideSource object has method Duplicate(). +◦ AbstractIdealSource object has method CopyAndRotate(table, number). +◦ AbstractIdealSource object has method CopyAndTranslate(table, number). +◦ AbstractIdealSource object has method CopyAndRotate(Point, Vector, number, number). +◦ AbstractIdealSource object has method CopyAndTranslate(Point, Point, number). +◦ AbstractIdealSource object has method CopyAndMirror(table). +◦ AbstractIdealSource object has method Duplicate(). +◦ AbstractPointSource object has method CopyAndRotate(table, number). +◦ AbstractPointSource object has method CopyAndTranslate(table, number). +◦ AbstractPointSource object has method CopyAndRotate(Point, Vector, number, number). +◦ AbstractPointSource object has method CopyAndTranslate(Point, Point, number). +◦ AbstractPointSource object has method CopyAndMirror(table). +◦ AbstractPointSource object has method Duplicate(). +◦ ElectricDipole object has method CopyAndRotate(table, number). +◦ ElectricDipole object has method CopyAndTranslate(table, number). +◦ ElectricDipole object has method CopyAndRotate(Point, Vector, number, number). +◦ ElectricDipole object has method CopyAndTranslate(Point, Point, number). +◦ ElectricDipole object has method CopyAndMirror(table). +◦ ElectricDipole object has method Duplicate(). +◦ MagneticDipole object has method CopyAndRotate(table, number). +◦ MagneticDipole object has method CopyAndTranslate(table, number). +◦ MagneticDipole object has method CopyAndRotate(Point, Vector, number, number). +◦ MagneticDipole object has method CopyAndTranslate(Point, Point, number). +◦ MagneticDipole object has method CopyAndMirror(table). +◦ MagneticDipole object has method Duplicate(). +◦ +◦ +◦ +◦ +ImpressedCurrent object has method CopyAndRotate(table, number). +ImpressedCurrent object has method CopyAndTranslate(table, number). +ImpressedCurrent object has method CopyAndRotate(Point, Vector, number, number). +ImpressedCurrent object has method CopyAndTranslate(Point, Point, number). +◦ +◦ +ImpressedCurrent object has method CopyAndMirror(table). +ImpressedCurrent object has method Duplicate(). +◦ FarFieldSource object has method CopyAndRotate(table, number). +◦ FarFieldSource object has method CopyAndTranslate(table, number). +◦ FarFieldSource object has method CopyAndRotate(Point, Vector, number, number). +◦ FarFieldSource object has method CopyAndTranslate(Point, Point, number). +◦ FarFieldSource object has method CopyAndMirror(table). +◦ FarFieldSource object has method Duplicate(). +◦ NearFieldSource object has method CopyAndRotate(table, number). +◦ NearFieldSource object has method CopyAndTranslate(table, number). +◦ NearFieldSource object has method CopyAndRotate(Point, Vector, number, number). +◦ NearFieldSource object has method CopyAndTranslate(Point, Point, number). +◦ NearFieldSource object has method CopyAndMirror(table). +◦ NearFieldSource object has method Duplicate(). +◦ PCBSource object has method CopyAndRotate(table, number). +◦ PCBSource object has method CopyAndTranslate(table, number). +◦ PCBSource object has method CopyAndRotate(Point, Vector, number, number). +◦ PCBSource object has method CopyAndTranslate(Point, Point, number). +◦ PCBSource object has method CopyAndMirror(table). +◦ PCBSource object has method Duplicate(). +◦ SolutionCoefficientSource object has method CopyAndRotate(table, number). +◦ SolutionCoefficientSource object has method CopyAndTranslate(table, number). +◦ SolutionCoefficientSource object has method CopyAndRotate(Point, Vector, number, number). +◦ SolutionCoefficientSource object has method CopyAndTranslate(Point, Point, number). +◦ SolutionCoefficientSource object has method CopyAndMirror(table). +◦ SolutionCoefficientSource object has method Duplicate(). +◦ SphericalModeSource object has method CopyAndRotate(table, number). +◦ SphericalModeSource object has method CopyAndTranslate(table, number). +◦ SphericalModeSource object has method CopyAndRotate(Point, Vector, number, number). +◦ SphericalModeSource object has method CopyAndTranslate(Point, Point, number). +◦ SphericalModeSource object has method CopyAndMirror(table). +◦ SphericalModeSource object has method Duplicate(). +◦ PlaneWave object has method CopyAndRotate(table, number). +◦ PlaneWave object has method CopyAndTranslate(table, number). +◦ PlaneWave object has method CopyAndRotate(Point, Vector, number, number). +◦ PlaneWave object has method CopyAndTranslate(Point, Point, number). +◦ PlaneWave object has method CopyAndMirror(table). +◦ PlaneWave object has method Duplicate(). +◦ Currents object has method Duplicate(). +◦ ErrorEstimation object has method Duplicate(). +◦ FarField object has method CopyAndRotate(table, number). +◦ FarField object has method CopyAndTranslate(table, number). +◦ FarField object has method CopyAndRotate(Point, Vector, number, number). +◦ FarField object has method CopyAndTranslate(Point, Point, number). +◦ FarField object has method CopyAndMirror(table). +◦ FarField object has method Duplicate(). +◦ BaseFieldReceivingAntenna object has method CopyAndRotate(table, number). +◦ BaseFieldReceivingAntenna object has method CopyAndTranslate(table, number). +◦ BaseFieldReceivingAntenna object has method CopyAndRotate(Point, Vector, number, +number). +◦ BaseFieldReceivingAntenna object has method CopyAndTranslate(Point, Point, number). +◦ BaseFieldReceivingAntenna object has method CopyAndMirror(table). +◦ BaseFieldReceivingAntenna object has method Duplicate(). +◦ FarFieldReceivingAntenna object has method CopyAndRotate(table, number). +◦ FarFieldReceivingAntenna object has method CopyAndTranslate(table, number). +◦ FarFieldReceivingAntenna object has method CopyAndRotate(Point, Vector, number, number). +◦ FarFieldReceivingAntenna object has method CopyAndTranslate(Point, Point, number). +◦ FarFieldReceivingAntenna object has method CopyAndMirror(table). +◦ FarFieldReceivingAntenna object has method Duplicate(). +◦ NearFieldReceivingAntenna object has method CopyAndRotate(table, number). +◦ NearFieldReceivingAntenna object has method CopyAndTranslate(table, number). +◦ NearFieldReceivingAntenna object has method CopyAndRotate(Point, Vector, number, +number). +◦ NearFieldReceivingAntenna object has method CopyAndTranslate(Point, Point, number). +◦ NearFieldReceivingAntenna object has method CopyAndMirror(table). +◦ NearFieldReceivingAntenna object has method Duplicate(). +◦ SphericalModeReceivingAntenna object has method CopyAndRotate(table, number). +◦ SphericalModeReceivingAntenna object has method CopyAndTranslate(table, number). +◦ SphericalModeReceivingAntenna object has method CopyAndRotate(Point, Vector, number, +number). +◦ SphericalModeReceivingAntenna object has method CopyAndTranslate(Point, Point, number). +◦ SphericalModeReceivingAntenna object has method CopyAndMirror(table). +◦ SphericalModeReceivingAntenna object has method Duplicate(). +◦ Frequency object has method Duplicate(). +◦ Network object has method Duplicate(). +◦ GeneralNetwork object has method Duplicate(). +◦ TransmissionLine object has method Duplicate(). +◦ GroundPlane object has method Duplicate(). +◦ Load object has method Duplicate(). +◦ ModelSymmetry object has method Duplicate(). +◦ NearField object has method CopyAndRotate(table, number). +◦ NearField object has method CopyAndTranslate(table, number). +◦ NearField object has method CopyAndRotate(Point, Vector, number, number). +◦ NearField object has method CopyAndTranslate(Point, Point, number). +◦ NearField object has method CopyAndMirror(table). +◦ NearField object has method Duplicate(). +◦ NumericalGreensFunction object has method Duplicate(). +◦ PeriodicBoundary object has method CopyAndRotate(table, number). +◦ PeriodicBoundary object has method CopyAndTranslate(table, number). +◦ PeriodicBoundary object has method CopyAndRotate(Point, Vector, number, number). +◦ PeriodicBoundary object has method CopyAndTranslate(Point, Point, number). +◦ PeriodicBoundary object has method CopyAndMirror(table). +◦ PeriodicBoundary object has method Duplicate(). +◦ Power object has method Duplicate(). +◦ SAR object has method Duplicate(). +◦ SParameter object has method Duplicate(). +◦ SolutionSettings object has method Duplicate(). +◦ SolverSettings object has method Duplicate(). +◦ TransmissionReflection object has method Duplicate(). +◦ UnitCell object has method Duplicate(). +◦ OptimisationOperator object has method Duplicate(). +◦ OptimisationGoal object has method Duplicate(). +◦ SParameterOptimisationGoal object has method Duplicate(). +◦ FarFieldOptimisationGoal object has method Duplicate(). +◦ +ImpedanceOptimisationGoal object has method Duplicate(). +◦ NearFieldOptimisationGoal object has method Duplicate(). +◦ PowerOptimisationGoal object has method Duplicate(). +◦ ReceivingAntennaOptimisationGoal object has method Duplicate(). +◦ SAROptimisationGoal object has method Duplicate(). +◦ TransmissionReflectionOptimisationGoal object has method Duplicate(). +◦ OptimisationCombination object has method Duplicate(). +◦ Optimisation object has method Duplicate(). +◦ OptimisationGoalObjective object has method Duplicate(). +◦ OptimisationMask object has method Duplicate(). +◦ OptimisationParameters object has method Duplicate(). +◦ OptimisationSearch object has method Duplicate(). +◦ OptimisationSearchAdvancedSettings object has method Duplicate(). +◦ PCB object has method Duplicate(). +◦ CFXModelImportSettings object has method Duplicate(). +◦ CFXModelImporter object has method Duplicate(). +◦ Exporter object has method Duplicate(). +◦ +Importer object has method Duplicate(). +◦ MeshExporter object has method Duplicate(). +◦ MeshImporter object has method Duplicate(). +◦ MeshInfo object has method Duplicate(). +◦ ModelMeshInfo object has method Duplicate(). +◦ SimulationMeshInfo object has method Duplicate(). +◦ Mesher object has method Duplicate(). +◦ ModelContents object has method Duplicate(). +◦ ModelDefinitions object has method Duplicate(). +◦ ProtectedModel object has method CopyAndRotate(table, number). +◦ ProtectedModel object has method CopyAndTranslate(table, number). +◦ ProtectedModel object has method CopyAndRotate(Point, Vector, number, number). +◦ ProtectedModel object has method CopyAndTranslate(Point, Point, number). +◦ ProtectedModel object has method CopyAndMirror(table). +◦ ProtectedModel object has method Duplicate(). +◦ UnprotectedInformation object has method Duplicate(). +◦ LaunchResult object has method Duplicate(). +◦ LibraryMedium object has method Duplicate(). +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1427 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ObjectReferenceList +A list of ObjectReference items. +Usage locations +The ObjectReferenceList object can be accessed from the following locations: +• Properties +◦ Cutplane object has property FilteredEntities. +◦ +◦ +ImprintPoints object has property ChildReferences. +Intersect object has property ChildReferences. +◦ Loft object has property ChildReferences. +◦ PathSweep object has property ChildReferences. +◦ ProjectGeometry object has property ChildReferences. +◦ RepairAndSewFaces object has property ChildReferences. +◦ RepairPart object has property ChildReferences. +◦ Spin object has property ChildReferences. +◦ Split object has property ChildReferences. +◦ Stitch object has property ChildReferences. +◦ Subtract object has property ChildReferences. +◦ Sweep object has property ChildReferences. +◦ Union object has property ChildReferences. +◦ Simplify object has property ChildReferences. +◦ EdgeMeshPort object has property PositiveFaces. +◦ EdgeMeshPort object has property NegativeFaces. +◦ EdgePort object has property PositiveFaces. +◦ EdgePort object has property NegativeFaces. +◦ FEMLinePort object has property Edges. +◦ FEMModalPort object has property Faces. +◦ MicrostripPort object has property Edges. +◦ Currents object has property ScopedEntities. +◦ ErrorEstimation object has property ScopedEntities. +◦ NearFieldReceivingAntenna object has property CombinedFacesFieldData. +◦ NumericalGreensFunction object has property StaticParts. +◦ ScopeSettings object has property ScopedEntities. +Method List +Append () +Appends a new item to the list. (Returns a ObjectReference object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a ObjectReference object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +ObjectReference +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +ObjectReference +The value at the given index +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ObjectReferenceTable +A table (2 dimensional list) of ObjectReference items. +Usage locations +The ObjectReferenceTable object can be accessed from the following locations: +• Properties +◦ AnisotropicDielectric object has property DiagonalTensor. +◦ AnisotropicDielectric object has property FullTensor. +p.1431 +Method List +AddColumn () +Appends a new column to the table. +AddRow () +Appends a new row to the table. +ColumnCount () +Returns the number columns in the table. (Returns a number object.) +Get (rowIndex number, columnIndex number) +Returns the item at the given row and column indices. Indexing starts at 1. (Returns a +ObjectReference object.) +RowCount () +Returns the number of rows in the table. (Returns a number object.) +Set (rowIndex number, columnIndex number, value ObjectReference) +Set item at the given row and column indices. Indexing starts at 1. +SetDimensions (rowCount number, columnCount number) +Sets the number of rows and columns in the table. +Method Details +AddColumn () +Appends a new column to the table. +AddRow () +Appends a new row to the table. +ColumnCount () +Returns the number columns in the table. +Return +number +The number of columns in the table. +Get (rowIndex number, columnIndex number) +Returns the item at the given row and column indices. Indexing starts at 1. +Input Parameters +rowIndex(number) +The row index of the item to return. +columnIndex(number) +The column index of the item to return. +Return +ObjectReference +The ObjectReference at the given indices. +RowCount () +Returns the number of rows in the table. +Return +number +The number of rows in the table. +Set (rowIndex number, columnIndex number, value ObjectReference) +Set item at the given row and column indices. Indexing starts at 1. +Input Parameters +rowIndex(number) +The row index of the item to return. +columnIndex(number) +The column index of the item to return. +value(ObjectReference) +The ObjectReference item to be assigned to the table at the given indices. +SetDimensions (rowCount number, columnCount number) +Sets the number of rows and columns in the table. +Input Parameters +rowCount(number) +The number of rows. +columnCount(number) +The number of columns. +OpenRing +An open ring. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a ring at the specified 'Point' +centre = cf.Point(-0.25, -0.25, 0) +ring = project.Contents.Geometry:AddOpenRing(centre, 1.5, 1.2, 45, 90) +Inheritance +The OpenRing object is derived from the Ring object. +The following objects are derived (specialisations) from the OpenRing object: +• SplitRing +Usage locations +The OpenRing object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddOpenRing(table). +◦ GeometryCollection collection has method AddOpenRing(Point, Expression, Expression, +Expression, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The ring centre point. (Read/Write LocalCoordinate) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +GapAngle +The angle of the ring opening. (Read/Write AngularDimension) +InnerRadius +The ring inner radius. (Read/Write Dimension) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +OuterRadius +The ring outer radius. (Read/Write Dimension) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +StartAngle +The angle the ring opening starts at. (Read/Write AngularDimension) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +The ring centre point. +Type +LocalCoordinate +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +GapAngle +The angle of the ring opening. +Type +AngularDimension +Access +Read/Write +InnerRadius +The ring inner radius. +Type +Dimension +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +OuterRadius +The ring outer radius. +Type +Dimension +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +StartAngle +The angle the ring opening starts at. +Type +AngularDimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +p.1439 +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +p.1441 +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +OpenRingShape +A open ring shape. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create an open ring shape +ring = + project.Definitions.PeriodicStructures.Shapes:AddOpenRing(1.5, 1.2, 10.0, 30.0) +Inheritance +The OpenRingShape object is derived from the RingShape object. +The following objects are derived (specialisations) from the OpenRingShape object: +• SplitRingShape +Usage locations +The OpenRingShape object can be accessed from the following locations: +• Methods +◦ ShapeCollection collection has method AddOpenRing(table). +◦ ShapeCollection collection has method AddOpenRing(Expression, Expression, Expression, +Expression). +Property List +GapAngle +The angle of the ring opening. (Read/Write ParametricExpression) +InnerRadius +The ring inner radius. (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +OuterRadius +The ring outer radius. (Read/Write ParametricExpression) +StartAngle +The angle the ring opening starts at. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +BuildGeometry () +Creates the full geometry representation of the shape. (Returns a Geometry object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +GapAngle +The angle of the ring opening. +Type +ParametricExpression +Access +Read/Write +InnerRadius +The ring inner radius. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +OuterRadius +The ring outer radius. +Type +ParametricExpression +Access +Read/Write +StartAngle +The angle the ring opening starts at. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +BuildGeometry () +Creates the full geometry representation of the shape. +Return +Geometry +The shape geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Optimisation +An optimisation object. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add an optimisation using the genetic search algorithm +project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GeneticAlgorithm) + -- Get the number of optimisation masks +maskCount = project.Optimisation.Masks.Count +Inheritance +The Optimisation object is derived from the Object object. +Usage locations +The Optimisation object can be accessed from the following locations: +• Properties +◦ Model object has property Optimisation. +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Collection List +Masks +A collection of optimisation masks. (OptimisationMaskCollection of OptimisationMask.) +Searches +A collection of optimisation searches. (OptimisationSearchCollection of OptimisationSearch.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1447 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Masks +A collection of optimisation masks. +Type +Searches +OptimisationMaskCollection +A collection of optimisation searches. +Type +OptimisationSearchCollection +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.1448 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +OptimisationCombination +p.1449 +A combined set of goals where only the minimum, maximum or average value of all of the errors of all +of the goals in the set is taken. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Optimisation.cfx]]}) +search = project.Optimisation.Searches["Search1"] + -- Combine all the optimisation goals +goals = search.Goals:Items() +properties = cf.OptimisationCombination.GetDefaultProperties() +properties.OperatorsToCombine = goals +combinedGoal = search.Goals:AddCombinedGoal(properties) + -- Set the combination type to use only the maximum value of the combined goals +combinedGoal.CombineType = cf.Enums.OptimisationCombineTypeEnum.Maximum +Inheritance +The OptimisationCombination object is derived from the OptimisationOperator object. +Usage locations +The OptimisationCombination object can be accessed from the following locations: +• Methods +◦ OptimisationGoalCollection collection has method AddCombinedGoal(table). +◦ OptimisationGoalCollection collection has method AddCombinedGoal(table, List of +OptimisationOperator). +Property List +CombineType +The combination type that specifies how the evaluated errors of the goals in the combination +should be reduced to one error value. (Read/Write OptimisationCombineTypeEnum) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Weight +Weight associated with the combine. (Read/Write ParametricExpression) +Collection List +Goals +A collection of combined optimisation goals. (OptimisationGoalCollection of OptimisationOperator.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CombineType +The combination type that specifies how the evaluated errors of the goals in the combination +should be reduced to one error value. +Type +OptimisationCombineTypeEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Weight +Weight associated with the combine. +Type +ParametricExpression +Access +Read/Write +Collection Details +Goals +A collection of combined optimisation goals. +Type +OptimisationGoalCollection +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +OptimisationConstraint +Constraint. +Example +p.1452 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add an optimisation search with the some variables +startFreq = project.Definitions.Variables:Add("freqStart", 1e6) +endFreq = project.Definitions.Variables:Add("freqEnd", 10e6) +search = + project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) +searchVar = search.Parameters.Variables:append() +searchVar.Variable = startFreq +searchVar.MinimumValue = 1e6 +searchVar.MaximumValue = 10e6 +searchVar1 = search.Parameters.Variables:append() +searchVar1.Variable = endFreq +searchVar1.MinimumValue = 10e6 +searchVar1.MaximumValue = 100e6 + -- Add a variable constraint to the optimisation search +optimisationConstraint = search.Parameters.Constraints:append() +optimisationConstraint.LeftVariable = startFreq +optimisationConstraint.Relation = cf.Enums.OptimisationConstraintRelationEnum.Less +optimisationConstraint.RightVariable = endFreq + -- Modify the constraint relation between the two variables +search.Parameters.Constraints[1].Relation + = cf.Enums.OptimisationConstraintRelationEnum.LessOrEqual +Inheritance +The OptimisationConstraint object is derived from the CompositeValue object. +Usage locations +The OptimisationConstraint object can be accessed from the following locations: +• Methods +◦ OptimisationConstraintList object has method Append(). +◦ OptimisationConstraintList object has method Get(number). +Property List +Enabled +Enables the constraint for use in the optimisation. (Read/Write boolean) +LeftVariable +Left variable. (Read/Write Variable) +Relation +Constraint between two variables. (Read/Write OptimisationConstraintRelationEnum) +RightVariable +Right variable. (Read/Write Variable) +Property Details +Enabled +Enables the constraint for use in the optimisation. +Type +boolean +Access +Read/Write +LeftVariable +Left variable. +Type +Variable +Access +Read/Write +Relation +Constraint between two variables. +Type +OptimisationConstraintRelationEnum +Access +Read/Write +RightVariable +Right variable. +Type +Variable +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +OptimisationConstraintList +A list of OptimisationConstraint items. +Usage locations +p.1454 +The OptimisationConstraintList object can be accessed from the following locations: +• Properties +◦ OptimisationParameters object has property Constraints. +Method List +Append () +Appends a new item to the list. (Returns a OptimisationConstraint object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a OptimisationConstraint +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +OptimisationConstraint +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +OptimisationConstraint +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +OptimisationGoal +An optimisation goal. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Optimisation.cfx]]}) + -- Increase the 'FarFieldGoal' weight to 2.0 +goal = project.Optimisation.Searches["Search1"].Goals["FarFieldGoal1"] +goal.Weight = 2.0 +Inheritance +The OptimisationGoal object is derived from the OptimisationOperator object. +The following objects are derived (specialisations) from the OptimisationGoal object: +• FarFieldOptimisationGoal +• ImpedanceOptimisationGoal +• NearFieldOptimisationGoal +• PowerOptimisationGoal +• ReceivingAntennaOptimisationGoal +• SAROptimisationGoal +• SParameterOptimisationGoal +• TransmissionReflectionOptimisationGoal +Property List +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. (Read/Write string) +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +(Read/Write OptimisationGoalOperatorEnum) +Label +The object label. (Read/Write string) +Objective +The objective describes a state that the optimisation process should attempt to achieve. (Read +only OptimisationGoalObjective) +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. (Read/Write OptimisationGoalProcessingStepsList) +Type +The object type string. (Read only string) +Weight +Specify the optimisation weight. (Read/Write ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. +Type +string +Access +Read/Write +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +Type +OptimisationGoalOperatorEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Objective +The objective describes a state that the optimisation process should attempt to achieve. +Type +OptimisationGoalObjective +Access +Read only +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. +Type +OptimisationGoalProcessingStepsList +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Weight +Specify the optimisation weight. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +table +A table defining the properties. +SetProperties (properties Object) +p.1459 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +OptimisationGoalObjective +The optimisation goal objective. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Optimisation.cfx]]}) +goal = project.Optimisation.Searches["Search1"].Goals["FarFieldGoal1"] + -- Set the goal to have an objective target value less than 10 +properties = goal:GetProperties() +properties.GoalOperator = cf.Enums.OptimisationGoalOperatorEnum.LessThan +properties.Objective.TargetValue = "10" +goal:SetProperties(properties) +Inheritance +The OptimisationGoalObjective object is derived from the Object object. +Usage locations +The OptimisationGoalObjective object can be accessed from the following locations: +• Properties +◦ OptimisationGoal object has property Objective. +◦ SParameterOptimisationGoal object has property Objective. +◦ FarFieldOptimisationGoal object has property Objective. +◦ +ImpedanceOptimisationGoal object has property Objective. +◦ NearFieldOptimisationGoal object has property Objective. +◦ PowerOptimisationGoal object has property Objective. +◦ ReceivingAntennaOptimisationGoal object has property Objective. +◦ SAROptimisationGoal object has property Objective. +◦ TransmissionReflectionOptimisationGoal object has property Objective. +Property List +Label +Mask +The object label. (Read/Write string) +Set the mask. (Read/Write OptimisationMask) +TargetValue +Specify the target value. (Read/Write ParametricExpression) +TargetValueType +Set the target value type. (Read/Write OptimisationTargetValueTypeEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.1461 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Mask +Set the mask. +Type +OptimisationMask +Access +Read/Write +TargetValue +Specify the target value. +Type +ParametricExpression +Access +Read/Write +TargetValueType +Set the target value type. +Type +OptimisationTargetValueTypeEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +OptimisationGoalProcessingSteps +Focus processing steps. +Example +p.1464 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Optimisation.cfx]]}) +goal = project.Optimisation.Searches["Search1"].Goals["FarFieldGoal1"] + -- Set the first processing step operation to get the maximum value +goal.ProcessingSteps[1].Operation = cf.Enums.OptimisationGoalProcessingStepsEnum.Max + -- Add an offset of 10 as the second processing step +processingStep = goal.ProcessingSteps:append() +processingStep.Operation = cf.Enums.OptimisationGoalProcessingStepsEnum.Offset +processingStep.Value = 10 +Inheritance +The OptimisationGoalProcessingSteps object is derived from the CompositeValue object. +Usage locations +The OptimisationGoalProcessingSteps object can be accessed from the following locations: +• Methods +◦ OptimisationGoalProcessingStepsList object has method Append(). +◦ OptimisationGoalProcessingStepsList object has method Get(number). +Property List +Operation +Processing operation carried out on the goal focus. (Read/Write +OptimisationGoalProcessingStepsEnum) +Value +Processing value if required by the operation. (Read/Write ParametricExpression) +Property Details +Operation +Processing operation carried out on the goal focus. +Type +OptimisationGoalProcessingStepsEnum +Access +Read/Write +Value +Processing value if required by the operation. +Type +ParametricExpression +Access +Read/Write +OptimisationGoalProcessingStepsList +A list of OptimisationGoalProcessingSteps items. +Usage locations +The OptimisationGoalProcessingStepsList object can be accessed from the following locations: +• Properties +◦ OptimisationGoal object has property ProcessingSteps. +◦ SParameterOptimisationGoal object has property ProcessingSteps. +◦ FarFieldOptimisationGoal object has property ProcessingSteps. +◦ +ImpedanceOptimisationGoal object has property ProcessingSteps. +◦ NearFieldOptimisationGoal object has property ProcessingSteps. +◦ PowerOptimisationGoal object has property ProcessingSteps. +◦ ReceivingAntennaOptimisationGoal object has property ProcessingSteps. +◦ SAROptimisationGoal object has property ProcessingSteps. +◦ TransmissionReflectionOptimisationGoal object has property ProcessingSteps. +Method List +Append () +Appends a new item to the list. (Returns a OptimisationGoalProcessingSteps object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +OptimisationGoalProcessingSteps object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +OptimisationGoalProcessingSteps +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +OptimisationGoalProcessingSteps +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +OptimisationMask +An optimisation mask. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add an optimisation mask for the given list of values +xValues = {0, 1, 2, 3, 4} +yValues = {0, 10, 20, 20, 30} +mask = project.Optimisation.Masks:Add(xValues, yValues) + -- Set the label of the mask +mask.Label = "ImpedanceMask" +Inheritance +The OptimisationMask object is derived from the Object object. +Usage locations +The OptimisationMask object can be accessed from the following locations: +• Properties +◦ OptimisationGoalObjective object has property Mask. +• Methods +◦ OptimisationMaskCollection collection has method Add(table). +◦ OptimisationMaskCollection collection has method Add(ExpressionList, ExpressionList). +◦ OptimisationMaskCollection collection has method Item(number). +◦ OptimisationMaskCollection collection has method Item(string). +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Values +Mask coordinates. (Read/Write OptimisationMaskValuesList) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1469 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Values +Mask coordinates. +Type +OptimisationMaskValuesList +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.1470 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +OptimisationMaskValues +The graph value pairs of the optimisation mask. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add an optimisation mask for the given list of values +xValues = {0, 1, 2, 3, 4} +yValues = {0, 10, 20, 20, 30} +mask = project.Optimisation.Masks:Add(xValues, yValues) + -- Get the X and Y coordinates of the first value of the mask +startX = mask.Values[1].X +startY = mask.Values[1].Y +Inheritance +The OptimisationMaskValues object is derived from the CompositeValue object. +Usage locations +The OptimisationMaskValues object can be accessed from the following locations: +• Methods +◦ OptimisationMaskValuesList object has method Append(). +◦ OptimisationMaskValuesList object has method Get(number). +Property List +The x value. (Read/Write ParametricExpression) +The y value. (Read/Write ParametricExpression) +Property Details +The x value. +Type +ParametricExpression +Access +Read/Write +The y value. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +OptimisationMaskValuesList +A list of OptimisationMaskValues items. +Usage locations +p.1473 +The OptimisationMaskValuesList object can be accessed from the following locations: +• Properties +◦ OptimisationMask object has property Values. +Method List +Append () +Appends a new item to the list. (Returns a OptimisationMaskValues object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a OptimisationMaskValues +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +OptimisationMaskValues +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +OptimisationMaskValues +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +OptimisationOperator +An optimisation operator. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Optimisation.cfx]]}) + -- Set the label of the optimisation operator +optimisationOperator = + project.Optimisation.Searches["Search1"].Goals["FarFieldGoal1"] +optimisationOperator.Label = "MaxFarFieldGainGoal" +Inheritance +The OptimisationOperator object is derived from the Object object. +The following objects are derived (specialisations) from the OptimisationOperator object: +• OptimisationCombination +• OptimisationGoal +Usage locations +The OptimisationOperator object can be accessed from the following locations: +• Methods +◦ OptimisationGoalCollection collection has method Item(number). +◦ OptimisationGoalCollection collection has method Item(string). +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1476 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +OptimisationParameters +p.1478 +An optimisation parameters object that defines the variables which may be used during the optimisation +process. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add an optimisation using the grid search algorithm +search = + project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) + -- Get the number of optimisation parameters variables defined +variableCount = search.Parameters.Variables:count() +Inheritance +The OptimisationParameters object is derived from the Object object. +Usage locations +The OptimisationParameters object can be accessed from the following locations: +• Properties +◦ OptimisationSearch object has property Parameters. +Property List +Constraints +A collection of variable constraints. (Read/Write OptimisationConstraintList) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Variables +A collection of variables used in the optimisation process. (Read/Write OptimisationVariableList) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1479 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Constraints +A collection of variable constraints. +Type +OptimisationConstraintList +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Variables +A collection of variables used in the optimisation process. +Type +OptimisationVariableList +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.1480 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +OptimisationSearch +An optimisation search object. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add an optimisation using the grid search algorithm +search = + project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) + -- Set the number of points used in the grid search to 20 +search.NumberOfPoints = 20 +Inheritance +The OptimisationSearch object is derived from the Object object. +Usage locations +The OptimisationSearch object can be accessed from the following locations: +• Methods +◦ OptimisationSearchCollection collection has method Add(table). +◦ OptimisationSearchCollection collection has method Add(OptimisationMethodTypeEnum). +◦ OptimisationSearchCollection collection has method Item(number). +◦ OptimisationSearchCollection collection has method Item(string). +Property List +Advanced +Advanced properties for the optimisation search. (Read only +OptimisationSearchAdvancedSettings) +ConvergenceAccuracy +Set the convergence rate. Only applies if the MethodType is set to AutoMethod, +ParticleSwarmOptimisation, GeneticAlgorithm, Simplex or AdaptiveResponseSurfaceMethod. +(Read/Write OptimisationConvergenceAccuracyEnum) +Label +The object label. (Read/Write string) +MethodType +Set the search algorithm. (Read/Write OptimisationMethodTypeEnum) +NumberOfPoints +Specify the default number of points to be used in the grid search. Only applies if the MethodType +is set to GridSearch. (Read/Write ParametricExpression) +Parameters +The parameters of the optimisation. (Read only OptimisationParameters) +SearchActive +Indicates if this is an active search. (Read only boolean) +Type +The object type string. (Read only string) +Collection List +Goals +A collection of optimisation goals. (OptimisationGoalCollection of OptimisationOperator.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetActive () +Set the search to the currently active search. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Advanced +Advanced properties for the optimisation search. +Type +OptimisationSearchAdvancedSettings +Access +Read only +ConvergenceAccuracy +Set the convergence rate. Only applies if the MethodType is set to AutoMethod, +ParticleSwarmOptimisation, GeneticAlgorithm, Simplex or AdaptiveResponseSurfaceMethod. +Type +OptimisationConvergenceAccuracyEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MethodType +Set the search algorithm. +Type +OptimisationMethodTypeEnum +Access +Read/Write +NumberOfPoints +Specify the default number of points to be used in the grid search. Only applies if the MethodType +is set to GridSearch. +Type +ParametricExpression +Access +Read/Write +Parameters +The parameters of the optimisation. +Type +OptimisationParameters +Access +Read only +SearchActive +Indicates if this is an active search. +Type +boolean +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Goals +A collection of optimisation goals. +Type +OptimisationGoalCollection +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetActive () +Set the search to the currently active search. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +OptimisationSearchAdvancedSettings +The Advanced optimisation search settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add an 'OptimisationSearch' +search = + project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.AutoMethod) + -- Set the maximum number of solver runs to 20 +search.Advanced.NumberOfRunsEnabled = true +search.Advanced.NumberOfRuns = 20 +Inheritance +The OptimisationSearchAdvancedSettings object is derived from the Object object. +Usage locations +The OptimisationSearchAdvancedSettings object can be accessed from the following locations: +• Properties +◦ OptimisationSearch object has property Advanced. +Property List +Label +The object label. (Read/Write string) +NumberOfRuns +Specify the the maximum number of solver runs. Changing this property will set +NumberOfRunsEnabled to true. (Read/Write ParametricExpression) +NumberOfRunsEnabled +Enables maximum number of solver runs to be specified manually. (Read/Write boolean) +RandomNumberGenerationOption +Set the random number generation method. Only applies if the MethodType is set to +ParticleSwarmOptimisation, GeneticAlgorithm or GlobalResponseSurfaceMethod. (Read/Write +OptimisationRandomNumberGenerationOptionEnum) +SeedValue +Specify the seed value. Only applies if the RandomNumberGenerationOption is set to +SpecifiedSeed. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +NumberOfRuns +Specify the the maximum number of solver runs. Changing this property will set +NumberOfRunsEnabled to true. +Type +ParametricExpression +Access +Read/Write +NumberOfRunsEnabled +Enables maximum number of solver runs to be specified manually. +Type +boolean +Access +Read/Write +RandomNumberGenerationOption +Set the random number generation method. Only applies if the MethodType is set to +ParticleSwarmOptimisation, GeneticAlgorithm or GlobalResponseSurfaceMethod. +Type +OptimisationRandomNumberGenerationOptionEnum +Access +Read/Write +SeedValue +Specify the seed value. Only applies if the RandomNumberGenerationOption is set to +SpecifiedSeed. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.1488 +Altair Feko 2022.3 +2 Application Programming Interface (API) +OptimisationVariable +Variable. +Example +p.1489 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add an optimisation search with the frequency as parameter +freq = project.Definitions.Variables:Add("freq", 10e6) +search = + project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) +searchVar = search.Parameters.Variables:append() +searchVar.Variable = freq +searchVar.MinimumValue = 1e6 +searchVar.MaximumValue = 100e6 + -- Set the start value of the frequency optimisation variable to 10e6 +search.Parameters.Variables[1].MinimumValue = 10e6 +Inheritance +The OptimisationVariable object is derived from the CompositeValue object. +Usage locations +The OptimisationVariable object can be accessed from the following locations: +• Methods +◦ OptimisationVariableList object has method Append(). +◦ OptimisationVariableList object has method Get(number). +Property List +Enabled +Enables the variable for use in the optimisation. (Read/Write boolean) +MaximumValue +The maximum value of the variable. (Read/Write ParametricExpression) +MinimumValue +The minimum value of the variable. (Read/Write ParametricExpression) +NumberOfGridPoints +The number of grid points used. (Read/Write ParametricExpression) +StartValue +The start value of the variable. (Read/Write ParametricExpression) +Variable +Variable that will limited to a range. (Read/Write Variable) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property Details +Enabled +Enables the variable for use in the optimisation. +p.1490 +Type +boolean +Access +Read/Write +MaximumValue +The maximum value of the variable. +Type +ParametricExpression +Access +Read/Write +MinimumValue +The minimum value of the variable. +Type +ParametricExpression +Access +Read/Write +NumberOfGridPoints +The number of grid points used. +Type +ParametricExpression +Access +Read/Write +StartValue +The start value of the variable. +Type +ParametricExpression +Access +Read/Write +Variable +Variable that will limited to a range. +Type +Variable +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +OptimisationVariableList +A list of OptimisationVariable items. +Usage locations +p.1491 +The OptimisationVariableList object can be accessed from the following locations: +• Properties +◦ OptimisationParameters object has property Variables. +Method List +Append () +Appends a new item to the list. (Returns a OptimisationVariable object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a OptimisationVariable object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +OptimisationVariable +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +OptimisationVariable +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1492 +Altair Feko 2022.3 +2 Application Programming Interface (API) +OutputFileSolverSettings +Output file solver settings. +Example +p.1493 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Active logging of the residue for iterative solutions +project.Contents.SolutionSettings.SolverSettings.GeneralSettings.OutputFileSettings. + StoreConvergenceDataEnabled = true +Inheritance +The OutputFileSolverSettings object is derived from the CompositeValue object. +Usage locations +The OutputFileSolverSettings object can be accessed from the following locations: +• Properties +◦ GeneralSolverSettings object has property OutputFileSettings. +• Methods +◦ OutputFileSolverSettingsList object has method Append(). +◦ OutputFileSolverSettingsList object has method Get(number). +Property List +CablePerUnitLength +Save/read cable per-unit-length parameters, specified by OutputFileSettingsEnum, e.g. +NormalExecution, ReadFromFileIfAvailable. (Read/Write OutputFileSettingsEnum) +Currents +Specifies whether the solution vector of the linear equations should be saved to and/or read from +a *.str file, specified by OutputFileSettingsEnum, e.g. NormalExecution, SaveToFile, etc. (Read/ +Write OutputFileSettingsEnum) +LUDecomposedMatrix +Specifies whether the LU decomposed matrix should be saved to and/or read from a *.lud +file, specified by OutputFileSettingsEnum, e.g. NormalExecution, SaveToFile, etc. (Read/Write +OutputFileSettingsEnum) +MatrixElements +Specifies whether the matrix elements should be saved to and/or read from a *.mat file, +specified by OutputFileSettingsEnum, e.g. NormalExecution, SaveToFile, etc. (Read/Write +OutputFileSettingsEnum) +StoreConvergenceDataEnabled +Specifies whether the residue of the iterative solutions should be written to a *.cgm file. (Read/ +Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +ThermalAnalysisExportEnabled +p.1494 +Specifies whether to export (*.epl, *.nas, *.map) files for thermal analysis. (Read/Write boolean) +Property Details +CablePerUnitLength +Save/read cable per-unit-length parameters, specified by OutputFileSettingsEnum, e.g. +NormalExecution, ReadFromFileIfAvailable. +Type +OutputFileSettingsEnum +Access +Read/Write +Currents +Specifies whether the solution vector of the linear equations should be saved to and/or read from +a *.str file, specified by OutputFileSettingsEnum, e.g. NormalExecution, SaveToFile, etc. +Type +OutputFileSettingsEnum +Access +Read/Write +LUDecomposedMatrix +Specifies whether the LU decomposed matrix should be saved to and/or read from a *.lud file, +specified by OutputFileSettingsEnum, e.g. NormalExecution, SaveToFile, etc. +Type +OutputFileSettingsEnum +Access +Read/Write +MatrixElements +Specifies whether the matrix elements should be saved to and/or read from a *.mat file, specified +by OutputFileSettingsEnum, e.g. NormalExecution, SaveToFile, etc. +Type +OutputFileSettingsEnum +Access +Read/Write +StoreConvergenceDataEnabled +Specifies whether the residue of the iterative solutions should be written to a *.cgm file. +Type +boolean +Access +Read/Write +ThermalAnalysisExportEnabled +Specifies whether to export (*.epl, *.nas, *.map) files for thermal analysis. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +OutputFileSolverSettingsList +A list of OutputFileSolverSettings items. +Method List +Append () +p.1496 +Appends a new item to the list. (Returns a OutputFileSolverSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a OutputFileSolverSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +OutputFileSolverSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +OutputFileSolverSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1497 +PCB +The PCB importer. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +project.Importer.PCB:Import(cf.Enums.PCBImportTypeEnum.PEMA, FEKO_HOME..[[/shared/ +Resources/Automation/sample.pema]]) +Inheritance +The PCB object is derived from the Object object. +Usage locations +The PCB object can be accessed from the following locations: +• Properties +◦ +Importer object has property PCB. +Property List +HealAndSimplifyRepresentation +Heal and simplify the substrates, vias and tracks as part of the import. (Read/Write boolean) +ImportScaleFactor +The factor by which the imported geometry will be scaled. This value must be greater than 0. +(Read/Write number) +ImportViasEnabled +Enables the importing of PCB vias. (Read/Write boolean) +IncludeBoardOutline +Value that enables the import of the board outline/drill definition that is applied to all layers. +(Read/Write boolean) +IncludeLayerDielectric +Value that enables the import of dielectric/substrate layers. (Read/Write boolean) +IncludeLayerSignal +Value that enables the import of the signal/power layers that include traces. (Read/Write boolean) +IncludeLayerSilkscreen +Value that enables the import of silkscreen demarcations that can include text, shapes and logos. +(Read/Write boolean) +IncludeLayerSolderPaste +Value that enables the import of solder paste layers. (Read/Write boolean) +IncludeLayerSolderResist +Value that enables the import of insulating/non-conducting solder resist layers. (Read/Write +boolean) +IncludeLayerUserDefined +Value that enables the import of user defined layers. (Read/Write boolean) +Label +The object label. (Read/Write string) +SimplifyEnabled +Simplifies the imported geometry. (Read/Write boolean) +Type +The object type string. (Read only string) +UnionEnabled +Unions the imported geometry. (Read/Write boolean) +UseInfinitelyThinLayersEnabled +Enables the simplification of finite thickness faces to be infinitely thin. (Read/Write boolean) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Import (filetype PCBImportTypeEnum, filename string) +Import the specified file. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +HealAndSimplifyRepresentation +Heal and simplify the substrates, vias and tracks as part of the import. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ImportScaleFactor +p.1500 +The factor by which the imported geometry will be scaled. This value must be greater than 0. +Type +number +Access +Read/Write +ImportViasEnabled +Enables the importing of PCB vias. +Type +boolean +Access +Read/Write +IncludeBoardOutline +Value that enables the import of the board outline/drill definition that is applied to all layers. +Type +boolean +Access +Read/Write +IncludeLayerDielectric +Value that enables the import of dielectric/substrate layers. +Type +boolean +Access +Read/Write +IncludeLayerSignal +Value that enables the import of the signal/power layers that include traces. +Type +boolean +Access +Read/Write +IncludeLayerSilkscreen +Value that enables the import of silkscreen demarcations that can include text, shapes and logos. +Type +boolean +Access +Read/Write +IncludeLayerSolderPaste +Value that enables the import of solder paste layers. +Type +boolean +Access +Read/Write +IncludeLayerSolderResist +Value that enables the import of insulating/non-conducting solder resist layers. +Type +boolean +Access +Read/Write +IncludeLayerUserDefined +Value that enables the import of user defined layers. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +SimplifyEnabled +Simplifies the imported geometry. +Type +boolean +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +UnionEnabled +Unions the imported geometry. +Type +boolean +Access +Read/Write +UseInfinitelyThinLayersEnabled +Enables the simplification of finite thickness faces to be infinitely thin. +Type +boolean +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Import (filetype PCBImportTypeEnum, filename string) +Import the specified file. +Input Parameters +filetype(PCBImportTypeEnum) +The file type to be imported. +filename(string) +The name of the file to be imported. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.1503 +PCBCurrentData +PCB current data using PollEx. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Import 'PCBCurrentData' from file +PCBCurrentData = project.Definitions.FieldDataList: + AddPCBCurrentData([[PCBCurrentData.rei]]) +Inheritance +The PCBCurrentData object is derived from the FieldData object. +Usage locations +The PCBCurrentData object can be accessed from the following locations: +• Methods +◦ FieldDataCollection collection has method AddPCBCurrentData(table). +◦ FieldDataCollection collection has method AddPCBCurrentData(string). +Property List +Filename +Import file containing the PCB current data. (Read/Write FileReference) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Filename +Import file containing the PCB current data. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.1508 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +PCBSource +A solution PCB source. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a 'PCBSource' from PCBCurrentData +PCBCurrentData = + project.Definitions.FieldDataList:AddPCBCurrentData([[PCBCurrentData.rei]]) +PCBSource = + project.Contents.SolutionConfigurations.GlobalSources:AddPCBSource(PCBCurrentData) + -- Delete this 'PCBSource' +PCBSource:Delete() +Inheritance +The PCBSource object is derived from the Source object. +Usage locations +The PCBSource object can be accessed from the following locations: +• Methods +◦ SourceCollection collection has method AddPCBSource(table). +◦ SourceCollection collection has method AddPCBSource(FieldData). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +FieldData +The field data that defines the source. (Read/Write FieldData) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Magnitude +The source magnitude scaling factor. (Read/Write ParametricExpression) +Phase +The source phase offset (degrees). (Read/Write ParametricExpression) +Position +The Position of the source. (Read/Write LocalCoordinate) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +FieldData +The field data that defines the source. +Type +FieldData +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Magnitude +The source magnitude scaling factor. +Type +ParametricExpression +Access +Read/Write +Phase +The source phase offset (degrees). +Type +ParametricExpression +Access +Read/Write +Position +The Position of the source. +Type +LocalCoordinate +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1514 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +PREFEKOLaunchOptions +PREFEKO launch options. +Example +p.1515 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Access the 'PREFEKOLaunchOptions' object and check if errors are ignored +errorsIgnored = application.Launcher.Settings.PREFEKO.ErrorsIgnored +Inheritance +The PREFEKOLaunchOptions object is derived from the CompositeValue object. +Usage locations +The PREFEKOLaunchOptions object can be accessed from the following locations: +• Properties +◦ ComponentLaunchOptions object has property PREFEKO. +• Methods +◦ PREFEKOLaunchOptionsList object has method Append(). +◦ PREFEKOLaunchOptionsList object has method Get(number). +Property List +Advanced +Advanced command line options for launching PREFEKO. (Read/Write string) +ErrorsIgnored +Enables/disables treating errors as non-fatal, print error messages but then continue. (Read/Write +boolean) +ExportVariables +Variables (names, values, comments) export launch options. (Read/Write +PREFEKOVariableExportOptions) +Property Details +Advanced +Advanced command line options for launching PREFEKO. +Type +string +Access +Read/Write +ErrorsIgnored +Enables/disables treating errors as non-fatal, print error messages but then continue. +Type +boolean +Access +Read/Write +ExportVariables +Variables (names, values, comments) export launch options. +Type +PREFEKOVariableExportOptions +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +PREFEKOLaunchOptionsList +A list of PREFEKOLaunchOptions items. +Method List +Append () +p.1517 +Appends a new item to the list. (Returns a PREFEKOLaunchOptions object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a PREFEKOLaunchOptions +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +PREFEKOLaunchOptions +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +PREFEKOLaunchOptions +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1518 +PREFEKOVariableExportOptions +PREFEKO variables (names, values, comments) export launch options. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Access the 'PREFEKOVariableExportOptions' object and check if + -- variables are exported to the OUT file +variablesExported = + application.Launcher.Settings.PREFEKO.ExportVariables.OutFileEnabled +Inheritance +The PREFEKOVariableExportOptions object is derived from the CompositeValue object. +Usage locations +The PREFEKOVariableExportOptions object can be accessed from the following locations: +• Properties +◦ PREFEKOLaunchOptions object has property ExportVariables. +• Methods +◦ PREFEKOVariableExportOptionsList object has method Append(). +◦ PREFEKOVariableExportOptionsList object has method Get(number). +Property List +OutFileEnabled +Enables/disables exporting variables to the Feko *.out file. (Read/Write boolean) +StdOutEnabled +Enables/disables exporting variables to the screen (stdout). (Read/Write boolean) +Property Details +OutFileEnabled +Enables/disables exporting variables to the Feko *.out file. +Type +boolean +Access +Read/Write +StdOutEnabled +Enables/disables exporting variables to the screen (stdout). +Type +boolean +Access +Read/Write +PREFEKOVariableExportOptionsList +A list of PREFEKOVariableExportOptions items. +Method List +Append () +Appends a new item to the list. (Returns a PREFEKOVariableExportOptions object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +PREFEKOVariableExportOptions object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +PREFEKOVariableExportOptions +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +PREFEKOVariableExportOptions +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1522 +ParabolicArc +A parabolic arc. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a parabolic arc with the parabola's base centre at the specified + 'Point' +parabolaCentre = cf.Point(0, 0, 0) +parabolicArc = project.Contents.Geometry:AddParabolicArc(parabolaCentre, 1.0, 1.0) +Inheritance +The ParabolicArc object is derived from the Geometry object. +Usage locations +The ParabolicArc object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddParabolicArc(table). +◦ GeometryCollection collection has method AddParabolicArcAtApertureCentre(Point, Expression, +Expression). +◦ GeometryCollection collection has method AddParabolicArcAtBaseCentre(Point, Expression, +Expression). +◦ GeometryCollection collection has method AddParabolicArc(Point, Expression, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The centre of either the underlying parabola's base or the arc aperture, depending on the value of +ParabolicArcDefinitionMethodEnum. (Read/Write LocalCoordinate) +DefinitionMethod +Parabolic arc definition method as specified by the ParabolicArcDefinitionMethodEnum, e.g. +BaseCentreAndFocalDepth, BaseCentreAndDepth or ApertureCentreAndDepth. (Read/Write +ParabolicArcDefinitionMethodEnum) +Depth +The distance from the apex of the parabola to the centre of the aperture. Only valid if +DefinitionMethod is BaseCentreAndDepth or ApertureCentreAndDepth. (Read/Write Dimension) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +FocalDepth +p.1524 +The focal depth of the parabola. Only valid if DefinitionMethod is BaseCentreAndFocalDepth. +(Read/Write Dimension) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Radius +The radius of the parabolic arc's aperture. (Read/Write Dimension) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +Centre +p.1526 +The centre of either the underlying parabola's base or the arc aperture, depending on the value of +ParabolicArcDefinitionMethodEnum. +Type +LocalCoordinate +Access +Read/Write +DefinitionMethod +Parabolic arc definition method as specified by the ParabolicArcDefinitionMethodEnum, e.g. +BaseCentreAndFocalDepth, BaseCentreAndDepth or ApertureCentreAndDepth. +Type +ParabolicArcDefinitionMethodEnum +Access +Read/Write +Depth +The distance from the apex of the parabola to the centre of the aperture. Only valid if +DefinitionMethod is BaseCentreAndDepth or ApertureCentreAndDepth. +Type +Dimension +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +FocalDepth +The focal depth of the parabola. Only valid if DefinitionMethod is BaseCentreAndFocalDepth. +Type +Dimension +Access +Read/Write +The object label. +Type +string +Label +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Radius +The radius of the parabolic arc's aperture. +Type +Dimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +p.1531 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Paraboloid +A paraboloid. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a paraboloid with its centre at the specified 'Point' +corner = cf.Point(-0.25,-0.25,0) +paraboloid = project.Contents.Geometry:AddParaboloid(corner,1,0.5) +Inheritance +The Paraboloid object is derived from the Geometry object. +Usage locations +The Paraboloid object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddParaboloid(table). +◦ GeometryCollection collection has method AddParaboloid(Point, Expression, Expression). +Property List +Base +The apex of the paraboloid. (Read/Write LocalCoordinate) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +FocalDepth +The paraboloid focal depth. (Read/Write NormalDimension) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Radius +The radius of the paraboloid aperture. (Read/Write Dimension) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1534 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Base +The apex of the paraboloid. +Type +LocalCoordinate +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +FocalDepth +The paraboloid focal depth. +Type +NormalDimension +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Radius +The radius of the paraboloid aperture. +Type +Dimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1539 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ParametricComplexExpression +A complex expression is a Lua string that defines a complex expression. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create an anisotropic 3D medium using a complex tensor definition +properties = cf.AnisotropicDielectric.GetDefaultProperties() +properties.TensorDescription = cf.Enums.TensorDescriptionMethodEnum.ComplexTensor + -- Set the Permittivity matrix using complex expressions +properties.ComplexTensor.Permittivity[1][1] = "14.5 + j*0.0" +properties.ComplexTensor.Permittivity[1][2] = "0.0 + j*0.0" +properties.ComplexTensor.Permittivity[1][3] = "0.0 + j*0.0" +properties.ComplexTensor.Permittivity[2][1] = "0.0 + j*0.0" +properties.ComplexTensor.Permittivity[2][2] = "14.5 + j*0.0" +properties.ComplexTensor.Permittivity[2][3] = "0.0 + j*0.0" +properties.ComplexTensor.Permittivity[3][1] = "0.0 + j*0.0" +properties.ComplexTensor.Permittivity[3][2] = "0.0 + j*0.0" +properties.ComplexTensor.Permittivity[3][3] = "14.5 + j*0.0" + -- Set the Permeability matrix using complex expressions +properties.ComplexTensor.Permeability[1][1] = "0.998 + j*0.0" +properties.ComplexTensor.Permeability[1][2] = "0.0 - j*0.008" +properties.ComplexTensor.Permeability[1][3] = "0.0 + j*0.0" +properties.ComplexTensor.Permeability[2][1] = "0.0 + j*0.008" +properties.ComplexTensor.Permeability[2][2] = "0.998 + j*0.0" +properties.ComplexTensor.Permeability[2][3] = "0.0 + j*0.0" +properties.ComplexTensor.Permeability[3][1] = "0.0 + j*0.0" +properties.ComplexTensor.Permeability[3][2] = "0.0 + j*0.0" +properties.ComplexTensor.Permeability[3][3] = "1.0 + j*0.0" +anisotropicDielectric = + project.Definitions.Media.AnisotropicDielectric:AddAnisotropicDielectric(properties) + -- Change the colour to Cyan +anisotropicDielectric.Colour = "#00FFFF" +Inheritance +The ParametricComplexExpression object is derived from the CompositeValue object. +Usage locations +The ParametricComplexExpression object can be accessed from the following locations: +• Methods +◦ ParametricComplexExpressionList object has method Append(). +◦ ParametricComplexExpressionList object has method Get(number). +◦ ParametricComplexExpressionTable object has method Get(number, number). +ParametricComplexExpressionList +A list of ParametricComplexExpression items. +Method List +Append () +Appends a new item to the list. (Returns a ParametricComplexExpression object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +ParametricComplexExpression object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +ParametricComplexExpression +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +ParametricComplexExpression +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1542 +ParametricComplexExpressionTable +A table (2 dimensional list) of ParametricComplexExpression items. +Usage locations +The ParametricComplexExpressionTable object can be accessed from the following locations: +• Properties +◦ GeneralNetwork object has property CouplingParameters. +◦ ComplexTensor object has property Permeability. +◦ ComplexTensor object has property Permittivity. +Method List +AddColumn () +Appends a new column to the table. +AddRow () +Appends a new row to the table. +ColumnCount () +Returns the number columns in the table. (Returns a number object.) +Get (rowIndex number, columnIndex number) +Returns the item at the given row and column indices. Indexing starts at 1. (Returns a +ParametricComplexExpression object.) +Set (rowIndex number, columnIndex number, value ParametricComplexExpression) +Set item at the given row and column indices. Indexing starts at 1. +SetDimensions (rowCount number, columnCount number) +Sets the number of rows and columns in the table. +rowCount () +Returns the number of rows in the table. (Returns a number object.) +Method Details +AddColumn () +Appends a new column to the table. +AddRow () +Appends a new row to the table. +ColumnCount () +Returns the number columns in the table. +Return +number +The number of columns in the table. +Get (rowIndex number, columnIndex number) +Returns the item at the given row and column indices. Indexing starts at 1. +Input Parameters +rowIndex(number) +The row index of the item to return. +columnIndex(number) +The column index of the item to return. +Return +ParametricComplexExpression +The ParametricComplexExpression at the given indices. +Set (rowIndex number, columnIndex number, value ParametricComplexExpression) +Set item at the given row and column indices. Indexing starts at 1. +Input Parameters +rowIndex(number) +The row index of the item to return. +columnIndex(number) +The column index of the item to return. +value(ParametricComplexExpression) +The ParametricComplexExpression item to be assigned to the table at the given +indices. +SetDimensions (rowCount number, columnCount number) +Sets the number of rows and columns in the table. +Input Parameters +rowCount(number) +The number of rows. +columnCount(number) +The number of columns. +rowCount () +Returns the number of rows in the table. +Return +number +The number of rows in the table. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ParametricExpression +p.1545 +An expression is a Lua string containing variables and numbers. Eg: “(1+5)*10”. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +paraboloid = +project.Contents.Geometry:AddParaboloid(cf.Paraboloid.GetDefaultProperties()) + -- Add a work surface onto the paraboloid face +workSurface = project.Definitions.WorkSurfaces:Add(paraboloid.Faces["Face1"], 0) + -- Move the worksurface using a parametric expression +workSurface.Offset = 1/5 * 40 +Inheritance +The ParametricExpression object is derived from the CompositeValue object. +The following objects are derived (specialisations) from the ParametricExpression object: +• Dimension +Usage locations +The ParametricExpression object can be accessed from the following locations: +• Properties +◦ Variable object has property Expression. +◦ Variable object has property Maximum. +◦ Variable object has property Minimum. +◦ Mirror object has property RotationU. +◦ Mirror object has property RotationV. +◦ Mirror object has property RotationN. +◦ Scale object has property Factor. +◦ ModelAttributes object has property UnitFactor. +◦ CylindricalAntennaArray object has property OffsetN. +◦ CylindricalAntennaArray object has property PhiAngle. +◦ CylindricalAntennaArray object has property Radius. +◦ LinearPlanarArray object has property OffsetU. +◦ LinearPlanarArray object has property OffsetV. +◦ CustomAntennaArray object has property MagnitudeScaling. +◦ CustomAntennaArray object has property PhaseOffset. +◦ AnisotropicDielectric object has property MassDensity. +◦ Dielectric object has property MassDensity. +◦ FreeSpace object has property MassDensity. +◦ GroundPlaneMedium object has property MassDensity. +◦ Zero object has property MassDensity. +◦ +◦ +ImpedanceSheet object has property ImpedanceReal. +ImpedanceSheet object has property ImpedanceImaginary. +◦ Metal object has property RelativePermeability. +◦ Metal object has property LossTangent. +◦ Metal object has property Conductivity. +◦ Metal object has property SurfaceRoughness. +◦ Windscreen object has property Offset. +◦ Capacitor object has property Capacitance. +◦ Resistor object has property Resistance. +◦ CableBundleCrossSection object has property SheathThickness. +◦ CableBundleCrossSection object has property CoatingThickness. +◦ CableBundleCrossSection object has property TwistPitchLength. +◦ CableCoaxialCrossSection object has property CoreRadius. +◦ CableCoaxialCrossSection object has property Magnitude. +◦ CableCoaxialCrossSection object has property Attenuation. +◦ CableCoaxialCrossSection object has property PropagationVelocity. +◦ CableCoaxialCrossSection object has property OuterRadius. +◦ CableCoaxialCrossSection object has property CoatingThickness. +◦ CableNonConductingElementCrossSection object has property FibreRadius. +◦ CableRibbonCrossSection object has property CoreRadius. +◦ CableRibbonCrossSection object has property CoreCount. +◦ CableRibbonCrossSection object has property CoreSpacing. +◦ CableRibbonCrossSection object has property InsulationThickness. +◦ CableSingleConductorCrossSection object has property CoreRadius. +◦ CableSingleConductorCrossSection object has property InsulationThickness. +◦ CableTwistedPairCrossSection object has property CoreRadius. +◦ CableTwistedPairCrossSection object has property InsulationThickness. +◦ CableTwistedPairCrossSection object has property TwistRadius. +◦ CableTwistedPairCrossSection object has property TwistPitchLength. +◦ CablePath object has property MaxSeparationDistance. +◦ CablePath object has property TwistAngle. +◦ CableProbe object has property PositionDistance. +◦ CableProbe object has property PositionPercentage. +◦ CableShield object has property GapBetweenLayers. +◦ ComplexLoad object has property ImpedanceImaginary. +◦ ComplexLoad object has property ImpedanceReal. +◦ +Inductor object has property Inductance. +◦ Transformer object has property CoupledInductor1. +◦ Transformer object has property CoupledInductor2. +◦ Transformer object has property CouplingCoefficient. +◦ VoltageControlledVoltageSource object has property VoltageGain. +◦ MeshCurvilinearTriangleFace object has property LocalMeshSize. +◦ MeshCurvilinearTriangleFace object has property Thickness. +◦ MeshCurvilinearTriangleFace object has property CoatingThickness. +◦ MeshTriangleFace object has property LocalMeshSize. +◦ MeshTriangleFace object has property Thickness. +◦ MeshTriangleFace object has property CoatingThickness. +◦ MeshCurvilinearSegmentWire object has property LocalWireRadius. +◦ MeshCurvilinearSegmentWire object has property LocalMeshSize. +◦ MeshSegmentWire object has property LocalWireRadius. +◦ MeshSegmentWire object has property LocalMeshSize. +◦ MeshPlate object has property LocalMeshSize. +◦ MeshPlate object has property Thickness. +◦ MeshPlate object has property CoatingThickness. +◦ MeshTetrahedronRegion object has property LocalMeshSize. +◦ PointRefinement object has property MeshSize. +◦ PolylineRefinement object has property Radius. +◦ PolylineRefinement object has property MeshSize. +◦ AnalyticalCurve object has property ParametricStart. +◦ AnalyticalCurve object has property ParametricEnd. +◦ ConstrainedSurface object has property SymmetryPlaneUValue. +◦ ConstrainedSurface object has property SymmetryPlaneVValue. +◦ EllipticArc object has property Eccentricity. +◦ Helix object has property Turns. +◦ Helix object has property PitchAngle. +◦ HyperbolicArc object has property Eccentricity. +◦ PathSweep object has property TwistAngle. +◦ PathSweep object has property ScaleFactor. +◦ Split object has property RotationU. +◦ Split object has property RotationV. +◦ Split object has property RotationN. +◦ Stitch object has property Tolerance. +◦ SurfaceRegularLines object has property Spacing. +◦ Edge object has property LocalWireRadius. +◦ Edge object has property LocalMeshSize. +◦ Face object has property LocalMeshSize. +◦ Face object has property Thickness. +◦ Face object has property CoatingThickness. +◦ Region object has property LocalMeshSize. +◦ RemoveSmallFeaturesSettings object has property GashAspectBound. +◦ RemoveSmallFeaturesSettings object has property SmallFeatureSize. +◦ RepairAndSewFacesSettings object has property AngularTolerance. +◦ RepairAndSewFacesSettings object has property SewTolerance. +◦ RepairEdgesSettings object has property LinearTolerance. +◦ RepairPartsSettings object has property DeviationUpperBound. +◦ RepairPartsSettings object has property MaxSmallEdgeLength. +◦ RepairPartsSettings object has property SmootheningAngularTolerance. +◦ RepairPartsSettings object has property SpecifiedEdgeRepairTolerance. +◦ SimplifyPartRepresentationSettings object has property EdgeTolerance. +◦ SimplifyPartRepresentationSettings object has property OperatingPrecisionTolerance. +◦ SimplifyPartRepresentationSettings object has property SurfaceNormalTolerance. +◦ WorkSurface object has property Offset. +◦ SolutionCoefficientData object has property DataBlockNumber. +◦ SphericalModeDataFromFile object has property DataBlockNumber. +◦ NearFieldDataFullImport object has property DataBlockNumber. +◦ NearFieldDataFileStructure object has property ReadFromLine. +◦ NearFieldDataFileStructure object has property DataBlockNumber. +◦ FarFieldData object has property StartFromPoint. +◦ FarFieldData object has property NumberThetaPoints. +◦ FarFieldData object has property NumberPhiPoints. +◦ FarFieldData object has property DataBlockNumber. +◦ CrossShape object has property ArmLengthU. +◦ CrossShape object has property ArmLengthV. +◦ CrossShape object has property StripWidth. +◦ StripCrossShape object has property SlotWidth. +◦ StripCrossShape object has property ArmLengthU. +◦ StripCrossShape object has property ArmLengthV. +◦ StripCrossShape object has property StripWidth. +◦ EllipseShape object has property RadiusU. +◦ EllipseShape object has property RadiusV. +◦ HexagonShape object has property Width. +◦ StripHexagonShape object has property StripWidth. +◦ StripHexagonShape object has property Width. +◦ PlaneShape object has property Depth. +◦ PlaneShape object has property Width. +◦ RingShape object has property InnerRadius. +◦ RingShape object has property OuterRadius. +◦ OpenRingShape object has property GapAngle. +◦ OpenRingShape object has property StartAngle. +◦ OpenRingShape object has property InnerRadius. +◦ OpenRingShape object has property OuterRadius. +◦ SplitRingShape object has property GapAngle. +◦ SplitRingShape object has property StartAngle. +◦ SplitRingShape object has property InnerRadius. +◦ SplitRingShape object has property OuterRadius. +◦ SpiralCrossShape object has property ArmLength. +◦ SpiralCrossShape object has property EdgeLength. +◦ SpiralCrossShape object has property SpiralLength. +◦ SpiralCrossShape object has property StripWidth. +◦ TCrossShape object has property ArmLength. +◦ TCrossShape object has property EdgeLength. +◦ TCrossShape object has property StripWidth. +◦ TrifilarShape object has property Length. +◦ TrifilarShape object has property StripWidth. +◦ MeshSettings object has property TetrahedronEdgeLength. +◦ MeshSettings object has property TriangleEdgeLength. +◦ MeshSettings object has property WireRadius. +◦ MeshSettings object has property WireSegmentLength. +◦ LocalMeshSettings object has property TetrahedronEdgeLength. +◦ LocalMeshSettings object has property TriangleEdgeLength. +◦ LocalMeshSettings object has property WireRadius. +◦ LocalMeshSettings object has property WireSegmentLength. +◦ GlobalMeshSettings object has property TetrahedronEdgeLength. +◦ GlobalMeshSettings object has property TriangleEdgeLength. +◦ GlobalMeshSettings object has property WireRadius. +◦ GlobalMeshSettings object has property WireSegmentLength. +◦ VoxelSettings object has property VoxelSize. +◦ VoxelSettings object has property WireRadius. +◦ WaveguideMeshPort object has property MaxModalExpansionIndexM. +◦ WaveguideMeshPort object has property MaxModalExpansionIndexN. +◦ WaveguidePort object has property MaxModalExpansionIndexM. +◦ WaveguidePort object has property MaxModalExpansionIndexN. +◦ WirePort object has property PositionPercentage. +◦ CharacteristicModes object has property NumberOfModes. +◦ CurrentSource object has property Magnitude. +◦ CurrentSource object has property Phase. +◦ CurrentSource object has property Impedance. +◦ FEMModalSource object has property Magnitude. +◦ FEMModalSource object has property Phase. +◦ VoltageSource object has property Magnitude. +◦ VoltageSource object has property Phase. +◦ VoltageSource object has property Impedance. +◦ WaveguideSource object has property Magnitude. +◦ WaveguideSource object has property Phase. +◦ AbstractPointSource object has property Magnitude. +◦ AbstractPointSource object has property Phase. +◦ AbstractPointSource object has property Phi. +◦ AbstractPointSource object has property Theta. +◦ ElectricDipole object has property Magnitude. +◦ ElectricDipole object has property Phase. +◦ ElectricDipole object has property Phi. +◦ ElectricDipole object has property Theta. +◦ MagneticDipole object has property Magnitude. +◦ MagneticDipole object has property Phase. +◦ MagneticDipole object has property Phi. +◦ MagneticDipole object has property Theta. +◦ +◦ +◦ +◦ +◦ +ImpressedCurrent object has property StartMagnitude. +ImpressedCurrent object has property StartPhase. +ImpressedCurrent object has property EndMagnitude. +ImpressedCurrent object has property EndPhase. +ImpressedCurrent object has property Radius. +◦ FarFieldSource object has property Magnitude. +◦ FarFieldSource object has property Phase. +◦ FarFieldSource object has property Theta. +◦ FarFieldSource object has property Phi. +◦ NearFieldSource object has property Magnitude. +◦ NearFieldSource object has property Phase. +◦ PCBSource object has property Magnitude. +◦ PCBSource object has property Phase. +◦ SolutionCoefficientSource object has property Magnitude. +◦ SolutionCoefficientSource object has property Phase. +◦ SphericalModeSource object has property Magnitude. +◦ SphericalModeSource object has property Phase. +◦ SphericalModeSource object has property Theta. +◦ SphericalModeSource object has property Phi. +◦ PlaneWave object has property Magnitude. +◦ PlaneWave object has property Phase. +◦ PlaneWave object has property PolarisationAngle. +◦ PlaneWave object has property Ellipticity. +◦ FarFieldReceivingAntenna object has property Theta. +◦ FarFieldReceivingAntenna object has property Phi. +◦ SphericalModeReceivingAntenna object has property Theta. +◦ SphericalModeReceivingAntenna object has property Phi. +◦ Frequency object has property Start. +◦ Frequency object has property End. +◦ Frequency object has property NumberOfDiscreteValues. +◦ TransmissionLine object has property LineLength. +◦ TransmissionLine object has property Attenuation. +◦ TransmissionLine object has property Z0Real. +◦ TransmissionLine object has property Z0Imaginary. +◦ TransmissionLine object has property PropagationVelocity. +◦ GroundPlane object has property ZValue. +◦ Load object has property ImpedanceReal. +◦ Load object has property ImpedanceImaginary. +◦ Load object has property Resistance. +◦ Load object has property Capacitance. +◦ Load object has property Inductance. +◦ Power object has property SourcePower. +◦ Power object has property Z0Real. +◦ Power object has property Z0Imaginary. +◦ SAR object has property SubstrateLayer. +◦ UnitCell object has property DistanceU. +◦ UnitCell object has property DistanceV. +◦ UnitCell object has property SkewAngle. +◦ UnitCell object has property ZValue. +◦ OptimisationGoal object has property Weight. +◦ SParameterOptimisationGoal object has property Weight. +◦ FarFieldOptimisationGoal object has property Weight. +◦ +◦ +ImpedanceOptimisationGoal object has property ReferenceImpedance. +ImpedanceOptimisationGoal object has property Weight. +◦ NearFieldOptimisationGoal object has property Weight. +◦ PowerOptimisationGoal object has property Weight. +◦ ReceivingAntennaOptimisationGoal object has property Weight. +◦ SAROptimisationGoal object has property Weight. +◦ TransmissionReflectionOptimisationGoal object has property Weight. +◦ OptimisationCombination object has property Weight. +◦ OptimisationGoalObjective object has property TargetValue. +◦ OptimisationSearch object has property NumberOfPoints. +◦ OptimisationSearchAdvancedSettings object has property NumberOfRuns. +◦ OptimisationSearchAdvancedSettings object has property SeedValue. +◦ MeshImporter object has property ScaleFactor. +◦ MeshImporter object has property SegmentLength. +◦ MeshImporter object has property VertexTolerance. +◦ MeshImporter object has property WireRadius. +◦ ManuallySpecifiedOrDerivedValue object has property ManuallySpecifiedExpression. +◦ AntennaArraySource object has property MagnitudeScaling. +◦ AntennaArraySource object has property PhaseOffset. +◦ AnisotropicDielectricLayers object has property PrincipleDirection. +◦ AnisotropicDielectricLayers object has property Thickness. +◦ DielectricFrequencyPoint object has property Conductivity. +◦ DielectricFrequencyPoint object has property Frequency. +◦ DielectricFrequencyPoint object has property LossTangent. +◦ DielectricFrequencyPoint object has property RelativePermittivity. +◦ DielectricModelling object has property AngularFrequencyLowerLimit. +◦ DielectricModelling object has property AngularFrequencyUpperLimit. +◦ DielectricModelling object has property AttenuationFactor. +◦ DielectricModelling object has property Conductivity. +◦ DielectricModelling object has property LossTangent. +◦ DielectricModelling object has property PhaseFactor. +◦ DielectricModelling object has property RealPermittivityVariation. +◦ DielectricModelling object has property RelativeHighFrequencyPermittivity. +◦ DielectricModelling object has property RelativePermittivity. +◦ DielectricModelling object has property RelativeStaticPermittivity. +◦ DielectricModelling object has property RelaxationFrequency. +◦ +IsotropicDielectricLayers object has property Thickness. +◦ CoaxialInsulationLayer object has property Thickness. +◦ MagneticFrequencyPoint object has property Frequency. +◦ MagneticFrequencyPoint object has property LossTangent. +◦ MagneticFrequencyPoint object has property RelativePermeability. +◦ MagneticModelling object has property LossTangent. +◦ MagneticModelling object has property RelativePermeability. +◦ MetallicFrequencyPoint object has property Conductivity. +◦ MetallicFrequencyPoint object has property Frequency. +◦ MetallicFrequencyPoint object has property LossTangent. +◦ MetallicFrequencyPoint object has property RelativePermeability. +◦ PolderTensor object has property DCBiasField. +◦ PolderTensor object has property LineWidth. +◦ PolderTensor object has property LossTangent. +◦ PolderTensor object has property RelativePermittivity. +◦ PolderTensor object has property SaturationMagnetisation. +◦ SurfaceImpedanceFrequencyPoint object has property Frequency. +◦ SurfaceImpedanceFrequencyPoint object has property ImpedanceImaginary. +◦ SurfaceImpedanceFrequencyPoint object has property ImpedanceReal. +◦ CableBundleCableSpecification object has property OffsetX. +◦ CableBundleCableSpecification object has property OffsetY. +◦ CableBundleCableSpecification object has property Rotation. +◦ ShieldLayerSettings object has property FilamentDiameter. +◦ ShieldLayerSettings object has property MinimumOpticalCoverage. +◦ ShieldLayerSettings object has property NumberOfCarriers. +◦ ShieldLayerSettings object has property NumberOfFilaments. +◦ ShieldLayerSettings object has property ShieldThickness. +◦ ShieldLayerSettings object has property TransferCapacitance. +◦ ShieldLayerSettings object has property WeaveAngle. +◦ ShieldLayerSettings object has property WeaveAngleDeviation. +◦ CartesianDescription object has property N. +◦ CartesianDescription object has property U. +◦ CartesianDescription object has property V. +◦ CylindricalDescription object has property N. +◦ CylindricalDescription object has property Phi. +◦ CylindricalDescription object has property Rho. +◦ NurbsControlPoint object has property Weight. +◦ SphericalDescription object has property Phi. +◦ SphericalDescription object has property R. +◦ SphericalDescription object has property Theta. +◦ SphericalModeOptions object has property SphericalMJ. +◦ SphericalModeOptions object has property SphericalMagnitude. +◦ SphericalModeOptions object has property SphericalN. +◦ SphericalModeOptions object has property SphericalPhase. +◦ SphericalStructure object has property PhiPoints. +◦ SphericalStructure object has property ThetaPoints. +◦ CylindricalStructure object has property NPoints. +◦ CylindricalStructure object has property PhiPoints. +◦ CartesianStructure object has property UPoints. +◦ CartesianStructure object has property VPoints. +◦ MeshAdvancedSettings object has property SmallGeometryThreshold. +◦ FDTDBoundarySettings object has property BufferPosition. +◦ FDTDBoundarySettings object has property BufferSize. +◦ VoxelAdvancedSettings object has property AspectRatioThreshold. +◦ VoxelAdvancedSettings object has property GrowthRateThreshold. +◦ VoxelAdvancedSettings object has property SmallVoxelThreshold. +◦ FrequencyContinuousSettings object has property MaxSamples. +◦ FrequencyContinuousSettings object has property MinIncrement. +◦ FrequencyExportSettings object has property NumberOfSamples. +◦ FrequencyFDTDSettings object has property ConvergenceThreshold. +◦ FrequencyFDTDSettings object has property MaximumTimeInterval. +◦ FrequencyFDTDSettings object has property MinimumTimeInterval. +◦ FundamentalModeOptions object has property Magnitude. +◦ FundamentalModeOptions object has property Phase. +◦ FundamentalModeOptions object has property Rotation. +◦ HighFrequencySettings object has property MaxIterations. +◦ HighFrequencySettings object has property MaxRLGORayInteractions. +◦ HighFrequencySettings object has property MaxUTDRayInteractions. +◦ HighFrequencySettings object has property PhiIncrement. +◦ HighFrequencySettings object has property StoppingCriterion. +◦ HighFrequencySettings object has property ThetaIncrement. +◦ HighFrequencySettings object has property UIncrement. +◦ HighFrequencySettings object has property VIncrement. +◦ +◦ +◦ +◦ +◦ +◦ +◦ +◦ +IntegralEquation object has property CFIEFactor. +IterativeSolverSettings object has property BlockSize. +IterativeSolverSettings object has property FillInPerRow. +IterativeSolverSettings object has property LevelOfFill. +IterativeSolverSettings object has property MaxIterations. +IterativeSolverSettings object has property MaxResiduum. +IterativeSolverSettings object has property StabilisationFactor. +IterativeSolverSettings object has property StoppingCriterion. +◦ MLFMMSolverSettings object has property ManuallySpecifiedBoxSize. +◦ PeriodicBoundaryBeamSquintAngle object has property Phi. +◦ PeriodicBoundaryBeamSquintAngle object has property Theta. +◦ PeriodicBoundaryPhaseShift object has property FirstVector. +◦ PeriodicBoundaryPhaseShift object has property SecondVector. +◦ PlanarSubstrate object has property Thickness. +◦ PointRange object has property Increment. +◦ PointRange object has property NumberOfPoints. +◦ PortProperties object has property Impedance. +◦ PortProperties object has property IndexM. +◦ PortProperties object has property IndexN. +◦ PortProperties object has property Rotation. +◦ UnitCellLayer object has property Rotation. +◦ UnitCellLayer object has property Thickness. +◦ WaveguideModeOptions object has property IndexM. +◦ WaveguideModeOptions object has property IndexN. +◦ WaveguideModeOptions object has property Magnitude. +◦ WaveguideModeOptions object has property Phase. +◦ WaveguideModeOptions object has property Rotation. +◦ WindscreenSolutionMethod object has property OffsetA. +◦ OptimisationGoalProcessingSteps object has property Value. +◦ OptimisationMaskValues object has property X. +◦ OptimisationMaskValues object has property Y. +◦ OptimisationVariable object has property MaximumValue. +◦ OptimisationVariable object has property MinimumValue. +◦ OptimisationVariable object has property NumberOfGridPoints. +◦ OptimisationVariable object has property StartValue. +• Methods +◦ ParametricExpressionList object has method Append(). +◦ ParametricExpressionList object has method Get(number). +ParametricExpressionList +A list of ParametricExpression items. +Usage locations +The ParametricExpressionList object can be accessed from the following locations: +• Properties +◦ Frequency object has property DiscreteFrequencies. +Method List +Append () +Appends a new item to the list. (Returns a ParametricExpression object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a ParametricExpression +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +ParametricExpression +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +ParametricExpression +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +PathSweep +A path sweep operator. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a line to sweep and another to define the sweep path +line = + project.Contents.Geometry:AddLine(cf.Point(1.2, 1.8, 0), cf.Point(0.1, 1.2, -0.2)) +path = + project.Contents.Geometry:AddLine(cf.Point(1.3, 2.1, 0), cf.Point(-0.1, 2.35, 1)) + -- Sweep the line along the path +project.Contents.Geometry:PathSweep(line, path) +Inheritance +The PathSweep object is derived from the Geometry object. +Usage locations +The PathSweep object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method PathSweep(Geometry, Geometry). +◦ GeometryCollection collection has method PathSweep(Geometry, Geometry, Expression, +Expression, boolean). +◦ GeometryCollection collection has method PathSweepParallel(Geometry, Geometry, +Expression, Expression, boolean). +◦ GeometryCollection collection has method PathSweep(Geometry, Geometry, boolean). +Property List +Alignment +The alignment of the path sweep specified by the PathSweepAlignmentEnum, e.g. Normal or +Parallel. (Read/Write PathSweepAlignmentEnum) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ChildReferences +The geometry items to be transformed. (Read/Write ObjectReferenceList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +FlipPathEnds +Start the sweep from the other end of the path. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +p.1559 +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +ScaleFactor +The scale factor of the path sweep. (Read/Write ParametricExpression) +TwistAngle +The twist angle of the path sweep (degrees). (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Collection List +Children +The collection of child operators of the operator. (OperatorCollection of Geometry.) +The collection of edges of the operator. (EdgeCollection of Edge.) +Edges +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Alignment +The alignment of the path sweep specified by the PathSweepAlignmentEnum, e.g. Normal or +Parallel. +Type +PathSweepAlignmentEnum +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ChildReferences +The geometry items to be transformed. +Type +ObjectReferenceList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +FlipPathEnds +Start the sweep from the other end of the path. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +ScaleFactor +The scale factor of the path sweep. +Type +ParametricExpression +Access +Read/Write +TwistAngle +The twist angle of the path sweep (degrees). +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Children +The collection of child operators of the operator. +Type +OperatorCollection +Edges +Faces +The collection of edges of the operator. +Type +EdgeCollection +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +p.1566 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +PerfectElectricConductor +The default perfect electric conductor medium. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Retrieve the PEC medium +PECMedium = project.Definitions.Media.PerfectElectricConductor +Inheritance +The PerfectElectricConductor object is derived from the Medium object. +Usage locations +The PerfectElectricConductor object can be accessed from the following locations: +• Properties +◦ Media object has property PerfectElectricConductor. +Property List +Colour +The medium colour. (Read/Write string) +The object label. (Read/Write string) +Label +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +p.1568 +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1569 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +PerfectMagneticConductor +The default perfect magnetic conductor medium. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Retrieve the PMC medium +PMCMedium = project.Definitions.Media.PerfectMagneticConductor +Inheritance +The PerfectMagneticConductor object is derived from the Medium object. +Usage locations +The PerfectMagneticConductor object can be accessed from the following locations: +• Properties +◦ Media object has property PerfectMagneticConductor. +Property List +Colour +The medium colour. (Read/Write string) +The object label. (Read/Write string) +Label +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +p.1571 +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1572 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +PeriodicBoundary +p.1573 +The periodic boundary condition (PBC) for the model. PBCs are used to simulate structures that repeat +to infinity. PBC is often used to simulate frequency selective surfaces (FSS) and infinite antenna arrays. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME.. + [[/shared/Resources/Automation/square_loop_antenna_MATCHED.cfx]]}) + -- Set up one dimensional periodic boundary condition for the model +properties = project.Contents.SolutionSettings.PeriodicBoundary:GetProperties() +properties.Dimension = cf.Enums.PeriodicBoundaryDimensionsEnum.OneDimension +properties.EndPointVectorOne.N = "0.0" +properties.EndPointVectorOne.U = "0.05" +properties.EndPointVectorOne.V = "-0.05" +properties.StartPoint.N = "0.0" +properties.StartPoint.U = "-0.05" +properties.StartPoint.V = "-0.05" +project.Contents.SolutionSettings.PeriodicBoundary:SetProperties(properties) + -- Increase the periodic boundary to two dimensions +properties = project.Contents.SolutionSettings.PeriodicBoundary:GetProperties() +properties.Dimension = cf.Enums.PeriodicBoundaryDimensionsEnum.TwoDimensions +properties.EndPointVectorTwo.N = "0" +properties.EndPointVectorTwo.U = "-0.05" +properties.EndPointVectorTwo.V = "0.05" +project.Contents.SolutionSettings.PeriodicBoundary:SetProperties(properties) +Inheritance +The PeriodicBoundary object is derived from the Object object. +Usage locations +The PeriodicBoundary object can be accessed from the following locations: +• Properties +◦ SolutionSettings object has property PeriodicBoundary. +Property List +BeamSquintAngle +The beam pointing (squint) angle used to determine the phase shift. Only applicable if +PhaseShiftMethod is FromSquintAngle. (Read/Write PeriodicBoundaryBeamSquintAngle) +Dimension +The PBC dimension type defining the number of periodic boundaries. The unit cell is repeated +along the defined dimension type. (Read/Write PeriodicBoundaryDimensionsEnum) +EndPointVectorOne +The end point defining the first vector. Only applicable if the Dimension is OneDimension or +TwoDimensions. (Read/Write LocalCoordinate) +Altair Feko 2022.3 +2 Application Programming Interface (API) +EndPointVectorTwo +p.1574 +The end point defining the second vector. Only applicable if the Dimension is TwoDimensions. +(Read/Write LocalCoordinate) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +PhaseShift +The phase shift in each vector direction. Only applicable if PhaseShiftMethod is SpecifyManually. +(Read/Write PeriodicBoundaryPhaseShift) +PhaseShiftMethod +Defines the method for determining the phase shift of the source between one unit cell and the +next when doing periodic boundary condition calculations. When a plane wave is used as source +the phase difference between the cells cannot be specified, but is determined by the source. +(Read/Write PeriodicBoundaryPhaseShiftMethodEnum) +StartPoint +The start point used for defining the vectors that define the periodicity. Only applicable if the +Dimension is OneDimension or TwoDimensions. (Read/Write LocalCoordinate) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1575 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetOneDimension (startpoint Point, endpoint Point) +Define a 1D periodic boundary condition. The start- and end-point of a single vector is required. +Periodicity is then defined based on two planes passing through these start and end points, and +normal to the vector formed between them. The vector used to define 1D periodicity can have any +orientation, but must have a non-zero length. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetTwoDimensions (startpoint Point, endpointone Point, endpointtwo Point) +Define a 2D periodic boundary condition. The start- and end-points of a two vectors are required. +These vectors form the two boundaries of the unit cell which is infinite in the direction normal to +the plane on which both vectors lie. The vectors that define the unit-cell for 2D periodicity must +have non-zero length, and cannot be oriented in the same direction. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BeamSquintAngle +The beam pointing (squint) angle used to determine the phase shift. Only applicable if +PhaseShiftMethod is FromSquintAngle. +Type +PeriodicBoundaryBeamSquintAngle +Access +Read/Write +Dimension +The PBC dimension type defining the number of periodic boundaries. The unit cell is repeated +along the defined dimension type. +Type +PeriodicBoundaryDimensionsEnum +Access +Read/Write +EndPointVectorOne +The end point defining the first vector. Only applicable if the Dimension is OneDimension or +TwoDimensions. +Type +LocalCoordinate +Access +Read/Write +EndPointVectorTwo +The end point defining the second vector. Only applicable if the Dimension is TwoDimensions. +Type +LocalCoordinate +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +PhaseShift +The phase shift in each vector direction. Only applicable if PhaseShiftMethod is SpecifyManually. +Type +PeriodicBoundaryPhaseShift +Access +Read/Write +PhaseShiftMethod +Defines the method for determining the phase shift of the source between one unit cell and the +next when doing periodic boundary condition calculations. When a plane wave is used as source +the phase difference between the cells cannot be specified, but is determined by the source. +Type +PeriodicBoundaryPhaseShiftMethodEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +StartPoint +p.1577 +The start point used for defining the vectors that define the periodicity. Only applicable if the +Dimension is OneDimension or TwoDimensions. +Type +LocalCoordinate +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +p.1578 +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetOneDimension (startpoint Point, endpoint Point) +Define a 1D periodic boundary condition. The start- and end-point of a single vector is required. +Periodicity is then defined based on two planes passing through these start and end points, and +normal to the vector formed between them. The vector used to define 1D periodicity can have any +orientation, but must have a non-zero length. +Input Parameters +startpoint(Point) +Start point of vector. +endpoint(Point) +End point of vector. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetTwoDimensions (startpoint Point, endpointone Point, endpointtwo Point) +Define a 2D periodic boundary condition. The start- and end-points of a two vectors are required. +These vectors form the two boundaries of the unit cell which is infinite in the direction normal to +the plane on which both vectors lie. The vectors that define the unit-cell for 2D periodicity must +have non-zero length, and cannot be oriented in the same direction. +Input Parameters +startpoint(Point) +Start point of both vectors. +endpointone(Point) +End point of first vector. +endpointtwo(Point) +End point of second vector. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +PeriodicBoundaryBeamSquintAngle +Beam pointing (squint) angle used for modelling arrays by using periodic boundary conditions. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME.. + [[/shared/Resources/Automation/square_loop_antenna_MATCHED.cfx]]}) + -- Set up one dimensional periodic boundary condition for the model +properties = project.Contents.SolutionSettings.PeriodicBoundary:GetProperties() +properties.Dimension = cf.Enums.PeriodicBoundaryDimensionsEnum.OneDimension +properties.EndPointVectorOne.N = "0.0" +properties.EndPointVectorOne.U = "0.05" +properties.EndPointVectorOne.V = "-0.05" +properties.StartPoint.N = "0.0" +properties.StartPoint.U = "-0.05" +properties.StartPoint.V = "-0.05" +project.Contents.SolutionSettings.PeriodicBoundary:SetProperties(properties) + -- Introduce a squint angle of 15 degrees to the periodic boundary +properties = project.Contents.SolutionSettings.PeriodicBoundary:GetProperties() +properties.PhaseShiftMethod + = cf.Enums.PeriodicBoundaryPhaseShiftMethodEnum.BeamSquintAngle +properties.BeamSquintAngle.Theta = 15 +project.Contents.SolutionSettings.PeriodicBoundary:SetProperties(properties) +Inheritance +The PeriodicBoundaryBeamSquintAngle object is derived from the CompositeValue object. +Usage locations +The PeriodicBoundaryBeamSquintAngle object can be accessed from the following locations: +• Properties +◦ PeriodicBoundary object has property BeamSquintAngle. +• Methods +◦ PeriodicBoundaryBeamSquintAngleList object has method Append(). +◦ PeriodicBoundaryBeamSquintAngleList object has method Get(number). +Property List +Phi +Theta +The phi angle (in degrees). (Read/Write ParametricExpression) +The theta angle (in degrees). (Read/Write ParametricExpression) +Property Details +Phi +The phi angle (in degrees). +Type +ParametricExpression +Access +Read/Write +Theta +The theta angle (in degrees). +Type +ParametricExpression +Access +Read/Write +PeriodicBoundaryBeamSquintAngleList +A list of PeriodicBoundaryBeamSquintAngle items. +Method List +Append () +Appends a new item to the list. (Returns a PeriodicBoundaryBeamSquintAngle object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +PeriodicBoundaryBeamSquintAngle object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +PeriodicBoundaryBeamSquintAngle +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +PeriodicBoundaryBeamSquintAngle +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1584 +Altair Feko 2022.3 +2 Application Programming Interface (API) +PeriodicBoundaryPhaseShift +p.1585 +The phase shift to be applied in the direction of each of the vectors defining the unit-cell. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME.. + [[/shared/Resources/Automation/square_loop_antenna_MATCHED.cfx]]}) + -- Set up one dimensional periodic boundary condition for the model +properties = project.Contents.SolutionSettings.PeriodicBoundary:GetProperties() +properties.Dimension = cf.Enums.PeriodicBoundaryDimensionsEnum.OneDimension +properties.EndPointVectorOne.N = "0.0" +properties.EndPointVectorOne.U = "0.05" +properties.EndPointVectorOne.V = "-0.05" +properties.StartPoint.N = "0.0" +properties.StartPoint.U = "-0.05" +properties.StartPoint.V = "-0.05" +project.Contents.SolutionSettings.PeriodicBoundary:SetProperties(properties) + -- Introduce a phase shift in a vector direction +properties = project.Contents.SolutionSettings.PeriodicBoundary:GetProperties() +properties.PhaseShiftMethod + = cf.Enums.PeriodicBoundaryPhaseShiftMethodEnum.SpecifyManually +properties.PhaseShift.FirstVector = 1 +project.Contents.SolutionSettings.PeriodicBoundary:SetProperties(properties) +Inheritance +The PeriodicBoundaryPhaseShift object is derived from the CompositeValue object. +Usage locations +The PeriodicBoundaryPhaseShift object can be accessed from the following locations: +• Properties +◦ PeriodicBoundary object has property PhaseShift. +• Methods +◦ PeriodicBoundaryPhaseShiftList object has method Append(). +◦ PeriodicBoundaryPhaseShiftList object has method Get(number). +Property List +FirstVector +The phase shift to be applied in the direction of the first vector. (Read/Write +ParametricExpression) +SecondVector +The phase shift to be applied in the direction of the second vector. (Read/Write +ParametricExpression) +Property Details +FirstVector +The phase shift to be applied in the direction of the first vector. +Type +ParametricExpression +Access +Read/Write +SecondVector +The phase shift to be applied in the direction of the second vector. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +PeriodicBoundaryPhaseShiftList +A list of PeriodicBoundaryPhaseShift items. +Method List +Append () +p.1587 +Appends a new item to the list. (Returns a PeriodicBoundaryPhaseShift object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a PeriodicBoundaryPhaseShift +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +PeriodicBoundaryPhaseShift +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +PeriodicBoundaryPhaseShift +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1588 +PlanarSubstrate +The planar substrate properties. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +dielectric = project.Definitions.Media.Dielectric:AddDielectric() +project.Contents.SolutionSettings.GroundPlane.DefinitionMethod = + cf.Enums.GroundPlaneDefinitionMethodEnum.MultilayerSubstrate + -- Modify the medium of the second ground plane layer +groundPlaneLayer = project.Contents.SolutionSettings.GroundPlane.Layers[1] +groundPlaneLayer.Medium = dielectric +Inheritance +The PlanarSubstrate object is derived from the CompositeValue object. +Usage locations +The PlanarSubstrate object can be accessed from the following locations: +• Properties +• Methods +◦ PlanarSubstrateList object has method Append(). +◦ PlanarSubstrateList object has method Get(number). +Property List +GroundBottom +The planar substrate ground bottom type specified by the GroundBottomTypeEnum, e.g. None or +PEC. (Read/Write GroundBottomTypeEnum) +Medium +The planar substrate medium. (Read/Write Dielectric) +Thickness +The planar substrate thickness. (Read/Write ParametricExpression) +Property Details +GroundBottom +The planar substrate ground bottom type specified by the GroundBottomTypeEnum, e.g. None or +PEC. +Type +GroundBottomTypeEnum +Access +Read/Write +Medium +The planar substrate medium. +Type +Dielectric +Access +Read/Write +Thickness +The planar substrate thickness. +Type +ParametricExpression +Access +Read/Write +PlanarSubstrateList +A list of PlanarSubstrate items. +Usage locations +The PlanarSubstrateList object can be accessed from the following locations: +• Properties +◦ GroundPlane object has property Layers. +Method List +Append () +Appends a new item to the list. (Returns a PlanarSubstrate object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a PlanarSubstrate object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +PlanarSubstrate +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +PlanarSubstrate +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1592 +PlaneShape +A plane shape. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a plane shape +plane = project.Definitions.PeriodicStructures.Shapes:AddPlane(1.5, 1.2) +Inheritance +The PlaneShape object is derived from the Shape object. +Usage locations +The PlaneShape object can be accessed from the following locations: +• Methods +◦ ShapeCollection collection has method AddPlane(table). +◦ ShapeCollection collection has method AddPlane(Expression, Expression). +Property List +Depth +The plane shape depth. (Read/Write ParametricExpression) +Label +Type +Width +The object label. (Read/Write string) +The object type string. (Read only string) +The plane shape width. (Read/Write ParametricExpression) +Method List +BuildGeometry () +Creates the full geometry representation of the shape. (Returns a Geometry object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1594 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Depth +The plane shape depth. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Width +The plane shape width. +Type +ParametricExpression +Access +Read/Write +Method Details +BuildGeometry () +Creates the full geometry representation of the shape. +Return +Geometry +The shape geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +PlaneWave +A plane wave may be defined as a source in a model. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a plane wave source +p.1596 +planeWave = project.Contents.SolutionConfigurations.GlobalSources:AddPlaneWave(0,0) +Inheritance +The PlaneWave object is derived from the Source object. +Usage locations +The PlaneWave object can be accessed from the following locations: +• Methods +◦ SourceCollection collection has method AddPlaneWave(table). +◦ SourceCollection collection has method AddPlaneWave(Expression, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CalculateOrthogonalPolarisationsEnabled +Calculate orthogonal polarisations. (Read/Write boolean) +DefinitionMethod +The plane wave definition method. (Read/Write PlaneWaveDefinitionMethodEnum) +Ellipticity +Ellipticity (between 0 and 1). (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Magnitude +The source magnitude (V/m). (Read/Write ParametricExpression) +Phase +Phi +The source phase (degrees). (Read/Write ParametricExpression) +The phi range of points. (Read/Write PointAngleRange) +PolarisationAngle +The polarisation angle (degrees). (Read/Write ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +PolarityType +p.1597 +The plane wave type specified by the PlaneWavePolarityTypeEnum, e.g. LeftHand, Linear, etc. +(Read/Write PlaneWavePolarityTypeEnum) +Theta +Type +The theta range of points. (Read/Write PointAngleRange) +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CalculateOrthogonalPolarisationsEnabled +Calculate orthogonal polarisations. +Type +boolean +Access +Read/Write +DefinitionMethod +The plane wave definition method. +Type +PlaneWaveDefinitionMethodEnum +Access +Read/Write +Ellipticity +Ellipticity (between 0 and 1). +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Magnitude +The source magnitude (V/m). +Type +ParametricExpression +Access +Read/Write +The source phase (degrees). +Type +ParametricExpression +Access +Read/Write +Phase +Phi +The phi range of points. +Type +PointAngleRange +Access +Read/Write +PolarisationAngle +The polarisation angle (degrees). +Type +ParametricExpression +Access +Read/Write +PolarityType +The plane wave type specified by the PlaneWavePolarityTypeEnum, e.g. LeftHand, Linear, etc. +Type +PlaneWavePolarityTypeEnum +Access +Read/Write +Theta +The theta range of points. +Type +PointAngleRange +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1602 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Point +p.1603 +A point in 3D space. This object lives in the Lua session only. Points are defined by numbers and cannot +be defined with expressions. Mathematical operations can be done on points. +Example + -- Create a default 'Point' at (0,0,0) +p1 = pf.Point.New() + -- Assign values to each component of the point +p1.x = 1 +p1.y = 1 +p1.z = 1 + -- Create a 'Point' with number values +p2 = pf.Point(2,2,2) + -- Determine the distance between two points +distance = p1:distanceTo(p2) + -- Some of the valid operators for 'Point' +p3 = 2 * p1 +p4 = p2 * 2 +p5 = p2 / 2 +p6 = -p2 +p7 = p1 + p2 +p8 = p1 - p2 +if (p1 ~= p2) then + print(p1.." is not equal to "..p2) +end +Usage locations +The Point object can be accessed from the following locations: +• Properties +◦ Workplane object has property Origin. +◦ Edge object has property CentreOfGravity. +◦ Face object has property CentreOfGravity. +◦ Region object has property CentreOfGravity. +◦ Box object has property Corner1. +◦ Box object has property Corner2. +◦ Box object has property Centre. +• Static functions +◦ Point object has static function New(number, number, number). +◦ Point object has static function New(). +Property List +Type +The object type string. (Read only string) +The x component of the point. (Read/Write number) +The y component of the point. (Read/Write number) +The z component of the point. (Read/Write number) +Method List +DistanceTo (point Point) +Returns the distance between this point and another. (Returns a number object.) +Constructor Function List +New (x number, y number, z number) +Creates a new point. (Returns a Point object.) +New () +Creates a new point. (Returns a Point object.) +Index List +[number] +Index a component of the point. (Read number) +[number] +Index a component of the point. (Write number) +Property Details +Type +The object type string. +Type +string +Access +Read only +The x component of the point. +Type +number +Access +Read/Write +The y component of the point. +Type +number +Access +Read/Write +The z component of the point. +Type +number +Access +Read/Write +Method Details +DistanceTo (point Point) +Returns the distance between this point and another. +Input Parameters +point(Point) +The point to measure the distance To from this point. +Return +number +The distance between the points. +Static Function Details +New (x number, y number, z number) +Creates a new point. +Input Parameters +x(number) +The x component. +y(number) +The y component. +z(number) +The z component. +Return +Point +The new point. +New () +Creates a new point. +Return +Point +The new point. +PointAngleRange +A range of points defined between a start and end angles. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Add a NearField starting at (1,0,0) ending at (0,0,0) with 11 points along X +nearField = project.Contents.SolutionConfigurations[1].NearFields:AddSpherical(1,0,0, +2,30,90, +11,4,10) +Inheritance +The PointAngleRange object is derived from the CompositeValue object. +Usage locations +The PointAngleRange object can be accessed from the following locations: +• Properties +◦ PlaneWave object has property Phi. +◦ PlaneWave object has property Theta. +◦ FarField object has property Phi. +◦ FarField object has property Theta. +◦ ConicalRequestPoints object has property Phi. +◦ CylindricalRequestPoints object has property Phi. +◦ CylindricalXRequestPoints object has property Phi. +◦ CylindricalYRequestPoints object has property Phi. +◦ SphericalRequestPoints object has property Phi. +◦ SphericalRequestPoints object has property Theta. +• Methods +◦ PointAngleRangeList object has method Append(). +◦ PointAngleRangeList object has method Get(number). +PointAngleRangeList +A list of PointAngleRange items. +Method List +Append () +Appends a new item to the list. (Returns a PointAngleRange object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a PointAngleRange object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +PointAngleRange +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +PointAngleRange +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +PointExpressionTable +A table (2 dimensional list) of PointExpression items. +Method List +AddColumn () +Appends a new column to the table. +AddRow () +Appends a new row to the table. +ColumnCount () +Returns the number columns in the table. (Returns a number object.) +Get (rowIndex number, columnIndex number) +Returns the item at the given row and column indices. Indexing starts at 1. (Returns a +PointExpression object.) +RowCount () +Returns the number of rows in the table. (Returns a number object.) +Set (rowIndex number, columnIndex number, value PointExpression) +Set item at the given row and column indices. Indexing starts at 1. +SetDimensions (rowCount number, columnCount number) +Sets the number of rows and columns in the table. +Method Details +AddColumn () +Appends a new column to the table. +AddRow () +Appends a new row to the table. +ColumnCount () +Returns the number columns in the table. +Return +number +The number of columns in the table. +Get (rowIndex number, columnIndex number) +Returns the item at the given row and column indices. Indexing starts at 1. +Input Parameters +rowIndex(number) +The row index of the item to return. +columnIndex(number) +The column index of the item to return. +Return +PointExpression +The PointExpression at the given indices. +RowCount () +Returns the number of rows in the table. +Return +number +The number of rows in the table. +Set (rowIndex number, columnIndex number, value PointExpression) +Set item at the given row and column indices. Indexing starts at 1. +Input Parameters +rowIndex(number) +The row index of the item to return. +columnIndex(number) +The column index of the item to return. +value(PointExpression) +The PointExpression item to be assigned to the table at the given indices. +SetDimensions (rowCount number, columnCount number) +Sets the number of rows and columns in the table. +Input Parameters +rowCount(number) +The number of rows. +columnCount(number) +The number of columns. +PointRange +A range of points defined between a start and end point. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Add a NearField starting at (1,0,0) ending at (0,0,0) with 11 points along X +nearField = project.Contents.SolutionConfigurations[1].NearFields:AddCartesian(1,0,0, +0,0,0, +11,1,1) +Inheritance +The PointRange object is derived from the CompositeValue object. +Usage locations +The PointRange object can be accessed from the following locations: +• Properties +◦ FarField object has property U. +◦ FarField object has property V. +◦ CartesianRequestPoints object has property N. +◦ CartesianRequestPoints object has property U. +◦ CartesianRequestPoints object has property V. +◦ ConicalRequestPoints object has property Rho. +◦ ConicalRequestPoints object has property Z. +◦ CylindricalRequestPoints object has property Rho. +◦ CylindricalRequestPoints object has property Z. +◦ CylindricalXRequestPoints object has property Rho. +◦ CylindricalXRequestPoints object has property X. +◦ CylindricalYRequestPoints object has property Rho. +◦ CylindricalYRequestPoints object has property Y. +◦ SphericalRequestPoints object has property Radius. +• Methods +◦ PointRangeList object has method Append(). +◦ PointRangeList object has method Get(number). +Property List +End +The end point. (Read/Write PointRangeExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Increment +p.1613 +The increment per axis. Only valid if PointSpecificationMethod is Increment. (Read/Write +ParametricExpression) +NumberOfPoints +The number of points per axis. Only valid if PointSpecificationMethod is NumberOfPoints. (Read/ +Write ParametricExpression) +Start +The start point. (Read/Write PointRangeExpression) +Property Details +End +The end point. +Type +PointRangeExpression +Access +Read/Write +Increment +The increment per axis. Only valid if PointSpecificationMethod is Increment. +Type +ParametricExpression +Access +Read/Write +NumberOfPoints +The number of points per axis. Only valid if PointSpecificationMethod is NumberOfPoints. +Type +ParametricExpression +Access +Read/Write +Start +The start point. +Type +PointRangeExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +PointRangeExpression +A type of parametric expression used in point ranges. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a plane wave source +p.1614 +planeWave = project.Contents.SolutionConfigurations.GlobalSources:AddPlaneWave(0,0) +Inheritance +The PointRangeExpression object is derived from the NormalDimension object. +Usage locations +The PointRangeExpression object can be accessed from the following locations: +• Properties +◦ PointRange object has property End. +◦ PointRange object has property Start. +• Methods +◦ PointRangeExpressionList object has method Append(). +◦ PointRangeExpressionList object has method Get(number). +PointRangeExpressionList +A list of PointRangeExpression items. +Method List +Append () +Appends a new item to the list. (Returns a PointRangeExpression object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a PointRangeExpression +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +PointRangeExpression +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +PointRangeExpression +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1616 +PointRangeList +A list of PointRange items. +Method List +Append () +Appends a new item to the list. (Returns a PointRange object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a PointRange object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +PointRange +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +PointRange +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +PointRefinement +A point refinement meshing rule. Objects in the vicinity of the point are meshed finer. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a mesh refinement point at the origin +origin = cf.Point() +pointRefinement = + project.Contents.MeshRefinementRules:AddPointRefinement(origin, 1, 0.1) + -- Change the refinement point radius to 2 +pointRefinement.Radius = 2 +Inheritance +The PointRefinement object is derived from the MeshRefinementRule object. +Usage locations +The PointRefinement object can be accessed from the following locations: +• Methods +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSize +The target mesh size in the refinement region. (Read/Write ParametricExpression) +Position +The point refinement's position. (Read/Write LocalCoordinate) +Radius +The radius around the point that will be affected by the refinement. (Read/Write Dimension) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method List +CopyAndMirror (properties table) +p.1620 +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSize +The target mesh size in the refinement region. +Type +ParametricExpression +Access +Read/Write +Position +The point refinement's position. +Type +LocalCoordinate +Access +Read/Write +Radius +The radius around the point that will be affected by the refinement. +Type +Dimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +PolderTensor +The parameters used to define a Polder tensor. +Example +p.1625 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create an anisotropic 3D medium using a Polder tensor definition +properties = cf.AnisotropicDielectric.GetDefaultProperties() +properties.TensorDescription = cf.Enums.TensorDescriptionMethodEnum.PolderTensor +-- Dielectric modelling +properties.PolderTensor.RelativePermittivity = "14.5" +properties.PolderTensor.LossTangent = "0.0" +-- Magnetic medium properties +properties.PolderTensor.SaturationMagnetisation = "650.0" +properties.PolderTensor.LineWidth = "0.0" +-- Magnetostatic bias field +properties.PolderTensor.DCBiasField = "220.0" +properties.PolderTensor.FieldDirection + = cf.Enums.MagnetostaticFieldDirectionEnum.ZDirected +anisotropicDielectric = + project.Definitions.Media.AnisotropicDielectric:AddAnisotropicDielectric(properties) + -- Change the colour to Cyan +anisotropicDielectric.Colour = "#00FFFF" +Inheritance +The PolderTensor object is derived from the CompositeValue object. +Usage locations +The PolderTensor object can be accessed from the following locations: +• Properties +◦ AnisotropicDielectric object has property PolderTensor. +• Methods +◦ PolderTensorList object has method Append(). +◦ PolderTensorList object has method Get(number). +Property List +DCBiasField +The magnetic bias field applied to the 3D anisotropic medium. This value is given in +Oersted. The direction is defined using the FieldDirection enumeration property. (Read/Write +ParametricExpression) +FieldDirection +The orientation of the DCBiasField. (Read/Write MagnetostaticFieldDirectionEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +LineWidth +p.1626 +The line width or delta H represents the rate that the precessional mode, in the biased +ferrite, will decay when the excitation is removed. This is measured in Oersted. (Read/Write +ParametricExpression) +LossTangent +Dielectric loss tangent value. (Read/Write ParametricExpression) +RelativePermittivity +Dielectric relative permittivity value. (Read/Write ParametricExpression) +SaturationMagnetisation +The magnetisation value at which all the magnetic dipole moments of the material become +aligned. (Read/Write ParametricExpression) +Property Details +DCBiasField +The magnetic bias field applied to the 3D anisotropic medium. This value is given in Oersted. The +direction is defined using the FieldDirection enumeration property. +Type +ParametricExpression +Access +Read/Write +FieldDirection +The orientation of the DCBiasField. +Type +MagnetostaticFieldDirectionEnum +Access +Read/Write +LineWidth +The line width or delta H represents the rate that the precessional mode, in the biased ferrite, will +decay when the excitation is removed. This is measured in Oersted. +Type +ParametricExpression +Access +Read/Write +LossTangent +Dielectric loss tangent value. +Type +ParametricExpression +Access +Read/Write +RelativePermittivity +Dielectric relative permittivity value. +Type +ParametricExpression +Access +Read/Write +SaturationMagnetisation +The magnetisation value at which all the magnetic dipole moments of the material become +aligned. +Type +ParametricExpression +Access +Read/Write +PolderTensorList +A list of PolderTensor items. +Method List +Append () +Appends a new item to the list. (Returns a PolderTensor object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a PolderTensor object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +PolderTensor +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +PolderTensor +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Polygon +A polygon. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a polygon from a 'Point' list +points = {} +points[1] = cf.Point(1,0,0) +points[2] = cf.Point(1,1,0) +points[3] = cf.Point(1,1,1) +polygon = project.Contents.Geometry:AddPolygon(points) +Inheritance +The Polygon object is derived from the Geometry object. +Usage locations +The Polygon object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddPolygon(table). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Corners +The collection of corner coordinates of the polygon. (Read/Write LocalInternalCoordinateList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReverseFaceNormal () +Reverse the geometry face normals. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +p.1632 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Corners +The collection of corner coordinates of the polygon. +Type +LocalInternalCoordinateList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormal () +Reverse the geometry face normals. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Polyline +A polyline. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a polyline from a 'Point' list +points = {} +points[1] = cf.Point(1,0,0) +points[2] = cf.Point(1,1,0) +points[3] = cf.Point(1,1,1) +polyline = project.Contents.Geometry:AddPolyline(points) +Inheritance +The Polyline object is derived from the Geometry object. +Usage locations +The Polyline object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddPolyline(table). +◦ GeometryCollection collection has method AddPolyline(List of Point). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Corners +The collection of corner coordinates of the polyline. (Read/Write LocalInternalCoordinateList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +p.1640 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Corners +The collection of corner coordinates of the polyline. +Type +LocalInternalCoordinateList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +PolylineRefinement +p.1646 +A point refinement meshing rule. Objects in the vicinity of the polyline are meshed finer. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a mesh refinement polyline at the specified corners +corners = {cf.Point(), cf.Point(1, 0, 0), cf.Point(1, 1, 0)} +pointRefinement = + project.Contents.MeshRefinementRules:AddPolylineRefinement(corners, 0.1, 0.01) + -- Change the polyline refinement radius to 0.2 +pointRefinement.Radius = 0.2 +Inheritance +The PolylineRefinement object is derived from the MeshRefinementRule object. +Usage locations +The PolylineRefinement object can be accessed from the following locations: +• Methods +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Corners +The collection of corner coordinates of the polyline refinement. (Read/Write +LocalInternalCoordinateList) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSize +The target mesh size in the refinement region. (Read/Write ParametricExpression) +Radius +The radius around the polyline that will be affected by the refinement. (Read/Write +ParametricExpression) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Corners +The collection of corner coordinates of the polyline refinement. +Type +LocalInternalCoordinateList +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSize +The target mesh size in the refinement region. +Type +ParametricExpression +Access +Read/Write +Radius +The radius around the polyline that will be affected by the refinement. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1651 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Port +A port. +Example +local application = cf.Application.GetInstance() +local project = application:NewProject() +line = project.Contents.Geometry:AddLine(cf.Point(0, 0, 0), cf.Point(1, 1, 1)) + -- Add a wire port and obtain a handle to a 'Port' +port = project.Contents.Ports:AddWirePort(line.Wires[1]) + -- Delete the port again +port:Delete() +Inheritance +The Port object is derived from the Object object. +The following objects are derived (specialisations) from the Port object: +• AbstractFEMLinePort +• AbstractMeshPort +• CablePort +• EdgeMeshPort +• EdgePort +• FEMModalMeshPort +• FEMModalPort +• MicrostripPort +• WaveguideMeshPort +• WaveguidePort +• WirePort +Usage locations +The Port object can be accessed from the following locations: +• Properties +◦ PortProperties object has property Terminal. +• Methods +◦ PortCollection collection has method Item(number). +◦ PortCollection collection has method Item(string). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.1653 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +PortProperties +The S-parameter port properties. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a line and a wire port at the start of the line +line = project.Contents.Geometry:AddLine(cf.Point(0,0,0),cf.Point(1,1,0)) +port1 = project.Contents.Ports:AddWirePort(line.Wires[1]) + -- Add an S-parameters calculation request for the wire port +SParameterConfiguration = + project.Contents.SolutionConfigurations:AddMultiportSParameter({port1}) + -- Add a port to the S-parameters calculation +port2 = project.Contents.Ports:AddWirePort(line.Wires[1]) +port2.Location = cf.Enums.WirePortLocationEnum.End +SParametersRequest = SParameterConfiguration.SParameter + -- Obtain a handle to the 'PortProperties' +portProperties = SParametersRequest.PortProperties[1] + -- Set the port inactive +portProperties.Active = false +Inheritance +The PortProperties object is derived from the CompositeValue object. +Usage locations +The PortProperties object can be accessed from the following locations: +• Methods +◦ PortPropertiesList object has method Append(). +◦ PortPropertiesList object has method Get(number). +Property List +Active +Specifies if the port is active. (Read/Write boolean) +Impedance +The reference impedance. This property applies to all ports except waveguide ports. (Read/Write +ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +IndexM +p.1656 +M index. This property only applies for waveguide ports where WaveGuideModeType is set to TE or +TM. (Read/Write ParametricExpression) +IndexN +N index. This property only applies for waveguide ports where WaveGuideModeType is set to TE or +TM. (Read/Write ParametricExpression) +Rotation +Waveguide rotation. This property only applies for the coaxial or circular waveguide ports. (Read/ +Write ParametricExpression) +Terminal +The port terminal connected to the S-parameter. (Read/Write Port) +WaveguideModeType +The waveguide mode type. The property only applies for waveguide ports. (Read/Write +SParameterWaveguideModeTypeEnum) +Property Details +Active +Specifies if the port is active. +Type +boolean +Access +Read/Write +Impedance +The reference impedance. This property applies to all ports except waveguide ports. +Type +ParametricExpression +Access +Read/Write +IndexM +M index. This property only applies for waveguide ports where WaveGuideModeType is set to TE or +TM. +Type +ParametricExpression +Access +Read/Write +IndexN +N index. This property only applies for waveguide ports where WaveGuideModeType is set to TE or +TM. +Type +ParametricExpression +Access +Read/Write +Rotation +Waveguide rotation. This property only applies for the coaxial or circular waveguide ports. +Type +ParametricExpression +Access +Read/Write +Terminal +The port terminal connected to the S-parameter. +Type +Port +Access +Read/Write +WaveguideModeType +The waveguide mode type. The property only applies for waveguide ports. +Type +SParameterWaveguideModeTypeEnum +Access +Read/Write +PortPropertiesList +A list of PortProperties items. +Usage locations +The PortPropertiesList object can be accessed from the following locations: +• Properties +◦ SParameter object has property PortProperties. +Method List +Append () +Appends a new item to the list. (Returns a PortProperties object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a PortProperties object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +PortProperties +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +PortProperties +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1659 +Power +The power settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- The power object is always there, obtain a handle +power = project.Contents.SolutionConfigurations.GlobalPower + -- Set the power scale setting +power.ScaleSettings = cf.Enums.PowerScaleSettingsEnum.NoPowerScaling +Inheritance +The Power object is derived from the Object object. +Usage locations +The Power object can be accessed from the following locations: +• Properties +◦ SolutionConfigurationCollection collection has property GlobalPower. +◦ StandardConfiguration object has property Power. +Property List +DecoupleSourcesEnabled +The option to decouple all sources when calculating power. (Read/Write boolean) +Label +The object label. (Read/Write string) +ScaleSettings +The scale settings specified by the PowerScaleSettingsEnum, e.g. NoPowerScaling, +TotalSourcePower, etc. (Read/Write PowerScaleSettingsEnum) +SourcePower +The source power (Watt). (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Z0Imaginary +The imaginary part of the characteristic impedance (Z0). (Read/Write ParametricExpression) +Z0Real +The real part of the characteristic impedance (Z0). (Read/Write ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +DecoupleSourcesEnabled +The option to decouple all sources when calculating power. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +ScaleSettings +The scale settings specified by the PowerScaleSettingsEnum, e.g. NoPowerScaling, +TotalSourcePower, etc. +Type +PowerScaleSettingsEnum +Access +Read/Write +SourcePower +The source power (Watt). +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Z0Imaginary +The imaginary part of the characteristic impedance (Z0). +Type +ParametricExpression +Access +Read/Write +Z0Real +The real part of the characteristic impedance (Z0). +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1663 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +PowerOptimisationGoal +A power optimisation goal. +Example +p.1664 +application = cf.Application.GetInstance() +project = application:NewProject() +search = + project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) + -- Create a power optimisation goal +properties = cf.PowerOptimisationGoal.GetDefaultProperties() +properties.GoalOperator = cf.Enums.OptimisationGoalOperatorEnum.Minimise +powerGoal = search.Goals:AddPowerGoal(properties) + -- Change the focus type to power loss +powerGoal.FocusType = cf.Enums.OptimisationPowerFocusTypeEnum.PowerLoss +Inheritance +The PowerOptimisationGoal object is derived from the OptimisationGoal object. +Usage locations +The PowerOptimisationGoal object can be accessed from the following locations: +• Methods +◦ OptimisationGoalCollection collection has method AddPowerGoal(table). +Property List +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. (Read/Write string) +FocusType +Set the focus type. (Read/Write OptimisationPowerFocusTypeEnum) +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +(Read/Write OptimisationGoalOperatorEnum) +Label +The object label. (Read/Write string) +Objective +The objective describes a state that the optimisation process should attempt to achieve. (Read +only OptimisationGoalObjective) +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. (Read/Write OptimisationGoalProcessingStepsList) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Weight +Specify the optimisation weight. (Read/Write ParametricExpression) +p.1665 +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. +Type +string +Access +Read/Write +FocusType +Set the focus type. +Type +OptimisationPowerFocusTypeEnum +Access +Read/Write +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +Type +OptimisationGoalOperatorEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Objective +The objective describes a state that the optimisation process should attempt to achieve. +Type +OptimisationGoalObjective +Access +Read only +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. +Type +OptimisationGoalProcessingStepsList +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Weight +Specify the optimisation weight. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.1667 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +PreconditionerSettings +Preconditioner solver settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Active the direct sparse solver +p.1668 +project.Contents.SolutionSettings.SolverSettings.PreconditionerSettings.AdvancedSolverType + = + cf.Enums.AdvancedSolverTypeEnum.DirectSparse +Inheritance +The PreconditionerSettings object is derived from the CompositeValue object. +Usage locations +The PreconditionerSettings object can be accessed from the following locations: +• Properties +◦ SolverSettings object has property PreconditionerSettings. +• Methods +◦ PreconditionerSettingsList object has method Append(). +◦ PreconditionerSettingsList object has method Get(number). +Property List +AdvancedSolverType +The solver type to be used, specified by AdvancedSolverTypeEnum, eg. Default, DirectSparse, etc. +(Read/Write AdvancedSolverTypeEnum) +FactorisationType +The parallel execution factorisation type to be used, specified by FactorisationTypeEnum, eg. Auto, +Default, StandardFullRank or BlockLowRank. (Read/Write FactorisationTypeEnum) +IterativeSolverSettings +Iterative solver settings. Only valid if AdvancedSolverType is Iterative. (Read/Write +IterativeSolverSettings) +Property Details +AdvancedSolverType +The solver type to be used, specified by AdvancedSolverTypeEnum, eg. Default, DirectSparse, etc. +Type +AdvancedSolverTypeEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FactorisationType +p.1669 +The parallel execution factorisation type to be used, specified by FactorisationTypeEnum, eg. Auto, +Default, StandardFullRank or BlockLowRank. +Type +FactorisationTypeEnum +Access +Read/Write +IterativeSolverSettings +Iterative solver settings. Only valid if AdvancedSolverType is Iterative. +Type +IterativeSolverSettings +Access +Read/Write +PreconditionerSettingsList +A list of PreconditionerSettings items. +Method List +Append () +Appends a new item to the list. (Returns a PreconditionerSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a PreconditionerSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +PreconditionerSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +PreconditionerSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1671 +Primitive +A primitive operator. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0,0,0),1,1,1) + -- Convert the cuboid to a primitive +primitive = cuboid:ConvertToPrimitive() + -- Hide the primitive +primitive.Visible = false +Inheritance +The Primitive object is derived from the Geometry object. +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +The object type string. (Read only string) +Collection List +Edges +The collection of edges of the operator. (EdgeCollection of Edge.) +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1674 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +p.1676 +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +Explode () +p.1678 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ProjectGeometry +Project geometry onto a part. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create some geometry to project +sphere = project.Contents.Geometry:AddSphere(cf.Point(0, 0, 0), 1) +cube = project.Contents.Geometry:AddCuboid(cf.Point(0, 1, 0.0), 0.5, 0.5, 0.5) + -- Now project the cube onto the sphere +project.Contents.Geometry:ProjectGeometry(cube, sphere) +Inheritance +The ProjectGeometry object is derived from the Geometry object. +Usage locations +The ProjectGeometry object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method ProjectGeometry(List of Geometry, Geometry). +◦ GeometryCollection collection has method ProjectGeometry(Geometry, Geometry). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ChildReferences +The geometry items to be transformed. (Read/Write ObjectReferenceList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +The object type string. (Read only string) +Collection List +Children +The collection of child operators of the operator. (OperatorCollection of Geometry.) +The collection of edges of the operator. (EdgeCollection of Edge.) +Edges +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Explode () +p.1682 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ChildReferences +The geometry items to be transformed. +Type +ObjectReferenceList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Children +The collection of child operators of the operator. +Type +OperatorCollection +Edges +Faces +The collection of edges of the operator. +Type +EdgeCollection +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +p.1687 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ProtectedModel +A concealed password protected component. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +sphere = project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1) +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e06" +-- Protect the model with a password +--project:EnableEncryption("password",true) +Inheritance +The ProtectedModel object is derived from the Object object. +Usage locations +The ProtectedModel object can be accessed from the following locations: +• Methods +◦ ProtectedModels collection has method AddComponent(table). +◦ ProtectedModels collection has method AddComponentFromFile(string). +◦ ProtectedModels collection has method Item(number). +◦ ProtectedModels collection has method Item(string). +Property List +AbsoluteFilePath +The full path of the project file (directory path and file name including the file extension). (Read +only string) +AbsolutePath +The full directory path of the project file (directory path excluding the file name and extension). +(Read only string) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Filename +The file to be imported as a protected component. (Read/Write FileReference) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +ConcealModel () +Conceals the component if it was exposed. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AbsoluteFilePath +The full path of the project file (directory path and file name including the file extension). +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +AbsolutePath +p.1690 +The full directory path of the project file (directory path excluding the file name and extension). +Type +string +Access +Read only +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Filename +The file to be imported as a protected component. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +ConcealModel () +Conceals the component if it was exposed. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1693 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +RLGOFaceAbsorbingSettings +The face absorption, reflection and transmission properties with regards to rays. +p.1694 +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a cone +cone = project.Contents.Geometry:AddCone(cf.Cone.GetDefaultProperties()) + -- Set the RL-GO settings for a face +cone.Faces[1].SolutionMethod = cf.Enums.FaceSolutionMethodEnum.RLGO +cone.Faces[1].FaceAbsorbingSettings.Enabled = true +cone.Faces[1].FaceAbsorbingSettings.NormalSide = + cf.Enums.FaceAbsorptionTypeEnum.ConsiderAllSources +cone.Faces[1].FaceAbsorbingSettings.OppositeSide = + cf.Enums.FaceAbsorptionTypeEnum.None +Inheritance +The RLGOFaceAbsorbingSettings object is derived from the CompositeValue object. +Usage locations +The RLGOFaceAbsorbingSettings object can be accessed from the following locations: +• Properties +◦ MeshCurvilinearTriangleFace object has property FaceAbsorbingSettings. +◦ MeshTriangleFace object has property FaceAbsorbingSettings. +◦ MeshPlate object has property FaceAbsorbingSettings. +◦ Face object has property FaceAbsorbingSettings. +• Methods +◦ RLGOFaceAbsorbingSettingsList object has method Append(). +◦ RLGOFaceAbsorbingSettingsList object has method Get(number). +Property List +Enabled +Enables the setting of the face absorbing, reflection and transmission properties for the RL-GO. +(Read/Write boolean) +NormalSide +The default face property of the faces (normal side) for all sources. Only valid if face absorption is +enabled. (Read/Write FaceAbsorptionTypeEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +OppositeSide +p.1695 +The default face property of the faces (opposite to normal side) for all sources. Only valid if face +absorption is enabled. (Read/Write FaceAbsorptionTypeEnum) +Property Details +Enabled +Enables the setting of the face absorbing, reflection and transmission properties for the RL-GO. +Type +boolean +Access +Read/Write +NormalSide +The default face property of the faces (normal side) for all sources. Only valid if face absorption is +enabled. +Type +FaceAbsorptionTypeEnum +Access +Read/Write +OppositeSide +The default face property of the faces (opposite to normal side) for all sources. Only valid if face +absorption is enabled. +Type +FaceAbsorptionTypeEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +RLGOFaceAbsorbingSettingsList +A list of RLGOFaceAbsorbingSettings items. +Method List +Append () +p.1696 +Appends a new item to the list. (Returns a RLGOFaceAbsorbingSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a RLGOFaceAbsorbingSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +RLGOFaceAbsorbingSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +RLGOFaceAbsorbingSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1697 +Altair Feko 2022.3 +2 Application Programming Interface (API) +RayContributionsFacetedUTD +Ray contribution settings. +Example +application = cf.Application.GetInstance() + project = application.Project +p.1698 + SolverSettings_1 = project.Contents.SolutionSettings.SolverSettings + SolverSettings_1.HighFrequencySettings.UTDRayContributionsType + = cf.Enums.UTDRayContributionsTypeEnum.Advanced + SolverSettings_1.HighFrequencySettings.RayContributionsFacetedUTD.EdgeAndWedgeDiffractions + = true +Inheritance +The RayContributionsFacetedUTD object is derived from the CompositeValue object. +Usage locations +The RayContributionsFacetedUTD object can be accessed from the following locations: +• Properties +◦ HighFrequencySettings object has property RayContributionsFacetedUTD. +• Methods +◦ RayContributionsFacetedUTDList object has method Append(). +◦ RayContributionsFacetedUTDList object has method Get(number). +Property List +CornerTipDiffraction +Specifies whether the corner and tip diffraction contributions are used. Only valid if +UTDRayContributionsType is Advanced. (Read/Write boolean) +CreepingWaves +Specifies whether the creeping waves ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. (Read/Write boolean) +DirectField +Specifies whether the direct field ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. (Read/Write boolean) +EdgeAndWedgeDiffractions +Specifies whether the edge and wedge diffractions ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. (Read/Write boolean) +HigherOrderEffects +Specifies whether higher-order contributions are used. Only valid if UTDRayContributionsType is +Advanced. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfaceReflections +Specifies whether the surface reflection ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. (Read/Write boolean) +Property Details +CornerTipDiffraction +Specifies whether the corner and tip diffraction contributions are used. Only valid if +UTDRayContributionsType is Advanced. +p.1699 +Type +boolean +Access +Read/Write +CreepingWaves +Specifies whether the creeping waves ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. +Type +boolean +Access +Read/Write +DirectField +Specifies whether the direct field ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. +Type +boolean +Access +Read/Write +EdgeAndWedgeDiffractions +Specifies whether the edge and wedge diffractions ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. +Type +boolean +Access +Read/Write +HigherOrderEffects +Specifies whether higher-order contributions are used. Only valid if UTDRayContributionsType is +Advanced. +Type +boolean +Access +Read/Write +SurfaceReflections +Specifies whether the surface reflection ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +RayContributionsFacetedUTDList +A list of RayContributionsFacetedUTD items. +Method List +Append () +p.1701 +Appends a new item to the list. (Returns a RayContributionsFacetedUTD object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a RayContributionsFacetedUTD +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +RayContributionsFacetedUTD +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +RayContributionsFacetedUTD +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1702 +Altair Feko 2022.3 +2 Application Programming Interface (API) +RayContributionsRLGO +Ray contribution settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +p.1703 +SolverSettings_1 = project.Contents.SolutionSettings.SolverSettings +SolverSettings_1.HighFrequencySettings.RayContributionsRLGO.EdgeAndWedgeDiffractions + = true +Inheritance +The RayContributionsRLGO object is derived from the CompositeValue object. +Usage locations +The RayContributionsRLGO object can be accessed from the following locations: +• Properties +◦ HighFrequencySettings object has property RayContributionsRLGO. +• Methods +◦ RayContributionsRLGOList object has method Append(). +◦ RayContributionsRLGOList object has method Get(number). +Property List +EdgeAndWedgeDiffractions +Specifies whether the edge and wedge diffractions ray contributions are used. (Read/Write +boolean) +Property Details +EdgeAndWedgeDiffractions +Specifies whether the edge and wedge diffractions ray contributions are used. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +RayContributionsRLGOList +A list of RayContributionsRLGO items. +Method List +Append () +p.1704 +Appends a new item to the list. (Returns a RayContributionsRLGO object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a RayContributionsRLGO +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +RayContributionsRLGO +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +RayContributionsRLGO +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1705 +RayContributionsUTD +Ray contribution settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +SolverSettings_1 = project.Contents.SolutionSettings.SolverSettings +SolverSettings_1.HighFrequencySettings.UTDRayContributionsType + = cf.Enums.UTDRayContributionsTypeEnum.Advanced +SolverSettings_1.HighFrequencySettings.RayContributionsUTD.EdgeAndWedgeDiffractions + = true +Inheritance +The RayContributionsUTD object is derived from the CompositeValue object. +Usage locations +The RayContributionsUTD object can be accessed from the following locations: +• Properties +◦ HighFrequencySettings object has property RayContributionsUTD. +• Methods +◦ RayContributionsUTDList object has method Append(). +◦ RayContributionsUTDList object has method Get(number). +Property List +ConeTipDiffractions +Specifies whether the cone tip diffractions ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. (Read/Write boolean) +CornerDiffractions +Specifies whether the corner diffractions ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. (Read/Write boolean) +CreepingWaves +Specifies whether the creeping waves ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. (Read/Write boolean) +DirectAndReflected +Specifies whether the direct and reflected ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. (Read/Write boolean) +DoubleDiffractions +Specifies whether the double diffractions ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +EdgeAndWedgeDiffractions +Specifies whether the edge and wedge diffractions ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. (Read/Write boolean) +Property Details +ConeTipDiffractions +Specifies whether the cone tip diffractions ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. +p.1707 +Type +boolean +Access +Read/Write +CornerDiffractions +Specifies whether the corner diffractions ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. +Type +boolean +Access +Read/Write +CreepingWaves +Specifies whether the creeping waves ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. +Type +boolean +Access +Read/Write +DirectAndReflected +Specifies whether the direct and reflected ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. +Type +boolean +Access +Read/Write +DoubleDiffractions +Specifies whether the double diffractions ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. +Type +boolean +Access +Read/Write +EdgeAndWedgeDiffractions +Specifies whether the edge and wedge diffractions ray contributions are used. Only valid if +UTDRayContributionsType is Advanced. +Type +boolean +Access +Read/Write +RayContributionsUTDList +A list of RayContributionsUTD items. +Method List +Append () +Appends a new item to the list. (Returns a RayContributionsUTD object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a RayContributionsUTD +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +RayContributionsUTD +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +RayContributionsUTD +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1710 +ReceivingAntennaOptimisationGoal +A receiving antenna optimisation goal. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +search = + project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) + -- Create a receiving antenna optimisation goal with focus on a request with + label "RXAntenna" +properties = cf.ReceivingAntennaOptimisationGoal.GetDefaultProperties() +properties.FocusSourceLabel = "RXAntenna" +properties.FocusSourceType + = cf.Enums.OptimisationFocusSourceTypeEnum.FocusSourceByLabel +properties.GoalOperator = cf.Enums.OptimisationGoalOperatorEnum.Minimise +rxAntennaGoal = search.Goals:AddReceivingAntennaGoal(properties) + -- Set the focus type to power loss +rxAntennaGoal.FocusType + = cf.Enums.OptimisationReceivingAntennaFocusTypeEnum.PowerLoss +Inheritance +The ReceivingAntennaOptimisationGoal object is derived from the OptimisationGoal object. +Usage locations +The ReceivingAntennaOptimisationGoal object can be accessed from the following locations: +• Methods +◦ OptimisationGoalCollection collection has method AddReceivingAntennaGoal(table). +Property List +FocusSource +Set the focus source to a specified source object. The intended usage is for when the source is +defined in CADFEKO. (Read/Write BaseFieldReceivingAntenna) +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. (Read/Write string) +FocusType +Set the focus type. (Read/Write OptimisationReceivingAntennaFocusTypeEnum) +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +(Read/Write OptimisationGoalOperatorEnum) +Label +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Objective +p.1712 +The objective describes a state that the optimisation process should attempt to achieve. (Read +only OptimisationGoalObjective) +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. (Read/Write OptimisationGoalProcessingStepsList) +Type +The object type string. (Read only string) +Weight +Specify the optimisation weight. (Read/Write ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +FocusSource +Set the focus source to a specified source object. The intended usage is for when the source is +defined in CADFEKO. +Type +BaseFieldReceivingAntenna +Access +Read/Write +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. +Type +string +Access +Read/Write +FocusType +Set the focus type. +Type +OptimisationReceivingAntennaFocusTypeEnum +Access +Read/Write +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +Type +OptimisationGoalOperatorEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Objective +The objective describes a state that the optimisation process should attempt to achieve. +Type +OptimisationGoalObjective +Access +Read only +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. +Type +OptimisationGoalProcessingStepsList +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Weight +Specify the optimisation weight. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Rectangle +A rectangle. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a rectangle with its base corner at the specified 'Point' +corner = cf.Point(-0.25, -0.25, 0) +rectangle = project.Contents.Geometry:AddRectangle(corner, 0.5, 0.5) +Inheritance +The Rectangle object is derived from the Geometry object. +Usage locations +The Rectangle object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddRectangle(Point, Expression, Expression). +◦ GeometryCollection collection has method AddRectangle(table). +◦ GeometryCollection collection has method AddRectangleAtCentre(Point, Expression, +Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +DefinitionMethod +Rectangle base corner type definition specified by the RectangleDefinitionMethodEnum, e.g. +BaseAtCorner or BaseAtCentre. (Read/Write RectangleDefinitionMethodEnum) +Depth +The rectangle depth. (Read/Write Dimension) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Origin +The rectangle base corner / centre origin point. (Read/Write LocalCoordinate) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +Width +The object type string. (Read only string) +The rectangle width. (Read/Write Dimension) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Explode () +p.1717 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +DefinitionMethod +Rectangle base corner type definition specified by the RectangleDefinitionMethodEnum, e.g. +BaseAtCorner or BaseAtCentre. +Type +RectangleDefinitionMethodEnum +Access +Read/Write +Depth +The rectangle depth. +Type +Dimension +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Origin +The rectangle base corner / centre origin point. +Type +LocalCoordinate +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Width +The rectangle width. +Type +Dimension +Access +Read/Write +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +p.1720 +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +Explode () +p.1722 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReferenceDirection +The reference direction vector components. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a layered anisotropic dielectric +p.1724 +dielectric1 = + project.Definitions.Media.Dielectric:AddDielectric(cf.Dielectric.GetDefaultProperties()) +dielectric2 = + project.Definitions.Media.Dielectric:AddDielectric(cf.Dielectric.GetDefaultProperties()) +layeredMedium = + project.Definitions.Media.LayeredDielectric:AddLayeredAnisotropicDielectric({0.001}, + {0}, + {dielectric1}, {dielectric2}) + -- Create a cuboid and set region to free space +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +cuboid.Regions[1].Medium = project.Definitions.Media.FreeSpace + -- Set the face media to the layered dielectric + -- Set the medium reference direction vector + -- These must be set in one action so a properties table is used +properties = cuboid.Faces[1]:GetProperties() +properties.Medium = layeredMedium +properties.ReferenceDirection.Start = cf.Point(0,0,0) +properties.ReferenceDirection.End = cf.Point(1,0,0) +cuboid.Faces[1]:SetProperties(properties) +Inheritance +The ReferenceDirection object is derived from the CompositeValue object. +Usage locations +The ReferenceDirection object can be accessed from the following locations: +• Properties +◦ MeshCurvilinearTriangleFace object has property CharacterisedSurfaceReferenceDirection. +◦ MeshTriangleFace object has property CharacterisedSurfaceReferenceDirection. +◦ MeshPlate object has property CharacterisedSurfaceReferenceDirection. +◦ Face object has property CharacterisedSurfaceReferenceDirection. +• Methods +◦ ReferenceDirectionList object has method Append(). +◦ ReferenceDirectionList object has method Get(number). +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property List +End +Start +The end coordinates. (Read/Write GlobalCoordinates) +The start coordinates. (Read/Write GlobalCoordinates) +p.1725 +Property Details +End +The end coordinates. +Type +GlobalCoordinates +Access +Read/Write +The start coordinates. +Type +GlobalCoordinates +Access +Read/Write +Start +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReferenceDirectionList +A list of ReferenceDirection items. +Method List +Append () +p.1726 +Appends a new item to the list. (Returns a ReferenceDirection object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a ReferenceDirection object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +ReferenceDirection +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +ReferenceDirection +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Region +A geometry region entity. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create geometry which contains regions +project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +project.Contents.Geometry:AddSphere(cf.Point(0.5, 0.5, 0.5), 1) +union = project.Contents.Geometry:Union() + -- Set the local mesh size of first region of the union +union.Regions[1].LocalMeshSize = 0.1 +Inheritance +The Region object is derived from the TopologyEntity object. +Usage locations +The Region object can be accessed from the following locations: +• Properties +• Methods +◦ RegionCollection collection has method Item(number). +◦ RegionCollection collection has method Item(string). +Property List +BasisFunctionSettings +Local basis function solver settings for the region. Only applies if the SolutionMethod is set to SEP. +(Read/Write BasisFunctionLocalSolverSettings) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CentreOfGravity +A point indicating the centre of gravity of this entity. (Read only Point) +DefinitionMethod +The definition method for the 3D anisotropic reference direction. (Read/Write +RegionDefinitionMethodEnum) +Faulty +Indicates whether the geometry entity has faults. (Read only boolean) +Geometry +The geometry operator that the region belongs to. (Read only Geometry) +Label +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +LocalMeshSize +p.1729 +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. (Read/Write ParametricExpression) +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. (Read/Write boolean) +Medium +The region medium. (Read/Write Medium) +ReferenceWorkplane +The workplane for the 3D anisotropic reference direction. (Read/Write Workplane) +SolutionMedium +The local solution method used for the region. (Read only Medium) +SolutionMethod +The local solution method used for the region. (Read/Write RegionSolutionMethodEnum) +Type +The object type string. (Read only string) +UTDCylinder +The cylinder region's uniform theory of diffraction (UTD) solution settings. Only applies if the +SolutionMethod is set to UTD. (Read/Write UTDCylinderTerminationType) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BasisFunctionSettings +Local basis function solver settings for the region. Only applies if the SolutionMethod is set to SEP. +Type +BasisFunctionLocalSolverSettings +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CentreOfGravity +A point indicating the centre of gravity of this entity. +Type +Point +Access +Read only +DefinitionMethod +The definition method for the 3D anisotropic reference direction. +Type +RegionDefinitionMethodEnum +Access +Read/Write +Faulty +Indicates whether the geometry entity has faults. +Type +boolean +Access +Read only +Geometry +The geometry operator that the region belongs to. +Type +Geometry +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSize +The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to +true. +Type +ParametricExpression +Access +Read/Write +LocalMeshSizeEnabled +Specifies if the local mesh size should be used for the wire/edge. +Type +boolean +Access +Read/Write +Medium +The region medium. +Type +Medium +Access +Read/Write +ReferenceWorkplane +The workplane for the 3D anisotropic reference direction. +Type +Workplane +Access +Read/Write +SolutionMedium +The local solution method used for the region. +Type +Medium +Access +Read only +SolutionMethod +The local solution method used for the region. +Type +RegionSolutionMethodEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +UTDCylinder +The cylinder region's uniform theory of diffraction (UTD) solution settings. Only applies if the +SolutionMethod is set to UTD. +Type +UTDCylinderTerminationType +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.1733 +RemoveSmallFeaturesSettings +A settings object for removing small geometry features. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Get the settings for removing small geometry features +smallFeatureSettings = project.Contents.Geometry.Repair.RemoveSmallFeaturesSettings + -- Get the setting for the size that determines which small features will be + removed +featureSize = smallFeatureSettings.SmallFeatureSize +Inheritance +The RemoveSmallFeaturesSettings object is derived from the Object object. +Usage locations +The RemoveSmallFeaturesSettings object can be accessed from the following locations: +• Properties +◦ GeometryRepair object has property RemoveSmallFeaturesSettings. +Property List +GashAspectBound +The maximum width to length ratio of any gash that is to be removed. Only valid if +RemoveGashesEnabled is true. (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +RemoveGashesEnabled +If this option is selected, gashes are removed. SmallFeatureSize for gashes is the maximum width +of any gash to be removed. (Read/Write boolean) +RemoveSliverFacesEnabled +If this option is selected, sliver faces are removed. SmallFeatureSize for sliver faces is defined as +the tolerance which is the width of the sliver face. (Read/Write boolean) +RemoveSmallEdgesEnabled +If this option is selected, small edges are removed. Small edges have a length less than specified +by SmallFeatureSize. (Read/Write boolean) +RemoveSmallFacesEnabled +If this option is selected, small faces are removed. A small face is any face that fits within a +sphere of a radius specified by SmallFeatureSize. (Read/Write boolean) +RemoveSpikesEnabled +If this option is selected, spikes are removed from the geometry part. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +RepairTolerantEdgesEnabled +p.1735 +This option specifies whether the healing of tolerant edges, created during the removal of narrow +features such as sliver faces, spikes and gashes, should be attempted. (Read/Write boolean) +SmallFeatureSize +This field specifies the radius of a sphere to be used to determine which small features will be +removed. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RestoreDefaults () +Restores all the settings to their default values. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +GashAspectBound +The maximum width to length ratio of any gash that is to be removed. Only valid if +RemoveGashesEnabled is true. +Type +ParametricExpression +Label +Access +Read/Write +The object label. +Type +string +Access +Read/Write +RemoveGashesEnabled +If this option is selected, gashes are removed. SmallFeatureSize for gashes is the maximum width +of any gash to be removed. +Type +boolean +Access +Read/Write +RemoveSliverFacesEnabled +If this option is selected, sliver faces are removed. SmallFeatureSize for sliver faces is defined as +the tolerance which is the width of the sliver face. +Type +boolean +Access +Read/Write +RemoveSmallEdgesEnabled +If this option is selected, small edges are removed. Small edges have a length less than specified +by SmallFeatureSize. +Type +boolean +Access +Read/Write +RemoveSmallFacesEnabled +If this option is selected, small faces are removed. A small face is any face that fits within a +sphere of a radius specified by SmallFeatureSize. +Type +boolean +Access +Read/Write +RemoveSpikesEnabled +If this option is selected, spikes are removed from the geometry part. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +RepairTolerantEdgesEnabled +p.1737 +This option specifies whether the healing of tolerant edges, created during the removal of narrow +features such as sliver faces, spikes and gashes, should be attempted. +Type +boolean +Access +Read/Write +SmallFeatureSize +This field specifies the radius of a sphere to be used to determine which small features will be +removed. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RestoreDefaults () +Restores all the settings to their default values. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1738 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +RepairAndSewFaces +Represents a geometry object that has been repaired and sewn. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +p.1739 +-- Add some geometry +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +flare = project.Contents.Geometry:AddFlare(cf.Point(0.5, 0.5, 1), 1, 1, 0.75, 0, 1) +-- Delete some faces +face9 = flare.Faces:Item("Face9") +face10 = flare.Faces:Item("Face10") +flare:DeleteFaces({face9, face10}) +project.Contents.Geometry.Repair:RepairAndSewFaces({cuboid, flare}) +Inheritance +The RepairAndSewFaces object is derived from the Geometry object. +Usage locations +The RepairAndSewFaces object can be accessed from the following locations: +• Methods +◦ GeometryRepair object has method RepairAndSewFaces(List of Geometry). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ChildReferences +The geometry items to be transformed. (Read/Write ObjectReferenceList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +The object type string. (Read only string) +Collection List +Children +The collection of child operators of the operator. (OperatorCollection of Geometry.) +The collection of edges of the operator. (EdgeCollection of Edge.) +Edges +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Explode () +p.1741 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ChildReferences +The geometry items to be transformed. +Type +ObjectReferenceList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Children +The collection of child operators of the operator. +Type +OperatorCollection +Edges +Faces +The collection of edges of the operator. +Type +EdgeCollection +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +p.1746 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +RepairAndSewFacesSettings +A settings object for repairing and sewing geometry faces. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Get the settings for repairing and sewing faces +repairFacesSettings = project.Contents.Geometry.Repair.RepairAndSewFacesSettings + -- Get the setting for the sew tolerance used for sewing the sheets +tolerance = repairFacesSettings.SewTolerance +Inheritance +The RepairAndSewFacesSettings object is derived from the Object object. +Usage locations +The RepairAndSewFacesSettings object can be accessed from the following locations: +• Properties +◦ GeometryRepair object has property RepairAndSewFacesSettings. +Property List +AngularTolerance +The tangent change angle in degrees above which G1 discontinuities will be removed by splitting +rather than smoothing. (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +ReplaceMissingGeometryEnabled +If this option is selected, the tool will attempt to generate surface geometry for faces that will cap +holes in the resulting body. (Read/Write boolean) +SewTolerance +The tolerance to be used when sewing the sheets. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1748 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RestoreDefaults () +Restores all the settings to their default values. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AngularTolerance +The tangent change angle in degrees above which G1 discontinuities will be removed by splitting +rather than smoothing. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +ReplaceMissingGeometryEnabled +If this option is selected, the tool will attempt to generate surface geometry for faces that will cap +holes in the resulting body. +Type +boolean +Access +Read/Write +SewTolerance +The tolerance to be used when sewing the sheets. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RestoreDefaults () +Restores all the settings to their default values. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +RepairEdgesSettings +A settings object for repairing geometry edges. +Example +p.1750 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Get the settings for repairing geometry edges +repairEdgesSettings = project.Contents.Geometry.Repair.RepairEdgesSettings + -- Get the setting for the linear tolerance used for repairing +tolerance = repairEdgesSettings.LinearTolerance +Inheritance +The RepairEdgesSettings object is derived from the Object object. +Usage locations +The RepairEdgesSettings object can be accessed from the following locations: +• Properties +◦ GeometryRepair object has property RepairEdgesSettings. +Property List +Label +The object label. (Read/Write string) +LinearTolerance +The linear tolerance used for repairing. (Read/Write ParametricExpression) +MergeEdgesEnabled +If this option is selected, any redundant edges or vertices will be removed. (Read/Write boolean) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +RestoreDefaults () +Restores all the settings to their default values. +SetProperties (properties Object) +p.1751 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +LinearTolerance +The linear tolerance used for repairing. +Type +ParametricExpression +Access +Read/Write +MergeEdgesEnabled +If this option is selected, any redundant edges or vertices will be removed. +Type +boolean +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.1752 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RestoreDefaults () +Restores all the settings to their default values. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +RepairPart +Represents a geometry object that has been repaired. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +p.1753 +-- Add some geometry +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +flare = project.Contents.Geometry:AddFlare(cf.Point(0.5, 0.5, 1), 1, 1, 0.75, 0, 1) +-- Delete some faces +face9 = flare.Faces:Item("Face9") +face10 = flare.Faces:Item("Face10") +flare:DeleteFaces({face9, face10}) +-- Repair parts +project.Contents.Geometry.Repair:RepairParts({cuboid, flare}) +Inheritance +The RepairPart object is derived from the Geometry object. +Usage locations +The RepairPart object can be accessed from the following locations: +• Methods +◦ GeometryRepair object has method RepairParts(List of Geometry). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ChildReferences +The geometry items to be transformed. (Read/Write ObjectReferenceList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +The object type string. (Read only string) +Collection List +Children +The collection of child operators of the operator. (OperatorCollection of Geometry.) +The collection of edges of the operator. (EdgeCollection of Edge.) +Edges +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Explode () +p.1755 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ChildReferences +The geometry items to be transformed. +Type +ObjectReferenceList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Children +The collection of child operators of the operator. +Type +OperatorCollection +Edges +Faces +The collection of edges of the operator. +Type +EdgeCollection +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +p.1760 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +RepairPartsSettings +A settings object for repairing geometry parts. +Example +p.1761 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Get the settings for repairing geometry parts +repairPartsSettings = project.Contents.Geometry.Repair.RepairPartsSettings + -- Get the setting for the upper bound on deviation between original and repaired + geometry +deviation = repairPartsSettings.DeviationUpperBound +Inheritance +The RepairPartsSettings object is derived from the Object object. +Usage locations +The RepairPartsSettings object can be accessed from the following locations: +• Properties +◦ GeometryRepair object has property RepairPartsSettings. +Property List +AdvancedSelfIntersectionRemovalEnabled +This option enables a more thorough self-intersection removal process. This property is only valid +if RemoveSelfIntersectionsEnabled is true. (Read/Write boolean) +DeviationUpperBound +The upper bound on deviation between original and repaired geometry. (Read/Write +ParametricExpression) +Label +The object label. (Read/Write string) +MaxSmallEdgeLength +The maximum length of small edges. This property is only valid if RemoveSmallEdgesEnabled is +true. (Read/Write ParametricExpression) +RemoveDiscontinuitiesEnabled +The option to remove discontinuities. (Read/Write boolean) +RemoveSelfIntersectionsEnabled +The option to remove self-intersections. (Read/Write boolean) +RemoveSmallEdgesEnabled +The option to remove small edges during the repair operation. (Read/Write boolean) +RepairBadFaceFaceErrorsEnabled +The option to repair bad face-face errors. (Read/Write boolean) +SimplifyGeometryDuringCleaningEnabled +The option to simplify geometry during repairing. (Read/Write boolean) +SimplifyPartSettings +The simplify part settings. These properties are only valid if +SimplifyGeometryDuringCleaningEnabled is true. (Read only SimplifyPartRepresentationSettings) +SimplifyToBlends +The options for simplifying surfaces to blends. (Read/Write SimplifyBlendTypeEnum) +SmootheningAngularTolerance +The angular tolerance for geometry smoothening (degrees). This property is only valid if +RemoveDiscontinuitiesEnabled is true. (Read/Write ParametricExpression) +SpecifiedEdgeRepairTolerance +The specified edge repair tolerance. This property is only valid if SpecifyEdgeToleranceEnabled is +true. (Read/Write ParametricExpression) +SpecifyEdgeToleranceEnabled +The option to specify an edge repair tolerance. (Read/Write boolean) +SuppressSurfaceModificationsEnabled +The option to suppress surface modifications. (Read/Write boolean) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RestoreDefaults () +Restores all the settings to their default values. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property Details +AdvancedSelfIntersectionRemovalEnabled +p.1763 +This option enables a more thorough self-intersection removal process. This property is only valid +if RemoveSelfIntersectionsEnabled is true. +Type +boolean +Access +Read/Write +DeviationUpperBound +The upper bound on deviation between original and repaired geometry. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MaxSmallEdgeLength +The maximum length of small edges. This property is only valid if RemoveSmallEdgesEnabled is +true. +Type +ParametricExpression +Access +Read/Write +RemoveDiscontinuitiesEnabled +The option to remove discontinuities. +Type +boolean +Access +Read/Write +RemoveSelfIntersectionsEnabled +The option to remove self-intersections. +Type +boolean +Access +Read/Write +RemoveSmallEdgesEnabled +The option to remove small edges during the repair operation. +Type +boolean +Access +Read/Write +RepairBadFaceFaceErrorsEnabled +The option to repair bad face-face errors. +Type +boolean +Access +Read/Write +SimplifyGeometryDuringCleaningEnabled +The option to simplify geometry during repairing. +Type +boolean +Access +Read/Write +SimplifyPartSettings +The simplify part settings. These properties are only valid if +SimplifyGeometryDuringCleaningEnabled is true. +Type +SimplifyPartRepresentationSettings +Access +Read only +SimplifyToBlends +The options for simplifying surfaces to blends. +Type +SimplifyBlendTypeEnum +Access +Read/Write +SmootheningAngularTolerance +The angular tolerance for geometry smoothening (degrees). This property is only valid if +RemoveDiscontinuitiesEnabled is true. +Type +ParametricExpression +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read/Write +SpecifiedEdgeRepairTolerance +p.1765 +The specified edge repair tolerance. This property is only valid if SpecifyEdgeToleranceEnabled is +true. +Type +ParametricExpression +Access +Read/Write +SpecifyEdgeToleranceEnabled +The option to specify an edge repair tolerance. +Type +boolean +Access +Read/Write +SuppressSurfaceModificationsEnabled +The option to suppress surface modifications. +Type +boolean +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1766 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RestoreDefaults () +Restores all the settings to their default values. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Resistor +A cable resistor component. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a 1k Ohm resistor +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +terminal1 = cableHarness.Connectors["CableConnector2"].Pins["Pin2"].Terminal +terminal2 = cableHarness.Connectors["CableConnector2"].Pins["Pin1"].Terminal +resistor = cableHarness.CableSchematic.Components:AddResistor(terminal1, + terminal2, 1e3) + -- Change the resistor's resistance +cableHarness.CableSchematic.Components["R1"].Resistance = 500 +Inheritance +The Resistor object is derived from the Object object. +Usage locations +The Resistor object can be accessed from the following locations: +• Methods +◦ CableSchematicComponentCollection collection has method AddResistor(). +◦ CableSchematicComponentCollection collection has method AddResistor(table). +◦ CableSchematicComponentCollection collection has method AddResistor(Terminal, Terminal, +Expression). +Property List +CurrentProbeEnabled +True if a current probe must be applied to the component. (Read/Write boolean) +Label +The object label. (Read/Write string) +Resistance +The resistance of the resistor in Ohm. (Read/Write ParametricExpression) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +VoltageProbeEnabled +True if a current probe must be applied to the component. (Read/Write boolean) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CurrentProbeEnabled +True if a current probe must be applied to the component. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Resistance +The resistance of the resistor in Ohm. +Type +ParametricExpression +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VoltageProbeEnabled +True if a current probe must be applied to the component. +Type +boolean +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Ring +A ring. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a ring at the specified 'Point' +centre = cf.Point(-0.25, -0.25, 0) +ring = project.Contents.Geometry:AddRing(centre, 1.5, 1.2) +Inheritance +The Ring object is derived from the Geometry object. +The following objects are derived (specialisations) from the Ring object: +• OpenRing +Usage locations +The Ring object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddRing(table). +◦ GeometryCollection collection has method AddRing(Point, Expression, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The ring centre point. (Read/Write LocalCoordinate) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +InnerRadius +The ring inner radius. (Read/Write Dimension) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Altair Feko 2022.3 +2 Application Programming Interface (API) +OuterRadius +The ring outer radius. (Read/Write Dimension) +Parent +p.1773 +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Explode () +p.1774 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +The ring centre point. +Type +LocalCoordinate +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +InnerRadius +The ring inner radius. +Type +Dimension +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +OuterRadius +The ring outer radius. +Type +Dimension +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method Details +ConvertToPrimitive () +p.1777 +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +RingShape +A ring shape. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a ring shape +ring = project.Definitions.PeriodicStructures.Shapes:AddRing(1.5, 1.2) +Inheritance +The RingShape object is derived from the Shape object. +The following objects are derived (specialisations) from the RingShape object: +• OpenRingShape +Usage locations +The RingShape object can be accessed from the following locations: +• Methods +◦ ShapeCollection collection has method AddRing(table). +◦ ShapeCollection collection has method AddRing(Expression, Expression). +Property List +InnerRadius +The ring inner radius. (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +OuterRadius +The ring outer radius. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +BuildGeometry () +Creates the full geometry representation of the shape. (Returns a Geometry object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1782 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +InnerRadius +The ring inner radius. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +OuterRadius +The ring outer radius. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +BuildGeometry () +Creates the full geometry representation of the shape. +Return +Geometry +The shape geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Rotate +A rotate transform. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a flare to rotate +flare = project.Contents.Geometry:AddFlare(cf.Point(0, 0, 0), 1, 1, 1, 0.5, 0.5) + -- Set up the origin and axis of rotation +rotationOrigin = cf.Point(3, 1, 1) +rotationAxis = cf.Point(1, 2, 0) + -- Rotate the flare by 25 degrees +rotate = flare.Transforms:AddRotate(rotationOrigin, rotationAxis, 25) + -- Modify the rotation angle +rotate.Angle = 65 +Inheritance +The Rotate object is derived from the Transform object. +Usage locations +The Rotate object can be accessed from the following locations: +• Methods +◦ TransformCollection collection has method AddRotate(Point, Vector, Expression). +◦ TransformCollection collection has method AddRotate(table). +Property List +Angle +Axis +Label +The rotation angle (degrees). (Read/Write AngularDimension) +The axis of rotation. (Read/Write LocalVector) +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Origin +The coordinates of the origin of the rotation. (Read/Write LocalCoordinate) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Collection List +Transforms +p.1785 +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Angle +The rotation angle (degrees). +Type +AngularDimension +Access +Read/Write +Axis +The axis of rotation. +Type +LocalVector +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Origin +The coordinates of the origin of the rotation. +Type +LocalCoordinate +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SAR +A SAR request. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a SAR request +configuration = project.Contents.SolutionConfigurations[1] +SARRequest = configuration.SAR:Add() +Inheritance +The SAR object is derived from the Object object. +Usage locations +The SAR object can be accessed from the following locations: +• Properties +◦ SAROptimisationGoal object has property FocusSource. +• Methods +◦ SARCollection collection has method Add(). +◦ SARCollection collection has method Add(table). +◦ SARCollection collection has method Item(number). +◦ SARCollection collection has method Item(string). +Property List +CalculationType +The SAR calculation type. (Read/Write SARCalculationTypeEnum) +Label +The object label. (Read/Write string) +LayerSelection +Specifies if all layers or a specific layer should be used for the SAR calculation when when the +'RegionType' is 'Substrate'. (Read/Write SARSubstrateLayerSelectEnum) +MediaSelection +Specifies if all media or a specific medium should be used for the SAR calculation when when the +'RegionType' is 'Medium'. (Read/Write SARMediumSelectEnum) +RegionType +The region over which to calculate the SAR. (Read/Write SARRegionTypeEnum) +SpecifiedMedium +Specifies the medium to use for the SAR calculation when 'MediaSelection' is 'Specified'. (Read/ +Write Medium) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SpecifiedPosition +p.1791 +Specifies the position to use for the SAR calculation when the 'RegionType' is 'Position'. (Read/ +Write GlobalCoordinates) +SubstrateLayer +The substrate layer to use when the 'RegionType' is 'Substrate'. (Read/Write +ParametricExpression) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CalculationType +The SAR calculation type. +Type +SARCalculationTypeEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +LayerSelection +p.1792 +Specifies if all layers or a specific layer should be used for the SAR calculation when when the +'RegionType' is 'Substrate'. +Type +SARSubstrateLayerSelectEnum +Access +Read/Write +MediaSelection +Specifies if all media or a specific medium should be used for the SAR calculation when when the +'RegionType' is 'Medium'. +Type +SARMediumSelectEnum +Access +Read/Write +RegionType +The region over which to calculate the SAR. +Type +SARRegionTypeEnum +Access +Read/Write +SpecifiedMedium +Specifies the medium to use for the SAR calculation when 'MediaSelection' is 'Specified'. +Type +Medium +Access +Read/Write +SpecifiedPosition +Specifies the position to use for the SAR calculation when the 'RegionType' is 'Position'. +Type +GlobalCoordinates +Access +Read/Write +SubstrateLayer +The substrate layer to use when the 'RegionType' is 'Substrate'. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SAROptimisationGoal +A SAR optimisation goal. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +search = + project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) + -- Create a SAR optimisation goal with focus on a request with label "SARRequest" +properties = cf.SAROptimisationGoal.GetDefaultProperties() +properties.FocusSourceLabel = "SARRequest" +properties.FocusSourceType + = cf.Enums.OptimisationFocusSourceTypeEnum.FocusSourceByLabel +properties.GoalOperator = cf.Enums.OptimisationGoalOperatorEnum.Maximise +properties.ProcessingSteps[1].Operation + = cf.Enums.OptimisationGoalProcessingStepsEnum.Offset +properties.ProcessingSteps[1].Value = "1" +sarGoal = search.Goals:AddSARGoal(properties) + -- Change the first processing step offset value to 10 +sarGoal.ProcessingSteps[1].Value = 10 +Inheritance +The SAROptimisationGoal object is derived from the OptimisationGoal object. +Usage locations +The SAROptimisationGoal object can be accessed from the following locations: +• Methods +◦ OptimisationGoalCollection collection has method AddSARGoal(table). +Property List +FocusSource +Set the focus source to a specified source object. The intended usage is for when the source is +defined in CADFEKO. (Read/Write SAR) +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. (Read/Write string) +FocusType +Set the focus type. (Read/Write OptimisationSARFocusTypeEnum) +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +(Read/Write OptimisationGoalOperatorEnum) +Label +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Objective +p.1795 +The objective describes a state that the optimisation process should attempt to achieve. (Read +only OptimisationGoalObjective) +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. (Read/Write OptimisationGoalProcessingStepsList) +Type +The object type string. (Read only string) +Weight +Specify the optimisation weight. (Read/Write ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +FocusSource +Set the focus source to a specified source object. The intended usage is for when the source is +defined in CADFEKO. +Type +SAR +Access +Read/Write +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. +Type +string +Access +Read/Write +FocusType +Set the focus type. +Type +OptimisationSARFocusTypeEnum +Access +Read/Write +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +Type +OptimisationGoalOperatorEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Objective +The objective describes a state that the optimisation process should attempt to achieve. +Type +OptimisationGoalObjective +Access +Read only +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. +Type +OptimisationGoalProcessingStepsList +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Weight +Specify the optimisation weight. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SParameter +A solution S-parameter request. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a line and a wire port at the start of the line +line = project.Contents.Geometry:AddLine(cf.Point(0,0,0), cf.Point(1,1,0)) +port1 = project.Contents.Ports:AddWirePort(line.Wires[1]) + -- Add an S-parameters calculation request for the wire port +SParameterConfiguration = + project.Contents.SolutionConfigurations:AddMultiportSParameter({port1}) + -- Add a port to the S-parameters calculation +port2 = project.Contents.Ports:AddWirePort(line.Wires[1]) +port2.Location = cf.Enums.WirePortLocationEnum.End +SParametersRequest = SParameterConfiguration.SParameter +portProperties = SParametersRequest.PortProperties:append() +portProperties.Terminal = port2 +portProperties.Impedance = 60 +portProperties.Active = true +Inheritance +The SParameter object is derived from the Object object. +Usage locations +The SParameter object can be accessed from the following locations: +• Properties +◦ SParameterConfiguration object has property SParameter. +Property List +Label +The object label. (Read/Write string) +LoadsRestored +Specifies if the loads are restored after calculation. (Read/Write boolean) +MultiportPackageGenerationEnabled +Enable the generation of multiport package files. (Read/Write boolean) +PortProperties +The collection of port properties for the S-parameter request. (Read/Write PortPropertiesList) +TouchstoneExportEnabled +Specifies if the S-parameters should be exported to a Touchstone (*.snp) file. (Read/Write +boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.1799 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +LoadsRestored +Specifies if the loads are restored after calculation. +Type +boolean +Access +Read/Write +MultiportPackageGenerationEnabled +Enable the generation of multiport package files. +Type +boolean +Access +Read/Write +PortProperties +The collection of port properties for the S-parameter request. +Type +PortPropertiesList +Access +Read/Write +TouchstoneExportEnabled +Specifies if the S-parameters should be exported to a Touchstone (*.snp) file. +Type +boolean +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SParameterConfiguration +An S-parameter configuration. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a line and attach a wire port to it +p.1802 +line = project.Contents.Geometry:AddLine(cf.Point(0,0,0), cf.Point(0,0,1)) +wirePort = project.Contents.Ports:AddWirePort(line.Wires[1]) + -- Add an S-parameter configuration +SParameterConfiguration = + project.Contents.SolutionConfigurations:AddMultiportSParameter({wirePort}) +Inheritance +The SParameterConfiguration object is derived from the SolutionConfiguration object. +Usage locations +The SParameterConfiguration object can be accessed from the following locations: +• Methods +◦ SolutionConfigurationCollection collection has method AddMultiportSParameter(List of Port). +Property List +Frequency +The configuration solution frequency. (Read only Frequency) +Label +The object label. (Read/Write string) +SParameter +The configuration solution S-parameter. (Read only SParameter) +Type +The object type string. (Read only string) +Collection List +Loads +The collection of loads in the configuration. (LoadCollection of Load.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1803 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Frequency +The configuration solution frequency. +Type +Frequency +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +SParameter +The configuration solution S-parameter. +Type +SParameter +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Loads +The collection of loads in the configuration. +Type +LoadCollection +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SParameterOptimisationGoal +An S-parameter optimisation goal. +Example +p.1805 +application = cf.Application.GetInstance() +project = application:NewProject() +search = + project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) + -- Create an S-parameter optimisation goal with focus on a request with label + 'SParameter' +properties = cf.SParameterOptimisationGoal.GetDefaultProperties() +properties.FocusSourceLabel = "SParameter" +properties.FocusSourceType + = cf.Enums.OptimisationFocusSourceTypeEnum.FocusSourceByLabel +properties.GoalOperator = cf.Enums.OptimisationGoalOperatorEnum.LessThan +properties.InputPort = 2 +properties.Objective.TargetValue = "1.5" +properties.ProcessingSteps[1].Operation + = cf.Enums.OptimisationGoalProcessingStepsEnum.Magnitude +sParameterGoal = search.Goals:AddSParameterGoal(properties) + -- Set the output port number to 1 +sParameterGoal.OutputPortSpecified = true +sParameterGoal.OutputPort = 1 +Inheritance +The SParameterOptimisationGoal object is derived from the OptimisationGoal object. +Usage locations +The SParameterOptimisationGoal object can be accessed from the following locations: +• Methods +◦ OptimisationGoalCollection collection has method AddSParameterGoal(table). +Property List +FocusSource +Set the focus source to a specified source object. The intended usage is for when the source is +defined in CADFEKO. (Read/Write Object) +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. (Read/Write string) +FocusType +Set the focus type. (Read/Write OptimisationSParameterFocusTypeEnum) +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +(Read/Write OptimisationGoalOperatorEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +InputPort +p.1806 +Input port number (n). Changing this property will set InputPortSpecified to true. (Read/Write +number) +InputPortSpecified +Specify input port enabled. (Read/Write boolean) +Label +The object label. (Read/Write string) +Objective +The objective describes a state that the optimisation process should attempt to achieve. (Read +only OptimisationGoalObjective) +OutputPort +Output port number (m). Changing this property will set OutputPortSpecified to true. (Read/Write +number) +OutputPortSpecified +Specify output port enabled. (Read/Write boolean) +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. (Read/Write OptimisationGoalProcessingStepsList) +Type +The object type string. (Read only string) +Weight +Specify the optimisation weight. (Read/Write ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +FocusSource +Set the focus source to a specified source object. The intended usage is for when the source is +defined in CADFEKO. +Type +Object +Access +Read/Write +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. +Type +string +Access +Read/Write +FocusType +Set the focus type. +Type +OptimisationSParameterFocusTypeEnum +Access +Read/Write +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +Type +OptimisationGoalOperatorEnum +Access +Read/Write +InputPort +Input port number (n). Changing this property will set InputPortSpecified to true. +Type +number +Access +Read/Write +InputPortSpecified +Specify input port enabled. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Objective +The objective describes a state that the optimisation process should attempt to achieve. +Type +OptimisationGoalObjective +Access +Read only +OutputPort +Output port number (m). Changing this property will set OutputPortSpecified to true. +Type +number +Access +Read/Write +OutputPortSpecified +Specify output port enabled. +Type +boolean +Access +Read/Write +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. +Type +OptimisationGoalProcessingStepsList +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Weight +Specify the optimisation weight. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Scale +A scale transformation. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a flare to scale +flare = project.Contents.Geometry:AddFlare(cf.Point(0, 0, 0), 1, 1, 1, 0.5, 0.5) + -- Scale the flare by a factor of 2.5 at the origin +scale = flare.Transforms:AddScale(cf.Point(0, 0, 0), 2.5) + -- Modify the scale factor +scale.Factor = 1.75 +Inheritance +The Scale object is derived from the Transform object. +Usage locations +The Scale object can be accessed from the following locations: +• Methods +◦ TransformCollection collection has method AddScale(Point, Expression). +◦ TransformCollection collection has method AddScale(table). +Property List +Factor +The factor to scale by. (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Origin +The coordinates of the origin of the scale transform. (Read/Write GlobalCoordinates) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method List +CopyAndMirror (properties table) +p.1811 +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Factor +The factor to scale by. +Type +ParametricExpression +Label +Access +Read/Write +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Origin +The coordinates of the origin of the scale transform. +Type +GlobalCoordinates +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Schematic +A schematic. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Obtain a 'Schematic' object +application.MainWindow.MdiArea:CreateGeneralNetworkSchematicView() +schematic = application.MainWindow.MdiArea:Item(1) + -- Close the schematic +application.MainWindow.MdiArea:CloseWindow(schematic) +Inheritance +The Schematic object is derived from the Object object. +Usage locations +The Schematic object can be accessed from the following locations: +• Properties +◦ Capacitor object has property Schematic. +◦ Ground object has property Schematic. +◦ Resistor object has property Schematic. +◦ CableConnector object has property Schematic. +◦ CableGeneralNetwork object has property Schematic. +◦ CableSchematicCurrentProbe object has property Schematic. +◦ CableSchematicVoltageProbe object has property Schematic. +◦ CableSpiceNetwork object has property Schematic. +◦ ComplexLoad object has property Schematic. +◦ +Inductor object has property Schematic. +◦ Transformer object has property Schematic. +◦ VoltageControlledVoltageSource object has property Schematic. +◦ CablePort object has property Schematic. +◦ EdgeMeshPort object has property Schematic. +◦ EdgePort object has property Schematic. +◦ AbstractFEMLinePort object has property Schematic. +◦ FEMLineMeshPort object has property Schematic. +◦ FEMLinePort object has property Schematic. +◦ MicrostripMeshPort object has property Schematic. +◦ WireMeshPort object has property Schematic. +◦ MicrostripPort object has property Schematic. +◦ WirePort object has property Schematic. +◦ GeneralNetwork object has property Schematic. +◦ TransmissionLine object has property Schematic. +Property List +Label +The object label. (Read/Write string) +SchematicItems +The list of schematic components on the schematic. (Read only List of Object) +Type +The object type string. (Read only string) +Collection List +Nets +The nets on the schematic. (NetCollection of Net.) +Terminals +The collection of terminals on the schematic. (TerminalCollection of Terminal.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +MoveItems (schematicItems List of Object, offset GridLocation) +Moves the given list of items on the schematic by the offset provided. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +SchematicItems +The list of schematic components on the schematic. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Nets +The nets on the schematic. +Type +NetCollection +Terminals +The collection of terminals on the schematic. +Type +TerminalCollection +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +MoveItems (schematicItems List of Object, offset GridLocation) +Moves the given list of items on the schematic by the offset provided. +Input Parameters +schematicItems(List of Object) +List of schematic components to move on the schematic. +offset(GridLocation) +The offset the items should be moved. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SchematicViewWindow +A schematic view window. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Obtain a 'Schematic' object +application.MainWindow.MdiArea:CreateGeneralNetworkSchematicView() +schematic = application.MainWindow.MdiArea:Item(1) + -- Close the schematic +application.MainWindow.MdiArea:CloseWindow(schematic) +Inheritance +The SchematicViewWindow object is derived from the Object object. +Property List +Height +The height of the window. (Read/Write number) +Label +Type +Width +The object label. (Read/Write string) +The object type string. (Read only string) +The width of the window. (Read/Write number) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +PanDown () +Pans the view down. +PanLeft () +Pans the view left. +PanRight () +Pans the view right. +PanUp () +Pans the view up. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +ZoomIn () +Zooms the view in. +ZoomOut () +Zooms the view out. +ZoomToExtents () +Zooms to the extents of the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Height +The height of the window. +Type +number +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Width +The width of the window. +Type +number +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +PanDown () +Pans the view down. +PanLeft () +Pans the view left. +PanRight () +Pans the view right. +PanUp () +Pans the view up. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +ZoomIn () +Zooms the view in. +ZoomOut () +Zooms the view out. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ZoomToExtents () +Zooms to the extents of the schematic. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.1822 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ScopeSettings +p.1823 +Limits the field calculation to only use the sources on the specified elements. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +farFieldRequest = + project.Contents.SolutionConfigurations[1].FarFields:Add(0,0,90,180,30,60) + -- Get the 'ScopeSettings' of the farFiledRequest +scopeSettings = farFieldRequest.ScopeSettings + -- Get the CalculationScope of the farField, should be All +calculationScope = scopeSettings.CalculationScope +Inheritance +The ScopeSettings object is derived from the CompositeValue object. +Usage locations +The ScopeSettings object can be accessed from the following locations: +• Properties +◦ FarField object has property ScopeSettings. +◦ NearField object has property ScopeSettings. +• Methods +◦ ScopeSettingsList object has method Append(). +◦ ScopeSettingsList object has method Get(number). +Property List +CalculationScope +Control which type of elements should be considered for the field calculation. (Read/Write +FieldCalculationScopeTypeEnum) +ScopedEntities +he field calculation will only use sources on the specified entities. (Read/Write +ObjectReferenceList) +Property Details +CalculationScope +Control which type of elements should be considered for the field calculation. +Type +FieldCalculationScopeTypeEnum +Access +Read/Write +ScopedEntities +he field calculation will only use sources on the specified entities. +Type +ObjectReferenceList +Access +Read/Write +ScopeSettingsList +A list of ScopeSettings items. +Method List +Append () +Appends a new item to the list. (Returns a ScopeSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a ScopeSettings object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +ScopeSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +ScopeSettings +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Shape +A shape object. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a cross shape +cross = project.Definitions.PeriodicStructures.Shapes:AddCross(1.5, 1.2, 0.5) +-- Build geometry for the cross shape +cross:BuildGeometry() +Inheritance +The Shape object is derived from the Object object. +The following objects are derived (specialisations) from the Shape object: +• CrossShape +• EllipseShape +• HexagonShape +• PlaneShape +• RingShape +• SpiralCrossShape +• TCrossShape +• TrifilarShape +Usage locations +The Shape object can be accessed from the following locations: +• Properties +◦ UnitCellLayer object has property Shape. +• Methods +◦ ShapeCollection collection has method Item(number). +◦ ShapeCollection collection has method Item(string). +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +BuildGeometry () +Creates the full geometry representation of the shape. (Returns a Geometry object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +BuildGeometry () +Creates the full geometry representation of the shape. +Return +Geometry +The shape geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ShieldLayerSettings +The shield layer settings. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a double layer solid shield +shield = + project.Definitions.Cables.Shields:AddSingleLayerSolidShield(project.Definitions.Media.PerfectElectricConductor, 0.0005) + -- Modify the shield thickness +innerLayerSettings = shield.InnerLayer +innerLayerSettings.ShieldThickness = 0.003 +Inheritance +The ShieldLayerSettings object is derived from the CompositeValue object. +Usage locations +The ShieldLayerSettings object can be accessed from the following locations: +• Properties +◦ CableShield object has property InnerLayer. +◦ CableShield object has property OuterLayer. +• Methods +◦ ShieldLayerSettingsList object has method Append(). +◦ ShieldLayerSettingsList object has method Get(number). +Property List +AdmittanceDefinitionMethod +The shield admittance definition method. (Read/Write CableShieldAdmittanceDefinitionEnum) +BraidFixingMaterialApplied +True if a braid-fixing material is used. Only applies when the ImpedanceDefinitionMethod is +BraidedKley. (Read/Write boolean) +FilamentDiameter +The filament diameter. Only applies when the ImpedanceDefinitionMethod is BraidedKley, +BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write ParametricExpression) +FilamentMedium +The filament medium. Only applies when the ImpedanceDefinitionMethod is BraidedKley, +BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write Medium) +ImpedanceDefinitionMethod +The shield impedance definition method. (Read/Write CableShieldDefinitionEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +InsideBraidFixingMedium +p.1831 +The inside braid-fixing material. Only applies when the BraidFixingMaterialApplied is true and +when the ImpedanceDefinitionMethod is BraidedKley. (Read/Write Medium) +MinimumOpticalCoverage +The minimum optical coverage (%). Only applies when the ImpedanceDefinitionMethod is +BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write ParametricExpression) +NumberOfCarriers +The number of carriers in the braided weave. Only applies when the ImpedanceDefinitionMethod +is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write +ParametricExpression) +NumberOfFilaments +The number of filaments in the braided weave. Only applies when the ImpedanceDefinitionMethod +is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write +ParametricExpression) +OutsideBraidFixingMedium +The outside braid-fixing material. Only applies when the BraidFixingMaterialApplied is true and +when the ImpedanceDefinitionMethod is BraidedKley. (Read/Write Medium) +ShieldMedium +The shield medium. Only applies if the ImpedanceDefinitionMethod property is Solid or when both +the ImpedanceDefinitionMethod is Custom and the SurfaceImpedanceFrequencyPropertiesSource +is SolidMetal. (Read/Write Medium) +ShieldThickness +The shield thickness. Only applies if the ImpedanceDefinitionMethod property is Solid or Custom. +(Read/Write ParametricExpression) +SurfaceImpedanceFrequencyPropertiesFile +The Surface impedance frequency dependent properties file name. Only applies when the +ImpedanceDefinitionMethod is Custom and the SurfaceImpedanceFrequencyPropertiesSource is +FromFile. (Read/Write FileReference) +SurfaceImpedanceFrequencyPropertiesSource +The surface impedance frequency dependent properties source. Only +applies when the ImpedanceDefinitionMethod is Custom. (Read/Write +CableShieldSurfaceImpedanceFrequencyDefinitionSourceEnum) +SurfaceImpedanceInterpolationMethod +The surface impedance interpolation method. Only applies when the ImpedanceDefinitionMethod +is Custom and SurfaceImpedanceFrequencyPropertiesSource is FromFile or SpecifyManually. +(Read/Write CableShieldInterpolationMethodEnum) +TransferAdmittanceFrequencyPropertiesFile +The transfer admittance frequency dependent properties file name. Only applies when the +AdmittanceDefinitionMethod is Custom and the TransferAdmittanceFrequencyPropertiesSource is +FromFile. (Read/Write FileReference) +TransferAdmittanceFrequencyPropertiesSource +The transfer admittance frequency dependent properties source. Only +applies when the AdmittanceDefinitionMethod is Custom. (Read/Write +CableShieldTransferAdmittanceFrequencyDefinitionSourceEnum) +TransferAdmittanceInterpolationMethod +The transfer admittance interpolation method. Only applies when the AdmittanceDefinitionMethod +is Custom. (Read/Write CableShieldInterpolationMethodEnum) +TransferCapacitance +The transfer capacitance. Only applies when the AdmittanceDefinitionMethod is +TransferCapacitance. (Read/Write ParametricExpression) +TransferImpedanceFrequencyPropertiesFile +The transfer impedance frequency dependent properties file name. Only applies when the +ImpedanceDefinitionMethod is Custom and the TransferImpedanceFrequencyPropertiesSource is +FromFile. (Read/Write FileReference) +TransferImpedanceFrequencyPropertiesSource +The transfer impedance frequency dependent properties source. Only +applies when the ImpedanceDefinitionMethod is Custom. (Read/Write +CableShieldTransferImpedanceFrequencyDefinitionSourceEnum) +TransferImpedanceInterpolationMethod +The transfer impedance interpolation method. Only applies when the ImpedanceDefinitionMethod +is Custom. (Read/Write CableShieldInterpolationMethodEnum) +WeaveAngle +The braided weave angle. Only applies when the ImpedanceDefinitionMethod is BraidedKley, +BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write ParametricExpression) +WeaveAngleDeviation +The deviation allowed for the braided weave angle. Only applies when the +ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. +(Read/Write ParametricExpression) +WeaveDefinitionMethod +The weave definition method. Only applies when the ImpedanceDefinitionMethod +is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. (Read/Write +CableShieldWeaveDefinitionMethodEnum) +Property Details +AdmittanceDefinitionMethod +The shield admittance definition method. +Type +CableShieldAdmittanceDefinitionEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +BraidFixingMaterialApplied +p.1833 +True if a braid-fixing material is used. Only applies when the ImpedanceDefinitionMethod is +BraidedKley. +Type +boolean +Access +Read/Write +FilamentDiameter +The filament diameter. Only applies when the ImpedanceDefinitionMethod is BraidedKley, +BraidedVance, BraidedDemoulin or BraidedTyni. +Type +ParametricExpression +Access +Read/Write +FilamentMedium +The filament medium. Only applies when the ImpedanceDefinitionMethod is BraidedKley, +BraidedVance, BraidedDemoulin or BraidedTyni. +Type +Medium +Access +Read/Write +ImpedanceDefinitionMethod +The shield impedance definition method. +Type +CableShieldDefinitionEnum +Access +Read/Write +InsideBraidFixingMedium +The inside braid-fixing material. Only applies when the BraidFixingMaterialApplied is true and +when the ImpedanceDefinitionMethod is BraidedKley. +Type +Medium +Access +Read/Write +MinimumOpticalCoverage +The minimum optical coverage (%). Only applies when the ImpedanceDefinitionMethod is +BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. +Type +ParametricExpression +Access +Read/Write +NumberOfCarriers +The number of carriers in the braided weave. Only applies when the ImpedanceDefinitionMethod +is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. +Type +ParametricExpression +Access +Read/Write +NumberOfFilaments +The number of filaments in the braided weave. Only applies when the ImpedanceDefinitionMethod +is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. +Type +ParametricExpression +Access +Read/Write +OutsideBraidFixingMedium +The outside braid-fixing material. Only applies when the BraidFixingMaterialApplied is true and +when the ImpedanceDefinitionMethod is BraidedKley. +Type +Medium +Access +Read/Write +ShieldMedium +The shield medium. Only applies if the ImpedanceDefinitionMethod property is Solid or when both +the ImpedanceDefinitionMethod is Custom and the SurfaceImpedanceFrequencyPropertiesSource +is SolidMetal. +Type +Medium +Access +Read/Write +ShieldThickness +The shield thickness. Only applies if the ImpedanceDefinitionMethod property is Solid or Custom. +Type +ParametricExpression +Access +Read/Write +SurfaceImpedanceFrequencyPropertiesFile +The Surface impedance frequency dependent properties file name. Only applies when the +ImpedanceDefinitionMethod is Custom and the SurfaceImpedanceFrequencyPropertiesSource is +FromFile. +Type +FileReference +Access +Read/Write +SurfaceImpedanceFrequencyPropertiesSource +The surface impedance frequency dependent properties source. Only applies when the +ImpedanceDefinitionMethod is Custom. +Type +CableShieldSurfaceImpedanceFrequencyDefinitionSourceEnum +Access +Read/Write +SurfaceImpedanceInterpolationMethod +The surface impedance interpolation method. Only applies when the ImpedanceDefinitionMethod +is Custom and SurfaceImpedanceFrequencyPropertiesSource is FromFile or SpecifyManually. +Type +CableShieldInterpolationMethodEnum +Access +Read/Write +TransferAdmittanceFrequencyPropertiesFile +The transfer admittance frequency dependent properties file name. Only applies when the +AdmittanceDefinitionMethod is Custom and the TransferAdmittanceFrequencyPropertiesSource is +FromFile. +Type +FileReference +Access +Read/Write +TransferAdmittanceFrequencyPropertiesSource +The transfer admittance frequency dependent properties source. Only applies when the +AdmittanceDefinitionMethod is Custom. +Type +CableShieldTransferAdmittanceFrequencyDefinitionSourceEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +TransferAdmittanceInterpolationMethod +p.1836 +The transfer admittance interpolation method. Only applies when the AdmittanceDefinitionMethod +is Custom. +Type +CableShieldInterpolationMethodEnum +Access +Read/Write +TransferCapacitance +The transfer capacitance. Only applies when the AdmittanceDefinitionMethod is +TransferCapacitance. +Type +ParametricExpression +Access +Read/Write +TransferImpedanceFrequencyPropertiesFile +The transfer impedance frequency dependent properties file name. Only applies when the +ImpedanceDefinitionMethod is Custom and the TransferImpedanceFrequencyPropertiesSource is +FromFile. +Type +FileReference +Access +Read/Write +TransferImpedanceFrequencyPropertiesSource +The transfer impedance frequency dependent properties source. Only applies when the +ImpedanceDefinitionMethod is Custom. +Type +CableShieldTransferImpedanceFrequencyDefinitionSourceEnum +Access +Read/Write +TransferImpedanceInterpolationMethod +The transfer impedance interpolation method. Only applies when the ImpedanceDefinitionMethod +is Custom. +Type +CableShieldInterpolationMethodEnum +Access +Read/Write +WeaveAngle +The braided weave angle. Only applies when the ImpedanceDefinitionMethod is BraidedKley, +BraidedVance, BraidedDemoulin or BraidedTyni. +Type +ParametricExpression +Access +Read/Write +WeaveAngleDeviation +The deviation allowed for the braided weave angle. Only applies when the +ImpedanceDefinitionMethod is BraidedKley, BraidedVance, BraidedDemoulin or BraidedTyni. +Type +ParametricExpression +Access +Read/Write +WeaveDefinitionMethod +The weave definition method. Only applies when the ImpedanceDefinitionMethod is BraidedKley, +BraidedVance, BraidedDemoulin or BraidedTyni. +Type +CableShieldWeaveDefinitionMethodEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ShieldLayerSettingsList +A list of ShieldLayerSettings items. +Method List +Append () +p.1838 +Appends a new item to the list. (Returns a ShieldLayerSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a ShieldLayerSettings object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +ShieldLayerSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +ShieldLayerSettings +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Simplify +Simplify a part. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create some geometry to simplify +cube1 = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +cube2 = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 1), 1, 1, 1) +union = project.Contents.Geometry:Union({cube1, cube2}) + -- Now simplify the geometry +simplify = project.Contents.Geometry:Simplify(union) +Inheritance +The Simplify object is derived from the Geometry object. +Usage locations +The Simplify object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method Simplify(table). +◦ GeometryCollection collection has method SimplifyEntities(List of Geometry). +◦ GeometryCollection collection has method Simplify(Geometry). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ChildReferences +The geometry items to be transformed. (Read/Write ObjectReferenceList) +EdgeSettings +Edge and wire simplification settings. (Read/Write SimplifyEdgeSettings) +FaceSettings +Face simplification settings. (Read/Write SimplifyFaceSettings) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +PointSettings +Point simplification settings. (Read/Write SimplifyPointSettings) +RegionSettings +Region simplification settings. (Read/Write SimplifyRegionSettings) +Type +The object type string. (Read only string) +Collection List +Children +The collection of child operators of the operator. (OperatorCollection of Geometry.) +The collection of edges of the operator. (EdgeCollection of Edge.) +Edges +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ChildReferences +The geometry items to be transformed. +Type +ObjectReferenceList +Access +Read/Write +EdgeSettings +Edge and wire simplification settings. +Type +SimplifyEdgeSettings +Access +Read/Write +FaceSettings +Face simplification settings. +Type +SimplifyFaceSettings +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +PointSettings +Point simplification settings. +Type +SimplifyPointSettings +Access +Read/Write +RegionSettings +Region simplification settings. +Type +SimplifyRegionSettings +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Children +The collection of child operators of the operator. +Type +OperatorCollection +Edges +Faces +The collection of edges of the operator. +Type +EdgeCollection +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +p.1848 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SimplifyEdgeSettings +Edge and wire simplification settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create some geometry to simplify +cube1 = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +cube2 = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 1), 1, 1, 1) +union = project.Contents.Geometry:Union({cube1, cube2}) + -- Now simplify the geometry and adjust some edge options +simplified = project.Contents.Geometry:Simplify(union) +simplified.EdgeSettings.RemoveOnMetalFaces = false +simplified.EdgeSettings.RemoveOnDielectricFaces = false +Inheritance +The SimplifyEdgeSettings object is derived from the CompositeValue object. +Usage locations +The SimplifyEdgeSettings object can be accessed from the following locations: +• Properties +◦ Simplify object has property EdgeSettings. +• Methods +◦ SimplifyEdgeSettingsList object has method Append(). +◦ SimplifyEdgeSettingsList object has method Get(number). +Property List +KeepWithLocalMeshSizeEnabled +Keep edges/wires with local mesh sizes/wire radii. (Read/Write boolean) +RemoveInDielectricRegions +Remove wires inside dielectric regions. (Read/Write boolean) +RemoveInMetalRegions +Remove wires inside metal regions. (Read/Write boolean) +RemoveOnDielectricFaces +Remove edges on dielectric surfaces. (Read/Write boolean) +RemoveOnMetalFaces +Remove edges on metal surfaces. (Read/Write boolean) +Property Details +KeepWithLocalMeshSizeEnabled +Keep edges/wires with local mesh sizes/wire radii. +Type +boolean +Access +Read/Write +RemoveInDielectricRegions +Remove wires inside dielectric regions. +Type +boolean +Access +Read/Write +RemoveInMetalRegions +Remove wires inside metal regions. +Type +boolean +Access +Read/Write +RemoveOnDielectricFaces +Remove edges on dielectric surfaces. +Type +boolean +Access +Read/Write +RemoveOnMetalFaces +Remove edges on metal surfaces. +Type +boolean +Access +Read/Write +SimplifyEdgeSettingsList +A list of SimplifyEdgeSettings items. +Method List +Append () +Appends a new item to the list. (Returns a SimplifyEdgeSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a SimplifyEdgeSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +SimplifyEdgeSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +SimplifyEdgeSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1852 +SimplifyFaceSettings +Face simplification settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create some geometry to simplify +cube1 = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +cube2 = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 1), 1, 1, 1) +union = project.Contents.Geometry:Union({cube1, cube2}) + -- Now simplify the geometry and adjust some face options +simplified = project.Contents.Geometry:Simplify(union) +simplified.FaceSettings.RemoveBetweenEqualMetalRegions = false +simplified.FaceSettings.KeepWithLocalMeshSizeEnabled = true +Inheritance +The SimplifyFaceSettings object is derived from the CompositeValue object. +Usage locations +The SimplifyFaceSettings object can be accessed from the following locations: +• Properties +◦ Simplify object has property FaceSettings. +• Methods +◦ SimplifyFaceSettingsList object has method Append(). +◦ SimplifyFaceSettingsList object has method Get(number). +Property List +KeepWithLocalMeshSizeEnabled +Keep faces with local mesh sizes. (Read/Write boolean) +RemoveBetweenEqualDielectricRegions +Remove faces between equal dielectric regions. (Read/Write boolean) +RemoveBetweenEqualMetalRegions +Remove faces between equal metal regions. (Read/Write boolean) +RemoveBetweenShellRegions +Remove faces between shell regions. (Read/Write boolean) +Property Details +KeepWithLocalMeshSizeEnabled +Keep faces with local mesh sizes. +Type +boolean +Access +Read/Write +RemoveBetweenEqualDielectricRegions +Remove faces between equal dielectric regions. +Type +boolean +Access +Read/Write +RemoveBetweenEqualMetalRegions +Remove faces between equal metal regions. +Type +boolean +Access +Read/Write +RemoveBetweenShellRegions +Remove faces between shell regions. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SimplifyFaceSettingsList +A list of SimplifyFaceSettings items. +Method List +Append () +p.1855 +Appends a new item to the list. (Returns a SimplifyFaceSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a SimplifyFaceSettings object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +SimplifyFaceSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +SimplifyFaceSettings +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +SimplifyPartRepresentationSettings +A settings object for simplifying part representation. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Get the settings for simplifying part representations +simplifyPartsSettings = + project.Contents.Geometry.Repair.SimplifyPartRepresentationSettings + -- Get the setting for the geometry replacement tolerance +tolerance = simplifyPartsSettings.OperatingPrecisionTolerance +Inheritance +The SimplifyPartRepresentationSettings object is derived from the Object object. +Usage locations +The SimplifyPartRepresentationSettings object can be accessed from the following locations: +• Properties +◦ GeometryRepair object has property SimplifyPartRepresentationSettings. +◦ RepairPartsSettings object has property SimplifyPartSettings. +Property List +ConstrainSurfaceNormalsEnabled +The option to ensure that smooth edges will remain smooth. (Read/Write boolean) +ConvertSurfacesToBlends +The options to converting surfaces to blends. (Read/Write SimplifyBlendTypeEnum) +EdgeTolerance +The specified edge tolerance. Only valid if SpecifyEdgeTolerance is true. (Read/Write +ParametricExpression) +Label +The object label. (Read/Write string) +MergeMultipleSPCurveSegmentsEnabled +The option to merge multiple surface parameter curve segments to a single segment. (Read/Write +boolean) +OperatingPrecisionTolerance +The tolerance for replacement geometry. (Read/Write ParametricExpression) +ReduceAndTrimBGeometryEnabled +The option to trim or simplify high-degree B-surfaces to cubic B-surfaces. (Read/Write boolean) +SimplifyBCurvesEnabled +The option to simplify B-curves to lines, circles or ellipses. (Read/Write boolean) +SimplifyBSurfacesEnabled +The option to simplify B-surfaces to planes, cylinders, cones, spheres or tori where possible. +(Read/Write boolean) +SimplifyRationalGeometryEnabled +The option to simplify rational B-surfaces to non-rational B-surfaces. (Read/Write boolean) +SimplifySPCurvesToConstantUVCurvesEnabled +The option to simplify surface parameter curves to be constant in one parameter (U or V). (Read/ +Write boolean) +SimplifySweptSpunSurfacesEnabled +The option to simplify swept or spun surfaces to planes, cylinders, cones, spheres or tori. (Read/ +Write boolean) +SpecifyEdgeToleranceEnabled +The option to specify the edge tolerance to be used. (Read/Write boolean) +SurfaceNormalTolerance +The angular tolerance for constraining surface normals (degrees). Only valid if +ConstrainSurfaceNormals is true. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RestoreDefaults () +Restores all the settings to their default values. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property Details +ConstrainSurfaceNormalsEnabled + The option to ensure that smooth edges will remain smooth. +p.1859 +Type +boolean +Access +Read/Write +ConvertSurfacesToBlends +The options to converting surfaces to blends. +Type +SimplifyBlendTypeEnum +Access +Read/Write +EdgeTolerance + The specified edge tolerance. Only valid if SpecifyEdgeTolerance is true. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MergeMultipleSPCurveSegmentsEnabled + The option to merge multiple surface parameter curve segments to a single segment. +Type +boolean +Access +Read/Write +OperatingPrecisionTolerance +The tolerance for replacement geometry. +Type +ParametricExpression +Access +Read/Write +ReduceAndTrimBGeometryEnabled +The option to trim or simplify high-degree B-surfaces to cubic B-surfaces. +Type +boolean +Access +Read/Write +SimplifyBCurvesEnabled +The option to simplify B-curves to lines, circles or ellipses. +Type +boolean +Access +Read/Write +SimplifyBSurfacesEnabled +The option to simplify B-surfaces to planes, cylinders, cones, spheres or tori where possible. +Type +boolean +Access +Read/Write +SimplifyRationalGeometryEnabled +The option to simplify rational B-surfaces to non-rational B-surfaces. +Type +boolean +Access +Read/Write +SimplifySPCurvesToConstantUVCurvesEnabled +The option to simplify surface parameter curves to be constant in one parameter (U or V). +Type +boolean +Access +Read/Write +SimplifySweptSpunSurfacesEnabled +The option to simplify swept or spun surfaces to planes, cylinders, cones, spheres or tori. +Type +boolean +Access +Read/Write +SpecifyEdgeToleranceEnabled + The option to specify the edge tolerance to be used. +Type +boolean +Access +Read/Write +SurfaceNormalTolerance +The angular tolerance for constraining surface normals (degrees). Only valid if +ConstrainSurfaceNormals is true. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RestoreDefaults () +Restores all the settings to their default values. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SimplifyPointSettings +Point simplification settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create some geometry to simplify +p.1863 +line1 = project.Contents.Geometry:AddLine(cf.Point(0, 0, 0), cf.Point(1, 0, 0)) +line2 = project.Contents.Geometry:AddLine(cf.Point(0.25, 0, 0), cf.Point(0.75, 0, 0)) +union = project.Contents.Geometry:Union({line1, line2}) + -- Now simplify the geometry and adjust a point option +simplified = project.Contents.Geometry:Simplify(union) +simplified.PointSettings.RemoveRedundant = false +Inheritance +The SimplifyPointSettings object is derived from the CompositeValue object. +Usage locations +The SimplifyPointSettings object can be accessed from the following locations: +• Properties +◦ Simplify object has property PointSettings. +• Methods +◦ SimplifyPointSettingsList object has method Append(). +◦ SimplifyPointSettingsList object has method Get(number). +Property List +RemoveRedundant +Remove redundant geometry points. (Read/Write boolean) +Property Details +RemoveRedundant +Remove redundant geometry points. +Type +boolean +Access +Read/Write +SimplifyPointSettingsList +A list of SimplifyPointSettings items. +Method List +Append () +Appends a new item to the list. (Returns a SimplifyPointSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a SimplifyPointSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +SimplifyPointSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +SimplifyPointSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1865 +SimplifyRegionSettings +Region simplification settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create some geometry to simplify +cube1 = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +cube2 = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 1), 1, 1, 1) +union = project.Contents.Geometry:Union({cube1, cube2}) + -- Now simplify the geometry and adjust a region option +simplified = project.Contents.Geometry:Simplify(union) +simplified.RegionSettings.KeepWithLocalMeshSizeEnabled = true +Inheritance +The SimplifyRegionSettings object is derived from the CompositeValue object. +Usage locations +The SimplifyRegionSettings object can be accessed from the following locations: +• Properties +◦ Simplify object has property RegionSettings. +• Methods +◦ SimplifyRegionSettingsList object has method Append(). +◦ SimplifyRegionSettingsList object has method Get(number). +Property List +KeepWithLocalMeshSizeEnabled +Keep regions with local mesh sizes. (Read/Write boolean) +Property Details +KeepWithLocalMeshSizeEnabled +Keep regions with local mesh sizes. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SimplifyRegionSettingsList +A list of SimplifyRegionSettings items. +Method List +Append () +p.1867 +Appends a new item to the list. (Returns a SimplifyRegionSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a SimplifyRegionSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +SimplifyRegionSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +SimplifyRegionSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1868 +SimulationMeshInfo +The quality of the mesh can be examined through these properties. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Waveguide_Divider.cfx]]}) +geometry = project.Contents.Geometry["Union2"] +simulationMeshInfo = geometry.SimulationMeshInfo +averageEdgeLength = simulationMeshInfo.AverageEdgeLength +Inheritance +The SimulationMeshInfo object is derived from the Object object. +Usage locations +The SimulationMeshInfo object can be accessed from the following locations: +• Properties +Property List +AverageCurvilinearEdgeLength +The average mesh curvilinear edge length. (Read only number) +AverageCurvilinearSegmentLength +The average mesh curvilinear segment length. (Read only number) +AverageEdgeLength +The average mesh edge length. (Read only number) +AverageSegmentLength +The average mesh segment length. (Read only number) +AverageTetrahedronEdgeLength +The average mesh tetrahedron edge length. (Read only number) +AverageVoxelLength +The average mesh voxel length. (Read only number) +CableSegmentCount +Get the total number of cable segment elements. (Read only number) +CurvilinearEdgeStandardDeviation +The standard deviation of curvilinear mesh edge length. (Read only number) +CurvilinearSegmentCount +The number of curvilinear line segments in the mesh. (Read only number) +CurvilinearSegmentStandardDeviation +The standard deviation of mesh curvilinear segment length. (Read only number) +CurvilinearTriangleCount +The number of curvilinear triangles in the mesh. (Read only number) +EdgeStandardDeviation +The standard deviation of mesh edge length. (Read only number) +Label +The object label. (Read/Write string) +MaximumCurvilinearEdgeLength +The maximum mesh curvilinear edge length. (Read only number) +MaximumCurvilinearSegmentLength +The maximum mesh curvilinear segment length. (Read only number) +MaximumEdgeLength +The maximum mesh edge length. (Read only number) +MaximumElementAngle +The maximum mesh element angle. (Read only number) +MaximumSegmentLength +The maximum mesh segment length. (Read only number) +MaximumTetrahedronEdgeLength +The maximum mesh tetrahedron edge length. (Read only number) +MaximumVoxelLength +The maximum mesh voxel length. (Read only number) +MeshElementCount +Get the total number of mesh elements. (Read only number) +MinimumCurvilinearEdgeLength +The minimum mesh curvilinear edge length. (Read only number) +MinimumCurvilinearSegmentLength +The minimum mesh curvilinear segment length. (Read only number) +MinimumEdgeLength +The minimum mesh edge length. (Read only number) +MinimumElementAngle +The minimum mesh element angle. (Read only number) +MinimumSegmentLength +The minimum mesh segment length. (Read only number) +MinimumTetrahedronEdgeLength +The minimum mesh tetrahedron edge length. (Read only number) +MinimumVoxelLength +The minimum mesh voxel length. (Read only number) +PolygonCount +The total number of polygons in the mesh. (Read only number) +SegmentCount +The total number of segments in the mesh. (Read only number) +SegmentStandardDeviation +The standard deviation of mesh segment length. (Read only number) +TetrahedronCount +The total number of tetrahedra in the mesh. (Read only number) +TetrahedronEdgeStandardDeviation +The standard deviation of mesh tetradron edge length. (Read only number) +TriangleCount +The number of triangles in the mesh. This is including both flat and curvilinear triangles. (Read +only number) +Type +The object type string. (Read only string) +VoxelCount +The number of FDTD voxels in the mesh. (Read only number) +VoxelStandardDeviation +The standard deviation of mesh voxel length. (Read only number) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AverageCurvilinearEdgeLength +The average mesh curvilinear edge length. +Type +number +Access +Read only +AverageCurvilinearSegmentLength +The average mesh curvilinear segment length. +Type +number +Access +Read only +AverageEdgeLength +The average mesh edge length. +Type +number +Access +Read only +AverageSegmentLength +The average mesh segment length. +Type +number +Access +Read only +AverageTetrahedronEdgeLength +The average mesh tetrahedron edge length. +Type +number +Access +Read only +AverageVoxelLength +The average mesh voxel length. +Type +number +Access +Read only +CableSegmentCount +Get the total number of cable segment elements. +Type +number +Access +Read only +CurvilinearEdgeStandardDeviation +The standard deviation of curvilinear mesh edge length. +Type +number +Access +Read only +CurvilinearSegmentCount +The number of curvilinear line segments in the mesh. +Type +number +Access +Read only +CurvilinearSegmentStandardDeviation +The standard deviation of mesh curvilinear segment length. +Type +number +Access +Read only +CurvilinearTriangleCount +The number of curvilinear triangles in the mesh. +Type +number +Access +Read only +EdgeStandardDeviation +The standard deviation of mesh edge length. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +MaximumCurvilinearEdgeLength +The maximum mesh curvilinear edge length. +Type +number +Access +Read only +MaximumCurvilinearSegmentLength +The maximum mesh curvilinear segment length. +Type +number +Access +Read only +MaximumEdgeLength +The maximum mesh edge length. +Type +number +Access +Read only +MaximumElementAngle +The maximum mesh element angle. +Type +number +Access +Read only +MaximumSegmentLength +The maximum mesh segment length. +Type +number +Access +Read only +MaximumTetrahedronEdgeLength +The maximum mesh tetrahedron edge length. +Type +number +Access +Read only +MaximumVoxelLength +The maximum mesh voxel length. +Type +number +Access +Read only +MeshElementCount +Get the total number of mesh elements. +Type +number +Access +Read only +MinimumCurvilinearEdgeLength +The minimum mesh curvilinear edge length. +Type +number +Access +Read only +MinimumCurvilinearSegmentLength +The minimum mesh curvilinear segment length. +Type +number +Access +Read only +MinimumEdgeLength +The minimum mesh edge length. +Type +number +Access +Read only +MinimumElementAngle +The minimum mesh element angle. +Type +number +Access +Read only +MinimumSegmentLength +The minimum mesh segment length. +Type +number +Access +Read only +MinimumTetrahedronEdgeLength +The minimum mesh tetrahedron edge length. +Type +number +Access +Read only +MinimumVoxelLength +The minimum mesh voxel length. +Type +number +Access +Read only +PolygonCount +The total number of polygons in the mesh. +Type +number +Access +Read only +SegmentCount +The total number of segments in the mesh. +Type +number +Access +Read only +SegmentStandardDeviation +The standard deviation of mesh segment length. +Type +number +Access +Read only +TetrahedronCount +The total number of tetrahedra in the mesh. +Type +number +Access +Read only +TetrahedronEdgeStandardDeviation +The standard deviation of mesh tetradron edge length. +Type +number +Access +Read only +TriangleCount +The number of triangles in the mesh. This is including both flat and curvilinear triangles. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VoxelCount +The number of FDTD voxels in the mesh. +Type +number +Access +Read only +VoxelStandardDeviation +The standard deviation of mesh voxel length. +Type +number +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SolutionCoefficientData +Solution coefficient data. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Import 'SolutionCoefficientData' from file +p.1879 +SolutionCoefficientData = project.Definitions.FieldDataList: + AddSolutionCoefficientData( + FEKO_HOME..[[/shared/Resources/Automation/solution_coefficients_file.sol]]) +Inheritance +The SolutionCoefficientData object is derived from the FieldData object. +Usage locations +The SolutionCoefficientData object can be accessed from the following locations: +• Methods +◦ FieldDataCollection collection has method AddSolutionCoefficientData(table). +◦ FieldDataCollection collection has method AddSolutionCoefficientData(string). +Property List +DataBlockNumber +The data block that is first read from. (Read/Write ParametricExpression) +Filename +Import file containing the solution coefficient data. (Read/Write FileReference) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Type +The object type string. (Read only string) +UseAllDataBlocks +Specifies if all data blocks should be read. (Read/Write boolean) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +DataBlockNumber +The data block that is first read from. +Type +ParametricExpression +Access +Read/Write +Filename +Import file containing the solution coefficient data. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +UseAllDataBlocks +Specifies if all data blocks should be read. +Type +boolean +Access +Read/Write +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SolutionCoefficientSource +A solution SolutionCoefficient source. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +p.1884 +SolutionCoefficientData = + project.Definitions.FieldDataList:AddSolutionCoefficientData( + FEKO_HOME..[[/shared/Resources/Automation/solution_coefficients_file.sol]]) + -- Create a 'SolutionCoefficientSource' from SolutionCoefficientData +SolutionCoefficientSource = + project.Contents.SolutionConfigurations.GlobalSources:AddSolutionCoefficientSource( + SolutionCoefficientData) + -- Delete this 'SolutionCoefficientSource' +SolutionCoefficientSource:Delete() +Inheritance +The SolutionCoefficientSource object is derived from the Source object. +Usage locations +The SolutionCoefficientSource object can be accessed from the following locations: +• Methods +◦ SourceCollection collection has method AddSolutionCoefficientSource(table). +◦ SourceCollection collection has method AddSolutionCoefficientSource(FieldData). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +FieldData +The field data that defines the source. (Read/Write FieldData) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Magnitude +The source magnitude scaling factor. (Read/Write ParametricExpression) +Phase +The source phase offset (degrees). (Read/Write ParametricExpression) +Position +The Position of the source. (Read/Write LocalCoordinate) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Collection List +Transforms +p.1885 +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +FieldData +The field data that defines the source. +p.1886 +Type +FieldData +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Magnitude +The source magnitude scaling factor. +Type +ParametricExpression +Access +Read/Write +Phase +The source phase offset (degrees). +Type +ParametricExpression +Access +Read/Write +Position +The Position of the source. +Type +LocalCoordinate +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1889 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SolutionConfiguration +A solution configuration. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add new standard configuration +p.1890 +standardConfiguration = + project.Contents.SolutionConfigurations:AddStandardConfiguration() + -- Move the new standard configuration above the default standard configuration +project.Contents.SolutionConfigurations:MoveUp(standardConfiguration) +Inheritance +The SolutionConfiguration object is derived from the Object object. +The following objects are derived (specialisations) from the SolutionConfiguration object: +• CharacteristicModesConfiguration +• SParameterConfiguration +• StandardConfiguration +Usage locations +The SolutionConfiguration object can be accessed from the following locations: +• Methods +◦ SolutionConfigurationCollection collection has method Item(number). +◦ SolutionConfigurationCollection collection has method Item(string). +Property List +Frequency +The configuration solution frequency. (Read only Frequency) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Collection List +Loads +The collection of loads in the configuration. (LoadCollection of Load.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Frequency +The configuration solution frequency. +Type +Frequency +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Loads +The collection of loads in the configuration. +Type +LoadCollection +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SolutionSettings +The model solution settings. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Access the 'SolutionSettings' object and set the X plane symmetry to geometric +project.Contents.SolutionSettings.ModelSymmetry.PlaneX + = cf.Enums.ModelSymmetryTypeEnum.Geometric +Inheritance +The SolutionSettings object is derived from the Object object. +Usage locations +The SolutionSettings object can be accessed from the following locations: +• Properties +◦ ModelContents object has property SolutionSettings. +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +FDTDBoundary +The finite difference time domain boundary settings. (Read only FDTDBoundaryConditions) +GroundPlane +Planar Green's functions and ground planes in the model. (Read only GroundPlane) +Label +The object label. (Read/Write string) +ModelSymmetry +The model symmetry planes. (Read only ModelSymmetry) +NumericalGreensFunction +The numerical Green's function (NGF) settings. (Read only NumericalGreensFunction) +PeriodicBoundary +The periodic boundary condition (PBC) for the model. (Read only PeriodicBoundary) +SolverSettings +The solver solution settings of the model. (Read only SolverSettings) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +FDTDBoundary +The finite difference time domain boundary settings. +Type +FDTDBoundaryConditions +Access +Read only +GroundPlane +Planar Green's functions and ground planes in the model. +Type +GroundPlane +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +ModelSymmetry +The model symmetry planes. +Type +ModelSymmetry +Access +Read only +NumericalGreensFunction +The numerical Green's function (NGF) settings. +Type +NumericalGreensFunction +Access +Read only +PeriodicBoundary +The periodic boundary condition (PBC) for the model. +Type +PeriodicBoundary +Access +Read only +SolverSettings +The solver solution settings of the model. +Type +SolverSettings +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.1896 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SolverSettings +The solution solver settings. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Activate the finite difference time domain solver +project.Contents.SolutionSettings.SolverSettings.FDTDSettings.FDTDEnabled = true +Inheritance +The SolverSettings object is derived from the Object object. +Usage locations +The SolverSettings object can be accessed from the following locations: +• Properties +◦ SolutionSettings object has property SolverSettings. +Property List +AdvancedSettings +Advanced solver settings. (Read/Write AdvancedSolverSettings) +DomainDecompositionSettings +Domain decomposition solver settings. (Read/Write DomainDecompositionSettings) +FDTDSettings +Settings for the finite difference time domain solver. (Read/Write FDTDSettings) +FEMSettings +FEM settings. (Read/Write FEMSettings) +GeneralSettings +General solution solver settings. (Read/Write GeneralSolverSettings) +HighFrequencySettings +High frequency solver settings. (Read/Write HighFrequencySettings) +IntegralEquation +Integral equation solver settings. (Read/Write IntegralEquation) +Label +The object label. (Read/Write string) +MLFMMACASettings +MLFMM / ACA settings. (Read/Write MLFMMACASettings) +PreconditionerSettings +Preconditioner solver settings. (Read/Write PreconditionerSettings) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.1898 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +AdvancedSettings +Advanced solver settings. +Type +AdvancedSolverSettings +Access +Read/Write +DomainDecompositionSettings +Domain decomposition solver settings. +Type +DomainDecompositionSettings +Access +Read/Write +FDTDSettings +Settings for the finite difference time domain solver. +Type +FDTDSettings +Access +Read/Write +FEMSettings +FEM settings. +Type +FEMSettings +Access +Read/Write +GeneralSettings +General solution solver settings. +Type +GeneralSolverSettings +Access +Read/Write +HighFrequencySettings +High frequency solver settings. +Type +HighFrequencySettings +Access +Read/Write +IntegralEquation +Integral equation solver settings. +Type +IntegralEquation +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MLFMMACASettings +MLFMM / ACA settings. +Type +MLFMMACASettings +Access +Read/Write +PreconditionerSettings +Preconditioner solver settings. +Type +PreconditionerSettings +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Source +An abstract (base) object for sources. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The Source object is derived from the Object object. +The following objects are derived (specialisations) from the Source object: +p.1901 +• AbstractIdealSource +• CurrentSource +• FEMModalSource +• FarFieldSource +• NearFieldSource +• PCBSource +• PlaneWave +• SolutionCoefficientSource +• SphericalModeSource +• VoltageSource +• WaveguideSource +Usage locations +The Source object can be accessed from the following locations: +• Methods +◦ SourceCollection collection has method Item(number). +◦ SourceCollection collection has method Item(string). +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1902 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +table +A table defining the properties. +SetProperties (properties Object) +p.1903 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SpecifiedRequestPoints +The Specified request point positions. +Example +p.1904 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a NearField by specifying a table of arbitrary points +points = {} +points[1] = cf.Point(0.3,0.1,0.0) +points[2] = cf.Point(0.3,0.7,0.0) +points[3] = cf.Point(0.7,0.7,0.0) +nearField = + project.Contents.SolutionConfigurations[1].NearFields:AddSpecifiedPoints(points) + -- Modify the N coordinate of the last NearField point +nearField.SpecifiedRequestPoints.Points[3].N = 2.0 +Inheritance +The SpecifiedRequestPoints object is derived from the CompositeValue object. +Usage locations +The SpecifiedRequestPoints object can be accessed from the following locations: +• Properties +◦ NearField object has property SpecifiedRequestPoints. +• Methods +◦ SpecifiedRequestPointsList object has method Append(). +◦ SpecifiedRequestPointsList object has method Get(number). +Property List +Points +The collection of specified request points. (Read/Write LocalInternalCoordinateList) +Property Details +Points +The collection of specified request points. +Type +LocalInternalCoordinateList +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SpecifiedRequestPointsList +A list of SpecifiedRequestPoints items. +Method List +Append () +p.1905 +Appends a new item to the list. (Returns a SpecifiedRequestPoints object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a SpecifiedRequestPoints +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +SpecifiedRequestPoints +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +SpecifiedRequestPoints +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1906 +Sphere +A spheroid. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a simple sphere centred at the specified 'Point' +centre = cf.Point(1, 2, 0) +radius = 2.5 +project.Contents.Geometry:AddSphere(centre, radius) + -- Create a spheroid at the given 'Point' where each radius differs +centre = cf.Point(-1, -2, 0) +uRadius = 0.5 +vRadius = 1 +nRadius = 3 +project.Contents.Geometry:AddSpheroid(centre, uRadius, vRadius, nRadius) +Inheritance +The Sphere object is derived from the Geometry object. +Usage locations +The Sphere object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddSpheroid(table). +◦ GeometryCollection collection has method AddSphere(Point, Expression). +◦ GeometryCollection collection has method AddSpheroid(Point, Expression, Expression, +Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The spheroid centre. (Read/Write LocalCoordinate) +DefinitionMethod +Spheroid definition method specified by the SpheroidDefinitionMethodEnum, e.g. Sphere or +Spheroid. (Read/Write SpheroidDefinitionMethodEnum) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +LocalMeshSettingsEnabled +p.1908 +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Radius +The sphere radius. Only valid if DefinitionMethod is Sphere. (Read/Write Dimension) +RadiusN +The spheroid radius in the N direction. Only valid if DefinitionMethod is Spheroid. (Read/Write +NormalDimension) +RadiusU +The spheroid radius in the U direction. Only valid if DefinitionMethod is Spheroid. (Read/Write +Dimension) +RadiusV +The spheroid radius in the V direction. Only valid if DefinitionMethod is Spheroid. (Read/Write +Dimension) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +CopyAndMirror (properties table) +p.1909 +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +The spheroid centre. +Type +LocalCoordinate +Access +Read/Write +DefinitionMethod +Spheroid definition method specified by the SpheroidDefinitionMethodEnum, e.g. Sphere or +Spheroid. +Type +SpheroidDefinitionMethodEnum +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Radius +The sphere radius. Only valid if DefinitionMethod is Sphere. +Type +Dimension +Access +Read/Write +RadiusN +The spheroid radius in the N direction. Only valid if DefinitionMethod is Spheroid. +Type +NormalDimension +Access +Read/Write +RadiusU +The spheroid radius in the U direction. Only valid if DefinitionMethod is Spheroid. +Type +Dimension +Access +Read/Write +RadiusV +The spheroid radius in the V direction. Only valid if DefinitionMethod is Spheroid. +Type +Dimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SphericalDescription +p.1916 +The description of an analytical curve using the spherical coordinate system. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Define three local variables used to create a spherical analytical curve +R = "t*sqrt(1+t^2)" +theta = "90" +phi = "deg(arctan(t))" +analyticalCurve = project.Contents.Geometry:AddAnalyticalCurveSpherical(0, 1, R, + theta, phi) + -- Access the spherical description +analyticalCurve.SphericalDescription.R = "10*t*sqrt(1+t^2)" +analyticalCurve.SphericalDescription.Theta = 80 +Inheritance +The SphericalDescription object is derived from the CompositeValue object. +Usage locations +The SphericalDescription object can be accessed from the following locations: +• Properties +◦ AnalyticalCurve object has property SphericalDescription. +• Methods +◦ SphericalDescriptionList object has method Append(). +◦ SphericalDescriptionList object has method Get(number). +Property List +Phi +Theta +The curve description in the phi dimension as a function of variable t. (Read/Write +ParametricExpression) +The curve description in the R dimension as a function of variable t. (Read/Write +ParametricExpression) +The curve description in the theta dimension as a function of variable t. (Read/Write +ParametricExpression) +Property Details +Phi +The curve description in the phi dimension as a function of variable t. +Type +ParametricExpression +Access +Read/Write +Theta +The curve description in the R dimension as a function of variable t. +Type +ParametricExpression +Access +Read/Write +The curve description in the theta dimension as a function of variable t. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SphericalDescriptionList +A list of SphericalDescription items. +Method List +Append () +p.1918 +Appends a new item to the list. (Returns a SphericalDescription object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a SphericalDescription object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +SphericalDescription +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +SphericalDescription +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SphericalModeDataFromFile +A spherical modes data using full file import. +Example +p.1920 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Import 'SphericalModeDataFromFile' from previously a exported 'FarField' +sphericalModesData = project.Definitions.FieldDataList: + AddSphericalModeDataFullImport([[SphericalModesData.sph]]) +Inheritance +The SphericalModeDataFromFile object is derived from the FieldData object. +Usage locations +The SphericalModeDataFromFile object can be accessed from the following locations: +• Methods +◦ FieldDataCollection collection has method AddSphericalModeDataFromFile(table). +◦ FieldDataCollection collection has method AddSphericalModeDataFullImport(string). +Property List +DataBlockNumber +The data block that is first read from. (Read/Write ParametricExpression) +Filename +Import file containing the spherical modes data. (Read/Write FileReference) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Type +The object type string. (Read only string) +UseAllDataBlocks +Specifies if all data blocks should be read. (Read/Write boolean) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +DataBlockNumber +The data block that is first read from. +Type +ParametricExpression +Access +Read/Write +Filename +Import file containing the spherical modes data. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +UseAllDataBlocks +Specifies if all data blocks should be read. +Type +boolean +Access +Read/Write +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SphericalModeDataManuallySpecified +A spherical modes data using manual specifications. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Created 'SphericalModeDataManuallySpecified' + -- from a set of default properties +properties = cf.SphericalModeDataManuallySpecified.GetDefaultProperties() +properties.ModeIndices[1].SphericalMJ = "1" +properties.ModeIndices[1].SphericalMagnitude = "1" +properties.ModeIndices[1].SphericalN = "10" +properties.ModeIndices[1].SphericalPhase = "13" +SphericalModesData1 = project.Definitions.FieldDataList: + AddSphericalModeDataManuallySpecified(properties) +Inheritance +The SphericalModeDataManuallySpecified object is derived from the FieldData object. +Usage locations +The SphericalModeDataManuallySpecified object can be accessed from the following locations: +• Methods +◦ FieldDataCollection collection has method AddSphericalModeDataManuallySpecified(table). +Property List +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +ModeIndices +The collection of spherical modes data defined manually. (Read/Write SphericalModeOptionsList) +PropagationDirection +Select the direction of propagation for the spherical mode. (Read/Write +SphericalModeDataPropagationDirectionMethodEnum) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method List +CopyAndMirror (properties table) +p.1926 +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +ModeIndices +The collection of spherical modes data defined manually. +Type +SphericalModeOptionsList +Access +Read/Write +PropagationDirection +Select the direction of propagation for the spherical mode. +Type +SphericalModeDataPropagationDirectionMethodEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SphericalModeOptions +p.1930 +For manual specification, each mode must be defined separately per specification entry. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +properties = cf.SphericalModeDataManuallySpecified.GetDefaultProperties() +properties.ModeIndices[1].SphericalMJ = "1" +properties.ModeIndices[1].SphericalMagnitude = "3" +properties.ModeIndices[1].SphericalN = "2" +properties.ModeIndices[1].SphericalPhase = "4" +fieldData = + project.Definitions.FieldDataList:AddSphericalModeDataManuallySpecified(properties) + -- Modify the first spherical mode +sphericalModeIndexProp = fieldData:GetProperties() +sphericalModeIndexProp.ModeIndices[1].TeTmType + = cf.Enums.SphericalModeDataTeTmTypeMethodEnum.Empty +sphericalModeIndexProp.ModeIndices[1].IndexSchemeType + = cf.Enums.SphericalModeDataIndexSchemeMethodEnum.Compressed +fieldData:SetProperties(sphericalModeIndexProp) +Inheritance +The SphericalModeOptions object is derived from the CompositeValue object. +Usage locations +The SphericalModeOptions object can be accessed from the following locations: +• Methods +◦ SphericalModeOptionsList object has method Append(). +◦ SphericalModeOptionsList object has method Get(number). +Property List +IndexSchemeType +Index scheme for this specific spherical mode. (Read/Write +SphericalModeDataIndexSchemeMethodEnum) +SphericalMJ +The M mode index which is in the azimuth direction for this specific spherical mode. (Read/Write +ParametricExpression) +SphericalMagnitude +Absolute value of the complex amplitude of this specific spherical mode. (Read/Write +ParametricExpression) +SphericalN +The N mode index which is in radial direction for this specific spherical mode. (Read/Write +ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SphericalPhase +The phase of the complex amplitude of this spherical mode in degrees. (Read/Write +ParametricExpression) +TeTmType +Select either the TE or TM mode for this specific spherical mode. (Read/Write +SphericalModeDataTeTmTypeMethodEnum) +p.1931 +Property Details +IndexSchemeType +Index scheme for this specific spherical mode. +Type +SphericalModeDataIndexSchemeMethodEnum +Access +Read/Write +SphericalMJ +The M mode index which is in the azimuth direction for this specific spherical mode. +Type +ParametricExpression +Access +Read/Write +SphericalMagnitude +Absolute value of the complex amplitude of this specific spherical mode. +Type +ParametricExpression +Access +Read/Write +SphericalN +The N mode index which is in radial direction for this specific spherical mode. +Type +ParametricExpression +Access +Read/Write +SphericalPhase +The phase of the complex amplitude of this spherical mode in degrees. +Type +ParametricExpression +Access +Read/Write +TeTmType +Select either the TE or TM mode for this specific spherical mode. +Type +SphericalModeDataTeTmTypeMethodEnum +Access +Read/Write +SphericalModeOptionsList +A list of SphericalModeOptions items. +Usage locations +The SphericalModeOptionsList object can be accessed from the following locations: +• Properties +◦ SphericalModeDataManuallySpecified object has property ModeIndices. +Method List +Append () +Appends a new item to the list. (Returns a SphericalModeOptions object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a SphericalModeOptions +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +SphericalModeOptions +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +SphericalModeOptions +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SphericalModeReceivingAntenna +A solution spherical modes receiving antenna request. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +p.1935 +standardConfiguration = + project.Contents.SolutionConfigurations['StandardConfiguration1'] +sphericalModesData = project.Definitions.FieldDataList: + AddSphericalModeDataFullImport([[SphericalModesData.sph]]) + -- Create a 'SphericalModeReceivingAntenna' from sphericalModesData +sphericalModesReceivingAntenna = + standardConfiguration.SphericalModeReceivingAntennas: + Add(sphericalModesData) + -- Specify the Theta orientation +sphericalModesReceivingAntenna.Theta = 45 + -- Delete this SphericalModeReceivingAntenna +sphericalModesReceivingAntenna:Delete() +Inheritance +The SphericalModeReceivingAntenna object is derived from the BaseFieldReceivingAntenna object. +Usage locations +The SphericalModeReceivingAntenna object can be accessed from the following locations: +• Methods +◦ SphericalModeReceivingAntennaCollection collection has method Add(table). +◦ SphericalModeReceivingAntennaCollection collection has method Add(FieldData). +◦ SphericalModeReceivingAntennaCollection collection has method Item(number). +◦ SphericalModeReceivingAntennaCollection collection has method Item(string). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +FieldData +The field data that defines the spherical modes. (Read/Write FieldData) +IncludeScatteredPart +Enable including only the scattered part of the field. (Read/Write boolean) +InternalApproximationMethod +Select the approximation method. (Read/Write ApproximationMethodEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Label +The object label. (Read/Write string) +LocalWorkplane +p.1936 +The source workplane. (Read/Write LocalWorkplane) +Phi +The spherical modes receiving antenna phi orientation (degrees). (Read/Write +ParametricExpression) +Position +The position of the spherical modes receiving antenna. (Read/Write LocalCoordinate) +Theta +Type +The spherical modes receiving antenna theta orientation (degrees). (Read/Write +ParametricExpression) +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.1937 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +FieldData +The field data that defines the spherical modes. +Type +FieldData +Access +Read/Write +IncludeScatteredPart +Enable including only the scattered part of the field. +Type +boolean +Access +Read/Write +InternalApproximationMethod +Select the approximation method. +Type +ApproximationMethodEnum +Label +Access +Read/Write +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Phi +The spherical modes receiving antenna phi orientation (degrees). +Type +ParametricExpression +Access +Read/Write +Position +The position of the spherical modes receiving antenna. +Type +LocalCoordinate +Access +Read/Write +Theta +The spherical modes receiving antenna theta orientation (degrees). +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SphericalModeSource +A solution spherical modes source. +Example +p.1942 +application = cf.Application.GetInstance() +project = application:NewProject() +sphericalModesData = project.Definitions.FieldDataList: + AddSphericalModeDataFullImport([[SphericalModesData.sph]]) + -- Create a 'SphericalModeSource' from sphericalModesData +sphericalModeSource = + project.Contents.SolutionConfigurations.GlobalSources:AddSphericalModeSource(sphericalModesData) + -- Specify the Theta orientation +sphericalModeSource.Theta = 45 + -- Delete this 'SphericalModeSource' +sphericalModeSource:Delete() +Inheritance +The SphericalModeSource object is derived from the Source object. +Usage locations +The SphericalModeSource object can be accessed from the following locations: +• Methods +◦ SourceCollection collection has method AddSphericalModeSource(table). +◦ SourceCollection collection has method AddSphericalModeSource(FieldData). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +FieldData +The field data that defines the source. (Read/Write FieldData) +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Magnitude +The source magnitude scaling factor. (Read/Write ParametricExpression) +Phase +The source phase offset (degrees). (Read/Write ParametricExpression) +Phi +The spherical source Phi orientation (degrees). (Read/Write ParametricExpression) +Position +The Position of the source. (Read/Write LocalCoordinate) +Theta +Type +The spherical source Theta orientation (degrees). (Read/Write ParametricExpression) +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +FieldData +The field data that defines the source. +Type +FieldData +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Magnitude +The source magnitude scaling factor. +Type +ParametricExpression +Access +Read/Write +Phase +The source phase offset (degrees). +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Phi +The spherical source Phi orientation (degrees). +p.1945 +Type +ParametricExpression +Access +Read/Write +Position +The Position of the source. +Type +LocalCoordinate +Access +Read/Write +Theta +The spherical source Theta orientation (degrees). +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.1948 +Altair Feko 2022.3 +2 Application Programming Interface (API) +SphericalRequestPoints +The spherical request point positions. +Example +p.1949 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a Spherical NearField + -- that spans the quadrant with phi = [0,90] and theta = [-45,45] + -- with an inner radius 1 and outer radius 2 +nearField = + project.Contents.SolutionConfigurations[1].NearFields:AddSpherical(1,0,-45, + 2,90,45, + 5,11,11) +sphericalRequestPoints = nearField.SphericalRequestPoints + -- Get the Phi coordinate of the start of the NearField, which is 0 +startPhi = sphericalRequestPoints.Phi.Start + -- Get the Phi coordinate of the end of the NearField, which is 45 +endPhi = sphericalRequestPoints.Phi.End +Inheritance +The SphericalRequestPoints object is derived from the CompositeValue object. +Usage locations +The SphericalRequestPoints object can be accessed from the following locations: +• Properties +◦ NearField object has property SphericalRequestPoints. +• Methods +◦ SphericalRequestPointsList object has method Append(). +◦ SphericalRequestPointsList object has method Get(number). +Property List +Phi +The Phi range of points. (Read/Write PointAngleRange) +Radius +The Radius range of points. (Read/Write PointRange) +Theta +The Theta range of points. (Read/Write PointAngleRange) +Property Details +Phi +The Phi range of points. +Type +PointAngleRange +Access +Read/Write +Radius +The Radius range of points. +Type +PointRange +Access +Read/Write +Theta +The Theta range of points. +Type +PointAngleRange +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SphericalRequestPointsList +A list of SphericalRequestPoints items. +Method List +Append () +p.1951 +Appends a new item to the list. (Returns a SphericalRequestPoints object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a SphericalRequestPoints +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +SphericalRequestPoints +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +SphericalRequestPoints +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.1952 +Altair Feko 2022.3 +2 Application Programming Interface (API) +SphericalStructure +The spherical coordinate system source description. +Example +p.1953 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a 'NearFieldFileStructure' from a set of default properties +properties = cf.NearFieldDataFileStructure.GetDefaultProperties() +properties.CoordinateType = cf.Enums.NearFieldDataCoordinateTypeEnum.Spherical +properties.SphericalStructure.Radius = "2" +properties.SphericalStructure.ThetaPoints = "11" +properties.SphericalStructure.PhiPoints = "11" +properties.EFieldFilename = [[EFieldFileName]] +properties.HFieldFilename = [[HFieldFileName]] +nearFieldData = + project.Definitions.FieldDataList:AddNearFieldDataFileStructure(properties) + -- Change the radius of the spherical shell +nearFieldData.SphericalStructure.Radius = "4" +Inheritance +The SphericalStructure object is derived from the CompositeValue object. +Usage locations +The SphericalStructure object can be accessed from the following locations: +• Properties +◦ NearFieldDataFileStructure object has property SphericalStructure. +• Methods +◦ SphericalStructureList object has method Append(). +◦ SphericalStructureList object has method Get(number). +Property List +PhiPoints +The number of points along Phi. (Read/Write ParametricExpression) +Radius +The radius of the spherical shell. (Read/Write Dimension) +ThetaPoints +The number of points along Theta. (Read/Write ParametricExpression) +Property Details +PhiPoints +The number of points along Phi. +Type +ParametricExpression +Access +Read/Write +Radius +The radius of the spherical shell. +Type +Dimension +Access +Read/Write +ThetaPoints +The number of points along Theta. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SphericalStructureList +A list of SphericalStructure items. +Method List +Append () +p.1955 +Appends a new item to the list. (Returns a SphericalStructure object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a SphericalStructure object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +SphericalStructure +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +SphericalStructure +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Spin +A spin operator. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a line that will be spun 270 degrees about the N axis at the origin +line = project.Contents.Geometry:AddLine(cf.Point(0, 0, 0), cf.Point(1, 1, 1)) +axisOrigin = cf.Point(0, 0, 0) +axisDirection = cf.Point(0, 0, 1) +project.Contents.Geometry:Spin(line, axisOrigin, axisDirection, 270) +Inheritance +The Spin object is derived from the Geometry object. +Usage locations +The Spin object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method Spin(Geometry, table). +◦ GeometryCollection collection has method Spin(Geometry, Point, Point, Expression). +Property List +Angle +The angle to spin by (degrees). (Read/Write AngularDimension) +AxisDirection +The direction of the axis of rotation. (Read/Write LocalCoordinate) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ChildReferences +The geometry items to be transformed. (Read/Write ObjectReferenceList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Origin +The origin of the axis of rotation. (Read/Write LocalCoordinate) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +The object type string. (Read only string) +Collection List +Children +The collection of child operators of the operator. (OperatorCollection of Geometry.) +The collection of edges of the operator. (EdgeCollection of Edge.) +Edges +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Angle +The angle to spin by (degrees). +Type +AngularDimension +Access +Read/Write +AxisDirection +The direction of the axis of rotation. +Type +LocalCoordinate +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ChildReferences +The geometry items to be transformed. +Type +ObjectReferenceList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Origin +The origin of the axis of rotation. +Type +LocalCoordinate +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Children +The collection of child operators of the operator. +Type +OperatorCollection +The collection of edges of the operator. +Type +EdgeCollection +Edges +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +p.1965 +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SpiralCross +A spiral cross. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a spiral cross at the specified 'Point' +center = cf.Point(-0.25, -0.25, 0) +spiralcross = project.Contents.Geometry:AddSpiralCross(center, 1.5, 0.5, 0.5, 0.1) +Inheritance +The SpiralCross object is derived from the Geometry object. +Usage locations +The SpiralCross object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddSpiralCross(table). +◦ GeometryCollection collection has method AddSpiralCross(Point, Expression, Expression, +Expression, Expression). +Property List +ArmLength +The cross arm length. (Read/Write Dimension) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The cross centre point. (Read/Write LocalCoordinate) +EdgeLength +The cross edge length. (Read/Write Dimension) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Parent +p.1967 +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +SpiralLength +The cross spiral length. (Read/Write Dimension) +StripWidth +The cross strip width. (Read/Write Dimension) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Explode () +p.1968 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ArmLength +The cross arm length. +Type +Dimension +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +The cross centre point. +Type +LocalCoordinate +Access +Read/Write +EdgeLength +The cross edge length. +Type +Dimension +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +SpiralLength +The cross spiral length. +Type +Dimension +Access +Read/Write +StripWidth +The cross strip width. +Type +Dimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +p.1974 +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SpiralCrossShape +A spiral cross shape. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a spiral cross shape +cross = + project.Definitions.PeriodicStructures.Shapes:AddSpiralCross(2.0, 1.0, 0.6, 0.2) +Inheritance +The SpiralCrossShape object is derived from the Shape object. +Usage locations +The SpiralCrossShape object can be accessed from the following locations: +• Methods +◦ ShapeCollection collection has method AddSpiralCross(table). +◦ ShapeCollection collection has method AddSpiralCross(Expression, Expression, Expression, +Expression). +Property List +ArmLength +The spiral cross arm length. (Read/Write ParametricExpression) +EdgeLength +The spiral cross edge length. (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +SpiralLength +The spiral cross spiral length. (Read/Write ParametricExpression) +StripWidth +The spiral cross strip width. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +BuildGeometry () +Creates the full geometry representation of the shape. (Returns a Geometry object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ArmLength +The spiral cross arm length. +Type +ParametricExpression +Access +Read/Write +EdgeLength +The spiral cross edge length. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +SpiralLength +The spiral cross spiral length. +Type +ParametricExpression +Access +Read/Write +StripWidth +The spiral cross strip width. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +BuildGeometry () +Creates the full geometry representation of the shape. +Return +Geometry +The shape geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Split +A split operator. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Split a cuboid in half in the UV plane +cube = project.Contents.Geometry:AddCuboid(cf.Point(0,0,0),1,1,1) +split = + project.Contents.Geometry:Split(project.Contents.Geometry[1],cf.Point(0.5,0,0),0,0) +backSplit = split[1] +frontSplit = split[2] +Inheritance +The Split object is derived from the Geometry object. +Usage locations +The Split object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method Split(table). +◦ GeometryCollection collection has method SplitPlaneUN(Geometry, Point, Expression, +Expression). +◦ GeometryCollection collection has method Split(Geometry, Point, Expression, Expression). +◦ GeometryCollection collection has method SplitPlaneVN(Geometry, Point, Expression, +Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ChildReferences +The geometry items to be transformed. (Read/Write ObjectReferenceList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Origin +The split plane's point of origin. (Read/Write LocalCoordinate) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Plane +The split plane specified by the SplitPlanesEnum, e.g. UV or VN or UN. (Read/Write +SplitPlanesEnum) +RotationN +The split plane's N axis rotation angle (degrees). Only valid if Plane is UN or VN. (Read/Write +ParametricExpression) +RotationU +The split plane's U axis rotation angle (degrees). Only valid if Plane is UV or UN. (Read/Write +ParametricExpression) +RotationV +The split plane's V axis rotation angle (degrees). Only valid if Plane is UV or VN. (Read/Write +ParametricExpression) +Type +The object type string. (Read only string) +Collection List +Children +The collection of child operators of the operator. (OperatorCollection of Geometry.) +The collection of edges of the operator. (EdgeCollection of Edge.) +Edges +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +CopyAndMirror (properties table) +p.1981 +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ChildReferences +The geometry items to be transformed. +Type +ObjectReferenceList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Origin +The split plane's point of origin. +Type +LocalCoordinate +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Plane +The split plane specified by the SplitPlanesEnum, e.g. UV or VN or UN. +Type +SplitPlanesEnum +Access +Read/Write +RotationN +The split plane's N axis rotation angle (degrees). Only valid if Plane is UN or VN. +Type +ParametricExpression +Access +Read/Write +RotationU +The split plane's U axis rotation angle (degrees). Only valid if Plane is UV or UN. +Type +ParametricExpression +Access +Read/Write +RotationV +The split plane's V axis rotation angle (degrees). Only valid if Plane is UV or VN. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Children +The collection of child operators of the operator. +Type +OperatorCollection +Edges +Faces +The collection of edges of the operator. +Type +EdgeCollection +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.1987 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SplitRing +A split ring. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a split ring at the specified 'Point' +centre = cf.Point(-0.25, -0.25, 0) +ring = project.Contents.Geometry:AddSplitRing(centre, 1.5, 1.2, 45, 90) +Inheritance +The SplitRing object is derived from the OpenRing object. +Usage locations +The SplitRing object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddSplitRing(table). +◦ GeometryCollection collection has method AddSplitRing(Point, Expression, Expression, +Expression, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The ring centre point. (Read/Write LocalCoordinate) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +GapAngle +The angle of the ring opening. (Read/Write AngularDimension) +InnerRadius +The ring inner radius. (Read/Write Dimension) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +OuterRadius +The ring outer radius. (Read/Write Dimension) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +StartAngle +The angle the ring opening starts at. (Read/Write AngularDimension) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Explode () +p.1990 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +The ring centre point. +Type +LocalCoordinate +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +GapAngle +The angle of the ring opening. +Type +AngularDimension +Access +Read/Write +InnerRadius +The ring inner radius. +Type +Dimension +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +OuterRadius +The ring outer radius. +Type +Dimension +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +StartAngle +The angle the ring opening starts at. +Type +AngularDimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +p.1996 +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SplitRingShape +A split ring shape. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a split ring shape +ring = + project.Definitions.PeriodicStructures.Shapes:AddSplitRing(1.5, 1.2, 10.0, 30.0) +Inheritance +The SplitRingShape object is derived from the OpenRingShape object. +Usage locations +The SplitRingShape object can be accessed from the following locations: +• Methods +◦ ShapeCollection collection has method AddSplitRing(table). +◦ ShapeCollection collection has method AddSplitRing(Expression, Expression, Expression, +Expression). +Property List +GapAngle +The angle of the ring opening. (Read/Write ParametricExpression) +InnerRadius +The ring inner radius. (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +OuterRadius +The ring outer radius. (Read/Write ParametricExpression) +StartAngle +The angle the ring opening starts at. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +BuildGeometry () +Creates the full geometry representation of the shape. (Returns a Geometry object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +GapAngle +The angle of the ring opening. +Type +ParametricExpression +Access +Read/Write +InnerRadius +The ring inner radius. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +OuterRadius +The ring outer radius. +Type +ParametricExpression +Access +Read/Write +StartAngle +The angle the ring opening starts at. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +BuildGeometry () +Creates the full geometry representation of the shape. +Return +Geometry +The shape geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +StandardConfiguration +A standard configuration. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a new standard configuration +standardConfiguration = + project.Contents.SolutionConfigurations:AddStandardConfiguration() +Inheritance +The StandardConfiguration object is derived from the SolutionConfiguration object. +Usage locations +The StandardConfiguration object can be accessed from the following locations: +• Methods +◦ SolutionConfigurationCollection collection has method AddStandardConfiguration(). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Frequency +The configuration solution frequency. (Read only Frequency) +Label +The object label. (Read/Write string) +Power +The configuration power settings. (Read only Power) +Type +The object type string. (Read only string) +Collection List +Currents +The collection of currents requests in the configuration. (CurrentsCollection of Currents.) +ErrorEstimations +The collection of error estimations in the configuration. (ErrorEstimationCollection of +ErrorEstimation.) +FarFieldReceivingAntennas +The collection of far field receiving antennas in the configuration. +(FarFieldReceivingAntennaCollection of FarFieldReceivingAntenna.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFields +p.2002 +The collection of far field requests in the configuration. (FarFieldCollection of FarField.) +Loads +The collection of loads in the configuration. (LoadCollection of Load.) +ModelDecompositions +The collection of model decomposition requests in the configuration. +(ModelDecompositionCollection of ModelDecomposition.) +NearFieldReceivingAntennas +The collection of near field receiving antennas in the configuration. +(NearFieldReceivingAntennaCollection of NearFieldReceivingAntenna.) +NearFields +The collection of near field requests in the configuration. (NearFieldCollection of NearField.) +SAR +The collection of SAR requests in the configuration. (SARCollection of SAR.) +Sources +The collection of sources in the configuration. (SourceCollection of Source.) +SphericalModeReceivingAntennas +The collection of spherical modes receiving antennas in the configuration. +(SphericalModeReceivingAntennaCollection of SphericalModeReceivingAntenna.) +TransmissionReflection +The collection of Transmission / reflection requests in the configuration. +(TransmissionReflectionCollection of TransmissionReflection.) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Frequency +The configuration solution frequency. +Type +Frequency +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Power +The configuration power settings. +Type +Power +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Currents +The collection of currents requests in the configuration. +Type +CurrentsCollection +ErrorEstimations +The collection of error estimations in the configuration. +Type +ErrorEstimationCollection +FarFieldReceivingAntennas +The collection of far field receiving antennas in the configuration. +Type +FarFields +FarFieldReceivingAntennaCollection +The collection of far field requests in the configuration. +Type +FarFieldCollection +Loads +The collection of loads in the configuration. +Type +LoadCollection +ModelDecompositions +The collection of model decomposition requests in the configuration. +Type +ModelDecompositionCollection +NearFieldReceivingAntennas +The collection of near field receiving antennas in the configuration. +Type +NearFields +NearFieldReceivingAntennaCollection +The collection of near field requests in the configuration. +Type +NearFieldCollection +SAR +The collection of SAR requests in the configuration. +Type +SARCollection +Sources +The collection of sources in the configuration. +Type +SourceCollection +SphericalModeReceivingAntennas +The collection of spherical modes receiving antennas in the configuration. +Type +SphericalModeReceivingAntennaCollection +TransmissionReflection +The collection of Transmission / reflection requests in the configuration. +Type +TransmissionReflectionCollection +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Stitch +A stitch operator. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create two rectangles to stitch together +rec1 = project.Contents.Geometry:AddRectangle(cf.Point(0, 0, 0), 1, 1) +rec2 = project.Contents.Geometry:AddRectangle(cf.Point(1, 0, 0.01), 1, 1) + -- Stitch rec1 and rec2 together with a tolerance of 0.05 +stitchedRectangles = project.Contents.Geometry:Stitch({rec1, rec2}, 0.05) +Inheritance +The Stitch object is derived from the Geometry object. +Usage locations +The Stitch object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method Stitch(table). +◦ GeometryCollection collection has method Stitch(List of Geometry). +◦ GeometryCollection collection has method Stitch(List of Geometry, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +CalculatedToleranceUsed +Specifies whether to use the calculated or user-defined tolerance. (Read/Write boolean) +ChildReferences +The geometry items to be transformed. (Read/Write ObjectReferenceList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Tolerance +The tolerance to use when stitching. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Collection List +Children +The collection of child operators of the operator. (OperatorCollection of Geometry.) +The collection of edges of the operator. (EdgeCollection of Edge.) +Edges +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +CalculatedToleranceUsed +Specifies whether to use the calculated or user-defined tolerance. +Type +boolean +Access +Read/Write +ChildReferences +The geometry items to be transformed. +Type +ObjectReferenceList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Tolerance +The tolerance to use when stitching. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Children +The collection of child operators of the operator. +Type +OperatorCollection +Edges +Faces +The collection of edges of the operator. +Type +EdgeCollection +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +p.2011 +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +Explode () +p.2013 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +StripCross +A strip cross. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a strip cross at the specified 'Point' +center = cf.Point(-0.25, -0.25, 0) +stripcross = project.Contents.Geometry:AddStripCross(center, 1.5, 1.2, 0.5, 0.3) +Inheritance +The StripCross object is derived from the Cross object. +Usage locations +The StripCross object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddStripCross(table). +◦ GeometryCollection collection has method AddStripCross(Point, Expression, Expression, +Expression, Expression). +Property List +ArmLengthU +The cross arm length (U). (Read/Write Dimension) +ArmLengthV +The cross arm length (V). (Read/Write Dimension) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The cross centre point. (Read/Write LocalCoordinate) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Parent +p.2016 +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +SlotWidth +The slot width. (Read/Write Dimension) +StripWidth +The cross strip width. (Read/Write Dimension) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Explode () +p.2017 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ArmLengthU +The cross arm length (U). +Type +Dimension +Access +Read/Write +ArmLengthV +The cross arm length (V). +Type +Dimension +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +The cross centre point. +Type +LocalCoordinate +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +SlotWidth +The slot width. +Type +Dimension +Access +Read/Write +StripWidth +The cross strip width. +Type +Dimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +p.2023 +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +StripCrossShape +A strip cross shape. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a strip cross shape +cross = + project.Definitions.PeriodicStructures.Shapes:AddStripCross(1.5, 1.2, 0.5, 0.4) +Inheritance +The StripCrossShape object is derived from the CrossShape object. +Usage locations +The StripCrossShape object can be accessed from the following locations: +• Methods +◦ ShapeCollection collection has method AddStripCross(table). +◦ ShapeCollection collection has method AddStripCross(Expression, Expression, Expression, +Expression). +Property List +ArmLengthU +The cross arm length (U). (Read/Write ParametricExpression) +ArmLengthV +The cross arm length (V). (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +SlotWidth +The strip cross slot width. (Read/Write ParametricExpression) +StripWidth +The cross strip width. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +BuildGeometry () +Creates the full geometry representation of the shape. (Returns a Geometry object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ArmLengthU +The cross arm length (U). +Type +ParametricExpression +Access +Read/Write +ArmLengthV +The cross arm length (V). +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +SlotWidth +The strip cross slot width. +Type +ParametricExpression +Access +Read/Write +StripWidth +The cross strip width. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +BuildGeometry () +Creates the full geometry representation of the shape. +Return +Geometry +The shape geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +StripHexagon +A strip hexagon. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a strip hexagon at the specified 'Point' +centre = cf.Point(-0.25, -0.25, 0) +hexagon= project.Contents.Geometry:AddStripHexagon(centre, 1.5, 0.2) +Inheritance +The StripHexagon object is derived from the Hexagon object. +Usage locations +The StripHexagon object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddStripHexagon(table). +◦ GeometryCollection collection has method AddStripHexagon(Point, Expression, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The hexagon centre point. (Read/Write LocalCoordinate) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +StripWidth +The width of the strip. (Read/Write Dimension) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +Width +The object type string. (Read only string) +The hexagon width. (Read/Write Dimension) +Collection List +p.2029 +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2030 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +The hexagon centre point. +Type +LocalCoordinate +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +StripWidth +The width of the strip. +Type +Dimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Width +The hexagon width. +Type +Dimension +Access +Read/Write +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2035 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +StripHexagonShape +A strip hexagon shape. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a strip hexagon shape +hexagon= project.Definitions.PeriodicStructures.Shapes:AddStripHexagon(1.5, 0.3) +Inheritance +The StripHexagonShape object is derived from the HexagonShape object. +Usage locations +The StripHexagonShape object can be accessed from the following locations: +• Methods +◦ ShapeCollection collection has method AddStripHexagon(table). +◦ ShapeCollection collection has method AddStripHexagon(Expression, Expression). +Property List +Label +The object label. (Read/Write string) +StripWidth +The hexagon strip width. (Read/Write ParametricExpression) +Type +Width +The object type string. (Read only string) +The hexagon width. (Read/Write ParametricExpression) +Method List +BuildGeometry () +Creates the full geometry representation of the shape. (Returns a Geometry object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.2037 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +StripWidth +The hexagon strip width. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Width +The hexagon width. +Type +ParametricExpression +Access +Read/Write +Method Details +BuildGeometry () +Creates the full geometry representation of the shape. +Return +Geometry +The shape geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Subtract +A subtract operator. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create some geometry +sphere = project.Contents.Geometry:AddSphere(cf.Point(0, 0, 0), 1) +cube = project.Contents.Geometry:AddCuboid(cf.Point(0, -0.5, -0.5), 1, 1, 1) +cylinder = project.Contents.Geometry:AddCylinder(cf.Point(0, 0, 0), 1, 1) + -- Subtract the cylinder and cuboid from the sphere +project.Contents.Geometry:Subtract(sphere, {cube, cylinder}) +Inheritance +The Subtract object is derived from the Geometry object. +Usage locations +The Subtract object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method Subtract(Geometry, List of Geometry). +◦ GeometryCollection collection has method Subtract(Geometry, Geometry). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ChildReferences +The geometry items to be transformed. (Read/Write ObjectReferenceList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Type +The object type string. (Read only string) +Collection List +Children +The collection of child operators of the operator. (OperatorCollection of Geometry.) +The collection of edges of the operator. (EdgeCollection of Edge.) +Edges +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Explode () +p.2041 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ChildReferences +The geometry items to be transformed. +Type +ObjectReferenceList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Children +The collection of child operators of the operator. +Type +OperatorCollection +Edges +Faces +The collection of edges of the operator. +Type +EdgeCollection +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +p.2046 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SurfaceBezierCurve +A surface Bezier curve. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +paraboloid = + project.Contents.Geometry:AddParaboloid(cf.Paraboloid.GetDefaultProperties()) + -- Add a work surface around the 'Paraboloid' +workSurface = project.Definitions.WorkSurfaces:Add(paraboloid.Faces["Face1"], 1) + -- Add a surface bezier curve along the 'WorkSurface' +bezierSurfaceCurve = project.Contents.Geometry:AddSurfaceBezierCurve(workSurface, + 0.4, 0.4, + 0.42, 0.42, + 0.43, 0.43, + 0.7, 0.7) + -- Increase the curve U' tangent +bezierSurfaceCurve.EndTangentPoint.U = 0.6 +Inheritance +The SurfaceBezierCurve object is derived from the AbstractSurfaceCurve object. +Usage locations +The SurfaceBezierCurve object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddSurfaceBezierCurve(table). +◦ GeometryCollection collection has method AddSurfaceBezierCurve(WorkSurface, Expression, +Expression, Expression, Expression, Expression, Expression, Expression, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +EndPoint +The end point of the Bezier curve on the work surface. (Read/Write SurfaceCoordinate) +EndTangentPoint +The end tangent point of the Bezier curve on the work surface. (Read/Write SurfaceCoordinate) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +LocalMeshSettingsEnabled +p.2048 +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +StartPoint +The start point of the Bezier curve on the work surface. (Read/Write SurfaceCoordinate) +StartTangentPoint +The star tangent point of the Bezier curve on the work surface. (Read/Write SurfaceCoordinate) +Type +The object type string. (Read only string) +WorkSurface +The referenced work surface used to map the U'V' coordinates. (Read/Write WorkSurface) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +EndPoint +The end point of the Bezier curve on the work surface. +Type +SurfaceCoordinate +Access +Read/Write +EndTangentPoint +The end tangent point of the Bezier curve on the work surface. +Type +SurfaceCoordinate +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +StartPoint +The start point of the Bezier curve on the work surface. +Type +SurfaceCoordinate +Access +Read/Write +StartTangentPoint +The star tangent point of the Bezier curve on the work surface. +Type +SurfaceCoordinate +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +WorkSurface +The referenced work surface used to map the U'V' coordinates. +Type +WorkSurface +Access +Read/Write +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.2055 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfaceCoordinate +Surface coordinates are used to define a 2D position (U', V') on a work surface. +p.2056 +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create some surface geometry +paraboloid = + project.Contents.Geometry:AddParaboloid(cf.Paraboloid.GetDefaultProperties()) +workSurface = project.Definitions.WorkSurfaces:Add(paraboloid.Faces["Face1"], 1) +surfaceLine = + project.Contents.Geometry:AddSurfaceLine(workSurface, 0.35, 0.35, 0.5, 0.5) + -- Modify the surface end coordinate +surfaceLine.EndPoint.U = "0.6" +surfaceLine.EndPoint.V = "0.4" +Inheritance +The SurfaceCoordinate object is derived from the CompositeValue object. +Usage locations +The SurfaceCoordinate object can be accessed from the following locations: +• Properties +◦ SurfaceBezierCurve object has property EndPoint. +◦ SurfaceBezierCurve object has property EndTangentPoint. +◦ SurfaceBezierCurve object has property StartPoint. +◦ SurfaceBezierCurve object has property StartTangentPoint. +◦ SurfaceLine object has property StartPoint. +◦ SurfaceLine object has property EndPoint. +◦ SurfaceRegularLines object has property StartCornerPoint. +◦ SurfaceRegularLines object has property EndCornerPoint. +◦ ConstrainedSurfacePoint object has property Surface. +• Methods +◦ SurfaceCoordinateList object has method Append(). +◦ SurfaceCoordinateList object has method Get(number). +Property List +The U' coordinate. (Read/Write Dimension) +The V' coordinate. (Read/Write Dimension) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property Details +p.2057 +The U' coordinate. +Type +Dimension +Access +Read/Write +The V' coordinate. +Type +Dimension +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfaceCoordinateList +A list of SurfaceCoordinate items. +Method List +Append () +p.2058 +Appends a new item to the list. (Returns a SurfaceCoordinate object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a SurfaceCoordinate object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +SurfaceCoordinate +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +SurfaceCoordinate +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +SurfaceImpedanceFrequencyPoint +Surface impedance modelling frequency point properties. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +surfaceImpedance = project.Definitions.Media.ImpedanceSheet:AddImpedanceSheet() +properties = surfaceImpedance:GetProperties() +properties.DefinitionMethod + = cf.Enums.MediumImpedanceDefinitionMethodEnum.FrequencyList +properties.FrequencyPoints[1].Frequency = 1e3 +properties.FrequencyPoints[1].ImpedanceReal = 1.0 +properties.FrequencyPoints[1].ImpedanceImaginary = 0 +surfaceImpedance:SetProperties(properties) + -- Modify the frequency of the first frequency point +surfaceImpedanceFrequencyPoint = surfaceImpedance.FrequencyPoints[1] +surfaceImpedanceFrequencyPoint.Frequency = 1.5e3 +Inheritance +The SurfaceImpedanceFrequencyPoint object is derived from the CompositeValue object. +Usage locations +The SurfaceImpedanceFrequencyPoint object can be accessed from the following locations: +• Methods +◦ SurfaceImpedanceFrequencyPointList object has method Append(). +◦ SurfaceImpedanceFrequencyPointList object has method Get(number). +Property List +Frequency +Surface impedance frequency value (Hz). (Read/Write ParametricExpression) +ImpedanceImaginary +Surface impedance imaginary value (Ohm). (Read/Write ParametricExpression) +ImpedanceReal +Surface impedance real value (Ohm). (Read/Write ParametricExpression) +Property Details +Frequency +Surface impedance frequency value (Hz). +Type +ParametricExpression +Access +Read/Write +ImpedanceImaginary +Surface impedance imaginary value (Ohm). +Type +ParametricExpression +Access +Read/Write +ImpedanceReal +Surface impedance real value (Ohm). +Type +ParametricExpression +Access +Read/Write +SurfaceImpedanceFrequencyPointList +A list of SurfaceImpedanceFrequencyPoint items. +Usage locations +The SurfaceImpedanceFrequencyPointList object can be accessed from the following locations: +• Properties +◦ +ImpedanceSheet object has property FrequencyPoints. +Method List +Append () +Appends a new item to the list. (Returns a SurfaceImpedanceFrequencyPoint object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a +SurfaceImpedanceFrequencyPoint object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +SurfaceImpedanceFrequencyPoint +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +SurfaceImpedanceFrequencyPoint +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +SurfaceLine +A surface line. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +paraboloid = + project.Contents.Geometry:AddParaboloid(cf.Paraboloid.GetDefaultProperties()) + -- Add a work surface 1m above the paraboloid face +workSurface = project.Definitions.WorkSurfaces:Add("WorkSurface1", + paraboloid.Faces["Face1"], 1) + -- Create a surface line on the specified 'WorkSurface' +surfaceLine = + project.Contents.Geometry:AddSurfaceLine(workSurface, 0.3, 0.3, 0.7, 0.7) +Inheritance +The SurfaceLine object is derived from the AbstractSurfaceCurve object. +Usage locations +The SurfaceLine object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddSurfaceLine(table). +◦ GeometryCollection collection has method AddSurfaceLine(WorkSurface, Expression, +Expression, Expression, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +EndPoint +The end point of the line on the work surface. (Read/Write SurfaceCoordinate) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +StartPoint +The start point of the line on the work surface. (Read/Write SurfaceCoordinate) +Type +The object type string. (Read only string) +WorkSurface +The referenced work surface used to map the U'V' coordinates. (Read/Write WorkSurface) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +EndPoint +The end point of the line on the work surface. +Type +SurfaceCoordinate +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +StartPoint +The start point of the line on the work surface. +Type +SurfaceCoordinate +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +WorkSurface +The referenced work surface used to map the U'V' coordinates. +Type +WorkSurface +Access +Read/Write +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Explode () +p.2071 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SurfaceRegularLines +Regular surface lines. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +paraboloid = + project.Contents.Geometry:AddParaboloid(cf.Paraboloid.GetDefaultProperties()) + -- Add a work surface around the 'Paraboloid' +workSurface = project.Definitions.WorkSurfaces:Add(paraboloid.Faces["Face1"], 1) + -- Add 8 surface lines at regular intervals along the 'WorkSurface' +regularSurfaceLine = + project.Contents.Geometry:AddSurfaceRegularLines(workSurface, 0.3, 0.32, 0.5, 0.7, 8) + -- Change the direction of the lines to vertical +regularSurfaceLine.ConstantParameter + = cf.Enums.SurfaceRegularLinesConstantParameterEnum.U +Inheritance +The SurfaceRegularLines object is derived from the AbstractSurfaceCurve object. +Usage locations +The SurfaceRegularLines object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddSurfaceRegularLines(table). +◦ GeometryCollection collection has method AddSurfaceRegularLines(WorkSurface, Expression, +Expression, Expression, Expression, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ConstantParameter +Specifies the parameter that will remain constant (direction of the lines). (Read/Write +SurfaceRegularLinesConstantParameterEnum) +EndCornerPoint +The end corner point of the regular lines on the work surface. (Read/Write SurfaceCoordinate) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +LocalMeshSettingsEnabled +p.2074 +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +NumLines +The number of lines. Only valid if SpacingMethod is set to SpecifyNumberOfLines. (Read/Write +number) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Spacing +The spacing between the lines. Only valid if SpacingMethod is set to SpecifyLineSpacing. (Read/ +Write ParametricExpression) +SpacingMethod +Specify how line spacing is determined. (Read/Write SurfaceRegularLinesSpacingMethodEnum) +StartCornerPoint +The start corner point of the regular lines on the work surface. (Read/Write SurfaceCoordinate) +Type +The object type string. (Read only string) +WorkSurface +The referenced work surface used to map the U'V' coordinates. (Read/Write WorkSurface) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +CopyAndMirror (properties table) +p.2075 +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ConstantParameter +Specifies the parameter that will remain constant (direction of the lines). +Type +SurfaceRegularLinesConstantParameterEnum +Access +Read/Write +EndCornerPoint +The end corner point of the regular lines on the work surface. +Type +SurfaceCoordinate +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +NumLines +The number of lines. Only valid if SpacingMethod is set to SpecifyNumberOfLines. +Type +number +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Spacing +The spacing between the lines. Only valid if SpacingMethod is set to SpecifyLineSpacing. +Type +ParametricExpression +Access +Read/Write +SpacingMethod +Specify how line spacing is determined. +Type +SurfaceRegularLinesSpacingMethodEnum +Access +Read/Write +StartCornerPoint +The start corner point of the regular lines on the work surface. +Type +SurfaceCoordinate +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +WorkSurface +The referenced work surface used to map the U'V' coordinates. +Type +WorkSurface +Access +Read/Write +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method Details +ConvertToPrimitive () +p.2079 +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Sweep +A sweep operator. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a line to sweep +line = + project.Contents.Geometry:AddLine(cf.Point(1.1, 0.6, 0), cf.Point(1.2, 1.4, 0.2)) + -- Sweep the line along the vector defined by two points +startCoord = cf.Point(1.1, 0.6, 0) +endCoord = cf.Point(0, 0.3, 0.8) +project.Contents.Geometry:Sweep(line, startCoord, endCoord) +Inheritance +The Sweep object is derived from the Geometry object. +Usage locations +The Sweep object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method Sweep(Geometry, table). +◦ GeometryCollection collection has method Sweep(Geometry, Point, Point). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ChildReferences +The geometry items to be transformed. (Read/Write ObjectReferenceList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +From +Label +The point to sweep from. (Read/Write LocalCoordinate) +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +To +Type +The point to sweep to. (Read/Write LocalCoordinate) +The object type string. (Read only string) +Collection List +Children +The collection of child operators of the operator. (OperatorCollection of Geometry.) +The collection of edges of the operator. (EdgeCollection of Edge.) +Edges +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ChildReferences +The geometry items to be transformed. +Type +ObjectReferenceList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +From +The point to sweep from. +Type +LocalCoordinate +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +To +The point to sweep to. +Type +LocalCoordinate +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Children +The collection of child operators of the operator. +Type +OperatorCollection +Edges +Faces +The collection of edges of the operator. +Type +EdgeCollection +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +p.2088 +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +Explode () +p.2090 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +TCross +A T-cross. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a T-cross at the specified 'Point' +center = cf.Point(-0.25, -0.25, 0) +cross = project.Contents.Geometry:AddTCross(center, 1.5, 1.2, 0.5) +Inheritance +The TCross object is derived from the Geometry object. +Usage locations +The TCross object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddTCross(table). +◦ GeometryCollection collection has method AddTCross(Point, Expression, Expression, +Expression). +Property List +ArmLength +The cross arm length. (Read/Write Dimension) +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The cross centre point. (Read/Write LocalCoordinate) +EdgeLength +The cross edge length. (Read/Write Dimension) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Parent +p.2093 +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +StripWidth +The cross strip width. (Read/Write Dimension) +Type +The object type string. (Read only string) +Collection List +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Explode () +p.2094 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ArmLength +The cross arm length. +Type +Dimension +Access +Read/Write +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +The cross centre point. +Type +LocalCoordinate +Access +Read/Write +EdgeLength +The cross edge length. +Type +Dimension +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +StripWidth +The cross strip width. +Type +Dimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +p.2097 +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +Explode () +p.2099 +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +TCrossShape +A t-cross shape. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a t-cross shape +cross = project.Definitions.PeriodicStructures.Shapes:AddTCross(2.0, 1.0, 0.2) +Inheritance +The TCrossShape object is derived from the Shape object. +Usage locations +The TCrossShape object can be accessed from the following locations: +• Methods +◦ ShapeCollection collection has method AddTCross(table). +◦ ShapeCollection collection has method AddTCross(Expression, Expression, Expression). +Property List +ArmLength +The t-cross arm length. (Read/Write ParametricExpression) +EdgeLength +The t-cross edge length. (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +StripWidth +The t-cross strip width. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +BuildGeometry () +Creates the full geometry representation of the shape. (Returns a Geometry object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2102 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ArmLength +The t-cross arm length. +Type +ParametricExpression +Access +Read/Write +EdgeLength +The t-cross edge length. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +StripWidth +The t-cross strip width. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +BuildGeometry () +Creates the full geometry representation of the shape. +Return +Geometry +The shape geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Terminal +A terminal of a component or a net. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +config = project.Contents.SolutionConfigurations + -- Create a transmission lines +transmissionLine = config.GlobalNetworks:AddTransmissionLine(10, 50, 25, 10) + -- Add a source to transmission line terminal +config.GlobalSources:AddVoltageSource(transmissionLine.Ports[1]) +Inheritance +The Terminal object is derived from the Object object. +Usage locations +The Terminal object can be accessed from the following locations: +• Properties +◦ Capacitor object has property Terminals. +◦ Ground object has property Terminals. +◦ Net object has property EndTerminal. +◦ Net object has property StartTerminal. +◦ Resistor object has property Terminals. +◦ CableConnector object has property Terminals. +◦ CableConnectorPin object has property Terminal. +◦ CableGeneralNetwork object has property Terminals. +◦ CableSchematicCurrentProbe object has property Terminals. +◦ CableSchematicVoltageProbe object has property Terminals. +◦ CableSpiceNetwork object has property Terminals. +◦ ComplexLoad object has property Terminals. +◦ +Inductor object has property Terminals. +◦ Transformer object has property Terminals. +◦ VoltageControlledVoltageSource object has property Terminals. +◦ CablePort object has property Terminals. +◦ EdgeMeshPort object has property Terminals. +◦ EdgePort object has property Terminals. +◦ AbstractFEMLinePort object has property Terminals. +◦ FEMLineMeshPort object has property Terminals. +◦ FEMLinePort object has property Terminals. +◦ MicrostripMeshPort object has property Terminals. +◦ WireMeshPort object has property Terminals. +◦ MicrostripPort object has property Terminals. +◦ WirePort object has property Terminals. +◦ GeneralNetwork object has property Terminals. +◦ TransmissionLine object has property Terminals. +• Methods +◦ TerminalCollection collection has method Item(number). +◦ TerminalCollection collection has method Item(string). +Property List +Label +The object label. (Read/Write string) +Location +The location of the terminal on the schematic. (Read only GridLocation) +Nets +Type +The nets attached to this terminal. (Read only List of Net) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Location +The location of the terminal on the schematic. +Type +GridLocation +Access +Read only +The nets attached to this terminal. +Access +Read only +Nets +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +TopologyEntity +An abstract (base) object for elements with topology information. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The TopologyEntity object is derived from the Object object. +The following objects are derived (specialisations) from the TopologyEntity object: +p.2108 +• Edge +• Face +• Region +Property List +Faulty +Indicates whether the geometry entity has faults. (Read only boolean) +Geometry +The geometry operator that the region belongs to. (Read only Geometry) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Faulty +Indicates whether the geometry entity has faults. +Type +boolean +Access +Read only +Geometry +The geometry operator that the region belongs to. +Type +Geometry +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +table +A table defining the properties. +SetProperties (properties Object) +p.2110 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Transform +A transform on a 3d object, e.g. geometry or mesh. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create geometry to transform +origin = cf.Point(0, 0, 0) +cube = project.Contents.Geometry:AddCuboidAtCentre(origin, 0.5, 0.5, 0.5) + -- Translate and rotate the geometry +translate = cube.Transforms:AddTranslate(origin, cf.Point(1.5, 0, 0)) +rotate = cube.Transforms:AddRotate(origin, cf.Point(0, 0, 1), 45) + -- Remove the translate transform +translate:Delete() +Inheritance +The Transform object is derived from the Object object. +The following objects are derived (specialisations) from the Transform object: +• Align +• Mirror +• Rotate +• Scale +• Translate +Usage locations +The Transform object can be accessed from the following locations: +• Methods +◦ TransformCollection collection has method AddTranslate(Point, Point). +◦ TransformCollection collection has method Item(number). +◦ TransformCollection collection has method Item(string). +Property List +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.2115 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Transformer +A cable transformer component. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a transformer +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +inductor1Terminal1 = cableHarness.Connectors["CableConnector1"].Pins["Pin1"].Terminal +inductor1Terminal2 = cableHarness.Connectors["CableConnector1"].Pins["Pin2"].Terminal +inductor2Terminal1 = cableHarness.Connectors["CableConnector2"].Pins["Pin1"].Terminal +inductor2Terminal2 = cableHarness.Connectors["CableConnector2"].Pins["Pin2"].Terminal +transformer = cableHarness.CableSchematic.Components:AddTransformer( + inductor1Terminal1, inductor1Terminal2, inductor2Terminal1, inductor2Terminal2, + 1e-6, 2e-6) + -- Change the transformers coupling coefficient +cableHarness.CableSchematic.Components["T1"].CouplingCoefficient = 0.8 +Inheritance +The Transformer object is derived from the Object object. +Usage locations +The Transformer object can be accessed from the following locations: +• Methods +◦ CableSchematicComponentCollection collection has method AddTransformer(table). +◦ CableSchematicComponentCollection collection has method AddTransformer(Terminal, +Terminal, Terminal, Terminal, Expression, Expression). +Property List +CoupledInductor1 +The value of coupled inductor 1 in Henry. (Read/Write ParametricExpression) +CoupledInductor2 +The value of coupled inductor 2 in Henry. (Read/Write ParametricExpression) +CouplingCoefficient +The coupling coefficient between the two inductors as a ratio. (Read/Write ParametricExpression) +CurrentProbeEnabled +True if a current probe must be applied to the component. (Read/Write boolean) +Label +The object label. (Read/Write string) +PhaseDefinition +The phase orientation definition between the two coupled inductors. (Read/Write +CableTransformerPhaseDefinitionEnum) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +VoltageProbeEnabled +True if a current probe must be applied to the component. (Read/Write boolean) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CoupledInductor1 +The value of coupled inductor 1 in Henry. +Type +ParametricExpression +Access +Read/Write +CoupledInductor2 +The value of coupled inductor 2 in Henry. +Type +ParametricExpression +Access +Read/Write +CouplingCoefficient +The coupling coefficient between the two inductors as a ratio. +Type +ParametricExpression +Access +Read/Write +CurrentProbeEnabled +True if a current probe must be applied to the component. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +PhaseDefinition +The phase orientation definition between the two coupled inductors. +Type +CableTransformerPhaseDefinitionEnum +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VoltageProbeEnabled +True if a current probe must be applied to the component. +Type +boolean +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.2120 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Translate +A translate transform. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Use 'Point' to translate a cone +cone = project.Contents.Geometry:AddCone(cf.Point(0, 0, 0), 1, 0.2, 1) +translate1 = cone.Transforms:AddTranslate(cf.Point(),cf.Point(1, 0, 0)) +translate2 = cone.Transforms:AddTranslate(cf.Point(),cf.Point(1, 0, 1)) +translate3 = cone.Transforms:AddTranslate(cf.Point(),cf.Point(1, 2, 1)) + -- Remove the first translate +translate1:Delete() +Inheritance +The Translate object is derived from the Transform object. +Usage locations +The Translate object can be accessed from the following locations: +• Methods +◦ TransformCollection collection has method AddTranslate(table). +Property List +From +Label +The translate transform start coordinates. (Read/Write LocalCoordinate) +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +To +Type +The translate transform end coordinates. (Read/Write LocalCoordinate) +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method List +CopyAndMirror (properties table) +p.2122 +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +From +The translate transform start coordinates. +Type +LocalCoordinate +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +To +The translate transform end coordinates. +Type +LocalCoordinate +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +TransmissionLine +An ideal non-radiating transmission line. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a transmission lines +p.2126 +project.Contents.SolutionConfigurations.GlobalNetworks:AddTransmissionLine(10, 50, 25, 10) +Inheritance +The TransmissionLine object is derived from the Network object. +Usage locations +The TransmissionLine object can be accessed from the following locations: +• Methods +◦ NetworkCollection collection has method AddTransmissionLine(table). +◦ NetworkCollection collection has method AddTransmissionLine(Expression, Expression, +Expression, Expression). +◦ NetworkCollection collection has method AddTransmissionLine(Expression, Expression, +Expression, Dielectric). +◦ NetworkCollection collection has method AddTransmissionLine(Expression, Expression, +Expression, Expression, Expression). +Property List +Attenuation +The transmission line losses (dB/m). Only applicable if DefinitionMethod is SpecifiedAttenuation or +VelocityOfPropagation. (Read/Write ParametricExpression) +DefinitionMethod +The transmission line definition method. (Read/Write TransmissionLineDefinitionMethodEnum) +InputOutputCrossed +Cross input and output ports. (Read/Write boolean) +Label +The object label. (Read/Write string) +LengthDetermined +Determine length from position. (Read/Write boolean) +LineLength +The transmission line length. This property is not valid when LengthDetermined is true. (Read/ +Write ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Medium +p.2127 +The dielectric medium used as the background medium for the transmission line. Only applicable +if DefinitionMethod is MediumAttenuation. (Read/Write Medium) +PropagationVelocity +The propagation speed through the transmission line relative to the speed of light. Only applicable +if DefinitionMethod is VelocityOfPropagation. (Read/Write ParametricExpression) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Z0Imaginary +The imaginary part of the characteristic impedance of the transmission line (Ohm). (Read/Write +ParametricExpression) +Z0Real +The real part of the characteristic impedance of the transmission line (Ohm). (Read/Write +ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Attenuation +The transmission line losses (dB/m). Only applicable if DefinitionMethod is SpecifiedAttenuation or +VelocityOfPropagation. +Type +ParametricExpression +Access +Read/Write +DefinitionMethod +The transmission line definition method. +Type +TransmissionLineDefinitionMethodEnum +Access +Read/Write +InputOutputCrossed +Cross input and output ports. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LengthDetermined +Determine length from position. +Type +boolean +Access +Read/Write +LineLength +The transmission line length. This property is not valid when LengthDetermined is true. +Type +ParametricExpression +Access +Read/Write +Medium +The dielectric medium used as the background medium for the transmission line. Only applicable +if DefinitionMethod is MediumAttenuation. +Type +Medium +Access +Read/Write +PropagationVelocity +The propagation speed through the transmission line relative to the speed of light. Only applicable +if DefinitionMethod is VelocityOfPropagation. +Type +ParametricExpression +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Z0Imaginary +The imaginary part of the characteristic impedance of the transmission line (Ohm). +Type +ParametricExpression +Access +Read/Write +Z0Real +The real part of the characteristic impedance of the transmission line (Ohm). +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +p.2131 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +TransmissionReflection +A transmission / reflection coefficient calculations request. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +transmissionReflectionCollection = + project.Contents.SolutionConfigurations[1].TransmissionReflection + -- Create a TransmissionReflection request +transmissionReflection = transmissionReflectionCollection:Add(0,0,0) + -- Modify the position of the TransmissionReflection request +transmissionReflection.Position = cf.Point(1,2,3) + -- Delete the TransmissionReflection request +transmissionReflection:Delete() +Inheritance +The TransmissionReflection object is derived from the Object object. +Usage locations +The TransmissionReflection object can be accessed from the following locations: +• Properties +◦ TransmissionReflectionOptimisationGoal object has property FocusSource. +• Methods +◦ TransmissionReflectionCollection collection has method Add(Expression, Expression, +Expression). +◦ TransmissionReflectionCollection collection has method Add(table). +◦ TransmissionReflectionCollection collection has method Item(number). +◦ TransmissionReflectionCollection collection has method Item(string). +Property List +ExportEnabled +Specifies if the transmission and reflection coefficients should be exported to a file (*.tr). (Read/ +Write boolean) +Label +The object label. (Read/Write string) +Position +The plane position for the phase reference. (Read/Write GlobalCoordinates) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.2133 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +ExportEnabled +Specifies if the transmission and reflection coefficients should be exported to a file (*.tr). +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Position +The plane position for the phase reference. +Type +GlobalCoordinates +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +TransmissionReflectionOptimisationGoal +A transmission / reflection optimisation goal. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +search = + project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) + -- Create a transmission reflection optimisation goal +properties = cf.TransmissionReflectionOptimisationGoal.GetDefaultProperties() +properties.FocusSourceLabel = "TXCoefficient" +properties.FocusSourceType + = cf.Enums.OptimisationFocusSourceTypeEnum.FocusSourceByLabel +properties.GoalOperator = cf.Enums.OptimisationGoalOperatorEnum.Minimise +properties.ProcessingSteps[1].Operation + = cf.Enums.OptimisationGoalProcessingStepsEnum.Magnitude +txReflectionGoal = search.Goals:AddTransmissionReflectionGoal(properties) + -- Set the polarisation type to CrossPolarisation +txReflectionGoal.PolarisationType = + cf.Enums.OptimisationTransmissionReflectionPolarisationTypeEnum.CrossPolarisation +Inheritance +The TransmissionReflectionOptimisationGoal object is derived from the OptimisationGoal object. +Usage locations +The TransmissionReflectionOptimisationGoal object can be accessed from the following locations: +• Methods +◦ OptimisationGoalCollection collection has method AddTransmissionReflectionGoal(table). +Property List +FocusSource +Set the focus source to a specified source object. The intended usage is for when the source is +defined in CADFEKO. (Read/Write TransmissionReflection) +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. (Read/Write string) +FocusType +Sets the focus type. (Read/Write OptimisationTransmissionReflectionFocusTypeEnum) +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +(Read/Write OptimisationGoalOperatorEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Label +The object label. (Read/Write string) +Objective +p.2136 +The objective describes a state that the optimisation process should attempt to achieve. (Read +only OptimisationGoalObjective) +PolarisationType +Sets the polarisation. (Read/Write OptimisationTransmissionReflectionPolarisationTypeEnum) +ProcessingSteps +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. (Read/Write OptimisationGoalProcessingStepsList) +Type +The object type string. (Read only string) +Weight +Specify the optimisation weight. (Read/Write ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +FocusSource +Set the focus source to a specified source object. The intended usage is for when the source is +defined in CADFEKO. +Type +TransmissionReflection +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FocusSourceLabel +Set the source focus label. The intended usage is for when the source is defined only in +EDITFEKO. +p.2137 +Type +string +Access +Read/Write +FocusType +Sets the focus type. +Type +OptimisationTransmissionReflectionFocusTypeEnum +Access +Read/Write +GoalOperator +The goal operator indicates the desired relationship between the goal focus and the objective. +Type +OptimisationGoalOperatorEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Objective +The objective describes a state that the optimisation process should attempt to achieve. +Type +OptimisationGoalObjective +Access +Read only +PolarisationType +Sets the polarisation. +Type +OptimisationTransmissionReflectionPolarisationTypeEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ProcessingSteps +p.2138 +A number of conversion steps or mathematical operations to be carried out on the goal focus +before the goal is evaluated. +Type +OptimisationGoalProcessingStepsList +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Weight +Specify the optimisation weight. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Trifilar +A trifilar. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a trifilar at the specified 'Point' +centre = cf.Point(-0.25, -0.25, 0) +trifilar = project.Contents.Geometry:AddTrifilar(centre, 1.5, 0.2) +Inheritance +The Trifilar object is derived from the Geometry object. +Usage locations +The Trifilar object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method AddTrifilar(table). +◦ GeometryCollection collection has method AddTrifilar(Point, Expression, Expression). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Centre +The trifilar centre point. (Read/Write LocalCoordinate) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +Length +The trifilar length. (Read/Write Dimension) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Altair Feko 2022.3 +2 Application Programming Interface (API) +StripWidth +The trifilar strip width. (Read/Write Dimension) +Type +The object type string. (Read only string) +Collection List +p.2141 +Edges +Faces +The collection of edges of the operator. (EdgeCollection of Edge.) +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2142 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Centre +The trifilar centre point. +Type +LocalCoordinate +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Length +The trifilar length. +Type +Dimension +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +StripWidth +The trifilar strip width. +Type +Dimension +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Edges +The collection of edges of the operator. +Type +EdgeCollection +Faces +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2147 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +TrifilarShape +A trifilar shape. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a trifilar shape +trifilar = project.Definitions.PeriodicStructures.Shapes:AddTrifilar(1.5, 0.2) +Inheritance +The TrifilarShape object is derived from the Shape object. +Usage locations +The TrifilarShape object can be accessed from the following locations: +• Methods +◦ ShapeCollection collection has method AddTrifilar(table). +◦ ShapeCollection collection has method AddTrifilar(Expression, Expression). +Property List +Label +The object label. (Read/Write string) +Length +The trifilar length. (Read/Write ParametricExpression) +StripWidth +The trifilar shape strip width. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +BuildGeometry () +Creates the full geometry representation of the shape. (Returns a Geometry object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.2149 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Length +The trifilar length. +Type +ParametricExpression +Access +Read/Write +StripWidth +The trifilar shape strip width. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +BuildGeometry () +Creates the full geometry representation of the shape. +Return +Geometry +The shape geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +UTDCylinderTerminationType +The uniform theory of diffraction (UTD) solution settings for cylinder regions. +p.2151 +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a cylinder +base = cf.Point(-0.25,-0.25,0) +cylinder = project.Contents.Geometry:AddCylinder(base, 0.5, 1.0) + -- Enable the UTD solution method and add end cap termination at the start +cylinderRegion = cylinder.Regions["Region1"] +properties = cylinderRegion:GetProperties() +properties.SolutionMethod = cf.Enums.RegionSolutionMethodEnum.UTD +properties.UTDCylinder.StartCapTerminated = true +cylinderRegion:SetProperties(properties) +Inheritance +The UTDCylinderTerminationType object is derived from the CompositeValue object. +Usage locations +The UTDCylinderTerminationType object can be accessed from the following locations: +• Properties +◦ MeshTetrahedronRegion object has property UTDCylinder. +◦ Region object has property UTDCylinder. +• Methods +◦ UTDCylinderTerminationTypeList object has method Append(). +◦ UTDCylinderTerminationTypeList object has method Get(number). +Property List +EndCapTerminated +Terminate the UTD cylinder's end cap. (Read/Write boolean) +StartCapTerminated +Terminate the UTD cylinder's start cap. (Read/Write boolean) +Property Details +EndCapTerminated +Terminate the UTD cylinder's end cap. +Type +boolean +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read/Write +StartCapTerminated +Terminate the UTD cylinder's start cap. +Type +boolean +Access +Read/Write +p.2152 +Altair Feko 2022.3 +2 Application Programming Interface (API) +UTDCylinderTerminationTypeList +A list of UTDCylinderTerminationType items. +Method List +Append () +p.2153 +Appends a new item to the list. (Returns a UTDCylinderTerminationType object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a UTDCylinderTerminationType +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +UTDCylinderTerminationType +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +UTDCylinderTerminationType +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.2154 +Altair Feko 2022.3 +2 Application Programming Interface (API) +UVPoint +p.2155 +A point in 2D space. This object lives in the Lua session only. Points are defined by numbers and cannot +be defined with expressions. Mathematical operations can be done on points. +Example + -- Create a default 'UVPoint' at (0,0,0) +p1 = pf.UVPoint.New() + -- Assign values to each component of the point +p1.x = 1 +p1.y = 1 + -- Create a 'UVPoint' with number values +p2 = pf.UVPoint(2,2) + -- Determine the distance between two points +distance = p1:distanceTo(p2) + -- Some of the valid operators for 'UVPoint' +p3 = 2 * p1 +p4 = p2 * 2 +p5 = p2 / 2 +p6 = -p2 +p7 = p1 + p2 +p8 = p1 - p2 +if (p1 ~= p2) then + print(p1.." is not equal to "..p2) +end +Usage locations +The UVPoint object can be accessed from the following locations: +• Static functions +◦ UVPoint object has static function New(number, number). +◦ UVPoint object has static function New(). +Property List +Type +The object type string. (Read only string) +The x component of the point. (Read/Write number) +The y component of the point. (Read/Write number) +The z component of the point. (Read/Write number) +Method List +DistanceTo (point UVPoint) +Returns the distance between this point and another. (Returns a number object.) +Constructor Function List +New (x number, y number) +Creates a new 2D point. (Returns a UVPoint object.) +New () +Creates a new point. (Returns a UVPoint object.) +Index List +[number] +Index a component of the point. (Read number) +[number] +Index a component of the point. (Write number) +Property Details +Type +The object type string. +Type +string +Access +Read only +The x component of the point. +Type +number +Access +Read/Write +The y component of the point. +Type +number +Access +Read/Write +The z component of the point. +Type +number +Access +Read/Write +Method Details +DistanceTo (point UVPoint) +Returns the distance between this point and another. +Input Parameters +point(UVPoint) +The point to measure the distance To from this point. +Return +number +The distance between the points. +Static Function Details +New (x number, y number) +Creates a new 2D point. +Input Parameters +x(number) +The x component. +y(number) +The y component. +Return +UVPoint +The new point. +New () +Creates a new point. +Return +UVPoint +The new point. +Union +A union operator. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Union two geometry parts +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +sphere = project.Contents.Geometry:AddSphere(cf.Point(0, 0, 0), 1) +union = project.Contents.Geometry:Union({cuboid,sphere}) +Inheritance +The Union object is derived from the Geometry object. +Usage locations +The Union object can be accessed from the following locations: +• Methods +◦ GeometryCollection collection has method Union(List of Geometry). +◦ GeometryCollection collection has method Union(). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +ChildReferences +The geometry items to be transformed. (Read/Write ObjectReferenceList) +Faulty +Indicates whether the geometry has faults. (Read only boolean) +Label +The object label. (Read/Write string) +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. (Read/Write MeshSettings) +Parent +The parent part of this geometry. If this is a top level part nil will be returned. (Read only +Geometry) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Collection List +Children +p.2159 +The collection of child operators of the operator. (OperatorCollection of Geometry.) +The collection of edges of the operator. (EdgeCollection of Edge.) +Edges +Faces +The collection of faces of the operator. (FaceCollection of Face.) +Regions +The collection of regions of the operator. (RegionCollection of Region.) +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Wires +The collection of wires of the operator. (WireCollection of Edge.) +Method List +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. (Returns a Geometry object.) +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. (Returns a List of Geometry object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2160 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +ChildReferences +The geometry items to be transformed. +Type +ObjectReferenceList +Access +Read/Write +Faulty +Indicates whether the geometry has faults. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalMeshSettingsEnabled +Control if the locally defined mesh settings should be used for the entity. +Type +boolean +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +MeshSettings +The locally defined mesh setting to use. This property is only available if +LocalMeshSettingsEnabled is true. +Type +MeshSettings +Access +Read/Write +Parent +The parent part of this geometry. If this is a top level part nil will be returned. +Type +Geometry +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Children +The collection of child operators of the operator. +Type +OperatorCollection +Edges +Faces +The collection of edges of the operator. +Type +EdgeCollection +The collection of faces of the operator. +Type +FaceCollection +Regions +The collection of regions of the operator. +Type +RegionCollection +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Wires +The collection of wires of the operator. +Type +WireCollection +Method Details +ConvertToPrimitive () +Convert the geometry into its primitive base form, returning a new part without the concrete type +properties. The reference to the original part will become invalid. +Return +Geometry +The new primitive geometry base. +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Explode () +Explode the geometry into separate surface and edge parts. The new parts represent a snapshot +of the geometry at the time it was exploded. +Return +List of Geometry +The list of new surface and edge parts. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReverseFaceNormals () +Reverse the geometry face normals. +ReverseFaceNormals (faces List of Face) +Reverse the geometry face normals. +Input Parameters +faces(List of Face) +The list of faces to reverse normal. +SetProperties (properties Object) +p.2165 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +UnlinkMesh (unlinkoption UnlinkMeshOptionEnum) +Unlinks the geometry's associated simulation mesh. +Input Parameters +unlinkoption(UnlinkMeshOptionEnum) +Mesh ports are created. Solution entities are either keep with their original +assignment or reassigned to the new port. +Return +Mesh +The unlinked mesh. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +UnitCell +A unit cell. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a ring shape +ringShape = project.Definitions.PeriodicStructures.Shapes:AddRing(1.0, 0.9) +-- Create a unit cell +properties = cf.UnitCell.GetDefaultProperties() +properties.Layers[1].Method = cf.Enums.UnitCellLayerMethodTypeEnum.Aperture +properties.Layers[1].Shape = ringShape +properties.Layers[1].Rotation = "0.0" +unitCell = project.Definitions.PeriodicStructures.UnitCells:AddUnitCell(properties) +-- Build geometry, for the unit cell, with PBC +unitCellGeometry = unitCell:BuildGeometry(true) +Inheritance +The UnitCell object is derived from the Object object. +Usage locations +The UnitCell object can be accessed from the following locations: +• Methods +◦ UnitCellCollection collection has method AddUnitCell(table). +◦ UnitCellCollection collection has method Item(number). +◦ UnitCellCollection collection has method Item(string). +Property List +DistanceU +The length along the U side of the unit cell. (Read/Write ParametricExpression) +DistanceV +The length along the V side of the unit cell. (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +Layers +The collection of layers that make up the unit cell definition. (Read/Write UnitCellLayerList) +ReferenceVector +Swap the unit cell direction between U and V vectors. (Read/Write UnitCellReferenceVectorEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SkewAngle +p.2167 +The angle between the reference vector and the unit cell. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +ZValue +The Z value at the top of layer 1. (Read/Write ParametricExpression) +Method List +BuildGeometry (setpbc boolean) +Creates the full geometry representation of the unit cell. (Returns a Geometry object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +DistanceU +The length along the U side of the unit cell. +Type +ParametricExpression +Access +Read/Write +DistanceV +The length along the V side of the unit cell. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Layers +The collection of layers that make up the unit cell definition. +Type +UnitCellLayerList +Access +Read/Write +ReferenceVector +Swap the unit cell direction between U and V vectors. +Type +UnitCellReferenceVectorEnum +Access +Read/Write +SkewAngle +The angle between the reference vector and the unit cell. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +ZValue +The Z value at the top of layer 1. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method Details +BuildGeometry (setpbc boolean) +Creates the full geometry representation of the unit cell. +Input Parameters +setpbc(boolean) +Sets the Periodic Boundary Condition if set to true. +p.2169 +Return +Geometry +The geometry built. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +UnitCellLayer +A layer within a unit cell. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Add a dielectric +properties = cf.Dielectric.GetDefaultProperties() +properties.DielectricModelling.RelativePermittivity = "2.0" +dielectric = + application.Project.Definitions.Media.Dielectric:AddDielectric(properties) +-- Add a strip hexagon +properties1 = cf.StripHexagonShape.GetDefaultProperties() +stripHexagonShape = + application.Project.Definitions.PeriodicStructures.Shapes:AddStripHexagon(properties1) +shape1 = application.Project.Definitions.PeriodicStructures.Shapes[1] +-- Add a unit cell with multiple layers +properties = cf.UnitCell.GetDefaultProperties() +properties.Layers[1].Thickness = "0.01" +properties.Layers[1].Medium = dielectric +properties.Layers[1].Method = cf.Enums.UnitCellLayerMethodTypeEnum.Substrate +properties.Layers[2] = {} +properties.Layers[2].Method = cf.Enums.UnitCellLayerMethodTypeEnum.Aperture +properties.Layers[2].Shape = shape1 +properties.Layers[2].FiniteThickness = true +properties.Layers[2].Thickness = "0.001" +properties.Layers[2].Rotation = "45" +properties.Layers[3] = {} +properties.Layers[3].Thickness = "0.02" +properties.Layers[3].Medium = dielectric +properties.Layers[3].Method = cf.Enums.UnitCellLayerMethodTypeEnum.Substrate +properties.ZValue = "0.05" +unitCell = + application.Project.Definitions.PeriodicStructures.UnitCells:AddUnitCell(properties) +-- Create geometry for the multi-layer unit cell and use periodic boundary conditions +unitCell:BuildGeometry(true) +Inheritance +The UnitCellLayer object is derived from the CompositeValue object. +Usage locations +The UnitCellLayer object can be accessed from the following locations: +• Methods +◦ UnitCellLayerList object has method Append(). +◦ UnitCellLayerList object has method Get(number). +Property List +FiniteThickness +Set finite thickness for a unit cell layer. (Read/Write boolean) +Medium +The medium of a unit cell layer. (Read/Write Dielectric) +Method +The type of unit cell layer. (Read/Write UnitCellLayerMethodTypeEnum) +Rotation +Rotation for a shape on a unit cell layer. (Read/Write ParametricExpression) +Shape +The shape used for the unit cell layer. (Read/Write Shape) +Thickness +Thickness of the unit cell layer. (Read/Write ParametricExpression) +Property Details +FiniteThickness +Set finite thickness for a unit cell layer. +Type +boolean +Access +Read/Write +Medium +The medium of a unit cell layer. +Type +Dielectric +Access +Read/Write +Method +The type of unit cell layer. +Type +UnitCellLayerMethodTypeEnum +Access +Read/Write +Rotation +Rotation for a shape on a unit cell layer. +Type +ParametricExpression +Access +Read/Write +Shape +The shape used for the unit cell layer. +Type +Shape +Access +Read/Write +Thickness +Thickness of the unit cell layer. +Type +ParametricExpression +Access +Read/Write +UnitCellLayerList +A list of UnitCellLayer items. +Usage locations +The UnitCellLayerList object can be accessed from the following locations: +• Properties +◦ UnitCell object has property Layers. +Method List +Append () +Appends a new item to the list. (Returns a UnitCellLayer object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a UnitCellLayer object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +UnitCellLayer +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +UnitCellLayer +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.2174 +UnprotectedInformation +Provides public information about the protected component. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Set the protected model's orientation workplane +workplane = project.UnprotectedInformation.OrientationWorkplane.LocalWorkplane +workplane.ReferencedWorkplane = project.Definitions.Workplanes:Item("Global XZ") +Inheritance +The UnprotectedInformation object is derived from the Object object. +Usage locations +The UnprotectedInformation object can be accessed from the following locations: +• Properties +Property List +Label +The object label. (Read/Write string) +OrientationWorkplane +Defines a workplane that can be used to orientate the protected component. (Read only +Workplane) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +p.2176 +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +OrientationWorkplane +Defines a workplane that can be used to orientate the protected component. +Type +Workplane +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.2177 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Variable +A variable expression. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create two variables, "freq" and "lambda" +freqVar = project.Definitions.Variables:Add("freq", 46e6, "The operating frequency") +lambdaVar = project.Definitions.Variables:Add("lambda", "c0/freq") +print("Name: "..tostring(lambdaVar)) +print("Expression: "..lambdaVar.Expression) +print("Value: "..lambdaVar.EvaluatedValue) + -- Use the predefined variable 'c0' to calculate a local lambda value +c0 = project.Definitions.Variables["c0"] +lambda = c0.EvaluatedValue/46e6 +print("Lambda: "..lambda) +Inheritance +The Variable object is derived from the Object object. +Usage locations +The Variable object can be accessed from the following locations: +• Properties +◦ OptimisationConstraint object has property LeftVariable. +◦ OptimisationConstraint object has property RightVariable. +◦ OptimisationVariable object has property Variable. +• Methods +◦ VariableCollection collection has method Add(table). +◦ VariableCollection collection has method Add(string, Expression). +◦ VariableCollection collection has method Add(string, Expression, string). +◦ VariableCollection collection has method Add(string, Variable). +◦ VariableCollection collection has method Item(number). +◦ VariableCollection collection has method Item(string). +Property List +Description +The variable description. (Read/Write string) +EvaluatedValue +The evaluated variable value. (Read only number) +Expression +The variable expression. (Read/Write ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Label +The object label. (Read/Write string) +LimitEnabled +p.2179 +Enables/disables variable limits. The variable can take on a value in the range defined by the +maximum and minimum bounds. (Read/Write boolean) +Maximum +Maximum value of variable. Only valid if variable is limited. (Read/Write ParametricExpression) +Minimum +Minimum value of variable. Only valid if variable is limited. (Read/Write ParametricExpression) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Description +The variable description. +Type +string +Access +Read/Write +EvaluatedValue +The evaluated variable value. +Type +number +Access +Read only +Expression +The variable expression. +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LimitEnabled +Enables/disables variable limits. The variable can take on a value in the range defined by the +maximum and minimum bounds. +Type +boolean +Access +Read/Write +Maximum +Maximum value of variable. Only valid if variable is limited. +Type +ParametricExpression +Access +Read/Write +Minimum +Minimum value of variable. Only valid if variable is limited. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Vector +p.2182 +A Cartesian vector (direction). This object lives in the Lua session only. Vectors are defined by numbers +and cannot be defined with expressions. Mathematical operations can be done on vectors. +Example + -- Create a default 'Vector' at (0,0,0) +v1 = pf.Vector.New() + -- Assign values to each component of the vector +v1.x = 1 +v1.y = 1 +v1.z = 1 + -- Create a 'Vector' with number values +v2 = pf.Vector(2,2,2) + -- Some of the valid operators for 'Vector' +v3 = 2 * v1 +v4 = v2 * 2 +v5 = v2 / 2 +v6 = -v2 +v7 = v1 + v2 +v8 = v1 - v2 +if (v1 ~= v2) then + print(v1.." is not equal to "..v2) +end +Usage locations +The Vector object can be accessed from the following locations: +• Properties +◦ Workplane object has property UVector. +◦ Workplane object has property VVector. +◦ WaveguideMeshPort object has property ReferenceVector. +◦ WaveguidePort object has property ReferenceVector. +• Static functions +◦ Vector object has static function New(number, number, number). +◦ Vector object has static function New(). +Property List +Type +The object type string. (Read only string) +The x component of the vector. (Read/Write number) +The y component of the vector. (Read/Write number) +The z component of the vector. (Read/Write number) +Constructor Function List +New (x number, y number, z number) +Creates a new vector. (Returns a Vector object.) +New () +Creates a new Vector. (Returns a Vector object.) +Index List +[number] +Index a component of the vector. (Read number) +[number] +Index a component of the vector. (Write number) +Property Details +Type +The object type string. +Type +string +Access +Read only +The x component of the vector. +Type +number +Access +Read/Write +The y component of the vector. +Type +number +Access +Read/Write +The z component of the vector. +Type +number +Access +Read/Write +Static Function Details +New (x number, y number, z number) +Creates a new vector. +Input Parameters +x(number) +The x component. +y(number) +The y component. +z(number) +The z component. +Return +Vector +The new vector. +New () +Creates a new Vector. +Return +Vector +The new vector. +Version +An object that describes that application version in detail. +Example +application = cf.Application.GetInstance() + -- Retrieve the various version components +vMajor = application.Version.Major +vMinor = application.Version.Minor +vPatch = application.Version.Patch +Inheritance +The Version object is derived from the Object object. +Usage locations +The Version object can be accessed from the following locations: +• Properties +◦ Application object has property Version. +Property List +Build +Label +Major +Minor +Patch +Type +The application build version. (Read only number) +The object label. (Read/Write string) +The application major version. (Read only number) +The application minor version. (Read only number) +The application patch version. (Read only number) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2186 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Build +The application build version. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Major +The application major version. +Type +number +Access +Read only +Minor +The application minor version. +Type +number +Access +Read only +Patch +The application patch version. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +View3DAxesFormat +The view 3D axes properties. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Configure the axes tick marks using using 'View3DAxesFormat' +view = application.MainWindow.MdiArea["3D View1"] +view.Axes.TickMarksVisible = true +Inheritance +The View3DAxesFormat object is derived from the CompositeValue object. +Usage locations +The View3DAxesFormat object can be accessed from the following locations: +• Methods +◦ View3DAxesFormatList object has method Append(). +◦ View3DAxesFormatList object has method Get(number). +Property List +MainVisible +Displays the main axes for the 3D view. (Read/Write boolean) +MiniVisible +Displays the mini axes for the 3D view. (Read/Write boolean) +TickMarksVisible +Displays the main axes tick marks for the 3D view. (Read/Write boolean) +Property Details +MainVisible +Displays the main axes for the 3D view. +Type +boolean +Access +Read/Write +MiniVisible +Displays the mini axes for the 3D view. +Type +boolean +Access +Read/Write +TickMarksVisible +Displays the main axes tick marks for the 3D view. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +View3DAxesFormatList +A list of View3DAxesFormat items. +Method List +Append () +p.2190 +Appends a new item to the list. (Returns a View3DAxesFormat object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a View3DAxesFormat object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +View3DAxesFormat +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +View3DAxesFormat +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ViewDisplayMode +The view display mode properties. +Example +p.2192 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +multiple_configurations.cfx]]}) + -- Change the display to show only the geometry without overlaying the mesh +application.MainWindow.MdiArea["3D View1"].DisplayMode.OverlayModeEnabled = false +Inheritance +The ViewDisplayMode object is derived from the CompositeValue object. +Usage locations +The ViewDisplayMode object can be accessed from the following locations: +• Methods +◦ ViewDisplayModeList object has method Append(). +◦ ViewDisplayModeList object has method Get(number). +Property List +ArraysVisible +Enables/disables the visibility of the antenna array elements. The antenna array base element is +indicated with green hatching. (Read/Write boolean) +Mode +The 3D view model display mode. (Read/Write ViewDisplayModeEnum) +OverlayModeEnabled +Enables/disables the overlay display. The Mode determines the primary display mode. The overlay +will render the unselected display mode with transparency. (Read/Write boolean) +Property Details +ArraysVisible +Enables/disables the visibility of the antenna array elements. The antenna array base element is +indicated with green hatching. +Type +boolean +Access +Read/Write +Mode +The 3D view model display mode. +Type +ViewDisplayModeEnum +Access +Read/Write +OverlayModeEnabled +Enables/disables the overlay display. The Mode determines the primary display mode. The overlay +will render the unselected display mode with transparency. +Type +boolean +Access +Read/Write +ViewDisplayModeList +A list of ViewDisplayMode items. +Method List +Append () +Appends a new item to the list. (Returns a ViewDisplayMode object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a ViewDisplayMode object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +ViewDisplayMode +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +ViewDisplayMode +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +ViewRenderingOptions +The view rendering properties. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Example_Expanded.cfx]]}) + -- Configure the model rendering to have 50% opacity +application.MainWindow.MdiArea["3D View1"].Rendering.ModelOpacity = 50 +Inheritance +The ViewRenderingOptions object is derived from the CompositeValue object. +Usage locations +The ViewRenderingOptions object can be accessed from the following locations: +• Methods +◦ ViewRenderingOptionsList object has method Append(). +◦ ViewRenderingOptionsList object has method Get(number). +Property List +CoatingsVisible +Display coatings on wires and triangular mesh. (Read/Write boolean) +ColourStyle +Colouring style applied to the model. (Read/Write ViewModelColourStyleEnum) +ConnectivityVisible +Displays the model connectivity lines. Faces with unbounded edges are shown in red. (Read/Write +boolean) +ModelOpacity +Model opacity as a percentage. (Read/Write number) +WindscreenLayersVisible +Displays the the individual layers of the windscreen. (Read/Write boolean) +Property Details +CoatingsVisible +Display coatings on wires and triangular mesh. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ColourStyle +Colouring style applied to the model. +Type +ViewModelColourStyleEnum +Access +Read/Write +ConnectivityVisible +Displays the model connectivity lines. Faces with unbounded edges are shown in red. +p.2197 +Type +boolean +Access +Read/Write +ModelOpacity +Model opacity as a percentage. +Type +number +Access +Read/Write +WindscreenLayersVisible +Displays the the individual layers of the windscreen. +Type +boolean +Access +Read/Write +ViewRenderingOptionsList +A list of ViewRenderingOptions items. +Method List +Append () +Appends a new item to the list. (Returns a ViewRenderingOptions object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a ViewRenderingOptions +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +ViewRenderingOptions +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +ViewRenderingOptions +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.2199 +ViewXt +A 3D model view where results can be plotted. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a large cuboid +cube = project.Contents.Geometry:AddCuboid(cf.Point(0,0,0), 10, 10, 10) + -- Get the first view +view1 = application.MainWindow.MdiArea[1] + -- Zoom to extents on the view +view1.ViewWindow.View:ZoomToExtents() +Inheritance +The ViewXt object is derived from the Object object. +Usage locations +The ViewXt object can be accessed from the following locations: +• Properties +◦ ViewXtWindow object has property View. +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ZoomToExtents () +Zoom the content of the window to its extent. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +p.2201 +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +ZoomToExtents () +Zoom the content of the window to its extent. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ViewXtWindow +A 3D model view window. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a large cuboid +cube = project.Contents.Geometry:AddCuboid(cf.Point(0,0,0), 10, 10, 10) + -- Get the first view +view1 = application.MainWindow.MdiArea[1] + -- Zoom to extents on the view +view1.ViewWindow.View:ZoomToExtents() +Inheritance +The ViewXtWindow object is derived from the Object object. +Property List +Height +The height of the window. (Read/Write number) +Label +Type +View +Width +The object label. (Read/Write string) +The object type string. (Read only string) +The 3D view of the window. (Read only ViewXt) +The width of the window. (Read/Write number) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +ExportImage (filename string, fileformat string) +Export the view window image at its same size to a specified file. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the view window image at the given size to a specified file. +ExportImage (filename string, fileformat string, imagesize ImageSizeEnum) +Export the view window image at a predefined size to a specified file. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Height +The height of the window. +Type +number +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +View +The 3D view of the window. +Type +ViewXt +Access +Read only +Width +The width of the window. +Type +number +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +ExportImage (filename string, fileformat string) +Export the view window image at its same size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the view window image at the given size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +imagewidth(number) +The export width in pixels. +imageheight(number) +The export height in pixels. +ExportImage (filename string, fileformat string, imagesize ImageSizeEnum) +Export the view window image at a predefined size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +imagesize(ImageSizeEnum) +The image size enum option, e.g. VGA, SVGA, etc. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +VoltageControlledVoltageSource +A cable voltage controlled voltage source component. +Example +p.2207 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a voltage controlled voltage source +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +connectionTerminal1 = + cableHarness.Connectors["CableConnector2"].Pins["Pin1"].Terminal +connectionTerminal2 = + cableHarness.Connectors["CableConnector2"].Pins["Pin2"].Terminal +controlTerminal1 = cableHarness.Connectors["CableConnector1"].Pins["Pin1"].Terminal +controlTerminal2 = cableHarness.Connectors["CableConnector1"].Pins["Pin2"].Terminal +source = cableHarness.CableSchematic.Components:AddVoltageControlledVoltageSource( + connectionTerminal1, connectionTerminal2, controlTerminal1, + controlTerminal2, 1.0) + -- Change the voltage gain +cableHarness.CableSchematic.Components["VCVS1"].VoltageGain = 0.7 +Inheritance +The VoltageControlledVoltageSource object is derived from the Object object. +Usage locations +The VoltageControlledVoltageSource object can be accessed from the following locations: +• Methods +◦ CableSchematicComponentCollection collection has method +AddVoltageControlledVoltageSource(FAIL - unsupported type). +◦ CableSchematicComponentCollection collection has method +AddVoltageControlledVoltageSource(Terminal, Terminal, Terminal, Terminal, Expression). +◦ CableSchematicComponentCollection collection has method +AddVoltageControlledVoltageSource(table). +Property List +CurrentProbeEnabled +True if a current probe must be applied to the component. (Read/Write boolean) +Label +The object label. (Read/Write string) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +VoltageGain +The gain of the voltage controlled voltage source as a ratio. (Read/Write ParametricExpression) +VoltageProbeEnabled +True if a current probe must be applied to the component. (Read/Write boolean) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +CurrentProbeEnabled +True if a current probe must be applied to the component. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VoltageGain +The gain of the voltage controlled voltage source as a ratio. +Type +ParametricExpression +Access +Read/Write +VoltageProbeEnabled +True if a current probe must be applied to the component. +Type +boolean +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +VoltageSource +A voltage source, impresses a voltage on the model. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create an edge port +p.2212 +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(1,1,0), 1, 1, 1) +edgePort = project.Contents.Ports:AddEdgePort({cuboid.Faces[1]},{cuboid.Faces[2]}) + -- Add a voltage source to the edge port +voltageSource = + project.Contents.SolutionConfigurations.GlobalSources:AddVoltageSource(edgePort) +Inheritance +The VoltageSource object is derived from the Source object. +Usage locations +The VoltageSource object can be accessed from the following locations: +• Properties +◦ +ImpedanceOptimisationGoal object has property FocusSource. +• Methods +◦ SourceCollection collection has method AddVoltageSource(table). +��� SourceCollection collection has method AddVoltageSource(Port). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Impedance +The reference impedance (Ohm). (Read/Write ParametricExpression) +Label +The object label. (Read/Write string) +Magnitude +The source magnitude. (Read/Write ParametricExpression) +Phase +Type +The source phase (degrees). (Read/Write ParametricExpression) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Impedance +The reference impedance (Ohm). +Type +ParametricExpression +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Magnitude +The source magnitude. +Type +ParametricExpression +Access +Read/Write +Phase +The source phase (degrees). +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +VoxelAdvancedSettings +Properties controlling advanced voxel mesh creation. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Get the voxel mesher advanced settings +advancedSettings = project.Mesher.VoxelSettings.Advanced + -- Set wire tracing connectivity enabled +advancedSettings.ConnectivityEnsured = true +Inheritance +The VoxelAdvancedSettings object is derived from the CompositeValue object. +Usage locations +The VoxelAdvancedSettings object can be accessed from the following locations: +• Properties +◦ VoxelSettings object has property Advanced. +• Methods +◦ VoxelAdvancedSettingsList object has method Append(). +◦ VoxelAdvancedSettingsList object has method Get(number). +Property List +AspectRatioLimiting +Control how the voxels' aspect ratios are handled. (Read/Write +MeshVoxelAspectRatioOptionsEnum) +AspectRatioThreshold +Specify the upper limit on the aspect ratio of all voxels. A dimensionless fraction [>1]. Only valid +if AspectRatioLimiting is Manual. (Read/Write ParametricExpression) +ConnectivityEnsured +Ensure connectivity through wire tracing using the face's edges. (Read/Write boolean) +GrowthRateLimiting +Control how the growth rate between voxels is handled. (Read/Write +MeshVoxelGrowthRateOptionsEnum) +GrowthRateThreshold +Specify the upper limit on the growth rate between adjacent voxels. A dimensionless fraction +[>1]. Only valid if GrowthRateLimiting is Manual. (Read/Write ParametricExpression) +SmallGeometrySuppression +Control how small geometry details are handled. (Read/Write +MeshVoxelSmallGeometryOptionsEnum) +SmallVoxelThreshold +Specify the lower limit on voxel size. A dimensionless fraction (0,1) of the ideal the +size determined from electromagnetic properties or specified in VoxelSize. Only valid if +SmallGeometrySuppression is Manual. (Read/Write ParametricExpression) +Property Details +AspectRatioLimiting +Control how the voxels' aspect ratios are handled. +Type +MeshVoxelAspectRatioOptionsEnum +Access +Read/Write +AspectRatioThreshold +Specify the upper limit on the aspect ratio of all voxels. A dimensionless fraction [>1]. Only valid +if AspectRatioLimiting is Manual. +Type +ParametricExpression +Access +Read/Write +ConnectivityEnsured +Ensure connectivity through wire tracing using the face's edges. +Type +boolean +Access +Read/Write +GrowthRateLimiting +Control how the growth rate between voxels is handled. +Type +MeshVoxelGrowthRateOptionsEnum +Access +Read/Write +GrowthRateThreshold +Specify the upper limit on the growth rate between adjacent voxels. A dimensionless fraction +[>1]. Only valid if GrowthRateLimiting is Manual. +Type +ParametricExpression +Access +Read/Write +SmallGeometrySuppression +Control how small geometry details are handled. +Type +MeshVoxelSmallGeometryOptionsEnum +Access +Read/Write +SmallVoxelThreshold +Specify the lower limit on voxel size. A dimensionless fraction (0,1) of the ideal the +size determined from electromagnetic properties or specified in VoxelSize. Only valid if +SmallGeometrySuppression is Manual. +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +VoxelAdvancedSettingsList +A list of VoxelAdvancedSettings items. +Method List +Append () +p.2219 +Appends a new item to the list. (Returns a VoxelAdvancedSettings object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a VoxelAdvancedSettings +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +VoxelAdvancedSettings +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +VoxelAdvancedSettings +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.2220 +Altair Feko 2022.3 +2 Application Programming Interface (API) +VoxelGridSummary +Information about the voxel grid setup. +Example +p.2221 +application = cf.Application.GetInstance() +project = application:Load({ + FEKO_HOME..[[/shared/Resources/Automation/ +Feeding_a_Horn_Antenna_Aperture_Feed.cfx]]}) +project.Contents.SolutionSettings.SolverSettings.FDTDSettings.FDTDEnabled = true + -- Get the voxel mesher grid summary info +voxelGridInfo = project.Mesher.VoxelSettings.GridInfo + -- Get the total number of voxels in the grid +count = voxelGridInfo.VoxelsTotal +Inheritance +The VoxelGridSummary object is derived from the CompositeValue object. +Usage locations +The VoxelGridSummary object can be accessed from the following locations: +• Properties +◦ VoxelSettings object has property GridInfo. +• Methods +◦ VoxelGridSummaryList object has method Append(). +◦ VoxelGridSummaryList object has method Get(number). +Property List +GridMaxInterval +The maximum grid interval. (Read only number) +GridMinInterval +The minimum grid interval. (Read only number) +MaxAspectRatio +The maximum aspect ratio in the grid. (Read only number) +MaxGrowthRate +The maximum growth rate in the grid. (Read only number) +VoxelsTotal +The total number of voxels in the grid. (Read only number) +VoxelsX +The number of voxels in the X axis direction. (Read only number) +VoxelsY +The number of voxels in the Y axis direction. (Read only number) +VoxelsZ +The number of voxels in the Z axis direction. (Read only number) +Property Details +GridMaxInterval +The maximum grid interval. +Type +number +Access +Read only +GridMinInterval +The minimum grid interval. +Type +number +Access +Read only +MaxAspectRatio +The maximum aspect ratio in the grid. +Type +number +Access +Read only +MaxGrowthRate +The maximum growth rate in the grid. +Type +number +Access +Read only +VoxelsTotal +The total number of voxels in the grid. +Type +number +Access +Read only +VoxelsX +The number of voxels in the X axis direction. +Type +number +Access +Read only +VoxelsY +The number of voxels in the Y axis direction. +Type +number +Access +Read only +VoxelsZ +The number of voxels in the Z axis direction. +Type +number +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +VoxelGridSummaryList +A list of VoxelGridSummary items. +Method List +Append () +p.2224 +Appends a new item to the list. (Returns a VoxelGridSummary object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a VoxelGridSummary object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +VoxelGridSummary +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +VoxelGridSummary +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +VoxelSettings +Settings applicable only to the creation of the voxel mesh. +Example +application = cf.Application.GetInstance() +project = application:Load({ + FEKO_HOME..[[/shared/Resources/Automation/ +Feeding_a_Horn_Antenna_Aperture_Feed.cfx]]}) + -- Enable FDTD and mesh the model +project.Contents.SolutionSettings.SolverSettings.FDTDSettings.FDTDEnabled = true +project.Mesher:Mesh() + -- Change the voxel mesh size to 'Fine' and remesh +project.Mesher.VoxelSettings.MeshSizeOption = cf.Enums.MeshSizeOptionEnum.Fine +project.Mesher:Mesh() +Inheritance +The VoxelSettings object is derived from the Object object. +Usage locations +The VoxelSettings object can be accessed from the following locations: +• Properties +◦ Mesher object has property VoxelSettings. +Property List +Advanced +Advanced voxel meshing settings. (Read/Write VoxelAdvancedSettings) +GridInfo +Information about the voxel grid setup. (Read/Write VoxelGridSummary) +IntrinsicWireRadiusEnabled +Specifies if the intrinsic wire radius should be used. Only applies if there is at least one wire in the +model. (Read/Write boolean) +Label +The object label. (Read/Write string) +MeshSizeOption +Voxel mesh size option. (Read/Write MeshSizeOptionEnum) +Type +The object type string. (Read only string) +VoxelSize +The length of each voxel edge. Only valid if MeshSize is Custom. (Read/Write +ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +WireRadius +p.2227 +Voxel wire segment radius. Only applies if there is at least one wire in the model. (Read/Write +ParametricExpression) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Advanced +Advanced voxel meshing settings. +Type +VoxelAdvancedSettings +Access +Read/Write +GridInfo +Information about the voxel grid setup. +Type +VoxelGridSummary +Access +Read/Write +IntrinsicWireRadiusEnabled +Specifies if the intrinsic wire radius should be used. Only applies if there is at least one wire in the +model. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MeshSizeOption +Voxel mesh size option. +Type +MeshSizeOptionEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +VoxelSize +The length of each voxel edge. Only valid if MeshSize is Custom. +Type +ParametricExpression +Access +Read/Write +WireRadius +Voxel wire segment radius. Only applies if there is at least one wire in the model. +Type +ParametricExpression +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.2229 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +WaveguideMeshPort +p.2230 +A waveguide mesh port is used to define a plane of excitation for a waveguide structure. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +MeshPorts.cfx]]}) +union1 = project.Contents.Geometry['Union1'] + -- Unlink the Mesh. 'WaveguideMeshPorts' are generated automatically from + 'WaveguidePorts' +union1:UnlinkMesh() + -- Get the 'WaveguideMeshPort' associated with 'WaveguidePort' labelled + 'WaveguidePort1' +waveguideMeshPort = project.Contents.Ports['WaveguidePort1_1'] + -- Query whether the mesh port is faulty +isFaulty = waveguideMeshPort.Faulty +Inheritance +The WaveguideMeshPort object is derived from the Port object. +Usage locations +The WaveguideMeshPort object can be accessed from the following locations: +• Methods +◦ PortCollection collection has method AddWaveguideMeshPort(table). +◦ PortCollection collection has method AddWaveguideMeshPort(MeshTriangleFace, Point). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +DirectionReversed +The option to set the propagation direction opposite to the normal direction. (Read/Write boolean) +Face +Label +The face to which the waveguide port is applied. (Read/Write MeshTriangleFace) +The object label. (Read/Write string) +ManualReferenceVector +The components for the reference vector. (Read/Write GlobalCoordinates) +MaxModalExpansionEnabled +The option to specify the maximum modal expansion indices manually. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +MaxModalExpansionIndexM +p.2231 +The option to specify the maximum modal expansion index m manually. This is only valid if +MaxModalExpansionEnabled is true. (Read/Write ParametricExpression) +MaxModalExpansionIndexN +The option to specify the maximum modal expansion index n manually. This is only valid if +MaxModalExpansionEnabled is true. (Read/Write ParametricExpression) +ReferenceVector +The components for the reference vector. (Read only Vector) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +DirectionReversed +The option to set the propagation direction opposite to the normal direction. +Type +boolean +Access +Read/Write +Face +The face to which the waveguide port is applied. +Type +MeshTriangleFace +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +ManualReferenceVector +The components for the reference vector. +Type +GlobalCoordinates +Access +Read/Write +MaxModalExpansionEnabled +The option to specify the maximum modal expansion indices manually. +Type +boolean +Access +Read/Write +MaxModalExpansionIndexM +The option to specify the maximum modal expansion index m manually. This is only valid if +MaxModalExpansionEnabled is true. +Type +ParametricExpression +Access +Read/Write +MaxModalExpansionIndexN +The option to specify the maximum modal expansion index n manually. This is only valid if +MaxModalExpansionEnabled is true. +Type +ParametricExpression +Access +Read/Write +ReferenceVector +The components for the reference vector. +Type +Vector +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +WaveguideModeOptions +The waveguide mode properties. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a waveguide port +p.2235 +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(-1,1,0), 1, 1, 1) +cuboid.Regions[1].Medium = project.Definitions.Media.FreeSpace +waveguidePort = project.Contents.Ports:AddWaveguidePort(cuboid.Faces[1]) + -- Add a waveguide source to the waveguide port +source = + project.Contents.SolutionConfigurations.GlobalSources:AddWaveguideSource(waveguidePort) + -- Specify the mode manually + -- A properties table is used as the changes need to be + -- made in one step +properties = source:GetProperties() +properties.SourceDefinitionType + = cf.Enums.WaveguideSourceDefinitionTypeEnum.SpecifyModesManually +properties.ManuallySpecifiedModesProperties[1].WaveguideModeType = + cf.Enums.SParameterWaveguideModeTypeEnum.TE +properties.ManuallySpecifiedModesProperties[1].IndexM = 1 +properties.ManuallySpecifiedModesProperties[1].IndexN = 1 +properties.ManuallySpecifiedModesProperties[1].Magnitude = 1 +properties.ManuallySpecifiedModesProperties[1].Phase = 0 +source:SetProperties(properties) +Inheritance +The WaveguideModeOptions object is derived from the CompositeValue object. +Usage locations +The WaveguideModeOptions object can be accessed from the following locations: +• Methods +◦ WaveguideModeOptionsList object has method Append(). +◦ WaveguideModeOptionsList object has method Get(number). +Property List +IndexM +The waveguide mode M index. (Read/Write ParametricExpression) +IndexN +The waveguide mode N index. (Read/Write ParametricExpression) +Magnitude +The waveguide mode magnitude (V). (Read/Write ParametricExpression) +Phase +The waveguide mode phase (degrees). (Read/Write ParametricExpression) +Rotation +The waveguide mode rotation (degrees). (Read/Write ParametricExpression) +WaveguideModeType +The waveguide mode type. (Read/Write SParameterWaveguideModeTypeEnum) +Property Details +IndexM +The waveguide mode M index. +Type +ParametricExpression +Access +Read/Write +IndexN +The waveguide mode N index. +Type +ParametricExpression +Access +Read/Write +Magnitude +The waveguide mode magnitude (V). +Type +ParametricExpression +Access +Read/Write +Phase +The waveguide mode phase (degrees). +Type +ParametricExpression +Access +Read/Write +Rotation +The waveguide mode rotation (degrees). +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +WaveguideModeType +The waveguide mode type. +Type +SParameterWaveguideModeTypeEnum +Access +Read/Write +p.2237 +Altair Feko 2022.3 +2 Application Programming Interface (API) +WaveguideModeOptionsList +A list of WaveguideModeOptions items. +Usage locations +p.2238 +The WaveguideModeOptionsList object can be accessed from the following locations: +• Properties +◦ WaveguideSource object has property ManuallySpecifiedModesProperties. +Method List +Append () +Appends a new item to the list. (Returns a WaveguideModeOptions object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a WaveguideModeOptions +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +WaveguideModeOptions +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +WaveguideModeOptions +The value at the given index. +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +Altair Feko 2022.3 +2 Application Programming Interface (API) +WaveguidePort +p.2240 +A waveguide port is used to define a plane of excitation for a waveguide structure. +Example +local application = cf.Application.GetInstance() +local project = application:NewProject() + -- Create a hollow cuboid +corner = cf.Point(-0.25, -0.25, 0) +cube = project.Contents.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25) +project.Contents.Geometry[1].Regions[1].Medium = project.Definitions.Media.FreeSpace + -- Create a waveguide port on the cube +port = project.Contents.Ports:AddWaveguidePort(cube.Faces[1]) +Inheritance +The WaveguidePort object is derived from the Port object. +Usage locations +The WaveguidePort object can be accessed from the following locations: +• Methods +◦ PortCollection collection has method AddWaveguidePort(table). +◦ PortCollection collection has method AddWaveguidePort(Face). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +DirectionReversed +The option to set the propagation direction opposite to the normal direction. (Read/Write boolean) +Face +Label +The face to which the waveguide port is applied. (Read/Write Face) +The object label. (Read/Write string) +ManualReferenceVector +The components for the reference vector. The reference vector must be set manually for +property to take effect.This is only valid if ManualReferenceVectorEnabled is true. (Read/Write +GlobalCoordinates) +ManualReferenceVectorEnabled +The option to specify the reference direction manually. (Read/Write boolean) +MaxModalExpansionEnabled +The option to specify the maximum modal expansion indices manually. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +MaxModalExpansionIndexM +p.2241 +The option to specify the maximum modal expansion index m manually. This is only valid if +MaxModalExpansionEnabled is true. (Read/Write ParametricExpression) +MaxModalExpansionIndexN +The option to specify the maximum modal expansion index n manually. This is only valid if +MaxModalExpansionEnabled is true. (Read/Write ParametricExpression) +ReferenceDirectionRotation +The reference direction rotation. This is only valid if ManualReferenceVectorEnabled is false. +(Read/Write WaveguidePortReferenceDirectionRotationEnum) +ReferenceVector +The components for the reference vector. The reference vector must be set manually for property +to take effect.This is only valid if ManualReferenceVectorEnabled is true. (Read only Vector) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +DirectionReversed +The option to set the propagation direction opposite to the normal direction. +Type +boolean +Access +Read/Write +Face +The face to which the waveguide port is applied. +Type +Face +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +ManualReferenceVector +The components for the reference vector. The reference vector must be set manually for property +to take effect.This is only valid if ManualReferenceVectorEnabled is true. +Type +GlobalCoordinates +Access +Read/Write +ManualReferenceVectorEnabled +The option to specify the reference direction manually. +Type +boolean +Access +Read/Write +MaxModalExpansionEnabled +The option to specify the maximum modal expansion indices manually. +Type +boolean +Access +Read/Write +MaxModalExpansionIndexM +The option to specify the maximum modal expansion index m manually. This is only valid if +MaxModalExpansionEnabled is true. +Type +ParametricExpression +Access +Read/Write +MaxModalExpansionIndexN +The option to specify the maximum modal expansion index n manually. This is only valid if +MaxModalExpansionEnabled is true. +Type +ParametricExpression +Access +Read/Write +ReferenceDirectionRotation +The reference direction rotation. This is only valid if ManualReferenceVectorEnabled is false. +Type +WaveguidePortReferenceDirectionRotationEnum +Access +Read/Write +ReferenceVector +The components for the reference vector. The reference vector must be set manually for property +to take effect.This is only valid if ManualReferenceVectorEnabled is true. +Type +Vector +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.2244 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +WaveguideSource +A waveguide source. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a waveguide port +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(-1,1,0), 1, 1, 1) +cuboid.Regions[1].Medium = project.Definitions.Media.FreeSpace +waveguidePort = project.Contents.Ports:AddWaveguidePort(cuboid.Faces[1]) + -- Add a waveguide source to the waveguide port +source = + project.Contents.SolutionConfigurations.GlobalSources:AddWaveguideSource(waveguidePort) +Inheritance +The WaveguideSource object is derived from the Source object. +Usage locations +The WaveguideSource object can be accessed from the following locations: +• Methods +◦ SourceCollection collection has method AddWaveguideSource(table). +◦ SourceCollection collection has method AddWaveguideSource(WaveguidePort). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +FundamentalModeOptions +The fundamental mode options. Only valid if SourceDefinitionType is ExciteFundamentalModeOnly. +(Read/Write FundamentalModeOptions) +Label +The object label. (Read/Write string) +Magnitude +The source magnitude. (Read/Write ParametricExpression) +ManuallySpecifiedModesProperties +The collection of waveguide mode properties. Only valid if SourceDefinitionType is +SpecifyModesManually. (Read/Write WaveguideModeOptionsList) +Phase +The source phase (degrees). (Read/Write ParametricExpression) +SourceDefinitionType +The waveguide source method. (Read/Write WaveguideSourceDefinitionTypeEnum) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +FundamentalModeOptions +The fundamental mode options. Only valid if SourceDefinitionType is ExciteFundamentalModeOnly. +Type +FundamentalModeOptions +Label +Access +Read/Write +The object label. +Type +string +Access +Read/Write +Magnitude +The source magnitude. +Type +ParametricExpression +Access +Read/Write +ManuallySpecifiedModesProperties +The collection of waveguide mode properties. Only valid if SourceDefinitionType is +SpecifyModesManually. +Type +WaveguideModeOptionsList +Access +Read/Write +Phase +The source phase (degrees). +Type +ParametricExpression +Access +Read/Write +SourceDefinitionType +The waveguide source method. +Type +WaveguideSourceDefinitionTypeEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.2248 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Windscreen +A windscreen medium. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +dielectric = project.Definitions.Media.Dielectric:AddDielectric() +layeredDielectric = + project.Definitions.Media.LayeredDielectric:AddLayeredDielectric({0.1},{dielectric}) + -- Create a windscreen medium +windscreenMedium = + project.Definitions.Media.Windscreen:AddWindscreen(layeredDielectric,0.1) + -- Change the offset of the windscreen medium +windscreenMedium.Offset = 0.2 +Inheritance +The Windscreen object is derived from the Medium object. +Usage locations +The Windscreen object can be accessed from the following locations: +• Properties +◦ WindscreenSolutionMethod object has property Medium. +• Methods +◦ WindscreenCollection collection has method AddWindscreen(table). +◦ WindscreenCollection collection has method AddWindscreen(LayeredIsotropicDielectric, +Expression). +◦ WindscreenCollection collection has method Item(number). +◦ WindscreenCollection collection has method Item(string). +Property List +Colour +The medium colour. (Read/Write string) +Label +The object label. (Read/Write string) +LayerDefinition +The layered dielectric contained in the windscreen layers. (Read/Write LayeredIsotropicDielectric) +Offset +The distance (in the model unit) from the windscreen curvature reference to the top of layer 1. +(Read/Write ParametricExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.2250 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +LayerDefinition +The layered dielectric contained in the windscreen layers. +Type +LayeredIsotropicDielectric +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Offset +p.2251 +The distance (in the model unit) from the windscreen curvature reference to the top of layer 1. +Type +ParametricExpression +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +WindscreenSolutionMethod +Windscreen solution method properties. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +p.2253 +rectangle = project.Contents.Geometry:AddRectangle(cf.Point(0,0,0),1,1) +dielectric = project.Definitions.Media.Dielectric:AddDielectric() +layeredDielectric = + project.Definitions.Media.LayeredDielectric:AddLayeredDielectric({0.1},{dielectric}) +windscreenMedium = + project.Definitions.Media.Windscreen:AddWindscreen(layeredDielectric,0.1) +face = rectangle.Faces[1] +properties = face:GetProperties() +properties.SolutionMethod = cf.Enums.FaceSolutionMethodEnum.Windscreen +properties.Windscreen.ElementType = cf.Enums.WindscreenElementTypeEnum.Reference +properties.Windscreen.Medium = windscreenMedium +face:SetProperties(properties) + -- Change the windscreen element type to Solution +properties.Windscreen.ElementType = cf.Enums.WindscreenElementTypeEnum.Solution +properties.Windscreen.OffsetA = 0.1 +face:SetProperties(properties) +Inheritance +The WindscreenSolutionMethod object is derived from the CompositeValue object. +Usage locations +The WindscreenSolutionMethod object can be accessed from the following locations: +• Properties +◦ MeshCurvilinearTriangleFace object has property Windscreen. +◦ MeshTriangleFace object has property Windscreen. +◦ MeshCurvilinearSegmentWire object has property Windscreen. +◦ MeshSegmentWire object has property Windscreen. +◦ MeshPlate object has property Windscreen. +◦ Edge object has property Windscreen. +◦ Face object has property Windscreen. +• Methods +◦ WindscreenSolutionMethodList object has method Append(). +◦ WindscreenSolutionMethodList object has method Get(number). +Property List +ElementType +The windscreen element type. Only applies to face entities. A windscreen reference element is +the curvature reference for the windscreen. The windscreen solution elements are the metallic +antenna elements. (Read/Write WindscreenElementTypeEnum) +Medium +The windscreen medium. (Read/Write Windscreen) +OffsetA +The distance from the windscreen curvature reference to the windscreen solution elements +(metallic antenna elements). (Read/Write ParametricExpression) +Property Details +ElementType +The windscreen element type. Only applies to face entities. A windscreen reference element is +the curvature reference for the windscreen. The windscreen solution elements are the metallic +antenna elements. +Type +WindscreenElementTypeEnum +Access +Read/Write +Medium +The windscreen medium. +Type +Windscreen +Access +Read/Write +OffsetA +The distance from the windscreen curvature reference to the windscreen solution elements +(metallic antenna elements). +Type +ParametricExpression +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +WindscreenSolutionMethodList +A list of WindscreenSolutionMethod items. +Method List +Append () +p.2255 +Appends a new item to the list. (Returns a WindscreenSolutionMethod object.) +Clear () +Clears the list. +Count () +Returns the number of items in the list. (Returns a number object.) +Get (index number) +Returns the item at the given index. Indexing starts at 1. (Returns a WindscreenSolutionMethod +object.) +Remove (index number) +Removes an item from the list. +Method Details +Append () +Appends a new item to the list. +Return +WindscreenSolutionMethod +The new value that was appended to the list. +Clear () +Clears the list. +Count () +Returns the number of items in the list. +Return +number +The number of items in the list. +Get (index number) +Returns the item at the given index. Indexing starts at 1. +Input Parameters +index(number) +The index of the item to return. +Return +WindscreenSolutionMethod +The value at the given index. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (index number) +Removes an item from the list. +Input Parameters +index(number) +The index of the item to remove. +p.2256 +Altair Feko 2022.3 +2 Application Programming Interface (API) +WireMeshPort +A port on a wire mesh segment or vertex. +Example +p.2257 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +MeshPorts.cfx]]}) +union1 = project.Contents.Geometry['Union1'] + -- Unlink the Mesh. 'WireMeshPorts' are generated automatically from 'WirePorts' +union1:UnlinkMesh() + -- Get the 'WireMeshPort' associated with the 'WirePort' labelled 'WirePort1' +wireMeshPort = project.Contents.Ports['WirePort1_1'] +-- + -- Query if the mesh port is faulty +isFaulty = wireMeshPort.Faulty +Inheritance +The WireMeshPort object is derived from the AbstractMeshPort object. +Usage locations +The WireMeshPort object can be accessed from the following locations: +• Methods +◦ PortCollection collection has method AddWireMeshPort(table). +◦ PortCollection collection has method AddWireMeshPort(MeshSegmentReference). +◦ PortCollection collection has method AddWireMeshPortOnVertex(MeshVertexReference). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +DefinitionMethod +The wire mesh port type definition. (Read/Write WirePortDefinitionMethodEnum) +Label +The object label. (Read/Write string) +PolarityReversed +The option to reverse polarity of the port. (Read/Write boolean) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +DefinitionMethod +The wire mesh port type definition. +Type +WirePortDefinitionMethodEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +PolarityReversed +The option to reverse polarity of the port. +Type +boolean +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +WirePort +p.2262 +A wire port is created on a wire edge, i.e. a free edge that does not form a face boundary. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create a line +line = project.Contents.Geometry:AddLine(cf.Point(0,0,0),cf.Point(1,1,0)) + -- Create a wire port on the line +port = project.Contents.Ports:AddWirePort(line.Wires[1]) +Inheritance +The WirePort object is derived from the Port object. +Usage locations +The WirePort object can be accessed from the following locations: +• Methods +◦ PortCollection collection has method AddWirePort(table). +◦ PortCollection collection has method AddWirePort(Edge). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +DefinitionMethod +The wire port type definition. (Read/Write WirePortDefinitionMethodEnum) +Label +The object label. (Read/Write string) +Location +The port location on the wire. (Read/Write WirePortLocationEnum) +PolarityReversed +The option to reverse polarity of the port. (Read/Write boolean) +PositionPercentage +The port position on the wire specified as a percentage (Range 0-100). Location must be set to +SpecifiedManually for this property to take effect. (Read/Write ParametricExpression) +Schematic +The schematic associated with this item. (Read only Schematic) +SchematicLocation +The location of the item on the schematic. (Read only GridLocation) +SchematicRotation +The rotation of the item on the schematic. (Read only SymbolRotationEnum) +Terminals +The schematic terminals on this item. (Read only List of Terminal) +Type +Wire +The object type string. (Read only string) +The free wire to which the port is connected. (Read/Write Edge) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +DefinitionMethod +The wire port type definition. +Type +WirePortDefinitionMethodEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Location +The port location on the wire. +Type +WirePortLocationEnum +Access +Read/Write +PolarityReversed +The option to reverse polarity of the port. +Type +boolean +Access +Read/Write +PositionPercentage +The port position on the wire specified as a percentage (Range 0-100). Location must be set to +SpecifiedManually for this property to take effect. +Type +ParametricExpression +Access +Read/Write +Schematic +The schematic associated with this item. +Type +Schematic +Access +Read only +SchematicLocation +The location of the item on the schematic. +Type +GridLocation +Access +Read only +SchematicRotation +The rotation of the item on the schematic. +Type +SymbolRotationEnum +Access +Read only +Terminals +The schematic terminals on this item. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Wire +The free wire to which the port is connected. +Type +Edge +Access +Read/Write +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2266 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +RotateSchematicSymbol () +Rotates the item on the schematic. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSchematicLocation (location GridLocation) +Sets the location of the item on the schematic. +Input Parameters +location(GridLocation) +The schematic location the item should be moved to. +SetSchematicRotation (rotation SymbolRotationEnum) +Sets the rotation of the item on the schematic. +Input Parameters +rotation(SymbolRotationEnum) +The rotation setting. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +WorkSurface +A work surface. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +paraboloid = + project.Contents.Geometry:AddParaboloid(cf.Paraboloid.GetDefaultProperties()) + -- Add a work surface onto the paraboloid face +workSurface = project.Definitions.WorkSurfaces:Add(paraboloid.Faces["Face1"], 0) + -- Move the work surface 1m below the paraboloid face +workSurface.Offset = -1 +Inheritance +The WorkSurface object is derived from the Object object. +Usage locations +The WorkSurface object can be accessed from the following locations: +• Properties +◦ AbstractSurfaceCurve object has property WorkSurface. +◦ SurfaceBezierCurve object has property WorkSurface. +◦ SurfaceLine object has property WorkSurface. +◦ SurfaceRegularLines object has property WorkSurface. +• Methods +◦ WorkSurfaceCollection collection has method Add(table). +◦ WorkSurfaceCollection collection has method Add(Face, Expression). +◦ WorkSurfaceCollection collection has method Add(string, Face, Expression). +◦ WorkSurfaceCollection collection has method Item(number). +◦ WorkSurfaceCollection collection has method Item(string). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Label +MaxU +MaxV +The object label. (Read/Write string) +The maximum U' coordinate of the work surface. (Read only number) +The maximum V' coordinate of the work surface. (Read only number) +MinU +MinV +Offset +The minimum U' coordinate of the work surface. (Read only number) +The minimum V' coordinate of the work surface. (Read only number) +The offset expression of the work surface from the reference face. (Read/Write +ParametricExpression) +ReferenceFace +The face that the work surface references. (Read/Write Face) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +The maximum U' coordinate of the work surface. +Type +number +Access +Read only +The maximum V' coordinate of the work surface. +Type +number +Access +Read only +The minimum U' coordinate of the work surface. +Type +number +Access +Read only +The minimum V' coordinate of the work surface. +MaxU +MaxV +MinU +MinV +Type +number +Access +Read only +Offset +The offset expression of the work surface from the reference face. +Type +ParametricExpression +Access +Read/Write +ReferenceFace +The face that the work surface references. +Type +Face +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Workplane +A workplane. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a new workplane definition to the project +wp = + project.Definitions.Workplanes:Add(cf.Point(1, 1, 1), cf.Point(0, -1, -1), cf.Point(1, 1, 0)) +Inheritance +The Workplane object is derived from the Object object. +Usage locations +The Workplane object can be accessed from the following locations: +• Properties +◦ MeshTetrahedronRegion object has property ReferenceWorkplane. +◦ Region object has property ReferenceWorkplane. +◦ UnprotectedInformation object has property OrientationWorkplane. +◦ LocalWorkplane object has property ReferencedWorkplane. +• Methods +◦ WorkplaneCollection collection has method Add(table). +◦ WorkplaneCollection collection has method Add(Point, Point, Point). +◦ WorkplaneCollection collection has method Item(number). +◦ WorkplaneCollection collection has method Item(string). +Property List +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Origin +The workplane origin. (Read only Point) +Type +The object type string. (Read only string) +UVector +The workplane U vector orientation. (Read only Vector) +VVector +The workplane V vector orientation. (Read only Vector) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetAsDefault () +Set the workplane as the default. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Origin +The workplane origin. +Type +Point +Access +Read only +Type +The object type string. +Type +string +Access +Read only +UVector +The workplane U vector orientation. +Type +Vector +Access +Read only +VVector +The workplane V vector orientation. +Type +Vector +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetAsDefault () +Set the workplane as the default. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.2276 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Zero +p.2277 +A non-physical medium that can be used with 3D anisotropic media. It represents no coupling to the +particular tensor component. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Get a reference to the zero medium for use in a 3D anisotropic medium +zeroMedium = project.Definitions.Media.Zero + -- Create a full tensor defined anisotropic 3D medium with zeros on the off + diagonal +dielUU = project.Definitions.Media.Dielectric:AddDielectric() +dielUU.Label = "dielUU" +dielVV = project.Definitions.Media.Dielectric:AddDielectric() +dielVV.Label = "dielVV" +dielNN = project.Definitions.Media.Dielectric:AddDielectric() +dielNN.Label = "dielNN" +properties = cf.AnisotropicDielectric.GetDefaultProperties() +properties.FullTensor[1][1] = dielUU +properties.FullTensor[2][1] = zeroMedium +properties.FullTensor[3][1] = zeroMedium +properties.FullTensor[1][2] = zeroMedium +properties.FullTensor[2][2] = dielVV +properties.FullTensor[3][2] = zeroMedium +properties.FullTensor[1][3] = zeroMedium +properties.FullTensor[2][3] = zeroMedium +properties.FullTensor[3][3] = dielNN +properties.TensorDescription = cf.Enums.TensorDescriptionMethodEnum.FullTensor +anisotropicDielectric = + project.Definitions.Media.AnisotropicDielectric:AddAnisotropicDielectric(properties) +Inheritance +The Zero object is derived from the Dielectric object. +Usage locations +The Zero object can be accessed from the following locations: +• Properties +◦ Media object has property Zero. +Property List +Colour +The medium colour. (Read/Write string) +DielectricModelling +The medium dielectric modelling properties. (Read/Write DielectricModelling) +Filename +The file describing the medium properties in XML format. (Read/Write FileReference) +Label +The object label. (Read/Write string) +MagneticModelling +The medium magnetic modelling properties. (Read/Write MagneticModelling) +MassDensity +Medium's mass density (kg/m^3). (Read/Write ParametricExpression) +SourceDefinitionMethod +Specifies the method used for defining the medium. (Read/Write +MediumSourceDefinitionMethodEnum) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Colour +The medium colour. +Type +string +Access +Read/Write +DielectricModelling +The medium dielectric modelling properties. +Type +DielectricModelling +Access +Read/Write +Filename +The file describing the medium properties in XML format. +Type +FileReference +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +MagneticModelling +The medium magnetic modelling properties. +Type +MagneticModelling +Access +Read/Write +MassDensity +Medium's mass density (kg/m^3). +Type +ParametricExpression +Access +Read/Write +SourceDefinitionMethod +Specifies the method used for defining the medium. +Type +MediumSourceDefinitionMethodEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +2.1.2 Collections (API) +p.2281 +AnisotropicDielectricCollection +A collection of anisotropic dielectric media. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Define media to be used in 3D anisotropic definition +dielUU = project.Definitions.Media.Dielectric:AddDielectric() +dielUV = project.Definitions.Media.Dielectric:AddDielectric() +dielUN = project.Definitions.Media.Dielectric:AddDielectric() +dielVU = project.Definitions.Media.Dielectric:AddDielectric() +dielVV = project.Definitions.Media.Dielectric:AddDielectric() +dielVN = project.Definitions.Media.Dielectric:AddDielectric() +dielNU = project.Definitions.Media.Dielectric:AddDielectric() +dielNV = project.Definitions.Media.Dielectric:AddDielectric() +dielNN = project.Definitions.Media.Dielectric:AddDielectric() + -- Create an anisotropic 3D medium +properties = cf.AnisotropicDielectric.GetDefaultProperties() +properties.MassDensity = "1000.0" +properties.FullTensor[1][1] = dielUU +properties.FullTensor[1][2] = dielUV +properties.FullTensor[1][3] = dielUN +properties.FullTensor[2][1] = dielVU +properties.FullTensor[2][2] = dielVV +properties.FullTensor[2][3] = dielVN +properties.FullTensor[3][1] = dielNU +properties.FullTensor[3][2] = dielNV +properties.FullTensor[3][3] = dielNN +properties.TensorDescription = cf.Enums.TensorDescriptionMethodEnum.FullTensor +AnisotropicDielectric = + project.Definitions.Media.AnisotropicDielectric:AddAnisotropicDielectric(properties) +Inheritance +The AnisotropicDielectricCollection object is derived from the Object object. +Usage locations +The AnisotropicDielectricCollection object can be accessed from the following locations: +• Collection lists +◦ Media object has collection AnisotropicDielectric. +Property List +Count +Label +The number of AnisotropicDielectric items in the collection. (Read only number) +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +AddAnisotropicDielectric (properties table) +p.2283 +Create a 3D anisotropic medium from a table defining the properties. (Returns a +AnisotropicDielectric object.) +AddAnisotropicDielectric (mediumuu Dielectric, mediumvv Dielectric, mediumnn Dielectric) +Create a 3D anisotropic medium. (Returns a AnisotropicDielectric object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the AnisotropicDielectric for the given index in the collection. (Returns a +AnisotropicDielectric object.) +Item (label string) +Returns the AnisotropicDielectric for the given label in the collection. (Returns a +AnisotropicDielectric object.) +Items () +Returns a table of AnisotropicDielectric items. (Returns a UnsupportedType(List of +AnisotropicDielectric) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of AnisotropicDielectric items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddAnisotropicDielectric (properties table) +Create a 3D anisotropic medium from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new 3D anisotropic medium. +Return +AnisotropicDielectric +The 3D anisotropic medium. +AddAnisotropicDielectric (mediumuu Dielectric, mediumvv Dielectric, mediumnn Dielectric) +Create a 3D anisotropic medium. +Input Parameters +mediumuu(Dielectric) +The dielectric media making up the U entry of the diagonal matrix. +mediumvv(Dielectric) +The dielectric media making up the V entry of the diagonal matrix. +mediumnn(Dielectric) +The dielectric media making up the N entry of the diagonal matrix. +Return +AnisotropicDielectric +The 3D anisotropic medium. +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.2285 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the AnisotropicDielectric for the given index in the collection. +Input Parameters +index(number) +The index of the AnisotropicDielectric. +Return +AnisotropicDielectric +The item in the collection +Item (label string) +Returns the AnisotropicDielectric for the given label in the collection. +Input Parameters +label(string) +The label of the AnisotropicDielectric. +Return +AnisotropicDielectric +The item in the collection +Items () +Returns a table of AnisotropicDielectric items. +Return +UnsupportedType(List of AnisotropicDielectric) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +AntennaArrayCollection +A collection of finite antenna arrays. +Example +p.2287 +application = cf.Application.GetInstance() +project = application:NewProject() +antennaArrays = project.Contents.SolutionSettings.AntennaArrays + -- Create a 6x3 circular array with radius of 3 +phiIncrement = 25 +offsetN = 2 +array = antennaArrays:AddCylindricalArray(3, 6, phiIncrement, 3, offsetN, false) + -- Convert the array to custom +array:ConvertToCustomArray() +print(#antennaArrays) +Inheritance +The AntennaArrayCollection object is derived from the Object object. +Usage locations +The AntennaArrayCollection object can be accessed from the following locations: +• Collection lists +Property List +BoundingBox +Count +Label +Type +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +The number of AbstractAntennaArray items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddArrayElement (properties table) +Create a custom antenna array element using the table of properties. (Returns a +CustomAntennaArray object.) +AddArrayElement (origin Point, magnitudescaling Expression, phaseoffset Expression) +Create a custom antenna array element. (Returns a CustomAntennaArray object.) +AddCylindricalArray (properties table) +Create a cylindrical/circular antenna array using the table of properties. (Returns a +CylindricalAntennaArray object.) +AddCylindricalArray (radius Expression, countphi number, countn number, offsetn Expression, +rotateelements boolean) +Create a cylindrical/circular antenna array where the elements is equally spaced in the Phi +dimension. (Returns a CylindricalAntennaArray object.) +AddCylindricalArray (radius Expression, countphi number, angle Expression, countn number, offsetn +Expression, rotateelements boolean) +Create a cylindrical/circular antenna array where the element spacing in the Phi dimension is +specified. (Returns a CylindricalAntennaArray object.) +AddPlanarArray (properties table) +Create a planar/linear antenna array using the table of properties. (Returns a LinearPlanarArray +object.) +AddPlanarArray (countu number, offsetu Expression, countv number, offsetv Expression) +Create a planar/linear antenna array. (Returns a LinearPlanarArray object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the AbstractAntennaArray for the given index in the collection. (Returns a +AbstractAntennaArray object.) +Item (label string) +Returns the AbstractAntennaArray for the given label in the collection. (Returns a +AbstractAntennaArray object.) +Items () +Returns a table of AbstractAntennaArray items. (Returns a UnsupportedType(List of +AbstractAntennaArray) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Count +The number of AbstractAntennaArray items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddArrayElement (properties table) +Create a custom antenna array element using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +CustomAntennaArray +The custom antenna array element. +AddArrayElement (origin Point, magnitudescaling Expression, phaseoffset Expression) +Create a custom antenna array element. +Input Parameters +origin(Point) +The element origin point. +magnitudescaling(Expression) +The element excitation magnitude scaling. +phaseoffset(Expression) +The element excitation phase offset. +Return +CustomAntennaArray +The custom antenna array element. +AddCylindricalArray (properties table) +Create a cylindrical/circular antenna array using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +CylindricalAntennaArray +The cylindrical/circular antenna array. +AddCylindricalArray (radius Expression, countphi number, countn number, offsetn Expression, +rotateelements boolean) +Create a cylindrical/circular antenna array where the elements is equally spaced in the Phi +dimension. +Input Parameters +radius(Expression) +The radius. +countphi(number) +The number of elements in the Phi dimension. +countn(number) +The number of elements in the N dimension. +offsetn(Expression) +The offset along the N axis in the N dimension. +rotateelements(boolean) +Whether to rotate each element to determine its new position. +Return +CylindricalAntennaArray +The cylindrical/circular antenna array. +AddCylindricalArray (radius Expression, countphi number, angle Expression, countn number, offsetn +Expression, rotateelements boolean) +Create a cylindrical/circular antenna array where the element spacing in the Phi dimension is +specified. +Input Parameters +radius(Expression) +The radius. +countphi(number) +The number of elements in the Phi dimension. +angle(Expression) +The spacing increment (in degress) in the Phi dimension. +countn(number) +The number of elements in the N dimension. +offsetn(Expression) +The offset along the N axis in the N dimension. +rotateelements(boolean) +Whether to rotate each element to determine its new position. +Return +CylindricalAntennaArray +The cylindrical/circular antenna array. +AddPlanarArray (properties table) +Create a planar/linear antenna array using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +LinearPlanarArray +The planar/linear antenna array. +AddPlanarArray (countu number, offsetu Expression, countv number, offsetv Expression) +Create a planar/linear antenna array. +Input Parameters +countu(number) +The number of elements in the U dimension. +offsetu(Expression) +The offset along the U axis in the U dimension. +countv(number) +The number of the elements in the V dimension. +offsetv (Expression) +The offset along the V axis in the V dimension. +Return +LinearPlanarArray +The planar/linear antenna array. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the AbstractAntennaArray for the given index in the collection. +Input Parameters +index(number) +The index of the AbstractAntennaArray. +Return +AbstractAntennaArray +The item in the collection +Item (label string) +Returns the AbstractAntennaArray for the given label in the collection. +Input Parameters +label(string) +The label of the AbstractAntennaArray. +Return +AbstractAntennaArray +The item in the collection +Items () +Returns a table of AbstractAntennaArray items. +Return +UnsupportedType(List of AbstractAntennaArray) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableConnectorCollection +A collection of CableConnectors. +Example +p.2294 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Retrieve a 'CablePath' and 'CableHarness' used to construct a connector +cablePath = project.Definitions.Cables.Paths["CablePath1"] +cableHarness = project.Contents.CableHarnesses:Item("CableHarness1") + -- Construct a 'CableConnector' with three pins +pinList = {"StartPin1", "StartPin2", "StartPin3"} +CableConnector = cableHarness.Connectors:Add(cablePath.StartTerminal, pinList) + -- Check if there is a connector on the harness with a specific label +found = cableHarness.Connectors:Contains("CableConnector2") +Inheritance +The CableConnectorCollection object is derived from the Object object. +Usage locations +The CableConnectorCollection object can be accessed from the following locations: +• Collection lists +◦ CableHarness object has collection Connectors. +Property List +BoundingBox +Count +Label +Type +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +The number of CableConnector items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Adds a new cable connector to the harness using the table of properties. (Returns a +CableConnector object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Add (position Point, pinNames string) +p.2295 +Adds a new cable connector at the given position to the harness. (Returns a CableConnector +object.) +Add (terminal CablePathTerminal, pinNames string) +Adds a new cable connector at the given path terminal to the harness. (Returns a CableConnector +object.) +Add (properties table, pinNames string) +Adds a new cable connector to the harness using the table of properties. (Returns a +CableConnector object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the CableConnector for the given index in the collection. (Returns a CableConnector +object.) +Item (label string) +Returns the CableConnector for the given label in the collection. (Returns a CableConnector +object.) +Items () +Returns a table of CableConnector items. (Returns a UnsupportedType(List of CableConnector) +object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Count +The number of CableConnector items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Adds a new cable connector to the harness using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +CableConnector +The cable connector. +Add (position Point, pinNames string) +Adds a new cable connector at the given position to the harness. +Input Parameters +position(Point) +The position of the cable connector. +pinNames(string) +The names of the connector pins. +Return +CableConnector +The cable connector. +Add (terminal CablePathTerminal, pinNames string) +Adds a new cable connector at the given path terminal to the harness. +Input Parameters +terminal(CablePathTerminal) +The cable path terminal the connector is connected to. +pinNames(string) +The names of the connector pins. +Return +CableConnector +The cable connector. +Add (properties table, pinNames string) +Adds a new cable connector to the harness using the table of properties. +Input Parameters +properties(table) +The table of properties. +pinNames(string) +The names of the connector pins. +Return +CableConnector +The cable connector. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the CableConnector for the given index in the collection. +Input Parameters +index(number) +The index of the CableConnector. +Return +CableConnector +The item in the collection +Item (label string) +Returns the CableConnector for the given label in the collection. +Input Parameters +label(string) +The label of the CableConnector. +Return +CableConnector +The item in the collection +Items () +Returns a table of CableConnector items. +Return +UnsupportedType(List of CableConnector) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableConnectorPinCollection +p.2299 +A collection of of connector pins that can be connected to cable signals and cable schematic +components. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Retrieve a 'CablePath' and 'CableHarness' used to construct a connector +cablePath = project.Definitions.Cables.Paths["CablePath1"] +cableHarness = project.Contents.CableHarnesses:Item("CableHarness1") + -- Construct a 'CableConnector' with three pins +pinList = {"StartPin1", "StartPin2", "StartPin3"} +CableConnector = cableHarness.Connectors:Add(cablePath.StartTerminal, pinList) +Inheritance +The CableConnectorPinCollection object is derived from the Object object. +Usage locations +The CableConnectorPinCollection object can be accessed from the following locations: +• Collection lists +◦ CableConnector object has collection Pins. +Property List +Count +Label +Type +The number of CableConnectorPin items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Item (index number) +p.2300 +Returns the CableConnectorPin for the given index in the collection. (Returns a CableConnectorPin +object.) +Item (label string) +Returns the CableConnectorPin for the given label in the collection. (Returns a CableConnectorPin +object.) +Items () +Returns a table of CableConnectorPin items. (Returns a UnsupportedType(List of +CableConnectorPin) object.) +SetPins (pinnames string) +Modifies the connector pins from a list of pin names. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of CableConnectorPin items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the CableConnectorPin for the given index in the collection. +Input Parameters +index(number) +The index of the CableConnectorPin. +Return +CableConnectorPin +The item in the collection +Item (label string) +Returns the CableConnectorPin for the given label in the collection. +Input Parameters +label(string) +The label of the CableConnectorPin. +Return +CableConnectorPin +The item in the collection +Items () +Returns a table of CableConnectorPin items. +Return +UnsupportedType(List of CableConnectorPin) +The list of items in the collection +SetPins (pinnames string) +Modifies the connector pins from a list of pin names. +Input Parameters +pinnames(string) +A list of pin names. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableCrossSectionCollection +A collection of cable cross sections. +Example +p.2303 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a cable bundle cross section to the collection +bundledCables = + { + project.Definitions.Cables.CrossSections["SingleConductor1"], + project.Definitions.Cables.CrossSections["TwistedPair1"] + } +bundle = project.Definitions.Cables.CrossSections:AddBundle(bundledCables) + -- Get a list of all the bundles in the collection +bundles = project.Definitions.Cables.CrossSections +Inheritance +The CableCrossSectionCollection object is derived from the Object object. +Usage locations +The CableCrossSectionCollection object can be accessed from the following locations: +• Collection lists +◦ Cables object has collection CrossSections. +Property List +Count +Label +Type +The number of CableCrossSection items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddBundle (properties table) +Create a cable bundle cross section. (Returns a CableBundleCrossSection object.) +AddBundle (cables List of CableCrossSection) +Create a cable bundle cross section. (Returns a CableBundleCrossSection object.) +AddCoaxial (properties table) +Create a coaxial cable cross section from the table defining the properties. (Returns a +CableCoaxialCrossSection object.) +AddCoaxialUsingDimensions (coremedium Medium, coreradius Expression, insulationmedium Medium, +insulationthickness Expression, shield CableShield) +Create a coaxial cable cross section defined by its dimensions. (Returns a +CableCoaxialCrossSection object.) +AddCoaxialUsingDimensionsWithCoating (coremedium Medium, coreradius Expression, +insulationmedium Medium, insulationthickness Expression, shield CableShield, coatingMedium Medium, +coatingThickness Expression) +Create a coaxial cable cross section defined by its dimensions. (Returns a +CableCoaxialCrossSection object.) +AddCoaxialUsingPropagationCharacteristics (magnitude Expression, phase Expression, attenuation +Expression, vop Expression, outerradius CableShield) +Create a coaxial cable cross section defined by its characteristics. (Returns a +CableCoaxialCrossSection object.) +AddCoaxialUsingPropagationCharacteristicsWithCoating (magnitude Expression, phase Expression, +attenuation Expression, vop Expression, outerradius CableShield, shield Medium, coatingMedium +Expression) +Create a coaxial cable cross section defined by its characteristics. (Returns a +CableCoaxialCrossSection object.) +AddNonConductingElement (properties table) +Create a non conducting element from the table defining the properties. (Returns a +CableNonConductingElementCrossSection object.) +AddNonConductingElementFromParameters (fibremedium Medium, radius Expression) +Create a non conducting element cross section. (Returns a +CableNonConductingElementCrossSection object.) +AddPredefinedCoaxial (coaxtype CablePredefinedCoaxialTypeEnum) +Create a predefined coaxial cable cross section. (Returns a CableCoaxialCrossSection object.) +AddRibbon (properties table) +Create a ribbon from the table defining the properties. (Returns a CableRibbonCrossSection +object.) +AddRibbon (coremedium Medium, coreradius Expression, numberofcores Expression, corespacing +Expression) +Create a ribbon cross section. (Returns a CableRibbonCrossSection object.) +AddRibbonWithInsulation (coremedium Medium, coreradius Expression, insulationmedium Medium, +insulationthickness Expression, numberofcores Expression, corespacing Expression) +Create a ribbon cross section. (Returns a CableRibbonCrossSection object.) +AddSingleConductor (properties table) +Create a single conductor from the table defining the properties. (Returns a +CableSingleConductorCrossSection object.) +AddSingleConductor (coremedium Medium, coreradius Expression) +Create a single conductor cross section with no insulation. (Returns a +CableSingleConductorCrossSection object.) +AddSingleConductorWithInsulation (coremedium Medium, coreradius Expression, insulationmedium +Medium, insulationthickness Expression) +Create a single conductor cross section with insulation. (Returns a +CableSingleConductorCrossSection object.) +AddTwistedPair (properties table) +Create a twisted pair from the table defining the properties. (Returns a +CableTwistedPairCrossSection object.) +AddTwistedPair (coremedium Medium, coreradius Expression, twistdirection TwistDirectionEnum, +twistradius Expression, twistlength Expression) +Create a twisted pair cross section. (Returns a CableTwistedPairCrossSection object.) +AddTwistedPairWithInsulation (coremedium Medium, coreradius Expression, insulationmedium +Dielectric, insulationthickness Expression, twistdirection TwistDirectionEnum, twistradius Expression, +twistlength Expression) +Create a twisted pair cross section. (Returns a CableTwistedPairCrossSection object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the CableCrossSection for the given index in the collection. (Returns a CableCrossSection +object.) +Item (label string) +Returns the CableCrossSection for the given label in the collection. (Returns a CableCrossSection +object.) +Items () +Returns a table of CableCrossSection items. (Returns a UnsupportedType(List of +CableCrossSection) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of CableCrossSection items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddBundle (properties table) +Create a cable bundle cross section. +Input Parameters +properties(table) +A table of properties defining the new bundle. +Return +CableBundleCrossSection +The cable bundle cross section. +AddBundle (cables List of CableCrossSection) +Create a cable bundle cross section. +Input Parameters +cables(List of CableCrossSection) +A list of cables to include in the bundle. +Return +CableBundleCrossSection +The cable bundle cross section. +AddCoaxial (properties table) +Create a coaxial cable cross section from the table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new coaxial cable. +Return +CableCoaxialCrossSection +The coaxial cable cross section. +AddCoaxialUsingDimensions (coremedium Medium, coreradius Expression, insulationmedium Medium, +insulationthickness Expression, shield CableShield) +Create a coaxial cable cross section defined by its dimensions. +Input Parameters +coremedium(Medium) +The core medium. +coreradius(Expression) +The core radius. +insulationmedium(Medium) +The insulation medium for the 1st layer. +insulationthickness(Expression) +The insulation medium for the 1st layer. +shield(CableShield) +The shield. +Return +CableCoaxialCrossSection +The coaxial cable cross section. +AddCoaxialUsingDimensionsWithCoating (coremedium Medium, coreradius Expression, +insulationmedium Medium, insulationthickness Expression, shield CableShield, coatingMedium Medium, +coatingThickness Expression) +Create a coaxial cable cross section defined by its dimensions. +Input Parameters +coremedium(Medium) +The core medium. +coreradius(Expression) +The core radius. +insulationmedium(Medium) +The insulation medium for the 1st layer. +insulationthickness(Expression) +The insulation medium for the 1st layer. +shield(CableShield) +The shield. +coatingMedium(Medium) +The coating medium. +coatingThickness(Expression) +The thickness of the coating. +Return +CableCoaxialCrossSection +The coaxial cable cross section. +AddCoaxialUsingPropagationCharacteristics (magnitude Expression, phase Expression, attenuation +Expression, vop Expression, outerradius CableShield) +Create a coaxial cable cross section defined by its characteristics. +Input Parameters +magnitude(Expression) +The magnitude of the characteristic impedance (Ohm). +phase(Expression) +The phase of the characteristic impedance (degrees). +attenuation(Expression) +The attenuation of the propagation in (dB/m). +vop(Expression) +The velocity of the propagation as a (%). +outerradius(CableShield) +The thickness of the insulation. +Return +CableCoaxialCrossSection +The coaxial cable cross section. +AddCoaxialUsingPropagationCharacteristicsWithCoating (magnitude Expression, phase +Expression, attenuation Expression, vop Expression, outerradius CableShield, shield Medium, +coatingMedium Expression) +Create a coaxial cable cross section defined by its characteristics. +Input Parameters +magnitude(Expression) +The magnitude of the characteristic impedance (Ohm). +phase(Expression) +The phase of the characteristic impedance (degrees). +attenuation(Expression) +The attenuation of the propagation in (dB/m). +vop(Expression) +The velocity of the propagation as a (%). +outerradius(CableShield) +The thickness of the insulation. +shield(Medium) +The shield. +coatingMedium(Expression) +The coating medium. +Return +CableCoaxialCrossSection +The coaxial cable cross section. +AddNonConductingElement (properties table) +Create a non conducting element from the table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new non conducting element. +Return +CableNonConductingElementCrossSection +The non conducting element. +AddNonConductingElementFromParameters (fibremedium Medium, radius Expression) +Create a non conducting element cross section. +Input Parameters +fibremedium(Medium) +The fibre medium. +radius(Expression) +The radius. +Return +CableNonConductingElementCrossSection +The non conducting element. +AddPredefinedCoaxial (coaxtype CablePredefinedCoaxialTypeEnum) +Create a predefined coaxial cable cross section. +Input Parameters +coaxtype(CablePredefinedCoaxialTypeEnum) +The coaxial cable type. +Return +CableCoaxialCrossSection +The coaxial cable type. +AddRibbon (properties table) +Create a ribbon from the table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new ribbon. +Return +CableRibbonCrossSection +The ribbon. +AddRibbon (coremedium Medium, coreradius Expression, numberofcores Expression, corespacing +Expression) +Create a ribbon cross section. +Input Parameters +coremedium(Medium) +The core medium. +coreradius(Expression) +The core radius. +numberofcores(Expression) +The number of cores. +corespacing(Expression) +The core spacing. +Return +CableRibbonCrossSection +The ribbon. +AddRibbonWithInsulation (coremedium Medium, coreradius Expression, insulationmedium Medium, +insulationthickness Expression, numberofcores Expression, corespacing Expression) +Create a ribbon cross section. +Input Parameters +coremedium(Medium) +The core medium. +coreradius(Expression) +The core radius. +insulationmedium(Medium) +The insulation medium. +insulationthickness(Expression) +The thickness of the insulation. +numberofcores(Expression) +The number of cores. +corespacing(Expression) +The core spacing. +Return +CableRibbonCrossSection +The ribbon. +AddSingleConductor (properties table) +Create a single conductor from the table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new single conductor. +Return +CableSingleConductorCrossSection +The single conductor. +AddSingleConductor (coremedium Medium, coreradius Expression) +Create a single conductor cross section with no insulation. +Input Parameters +coremedium(Medium) +The core medium. +coreradius(Expression) +The core radius. +Return +CableSingleConductorCrossSection +The cross section. +AddSingleConductorWithInsulation (coremedium Medium, coreradius Expression, insulationmedium +Medium, insulationthickness Expression) +Create a single conductor cross section with insulation. +Input Parameters +coremedium(Medium) +The core medium. +coreradius(Expression) +The core radius. +insulationmedium(Medium) +The insulation medium. +insulationthickness(Expression) +The thickness of the insulation. +Return +CableSingleConductorCrossSection +The cross section. +AddTwistedPair (properties table) +Create a twisted pair from the table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new twisted pair. +Return +CableTwistedPairCrossSection +The twisted pair. +AddTwistedPair (coremedium Medium, coreradius Expression, twistdirection TwistDirectionEnum, +twistradius Expression, twistlength Expression) +Create a twisted pair cross section. +Input Parameters +coremedium(Medium) +The core medium. +coreradius(Expression) +The core radius. +twistdirection(TwistDirectionEnum) +The twist direction. +twistradius(Expression) +The twist radius. +twistlength(Expression) +The twist length. +Return +CableTwistedPairCrossSection +The twisted pair. +AddTwistedPairWithInsulation (coremedium Medium, coreradius Expression, insulationmedium +Dielectric, insulationthickness Expression, twistdirection TwistDirectionEnum, twistradius Expression, +twistlength Expression) +Create a twisted pair cross section. +Input Parameters +coremedium(Medium) +The core medium. +coreradius(Expression) +The core radius. +insulationmedium(Dielectric) +The insulation medium. +insulationthickness(Expression) +The thickness of the insulation. +twistdirection(TwistDirectionEnum) +The twist direction. +twistradius(Expression) +The twist radius. +twistlength(Expression) +The twist length. +Return +CableTwistedPairCrossSection +The twisted pair. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the CableCrossSection for the given index in the collection. +Input Parameters +index(number) +The index of the CableCrossSection. +Return +CableCrossSection +The item in the collection +Item (label string) +Returns the CableCrossSection for the given label in the collection. +Input Parameters +label(string) +The label of the CableCrossSection. +Return +CableCrossSection +The item in the collection +Items () +Returns a table of CableCrossSection items. +Return +UnsupportedType(List of CableCrossSection) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableHarnessCollection +A collection of cable harnesses. +Example +p.2315 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add an empty 'CableHarness' +createTable = {} +createTable.Label = "EmptyCableHarness" +emptyCableHarness = project.Contents.CableHarnesses:Add(createTable) + -- Retrieve an existing 'CableHarness' +cableHarness1 = project.Contents.CableHarnesses:Item("CableHarness1") +Inheritance +The CableHarnessCollection object is derived from the Object object. +Usage locations +The CableHarnessCollection object can be accessed from the following locations: +• Collection lists +◦ ModelContents object has collection CableHarnesses. +Property List +Count +Label +Type +The number of CableHarness items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add () +Create a cable harness request. (Returns a CableHarness object.) +Add (properties table) +Create a cable harness request using the table of properties. (Returns a CableHarness object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2316 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the CableHarness for the given index in the collection. (Returns a CableHarness object.) +Item (label string) +Returns the CableHarness for the given label in the collection. (Returns a CableHarness object.) +Items () +Returns a table of CableHarness items. (Returns a UnsupportedType(List of CableHarness) +object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of CableHarness items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add () +Create a cable harness request. +Return +CableHarness +The cable harness. +Add (properties table) +Create a cable harness request using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +CableHarness +The cable harness. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the CableHarness for the given index in the collection. +Input Parameters +index(number) +The index of the CableHarness. +Return +CableHarness +The item in the collection +Item (label string) +Returns the CableHarness for the given label in the collection. +Input Parameters +label(string) +The label of the CableHarness. +Return +CableHarness +The item in the collection +Items () +Returns a table of CableHarness items. +Return +UnsupportedType(List of CableHarness) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableInstanceCollection +A collection of cable harnesses. +Example +p.2319 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add an empty 'CableHarness' +createTable = {} +createTable.Label = "EmptyCableHarness" +emptyCableHarness = project.Contents.CableHarnesses:Add(createTable) + -- Retrieve an existing 'CableHarness' +cableHarness1 = project.Contents.CableHarnesses:Item("CableHarness1") +Inheritance +The CableInstanceCollection object is derived from the Object object. +Usage locations +The CableInstanceCollection object can be accessed from the following locations: +• Collection lists +◦ CableHarness object has collection CableInstances. +Property List +BoundingBox +Count +Label +Type +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +The number of CableInstance items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Adds a new cable instance to the harness using table of properties. (Returns a CableInstance +object.) +Add (crosssection CableCrossSection, startconnector CableConnector, endconnector CableConnector) +Adds a new cable instance to the harness between two connectors. (Returns a CableInstance +object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the CableInstance for the given index in the collection. (Returns a CableInstance object.) +Item (label string) +Returns the CableInstance for the given label in the collection. (Returns a CableInstance object.) +Items () +Returns a table of CableInstance items. (Returns a UnsupportedType(List of CableInstance) +object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Count +The number of CableInstance items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Adds a new cable instance to the harness using table of properties. +Input Parameters +properties(table) +The table of properties defining the cable instance. +Return +CableInstance +The cable instance. +Add (crosssection CableCrossSection, startconnector CableConnector, endconnector CableConnector) +Adds a new cable instance to the harness between two connectors. +Input Parameters +crosssection(CableCrossSection) +The cross section for the cable instance. +startconnector(CableConnector) +The start connector. +endconnector(CableConnector) +The end connector. +Return +CableInstance +The cable instance. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2322 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the CableInstance for the given index in the collection. +Input Parameters +index(number) +The index of the CableInstance. +Return +CableInstance +The item in the collection +Item (label string) +Returns the CableInstance for the given label in the collection. +Input Parameters +label(string) +The label of the CableInstance. +Return +CableInstance +The item in the collection +Items () +Returns a table of CableInstance items. +Return +UnsupportedType(List of CableInstance) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CablePathCollection +A collection of cable paths. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a cable path to the cable path collection +corners = {cf.Point(0,0,0), cf.Point(0,1,0), cf.Point(1,1,0), cf.Point(1,0,0)} +path = project.Definitions.Cables.Paths:Add(corners) + -- Get the number of paths in the collection +count = project.Definitions.Cables.Paths.Count +Inheritance +The CablePathCollection object is derived from the Object object. +Usage locations +The CablePathCollection object can be accessed from the following locations: +• Collection lists +◦ Cables object has collection Paths. +Property List +BoundingBox +Count +Label +Type +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +The number of CablePath items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (cornerslist table) +Create a cable path from a list of points. (Returns a CablePath object.) +Add (properties List of Point) +Create a cable path using table of properties. (Returns a CablePath object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2325 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the CablePath for the given index in the collection. (Returns a CablePath object.) +Item (label string) +Returns the CablePath for the given label in the collection. (Returns a CablePath object.) +Items () +Returns a table of CablePath items. (Returns a UnsupportedType(List of CablePath) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Count +The number of CablePath items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (cornerslist table) +Create a cable path from a list of points. +Input Parameters +cornerslist(table) +The list of points defining the cable path. +Return +CablePath +The cable path. +Add (properties List of Point) +Create a cable path using table of properties. +Input Parameters +properties(List of Point) +The table of properties defining the cable path. +Return +CablePath +The cable path. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the CablePath for the given index in the collection. +Input Parameters +index(number) +The index of the CablePath. +Return +CablePath +The item in the collection +Item (label string) +Returns the CablePath for the given label in the collection. +Input Parameters +label(string) +The label of the CablePath. +Return +CablePath +The item in the collection +Items () +Returns a table of CablePath items. +Return +UnsupportedType(List of CablePath) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CableProbeCollection +A collection of cable probes. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Get an existing 'CableHarness' and 'CablePath' +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +cablePath = project.Definitions.Cables.Paths["CablePath1"] + -- Create a new 'CableProbe' +cableProbe = cableHarness.Probes:Add(cablePath) + -- Query the number of probes on 'CableHarness' +numberOfCableProbes = #cableHarness.Probes +Inheritance +The CableProbeCollection object is derived from the Object object. +Usage locations +The CableProbeCollection object can be accessed from the following locations: +• Collection lists +◦ CableHarness object has collection Probes. +Property List +Count +Label +Type +The number of CableProbe items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Adds a new cable probe along a cable path using table of properties. (Returns a CableProbe +object.) +Add (path CablePath) +Adds a new cable probe along a cable path. (Returns a CableProbe object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the CableProbe for the given index in the collection. (Returns a CableProbe object.) +Item (label string) +Returns the CableProbe for the given label in the collection. (Returns a CableProbe object.) +Items () +Returns a table of CableProbe items. (Returns a UnsupportedType(List of CableProbe) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of CableProbe items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Adds a new cable probe along a cable path using table of properties. +Input Parameters +properties(table) +The table of properties defining the cable probe. +Return +CableProbe +The new cable probe. +Add (path CablePath) +Adds a new cable probe along a cable path. +Input Parameters +path(CablePath) +The cable path to apply the probe on. +Return +CableProbe +The new cable probe. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the CableProbe for the given index in the collection. +Input Parameters +index(number) +The index of the CableProbe. +Return +CableProbe +The item in the collection +Item (label string) +Returns the CableProbe for the given label in the collection. +Input Parameters +label(string) +The label of the CableProbe. +Return +CableProbe +The item in the collection +Items () +Returns a table of CableProbe items. +Return +UnsupportedType(List of CableProbe) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CableSchematicComponentCollection +A collection of cable schematic components. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Get an existing 'CableHarness' +cableHarness = project.Contents.CableHarnesses["CableHarness1"] + -- Get the number of schematic components associated with a 'CableHarness' +componentCount = cableHarness.CableSchematic.Components.Count + -- Add a capacitor to between two terminals +terminal1 = cableHarness.Connectors["CableConnector2"].Pins["Pin2"].Terminal +terminal2 = cableHarness.Connectors["CableConnector2"].Pins["Pin1"].Terminal +capacitor = cableHarness.CableSchematic.Components:AddCapacitor(terminal1, terminal2, + 1e-6) +Inheritance +The CableSchematicComponentCollection object is derived from the CollectionOf_DomainEntity object. +Property List +Count +Label +Type +The number of Object items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddCapacitor () +Add a new capacitor to the cable harness schematic. (Returns a Capacitor object.) +AddCapacitor (properties table) +Add a new capacitor to the cable harness schematic using the specified properties. (Returns a +Capacitor object.) +AddCapacitor (terminal1 Terminal, terminal2 Terminal, capacitance Expression) +Add a new capacitor to the cable harness schematic and connect to specified terminals. (Returns a +Capacitor object.) +AddComplexLoad (properties FAIL - unsupported type) +Add a new complex load to the cable harness schematic using the specified properties. (Returns a +ComplexLoad object.) +AddComplexLoad (terminal1 Terminal, terminal2 Terminal, real Expression, imaginary Expression) +Add a new complex load to the cable harness schematic and connect to specified terminals. +(Returns a ComplexLoad object.) +AddComplexLoad (properties table) +Add a new complex load to the cable harness schematic. (Returns a ComplexLoad object.) +AddCurrentProbe (terminal1 Terminal, terminal2 Terminal) +Add a new current probe to the cable harness schematic and connect to specified terminals. +(Returns a CableSchematicCurrentProbe object.) +AddCurrentProbe (properties table) +Add a new current probe to the cable harness schematic using the specified properties. (Returns a +CableSchematicCurrentProbe object.) +AddGeneralNetwork (properties table) +Add a new general network to the cable harness schematic using the specified properties. +(Returns a CableGeneralNetwork object.) +AddGeneralNetwork (numports number, filename string) +Add a new general network to the cable harness schematic. (Returns a CableGeneralNetwork +object.) +AddGround () +Add a new ground to the cable harness schematic. (Returns a Ground object.) +AddGround (terminal Terminal) +Add a new ground to the cable harness schematic and connect to specified terminal. (Returns a +Ground object.) +AddGround (properties table) +Add a new ground to the cable harness schematic using the specified properties. (Returns a +Ground object.) +AddInductor () +Add a new inductor to the cable harness schematic. (Returns a Inductor object.) +AddInductor (properties table) +Add a new inductor to the cable harness schematic using the specified properties. (Returns a +Inductor object.) +AddInductor (terminal11 Terminal, terminal2 Terminal, inductance Expression) +Add a new inductor to the cable harness schematic and connect to specified terminals. (Returns a +Inductor object.) +AddResistor () +Add a new resistor to the cable harness schematic. (Returns a Resistor object.) +AddResistor (properties table) +Add a new resistor to the cable harness schematic using the specified properties. (Returns a +Resistor object.) +AddResistor (terminal1 Terminal, terminal2 Terminal, resistance Expression) +Add a new resistor to the cable harness schematic and connect to specified terminals. (Returns a +Resistor object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +AddSpiceNetwork (properties table) +p.2334 +Add a new SPICE network to the cable harness schematic using the specified properties. (Returns +a CableSpiceNetwork object.) +AddSpiceNetwork (numpins number, circuit string) +Add a new manually specified SPICE network to the cable harness schematic. (Returns a +CableSpiceNetwork object.) +AddSpiceNetworkFromFile (numpins number, filename string) +Add a new SPICE network to the cable harness schematic. (Returns a CableSpiceNetwork object.) +AddTransformer (properties table) +Add a new transformer to the cable harness schematic using the specified properties. (Returns a +Transformer object.) +AddTransformer (terminal1 Terminal, terminal2 Terminal, teminal3 Terminal, terminal4 Terminal, +coupledinductor1 Expression, coupledinductor2 Expression) +Add a new transformer to the cable harness schematic and connect to specified terminals. +(Returns a Transformer object.) +AddVoltageControlledVoltageSource (properties FAIL - unsupported type) +Add a new voltage controlled voltage source to the cable harness schematic using the specified +properties. (Returns a VoltageControlledVoltageSource object.) +AddVoltageControlledVoltageSource (terminal1 Terminal, terminal2 Terminal, teminal3 Terminal, +terminal4 Terminal, gain Expression) +Add a new voltage controlled voltage source to the cable harness schematic and connect to +specified terminals. (Returns a VoltageControlledVoltageSource object.) +AddVoltageControlledVoltageSource (properties table) +Add a new voltage controlled voltage source to the cable harness schematic and connect to +specified terminals. (Returns a VoltageControlledVoltageSource object.) +AddVoltageProbe (terminal1 Terminal, terminal2 Terminal) +Add a new voltage probe to the cable harness schematic and connect to specified terminals. +(Returns a CableSchematicVoltageProbe object.) +AddVoltageProbe (properties table) +Add a new voltage probe to the cable harness schematic using the specified properties. (Returns a +CableSchematicVoltageProbe object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Object for the given index in the collection. (Returns a Object object.) +Item (label string) +Returns the Object for the given label in the collection. (Returns a Object object.) +Items () +Returns a table of Object items. (Returns a UnsupportedType(List of Object) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Object items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddCapacitor () +Add a new capacitor to the cable harness schematic. +Return +Capacitor +The new component. +AddCapacitor (properties table) +Add a new capacitor to the cable harness schematic using the specified properties. +Input Parameters +properties(table) +A table of properties defining the new component. +Return +Capacitor +The new component. +AddCapacitor (terminal1 Terminal, terminal2 Terminal, capacitance Expression) +Add a new capacitor to the cable harness schematic and connect to specified terminals. +Input Parameters +terminal1(Terminal) +The terminal that the components first terminal should be connected to. +terminal2(Terminal) +The terminal that the components second terminal should be connected to. +capacitance(Expression) +The capacitance of the capacitor in Farad. +Return +Capacitor +The new component. +AddComplexLoad (properties FAIL - unsupported type) +Add a new complex load to the cable harness schematic using the specified properties. +Input Parameters +properties(FAIL - unsupported type) +A table of properties defining the new component. +Return +ComplexLoad +The new component. +AddComplexLoad (terminal1 Terminal, terminal2 Terminal, real Expression, imaginary Expression) +Add a new complex load to the cable harness schematic and connect to specified terminals. +Input Parameters +terminal1(Terminal) +The terminal that the components first terminal should be connected to. +terminal2(Terminal) +The terminal that the components second terminal should be connected to. +real(Expression) +The real impedance of the complex load in Ohm. +imaginary(Expression) +The imaginary impedance of the complex load in Ohm. +Return +ComplexLoad +The new component. +AddComplexLoad (properties table) +Add a new complex load to the cable harness schematic. +Input Parameters +properties(table) +A table of properties defining the new component. +Return +ComplexLoad +The new component. +AddCurrentProbe (terminal1 Terminal, terminal2 Terminal) +Add a new current probe to the cable harness schematic and connect to specified terminals. +Input Parameters +terminal1(Terminal) +The terminal that the components first terminal should be connected to. +terminal2(Terminal) +The terminal that the components second terminal should be connected to. +Return +CableSchematicCurrentProbe +The new current probe component. +AddCurrentProbe (properties table) +Add a new current probe to the cable harness schematic using the specified properties. +Input Parameters +properties(table) +A table of properties defining the new component. +Return +CableSchematicCurrentProbe +The new component. +AddGeneralNetwork (properties table) +Add a new general network to the cable harness schematic using the specified properties. +Input Parameters +properties(table) +A table of properties defining the new component. +Return +CableGeneralNetwork +The new component. +AddGeneralNetwork (numports number, filename string) +Add a new general network to the cable harness schematic. +Input Parameters +numports(number) +The number of ports. +filename(string) +The general network touchstone filename. +Return +CableGeneralNetwork +The new general network. +AddGround () +Add a new ground to the cable harness schematic. +Return +Ground +The new component. +AddGround (terminal Terminal) +Add a new ground to the cable harness schematic and connect to specified terminal. +Input Parameters +terminal(Terminal) +The terminal that the ground should be connected to. +Return +Ground +The new component. +AddGround (properties table) +Add a new ground to the cable harness schematic using the specified properties. +Input Parameters +properties(table) +A table of properties defining the new component. +Return +Ground +The new component. +AddInductor () +Add a new inductor to the cable harness schematic. +Return +Inductor +The new component. +AddInductor (properties table) +Add a new inductor to the cable harness schematic using the specified properties. +Input Parameters +properties(table) +A table of properties defining the new component. +Return +Inductor +The new component. +AddInductor (terminal11 Terminal, terminal2 Terminal, inductance Expression) +Add a new inductor to the cable harness schematic and connect to specified terminals. +Input Parameters +terminal11(Terminal) +The terminal that the components first terminal should be connected to. +terminal2(Terminal) +The terminal that the components second terminal should be connected to. +inductance(Expression) +The inductance of the inductor in Henry. +Return +Inductor +The new component. +AddResistor () +Add a new resistor to the cable harness schematic. +Return +Resistor +The new component. +AddResistor (properties table) +Add a new resistor to the cable harness schematic using the specified properties. +Input Parameters +properties(table) +A table of properties defining the new component. +Return +Resistor +The new component. +AddResistor (terminal1 Terminal, terminal2 Terminal, resistance Expression) +Add a new resistor to the cable harness schematic and connect to specified terminals. +Input Parameters +terminal1(Terminal) +The terminal that the components first terminal should be connected to. +terminal2(Terminal) +The terminal that the components second terminal should be connected to. +resistance(Expression) +The resistance of the resistor in Ohm. +Return +Resistor +The new component. +AddSpiceNetwork (properties table) +Add a new SPICE network to the cable harness schematic using the specified properties. +Input Parameters +properties(table) +A table of properties defining the new component. +Return +CableSpiceNetwork +The new spice circuit. +AddSpiceNetwork (numpins number, circuit string) +Add a new manually specified SPICE network to the cable harness schematic. +Input Parameters +numpins(number) +The number of pins. +circuit(string) +The spice circuit. +Return +CableSpiceNetwork +The new spice circuit. +AddSpiceNetworkFromFile (numpins number, filename string) +Add a new SPICE network to the cable harness schematic. +Input Parameters +numpins(number) +The number of pins. +filename(string) +The spice circuit filename. +Return +CableSpiceNetwork +The new spice circuit. +AddTransformer (properties table) +Add a new transformer to the cable harness schematic using the specified properties. +Input Parameters +properties(table) +A table of properties defining the new component. +Return +Transformer +The new component. +AddTransformer (terminal1 Terminal, terminal2 Terminal, teminal3 Terminal, terminal4 Terminal, +coupledinductor1 Expression, coupledinductor2 Expression) +Add a new transformer to the cable harness schematic and connect to specified terminals. +Input Parameters +terminal1(Terminal) +The terminal that the components first L1 terminal should be connected to. +terminal2(Terminal) +The terminal that the components second L1 terminal should be connected to. +teminal3(Terminal) +The terminal that the components first L2 terminal should be connected to. +terminal4(Terminal) +The terminal that the components second L2 terminal should be connected to. +coupledinductor1(Expression) +The inductance of the L1 coupled inductor. +coupledinductor2(Expression) +The inductance of the L2 coupled inductor. +Return +Transformer +The new component. +AddVoltageControlledVoltageSource (properties FAIL - unsupported type) +Add a new voltage controlled voltage source to the cable harness schematic using the specified +properties. +Input Parameters +properties(FAIL - unsupported type) +A table of properties defining the new component. +Return +VoltageControlledVoltageSource +The new component. +AddVoltageControlledVoltageSource (terminal1 Terminal, terminal2 Terminal, teminal3 Terminal, +terminal4 Terminal, gain Expression) +Add a new voltage controlled voltage source to the cable harness schematic and connect to +specified terminals. +Input Parameters +terminal1(Terminal) +The terminal that the source's positive terminal should be connected to. +terminal2(Terminal) +The terminal that the source's negative terminal should be connected to. +teminal3(Terminal) +The terminal that the component's positive probe terminal should be connected to. +terminal4(Terminal) +The terminal that the component's negative probe terminal should be connected to. +gain(Expression) +The voltage gain as a ratio. +Return +VoltageControlledVoltageSource +The new component. +AddVoltageControlledVoltageSource (properties table) +Add a new voltage controlled voltage source to the cable harness schematic and connect to +specified terminals. +Input Parameters +properties(table) +A table of properties defining the new component. +Return +VoltageControlledVoltageSource +The new component. +AddVoltageProbe (terminal1 Terminal, terminal2 Terminal) +Add a new voltage probe to the cable harness schematic and connect to specified terminals. +Input Parameters +terminal1(Terminal) +The terminal that the components first terminal should be connected to. +terminal2(Terminal) +The terminal that the components second terminal should be connected to. +Return +CableSchematicVoltageProbe +The new voltage probe component. +AddVoltageProbe (properties table) +Add a new voltage probe to the cable harness schematic using the specified properties. +Input Parameters +properties(table) +A table of properties defining the new component. +Return +CableSchematicVoltageProbe +The new component. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Object for the given index in the collection. +Input Parameters +index(number) +The index of the Object. +Return +Object +The item in the collection +Item (label string) +Returns the Object for the given label in the collection. +Input Parameters +label(string) +The label of the Object. +Return +Object +The item in the collection +Items () +Returns a table of Object items. +Return +UnsupportedType(List of Object) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CableShieldCollection +A collection of cable shields. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Add a solid shield +shield = + project.Definitions.Cables.Shields:AddSingleLayerSolidShield(project.Definitions.Media.PerfectElectricConductor, 0.0005) + -- Get the number of shields in the collection +count = project.Definitions.Cables.Shields.Count +Inheritance +The CableShieldCollection object is derived from the Object object. +Usage locations +The CableShieldCollection object can be accessed from the following locations: +• Collection lists +◦ Cables object has collection Shields. +Property List +Count +Label +Type +The number of CableShield items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddShield (properties table) +Create a shield from the table defining the properties. (Returns a CableShield object.) +AddSingleLayerBraidedDemoulinShield (numberOfCarriers Expression, weaveAngle Expression, +numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium) +Create a braided Demoulin shield. (Returns a CableShield object.) +AddSingleLayerBraidedKleyShield (numberOfCarriers Expression, weaveAngle Expression, +numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium) +Create a braided Kley shield. (Returns a CableShield object.) +AddSingleLayerBraidedTyniShield (numberOfCarriers Expression, weaveAngle Expression, +numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium) +Create a braided Tyni shield. (Returns a CableShield object.) +AddSingleLayerBraidedVanceShield (numberOfCarriers Expression, weaveAngle Expression, +numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium) +Create a braided Vance shield. (Returns a CableShield object.) +AddSingleLayerSolidShield (shieldMedium Medium, shieldThickness Expression) +Create a solid shield. (Returns a CableShield object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the CableShield for the given index in the collection. (Returns a CableShield object.) +Item (label string) +Returns the CableShield for the given label in the collection. (Returns a CableShield object.) +Items () +Returns a table of CableShield items. (Returns a UnsupportedType(List of CableShield) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of CableShield items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddShield (properties table) +Create a shield from the table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new shield. +Return +CableShield +The shield. +AddSingleLayerBraidedDemoulinShield (numberOfCarriers Expression, weaveAngle Expression, +numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium) +Create a braided Demoulin shield. +Input Parameters +numberOfCarriers(Expression) +The number of carriers. +weaveAngle(Expression) +The weave angle. +numberOfFilaments(Expression) +The number of filaments. +filamentDiameter(Expression) +The filament diameter. +filamentMedium(Medium) +The filament medium. +Return +CableShield +The shield. +AddSingleLayerBraidedKleyShield (numberOfCarriers Expression, weaveAngle Expression, +numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium) +Create a braided Kley shield. +Input Parameters +numberOfCarriers(Expression) +The number of carriers. +weaveAngle(Expression) +The weave angle. +numberOfFilaments(Expression) +The number of filaments. +filamentDiameter(Expression) +The number of filaments. +filamentMedium(Medium) +The filament medium. +Return +CableShield +The shield. +AddSingleLayerBraidedTyniShield (numberOfCarriers Expression, weaveAngle Expression, +numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium) +Create a braided Tyni shield. +Input Parameters +numberOfCarriers(Expression) +The number of carriers. +weaveAngle(Expression) +The weave angle. +numberOfFilaments(Expression) +The number of filaments. +filamentDiameter(Expression) +The filament diameter. +filamentMedium(Medium) +The filament medium. +Return +CableShield +The shield. +AddSingleLayerBraidedVanceShield (numberOfCarriers Expression, weaveAngle Expression, +numberOfFilaments Expression, filamentDiameter Expression, filamentMedium Medium) +Create a braided Vance shield. +Input Parameters +numberOfCarriers(Expression) +The number of carriers. +weaveAngle(Expression) +The weave angle. +numberOfFilaments(Expression) +The number of filaments. +filamentDiameter(Expression) +The filament diameter. +filamentMedium(Medium) +The filament medium. +Return +CableShield +The shield. +AddSingleLayerSolidShield (shieldMedium Medium, shieldThickness Expression) +Create a solid shield. +Input Parameters +shieldMedium(Medium) +The shield medium. +shieldThickness(Expression) +The shield thickness. +Return +CableShield +The shield. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the CableShield for the given index in the collection. +Input Parameters +index(number) +The index of the CableShield. +Return +CableShield +The item in the collection +Item (label string) +Returns the CableShield for the given label in the collection. +Input Parameters +label(string) +The label of the CableShield. +Return +CableShield +The item in the collection +Items () +Returns a table of CableShield items. +Return +UnsupportedType(List of CableShield) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CableSignalCollection +A collection of cable signals. +Example +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Get an existing 'CableHarness' and 'CableInstance' +cableHarness = project.Contents.CableHarnesses["CableHarness1"] +cableInstance = cableHarness.CableInstances["Cable1"] + -- Get the 'CableSignalSettings' of the 'CableInstance' +cableSignalSettings = cableInstance.Signals[1] + -- Get the number of signals on the cable instance +count = cableInstance.Signals.Count +Inheritance +The CableSignalCollection object is derived from the Object object. +Usage locations +The CableSignalCollection object can be accessed from the following locations: +• Collection lists +◦ CableInstance object has collection Signals. +Property List +Count +Label +Type +The number of CableSignal items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Item (index number) +p.2353 +Returns the CableSignal for the given index in the collection. (Returns a CableSignal object.) +Item (label string) +Returns the CableSignal for the given label in the collection. (Returns a CableSignal object.) +Items () +Returns a table of CableSignal items. (Returns a UnsupportedType(List of CableSignal) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of CableSignal items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.2354 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the CableSignal for the given index in the collection. +Input Parameters +index(number) +The index of the CableSignal. +Return +CableSignal +The item in the collection +Item (label string) +Returns the CableSignal for the given label in the collection. +Input Parameters +label(string) +The label of the CableSignal. +Return +CableSignal +The item in the collection +Items () +Returns a table of CableSignal items. +Return +UnsupportedType(List of CableSignal) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.2355 +Altair Feko 2022.3 +2 Application Programming Interface (API) +CharacterisedSurfaceCollection +A collection of characterised surface media. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create some characterised surfaces +p.2356 +characterisedSurface1 = + project.Definitions.Media.CharacterisedSurface:AddCharacterisedSurface("dummyFile") +characterisedSurface2 = + project.Definitions.Media.CharacterisedSurface:AddCharacterisedSurface("path\to +\file") +Inheritance +The CharacterisedSurfaceCollection object is derived from the Object object. +Usage locations +The CharacterisedSurfaceCollection object can be accessed from the following locations: +• Collection lists +◦ Media object has collection CharacterisedSurface. +Property List +Count +Label +Type +The number of CharacterisedSurface items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddCharacterisedSurface (properties table) +Create a characterised surface medium from a table defining the properties. (Returns a +CharacterisedSurface object.) +AddCharacterisedSurface (filename string) +Create a characterised surface medium. (Returns a CharacterisedSurface object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2357 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the CharacterisedSurface for the given index in the collection. (Returns a +CharacterisedSurface object.) +Item (label string) +Returns the CharacterisedSurface for the given label in the collection. (Returns a +CharacterisedSurface object.) +Items () +Returns a table of CharacterisedSurface items. (Returns a UnsupportedType(List of +CharacterisedSurface) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of CharacterisedSurface items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method Details +AddCharacterisedSurface (properties table) +Create a characterised surface medium from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new characterised surface medium. +p.2358 +Return +CharacterisedSurface +The characterised surface medium. +AddCharacterisedSurface (filename string) +Create a characterised surface medium. +Input Parameters +filename(string) +The file describing the medium properties. +Return +CharacterisedSurface +The characterised surface medium. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the CharacterisedSurface for the given index in the collection. +Input Parameters +index(number) +The index of the CharacterisedSurface. +Return +CharacterisedSurface +The item in the collection +Item (label string) +Returns the CharacterisedSurface for the given label in the collection. +Input Parameters +label(string) +The label of the CharacterisedSurface. +Return +CharacterisedSurface +The item in the collection +Items () +Returns a table of CharacterisedSurface items. +Return +UnsupportedType(List of CharacterisedSurface) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CollectionOf_DomainEntity +An abstract (base) collection for objects. +Example +p.2360 +-- This is an abstract object, see derived objects for examples +Inheritance +The CollectionOf_DomainEntity object is derived from the Object object. +The following objects are derived (specialisations) from the CollectionOf_DomainEntity object: +• CableSchematicComponentCollection +Property List +Count +Label +Type +The number of Object items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Object for the given index in the collection. (Returns a Object object.) +Item (label string) +Returns the Object for the given label in the collection. (Returns a Object object.) +Items () +Returns a table of Object items. (Returns a UnsupportedType(List of Object) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Object items in the collection. +p.2361 +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Object for the given index in the collection. +Input Parameters +index(number) +The index of the Object. +Return +Object +The item in the collection +Item (label string) +Returns the Object for the given label in the collection. +Input Parameters +label(string) +The label of the Object. +Return +Object +The item in the collection +Items () +Returns a table of Object items. +Return +UnsupportedType(List of Object) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CollectionOf_Mesh +An abstract (base) object for collections of mesh. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The CollectionOf_Mesh object is derived from the Object object. +Property List +Count +Label +Type +The number of Mesh items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Mesh for the given index in the collection. (Returns a Mesh object.) +Item (label string) +Returns the Mesh for the given label in the collection. (Returns a Mesh object.) +Items () +Returns a table of Mesh items. (Returns a UnsupportedType(List of Mesh) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property Details +Count +The number of Mesh items in the collection. +p.2364 +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Mesh for the given index in the collection. +Input Parameters +index(number) +The index of the Mesh. +Return +Mesh +The item in the collection +Item (label string) +Returns the Mesh for the given label in the collection. +Input Parameters +label(string) +The label of the Mesh. +Return +Mesh +The item in the collection +Items () +Returns a table of Mesh items. +Return +UnsupportedType(List of Mesh) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CurrentsCollection +A collection of solution currents for this solution configuration. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a currents request to the currents collection +currentsCollection = project.Contents.SolutionConfigurations[1].Currents +currentsRequest = currentsCollection:Add() + -- Remove the currents request from the currents collection +currentsCollection:Item(currentsRequest.Label):Delete() +Inheritance +The CurrentsCollection object is derived from the Object object. +Usage locations +The CurrentsCollection object can be accessed from the following locations: +• Collection lists +◦ CharacteristicModesConfiguration object has collection Currents. +◦ StandardConfiguration object has collection Currents. +Property List +Count +Label +Type +The number of Currents items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Create a currents calculation using the table of properties. (Returns a Currents object.) +Add () +Request a currents calculation. (Returns a Currents object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2367 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Currents for the given index in the collection. (Returns a Currents object.) +Item (label string) +Returns the Currents for the given label in the collection. (Returns a Currents object.) +Items () +Returns a table of Currents items. (Returns a UnsupportedType(List of Currents) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Currents items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Create a currents calculation using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +Currents +The currents request. +Add () +Request a currents calculation. +Return +Currents +The currents request. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Currents for the given index in the collection. +Input Parameters +index(number) +The index of the Currents. +Return +Currents +The item in the collection +Item (label string) +Returns the Currents for the given label in the collection. +Input Parameters +label(string) +The label of the Currents. +Return +Currents +The item in the collection +Items () +Returns a table of Currents items. +Return +UnsupportedType(List of Currents) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +CutplaneCollection +A collection of cutplanes. +Example + -- Script recorded on Tue 13. Nov 16:17:10 2018 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add +properties = cf.Cutplane.GetDefaultProperties() +properties.Label = "Cutplane1" +cutplane1 = project.Contents.Cutplanes:Add(properties) +Inheritance +The CutplaneCollection object is derived from the Object object. +Usage locations +The CutplaneCollection object can be accessed from the following locations: +• Collection lists +◦ ModelContents object has collection Cutplanes. +Property List +Count +Label +Type +The number of Cutplane items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Create a workplane using a table of properties. (Returns a Cutplane object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Cutplane for the given index in the collection. (Returns a Cutplane object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Item (label string) +p.2371 +Returns the Cutplane for the given label in the collection. (Returns a Cutplane object.) +Items () +Returns a table of Cutplane items. (Returns a UnsupportedType(List of Cutplane) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Cutplane items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Create a workplane using a table of properties. +Input Parameters +properties(table) +The table of properties defining the workplane. +Return +Cutplane +The new cutplane. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Cutplane for the given index in the collection. +Input Parameters +index(number) +The index of the Cutplane. +Return +Cutplane +The item in the collection +Item (label string) +Returns the Cutplane for the given label in the collection. +Input Parameters +label(string) +The label of the Cutplane. +Return +Cutplane +The item in the collection +Items () +Returns a table of Cutplane items. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +UnsupportedType(List of Cutplane) +The list of items in the collection +SetProperties (properties Object) +p.2373 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +DielectricCollection +A collection of dielectric media. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create the dielectric medium +dielectric = project.Definitions.Media.Dielectric:AddDielectric() +Inheritance +The DielectricCollection object is derived from the Object object. +Usage locations +The DielectricCollection object can be accessed from the following locations: +• Collection lists +◦ Media object has collection Dielectric. +Property List +Count +Label +Type +The number of Dielectric items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddDielectric (properties table) +Create a dielectric medium from a table defining the properties. (Returns a Dielectric object.) +AddDielectric (relativepermittivity Expression, losstangent Expression, massdensity Expression) +Create a dielectric medium. (Returns a Dielectric object.) +AddDielectric () +Create a dielectric medium. (Returns a Dielectric object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Item (index number) +p.2375 +Returns the Dielectric for the given index in the collection. (Returns a Dielectric object.) +Item (label string) +Returns the Dielectric for the given label in the collection. (Returns a Dielectric object.) +Items () +Returns a table of Dielectric items. (Returns a UnsupportedType(List of Dielectric) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Dielectric items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddDielectric (properties table) +Create a dielectric medium from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new dielectric medium. +Return +Dielectric +The dielectric medium. +AddDielectric (relativepermittivity Expression, losstangent Expression, massdensity Expression) +Create a dielectric medium. +Input Parameters +relativepermittivity(Expression) +The frequency independent dielectric relative permittivity. +losstangent(Expression) +The frequency independent dielectric loss tangent. +massdensity(Expression) +The mass density (kg/m^3). +Return +Dielectric +The dielectric medium. +AddDielectric () +Create a dielectric medium. +Return +Dielectric +The dielectric medium. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Dielectric for the given index in the collection. +Input Parameters +index(number) +The index of the Dielectric. +Return +Dielectric +The item in the collection +Item (label string) +Returns the Dielectric for the given label in the collection. +Input Parameters +label(string) +The label of the Dielectric. +Return +Dielectric +The item in the collection +Items () +Returns a table of Dielectric items. +Return +UnsupportedType(List of Dielectric) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +EdgeCollection +A collection of edges. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create geometry which contains edges +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) + -- Set the local mesh size of each edge +for key,value in pairs(cuboid.Edges) do + value.LocalMeshSize = 0.1 +end +Inheritance +The EdgeCollection object is derived from the TopologyEntityCollectionOf_Edge object. +Usage locations +The EdgeCollection object can be accessed from the following locations: +• Collection lists +◦ Geometry object has collection Edges. +◦ SpiralCross object has collection Edges. +◦ Ring object has collection Edges. +◦ OpenRing object has collection Edges. +◦ SplitRing object has collection Edges. +◦ Cross object has collection Edges. +◦ StripCross object has collection Edges. +◦ Trifilar object has collection Edges. +◦ AnalyticalCurve object has collection Edges. +◦ BezierCurve object has collection Edges. +◦ Cone object has collection Edges. +◦ ConstrainedSurface object has collection Edges. +◦ Cuboid object has collection Edges. +◦ Cylinder object has collection Edges. +◦ Ellipse object has collection Edges. +◦ EllipticArc object has collection Edges. +◦ FittedSpline object has collection Edges. +◦ Flare object has collection Edges. +◦ Helix object has collection Edges. +◦ Hexagon object has collection Edges. +◦ StripHexagon object has collection Edges. +◦ HyperbolicArc object has collection Edges. +◦ +◦ +ImprintPoints object has collection Edges. +Intersect object has collection Edges. +◦ Loft object has collection Edges. +◦ PathSweep object has collection Edges. +◦ ProjectGeometry object has collection Edges. +◦ RepairAndSewFaces object has collection Edges. +◦ RepairPart object has collection Edges. +◦ Spin object has collection Edges. +◦ Split object has collection Edges. +◦ Stitch object has collection Edges. +◦ Subtract object has collection Edges. +◦ Sweep object has collection Edges. +◦ Union object has collection Edges. +◦ Simplify object has collection Edges. +◦ Line object has collection Edges. +◦ NurbsSurface object has collection Edges. +◦ ParabolicArc object has collection Edges. +◦ Paraboloid object has collection Edges. +◦ Polygon object has collection Edges. +◦ Polyline object has collection Edges. +◦ Primitive object has collection Edges. +◦ Rectangle object has collection Edges. +◦ Sphere object has collection Edges. +◦ AbstractSurfaceCurve object has collection Edges. +◦ SurfaceBezierCurve object has collection Edges. +◦ SurfaceLine object has collection Edges. +◦ SurfaceRegularLines object has collection Edges. +◦ TCross object has collection Edges. +Property List +Count +Label +Type +The number of Edge items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Edge for the given index in the collection. (Returns a Edge object.) +Item (label string) +Returns the Edge for the given label in the collection. (Returns a Edge object.) +Items () +Returns a table of Edge items. (Returns a UnsupportedType(List of Edge) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Edge items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Edge for the given index in the collection. +Input Parameters +index(number) +The index of the Edge. +Return +Edge +The item in the collection +Item (label string) +Returns the Edge for the given label in the collection. +Input Parameters +label(string) +The label of the Edge. +Return +Edge +The item in the collection +Items () +Returns a table of Edge items. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +UnsupportedType(List of Edge) +The list of items in the collection +SetProperties (properties Object) +p.2382 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ErrorEstimationCollection +A collection of solution error estimations for this solution configuration. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +standardConfiguration = + project.Contents.SolutionConfigurations:AddStandardConfiguration() + -- Create a new 'ErrorEstimation' request +p.2383 +errorEstimation = standardConfiguration.ErrorEstimations:Add() + -- Find out whether the 'ErrorEstimationCollection' contains the ErrorEstimation +contains = standardConfiguration.ErrorEstimations:Contains('ErrorEstimation1') +Inheritance +The ErrorEstimationCollection object is derived from the Object object. +Usage locations +The ErrorEstimationCollection object can be accessed from the following locations: +• Collection lists +◦ StandardConfiguration object has collection ErrorEstimations. +Property List +Count +Label +Type +The number of ErrorEstimation items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add () +Create an error estimation request. (Returns a ErrorEstimation object.) +Add (properties table) +Create an error estimation request using the table of properties. (Returns a ErrorEstimation +object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2384 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the ErrorEstimation for the given index in the collection. (Returns a ErrorEstimation +object.) +Item (label string) +Returns the ErrorEstimation for the given label in the collection. (Returns a ErrorEstimation +object.) +Items () +Returns a table of ErrorEstimation items. (Returns a UnsupportedType(List of ErrorEstimation) +object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of ErrorEstimation items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method Details +Add () +Create an error estimation request. +Return +ErrorEstimation +The error estimation request. +Add (properties table) +Create an error estimation request using the table of properties. +p.2385 +Input Parameters +properties(table) +The table of properties. +Return +ErrorEstimation +The error estimation request. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the ErrorEstimation for the given index in the collection. +Input Parameters +index(number) +The index of the ErrorEstimation. +Return +ErrorEstimation +The item in the collection +Item (label string) +Returns the ErrorEstimation for the given label in the collection. +Input Parameters +label(string) +The label of the ErrorEstimation. +Return +ErrorEstimation +The item in the collection +Items () +Returns a table of ErrorEstimation items. +Return +UnsupportedType(List of ErrorEstimation) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +FaceCollection +A collection of faces. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create geometry which contains faces +cube = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) + -- Set the local mesh size on each face +for key,value in pairs(cube.Faces) do + value.LocalMeshSize = 0.1 +end +Inheritance +The FaceCollection object is derived from the Object object. +Usage locations +The FaceCollection object can be accessed from the following locations: +• Collection lists +◦ Geometry object has collection Faces. +◦ SpiralCross object has collection Faces. +◦ Ring object has collection Faces. +◦ OpenRing object has collection Faces. +◦ SplitRing object has collection Faces. +◦ Cross object has collection Faces. +◦ StripCross object has collection Faces. +◦ Trifilar object has collection Faces. +◦ AnalyticalCurve object has collection Faces. +◦ BezierCurve object has collection Faces. +◦ Cone object has collection Faces. +◦ ConstrainedSurface object has collection Faces. +◦ Cuboid object has collection Faces. +◦ Cylinder object has collection Faces. +◦ Ellipse object has collection Faces. +◦ EllipticArc object has collection Faces. +◦ FittedSpline object has collection Faces. +◦ Flare object has collection Faces. +◦ Helix object has collection Faces. +◦ Hexagon object has collection Faces. +◦ StripHexagon object has collection Faces. +◦ HyperbolicArc object has collection Faces. +◦ +◦ +ImprintPoints object has collection Faces. +Intersect object has collection Faces. +◦ Loft object has collection Faces. +◦ PathSweep object has collection Faces. +◦ ProjectGeometry object has collection Faces. +◦ RepairAndSewFaces object has collection Faces. +◦ RepairPart object has collection Faces. +◦ Spin object has collection Faces. +◦ Split object has collection Faces. +◦ Stitch object has collection Faces. +◦ Subtract object has collection Faces. +◦ Sweep object has collection Faces. +◦ Union object has collection Faces. +◦ Simplify object has collection Faces. +◦ Line object has collection Faces. +◦ NurbsSurface object has collection Faces. +◦ ParabolicArc object has collection Faces. +◦ Paraboloid object has collection Faces. +◦ Polygon object has collection Faces. +◦ Polyline object has collection Faces. +◦ Primitive object has collection Faces. +◦ Rectangle object has collection Faces. +◦ Sphere object has collection Faces. +◦ AbstractSurfaceCurve object has collection Faces. +◦ SurfaceBezierCurve object has collection Faces. +◦ SurfaceLine object has collection Faces. +◦ SurfaceRegularLines object has collection Faces. +◦ TCross object has collection Faces. +Property List +Count +Label +Type +The number of Face items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Face for the given index in the collection. (Returns a Face object.) +Item (label string) +Returns the Face for the given label in the collection. (Returns a Face object.) +Items () +Returns a table of Face items. (Returns a UnsupportedType(List of Face) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Face items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Face for the given index in the collection. +Input Parameters +index(number) +The index of the Face. +Return +Face +The item in the collection +Item (label string) +Returns the Face for the given label in the collection. +Input Parameters +label(string) +The label of the Face. +Return +Face +The item in the collection +Items () +Returns a table of Face items. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +UnsupportedType(List of Face) +The list of items in the collection +SetProperties (properties Object) +p.2391 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +FarFieldCollection +A collection of solution far fields for this solution configuration. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a far field request to the far field collection +configuration = project.Contents.SolutionConfigurations[1] +farFieldCollection = configuration.FarFields +farFieldRequest = farFieldCollection:Add3DPattern() + -- Remove the far field request from the far field collection +farFieldCollection:Item(farFieldRequest.Label):Delete() +Inheritance +The FarFieldCollection object is derived from the Object object. +Usage locations +The FarFieldCollection object can be accessed from the following locations: +• Collection lists +◦ CharacteristicModesConfiguration object has collection FarFields. +◦ StandardConfiguration object has collection FarFields. +Property List +Count +Label +Type +The number of FarField items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Create a far field using the table of properties. (Returns a FarField object.) +Add (starttheta Expression, startphi Expression, endtheta Expression, endphi Expression, +thetaincrement Expression, phiincrement Expression) +Create a spherical far field calculation request. (Returns a FarField object.) +Add3DPattern () +Create a 3D pattern spherical far field calculation request. (Returns a FarField object.) +AddHorizontalCutUVPlane () +Create a horizontal cut UV plane spherical far field calculation request. (Returns a FarField object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +AddRequestInPlaneWaveIncidentDirection () +p.2393 +Create a far field calculation request in the plane wave incident direction. (Returns a FarField +object.) +AddSquareGrid () +Create a square grid pattern Cartesian far field calculation request. (Returns a FarField object.) +AddVerticalCutUNPlane () +Create a vertical cut UN plane spherical far field calculation request. (Returns a FarField object.) +AddVerticalCutVNPlane () +Create a vertical cut VN plane spherical far field calculation request. (Returns a FarField object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the FarField for the given index in the collection. (Returns a FarField object.) +Item (label string) +Returns the FarField for the given label in the collection. (Returns a FarField object.) +Items () +Returns a table of FarField items. (Returns a UnsupportedType(List of FarField) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of FarField items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Create a far field using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +FarField +The far field. +Add (starttheta Expression, startphi Expression, endtheta Expression, endphi Expression, +thetaincrement Expression, phiincrement Expression) +Create a spherical far field calculation request. +Input Parameters +starttheta(Expression) +The theta start angle (degrees). +startphi(Expression) +The phi start angle (degrees). +endtheta(Expression) +The theta end angle (degrees). +endphi(Expression) +The phi end angle (degrees). +thetaincrement(Expression) +The theta increment (degrees). +phiincrement(Expression) +The phi increment (degrees). +Return +FarField +The far field. +Add3DPattern () +Create a 3D pattern spherical far field calculation request. +Return +FarField +The far field. +AddHorizontalCutUVPlane () +Create a horizontal cut UV plane spherical far field calculation request. +Return +FarField +The far field. +AddRequestInPlaneWaveIncidentDirection () +Create a far field calculation request in the plane wave incident direction. +Return +FarField +The far field. +AddSquareGrid () +Create a square grid pattern Cartesian far field calculation request. +Return +FarField +The far field. +AddVerticalCutUNPlane () +Create a vertical cut UN plane spherical far field calculation request. +Return +FarField +The far field. +AddVerticalCutVNPlane () +Create a vertical cut VN plane spherical far field calculation request. +Return +FarField +The far field. +Delete () +Deletes the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +p.2396 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the FarField for the given index in the collection. +Input Parameters +index(number) +The index of the FarField. +Return +FarField +The item in the collection +Item (label string) +Returns the FarField for the given label in the collection. +Input Parameters +label(string) +The label of the FarField. +Return +FarField +The item in the collection +Items () +Returns a table of FarField items. +Return +UnsupportedType(List of FarField) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +FarFieldReceivingAntennaCollection +A collection of solution receiving antennas. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +standardConfiguration = + project.Contents.SolutionConfigurations:AddStandardConfiguration() + -- Get the 'FarFieldReceivingAntennaCollections' +farFieldReceivingAntennaCollection = standardConfiguration.FarFieldReceivingAntennas + -- Get the number of 'FarFieldReceivingAntenna' in the collection +numberOfFarFieldRxAntennas = #farFieldReceivingAntennaCollection +Inheritance +The FarFieldReceivingAntennaCollection object is derived from the Object object. +Usage locations +The FarFieldReceivingAntennaCollection object can be accessed from the following locations: +• Collection lists +◦ StandardConfiguration object has collection FarFieldReceivingAntennas. +Property List +Count +Label +Type +The number of FarFieldReceivingAntenna items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Create a far field receiving antenna request using the table of properties. (Returns a +FarFieldReceivingAntenna object.) +Add (fielddata FarFieldData) +Create a far field receiving antenna request from the specified field data. (Returns a +FarFieldReceivingAntenna object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the FarFieldReceivingAntenna for the given index in the collection. (Returns a +FarFieldReceivingAntenna object.) +Item (label string) +Returns the FarFieldReceivingAntenna for the given label in the collection. (Returns a +FarFieldReceivingAntenna object.) +Items () +Returns a table of FarFieldReceivingAntenna items. (Returns a UnsupportedType(List of +FarFieldReceivingAntenna) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of FarFieldReceivingAntenna items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Create a far field receiving antenna request using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +FarFieldReceivingAntenna +The far field receiving antenna request. +Add (fielddata FarFieldData) +Create a far field receiving antenna request from the specified field data. +Input Parameters +fielddata(FarFieldData) +The field data that the receiving antenna writes to. +Return +FarFieldReceivingAntenna +The far field receiving antenna request. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the FarFieldReceivingAntenna for the given index in the collection. +Input Parameters +index(number) +The index of the FarFieldReceivingAntenna. +Return +FarFieldReceivingAntenna +The item in the collection +Item (label string) +Returns the FarFieldReceivingAntenna for the given label in the collection. +Input Parameters +label(string) +The label of the FarFieldReceivingAntenna. +Return +FarFieldReceivingAntenna +The item in the collection +Items () +Returns a table of FarFieldReceivingAntenna items. +Return +UnsupportedType(List of FarFieldReceivingAntenna) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +FieldDataCollection +A collection of field data. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Retrieve the project's 'FieldDataCollection' +fieldDataCollection = project.Definitions.FieldDataList + -- Add a 'FarFieldData' to the collection +fieldDataCollection:AddFarFieldDataUsingKnownFileFormat([[FarFieldData.ffe]]) + -- Query the number of FieldData entries in the collection +numberOfFieldDataDefinitions = #fieldDataCollection + -- Retrieve the first 'FieldData' from the collection +fieldData = fieldDataCollection[1] +Inheritance +The FieldDataCollection object is derived from the Object object. +Usage locations +The FieldDataCollection object can be accessed from the following locations: +• Collection lists +◦ ModelDefinitions object has collection FieldDataList. +Property List +Count +Label +Type +The number of FieldData items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddFarFieldData (properties table) +Create a far field data by importing from a known file format. (Returns a FarFieldData object.) +AddFarFieldDataUsingKnownFileFormat (filename string) +Create a far field data by importing from a known file format. (Returns a FarFieldData object.) +AddFarFieldDataUsingStructure (filename string, numberthetapoints Expression, numberphipoints +Expression) +Create a far field data by importing from a file format with an unknown structure where the +structure is given as part of the data. (Returns a FarFieldData object.) +AddNearFieldDataFileStructure (properties table) +Create a near field data by importing from a known file format. (Returns a +NearFieldDataFileStructure object.) +AddNearFieldDataFullImport (properties table) +Create a near field data by importing from a known file format. (Returns a +NearFieldDataFullImport object.) +AddNearFieldDataFullImportUsingKnownFileFormat (filename string) +Create a near field data by importing from a known file format. (Returns a +NearFieldDataFullImport object.) +AddPCBCurrentData (properties table) +Create PCB current data. (Returns a PCBCurrentData object.) +AddPCBCurrentData (filename string) +Create PCB current data by specifying a file defining the PCB and currents. (Returns a +PCBCurrentData object.) +AddSolutionCoefficientData (properties table) +Create solution coefficient data. (Returns a SolutionCoefficientData object.) +AddSolutionCoefficientData (filename string) +Create solution coefficient data by specifying a file defining the coefficients. (Returns a +SolutionCoefficientData object.) +AddSphericalModeDataFromFile (properties table) +Create a spherical mode data. (Returns a SphericalModeDataFromFile object.) +AddSphericalModeDataFullImport (filename string) +Create a spherical mode data by importing the modes from a known file format. (Returns a +SphericalModeDataFromFile object.) +AddSphericalModeDataManuallySpecified (properties table) +Create a spherical modes data by specifying the individual complex weightings for each spherical +mode. (Returns a SphericalModeDataManuallySpecified object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the FieldData for the given index in the collection. (Returns a FieldData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Item (label string) +p.2404 +Returns the FieldData for the given label in the collection. (Returns a FieldData object.) +Items () +Returns a table of FieldData items. (Returns a UnsupportedType(List of FieldData) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of FieldData items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddFarFieldData (properties table) +Create a far field data by importing from a known file format. +Input Parameters +properties(table) +A table of properties defining the new far field data. +Return +FarFieldData +The far field data. +AddFarFieldDataUsingKnownFileFormat (filename string) +Create a far field data by importing from a known file format. +Input Parameters +filename(string) +Import file containing the far field data. +Return +FarFieldData +The far field data. +AddFarFieldDataUsingStructure (filename string, numberthetapoints Expression, numberphipoints +Expression) +Create a far field data by importing from a file format with an unknown structure where the +structure is given as part of the data. +Input Parameters +filename(string) +Import file containing the far field data. +numberthetapoints(Expression) +The number of theta points used for the data. +numberphipoints(Expression) +The number of phi points used for the data. +Return +FarFieldData +The far field data. +AddNearFieldDataFileStructure (properties table) +Create a near field data by importing from a known file format. +Input Parameters +properties(table) +A table of properties defining the new near field data. +Return +NearFieldDataFileStructure +The near field data. +AddNearFieldDataFullImport (properties table) +Create a near field data by importing from a known file format. +Input Parameters +properties(table) +A table of properties defining the new near field data. +Return +NearFieldDataFullImport +The near field data. +AddNearFieldDataFullImportUsingKnownFileFormat (filename string) +Create a near field data by importing from a known file format. +Input Parameters +filename(string) +Import file containing the aperture data. +Return +NearFieldDataFullImport +The near field data. +AddPCBCurrentData (properties table) +Create PCB current data. +Input Parameters +properties(table) +A table of properties defining the new PCB current data. +Return +PCBCurrentData +The PCB current data. +AddPCBCurrentData (filename string) +Create PCB current data by specifying a file defining the PCB and currents. +Input Parameters +filename(string) +Import file containing the PCB current data. +Return +PCBCurrentData +The PCB current data. +AddSolutionCoefficientData (properties table) +Create solution coefficient data. +Input Parameters +properties(table) +A table of properties defining the new solution coefficient data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +SolutionCoefficientData +The solution coefficient data. +AddSolutionCoefficientData (filename string) +Create solution coefficient data by specifying a file defining the coefficients. +Input Parameters +filename(string) +Import file containing the solution coefficient data. +p.2407 +Return +SolutionCoefficientData +The solution coefficient data. +AddSphericalModeDataFromFile (properties table) +Create a spherical mode data. +Input Parameters +properties(table) +A table of properties defining the new spherical modes data. +Return +SphericalModeDataFromFile +The spherical modes data. +AddSphericalModeDataFullImport (filename string) +Create a spherical mode data by importing the modes from a known file format. +Input Parameters +filename(string) +Import file containing the spherical modes data. +Return +SphericalModeDataFromFile +The spherical modes full import data. +AddSphericalModeDataManuallySpecified (properties table) +Create a spherical modes data by specifying the individual complex weightings for each spherical +mode. +Input Parameters +properties(table) +A table of properties defining the new spherical modes data. +Return +SphericalModeDataManuallySpecified +The spherical modes data. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the FieldData for the given index in the collection. +Input Parameters +index(number) +The index of the FieldData. +Return +FieldData +The item in the collection +Item (label string) +Returns the FieldData for the given label in the collection. +Input Parameters +label(string) +The label of the FieldData. +Return +FieldData +The item in the collection +Items () +Returns a table of FieldData items. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +UnsupportedType(List of FieldData) +The list of items in the collection +SetProperties (properties Object) +p.2409 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +FormGroupBoxItemCollection +A collection of all of the items contained in a form group box. +Example +form = cf.Form.New() +group = cf.FormGroupBox.New("Items") +item1 = cf.FormLabel.New("Item 1") +item2 = cf.FormLabel.New("Item 2") + -- Assemble the form objects into a layout +group:Add(item1); +group:Add(item2) +form:Add(group); + -- Modify items using the collection +group.FormItems["Item 1"].Visible = false +form:Run() +Usage locations +The FormGroupBoxItemCollection object can be accessed from the following locations: +• Collection lists +◦ FormGroupBox object has collection FormItems. +Property List +Count +Type +The number of FormItem items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the FormItem at the given index. (Returns a FormItem object.) +Item (label string) +Returns the FormItem with the given label. (Returns a FormItem object.) +Items () +Returns a table of FormItem. (Returns a List of FormItem object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.2411 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the FormItem at the given index in the collection. (Read FormItem) +[string] +Returns the FormItem with the given name in the collection. (Read FormItem) +Property Details +Count +The number of FormItem items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +boolean +The success of the check. +Item (index number) +Returns the FormItem at the given index. +Input Parameters +index(number) +The index of the FormItem. +Return +FormItem +The FormItem at the given index. +Item (label string) +Returns the FormItem with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +FormItem +The FormItem with the given label. +Items () +Returns a table of FormItem. +Return +List of FormItem +A table of FormItem. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for FormItem. +FormItemCollection +A collection of all of the items contained in a form. +Example +form = cf.Form.New() + -- Create a variety of form items +checkbox = cf.FormCheckBox.New("Export electric near fields.") +label = cf.FormLabel.New("Item 1") +dirBrowser = cf.FormDirectoryBrowser.New("Output directory:") +form:Add(checkbox) +form:Add(label) +form:Add(dirBrowser) + -- All form items share the Enabled and Visible properties +for i = 1,#form.FormItems do + form.FormItems[i].Enabled = false +end +form:Run() +Usage locations +The FormItemCollection object can be accessed from the following locations: +• Collection lists +◦ Form object has collection FormItems. +Property List +Count +Type +The number of FormItem items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the FormItem at the given index. (Returns a FormItem object.) +Item (label string) +Returns the FormItem with the given label. (Returns a FormItem object.) +Items () +Returns a table of FormItem. (Returns a List of FormItem object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.2414 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the FormItem at the given index in the collection. (Read FormItem) +[string] +Returns the FormItem with the given name in the collection. (Read FormItem) +Property Details +Count +The number of FormItem items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +boolean +The success of the check. +Item (index number) +Returns the FormItem at the given index. +Input Parameters +index(number) +The index of the FormItem. +Return +FormItem +The FormItem at the given index. +Item (label string) +Returns the FormItem with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +FormItem +The FormItem with the given label. +Items () +Returns a table of FormItem. +Return +List of FormItem +A table of FormItem. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for FormItem. +FormLayoutItemCollection +A collection of all of the items contained in a form layout. +Example +form = cf.Form.New() + -- Create a few form items +label = cf.FormLabel.New("Specify a frequency:") +lineEdit = cf.FormLineEdit.New("Frequency") + -- Create a layout item +formLayout = cf.FormLayout.New(cf.Enums.FormLayoutEnum.Vertical) + -- Add items to the layout +formLayout:Add(label) +formLayout:Add(lineEdit) + -- Add layout item to the form +form:Add(formLayout) + -- Obtain a handle to the 'FormLayoutItemCollection' +formLayoutItemCollection = form.FormItems[1].FormItems + -- Iterate through the layout collection and disable the items. +for index in ipairs(formLayoutItemCollection) do + formLayoutItemCollection[index].Enabled = false +end +form:Run() +Usage locations +The FormLayoutItemCollection object can be accessed from the following locations: +• Collection lists +◦ FormLayout object has collection FormItems. +Property List +Count +Type +The number of FormItem items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the FormItem at the given index. (Returns a FormItem object.) +Item (label string) +Returns the FormItem with the given label. (Returns a FormItem object.) +Items () +Returns a table of FormItem. (Returns a List of FormItem object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the FormItem at the given index in the collection. (Read FormItem) +[string] +Returns the FormItem with the given name in the collection. (Read FormItem) +Property Details +Count +The number of FormItem items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +boolean +The success of the check. +Item (index number) +Returns the FormItem at the given index. +Input Parameters +index(number) +The index of the FormItem. +Return +FormItem +The FormItem at the given index. +Item (label string) +Returns the FormItem with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +FormItem +The FormItem with the given label. +Items () +Returns a table of FormItem. +Return +List of FormItem +A table of FormItem. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for FormItem. +FormScrollAreaItemCollection +A collection of all of the items contained in a form scroll area. +Example +form = cf.Form.New() + -- Create a scroll area form item +formScrollArea = cf.FormScrollArea.New() + -- Create a few form items +formScrollArea:Add(cf.FormLabel.New("A lot of text.")) +formScrollArea:Add(cf.FormLabel.New("even more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("... more text")) +formScrollArea:Add(cf.FormLabel.New("lost more text")) + -- Obtain a handle to the 'FormScrollAreaItemCollection' +formScrollAreaItemCollection = formScrollArea.FormItems + -- Iterate through all the objects in the scroll area and disable them. +for index in ipairs(formScrollAreaItemCollection) do + formScrollAreaItemCollection[index].Enabled = false +end + -- Add the scroll area to the form +form:Add(formScrollArea) + -- Show and run the form +form:Run() +Usage locations +The FormScrollAreaItemCollection object can be accessed from the following locations: +• Collection lists +◦ FormScrollArea object has collection FormItems. +Property List +Count +Type +The number of FormItem items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the FormItem at the given index. (Returns a FormItem object.) +Item (label string) +Returns the FormItem with the given label. (Returns a FormItem object.) +Items () +Returns a table of FormItem. (Returns a List of FormItem object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. (Returns a string object.) +Index List +[number] +Returns the FormItem at the given index in the collection. (Read FormItem) +[string] +Returns the FormItem with the given name in the collection. (Read FormItem) +Property Details +Count +The number of FormItem items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +boolean +The success of the check. +Item (index number) +Returns the FormItem at the given index. +Input Parameters +index(number) +The index of the FormItem. +Return +FormItem +The FormItem at the given index. +Item (label string) +Returns the FormItem with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +FormItem +The FormItem with the given label. +Items () +Returns a table of FormItem. +Return +List of FormItem +A table of FormItem. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +string +The generated unique name label for FormItem. +GeometryCollection +A collection of geometry. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create various geometry objects +project.Contents.Geometry:AddCuboid(cf.Point(1,0,0),1,1,1) +project.Contents.Geometry:AddLine(cf.Point(0,0,0),cf.Point(1,1,1)) +project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1) +project.Contents.Geometry:Union({project.Contents.Geometry[1], + project.Contents.Geometry[2]}) + -- Lock all the geometry +for value,geometry in pairs(project.Contents.Geometry) do + geometry.Locked = true +end +Inheritance +The GeometryCollection object is derived from the OperatorCollection object. +Usage locations +The GeometryCollection object can be accessed from the following locations: +• Collection lists +◦ ModelContents object has collection Geometry. +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Count +The number of Geometry items in the collection. (Read only number) +FaultyParts +Contains all faulty parts in the model. (Read only List of Geometry) +Find +Label +The geometry find tools. (Read only Find) +The object label. (Read/Write string) +Rebuild +The geometry rebuild tools. (Read only GeometryRebuild) +Repair +The geometry repair tools. (Read only GeometryRepair) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +AddAnalyticalCurve (properties table) +p.2423 +Create an analytical curve from a table defining the properties. (Returns a AnalyticalCurve +object.) +AddAnalyticalCurve (start Expression, end Expression, u Expression, v Expression, n Expression) +Create an analytical curve in the Cartesian coordinate system. (Returns a AnalyticalCurve object.) +AddAnalyticalCurveCylindrical (start Expression, end Expression, rho Expression, phi Expression, n +Expression) +Create an analytical curve in the cylindrical coordinate system. (Returns a AnalyticalCurve object.) +AddAnalyticalCurveSpherical (start Expression, end Expression, r Expression, theta Expression, phi +Expression) +Create an analytical curve in the spherical coordinate system. (Returns a AnalyticalCurve object.) +AddBezierCurve (properties table) +Create a Bezier from a table defining the properties. (Returns a BezierCurve object.) +AddBezierCurve (startpoint Point, starttangent Point, endtangent Point, endpoint Point) +Create a Bezier curve from the given coordinates. (Returns a BezierCurve object.) +AddCone (properties table) +Create a cone from a table defining the properties. (Returns a Cone object.) +AddCone (base Point, baseradius Expression, topradius Expression, height Expression) +Create a cone by specifying height and top radius in addition to the centre and radius at the base. +(Returns a Cone object.) +AddConeWithAngleAndHeight (base Point, baseradius Expression, angle Expression, height Expression) +Create a cone by specifying the height and side angle in addition to the centre and radius at the +base. (Returns a Cone object.) +AddConeWithAngleAndTopCentre (base Point, baseradius Expression, angle Expression, top Point) +Create a cone by specifying the top centre position and side angle in addition to the centre and +radius at the base. (Returns a Cone object.) +AddConeWithTopRadiusAndTopCentre (base Point, baseradius Expression, topradius Expression, top +Point) +Create a cone by specifying the centre and radius at the top in addition to the centre and radius +at the base. (Returns a Cone object.) +AddConstrainedSurface (properties table) +Create a constrained surface from a table defining the properties. (Returns a ConstrainedSurface +object.) +AddConstrainedSurface (positionlist List of Point, normallist List of Point, uvpointlist List of UVPoint) +Add a constrained surface operator. (Returns a ConstrainedSurface object.) +AddCross (properties table) +Create a cross from a table defining the properties. (Returns a Cross object.) +AddCross (centrepoint Point, armlengthu Expression, armlengthv Expression, stripwidth Expression) +Create a cross at the specified centre, arm lengths and strip width. (Returns a Cross object.) +AddCuboid (properties table) +Create a cuboid from a table defining the properties. (Returns a Cuboid object.) +AddCuboid (cornerpoint Point, width Expression, depth Expression, height Expression) +Create a cuboid at the specified base corner and dimensions. (Returns a Cuboid object.) +AddCuboidAtCentre (centrepoint Point, width Expression, depth Expression, height Expression) +Create a cuboid at the specified base centre and dimensions. (Returns a Cuboid object.) +AddCylinder (properties table) +Create a cylinder from a table defining the properties. (Returns a Cylinder object.) +AddCylinder (centrepoint Point, radius Expression, height Expression) +Create a cylinder at the specified base centre, radius and height. (Returns a Cylinder object.) +AddCylinderWithTopCentre (centrepoint Point, radius Expression, topcentrepoint Point) +Create a cylinder at the specified base centre, radius and top centre. (Returns a Cylinder object.) +AddEllipse (properties table) +Create an ellipse from a table defining the properties. (Returns a Ellipse object.) +AddEllipse (centrepoint Point, radiusu Expression, radiusv Expression) +Create an ellipse at a given centre point and 2 radii. (Returns a Ellipse object.) +AddEllipticArc (properties table) +Create an elliptic arc from a table defining the properties. (Returns a EllipticArc object.) +AddEllipticArc (ellipsecentre Point, radiusu Expression, radiusv Expression, startangle Expression, +endangle Expression) +Create an elliptic arc by specifying the ellipse centre point, radii and the arc angles. (Returns a +EllipticArc object.) +AddEllipticArcWithAperture (aperturecentre Point, depth Expression, apertureradius Expression, +eccentricity Expression, majoraxisdirection EllipticArcMajorAxisDirectionEnum) +Create an elliptic arc by specifying the aperture centre point, depth, radius and eccentricity. +(Returns a EllipticArc object.) +AddFittedSpline (properties table) +Create a fitted spline from a table defining the properties. (Returns a FittedSpline object.) +AddFittedSpline (points List of Point) +Create a fitted spline from the given coordinates. (Returns a FittedSpline object.) +AddFlare (properties table) +Create a flare from a table defining the properties. (Returns a Flare object.) +AddFlare (base Point, bottomwidth Expression, bottomdepth Expression, height Expression, topwidth +Expression, topdepth Expression) +Create a flare by specifying the height, bottom- and top width, bottom- and top depth in addition +to the centre at the base. (Returns a Flare object.) +AddFlareWithBaseCentreAndFlareAngles (base Point, bottomwidth Expression, bottomdepth Expression, +height Expression, angleu Expression, anglev Expression) +Create a flare by specifying the height, bottom width, bottom depth and flare angles in addition to +the centre at the base. (Returns a Flare object.) +AddFlareWithBaseCorner (base Point, bottomwidth Expression, bottomdepth Expression, height +Expression, topwidth Expression, topdepth Expression) +Create a flare by specifying the height, bottom- and top width, bottom- and top depth in addition +to the corner at the base. (Returns a Flare object.) +AddFlareWithBaseCornerAndTopCorner (base Point, top Point, bottomwidth Expression, bottomdepth +Expression) +Create a flare by specifying a corner at the base, a corner at the top as well as the bottom width +and depth. (Returns a Flare object.) +AddHelix (properties table) +Create a helix from a table defining the properties. (Returns a Helix object.) +AddHelix (basecentre Point, baseradius Expression, endradius Expression, height Expression, turns +Expression, lefthandrotated boolean) +Create a variable radius helix by specifying the top and bottom radii, the height and number of +turns. (Returns a Helix object.) +AddHelixWithHeight (basecentre Point, radius Expression, height Expression, pitchangle Expression, +lefthandrotated boolean) +Create a constant radius helix with the number of turns implied by the height. (Returns a Helix +object.) +AddHelixWithTurns (basecentre Point, radius Expression, pitchangle Expression, turns Expression, +lefthandrotated boolean) +Create a constant radius helix with height implied by the number of turns. (Returns a Helix +object.) +AddHexagon (properties table) +Create a hexagon from a table defining the properties. (Returns a Hexagon object.) +AddHexagon (centrepoint Point, width Expression) +Create a hexagon at the specified centre and width. (Returns a Hexagon object.) +AddHyperbolicArc (properties table) +Create a hyperbolic arc from a table defining the properties. (Returns a HyperbolicArc object.) +AddHyperbolicArc (basecentre Point, depth Expression, radius Expression, eccentricity Expression) +Create a hyperbolic arc by specifying the hyperbola base centre point, the radius, depth and +eccentricity. (Returns a HyperbolicArc object.) +AddHyperbolicArcAtApertureCentre (aperturecentre Point, depth Expression, radius Expression, +eccentricity Expression) +Create a hyperbolic arc by specifying the centre point of the arc's aperture, the radius, depth and +eccentricity. (Returns a HyperbolicArc object.) +AddLine (properties table) +Create a line from a table defining the properties. (Returns a Line object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +AddLine (startpoint Point, endpoint Point) +p.2426 +Create a straight line between the given start and end coordinates. (Returns a Line object.) +AddNurbsSurface (properties table) +Create a NURBS surface from a table defining the properties. (Returns a NurbsSurface object.) +AddNurbsSurface (points PointExpressionTable, weights ExpressionTable) +Create a NURBS surface by specifying all control points and all weights. The number of rows and +columns (U' and V' direction orders) will be derived implicitly from the provided 2D tables' size. +(Returns a NurbsSurface object.) +AddOpenRing (properties table) +Create an open ring from a table defining the properties. (Returns a OpenRing object.) +AddOpenRing (centrepoint Point, outerradius Expression, innerradius Expression, gapangle Expression, +startangle Expression) +Create an open ring at the specified centre, outer and inner radius, gap angle and start angle. +(Returns a OpenRing object.) +AddParabolicArc (properties table) +Create a parabolic arc from a table defining the properties. (Returns a ParabolicArc object.) +AddParabolicArc (basecentre Point, radius Expression, focaldepth Expression) +Create a parabolic arc by specifying the parabola base centre point, radius and focal depth. +(Returns a ParabolicArc object.) +AddParabolicArcAtApertureCentre (aperturecentre Point, radius Expression, depth Expression) +Create a parabolic arc by specifying the centre point of the arc's aperture, the radius and depth. +(Returns a ParabolicArc object.) +AddParabolicArcAtBaseCentre (basecentre Point, radius Expression, depth Expression) +Create a parabolic arc by specifying the parabola base centre point, radius and depth. (Returns a +ParabolicArc object.) +AddParaboloid (properties table) +Create a paraboloid from a table defining the properties. (Returns a Paraboloid object.) +AddParaboloid (centrepoint Point, radius Expression, focaldepth Expression) +Create a paraboloid at a given centre point, with specified radius and focal depth. (Returns a +Paraboloid object.) +AddPolygon (properties table) +Create a polygon from a table defining the properties. (Returns a Polygon object.) +AddPolyline (properties table) +Create a polyline from a table defining the properties. (Returns a Polyline object.) +AddPolyline (points List of Point) +Create a polyline from the given coordinates. (Returns a Polyline object.) +AddRectangle (cornerpoint Point, width Expression, depth Expression) +Create a rectangle at the specified base corner and dimensions. (Returns a Rectangle object.) +AddRectangle (properties table) +Create a rectangle from the properties given. (Returns a Rectangle object.) +AddRectangleAtCentre (centrepoint Point, width Expression, depth Expression) +Create a rectangle at the specified base centre and dimensions. (Returns a Rectangle object.) +AddRing (properties table) +Create a ring from a table defining the properties. (Returns a Ring object.) +AddRing (centrepoint Point, outerradius Expression, innerradius Expression) +Create a ring at the specified centre, outer and inner radius. (Returns a Ring object.) +AddSphere (centre Point, radius Expression) +Create a sphere with the specified radius. (Returns a Sphere object.) +AddSpheroid (properties table) +Create a spheroid from a table defining the properties. (Returns a Sphere object.) +AddSpheroid (centre Point, radiusu Expression, radiusv Expression, radiusn Expression) +Create a spheroid at centre with radii specified in the U, V and N directions. (Returns a Sphere +object.) +AddSpiralCross (properties table) +Create a spiral cross from a table defining the properties. (Returns a SpiralCross object.) +AddSpiralCross (centrepoint Point, armlength Expression, edgelength Expression, spirallength +Expression, stripwidth Expression) +Create a spiral cross at the specified centre, arm length, edge length, spiral length and strip +width. (Returns a SpiralCross object.) +AddSplitRing (properties table) +Create a split ring from a table defining the properties. (Returns a SplitRing object.) +AddSplitRing (centrepoint Point, outerradius Expression, innerradius Expression, gapangle Expression, +startangle Expression) +Create a split ring at the specified centre, outer and inner radius, gap angle and start angle. +(Returns a SplitRing object.) +AddStripCross (properties table) +Create a strip cross from a table defining the properties. (Returns a StripCross object.) +AddStripCross (properties Point, armlengthu Expression, armlengthv Expression, stripwidth Expression, +slotwidth Expression) +Create a strip cross at the specified centre, arm lengths, strip width and slot width. (Returns a +StripCross object.) +AddStripHexagon (properties table) +Create a strip hexagon from a table defining the properties. (Returns a StripHexagon object.) +AddStripHexagon (centrepoint Point, width Expression, stripwidth Expression) +Create a strip hexagon at the specified centre, width and strip width. (Returns a StripHexagon +object.) +AddSurfaceBezierCurve (properties table) +Create a surface Bezier from a table defining the properties. (Returns a SurfaceBezierCurve +object.) +AddSurfaceBezierCurve (worksurface WorkSurface, startu Expression, startv Expression, starttangentu +Expression, starttangentv Expression, endtangentu Expression, endtangentv Expression, endu +Expression, endv Expression) +Add a surface Bezier curve operator. (Returns a SurfaceBezierCurve object.) +AddSurfaceLine (properties table) +Create a surface line from a table defining the properties. (Returns a SurfaceLine object.) +AddSurfaceLine (worksurface WorkSurface, startu Expression, startv Expression, endu Expression, endv +Expression) +Add a surface line operator. (Returns a SurfaceLine object.) +AddSurfaceRegularLines (properties table) +Create a surface regular lines operator from a table defining the properties. (Returns a +SurfaceRegularLines object.) +AddSurfaceRegularLines (worksurface WorkSurface, startcorneru Expression, startcornerv Expression, +endcorneru Expression, endcornerv Expression, numlines Expression) +Add a surface regular lines operator. (Returns a SurfaceRegularLines object.) +AddTCross (properties table) +Create a T-cross from a table defining the properties. (Returns a TCross object.) +AddTCross (centrepoint Point, armlength Expression, edgelength Expression, stripwidth Expression) +Create a T-cross at the specified centre, arm length, edge length and strip width. (Returns a +TCross object.) +AddTrifilar (propreties table) +Create a trifilar from a table defining the properties. (Returns a Trifilar object.) +AddTrifilar (position Point, length Expression, stripwidth Expression) +Create a trifilar at the specified centre, length and strip width. (Returns a Trifilar object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +ImprintPoints (geometry Geometry, properties table) +Imprint points onto the geometry. (Returns a ImprintPoints object.) +ImprintPoints (geometry Geometry, points List of Point) +Imprint points onto the geometry. (Returns a ImprintPoints object.) +Intersect (geometrylist List of Geometry) +Intersect the given geometry. (Returns a Intersect object.) +Item (index number) +Returns the Geometry for the given index in the collection. (Returns a Geometry object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Item (label string) +p.2429 +Returns the Geometry for the given label in the collection. (Returns a Geometry object.) +Items () +Returns a table of Geometry items. (Returns a UnsupportedType(List of Geometry) object.) +Loft (startgeometry Geometry, endgeometry Geometry) +Create a loft from one geometry profile to another. The two geometry profiles should either both +be surfaces or curves. For surfaces each profile can only contain a single face without holes. For +curves and arcs, the profiles must be continuous. (Returns a Loft object.) +Loft (properties table) +Create a loft from one geometry profile to another, using a table defining the properties. The two +geometry profiles should either both be surfaces or curves. For surfaces each profile can only +contain a single face without holes. For curves and arcs, the profiles must be continuous. (Returns +a Loft object.) +Loft (startgeometry Geometry, endgeometry Geometry, reverse boolean) +Create a loft from one geometry profile to another. The two geometry profiles should either both +be surfaces or curves. For surfaces each profile can only contain a single face without holes. For +curves and arcs, the profiles must be continuous. (Returns a Loft object.) +Loft (startgeometry Geometry, endgeometry Geometry, properties table) +Create a loft from one geometry profile to another, using a table defining the properties. The two +geometry profiles should either both be surfaces or curves. For surfaces each profile can only +contain a single face without holes. For curves and arcs, the profiles must be continuous. (Returns +a Loft object.) +LoftEdges (startedge Edge, endedge Edge) +Create a loft from one edge to another. The edges will be copied out of their current geometry +into new geometry profiles. Also accepts wires. (Returns a Loft object.) +LoftEdges (startedge Edge, endedge Edge, properties table) +Create a loft from one edge to another, using a table defining the properties. The edges will be +copied out of their current geometry into new geometry profiles. Also accepts wires. (Returns a +Loft object.) +LoftFaces (startface Face, endface Face) +Create a loft from one face to another. The faces will be copied out of their current geometry into +new geometry profiles. The faces should not contain holes. (Returns a Loft object.) +LoftFaces (startface Face, endface Face, properties table) +Create a loft from one face to another, using a table defining the properties. The faces will be +copied out of their current geometry into new geometry profiles. The faces should not contain +holes. (Returns a Loft object.) +PathSweep (geometry Geometry, path Geometry) +Sweep a part along the given path. (Returns a PathSweep object.) +PathSweep (geometry Geometry, path Geometry, twistangle Expression, scalefactor Expression, +flipends boolean) +Sweep a part along the given path with normal alignment. (Returns a PathSweep object.) +PathSweep (geometry Geometry, path Geometry, flipends boolean) +Sweep a part along the given path. (Returns a PathSweep object.) +PathSweepParallel (geometry Geometry, path Geometry, twistangle Expression, scalefactor Expression, +flipends boolean) +Sweep a part along the given path with parallel alignment. (Returns a PathSweep object.) +ProjectGeometry (geometrylist List of Geometry, part Geometry) +Project the provided list of geometry onto the target geometry. (Returns a ProjectGeometry +object.) +ProjectGeometry (geometry Geometry, part Geometry) +Project the provided geometry onto the target geometry. (Returns a ProjectGeometry object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Simplify (properties table) +Simplify the provided geometry using a table to define the simplification settings. (Returns a List +of Simplify object.) +Simplify (geometry Geometry) +Simplify the provided geometry. (Returns a Simplify object.) +SimplifyEntities (geometrylist List of Geometry) +Simplify the provided geometry. (Returns a List of Simplify object.) +Spin (geometry Geometry, properties table) +Spin geometry using a table defining the properties. (Returns a Spin object.) +Spin (geometry Geometry, axisorigin Point, axisdirection Point, angle Expression) +Spin the given geometry. (Returns a Spin object.) +Split (properties table) +Split geometry using a table defining the properties. (Returns a List of Split object.) +Split (geometry Geometry, origin Point, rotationu Expression, rotationv Expression) +Split geometry along the UV plane. (Returns a List of Split object.) +SplitPlaneUN (geometry Geometry, origin Point, rotationu Expression, rotationn Expression) +Split geometry along the UN plane. (Returns a List of Split object.) +SplitPlaneVN (geometry Geometry, origin Point, rotationv Expression, rotationn Expression) +Split geometry along the VN plane. (Returns a List of Split object.) +Stitch (properties table) +Stitch the given geometry. (Returns a Stitch object.) +Stitch (geometrylist List of Geometry) +Stitch the given geometry. (Returns a Stitch object.) +Stitch (geometrylist List of Geometry, tolerance Expression) +Stitch the given geometry. (Returns a Stitch object.) +Subtract (part Geometry, geometrylist List of Geometry) +Subtract the given geometry. (Returns a Subtract object.) +Subtract (part Geometry, parttosubtract Geometry) +Subtract the given geometry. (Returns a Subtract object.) +Sweep (geometry Geometry, properties table) +Sweep geometry using a table defining the properties. (Returns a Sweep object.) +Sweep (geometry Geometry, from Point, to Point) +Sweep geometry between the vector defined by the given start and end points. (Returns a Sweep +object.) +Union (geometrylist List of Geometry) +Union the given geometry. (Returns a Union object.) +Union () +Union all the geometry. (Returns a Union object.) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Count +The number of Geometry items in the collection. +Type +number +Access +Read only +FaultyParts +Contains all faulty parts in the model. +Access +Read only +Find +The geometry find tools. +Type +Find +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Rebuild +The geometry rebuild tools. +Type +GeometryRebuild +Access +Read only +Repair +The geometry repair tools. +Type +GeometryRepair +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +AddAnalyticalCurve (properties table) +Create an analytical curve from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new analytical curve. +Return +AnalyticalCurve +The analytical curve. +AddAnalyticalCurve (start Expression, end Expression, u Expression, v Expression, n Expression) +Create an analytical curve in the Cartesian coordinate system. +Input Parameters +start(Expression) +The start of the interval over which the analytical curve is parametrically defined. +end(Expression) +The end of the interval over which the analytical curve is parametrically defined. +u(Expression) +The curve description in the U dimension as a function of variable t. +v(Expression) +The curve description in the V dimension as a function of variable t. +n(Expression) +The curve description in the N dimension as a function of variable t. +Return +AnalyticalCurve +The analytical curve. +AddAnalyticalCurveCylindrical (start Expression, end Expression, rho Expression, phi Expression, n +Expression) +Create an analytical curve in the cylindrical coordinate system. +Input Parameters +start(Expression) +The start of the interval over which the analytical curve is parametrically defined. +end(Expression) +The end of the interval over which the analytical curve is parametrically defined. +rho(Expression) +The curve description in the rho dimension as a function of variable t. +phi(Expression) +The curve description in the phi dimension as a function of variable t. +n(Expression) +The curve description in the N dimension as a function of variable t. +Return +AnalyticalCurve +The analytical curve. +AddAnalyticalCurveSpherical (start Expression, end Expression, r Expression, theta Expression, phi +Expression) +Create an analytical curve in the spherical coordinate system. +Input Parameters +start(Expression) +The start of the interval over which the analytical curve is parametrically defined. +end(Expression) +The end of the interval over which the analytical curve is parametrically defined. +r(Expression) +The curve description in the R dimension as a function of variable t. +theta(Expression) +The curve description in the theta dimension as a function of variable t. +phi(Expression) +The curve description in the phi dimension as a function of variable t. +Return +AnalyticalCurve +The analytical curve. +AddBezierCurve (properties table) +Create a Bezier from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new Bezier curve. +Return +BezierCurve +The Bezier curve. +AddBezierCurve (startpoint Point, starttangent Point, endtangent Point, endpoint Point) +Create a Bezier curve from the given coordinates. +Input Parameters +startpoint(Point) +The starting point of the curve. +starttangent(Point) +The first control point of the Bezier curve. +endtangent(Point) +The second control point of the Bezier curve. +endpoint(Point) +The end point of the curve. +Return +BezierCurve +The Bezier curve. +AddCone (properties table) +Create a cone from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new cone. +Return +Cone +The cone. +AddCone (base Point, baseradius Expression, topradius Expression, height Expression) +Create a cone by specifying height and top radius in addition to the centre and radius at the base. +Input Parameters +base(Point) +The base centre point coordinate. +baseradius(Expression) +The base radius. +topradius(Expression) +The top radius. +height(Expression) +The height. +Return +Cone +The cone. +AddConeWithAngleAndHeight (base Point, baseradius Expression, angle Expression, height Expression) +Create a cone by specifying the height and side angle in addition to the centre and radius at the +base. +Input Parameters +base(Point) +The base centre point coordinate. +baseradius(Expression) +The base radius. +angle(Expression) +The angle (degrees) between the cone's side and base. +height(Expression) +The height. +Return +Cone +The cone. +AddConeWithAngleAndTopCentre (base Point, baseradius Expression, angle Expression, top Point) +Create a cone by specifying the top centre position and side angle in addition to the centre and +radius at the base. +Input Parameters +base(Point) +The base centre point coordinate. +baseradius(Expression) +The base radius. +angle(Expression) +The angle (degrees) between the cone's side and base. +top(Point) +The top centre point coordinate. +Return +Cone +The cone. +AddConeWithTopRadiusAndTopCentre (base Point, baseradius Expression, topradius Expression, top +Point) +Create a cone by specifying the centre and radius at the top in addition to the centre and radius +at the base. +Input Parameters +base(Point) +The base centre point coordinate. +baseradius(Expression) +The base radius. +topradius(Expression) +The top radius. +top(Point) +The top centre point coordinate. +Return +Cone +The cone. +AddConstrainedSurface (properties table) +Create a constrained surface from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new constrained surface. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ConstrainedSurface +The constrained surface. +p.2437 +AddConstrainedSurface (positionlist List of Point, normallist List of Point, uvpointlist List of UVPoint) +Add a constrained surface operator. +Input Parameters +positionlist(List of Point) +The list of point positions. +normallist(List of Point) +The list of normals for each point position. +uvpointlist(List of UVPoint) +The list of UV points for the surface. +Return +ConstrainedSurface +The constrained surface. +AddCross (properties table) +Create a cross from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new cross. +Return +Cross +The cross. +AddCross (centrepoint Point, armlengthu Expression, armlengthv Expression, stripwidth Expression) +Create a cross at the specified centre, arm lengths and strip width. +Input Parameters +centrepoint(Point) +The centre point coordinate. +armlengthu(Expression) +The cross arm length (U). +armlengthv(Expression) +The cross arm length (V). +stripwidth(Expression) +The cross strip width. +Return +Cross +The cross. +AddCuboid (properties table) +Create a cuboid from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new cuboid. +Return +Cuboid +The cuboid. +AddCuboid (cornerpoint Point, width Expression, depth Expression, height Expression) +Create a cuboid at the specified base corner and dimensions. +Input Parameters +cornerpoint(Point) +The base corner coordinates. +width(Expression) +The cuboid width (W). +depth(Expression) +The cuboid depth (D). +height(Expression) +The cuboid height (H). +Return +Cuboid +The cuboid. +AddCuboidAtCentre (centrepoint Point, width Expression, depth Expression, height Expression) +Create a cuboid at the specified base centre and dimensions. +Input Parameters +centrepoint(Point) +The base centre coordinates. +width(Expression) +The cuboid width (W). +depth(Expression) +The cuboid depth (D). +height(Expression) +The cuboid height (H). +Return +Cuboid +The cuboid. +AddCylinder (properties table) +Create a cylinder from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new cylinder. +Return +Cylinder +The cylinder. +AddCylinder (centrepoint Point, radius Expression, height Expression) +Create a cylinder at the specified base centre, radius and height. +Input Parameters +centrepoint(Point) +The base centre coordinates. +radius(Expression) +The cylinder radius. +height(Expression) +The cylinder height. +Return +Cylinder +The cylinder. +AddCylinderWithTopCentre (centrepoint Point, radius Expression, topcentrepoint Point) +Create a cylinder at the specified base centre, radius and top centre. +Input Parameters +centrepoint(Point) +The base centre coordinates. +radius(Expression) +The cylinder radius. +topcentrepoint(Point) +The cylinder height. +Return +Cylinder +The cylinder. +AddEllipse (properties table) +Create an ellipse from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new ellipse. +Return +Ellipse +The ellipse. +AddEllipse (centrepoint Point, radiusu Expression, radiusv Expression) +Create an ellipse at a given centre point and 2 radii. +Input Parameters +centrepoint(Point) +The centre point coordinate. +radiusu(Expression) +The U radius. +radiusv(Expression) +The V radius. +Return +Ellipse +The ellipse. +AddEllipticArc (properties table) +Create an elliptic arc from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new elliptic arc. +Return +EllipticArc +The elliptic arc. +AddEllipticArc (ellipsecentre Point, radiusu Expression, radiusv Expression, startangle Expression, +endangle Expression) +Create an elliptic arc by specifying the ellipse centre point, radii and the arc angles. +Input Parameters +ellipsecentre(Point) +The centre point coordinate of the ellipse on which the arc lies. +radiusu(Expression) +The ellipse U radius. +radiusv(Expression) +The ellipse V radius. +startangle(Expression) +The arc start angle (degrees). +endangle(Expression) +The arc end angle (degrees). +Return +EllipticArc +The elliptic arc. +AddEllipticArcWithAperture (aperturecentre Point, depth Expression, apertureradius Expression, +eccentricity Expression, majoraxisdirection EllipticArcMajorAxisDirectionEnum) +Create an elliptic arc by specifying the aperture centre point, depth, radius and eccentricity. +Input Parameters +aperturecentre(Point) +The centre point coordinate of the aperture formed by the elliptical arc section. +depth(Expression) +The distance from the aperture centre point to the apex of the elliptical arc section. +apertureradius(Expression) +The radius of the aperture of the elliptic arc. +eccentricity(Expression) +The eccentricity of the ellipse on which the elliptical arc section lies. The eccentricity +must be less than 1 to specify a valid ellipse. +majoraxisdirection(EllipticArcMajorAxisDirectionEnum) +The ellipse major axis direction specified by EllipticArcMajorAxisDirectionEnum. +Return +EllipticArc +The elliptic arc. +AddFittedSpline (properties table) +Create a fitted spline from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new fitted spline. +Return +FittedSpline +The fitted spline. +AddFittedSpline (points List of Point) +Create a fitted spline from the given coordinates. +Input Parameters +points(List of Point) +List of coordinates describing the fitted spline. +Return +FittedSpline +The fitted spline. +AddFlare (properties table) +Create a flare from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new flare. +Return +Flare +The flare. +AddFlare (base Point, bottomwidth Expression, bottomdepth Expression, height Expression, topwidth +Expression, topdepth Expression) +Create a flare by specifying the height, bottom- and top width, bottom- and top depth in addition +to the centre at the base. +Input Parameters +base(Point) +The base centre point coordinate. +bottomwidth(Expression) +The bottom width. +bottomdepth(Expression) +The bottom depth. +height(Expression) +The height. +topwidth(Expression) +The top width. +topdepth(Expression) +The top depth. +Return +Flare +The flare. +AddFlareWithBaseCentreAndFlareAngles (base Point, bottomwidth Expression, bottomdepth +Expression, height Expression, angleu Expression, anglev Expression) +Create a flare by specifying the height, bottom width, bottom depth and flare angles in addition to +the centre at the base. +Input Parameters +base(Point) +The base centre point coordinate. +bottomwidth(Expression) +The bottom width. +bottomdepth(Expression) +The bottom depth. +height(Expression) +The height. +angleu(Expression) +The flare angle (degrees) between the flare and the UN plane. +anglev(Expression) +The flare angle (degrees) between the flare and the VN plane. +Return +Flare +The flare. +AddFlareWithBaseCorner (base Point, bottomwidth Expression, bottomdepth Expression, height +Expression, topwidth Expression, topdepth Expression) +Create a flare by specifying the height, bottom- and top width, bottom- and top depth in addition +to the corner at the base. +Input Parameters +base(Point) +The base corner point coordinate. +bottomwidth(Expression) +The bottom width. +bottomdepth(Expression) +The bottom depth. +height(Expression) +The height. +topwidth(Expression) +The top width. +topdepth(Expression) +The top depth. +Return +Flare +The flare. +AddFlareWithBaseCornerAndTopCorner (base Point, top Point, bottomwidth Expression, bottomdepth +Expression) +Create a flare by specifying a corner at the base, a corner at the top as well as the bottom width +and depth. +Input Parameters +base(Point) +The base corner point coordinate. +top(Point) +The top corner point coordinate. +bottomwidth(Expression) +The bottom width. +bottomdepth(Expression) +The bottom depth. +Return +Flare +The flare. +AddHelix (properties table) +Create a helix from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new helix. +Return +Helix +The helix. +AddHelix (basecentre Point, baseradius Expression, endradius Expression, height Expression, turns +Expression, lefthandrotated boolean) +Create a variable radius helix by specifying the top and bottom radii, the height and number of +turns. +Input Parameters +basecentre(Point) +The centre point of the helix base. +baseradius(Expression) +The radius of the helix base. +endradius(Expression) +The radius of the helix top. +height(Expression) +The height of the helix. +turns(Expression) +The number of turns of the helix. +lefthandrotated(boolean) +The rotation direction of the helix. Left handed if true, else right handed. +Return +Helix +The helix. +AddHelixWithHeight (basecentre Point, radius Expression, height Expression, pitchangle Expression, +lefthandrotated boolean) +Create a constant radius helix with the number of turns implied by the height. +Input Parameters +basecentre(Point) +The centre point of the helix base. +radius(Expression) +The radius of the helix. +height(Expression) +The height of the helix. +pitchangle(Expression) +The angle (degrees) between the tangent of the curve and the UV plane. +lefthandrotated(boolean) +The rotation direction of the helix. Left handed if true, else right handed. +Return +Helix +The helix. +AddHelixWithTurns (basecentre Point, radius Expression, pitchangle Expression, turns Expression, +lefthandrotated boolean) +Create a constant radius helix with height implied by the number of turns. +Input Parameters +basecentre(Point) +The centre point of the helix base. +radius(Expression) +The radius of the helix. +pitchangle(Expression) +The angle (degrees) between the tangent of the curve and the UV plane. +turns(Expression) +The number of turns of the helix. +lefthandrotated(boolean) +The rotation direction of the helix. Left handed if true, else right handed. +Return +Helix +The helix. +AddHexagon (properties table) +Create a hexagon from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new hexagon. +Return +Hexagon +The hexagon. +AddHexagon (centrepoint Point, width Expression) +Create a hexagon at the specified centre and width. +Input Parameters +centrepoint(Point) +The centre point coordinate. +width(Expression) +The hexagon width. +Return +Hexagon +The hexagon. +AddHyperbolicArc (properties table) +Create a hyperbolic arc from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new hyperbolic arc. +Return +HyperbolicArc +The hyperbolic arc. +AddHyperbolicArc (basecentre Point, depth Expression, radius Expression, eccentricity Expression) +Create a hyperbolic arc by specifying the hyperbola base centre point, the radius, depth and +eccentricity. +Input Parameters +basecentre(Point) +The centre point coordinate of the hyperbola base. +depth(Expression) +The distance from the apex of the hyperbola to the centre of the aperture. +radius(Expression) +The radius of the hyperbolic arc's aperture. +eccentricity(Expression) +The eccentricity of the hyperbola on which the hyperbolic arc section lies. +Return +HyperbolicArc +The hyperbolic arc. +AddHyperbolicArcAtApertureCentre (aperturecentre Point, depth Expression, radius Expression, +eccentricity Expression) +Create a hyperbolic arc by specifying the centre point of the arc's aperture, the radius, depth and +eccentricity. +Input Parameters +aperturecentre(Point) +The aperture centre of the hyperbolic arc section. +depth(Expression) +The distance from the apex of the hyperbola to the centre of the aperture. +radius(Expression) +The radius of the hyperbolic arc's aperture. +eccentricity(Expression) +The eccentricity of the hyperbola on which the hyperbolic arc section lies. +Return +HyperbolicArc +The hyperbolic arc. +AddLine (properties table) +Create a line from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new line. +Return +Line +The line. +AddLine (startpoint Point, endpoint Point) +Create a straight line between the given start and end coordinates. +Input Parameters +startpoint(Point) +The start coordinate. +endpoint(Point) +The end coordinate. +Return +Line +The line. +AddNurbsSurface (properties table) +Create a NURBS surface from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new NURBS surface. +Return +NurbsSurface +The NURBS surface. +AddNurbsSurface (points PointExpressionTable, weights ExpressionTable) +Create a NURBS surface by specifying all control points and all weights. The number of rows and +columns (U' and V' direction orders) will be derived implicitly from the provided 2D tables' size. +Input Parameters +points(PointExpressionTable) +The 2D table containing the control points. +weights(ExpressionTable) +The 2D table containing the weights at each control point. +Return +NurbsSurface +The NURBS surface. +AddOpenRing (properties table) +Create an open ring from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new open ring. +Return +OpenRing +The open ring. +AddOpenRing (centrepoint Point, outerradius Expression, innerradius Expression, gapangle Expression, +startangle Expression) +Create an open ring at the specified centre, outer and inner radius, gap angle and start angle. +Input Parameters +centrepoint(Point) +The centre point coordinate. +outerradius(Expression) +The ring outer radius. +innerradius(Expression) +The ring inner radius. +gapangle(Expression) +The ring gap angle. +startangle(Expression) +The ring gap start angle. +Return +OpenRing +The open ring. +AddParabolicArc (properties table) +Create a parabolic arc from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new parabolic arc. +Return +ParabolicArc +The parabolic arc. +AddParabolicArc (basecentre Point, radius Expression, focaldepth Expression) +Create a parabolic arc by specifying the parabola base centre point, radius and focal depth. +Input Parameters +basecentre(Point) +The centre point coordinate of the parabola base. +radius(Expression) +The radius of the parabolic arc's aperture. +focaldepth(Expression) +The focal depth of the parabola. +Return +ParabolicArc +The parabolic arc. +AddParabolicArcAtApertureCentre (aperturecentre Point, radius Expression, depth Expression) +Create a parabolic arc by specifying the centre point of the arc's aperture, the radius and depth. +Input Parameters +aperturecentre(Point) +The aperture centre of the parabolic arc section. +radius(Expression) +The radius of the parabolic arc's aperture. +depth(Expression) +The distance from the apex of the parabola to the centre of the aperture. +Return +ParabolicArc +The parabolic arc. +AddParabolicArcAtBaseCentre (basecentre Point, radius Expression, depth Expression) +Create a parabolic arc by specifying the parabola base centre point, radius and depth. +Input Parameters +basecentre(Point) +The centre point coordinate of the parabola base. +radius(Expression) +The radius of the parabolic arc's aperture. +depth(Expression) +The distance from the apex of the parabola to the centre of the aperture. +Return +ParabolicArc +The parabolic arc. +AddParaboloid (properties table) +Create a paraboloid from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new paraboloid. +Return +Paraboloid +The paraboloid. +AddParaboloid (centrepoint Point, radius Expression, focaldepth Expression) +Create a paraboloid at a given centre point, with specified radius and focal depth. +Input Parameters +centrepoint(Point) +The centre point coordinate. +radius(Expression) +The radius. +focaldepth(Expression) +The focal depth. +Return +Paraboloid +The paraboloid. +AddPolygon (properties table) +Create a polygon from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new polygon. +Return +Polygon +The polygon. +AddPolyline (properties table) +Create a polyline from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new polyline. +Return +Polyline +The polyline. +AddPolyline (points List of Point) +Create a polyline from the given coordinates. +Input Parameters +points(List of Point) +List of coordinates describing the polyline. +Return +Polyline +The polyline. +AddRectangle (cornerpoint Point, width Expression, depth Expression) +Create a rectangle at the specified base corner and dimensions. +Input Parameters +cornerpoint(Point) +The base corner coordinates. +width(Expression) +The rectangle width (W). +depth(Expression) +The rectangle depth (D). +Return +Rectangle +The rectangle. +AddRectangle (properties table) +Create a rectangle from the properties given. +Input Parameters +properties(table) +Properties defining the new rectangle. +Return +Rectangle +The rectangle. +AddRectangleAtCentre (centrepoint Point, width Expression, depth Expression) +Create a rectangle at the specified base centre and dimensions. +Input Parameters +centrepoint(Point) +The base centre coordinates. +width(Expression) +The rectangle width (W). +depth(Expression) +The rectangle depth (D). +Return +Rectangle +The rectangle. +AddRing (properties table) +Create a ring from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new ring. +Return +Ring +The ring. +AddRing (centrepoint Point, outerradius Expression, innerradius Expression) +Create a ring at the specified centre, outer and inner radius. +Input Parameters +centrepoint(Point) +The centre point coordinate. +outerradius(Expression) +The ring outer radius. +innerradius(Expression) +The ring inner radius. +Return +Ring +The ring. +AddSphere (centre Point, radius Expression) +Create a sphere with the specified radius. +Input Parameters +centre(Point) +The coordinate of the centre of the sphere. +radius(Expression) +The radius of the sphere. +Return +Sphere +The spheroid. +AddSpheroid (properties table) +Create a spheroid from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new spheroid. +Return +Sphere +The spheroid. +AddSpheroid (centre Point, radiusu Expression, radiusv Expression, radiusn Expression) +Create a spheroid at centre with radii specified in the U, V and N directions. +Input Parameters +centre(Point) +The coordinate of the centre of the spheroid. +radiusu(Expression) +The radius in the U direction. +radiusv(Expression) +The radius in the V direction. +radiusn(Expression) +The radius in the N direction. +Return +Sphere +The spheroid. +AddSpiralCross (properties table) +Create a spiral cross from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new spiral cross. +Return +SpiralCross +The spiral cross. +AddSpiralCross (centrepoint Point, armlength Expression, edgelength Expression, spirallength +Expression, stripwidth Expression) +Create a spiral cross at the specified centre, arm length, edge length, spiral length and strip +width. +Input Parameters +centrepoint(Point) +The centre point coordinate. +armlength(Expression) +The cross arm length. +edgelength(Expression) +The cross edge length. +spirallength(Expression) +The cross spiral length. +stripwidth(Expression) +The cross strip width. +Return +SpiralCross +The spiral cross. +AddSplitRing (properties table) +Create a split ring from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new split ring. +Return +SplitRing +The split ring. +AddSplitRing (centrepoint Point, outerradius Expression, innerradius Expression, gapangle Expression, +startangle Expression) +Create a split ring at the specified centre, outer and inner radius, gap angle and start angle. +Input Parameters +centrepoint(Point) +The centre point coordinate. +outerradius(Expression) +The split ring outer radius. +innerradius(Expression) +The split ring inner radius. +gapangle(Expression) +The ring gap angle. +startangle(Expression) +The ring gap start angle. +Return +SplitRing +The split ring. +AddStripCross (properties table) +Create a strip cross from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new strip cross. +Return +StripCross +The strip cross. +AddStripCross (properties Point, armlengthu Expression, armlengthv Expression, stripwidth +Expression, slotwidth Expression) +Create a strip cross at the specified centre, arm lengths, strip width and slot width. +Input Parameters +properties(Point) +The centre point coordinate. +armlengthu(Expression) +The cross arm length (U). +armlengthv(Expression) +The cross arm length (V). +stripwidth(Expression) +The cross strip width. +slotwidth(Expression) +The cross slot width. +Return +StripCross +The strip cross. +AddStripHexagon (properties table) +Create a strip hexagon from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new strip hexagon. +Return +StripHexagon +The strip hexagon. +AddStripHexagon (centrepoint Point, width Expression, stripwidth Expression) +Create a strip hexagon at the specified centre, width and strip width. +Input Parameters +centrepoint(Point) +The centre point coordinate. +width(Expression) +The hexagon width. +stripwidth(Expression) +The hexagon strip width. +Return +StripHexagon +The strip hexagon. +AddSurfaceBezierCurve (properties table) +Create a surface Bezier from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new surface Bezier curve. +Return +SurfaceBezierCurve +The surface Bezier curve. +AddSurfaceBezierCurve (worksurface WorkSurface, startu Expression, startv Expression, starttangentu +Expression, starttangentv Expression, endtangentu Expression, endtangentv Expression, endu +Expression, endv Expression) +Add a surface Bezier curve operator. +Input Parameters +worksurface(WorkSurface) +The work surface on which to create the surface line. +startu(Expression) +The start point U' coordinate. +startv(Expression) +The start point V' coordinate. +starttangentu(Expression) +The start tangent point U' coordinate. +starttangentv(Expression) +The start tangent point V' coordinate. +endtangentu(Expression) +The end tangent point U' coordinate. +endtangentv(Expression) +The end tangent point V' coordinate. +endu(Expression) +The end point U' coordinate. +endv(Expression) +The end point V' coordinate. +Return +SurfaceBezierCurve +The surface Bezier curve. +AddSurfaceLine (properties table) +Create a surface line from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new surface line. +Return +SurfaceLine +The surface line. +AddSurfaceLine (worksurface WorkSurface, startu Expression, startv Expression, endu Expression, +endv Expression) +Add a surface line operator. +Input Parameters +worksurface(WorkSurface) +The work surface on which to create the surface line. +startu(Expression) +The start point U' coordinate. +startv(Expression) +The start point V' coordinate. +endu(Expression) +The end point U' coordinate. +endv(Expression) +The end point V' coordinate. +Return +SurfaceLine +The surface line operator. +AddSurfaceRegularLines (properties table) +Create a surface regular lines operator from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new surface regular lines. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +SurfaceRegularLines +The surface regular lines. +p.2459 +AddSurfaceRegularLines (worksurface WorkSurface, startcorneru Expression, startcornerv Expression, +endcorneru Expression, endcornerv Expression, numlines Expression) +Add a surface regular lines operator. +Input Parameters +worksurface(WorkSurface) +The work surface on which to create the surface line. +startcorneru(Expression) +The start corner point U' coordinate. +startcornerv(Expression) +The start corner point V' coordinate. +endcorneru(Expression) +The end corner point U' coordinate. +endcornerv(Expression) +The end corner point V' coordinate. +numlines(Expression) +The number of lines. +Return +SurfaceRegularLines +The surface line operator. +AddTCross (properties table) +Create a T-cross from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new T-cross. +Return +TCross +The T-cross. +AddTCross (centrepoint Point, armlength Expression, edgelength Expression, stripwidth Expression) +Create a T-cross at the specified centre, arm length, edge length and strip width. +Input Parameters +centrepoint(Point) +The centre point coordinate. +armlength(Expression) +The cross arm length. +edgelength(Expression) +The cross edge length. +stripwidth(Expression) +The cross strip width. +Return +TCross +The T-cross. +AddTrifilar (propreties table) +Create a trifilar from a table defining the properties. +Input Parameters +propreties(table) +A table of properties defining the new trifilar. +Return +Trifilar +The trifilar. +AddTrifilar (position Point, length Expression, stripwidth Expression) +Create a trifilar at the specified centre, length and strip width. +Input Parameters +position(Point) +The centre point coordinate. +length(Expression) +The trifilar length. +stripwidth(Expression) +The trifilar strip width. +Return +Trifilar +The trifilar. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2461 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +ImprintPoints (geometry Geometry, properties table) +Imprint points onto the geometry. +Input Parameters +geometry(Geometry) +The geometry onto which to imprint. +properties(table) +A table of properties defining the imprint points operator. +Return +ImprintPoints +The points imprint operator. +ImprintPoints (geometry Geometry, points List of Point) +Imprint points onto the geometry. +Input Parameters +geometry(Geometry) +The geometry onto which to imprint. +points(List of Point) +The list of point coordinates to imprint. +Return +ImprintPoints +The points imprint operator. +Intersect (geometrylist List of Geometry) +Intersect the given geometry. +Input Parameters +geometrylist(List of Geometry) +The list of geometry that must be intersected. +Return +Intersect +The intersect operator. +Item (index number) +Returns the Geometry for the given index in the collection. +Input Parameters +index(number) +The index of the Geometry. +Return +Geometry +The item in the collection +Item (label string) +Returns the Geometry for the given label in the collection. +Input Parameters +label(string) +The label of the Geometry. +Return +Geometry +The item in the collection +Items () +Returns a table of Geometry items. +Return +UnsupportedType(List of Geometry) +The list of items in the collection +Loft (startgeometry Geometry, endgeometry Geometry) +Create a loft from one geometry profile to another. The two geometry profiles should either both +be surfaces or curves. For surfaces each profile can only contain a single face without holes. For +curves and arcs, the profiles must be continuous. +Input Parameters +startgeometry(Geometry) +The profile to loft from. +endgeometry(Geometry) +The profile to loft to. +Return +Loft +The loft operator. +Loft (properties table) +Create a loft from one geometry profile to another, using a table defining the properties. The two +geometry profiles should either both be surfaces or curves. For surfaces each profile can only +contain a single face without holes. For curves and arcs, the profiles must be continuous. +Input Parameters +properties(table) +A table of properties defining the loft. +Return +Loft +The loft operator. +Loft (startgeometry Geometry, endgeometry Geometry, reverse boolean) +Create a loft from one geometry profile to another. The two geometry profiles should either both +be surfaces or curves. For surfaces each profile can only contain a single face without holes. For +curves and arcs, the profiles must be continuous. +Input Parameters +startgeometry(Geometry) +The profile to loft from. +endgeometry(Geometry) +The profile to loft to. +reverse(boolean) +Reverse the orientation of the loft operations. +Return +Loft +The loft operator. +Loft (startgeometry Geometry, endgeometry Geometry, properties table) +Create a loft from one geometry profile to another, using a table defining the properties. The two +geometry profiles should either both be surfaces or curves. For surfaces each profile can only +contain a single face without holes. For curves and arcs, the profiles must be continuous. +Input Parameters +startgeometry(Geometry) +The profile to loft from. +endgeometry(Geometry) +The profile to loft to. +properties(table) +A table of properties defining the new loft. +Return +Loft +The loft operator. +LoftEdges (startedge Edge, endedge Edge) +Create a loft from one edge to another. The edges will be copied out of their current geometry +into new geometry profiles. Also accepts wires. +Input Parameters +startedge(Edge) +The edge to loft from. +endedge(Edge) +The edge to loft to. +Return +Loft +The loft operator. +LoftEdges (startedge Edge, endedge Edge, properties table) +Create a loft from one edge to another, using a table defining the properties. The edges will be +copied out of their current geometry into new geometry profiles. Also accepts wires. +Input Parameters +startedge(Edge) +The edge to loft from. +endedge(Edge) +The edge to loft to. +properties(table) +A table of properties defining the new loft. +Return +Loft +The loft operator. +LoftFaces (startface Face, endface Face) +Create a loft from one face to another. The faces will be copied out of their current geometry into +new geometry profiles. The faces should not contain holes. +Input Parameters +startface(Face) +The face to loft from. +endface(Face) +The face to loft to. +Return +Loft +The loft operator. +LoftFaces (startface Face, endface Face, properties table) +Create a loft from one face to another, using a table defining the properties. The faces will be +copied out of their current geometry into new geometry profiles. The faces should not contain +holes. +Input Parameters +startface(Face) +The face to loft from. +endface(Face) +The face to loft to. +properties(table) +A table of properties defining the new loft. +Return +Loft +The loft operator. +PathSweep (geometry Geometry, path Geometry) +Sweep a part along the given path. +Input Parameters +geometry(Geometry) +The geometry to sweep. +path(Geometry) +The geometry defining the path to sweep along. +Return +PathSweep +The path sweep operator. +PathSweep (geometry Geometry, path Geometry, twistangle Expression, scalefactor Expression, flipends +boolean) +Sweep a part along the given path with normal alignment. +Input Parameters +geometry(Geometry) +The geometry to sweep. +path(Geometry) +The geometry defining the path to sweep along. +twistangle(Expression) +The twist angle of the path sweep (degrees). +scalefactor(Expression) +The scale factor of the path sweep. +flipends(boolean) +Start the sweep from the other end of the path. +Return +PathSweep +The path sweep operator. +PathSweep (geometry Geometry, path Geometry, flipends boolean) +Sweep a part along the given path. +Input Parameters +geometry(Geometry) +The geometry to sweep. +path(Geometry) +The geometry defining the path to sweep along. +flipends(boolean) +Start the sweep from the other end of the path. +Return +PathSweep +The path sweep operator. +PathSweepParallel (geometry Geometry, path Geometry, twistangle Expression, scalefactor +Expression, flipends boolean) +Sweep a part along the given path with parallel alignment. +Input Parameters +geometry(Geometry) +The geometry to sweep. +path(Geometry) +The geometry defining the path to sweep along. +twistangle(Expression) +The twist angle of the path sweep (degrees). +scalefactor(Expression) +The scale factor of the path sweep. +flipends(boolean) +Start the sweep from the other end of the path (boolean). +Return +PathSweep +The path sweep operator. +ProjectGeometry (geometrylist List of Geometry, part Geometry) +Project the provided list of geometry onto the target geometry. +Input Parameters +geometrylist(List of Geometry) +The list of geometry to project. +part(Geometry) +The geometry to project onto. +Return +ProjectGeometry +The project geometry operator. +ProjectGeometry (geometry Geometry, part Geometry) +Project the provided geometry onto the target geometry. +Input Parameters +geometry(Geometry) +The geometry to project. +part(Geometry) +The geometry to project onto. +Return +ProjectGeometry +The project geometry operator. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Simplify (properties table) +Simplify the provided geometry using a table to define the simplification settings. +Input Parameters +properties(table) +A table of properties defining the simplify operation. +Return +List of Simplify +The simplify operator. +Simplify (geometry Geometry) +Simplify the provided geometry. +Input Parameters +geometry(Geometry) +The geometry to be simplified. +Return +Simplify +The simplify operator. +SimplifyEntities (geometrylist List of Geometry) +Simplify the provided geometry. +Input Parameters +geometrylist(List of Geometry) +The list of geometry that must be simplified. +Return +List of Simplify +The simplify operator. +Spin (geometry Geometry, properties table) +Spin geometry using a table defining the properties. +Input Parameters +geometry(Geometry) +The geometry that must be spun. +properties(table) +A table of properties defining the spin operation. +Return +Spin +The spin operator. +Spin (geometry Geometry, axisorigin Point, axisdirection Point, angle Expression) +Spin the given geometry. +Input Parameters +geometry(Geometry) +The geometry that must be spun. +axisorigin(Point) +The coordinates of the axis of rotation. +axisdirection(Point) +The direction of the axis of rotation. +angle(Expression) +The angle (degrees) to spin by. +Return +Spin +The spin operator. +Split (properties table) +Split geometry using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the split operation. +Return +List of Split +The list of split operator. +Split (geometry Geometry, origin Point, rotationu Expression, rotationv Expression) +Split geometry along the UV plane. +Input Parameters +geometry(Geometry) +The geometry that must be split. +origin(Point) +The origin of the split plane. +rotationu(Expression) +The split plane U axis rotation angle (degrees). +rotationv(Expression) +The split plane V axis rotation angle (degrees). +Return +List of Split +The list of split operator. +SplitPlaneUN (geometry Geometry, origin Point, rotationu Expression, rotationn Expression) +Split geometry along the UN plane. +Input Parameters +geometry(Geometry) +The geometry that must be split. +origin(Point) +The origin of the split plane. +rotationu(Expression) +The split plane U axis rotation angle (degrees). +rotationn(Expression) +The split plane N axis rotation angle (degrees). +Return +List of Split +The list of split operator. +SplitPlaneVN (geometry Geometry, origin Point, rotationv Expression, rotationn Expression) +Split geometry along the VN plane. +Input Parameters +geometry(Geometry) +The geometry that must be split. +origin(Point) +The geometry that must be split. +rotationv(Expression) +The split plane V axis rotation angle (degrees). +rotationn(Expression) +The split plane N axis rotation angle (degrees). +Return +List of Split +The list of split operator. +Stitch (properties table) +Stitch the given geometry. +Input Parameters +properties(table) +Create a stitch with the given properties. +Return +Stitch +The Stitch operator. +Stitch (geometrylist List of Geometry) +Stitch the given geometry. +Input Parameters +geometrylist(List of Geometry) +The list of geometry that must be stitched. +Return +Stitch +The Stitch operator. +Stitch (geometrylist List of Geometry, tolerance Expression) +Stitch the given geometry. +Input Parameters +geometrylist(List of Geometry) +The list of geometry that must be stitched. +tolerance(Expression) +The tolerance to use when stitching. +Return +Stitch +The Stitch operator. +Subtract (part Geometry, geometrylist List of Geometry) +Subtract the given geometry. +Input Parameters +part(Geometry) +The geometry part to subtract from. +geometrylist(List of Geometry) +The list of geometry to subtract. +Return +Subtract +The subtract operator. +Subtract (part Geometry, parttosubtract Geometry) +Subtract the given geometry. +Input Parameters +part(Geometry) +The geometry part to subtract from. +parttosubtract(Geometry) +The part to subtract. +Return +Subtract +The subtract operator. +Sweep (geometry Geometry, properties table) +Sweep geometry using a table defining the properties. +Input Parameters +geometry(Geometry) +The geometry that must be swept. +properties(table) +A table of properties defining the sweep operation. +Return +Sweep +The sweep operator. +Sweep (geometry Geometry, from Point, to Point) +Sweep geometry between the vector defined by the given start and end points. +Input Parameters +geometry(Geometry) +The geometry to sweep. +from(Point) +The point to start the sweep from. +to(Point) +The point to sweep to. +Return +Sweep +The sweep operator. +Union (geometrylist List of Geometry) +Union the given geometry. +Input Parameters +geometrylist(List of Geometry) +The list of geometry that must be unioned. +Return +Union +The union operator. +Union () +Union all the geometry. +Return +Union +The union operator. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +GeometryGroup +A group of geometry. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add some geometry +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +flare = project.Contents.Geometry:AddFlare(cf.Point(0.5, 0.5, 1), 1, -1, 0.5, 0, 1) +-- Add the geometry to the group +group = project.Contents.Geometry:CreateGroup() +group:MoveIn({cuboid, flare}) + -- Apply a transform to the group +from = cf.Point(0, 0, 0) +to = cf.Point(1, 1, 1) +translate = group.Transforms:AddTranslate(from, to) +Inheritance +The GeometryGroup object is derived from the Object object. +Usage locations +The GeometryGroup object can be accessed from the following locations: +• Methods +◦ GeometryGroupCollection collection has method Item(number). +◦ GeometryGroupCollection collection has method Item(string). +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +The number of Geometry items in the collection. (Read only number) +Count +Label +The object label. (Read/Write string) +LocalWorkplane +The source workplane. (Read/Write LocalWorkplane) +Type +The object type string. (Read only string) +Collection List +Transforms +The collection of transforms on the operator. (TransformCollection of Transform.) +Method List +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. (Returns a Object object.) +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.) +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. (Returns a List of Object object.) +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. (Returns a List of Object object.) +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. (Returns a List of Object object.) +Delete () +Deletes the entity. +Disassemble () +Disassembles the group. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Geometry for the given index in the collection. (Returns a Geometry object.) +Item (label string) +Returns the Geometry for the given label in the collection. (Returns a Geometry object.) +Items () +Returns a table of Geometry items. (Returns a UnsupportedType(List of Geometry) object.) +MoveOut (geometry List of Object) +Moves the specified geometry parts out of this geometry group. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Count +The number of Geometry items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +LocalWorkplane +The source workplane. +Type +LocalWorkplane +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +Transforms +The collection of transforms on the operator. +Type +TransformCollection +Method Details +CopyAndMirror (properties table) +Apply a copy and mirror using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the mirror transform. +Return +Object +The mirrored geometry. +CopyAndRotate (properties table, count number) +Apply a copy and rotate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of rotated geometry. +CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number) +Copy and rotate the geometry. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(number) +The angle of rotation (degrees). +count(number) +The number of copies. +Return +List of Object +The list of rotated geometry. +CopyAndTranslate (properties table, count number) +Apply a copy and translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +count(number) +The number of transform copies. +Return +List of Object +The list of translated geometry. +CopyAndTranslate (from Point, to Point, count number) +Copy and translate the geometry. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +count(number) +The number of copies. +Return +List of Object +The list of translated geometry. +Delete () +Deletes the entity. +Disassemble () +Disassembles the group. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Geometry for the given index in the collection. +Input Parameters +index(number) +The index of the Geometry. +Return +Geometry +The item in the collection +Item (label string) +Returns the Geometry for the given label in the collection. +Input Parameters +label(string) +The label of the Geometry. +Return +Geometry +The item in the collection +Items () +Returns a table of Geometry items. +Return +UnsupportedType(List of Geometry) +The list of items in the collection +MoveOut (geometry List of Object) +Moves the specified geometry parts out of this geometry group. +Input Parameters +geometry(List of Object) +The geometry part to remove from the group. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GeometryGroupCollection +A collection of geometry groups. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add some geometry +p.2480 +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +flare = project.Contents.Geometry:AddFlare(cf.Point(0.5, 0.5, 1), 1, -1, 0.5, 0, 1) + -- Add the geometry to the group +group = project.Contents.Geometry:CreateGroup() +group:MoveIn({cuboid, flare}) + -- Apply a transform to the group +from = cf.Point(0, 0, 0) +to = cf.Point(1, 1, 1) +translate = group.Transforms:AddTranslate(from, to) +Inheritance +The GeometryGroupCollection object is derived from the Object object. +Usage locations +The GeometryGroupCollection object can be accessed from the following locations: +• Collection lists +Property List +Count +Label +Type +The number of GeometryGroup items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2481 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the GeometryGroup for the given index in the collection. (Returns a GeometryGroup +object.) +Item (label string) +Returns the GeometryGroup for the given label in the collection. (Returns a GeometryGroup +object.) +Items () +Returns a table of GeometryGroup items. (Returns a UnsupportedType(List of GeometryGroup) +object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of GeometryGroup items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the GeometryGroup for the given index in the collection. +Input Parameters +index(number) +The index of the GeometryGroup. +Return +GeometryGroup +The item in the collection +Item (label string) +Returns the GeometryGroup for the given label in the collection. +Input Parameters +label(string) +The label of the GeometryGroup. +Return +GeometryGroup +The item in the collection +Items () +Returns a table of GeometryGroup items. +Return +UnsupportedType(List of GeometryGroup) +The list of items in the collection +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.2483 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ImpedanceSheetCollection +A collection of impedance sheet media. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create the impedance sheet medium +sheet = project.Definitions.Media.ImpedanceSheet:AddImpedanceSheet(1, 2) +Inheritance +The ImpedanceSheetCollection object is derived from the Object object. +Usage locations +The ImpedanceSheetCollection object can be accessed from the following locations: +• Collection lists +◦ Media object has collection ImpedanceSheet. +Property List +Count +Label +Type +The number of ImpedanceSheet items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddImpedanceSheet (properties table) +Create an impedance sheet medium from a table defining the properties. (Returns a +ImpedanceSheet object.) +AddImpedanceSheet (realimpedance Expression, imaginaryimpedance Expression) +Create an impedance sheet medium. (Returns a ImpedanceSheet object.) +AddImpedanceSheet () +Create an impedance sheet medium. (Returns a ImpedanceSheet object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2485 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the ImpedanceSheet for the given index in the collection. (Returns a ImpedanceSheet +object.) +Item (label string) +Returns the ImpedanceSheet for the given label in the collection. (Returns a ImpedanceSheet +object.) +Items () +Returns a table of ImpedanceSheet items. (Returns a UnsupportedType(List of ImpedanceSheet) +object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of ImpedanceSheet items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddImpedanceSheet (properties table) +Create an impedance sheet medium from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new impedance sheet medium. +Return +ImpedanceSheet +The impedance sheet medium. +AddImpedanceSheet (realimpedance Expression, imaginaryimpedance Expression) +Create an impedance sheet medium. +Input Parameters +realimpedance(Expression) +The frequency independent real impedance (Ohm). +imaginaryimpedance(Expression) +The frequency independent imaginary impedance (Ohm). +Return +ImpedanceSheet +The impedance sheet medium. +AddImpedanceSheet () +Create an impedance sheet medium. +Return +ImpedanceSheet +The impedance sheet medium. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the ImpedanceSheet for the given index in the collection. +Input Parameters +index(number) +The index of the ImpedanceSheet. +Return +ImpedanceSheet +The item in the collection +Item (label string) +Returns the ImpedanceSheet for the given label in the collection. +Input Parameters +label(string) +The label of the ImpedanceSheet. +Return +ImpedanceSheet +The item in the collection +Items () +Returns a table of ImpedanceSheet items. +Return +UnsupportedType(List of ImpedanceSheet) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +LayeredDielectricCollection +A collection of layered dielectric media. +Example +p.2489 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create the dielectric media +dielectric1 = project.Definitions.Media.Dielectric:AddDielectric() +dielectric2 = project.Definitions.Media.Dielectric:AddDielectric() +dielectric3 = project.Definitions.Media.Dielectric:AddDielectric() + -- Create the layered dielectric medium +layered = + project.Definitions.Media.LayeredDielectric:AddLayeredDielectric({0.1, 0.1, 0.1}, + {dielectric1, dielectric2, dielectric3}) +Inheritance +The LayeredDielectricCollection object is derived from the Object object. +Usage locations +The LayeredDielectricCollection object can be accessed from the following locations: +• Collection lists +◦ Media object has collection LayeredDielectric. +Property List +Count +Label +Type +The number of LayeredDielectric items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddLayeredAnisotropicDielectric (properties table) +Create a layered dielectric (anisotropic) medium from a table defining the properties. (Returns a +LayeredAnisotropicDielectric object.) +AddLayeredAnisotropicDielectric (thicknesslist ExpressionList, directionlist ExpressionList, +principlemediumlist List of Dielectric, orthogonalmediumlist List of Dielectric) +Create a layered dielectric (anisotropic) medium. (Returns a LayeredAnisotropicDielectric object.) +AddLayeredDielectric (properties table) +Create a layered dielectric (isotropic) medium from a table defining the properties. (Returns a +LayeredIsotropicDielectric object.) +AddLayeredDielectric (thicknesslist ExpressionList, mediumlist List of Dielectric) +Create a layered dielectric (isotropic) medium. (Returns a LayeredIsotropicDielectric object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the LayeredDielectric for the given index in the collection. (Returns a LayeredDielectric +object.) +Item (label string) +Returns the LayeredDielectric for the given label in the collection. (Returns a LayeredDielectric +object.) +Items () +Returns a table of LayeredDielectric items. (Returns a UnsupportedType(List of LayeredDielectric) +object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of LayeredDielectric items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddLayeredAnisotropicDielectric (properties table) +Create a layered dielectric (anisotropic) medium from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new layered dielectric medium. +Return +LayeredAnisotropicDielectric +The layered anisotropic dielectric medium. +AddLayeredAnisotropicDielectric (thicknesslist ExpressionList, directionlist ExpressionList, +principlemediumlist List of Dielectric, orthogonalmediumlist List of Dielectric) +Create a layered dielectric (anisotropic) medium. +Input Parameters +thicknesslist(ExpressionList) +The list of layer thicknesses (in the model unit). +directionlist(ExpressionList) +The list of angles (in degrees) from which the principle directions is obtained. +principlemediumlist(List of Dielectric) +The list of layer dielectric media in the principle direction. +orthogonalmediumlist(List of Dielectric) +The list of layer dielectric media in the orthogonal direction. +Return +LayeredAnisotropicDielectric +The layered anisotropic dielectric medium. +AddLayeredDielectric (properties table) +Create a layered dielectric (isotropic) medium from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new layered dielectric medium. +Return +LayeredIsotropicDielectric +The layered isotropic dielectric medium. +AddLayeredDielectric (thicknesslist ExpressionList, mediumlist List of Dielectric) +Create a layered dielectric (isotropic) medium. +Input Parameters +thicknesslist(ExpressionList) +The list of layer thicknesses (in the model unit). +mediumlist(List of Dielectric) +The list of layer dielectric media. +Return +LayeredIsotropicDielectric +The layered isotropic dielectric medium. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the LayeredDielectric for the given index in the collection. +Input Parameters +index(number) +The index of the LayeredDielectric. +Return +LayeredDielectric +The item in the collection +Item (label string) +Returns the LayeredDielectric for the given label in the collection. +Input Parameters +label(string) +The label of the LayeredDielectric. +Return +LayeredDielectric +The item in the collection +Items () +Returns a table of LayeredDielectric items. +Return +UnsupportedType(List of LayeredDielectric) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +LoadCollection +A collection of loads. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Get the 'LoadCollection' from the 'SolutionConfiguration' +loadCollection = project.Contents.SolutionConfigurations.GlobalLoads + -- Add a complex load to the collection. +dielectric = project.Definitions.Media.Dielectric:AddDielectric() +cube = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +cube.Regions[1].Medium = dielectric +cube.Regions[1].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.FEM +femLinePort = + project.Contents.Ports:AddFEMLinePortBetweenPoints(cf.Point(0,0,0) ,cf.Point(1,1,0) ) +complexLoad = loadCollection:AddComplex(femLinePort,"220","0") + -- Query the number of loads in the collection +numberOfLoads = #loadCollection +Inheritance +The LoadCollection object is derived from the Object object. +Usage locations +The LoadCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfigurationCollection collection has collection GlobalLoads. +◦ SolutionConfiguration object has collection Loads. +◦ CharacteristicModesConfiguration object has collection Loads. +◦ SParameterConfiguration object has collection Loads. +◦ StandardConfiguration object has collection Loads. +Property List +Count +Label +Type +The number of Load items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method List +p.2495 +AddComplex (portterminal Port, real Expression, imaginary Expression) +Create a load on the specified terminal with complex impedance. (Returns a Load object.) +AddLoad (properties table) +Create a load using the table of properties. (Returns a Load object.) +AddParallel (portterminal Port, resistance Expression, capacitance Expression, inductance Expression) +Create a load on the specified terminal with parallel circuit configuration. (Returns a Load object.) +AddSeries (portterminal Port, resistance Expression, capacitance Expression, inductance Expression) +Create a load on the specified terminal with series circuit configuration. (Returns a Load object.) +AddSinglePortTouchstone (portterminal Port, filename string) +Create a load on the specified terminal from data stored in a 1-port Touchstone file. (Returns a +Load object.) +AddSpiceCircuit (portterminal Port, filename string) +Create a load on the specified terminal from data stored in a SPICE circuit file. (Returns a Load +object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Load for the given index in the collection. (Returns a Load object.) +Item (label string) +Returns the Load for the given label in the collection. (Returns a Load object.) +Items () +Returns a table of Load items. (Returns a UnsupportedType(List of Load) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Load items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddComplex (portterminal Port, real Expression, imaginary Expression) +Create a load on the specified terminal with complex impedance. +Input Parameters +portterminal(Port) +The terminal to create the load on. +real(Expression) +The real part of the complex impedance (Ohm). +imaginary(Expression) +The reactive part of the complex impedance (Ohm). +Return +Load +The load. +AddLoad (properties table) +Create a load using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +Load +The load. +AddParallel (portterminal Port, resistance Expression, capacitance Expression, inductance Expression) +Create a load on the specified terminal with parallel circuit configuration. +Input Parameters +portterminal(Port) +The terminal to create the load on. +resistance(Expression) +The resistive part of the parallel circuit load definition (Ohm). +capacitance(Expression) +The capacitive part of the parallel circuit load definition (F). +inductance(Expression) +The inductive part of the parallel circuit load definition (H). +Return +Load +The load source. +AddSeries (portterminal Port, resistance Expression, capacitance Expression, inductance Expression) +Create a load on the specified terminal with series circuit configuration. +Input Parameters +portterminal(Port) +The terminal to create the load on. +resistance(Expression) +The resistive part of the series circuit load definition (Ohm). +capacitance(Expression) +The capacitive part of the series circuit load definition (F). +inductance(Expression) +The inductive part of the series circuit load definition (H). +Return +Load +The load source. +AddSinglePortTouchstone (portterminal Port, filename string) +Create a load on the specified terminal from data stored in a 1-port Touchstone file. +Input Parameters +portterminal(Port) +The terminal to create the load on. +filename(string) +The Touchstone filename. +Return +Load +The load source. +AddSpiceCircuit (portterminal Port, filename string) +Create a load on the specified terminal from data stored in a SPICE circuit file. +Input Parameters +portterminal(Port) +The terminal to create the load on. +filename(string) +The SPICE circuit filename. +Return +Load +The load source. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Load for the given index in the collection. +Input Parameters +index(number) +The index of the Load. +Return +Load +The item in the collection +Item (label string) +Returns the Load for the given label in the collection. +Input Parameters +label(string) +The label of the Load. +Return +Load +The item in the collection +Items () +Returns a table of Load items. +Return +UnsupportedType(List of Load) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MediaLibrary +The media library of predefined and user defined media. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a medium from the media library +diel1 = application.MediaLibrary:AddToModel("Aluminium") +Inheritance +The MediaLibrary object is derived from the Object object. +Usage locations +The MediaLibrary object can be accessed from the following locations: +• Collection lists +◦ Application object has collection MediaLibrary. +Property List +Count +Label +Type +The number of LibraryMedium items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddToModel (mediumname string) +Add a medium from the library to the CADFEKO model. (Returns a Medium object.) +AddToModelWithLabel (mediumname string, modellabel string) +Add a medium from the library to the CADFEKO model with a new label. (Returns a Medium +object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Item (index number) +p.2501 +Returns the LibraryMedium for the given index in the collection. (Returns a LibraryMedium +object.) +Item (label string) +Returns the LibraryMedium for the given label in the collection. (Returns a LibraryMedium object.) +Items () +Returns a table of LibraryMedium items. (Returns a UnsupportedType(List of LibraryMedium) +object.) +Replace (label LibraryMedium, medium LibraryMedium) +Replace the user defined medium in the media library. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of LibraryMedium items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddToModel (mediumname string) +Add a medium from the library to the CADFEKO model. +Input Parameters +mediumname(string) +The name of the library medium to add. +Return +Medium +The medium added to the model. +AddToModelWithLabel (mediumname string, modellabel string) +Add a medium from the library to the CADFEKO model with a new label. +Input Parameters +mediumname(string) +The name of the library medium to add. +modellabel(string) +The label that will be assigned to the medium. +Return +Medium +The medium added to the model. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the LibraryMedium for the given index in the collection. +Input Parameters +index(number) +The index of the LibraryMedium. +Return +LibraryMedium +The item in the collection +Item (label string) +Returns the LibraryMedium for the given label in the collection. +Input Parameters +label(string) +The label of the LibraryMedium. +Return +LibraryMedium +The item in the collection +Items () +Returns a table of LibraryMedium items. +Return +UnsupportedType(List of LibraryMedium) +The list of items in the collection +Replace (label LibraryMedium, medium LibraryMedium) +Replace the user defined medium in the media library. +Input Parameters +label(LibraryMedium) +The label of the user defined medium to replace. +medium(LibraryMedium) +The new medium. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MeshCurvilinearTriangleFaceCollection +A collection of faces meshed with curvilinear triangles. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Settings for curvilinear meshing +project.Contents.SolutionSettings.SolverSettings.GeneralSettings.BasisFunctionSettings.HOBFEnabled + = true +advancedMeshSettings = project.Mesher.Settings.Advanced +advancedMeshSettings.CurvilinearSegments + = cf.Enums.MeshCurvilinearOptionsEnum.Disabled +advancedMeshSettings.CurvilinearTriangles + = cf.Enums.MeshCurvilinearOptionsEnum.Enabled +frequency = project.Contents.SolutionConfigurations.GlobalFrequency +frequency.Start = "1e08" + -- Create geometry and mesh +project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1.0) +project.Mesher:Mesh() +project.Contents.Geometry["Sphere1"]:UnlinkMesh() + -- Obtain a handle to the 'MeshCurvilinearTriangleFaceCollection' +meshCurvilinearTriangleFaces = project.Contents.Meshes["Sphere1_1"].CurvilinearFaces + -- Store the number of curvilinear triangle faces +meshCurvilinearTriangleFacesCount = meshCurvilinearTriangleFaces.Count +Inheritance +The MeshCurvilinearTriangleFaceCollection object is derived from the Object object. +Usage locations +The MeshCurvilinearTriangleFaceCollection object can be accessed from the following locations: +• Collection lists +◦ Mesh object has collection CurvilinearFaces. +Property List +Count +Label +The number of MeshCurvilinearTriangleFace items in the collection. (Read only number) +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.2506 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the MeshCurvilinearTriangleFace for the given index in the collection. (Returns a +MeshCurvilinearTriangleFace object.) +Item (label string) +Returns the MeshCurvilinearTriangleFace for the given label in the collection. (Returns a +MeshCurvilinearTriangleFace object.) +Items () +Returns a table of MeshCurvilinearTriangleFace items. (Returns a UnsupportedType(List of +MeshCurvilinearTriangleFace) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of MeshCurvilinearTriangleFace items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the MeshCurvilinearTriangleFace for the given index in the collection. +Input Parameters +index(number) +The index of the MeshCurvilinearTriangleFace. +Return +MeshCurvilinearTriangleFace +The item in the collection +Item (label string) +Returns the MeshCurvilinearTriangleFace for the given label in the collection. +Input Parameters +label(string) +The label of the MeshCurvilinearTriangleFace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +MeshCurvilinearTriangleFace +The item in the collection +Items () +Returns a table of MeshCurvilinearTriangleFace items. +Return +UnsupportedType(List of MeshCurvilinearTriangleFace) +The list of items in the collection +p.2508 +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshCylinderCollection +A collection of unmeshed cylinders that are part of a mesh model. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Set the frequency +p.2509 +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08" + -- Create geometry, set the solution method to UTD +cylinder = project.Contents.Geometry:AddCylinder(cf.Point(-0.25,-0.25,0), 0.5, 1.0) +cylinder.Regions["Region1"].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.UTD + -- Mesh +project.Mesher:Mesh() +project.Contents.Geometry["Cylinder1"]:UnlinkMesh() + -- Obtain the 'MeshCylindersCollection' +meshCylinders = project.Contents.Meshes["Cylinder1_1"].Cylinders + -- Obtain a specific region from the collection +meshCylinderRegion = meshCylinders["Region1"] +Inheritance +The MeshCylinderCollection object is derived from the Object object. +Usage locations +The MeshCylinderCollection object can be accessed from the following locations: +• Collection lists +◦ Mesh object has collection Cylinders. +Property List +Count +Label +Type +The number of MeshCylinder items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the MeshCylinder for the given index in the collection. (Returns a MeshCylinder object.) +Item (label string) +Returns the MeshCylinder for the given label in the collection. (Returns a MeshCylinder object.) +Items () +Returns a table of MeshCylinder items. (Returns a UnsupportedType(List of MeshCylinder) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of MeshCylinder items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the MeshCylinder for the given index in the collection. +Input Parameters +index(number) +The index of the MeshCylinder. +Return +MeshCylinder +The item in the collection +Item (label string) +Returns the MeshCylinder for the given label in the collection. +Input Parameters +label(string) +The label of the MeshCylinder. +Return +MeshCylinder +The item in the collection +Items () +Returns a table of MeshCylinder items. +Return +UnsupportedType(List of MeshCylinder) +The list of items in the collection +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.2512 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshPlateCollection +A collection of unmeshed plates that are part of a mesh model. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Set the frequency +p.2513 +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08" + -- Create geometry, set solution method to UTD +polygons = project.Contents.Geometry:AddRectangle(cf.Point(-0.25,-0.25,0), 0.5, 1.0) +polygons.Faces["Face1"].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.UTD + -- Mesh +project.Mesher:Mesh() +project.Contents.Geometry["Rectangle1"]:UnlinkMesh() + -- Obtain the 'MeshPlatesCollection' +meshPlates = project.Contents.Meshes["Rectangle1_1"].Plates + -- Obtain a specific face from the collection +meshPlate = meshPlates["Face1"] +Inheritance +The MeshPlateCollection object is derived from the Object object. +Usage locations +The MeshPlateCollection object can be accessed from the following locations: +• Collection lists +◦ Mesh object has collection Plates. +Property List +Count +Label +Type +The number of MeshPlate items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the MeshPlate for the given index in the collection. (Returns a MeshPlate object.) +Item (label string) +Returns the MeshPlate for the given label in the collection. (Returns a MeshPlate object.) +Items () +Returns a table of MeshPlate items. (Returns a UnsupportedType(List of MeshPlate) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of MeshPlate items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the MeshPlate for the given index in the collection. +Input Parameters +index(number) +The index of the MeshPlate. +Return +MeshPlate +The item in the collection +Item (label string) +Returns the MeshPlate for the given label in the collection. +Input Parameters +label(string) +The label of the MeshPlate. +Return +MeshPlate +The item in the collection +Items () +Returns a table of MeshPlate items. +Return +UnsupportedType(List of MeshPlate) +The list of items in the collection +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.2516 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshRefinementRuleCollection +A collection of MeshRefinementRules. +Example +p.2517 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example.cfx]]}) + -- Add an adaptive refinement rule +project.Contents.MeshRefinementRules:AddPointRefinement(cf.Point(0,0,0),0.01,0.01) + -- Obtain the 'MeshRefinementRulesCollection' +meshRefinementRules = project.Contents.MeshRefinementRules + -- Store the number of mesh refinement rules in the collection +meshRefinementRulesCount = meshRefinementRules.Count +Inheritance +The MeshRefinementRuleCollection object is derived from the Object object. +Usage locations +The MeshRefinementRuleCollection object can be accessed from the following locations: +• Collection lists +◦ ModelContents object has collection MeshRefinementRules. +Property List +Count +Label +Type +The number of MeshRefinementRule items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddAdaptiveRefinement (table table) +Create a adaptive mesh refinement rule from a table defining the properties. (Returns a +AdaptiveRefinement object.) +AddAdaptiveRefinement () +Create an adaptive mesh refinement rule. Prerequisites are a saved project with an error estimate +request and a *.bof and *.fek file. (Returns a AdaptiveRefinement object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the MeshRefinementRule for the given index in the collection. (Returns a +MeshRefinementRule object.) +Item (label string) +Returns the MeshRefinementRule for the given label in the collection. (Returns a +MeshRefinementRule object.) +Items () +Returns a table of MeshRefinementRule items. (Returns a UnsupportedType(List of +MeshRefinementRule) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of MeshRefinementRule items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read only +Method Details +AddAdaptiveRefinement (table table) +p.2519 +Create a adaptive mesh refinement rule from a table defining the properties. +Input Parameters +table(table) +A table of properties defining the new adaptive mesh refinement rule. +Return +AdaptiveRefinement +The adaptive refinement. +AddAdaptiveRefinement () +Create an adaptive mesh refinement rule. Prerequisites are a saved project with an error estimate +request and a *.bof and *.fek file. +Return +AdaptiveRefinement +The adaptive refinement. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the MeshRefinementRule for the given index in the collection. +Input Parameters +index(number) +The index of the MeshRefinementRule. +Return +MeshRefinementRule +The item in the collection +Item (label string) +Returns the MeshRefinementRule for the given label in the collection. +Input Parameters +label(string) +The label of the MeshRefinementRule. +Return +MeshRefinementRule +The item in the collection +Items () +Returns a table of MeshRefinementRule items. +Return +UnsupportedType(List of MeshRefinementRule) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MeshSegmentCurvilinearWireCollection +A collection of wires meshed with curvilinear segments. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Settings for curvilinear meshing +project.Contents.SolutionSettings.SolverSettings.GeneralSettings.BasisFunctionSettings.HOBFEnabled + = true +advancedMeshSettings = project.Mesher.Settings.Advanced +advancedMeshSettings.CurvilinearSegments + = cf.Enums.MeshCurvilinearOptionsEnum.Enabled +advancedMeshSettings.CurvilinearTriangles + = cf.Enums.MeshCurvilinearOptionsEnum.Disabled +frequency = project.Contents.SolutionConfigurations.GlobalFrequency +frequency.Start = "1e08" + -- Create geometry and mesh +project.Contents.Geometry:AddHelix(cf.Point(0,0,0), 0.1, 0.1, 1.0, 5.0, false) +project.Mesher.Settings.WireRadius = "0.01" +project.Mesher:Mesh() +project.Contents.Geometry["Helix1"]:UnlinkMesh() + -- Obtain a 'MeshCurvilinearSegmentWireCollection' +meshCurvilinearSegmentWires = project.Contents.Meshes["Helix1_1"].CurvilinearWires + -- Store the number of curvilinear wire segments +meshCurvilinearSegmentWiresCount = meshCurvilinearSegmentWires.Count +Inheritance +The MeshSegmentCurvilinearWireCollection object is derived from the Object object. +Usage locations +The MeshSegmentCurvilinearWireCollection object can be accessed from the following locations: +• Collection lists +◦ Mesh object has collection CurvilinearWires. +Property List +Count +Label +The number of MeshCurvilinearWire items in the collection. (Read only number) +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.2522 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the MeshCurvilinearWire for the given index in the collection. (Returns a +MeshCurvilinearWire object.) +Item (label string) +Returns the MeshCurvilinearWire for the given label in the collection. (Returns a +MeshCurvilinearWire object.) +Items () +Returns a table of MeshCurvilinearWire items. (Returns a UnsupportedType(List of +MeshCurvilinearWire) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of MeshCurvilinearWire items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the MeshCurvilinearWire for the given index in the collection. +Input Parameters +index(number) +The index of the MeshCurvilinearWire. +Return +MeshCurvilinearWire +The item in the collection +Item (label string) +Returns the MeshCurvilinearWire for the given label in the collection. +Input Parameters +label(string) +The label of the MeshCurvilinearWire. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +MeshCurvilinearWire +The item in the collection +Items () +Returns a table of MeshCurvilinearWire items. +Return +UnsupportedType(List of MeshCurvilinearWire) +The list of items in the collection +p.2524 +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MeshSegmentWireCollection +A collection of wires meshed with segments. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Settings for normal meshing +advancedMeshSettings = project.Mesher.Settings.Advanced +advancedMeshSettings.CurvilinearSegments + = cf.Enums.MeshCurvilinearOptionsEnum.Disabled +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08" + -- Create geometry and mesh +project.Contents.Geometry:AddHelix(cf.Point(0,0,0), 0.1, 0.1, 1.0, 5.0, false) +project.Mesher.Settings.WireRadius = "0.01" +project.Mesher:Mesh() +project.Contents.Geometry["Helix1"]:UnlinkMesh() + -- Obtain a handle to the 'MeshSegmentWireCollection' +meshSegmentWires = project.Contents.Meshes["Helix1_1"].Wires + -- Store the number of mesh segment wires +meshSegmentWiresCount = meshSegmentWires.Count +Inheritance +The MeshSegmentWireCollection object is derived from the Object object. +Usage locations +The MeshSegmentWireCollection object can be accessed from the following locations: +• Collection lists +◦ Mesh object has collection Wires. +Property List +Count +Label +Type +The number of MeshWire items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the MeshWire for the given index in the collection. (Returns a MeshWire object.) +Item (label string) +Returns the MeshWire for the given label in the collection. (Returns a MeshWire object.) +Items () +Returns a table of MeshWire items. (Returns a UnsupportedType(List of MeshWire) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of MeshWire items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the MeshWire for the given index in the collection. +Input Parameters +index(number) +The index of the MeshWire. +Return +MeshWire +The item in the collection +Item (label string) +Returns the MeshWire for the given label in the collection. +Input Parameters +label(string) +The label of the MeshWire. +Return +MeshWire +The item in the collection +Items () +Returns a table of MeshWire items. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +UnsupportedType(List of MeshWire) +The list of items in the collection +SetProperties (properties Object) +p.2528 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MeshSettingsCollection +A collection of mesh setting definitions. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Add two mesh setting definions +properties1 = cf.LocalMeshSettings.GetDefaultProperties() +properties1.Label = "LocalMeshSettings1" +localMeshSettings1 = project.Definitions.MeshSettings:Add(properties1) +localMeshSettings2 = + project.Definitions.MeshSettings:Add(cf.Enums.MeshSizeOptionEnum.Coarse) +-- Create a cuboid with its base corner at the specified 'Point' +corner = cf.Point(-0.25, -0.25, 0) +cube = project.Contents.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25) +-- Set local mesh settings on cuboid +cubeproperties = cube:GetProperties() +cubeproperties.LocalMeshSettingsEnabled = true +cubeproperties.MeshSettings = localMeshSettings1 +cube:SetProperties(cubeproperties) +Inheritance +The MeshSettingsCollection object is derived from the Object object. +Usage locations +The MeshSettingsCollection object can be accessed from the following locations: +• Collection lists +Property List +Count +Label +Type +The number of LocalMeshSettings items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Add a mesh setting definion with default values. (Returns a LocalMeshSettings object.) +Add (sizeoption MeshSizeOptionEnum) +Add a mesh setting definion with standard, coarse or fine mesh settings. (Returns a +LocalMeshSettings object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the LocalMeshSettings for the given index in the collection. (Returns a LocalMeshSettings +object.) +Item (label string) +Returns the LocalMeshSettings for the given label in the collection. (Returns a LocalMeshSettings +object.) +Items () +Returns a table of LocalMeshSettings items. (Returns a UnsupportedType(List of +LocalMeshSettings) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of LocalMeshSettings items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Add a mesh setting definion with default values. +Input Parameters +properties(table) +A table of properties defining the mesh settings. +Return +LocalMeshSettings +The mesh settings definition. +Add (sizeoption MeshSizeOptionEnum) +Add a mesh setting definion with standard, coarse or fine mesh settings. +Input Parameters +sizeoption(MeshSizeOptionEnum) +Mesh size option. +Return +LocalMeshSettings +The mesh settings definition. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the LocalMeshSettings for the given index in the collection. +Input Parameters +index(number) +The index of the LocalMeshSettings. +Return +LocalMeshSettings +The item in the collection +Item (label string) +Returns the LocalMeshSettings for the given label in the collection. +Input Parameters +label(string) +The label of the LocalMeshSettings. +Return +LocalMeshSettings +The item in the collection +Items () +Returns a table of LocalMeshSettings items. +Return +UnsupportedType(List of LocalMeshSettings) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshTetrahedronRegionCollection +A collection of regions meshed with tetrahedra. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Set the frequency +p.2533 +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08" + -- Create geometry, set the solution method and mesh. +cuboid = project.Contents.Geometry:AddCuboidAtCentre(cf.Point(0,0,0), 1.0, 1.0, 1.0) +dielectric = project.Definitions.Media.Dielectric:AddDielectric(0.01,0.01,0.01) +cuboid.Regions["Region1"].Medium = dielectric +cuboid.Regions["Region1"].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.FEM + -- Mesh +project.Mesher:Mesh() +project.Contents.Geometry["Cuboid1"]:UnlinkMesh() + -- Obtain the 'TetrahedronRegionCollection' +tetrahedronRegions = project.Contents.Meshes["Cuboid1_1"].Regions + -- Store the number of tetragon regions in the collection +tetrahedronRegionsCount = tetrahedronRegions.Count +Inheritance +The MeshTetrahedronRegionCollection object is derived from the Object object. +Usage locations +The MeshTetrahedronRegionCollection object can be accessed from the following locations: +• Collection lists +Property List +Count +Label +Type +The number of MeshRegion items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the MeshRegion for the given index in the collection. (Returns a MeshRegion object.) +Item (label string) +Returns the MeshRegion for the given label in the collection. (Returns a MeshRegion object.) +Items () +Returns a table of MeshRegion items. (Returns a UnsupportedType(List of MeshRegion) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of MeshRegion items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the MeshRegion for the given index in the collection. +Input Parameters +index(number) +The index of the MeshRegion. +Return +MeshRegion +The item in the collection +Item (label string) +Returns the MeshRegion for the given label in the collection. +Input Parameters +label(string) +The label of the MeshRegion. +Return +MeshRegion +The item in the collection +Items () +Returns a table of MeshRegion items. +Return +UnsupportedType(List of MeshRegion) +The list of items in the collection +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.2536 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MeshTriangleFaceCollection +A collection of faces meshed with triangles. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Set the frequency +project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e06" + -- Create geometry and mesh +project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1.0) +project.Mesher:Mesh() +project.Contents.Geometry["Sphere1"]:UnlinkMesh() + -- Obtain the 'MeshTriangleFaceCollection' +meshTriangleFaces = project.Contents.Meshes["Sphere1_1"].Faces + -- Retrieve a specific face from the collection. +face = meshTriangleFaces["Face1"] +Inheritance +The MeshTriangleFaceCollection object is derived from the Object object. +Usage locations +The MeshTriangleFaceCollection object can be accessed from the following locations: +• Collection lists +◦ Mesh object has collection Faces. +Property List +Count +Label +Type +The number of MeshTriangleFace items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2538 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the MeshTriangleFace for the given index in the collection. (Returns a MeshTriangleFace +object.) +Item (label string) +Returns the MeshTriangleFace for the given label in the collection. (Returns a MeshTriangleFace +object.) +Items () +Returns a table of MeshTriangleFace items. (Returns a UnsupportedType(List of MeshTriangleFace) +object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of MeshTriangleFace items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the MeshTriangleFace for the given index in the collection. +Input Parameters +index(number) +The index of the MeshTriangleFace. +Return +MeshTriangleFace +The item in the collection +Item (label string) +Returns the MeshTriangleFace for the given label in the collection. +Input Parameters +label(string) +The label of the MeshTriangleFace. +Return +MeshTriangleFace +The item in the collection +Items () +Returns a table of MeshTriangleFace items. +Return +UnsupportedType(List of MeshTriangleFace) +The list of items in the collection +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties Object) +p.2540 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +MetalCollection +A collection of metallic media. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create metallic media +metal = project.Definitions.Media.Metallic:AddMetal() +Inheritance +The MetalCollection object is derived from the Object object. +Usage locations +The MetalCollection object can be accessed from the following locations: +• Collection lists +◦ Media object has collection Metallic. +Property List +Count +Label +Type +The number of Metal items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddMetal (properties table) +Create a dielectric medium. (Returns a Metal object.) +AddMetal (relativepermeability Expression, losstangent Expression, conductivity Expression) +Creates a new metallic medium. (Returns a Metal object.) +AddMetal () +Creates a new metallic medium. (Returns a Metal object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Metal for the given index in the collection. (Returns a Metal object.) +Item (label string) +Returns the Metal for the given label in the collection. (Returns a Metal object.) +Items () +Returns a table of Metal items. (Returns a UnsupportedType(List of Metal) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Metal items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddMetal (properties table) +Create a dielectric medium. +Input Parameters +properties(table) +A table of properties defining the new windscreen medium. +Return +Metal +The metallic medium. +AddMetal (relativepermeability Expression, losstangent Expression, conductivity Expression) +Creates a new metallic medium. +Input Parameters +relativepermeability(Expression) +The frequency independent relative permeability. +losstangent(Expression) +The frequency independent magnetic loss tangent. +conductivity(Expression) +The frequency independent conductivity (S/m). +Return +Metal +The metallic medium. +AddMetal () +Creates a new metallic medium. +Return +Metal +The metallic medium. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Metal for the given index in the collection. +Input Parameters +index(number) +The index of the Metal. +Return +Metal +The item in the collection +Item (label string) +Returns the Metal for the given label in the collection. +Input Parameters +label(string) +The label of the Metal. +Return +Metal +The item in the collection +Items () +Returns a table of Metal items. +Return +UnsupportedType(List of Metal) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ModelDecompositionCollection +A collection of solution model decomposition for this solution configuration. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a model decomposition request to the model decomposition collection +modelDecompositionCollection = + project.Contents.SolutionConfigurations[1].ModelDecompositions +modelDecompositionRequest = modelDecompositionCollection:Add() + -- Remove the model decomposition request from the model decomposition collection +modelDecompositionCollection:Item(modelDecompositionRequest.Label):Delete() +Inheritance +The ModelDecompositionCollection object is derived from the Object object. +Usage locations +The ModelDecompositionCollection object can be accessed from the following locations: +• Collection lists +◦ StandardConfiguration object has collection ModelDecompositions. +Property List +Count +Label +Type +The number of ModelDecomposition items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Create a model decomposition calculation using the table of properties. (Returns a +ModelDecomposition object.) +Add () +Request a model decomposition calculation. (Returns a ModelDecomposition object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2546 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the ModelDecomposition for the given index in the collection. (Returns a +ModelDecomposition object.) +Item (label string) +Returns the ModelDecomposition for the given label in the collection. (Returns a +ModelDecomposition object.) +Items () +Returns a table of ModelDecomposition items. (Returns a UnsupportedType(List of +ModelDecomposition) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of ModelDecomposition items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Create a model decomposition calculation using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +ModelDecomposition +The model decomposition request. +Add () +Request a model decomposition calculation. +Return +ModelDecomposition +The model decomposition request. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the ModelDecomposition for the given index in the collection. +Input Parameters +index(number) +The index of the ModelDecomposition. +Return +ModelDecomposition +The item in the collection +Item (label string) +Returns the ModelDecomposition for the given label in the collection. +Input Parameters +label(string) +The label of the ModelDecomposition. +Return +ModelDecomposition +The item in the collection +Items () +Returns a table of ModelDecomposition items. +Return +UnsupportedType(List of ModelDecomposition) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +NamedPointCollection +A collection of named points in the model. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create various named points +project.Definitions.NamedPoints:Add("pt1", 1.2, 1.4, 0.6) +project.Definitions.NamedPoints:Add("pt2", 0.2, 2.4, 0.1) +project.Definitions.NamedPoints:Add("pt3", -1.2, 2.5, 1.0) + -- Set the Z value of "pt1" for all the named points +for key,point in pairs(project.Definitions.NamedPoints) do + point.Point.N = project.Definitions.NamedPoints["pt1"].Point.N +end +Inheritance +The NamedPointCollection object is derived from the Object object. +Usage locations +The NamedPointCollection object can be accessed from the following locations: +• Collection lists +◦ ModelDefinitions object has collection NamedPoints. +Property List +Count +Label +Type +The number of NamedPoint items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (name string, x Expression, y Expression, z Expression) +Create a named point from the given coordinate expressions. (Returns a NamedPoint object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2550 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the NamedPoint for the given index in the collection. (Returns a NamedPoint object.) +Item (label string) +Returns the NamedPoint for the given label in the collection. (Returns a NamedPoint object.) +Items () +Returns a table of NamedPoint items. (Returns a UnsupportedType(List of NamedPoint) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of NamedPoint items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (name string, x Expression, y Expression, z Expression) +Create a named point from the given coordinate expressions. +Input Parameters +name(string) +The point name. +x(Expression) +The X coordinate expression. +y(Expression) +The Y coordinate expression. +z(Expression) +The Z coordinate expression. +Return +NamedPoint +The named point. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the NamedPoint for the given index in the collection. +Input Parameters +index(number) +The index of the NamedPoint. +Return +NamedPoint +The item in the collection +Item (label string) +Returns the NamedPoint for the given label in the collection. +Input Parameters +label(string) +The label of the NamedPoint. +Return +NamedPoint +The item in the collection +Items () +Returns a table of NamedPoint items. +Return +UnsupportedType(List of NamedPoint) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldCollection +A collection of solution near fields for this solution configuration. +Example +p.2553 +application = cf.Application.GetInstance() project = application:NewProject() + -- Add a near field request to the near field collection +configuration = project.Contents.SolutionConfigurations[1] +nearFieldCollection = configuration.NearFields +nearFieldRequest = nearFieldCollection:AddCartesian(0,0,0,1,1,1,3,3,3) + -- Remove the near field request from the near field collection +nearFieldCollection:Item(nearFieldRequest.Label):Delete() +Inheritance +The NearFieldCollection object is derived from the Object object. +Usage locations +The NearFieldCollection object can be accessed from the following locations: +• Collection lists +◦ CharacteristicModesConfiguration object has collection NearFields. +◦ StandardConfiguration object has collection NearFields. +Property List +Count +Label +Type +The number of NearField items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Create a near field using the table of properties. (Returns a NearField object.) +AddCartesian (startx Expression, starty Expression, startz Expression, endx Expression, endy +Expression, endz Expression, numx Expression, numy Expression, numz Expression) +Create a near field calculation request using the Cartesian coordinate system. (Returns a +NearField object.) +AddCartesianBoundary (startx Expression, starty Expression, startz Expression, endx Expression, endy +Expression, endz Expression, numx Expression, numy Expression, numz Expression) +Create a near field calculation request using the Cartesian boundary definition method. (Returns a +NearField object.) +AddConical (startrho Expression, startphi Expression, startz Expression, endrho Expression, endphi +Expression, endz Expression, numphi Expression, numz Expression) +Create a near field calculation request using the conical coordinate system. (Returns a NearField +object.) +AddCylindrical (startrho Expression, startphi Expression, startz Expression, endrho Expression, endphi +Expression, endz Expression, numrho Expression, numphi Expression, numz Expression) +Create a near field calculation request using the cylindrical coordinate system. (Returns a +NearField object.) +AddCylindricalX (startrho Expression, startphi Expression, startx Expression, endrho Expression, endphi +Expression, endx Expression, numrho Expression, numphi Expression, numx Expression) +Create a near field calculation request using the cylindrical (X axis) coordinate system. (Returns a +NearField object.) +AddCylindricalY (startrho Expression, startphi Expression, starty Expression, endrho Expression, endphi +Expression, endy Expression, numrho Expression, numphi Expression, numy Expression) +Create a near field calculation request using the cylindrical (Y axis) coordinate system. (Returns a +NearField object.) +AddSpecifiedPoints (points List of Point) +Create a near field calculation request using specified points. (Returns a NearField object.) +AddSpherical (startradius Expression, starttheta Expression, startphi Expression, endradius Expression, +endtheta Expression, endphi Expression, numradius Expression, numtheta Expression, numphi +Expression) +Create a near field calculation request using the spherical coordinate system. (Returns a NearField +object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the NearField for the given index in the collection. (Returns a NearField object.) +Item (label string) +Returns the NearField for the given label in the collection. (Returns a NearField object.) +Items () +Returns a table of NearField items. (Returns a UnsupportedType(List of NearField) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of NearField items in the collection. +p.2555 +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Create a near field using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +NearField +The near field. +AddCartesian (startx Expression, starty Expression, startz Expression, endx Expression, endy +Expression, endz Expression, numx Expression, numy Expression, numz Expression) +Create a near field calculation request using the Cartesian coordinate system. +Input Parameters +startx(Expression) +The X axis start point. +starty(Expression) +The Y axis start point. +startz(Expression) +The Z axis start point. +endx(Expression) +The X axis end point. +endy(Expression) +The Y axis end point. +endz(Expression) +The Z axis end point. +numx(Expression) +The X axis number of points. +numy(Expression) +The Y axis number of points. +numz(Expression) +The Z axis number of points. +Return +NearField +The near field. +AddCartesianBoundary (startx Expression, starty Expression, startz Expression, endx Expression, endy +Expression, endz Expression, numx Expression, numy Expression, numz Expression) +Create a near field calculation request using the Cartesian boundary definition method. +Input Parameters +startx(Expression) +The X axis number of points. +starty(Expression) +The Y axis number of points. +startz(Expression) +The Z axis number of points. +endx(Expression) +The X axis end point. +endy(Expression) +The Y axis end point. +endz(Expression) +The Z axis end point. +numx(Expression) +The X axis number of points. +numy(Expression) +The Y axis number of points. +numz(Expression) +The Z axis number of points. +Return +NearField +The near field. +AddConical (startrho Expression, startphi Expression, startz Expression, endrho Expression, endphi +Expression, endz Expression, numphi Expression, numz Expression) +Create a near field calculation request using the conical coordinate system. +Input Parameters +startrho(Expression) +The Rho axis start point. +startphi(Expression) +The Phi axis start point (degrees). +startz(Expression) +The Z axis start point. +endrho(Expression) +The Rho axis end point. +endphi(Expression) +The Phi axis end point (degrees). +endz(Expression) +The Z axis end point. +numphi(Expression) +The Phi axis number of points. +numz(Expression) +The Z axis number of points. +Return +NearField +The near field. +AddCylindrical (startrho Expression, startphi Expression, startz Expression, endrho Expression, +endphi Expression, endz Expression, numrho Expression, numphi Expression, numz Expression) +Create a near field calculation request using the cylindrical coordinate system. +Input Parameters +startrho(Expression) +The Rho axis start point. +startphi(Expression) +The Phi axis start point (degrees). +startz(Expression) +The Z axis start point. +endrho(Expression) +The Rho axis end point. +endphi(Expression) +The Phi axis end point (degrees). +endz(Expression) +The Z axis end point. +numrho(Expression) +The Rho axis number of points. +numphi(Expression) +The Phi axis number of points. +numz(Expression) +The Z axis number of points. +Return +NearField +The near field. +AddCylindricalX (startrho Expression, startphi Expression, startx Expression, endrho Expression, +endphi Expression, endx Expression, numrho Expression, numphi Expression, numx Expression) +Create a near field calculation request using the cylindrical (X axis) coordinate system. +Input Parameters +startrho(Expression) +The Rho axis start point. +startphi(Expression) +The Phi axis start point (degrees). +startx(Expression) +The X axis start point. +endrho(Expression) +The Rho axis end point. +endphi(Expression) +The Phi axis end point (degrees). +endx(Expression) +The X axis end point. +numrho(Expression) +The Rho axis number of points. +numphi(Expression) +The Phi axis number of points. +numx(Expression) +The X axis number of points. +Return +NearField +The near field. +AddCylindricalY (startrho Expression, startphi Expression, starty Expression, endrho Expression, +endphi Expression, endy Expression, numrho Expression, numphi Expression, numy Expression) +Create a near field calculation request using the cylindrical (Y axis) coordinate system. +Input Parameters +startrho(Expression) +The Rho axis start point. +startphi(Expression) +The Phi axis start point (degrees). +starty(Expression) +The Y axis start point. +endrho(Expression) +The Rho axis end point. +endphi(Expression) +The Phi axis end point (degrees). +endy(Expression) +The Y axis end point. +numrho(Expression) +The Rho axis number of points. +numphi(Expression) +The Phi axis number of points. +numy(Expression) +The Y axis number of points. +Return +NearField +The near field. +AddSpecifiedPoints (points List of Point) +Create a near field calculation request using specified points. +Input Parameters +points(List of Point) +The table of specified points. +Return +NearField +The near field. +AddSpherical (startradius Expression, starttheta Expression, startphi Expression, endradius +Expression, endtheta Expression, endphi Expression, numradius Expression, numtheta Expression, +numphi Expression) +Create a near field calculation request using the spherical coordinate system. +Input Parameters +startradius(Expression) +The radius start point. +starttheta(Expression) +The Theta axis start point (degrees). +startphi(Expression) +The Phi axis start point (degrees). +endradius(Expression) +The radius end point. +endtheta(Expression) +The Theta axis end point (degrees). +endphi(Expression) +The Phi axis end point (degrees). +numradius(Expression) +The radius number of points. +numtheta(Expression) +The Theta axis number of points. +numphi(Expression) +The Phi axis number of points. +Return +NearField +The near field. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2561 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the NearField for the given index in the collection. +Input Parameters +index(number) +The index of the NearField. +Return +NearField +The item in the collection +Item (label string) +Returns the NearField for the given label in the collection. +Input Parameters +label(string) +The label of the NearField. +Return +NearField +The item in the collection +Items () +Returns a table of NearField items. +Return +UnsupportedType(List of NearField) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +NearFieldReceivingAntennaCollection +A collection of solution receiving antennas. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +standardConfiguration = + project.Contents.SolutionConfigurations['StandardConfiguration1'] + -- Get the 'NearFieldReceivingAntennaCollections' +nearFieldReceivingAntennaCollection = + standardConfiguration.NearFieldReceivingAntennas + -- Get the number of 'NearFieldReceivingAntenna' in the collection +numberOfNearFieldRxAntennas = #nearFieldReceivingAntennaCollection +Inheritance +The NearFieldReceivingAntennaCollection object is derived from the Object object. +Usage locations +The NearFieldReceivingAntennaCollection object can be accessed from the following locations: +• Collection lists +◦ StandardConfiguration object has collection NearFieldReceivingAntennas. +Property List +Count +Label +Type +The number of NearFieldReceivingAntenna items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Create a near field receiving antenna request using the table of properties. (Returns a +NearFieldReceivingAntenna object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2564 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the NearFieldReceivingAntenna for the given index in the collection. (Returns a +NearFieldReceivingAntenna object.) +Item (label string) +Returns the NearFieldReceivingAntenna for the given label in the collection. (Returns a +NearFieldReceivingAntenna object.) +Items () +Returns a table of NearFieldReceivingAntenna items. (Returns a UnsupportedType(List of +NearFieldReceivingAntenna) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of NearFieldReceivingAntenna items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Create a near field receiving antenna request using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +NearFieldReceivingAntenna +The near field receiving antenna request. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the NearFieldReceivingAntenna for the given index in the collection. +Input Parameters +index(number) +The index of the NearFieldReceivingAntenna. +Return +NearFieldReceivingAntenna +The item in the collection +Item (label string) +Returns the NearFieldReceivingAntenna for the given label in the collection. +Input Parameters +label(string) +The label of the NearFieldReceivingAntenna. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +NearFieldReceivingAntenna +The item in the collection +Items () +Returns a table of NearFieldReceivingAntenna items. +Return +UnsupportedType(List of NearFieldReceivingAntenna) +The list of items in the collection +p.2566 +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +NetCollection +The collection on nets on a schematic. +Example +p.2567 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) + -- Create the schematic view +harness = project.Contents.CableHarnesses[1] +schematicView = application.MainWindow.MdiArea:CreateCableSchematicView(harness) + -- Add some nets +net1 = harness.CableSchematic.Nets:AddNet({-8, -1}, {-8, 13}) +net2 = harness.CableSchematic.Nets:AddNet({-8, 13}, {-7, 13}) +Inheritance +The NetCollection object is derived from the Object object. +Usage locations +The NetCollection object can be accessed from the following locations: +• Collection lists +◦ Schematic object has collection Nets. +Property List +Count +Label +Type +The number of Net items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddNet (start GridLocation, end GridLocation) +Adds a net between the given locations. (Returns a Net object.) +AddNet (start Terminal, end Terminal) +Adds a net between the specified terminals. (Returns a Net object.) +AddNet (path List of GridLocation) +Adds a net along the given path. (Returns a Net object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2568 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Net for the given index in the collection. (Returns a Net object.) +Item (label string) +Returns the Net for the given label in the collection. (Returns a Net object.) +Items () +Returns a table of Net items. (Returns a UnsupportedType(List of Net) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Net items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddNet (start GridLocation, end GridLocation) +Adds a net between the given locations. +Input Parameters +start(GridLocation) +The start location. +end(GridLocation) +The end location. +Return +Net +The new net. +AddNet (start Terminal, end Terminal) +Adds a net between the specified terminals. +Input Parameters +start(Terminal) +The start location of the net. +end(Terminal) +The end location of the net. +Return +Net +The new net between the terminals. +AddNet (path List of GridLocation) +Adds a net along the given path. +Input Parameters +path(List of GridLocation) +A list of grid locations. +Return +Net +The new net. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2570 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Net for the given index in the collection. +Input Parameters +index(number) +The index of the Net. +Return +Net +The item in the collection +Item (label string) +Returns the Net for the given label in the collection. +Input Parameters +label(string) +The label of the Net. +Return +Net +The item in the collection +Items () +Returns a table of Net items. +Return +UnsupportedType(List of Net) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +NetworkCollection +A collection of non-radiating networks. +Example +application =cf.Application.GetInstance() +project = application:NewProject() + -- Use the network collection to add a transmission line +networkCollection = project.Contents.SolutionConfigurations.GlobalNetworks +networkCollection:AddTransmissionLine(10, 50, 25, 10) +Inheritance +The NetworkCollection object is derived from the Object object. +Usage locations +The NetworkCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfigurationCollection collection has collection GlobalNetworks. +Property List +Count +Label +Type +The number of Network items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddGeneralNetwork (properties table) +Create a general network from a table defining the properties. (Returns a GeneralNetwork object.) +AddGeneralNetwork (type GeneralNetworkDataTypeEnum, terminalcount number, filename string) +Create a general network from data stored in either a Touchstone or SPICE circuit file. (Returns a +GeneralNetwork object.) +AddTransmissionLine (properties table) +Create a transmission line from a table defining the properties. (Returns a TransmissionLine +object.) +AddTransmissionLine (linelength Expression, real Expression, imaginary Expression, attenuation +Expression) +Create a transmission line with Z0, length and attenuation specified. This will set the +DefinitionMethod to ?SpecifiedAttenuation?. (Returns a TransmissionLine object.) +AddTransmissionLine (linelength Expression, real Expression, imaginary Expression, medium Dielectric) +Create a transmission line with Z0, length and medium specified. This will set the +DefinitionMethod to ?MediumAttenuation?. (Returns a TransmissionLine object.) +AddTransmissionLine (linelength Expression, real Expression, imaginary Expression, attenuation +Expression, velocity Expression) +Create a transmission line with Z0, length, attenuation and VOP specified. This will set the +DefinitionMethod to ?VelocityOfPropagation?. (Returns a TransmissionLine object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Network for the given index in the collection. (Returns a Network object.) +Item (label string) +Returns the Network for the given label in the collection. (Returns a Network object.) +Items () +Returns a table of Network items. (Returns a UnsupportedType(List of Network) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Network items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddGeneralNetwork (properties table) +Create a general network from a table defining the properties. +Input Parameters +properties (table) +A table of properties defining the new general network. +Return +GeneralNetwork +The general network. +AddGeneralNetwork (type GeneralNetworkDataTypeEnum, terminalcount number, filename string) +Create a general network from data stored in either a Touchstone or SPICE circuit file. +Input Parameters +type(GeneralNetworkDataTypeEnum) +The network data type. +terminalcount(number) +The number of network terminals. +filename(string) +The Touchstone or SPICE circuit filename. +Return +GeneralNetwork +The general network. +AddTransmissionLine (properties table) +Create a transmission line from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new transmission line. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +TransmissionLine +The transmission line. +p.2575 +AddTransmissionLine (linelength Expression, real Expression, imaginary Expression, attenuation +Expression) +Create a transmission line with Z0, length and attenuation specified. This will set the +DefinitionMethod to ?SpecifiedAttenuation?. +Input Parameters +linelength(Expression) +The transmission line length. +real(Expression) +The transmission line real impedance (Ohm). +imaginary(Expression) +The transmission line imaginary impedance (Ohm). +attenuation(Expression) +The transmission attenuation (dB/m). +Return +TransmissionLine +The transmission line. +AddTransmissionLine (linelength Expression, real Expression, imaginary Expression, medium +Dielectric) +Create a transmission line with Z0, length and medium specified. This will set the +DefinitionMethod to ?MediumAttenuation?. +Input Parameters +linelength(Expression) +The transmission line length. +real(Expression) +The transmission line real impedance (Ohm). +imaginary(Expression) +The transmission line imaginary impedance (Ohm). +medium(Dielectric) +The transmission Medium. +Return +TransmissionLine +The transmission line. +AddTransmissionLine (linelength Expression, real Expression, imaginary Expression, attenuation +Expression, velocity Expression) +Create a transmission line with Z0, length, attenuation and VOP specified. This will set the +DefinitionMethod to ?VelocityOfPropagation?. +Input Parameters +linelength(Expression) +The transmission line length. +real(Expression) +The transmission line real impedance (Ohm). +imaginary(Expression) +The transmission line imaginary impedance (Ohm). +attenuation(Expression) +The transmission attenuation (dB/m). +velocity(Expression) +The transmission velocity of propagation [0-100%]. +Return +TransmissionLine +The transmission line. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Network for the given index in the collection. +Input Parameters +index(number) +The index of the Network. +Return +Network +The item in the collection +Item (label string) +Returns the Network for the given label in the collection. +Input Parameters +label(string) +The label of the Network. +Return +Network +The item in the collection +Items () +Returns a table of Network items. +Return +UnsupportedType(List of Network) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +OperatorCollection +A collection of geometry operators. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create various geometry objects +project.Contents.Geometry:AddCuboid(cf.Point(1,0,0),1,1,1) +project.Contents.Geometry:AddLine(cf.Point(0,0,0),cf.Point(1,1,1)) +project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1) +project.Contents.Geometry:Union({project.Contents.Geometry[1], + project.Contents.Geometry[2]}) + -- Lock all the geometry +for value,geometry in pairs(project.Contents.Geometry) do + geometry.Locked = true +end +Inheritance +The OperatorCollection object is derived from the Object object. +The following objects are derived (specialisations) from the OperatorCollection object: +• GeometryCollection +Usage locations +The OperatorCollection object can be accessed from the following locations: +• Collection lists +◦ +◦ +ImprintPoints object has collection Children. +Intersect object has collection Children. +◦ Loft object has collection Children. +◦ PathSweep object has collection Children. +◦ ProjectGeometry object has collection Children. +◦ RepairAndSewFaces object has collection Children. +◦ RepairPart object has collection Children. +◦ Spin object has collection Children. +◦ Split object has collection Children. +◦ Stitch object has collection Children. +◦ Subtract object has collection Children. +◦ Sweep object has collection Children. +◦ Union object has collection Children. +◦ Simplify object has collection Children. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property List +Count +Label +Type +The number of Geometry items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +p.2579 +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Geometry for the given index in the collection. (Returns a Geometry object.) +Item (label string) +Returns the Geometry for the given label in the collection. (Returns a Geometry object.) +Items () +Returns a table of Geometry items. (Returns a UnsupportedType(List of Geometry) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Geometry items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Geometry for the given index in the collection. +Input Parameters +index(number) +The index of the Geometry. +Return +Geometry +The item in the collection +Item (label string) +Returns the Geometry for the given label in the collection. +Input Parameters +label(string) +The label of the Geometry. +Return +Geometry +The item in the collection +Items () +Returns a table of Geometry items. +Return +UnsupportedType(List of Geometry) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +OptimisationGoalCollection +A collection of optimisation operators. +Example +p.2582 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Optimisation.cfx]]}) + -- Check if the optimisation goal collection contains one with the label + "FarFieldGoal1" +containsGoal = + project.Optimisation.Searches["Search1"].Goals:Contains("FarFieldGoal1") +Inheritance +The OptimisationGoalCollection object is derived from the Object object. +Usage locations +The OptimisationGoalCollection object can be accessed from the following locations: +• Collection lists +◦ OptimisationCombination object has collection Goals. +◦ OptimisationSearch object has collection Goals. +Property List +Count +Label +Type +The number of OptimisationOperator items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddCombinedGoal (properties table) +Create a combined optimisation goal. (Returns a OptimisationCombination object.) +AddCombinedGoal (properties table, goals List of OptimisationOperator) +Create a combined optimisation goal. (Returns a OptimisationCombination object.) +AddFarFieldGoal (properties table) +Create a far field optimisation goal. (Returns a FarFieldOptimisationGoal object.) +AddImpedanceGoal (properties table) +Create an impedance optimisation goal. (Returns a ImpedanceOptimisationGoal object.) +AddNearFieldGoal (properties table) +Create a near field optimisation goal. (Returns a NearFieldOptimisationGoal object.) +AddPowerGoal (properties table) +Create a power optimisation goal. (Returns a PowerOptimisationGoal object.) +AddReceivingAntennaGoal (properties table) +Create a receiving antenna optimisation goal. (Returns a ReceivingAntennaOptimisationGoal +object.) +AddSARGoal (properties table) +Create a SAR optimisation goal. (Returns a SAROptimisationGoal object.) +AddSParameterGoal (properties table) +Create an S-parameter optimisation goal. (Returns a SParameterOptimisationGoal object.) +AddTransmissionReflectionGoal (properties table) +Create a transmission line optimisation goal. (Returns a TransmissionReflectionOptimisationGoal +object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the OptimisationOperator for the given index in the collection. (Returns a +OptimisationOperator object.) +Item (label string) +Returns the OptimisationOperator for the given label in the collection. (Returns a +OptimisationOperator object.) +Items () +Returns a table of OptimisationOperator items. (Returns a UnsupportedType(List of +OptimisationOperator) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of OptimisationOperator items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddCombinedGoal (properties table) +Create a combined optimisation goal. +Input Parameters +properties(table) +A table of properties defining the combined optimisation goal. +Return +OptimisationCombination +Returns a OptimisationCombination object. +AddCombinedGoal (properties table, goals List of OptimisationOperator) +Create a combined optimisation goal. +Input Parameters +properties(table) +A table of properties defining the combined optimisation goal. +goals(List of OptimisationOperator) +List of OptimisationOperator. +Return +OptimisationCombination +Returns a OptimisationCombination object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +AddFarFieldGoal (properties table) +Create a far field optimisation goal. +Input Parameters +properties(table) +A table of properties defining the far field optimisation goal. +p.2585 +Return +FarFieldOptimisationGoal +A far field optimisation goal. +AddImpedanceGoal (properties table) +Create an impedance optimisation goal. +Input Parameters +properties(table) +A table of properties defining the impedance optimisation goal. +Return +ImpedanceOptimisationGoal +An impedance optimisation goal. +AddNearFieldGoal (properties table) +Create a near field optimisation goal. +Input Parameters +properties(table) +A table of properties defining the near field optimisation goal. +Return +NearFieldOptimisationGoal +A near field optimisation goal. +AddPowerGoal (properties table) +Create a power optimisation goal. +Input Parameters +properties(table) +A table of properties defining the power optimisation goal. +Return +PowerOptimisationGoal +A power optimisation goal. +AddReceivingAntennaGoal (properties table) +Create a receiving antenna optimisation goal. +Input Parameters +properties(table) +A table of properties defining the receiving antenna optimisation goal. +Return +ReceivingAntennaOptimisationGoal +A receiving antenna optimisation goal. +AddSARGoal (properties table) +Create a SAR optimisation goal. +Input Parameters +properties(table) +A table of properties defining the SAR optimisation goal. +Return +SAROptimisationGoal +A SAR optimisation goal. +AddSParameterGoal (properties table) +Create an S-parameter optimisation goal. +Input Parameters +properties(table) +A table of properties defining the S-parameter optimisation goal. +Return +SParameterOptimisationGoal +An S-parameter optimisation goal. +AddTransmissionReflectionGoal (properties table) +Create a transmission line optimisation goal. +Input Parameters +properties(table) +A table of properties defining the transmission line optimisation goal. +Return +TransmissionReflectionOptimisationGoal +A transmission line optimisation goal. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.2587 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the OptimisationOperator for the given index in the collection. +Input Parameters +index(number) +The index of the OptimisationOperator. +Return +OptimisationOperator +The item in the collection +Item (label string) +Returns the OptimisationOperator for the given label in the collection. +Input Parameters +label(string) +The label of the OptimisationOperator. +Return +OptimisationOperator +The item in the collection +Items () +Returns a table of OptimisationOperator items. +Return +UnsupportedType(List of OptimisationOperator) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.2588 +OptimisationMaskCollection +A collection of optimisation masks. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add an optimisation mask for the given list of values +xValues = {0, 1, 2, 3, 4} +yValues = {0, 10, 20, 20, 30} +project.Optimisation.Masks:Add(xValues, yValues) + -- Check if the collection of masks contains one labelled "Mask1" +hasMask = project.Optimisation.Masks:Contains("Mask1") +Inheritance +The OptimisationMaskCollection object is derived from the Object object. +Usage locations +The OptimisationMaskCollection object can be accessed from the following locations: +• Collection lists +◦ Optimisation object has collection Masks. +Property List +Count +Label +Type +The number of OptimisationMask items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Create an optimisation mask. (Returns a OptimisationMask object.) +Add (xvaluelist ExpressionList, yvaluelist ExpressionList) +Create an optimisation mask. (Returns a OptimisationMask object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2590 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the OptimisationMask for the given index in the collection. (Returns a OptimisationMask +object.) +Item (label string) +Returns the OptimisationMask for the given label in the collection. (Returns a OptimisationMask +object.) +Items () +Returns a table of OptimisationMask items. (Returns a UnsupportedType(List of OptimisationMask) +object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of OptimisationMask items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Create an optimisation mask. +Input Parameters +properties(table) +A table of properties defining the optimisation mask. +Return +OptimisationMask +An optimisation mask. +Add (xvaluelist ExpressionList, yvaluelist ExpressionList) +Create an optimisation mask. +Input Parameters +xvaluelist(ExpressionList) +The x values of the mask. +yvaluelist(ExpressionList) +The x values of the mask. +Return +OptimisationMask +An optimisation mask. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the OptimisationMask for the given index in the collection. +Input Parameters +index(number) +The index of the OptimisationMask. +Return +OptimisationMask +The item in the collection +Item (label string) +Returns the OptimisationMask for the given label in the collection. +Input Parameters +label(string) +The label of the OptimisationMask. +Return +OptimisationMask +The item in the collection +Items () +Returns a table of OptimisationMask items. +Return +UnsupportedType(List of OptimisationMask) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +OptimisationSearchCollection +A collection of optimisation searches. +Example +p.2593 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add an optimisation using the grid search algorithm +project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch) + -- Check if the collection of searches contains one labelled "Search1" +containsSearch = project.Optimisation.Searches:Contains("Search1") +Inheritance +The OptimisationSearchCollection object is derived from the Object object. +Usage locations +The OptimisationSearchCollection object can be accessed from the following locations: +• Collection lists +◦ Optimisation object has collection Searches. +Property List +Count +Label +Type +The number of OptimisationSearch items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (table table) +Create an optimisation search. (Returns a OptimisationSearch object.) +Add (method OptimisationMethodTypeEnum) +Create an optimisation search as specified by the optimisation method. (Returns a +OptimisationSearch object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2594 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the OptimisationSearch for the given index in the collection. (Returns a +OptimisationSearch object.) +Item (label string) +Returns the OptimisationSearch for the given label in the collection. (Returns a +OptimisationSearch object.) +Items () +Returns a table of OptimisationSearch items. (Returns a UnsupportedType(List of +OptimisationSearch) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of OptimisationSearch items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (table table) +Create an optimisation search. +Input Parameters +table(table) +A table of properties defining the optimisation search. +Return +OptimisationSearch +An optimisation search. +Add (method OptimisationMethodTypeEnum) +Create an optimisation search as specified by the optimisation method. +Input Parameters +method(OptimisationMethodTypeEnum) +Optimisation method. +Return +OptimisationSearch +An optimisation search. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the OptimisationSearch for the given index in the collection. +Input Parameters +index(number) +The index of the OptimisationSearch. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +OptimisationSearch +The item in the collection +Item (label string) +Returns the OptimisationSearch for the given label in the collection. +p.2596 +Input Parameters +label(string) +The label of the OptimisationSearch. +Return +OptimisationSearch +The item in the collection +Items () +Returns a table of OptimisationSearch items. +Return +UnsupportedType(List of OptimisationSearch) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +PortCollection +A collection of ports. +Example +local application = cf.Application.GetInstance() +local project = application:NewProject() + -- Construct a port and add it to the collection +line = project.Contents.Geometry:AddLine(cf.Point(0, 0, 0), cf.Point(1, 1, 1)) +port = project.Contents.Ports:AddWirePort(line.Wires[1]) + -- Obtain a handle to the 'PortCollection' +ports = project.Contents.Ports + -- Print the number of ports in the collection +print("Number of ports in the collection is: " .. ports.Count) +Inheritance +The PortCollection object is derived from the Object object. +Usage locations +The PortCollection object can be accessed from the following locations: +• Collection lists +◦ ModelContents object has collection Ports. +Property List +Count +Label +Type +The number of Port items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddCablePort (harness CableHarness) +Add a cable port to the specified cable harness. (Returns a CablePort object.) +AddCablePort (harness CableHarness, terminal1 Terminal, terminal2 Terminal) +Add a cable port to the cable harness schematic, connecting it to the specified terminals. (Returns +a CablePort object.) +AddCablePort (table table) +Create a cable port from a creation table. (Returns a CablePort object.) +AddEdgeMeshPort (table table) +Create an edge mesh port from a creation table. (Returns a EdgeMeshPort object.) +AddEdgeMeshPort (positivefaces List of AbstractMeshTriangleFace, negativefaces List of +AbstractMeshTriangleFace) +Create a port on an edge between mesh faces. (Returns a EdgeMeshPort object.) +AddEdgeMeshPortConnectedToGround (faces List of AbstractMeshTriangleFace, groundconnection +EdgePortGroundConnectionEnum) +Create a port on an edge between mesh faces. (Returns a EdgeMeshPort object.) +AddEdgePort (table table) +Create a port on an edge between faces. (Returns a EdgePort object.) +AddEdgePort (positivefaces List of Face, negativefaces List of Face) +Create a port on an edge between faces. (Returns a EdgePort object.) +AddEdgePortConnectedToGround (faces List of Face, groundconnection +EdgePortGroundConnectionEnum) +Create a port on an edge between faces. (Returns a EdgePort object.) +AddFEMLineMeshPort (table table) +Create a FEM line mesh port from a creation table. (Returns a FEMLineMeshPort object.) +AddFEMLineMeshPort (startvertex MeshVertexReference, endvertex MeshVertexReference) +Create a FEM line port between two mesh vertices. (Returns a FEMLineMeshPort object.) +AddFEMLineMeshPortBetweenPoints (start Point, end Point) +Create a FEM line mesh port between two points. (Returns a FEMLineMeshPort object.) +AddFEMLinePort (edges table) +Create a FEM line port along a list of edges. (Returns a FEMLinePort object.) +AddFEMLinePort (edges List of Edge) +Create a FEM line port along a list of edges. (Returns a FEMLinePort object.) +AddFEMLinePortBetweenPoints (start Point, end Point) +Create a FEM line port between two points. (Returns a FEMLinePort object.) +AddFEMModalMeshPort (table table) +Create a FEM model mesh port from a creation table. (Returns a FEMModalMeshPort object.) +AddFEMModalMeshPort (vertex1 MeshVertexReference, vertex2 MeshVertexReference, vertex3 +MeshVertexReference) +Create a FEM modal port by specifying three mesh vertices. (Returns a FEMModalMeshPort +object.) +AddFEMModalMeshPortFromPoints (corner1 Point, corner2 Point, corner3 Point) +Create a FEM modal mesh port by specifying three points. (Returns a FEMModalMeshPort object.) +AddFEMModalPort (table table) +Create a FEM model port from a creation table. (Returns a FEMModalPort object.) +AddFEMModalPort (faces List of Face) +Create a FEM modal port on a list of faces. (Returns a FEMModalPort object.) +AddFEMModalPortFromPoints (corner1 Point, corner2 Point, corner3 Point) +Create a FEM modal port by specifying three points. (Returns a FEMModalPort object.) +AddMicrostripMeshPort (table table) +Create a microstrip mesh port from a creation table. (Returns a MicrostripMeshPort object.) +AddMicrostripMeshPort (startvertex MeshVertexReference, endvertex MeshVertexReference) +Create a microstrip port between two mesh vertices. (Returns a MicrostripMeshPort object.) +AddMicrostripPort (table table) +Create a microstrip port from a creation table. (Returns a MicrostripPort object.) +AddMicrostripPort (edges List of Edge) +Create a microstrip port along a list of edges. (Returns a MicrostripPort object.) +AddWaveguideMeshPort (table table) +Create a waveguide mesh port from a creation table. (Returns a WaveguideMeshPort object.) +AddWaveguideMeshPort (face MeshTriangleFace, referencevector Point) +Create a waveguide port on a mesh face. (Returns a WaveguideMeshPort object.) +AddWaveguidePort (table table) +Create a waveguide port from a creation table. (Returns a WaveguidePort object.) +AddWaveguidePort (face Face) +Create a waveguide port on a face. (Returns a WaveguidePort object.) +AddWireMeshPort (table table) +Create a wire mesh port from a creation table. (Returns a WireMeshPort object.) +AddWireMeshPort (segment MeshSegmentReference) +Create a wire port on a mesh segment. (Returns a WireMeshPort object.) +AddWireMeshPortOnVertex (vertex MeshVertexReference) +Create a wire port on a mesh vertex. (Returns a WireMeshPort object.) +AddWirePort (table table) +Create a wire port from a creation table. (Returns a WirePort object.) +AddWirePort (wire Edge) +Create a port which is a point on a free wire. (Returns a WirePort object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Port for the given index in the collection. (Returns a Port object.) +Item (label string) +Returns the Port for the given label in the collection. (Returns a Port object.) +Items () +Returns a table of Port items. (Returns a UnsupportedType(List of Port) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Port items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddCablePort (harness CableHarness) +Add a cable port to the specified cable harness. +Input Parameters +harness(CableHarness) +The cable harness to add the port to. +Return +CablePort +The cable port. +AddCablePort (harness CableHarness, terminal1 Terminal, terminal2 Terminal) +Add a cable port to the cable harness schematic, connecting it to the specified terminals. +Input Parameters +harness(CableHarness) +The cable harness to add the port to. +terminal1(Terminal) +The terminal that the components first terminal should be connected to. Can be nil. +terminal2(Terminal) +The terminal that the components second terminal should be connected to. Can be nil. +Return +CablePort +The cable port. +AddCablePort (table table) +Create a cable port from a creation table. +Input Parameters +table(table) +The creation table. +Return +CablePort +The cable port. +AddEdgeMeshPort (table table) +Create an edge mesh port from a creation table. +Input Parameters +table(table) +The creation table. +Return +EdgeMeshPort +The edge mesh port. +AddEdgeMeshPort (positivefaces List of AbstractMeshTriangleFace, negativefaces List of +AbstractMeshTriangleFace) +Create a port on an edge between mesh faces. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +positivefaces(List of AbstractMeshTriangleFace) +The list of faces on the positive side of the port. +negativefaces(List of AbstractMeshTriangleFace) +The list of faces on the negative side of the port. +Return +EdgeMeshPort +The edge mesh port. +p.2602 +AddEdgeMeshPortConnectedToGround (faces List of AbstractMeshTriangleFace, groundconnection +EdgePortGroundConnectionEnum) +Create a port on an edge between mesh faces. +Input Parameters +faces(List of AbstractMeshTriangleFace) +The list of mesh faces connecting the non-ground side of the port. +groundconnection(EdgePortGroundConnectionEnum) +Definition of whether the positive or negative terminal should be connected to ground. +Return +EdgeMeshPort +The edge mesh port. +AddEdgePort (table table) +Create a port on an edge between faces. +Input Parameters +table(table) +The creation table. +Return +EdgePort +The edge port. +AddEdgePort (positivefaces List of Face, negativefaces List of Face) +Create a port on an edge between faces. +Input Parameters +positivefaces(List of Face) +The list of faces on the positive side of the port. +negativefaces(List of Face) +The list of faces on the negative side of the port. +Return +EdgePort +The edge port. +AddEdgePortConnectedToGround (faces List of Face, groundconnection +EdgePortGroundConnectionEnum) +Create a port on an edge between faces. +Input Parameters +faces(List of Face) +The list of faces connecting the non-ground side of the port. +groundconnection(EdgePortGroundConnectionEnum) +Definition of whether the positive or negative terminal should be connected to ground. +Return +EdgePort +The edge port. +AddFEMLineMeshPort (table table) +Create a FEM line mesh port from a creation table. +Input Parameters +table(table) +The creation table. +Return +FEMLineMeshPort +The FEM line mesh port. +AddFEMLineMeshPort (startvertex MeshVertexReference, endvertex MeshVertexReference) +Create a FEM line port between two mesh vertices. +Input Parameters +startvertex(MeshVertexReference) +The mesh vertex for the port start position. +endvertex(MeshVertexReference) +The mesh vertex for the port end position. +Return +FEMLineMeshPort +The FEM line mesh port. +AddFEMLineMeshPortBetweenPoints (start Point, end Point) +Create a FEM line mesh port between two points. +Input Parameters +start(Point) +The start point of the port. +end(Point) +The end point of the port. +Return +FEMLineMeshPort +The FEM line mesh port. +AddFEMLinePort (edges table) +Create a FEM line port along a list of edges. +Input Parameters +edges(table) +The edges on which the FEM line port is located. +Return +FEMLinePort +The FEM line port. +AddFEMLinePort (edges List of Edge) +Create a FEM line port along a list of edges. +Input Parameters +edges(List of Edge) +The edges on which the FEM line port is located. +Return +FEMLinePort +The FEM line port. +AddFEMLinePortBetweenPoints (start Point, end Point) +Create a FEM line port between two points. +Input Parameters +start(Point) +The start point of the port. +end(Point) +The end point of the port. +Return +FEMLinePort +The FEM line port. +AddFEMModalMeshPort (table table) +Create a FEM model mesh port from a creation table. +Input Parameters +table(table) +The creation table. +Return +FEMModalMeshPort +The FEM modal mesh port. +AddFEMModalMeshPort (vertex1 MeshVertexReference, vertex2 MeshVertexReference, vertex3 +MeshVertexReference) +Create a FEM modal port by specifying three mesh vertices. +Input Parameters +vertex1(MeshVertexReference) +The first mesh vertex of the port. +vertex2(MeshVertexReference) +The second mesh vertex of the port. +vertex3(MeshVertexReference) +The third mesh vertex of the port. +Return +FEMModalMeshPort +The FEM modal mesh port. +AddFEMModalMeshPortFromPoints (corner1 Point, corner2 Point, corner3 Point) +Create a FEM modal mesh port by specifying three points. +Input Parameters +corner1(Point) +The first corner point of the port. +corner2(Point) +The second corner point of the port. +corner3(Point) +The third corner point of the port. +Return +FEMModalMeshPort +The FEM modal mesh port. +AddFEMModalPort (table table) +Create a FEM model port from a creation table. +Input Parameters +table(table) +The creation table. +Return +FEMModalPort +The FEM modal port. +AddFEMModalPort (faces List of Face) +Create a FEM modal port on a list of faces. +Input Parameters +faces(List of Face) +The faces on which the FEM modal port is located. +Return +FEMModalPort +The FEM modal port. +AddFEMModalPortFromPoints (corner1 Point, corner2 Point, corner3 Point) +Create a FEM modal port by specifying three points. +Input Parameters +corner1(Point) +The first corner point of the port. +corner2(Point) +The second corner point of the port. +corner3(Point) +The third corner point of the port. +Return +FEMModalPort +The FEM modal port. +AddMicrostripMeshPort (table table) +Create a microstrip mesh port from a creation table. +Input Parameters +table(table) +The creation table. +Return +MicrostripMeshPort +The microstrip mesh port. +AddMicrostripMeshPort (startvertex MeshVertexReference, endvertex MeshVertexReference) +Create a microstrip port between two mesh vertices. +Input Parameters +startvertex(MeshVertexReference) +The mesh vertex for the port start position. +endvertex(MeshVertexReference) +The mesh vertex for the port end position. +Return +MicrostripMeshPort +The microstrip mesh port. +AddMicrostripPort (table table) +Create a microstrip port from a creation table. +Input Parameters +table(table) +The creation table. +Return +MicrostripPort +The microstrip port. +AddMicrostripPort (edges List of Edge) +Create a microstrip port along a list of edges. +Input Parameters +edges(List of Edge) +The edges on which the microstrip port is located. +Return +MicrostripPort +The microstrip port. +AddWaveguideMeshPort (table table) +Create a waveguide mesh port from a creation table. +Input Parameters +table(table) +The creation table. +Return +WaveguideMeshPort +The waveguide mesh port. +AddWaveguideMeshPort (face MeshTriangleFace, referencevector Point) +Create a waveguide port on a mesh face. +Input Parameters +face(MeshTriangleFace) +The mesh face on which the waveguide port is located. +referencevector(Point) +The waveguide reference direction. +Return +WaveguideMeshPort +The waveguide mesh port. +AddWaveguidePort (table table) +Create a waveguide port from a creation table. +Input Parameters +table(table) +The creation table. +Return +WaveguidePort +The waveguide port. +AddWaveguidePort (face Face) +Create a waveguide port on a face. +Input Parameters +face(Face) +The face on which the waveguide port is located. +Return +WaveguidePort +The waveguide port. +AddWireMeshPort (table table) +Create a wire mesh port from a creation table. +Input Parameters +table(table) +The creation table. +Return +WireMeshPort +The wire mesh port. +AddWireMeshPort (segment MeshSegmentReference) +Create a wire port on a mesh segment. +Input Parameters +segment(MeshSegmentReference) +The mesh segment the port is located on. +Return +WireMeshPort +The wire mesh port. +AddWireMeshPortOnVertex (vertex MeshVertexReference) +Create a wire port on a mesh vertex. +Input Parameters +vertex(MeshVertexReference) +The mesh vertex the port is located on. +Return +WireMeshPort +The wire mesh port. +AddWirePort (table table) +Create a wire port from a creation table. +Input Parameters +table(table) +The creation table. +Return +WirePort +The wire port. +AddWirePort (wire Edge) +Create a port which is a point on a free wire. +Input Parameters +wire(Edge) +The wire the port is located on. +Return +WirePort +The wire port. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2610 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Port for the given index in the collection. +Input Parameters +index(number) +The index of the Port. +Return +Port +The item in the collection +Item (label string) +Returns the Port for the given label in the collection. +Input Parameters +label(string) +The label of the Port. +Return +Port +The item in the collection +Items () +Returns a table of Port items. +Return +UnsupportedType(List of Port) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ProtectedModels +A collection of protected components. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Import a protected model +p.2612 +--protectedModel = project.ProtectedModels:AddComponentFromFile(FEKO_HOME..[[/shared/ +Resources/Automation/protectedModel.cfx]]) +Inheritance +The ProtectedModels object is derived from the Object object. +Usage locations +The ProtectedModels object can be accessed from the following locations: +• Collection lists +Property List +BoundingBox +Count +Label +Type +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +The number of ProtectedModel items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddComponent (table table) +Create an protected component from a table defining the properties. (Returns a ProtectedModel +object.) +AddComponentFromFile (Filename string) +Create an protected component from the given file. (Returns a ProtectedModel object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2613 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the ProtectedModel for the given index in the collection. (Returns a ProtectedModel +object.) +Item (label string) +Returns the ProtectedModel for the given label in the collection. (Returns a ProtectedModel +object.) +Items () +Returns a table of ProtectedModel items. (Returns a UnsupportedType(List of ProtectedModel) +object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Count +The number of ProtectedModel items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddComponent (table table) +Create an protected component from a table defining the properties. +Input Parameters +table(table) +A table of properties defining the new protected component. +Return +ProtectedModel +Returns a ProtectedModel object. +AddComponentFromFile (Filename string) +Create an protected component from the given file. +Input Parameters +Filename(string) +The file to be imported as a protected component. +Return +ProtectedModel +Returns a ProtectedModel object. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the ProtectedModel for the given index in the collection. +Input Parameters +index(number) +The index of the ProtectedModel. +Return +ProtectedModel +The item in the collection +Item (label string) +Returns the ProtectedModel for the given label in the collection. +Input Parameters +label(string) +The label of the ProtectedModel. +Return +ProtectedModel +The item in the collection +Items () +Returns a table of ProtectedModel items. +Return +UnsupportedType(List of ProtectedModel) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +RegionCollection +A collection of regions. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create geometry which contains regions +project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) +project.Contents.Geometry:AddSphere(cf.Point(0.5, 0.5, 0.5), 1) +union = project.Contents.Geometry:Union() + -- Set the local mesh size on each region +for key,value in pairs(union.Regions) do + value.LocalMeshSize = 0.1 +end +Inheritance +The RegionCollection object is derived from the Object object. +Usage locations +The RegionCollection object can be accessed from the following locations: +• Collection lists +◦ Geometry object has collection Regions. +◦ SpiralCross object has collection Regions. +◦ Ring object has collection Regions. +◦ OpenRing object has collection Regions. +◦ SplitRing object has collection Regions. +◦ Cross object has collection Regions. +◦ StripCross object has collection Regions. +◦ Trifilar object has collection Regions. +◦ AnalyticalCurve object has collection Regions. +◦ BezierCurve object has collection Regions. +◦ Cone object has collection Regions. +◦ ConstrainedSurface object has collection Regions. +◦ Cuboid object has collection Regions. +◦ Cylinder object has collection Regions. +◦ Ellipse object has collection Regions. +◦ EllipticArc object has collection Regions. +◦ FittedSpline object has collection Regions. +◦ Flare object has collection Regions. +◦ Helix object has collection Regions. +◦ Hexagon object has collection Regions. +◦ StripHexagon object has collection Regions. +◦ HyperbolicArc object has collection Regions. +◦ +◦ +ImprintPoints object has collection Regions. +Intersect object has collection Regions. +◦ Loft object has collection Regions. +◦ PathSweep object has collection Regions. +◦ ProjectGeometry object has collection Regions. +◦ RepairAndSewFaces object has collection Regions. +◦ RepairPart object has collection Regions. +◦ Spin object has collection Regions. +◦ Split object has collection Regions. +◦ Stitch object has collection Regions. +◦ Subtract object has collection Regions. +◦ Sweep object has collection Regions. +◦ Union object has collection Regions. +◦ Simplify object has collection Regions. +◦ Line object has collection Regions. +◦ NurbsSurface object has collection Regions. +◦ ParabolicArc object has collection Regions. +◦ Paraboloid object has collection Regions. +◦ Polygon object has collection Regions. +◦ Polyline object has collection Regions. +◦ Primitive object has collection Regions. +◦ Rectangle object has collection Regions. +◦ Sphere object has collection Regions. +◦ AbstractSurfaceCurve object has collection Regions. +◦ SurfaceBezierCurve object has collection Regions. +◦ SurfaceLine object has collection Regions. +◦ SurfaceRegularLines object has collection Regions. +◦ TCross object has collection Regions. +Property List +Count +Label +The number of Region items in the collection. (Read only number) +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.2618 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Region for the given index in the collection. (Returns a Region object.) +Item (label string) +Returns the Region for the given label in the collection. (Returns a Region object.) +Items () +Returns a table of Region items. (Returns a UnsupportedType(List of Region) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Region items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Region for the given index in the collection. +Input Parameters +index(number) +The index of the Region. +Return +Region +The item in the collection +Item (label string) +Returns the Region for the given label in the collection. +Input Parameters +label(string) +The label of the Region. +Return +Region +The item in the collection +Altair Feko 2022.3 +2 Application Programming Interface (API) +Items () +Returns a table of Region items. +Return +UnsupportedType(List of Region) +The list of items in the collection +SetProperties (properties Object) +p.2620 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SARCollection +A collection of SAR calculation requests for this solution configuration. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a SAR request to the SAR collection +configuration = project.Contents.SolutionConfigurations[1] +SARCollection = configuration.SAR +SARRequest = SARCollection:Add() + -- Remove the SAR request from the SAR collection +SARCollection:Item(SARRequest.Label):Delete() +Inheritance +The SARCollection object is derived from the Object object. +Usage locations +The SARCollection object can be accessed from the following locations: +• Collection lists +◦ StandardConfiguration object has collection SAR. +Property List +Count +Label +Type +The number of SAR items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add () +Create a SAR calculation request. (Returns a SAR object.) +Add (properties table) +Create a SAR calculation request using the table of properties. (Returns a SAR object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2622 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the SAR for the given index in the collection. (Returns a SAR object.) +Item (label string) +Returns the SAR for the given label in the collection. (Returns a SAR object.) +Items () +Returns a table of SAR items. (Returns a UnsupportedType(List of SAR) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of SAR items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add () +Create a SAR calculation request. +Return +SAR +The SAR request. +Add (properties table) +Create a SAR calculation request using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +SAR +The SAR request. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the SAR for the given index in the collection. +Input Parameters +index(number) +The index of the SAR. +Return +SAR +The item in the collection +Item (label string) +Returns the SAR for the given label in the collection. +Input Parameters +label(string) +The label of the SAR. +Return +SAR +The item in the collection +Items () +Returns a table of SAR items. +Return +UnsupportedType(List of SAR) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +ShapeCollection +A collection of shapes. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create an open ring shape +properties = cf.OpenRingShape.GetDefaultProperties() +properties.Label = "OpenRingShape1" +application.Project.Definitions.PeriodicStructures.Shapes:AddOpenRing(properties) +-- Retrieve a shape object from the collection +shape1 = application.Project.Definitions.PeriodicStructures.Shapes[1] +-- Build geometry for the selected shape +openRing1 = shape1:BuildGeometry() +Inheritance +The ShapeCollection object is derived from the Object object. +Property List +Count +Label +Type +The number of Shape items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddCross (properties table) +Create a cross shape from a table defining the properties. (Returns a CrossShape object.) +AddCross (armlengthu Expression, armlengthv Expression, stripwidth Expression) +Create a cross shape with the specified arm lenths and strip width. (Returns a CrossShape +object.) +AddEllipse (properties table) +Create an ellipse shape from a table defining the properties. (Returns a EllipseShape object.) +AddEllipse (radiusu Expression, radiusv Expression) +Create an ellipse shape with the specified radius U and radius V. (Returns a EllipseShape object.) +AddHexagon (properties table) +Create a hexagon shape from a table defining the properties. (Returns a HexagonShape object.) +AddOpenRing (properties table) +Create an open ring shape from a table defining the properties. (Returns a OpenRingShape +object.) +AddOpenRing (outerradius Expression, innerradius Expression, gapangle Expression, startangle +Expression) +Create an open ring shape with the specified outer and inner radius, gap and start angle. (Returns +a OpenRingShape object.) +AddPlane (properties table) +Create a plane shape from a table defining the properties. (Returns a PlaneShape object.) +AddPlane (width Expression, depth Expression) +Create a plane shape with the specified width and depth. (Returns a PlaneShape object.) +AddRing (properties table) +Create a ring shape from a table defining the properties. (Returns a RingShape object.) +AddRing (outerradius Expression, innerradius Expression) +Create a ring shape with the specified outer and inner radius. (Returns a RingShape object.) +AddSpiralCross (properties table) +Create a spiral cross shape from a table defining the properties. (Returns a SpiralCrossShape +object.) +AddSpiralCross (armlength Expression, edgelength Expression, spirallength Expression, stripwidth +Expression) +Create a spiral cross shape with the specified arm, edge and spiral length and strip width. +(Returns a SpiralCrossShape object.) +AddSplitRing (properties table) +Create an split ring shape from a table defining the properties. (Returns a SplitRingShape object.) +AddSplitRing (outerradius Expression, innerradius Expression, gapangle Expression, startangle +Expression) +Create a split ring shape with the specified outer and inner radius, gap and start angle. (Returns a +SplitRingShape object.) +AddStripCross (properties table) +Create a strip cross shape from a table defining the properties. (Returns a StripCrossShape +object.) +AddStripCross (armlengthu Expression, armlengthv Expression, stripwidth Expression, slotwidth +Expression) +Create a strip cross shape with the specified arm lengths, strip width and slot width. (Returns a +StripCrossShape object.) +AddStripHexagon (properties table) +Create a strip hexagon shape from a table defining the properties. (Returns a StripHexagonShape +object.) +AddStripHexagon (width Expression, stripwidth Expression) +Create a strip hexagon shape with the specified width and strip width. (Returns a +StripHexagonShape object.) +AddTCross (properties table) +Create a T-cross shape from a table defining the properties. (Returns a TCrossShape object.) +AddTCross (armlength Expression, edgelength Expression, stripwidth Expression) +Create a T-cross shape with the specified arm length, edge length and strip width. (Returns a +TCrossShape object.) +AddTrifilar (properties table) +Create a trifilar shape from a table defining the properties. (Returns a TrifilarShape object.) +AddTrifilar (length Expression, stripwidth Expression) +Create a trifilar shape with the specified length and strip width. (Returns a TrifilarShape object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Shape for the given index in the collection. (Returns a Shape object.) +Item (label string) +Returns the Shape for the given label in the collection. (Returns a Shape object.) +Items () +Returns a table of Shape items. (Returns a UnsupportedType(List of Shape) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Shape items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddCross (properties table) +Create a cross shape from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new cross shape. +Return +CrossShape +The cross shape. +AddCross (armlengthu Expression, armlengthv Expression, stripwidth Expression) +Create a cross shape with the specified arm lenths and strip width. +Input Parameters +armlengthu(Expression) +The cross shape arm length (U). +armlengthv(Expression) +The cross shape arm length (V). +stripwidth(Expression) +The cross strip width. +Return +CrossShape +The cross shape. +AddEllipse (properties table) +Create an ellipse shape from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new ellipse shape. +Return +EllipseShape +The ellipse shape. +AddEllipse (radiusu Expression, radiusv Expression) +Create an ellipse shape with the specified radius U and radius V. +Input Parameters +radiusu(Expression) +The ellipse shape radius (U). +radiusv(Expression) +The ellipse shape radius (V). +Return +EllipseShape +The ellipse shape. +AddHexagon (properties table) +Create a hexagon shape from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new hexagon shape. +Return +HexagonShape +The hexagon shape. +AddOpenRing (properties table) +Create an open ring shape from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new open ring shape. +Return +OpenRingShape +The open ring shape. +AddOpenRing (outerradius Expression, innerradius Expression, gapangle Expression, startangle +Expression) +Create an open ring shape with the specified outer and inner radius, gap and start angle. +Input Parameters +outerradius(Expression) +The ring shape outer radius. +innerradius(Expression) +The ring shape inner radius. +gapangle(Expression) +The ring shape gap angle. +startangle(Expression) +The ring shape opening start angle. +Return +OpenRingShape +The open ring shape. +AddPlane (properties table) +Create a plane shape from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new plane shape. +Return +PlaneShape +The plane shape. +AddPlane (width Expression, depth Expression) +Create a plane shape with the specified width and depth. +Input Parameters +width(Expression) +The plane shape width. +depth(Expression) +The plane shape depth. +Return +PlaneShape +The plane shape. +AddRing (properties table) +Create a ring shape from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new ring shape. +Return +RingShape +The ring shape. +AddRing (outerradius Expression, innerradius Expression) +Create a ring shape with the specified outer and inner radius. +Input Parameters +outerradius(Expression) +The ring shape outer radius. +innerradius(Expression) +The ring shape inner radius. +Return +RingShape +The ring shape. +AddSpiralCross (properties table) +Create a spiral cross shape from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new spiral cross shape. +Return +SpiralCrossShape +The spiral cross shape. +AddSpiralCross (armlength Expression, edgelength Expression, spirallength Expression, stripwidth +Expression) +Create a spiral cross shape with the specified arm, edge and spiral length and strip width. +Input Parameters +armlength(Expression) +The cross shape arm length. +edgelength(Expression) +The cross shape edge length. +spirallength(Expression) +The cross shape spiral length. +stripwidth(Expression) +The cross shape strip width. +Return +SpiralCrossShape +The spiral cross shape. +AddSplitRing (properties table) +Create an split ring shape from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new split ring shape. +Return +SplitRingShape +The split ring shape. +AddSplitRing (outerradius Expression, innerradius Expression, gapangle Expression, startangle +Expression) +Create a split ring shape with the specified outer and inner radius, gap and start angle. +Input Parameters +outerradius(Expression) +The ring shape outer radius. +innerradius(Expression) +The ring shape inner radius. +gapangle(Expression) +The ring shape gap angle. +startangle(Expression) +The ring shape opening start angle. +Return +SplitRingShape +The split ring shape. +AddStripCross (properties table) +Create a strip cross shape from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new strip cross shape. +Return +StripCrossShape +The strip cross shape. +AddStripCross (armlengthu Expression, armlengthv Expression, stripwidth Expression, slotwidth +Expression) +Create a strip cross shape with the specified arm lengths, strip width and slot width. +Input Parameters +armlengthu(Expression) +The strip cross shape arm length (U). +armlengthv(Expression) +The strip cross shape arm length (V). +stripwidth(Expression) +The strip cross shape strip width. +slotwidth(Expression) +The strip cross shape slot width. +Return +StripCrossShape +The strip cross shape. +AddStripHexagon (properties table) +Create a strip hexagon shape from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new strip hexagon shape. +Return +StripHexagonShape +The strip hexagon shape. +AddStripHexagon (width Expression, stripwidth Expression) +Create a strip hexagon shape with the specified width and strip width. +Input Parameters +width(Expression) +The hexagon shape width. +stripwidth(Expression) +The hexagon shape strip width. +Return +StripHexagonShape +The strip hexagon shape. +AddTCross (properties table) +Create a T-cross shape from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new T-cross shape. +Return +TCrossShape +The T-cross shape. +AddTCross (armlength Expression, edgelength Expression, stripwidth Expression) +Create a T-cross shape with the specified arm length, edge length and strip width. +Input Parameters +armlength(Expression) +The cross shape arm length. +edgelength(Expression) +The cross shape edge length. +stripwidth(Expression) +The cross shape strip width. +Return +TCrossShape +The T-cross shape. +AddTrifilar (properties table) +Create a trifilar shape from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new trifilar shape. +Return +TrifilarShape +The trifilar shape. +AddTrifilar (length Expression, stripwidth Expression) +Create a trifilar shape with the specified length and strip width. +Input Parameters +length(Expression) +The trifilar shape length. +stripwidth(Expression) +The trifilar shape strip width. +Return +TrifilarShape +The trifilar shape. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2635 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Shape for the given index in the collection. +Input Parameters +index(number) +The index of the Shape. +Return +Shape +The item in the collection +Item (label string) +Returns the Shape for the given label in the collection. +Input Parameters +label(string) +The label of the Shape. +Return +Shape +The item in the collection +Items () +Returns a table of Shape items. +Return +UnsupportedType(List of Shape) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SolutionConfigurationCollection +A collection of solution configurations in the project. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a line and attach a wire port to it +p.2637 +line = project.Contents.Geometry:AddLine(cf.Point(0,0,0), cf.Point(0,0,1)) +wirePort = project.Contents.Ports:AddWirePort(line.Wires[1]) + -- Obtain a handle to the 'SolutionConfigurationCollection' +solutionConfigurations = project.Contents.SolutionConfigurations + -- Use handle to add an S-parameter configuration +SParameterConfiguration = solutionConfigurations:AddMultiportSParameter({wirePort}) + -- use handle to set loads to be specified per configuration +solutionConfigurations:SetLoadsPerConfiguration() + -- Add a load to the S-parameter configuration +SParameterConfiguration.Loads:AddComplex(wirePort,1,0) +Inheritance +The SolutionConfigurationCollection object is derived from the Object object. +Usage locations +The SolutionConfigurationCollection object can be accessed from the following locations: +• Collection lists +◦ ModelContents object has collection SolutionConfigurations. +Property List +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +Count +The number of SolutionConfiguration items in the collection. (Read only number) +GlobalFrequency +The global solution frequency range. (Read only Frequency) +GlobalPower +The global power settings. (Read only Power) +IsFrequencyPerConfiguration +Whether frequency is specified per configuration. (Read only boolean) +IsLoadsPerConfiguration +Whether loads are specified per configuration. (Read only boolean) +IsPowerPerConfiguration +Whether power is specified per configuration. (Read only boolean) +IsSourcesPerConfiguration +Whether sources are specified per configuration. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Collection List +GlobalLoads +The global collection of loads. (LoadCollection of Load.) +GlobalNetworks +The global collection of non-radiating networks. (NetworkCollection of Network.) +GlobalSources +The global collection of solution sources. (SourceCollection of Source.) +Method List +AddCharacteristicModes (numberofmodes Expression) +Add a characteristic modes configuration. (Returns a CharacteristicModesConfiguration object.) +AddMultiportSParameter (portterminals List of Port) +Add a multiport S-parameter configuration. (Returns a SParameterConfiguration object.) +AddStandardConfiguration () +Add a standard configuration. (Returns a StandardConfiguration object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the SolutionConfiguration for the given index in the collection. (Returns a +SolutionConfiguration object.) +Item (label string) +Returns the SolutionConfiguration for the given label in the collection. (Returns a +SolutionConfiguration object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Items () +Returns a table of SolutionConfiguration items. (Returns a UnsupportedType(List of +SolutionConfiguration) object.) +p.2639 +SetFrequencyGlobal (solutionconfiguration SolutionConfiguration) +Specify frequency to be global. +SetFrequencyPerConfiguration () +Specify frequency to be per configuration. +SetLoadsGlobal (solutionconfiguration SolutionConfiguration) +Specify loads to be global. +SetLoadsPerConfiguration () +Specify loads to be per configuration. +SetPowerGlobal (solutionconfiguration SolutionConfiguration) +Specify power to be global. +SetPowerPerConfiguration () +Specify power to be per configuration. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSourcesGlobal (solutionconfiguration SolutionConfiguration) +Specify sources to be global. +SetSourcesPerConfiguration () +Specify sources to be per configuration. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Count +The number of SolutionConfiguration items in the collection. +Type +number +Access +Read only +GlobalFrequency +The global solution frequency range. +Type +Frequency +Access +Read only +GlobalPower +The global power settings. +Type +Power +Access +Read only +IsFrequencyPerConfiguration +Whether frequency is specified per configuration. +Type +boolean +Access +Read only +IsLoadsPerConfiguration +Whether loads are specified per configuration. +Type +boolean +Access +Read only +IsPowerPerConfiguration +Whether power is specified per configuration. +Type +boolean +Access +Read only +IsSourcesPerConfiguration +Whether sources are specified per configuration. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +GlobalLoads +The global collection of loads. +Type +LoadCollection +GlobalNetworks +The global collection of non-radiating networks. +Type +NetworkCollection +GlobalSources +The global collection of solution sources. +Type +SourceCollection +Method Details +AddCharacteristicModes (numberofmodes Expression) +Add a characteristic modes configuration. +Input Parameters +numberofmodes(Expression) +The number of modes to calculate. +Return +CharacteristicModesConfiguration +The solution configuration. +Altair Feko 2022.3 +2 Application Programming Interface (API) +AddMultiportSParameter (portterminals List of Port) +Add a multiport S-parameter configuration. +Input Parameters +portterminals(List of Port) +p.2642 +The list of port terminals on which the S-parameters calculation should be done. +Return +SParameterConfiguration +The S-parameter configuration. +AddStandardConfiguration () +Add a standard configuration. +Return +StandardConfiguration +The standard configuration. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the SolutionConfiguration for the given index in the collection. +Input Parameters +index(number) +The index of the SolutionConfiguration. +Return +SolutionConfiguration +The item in the collection +Item (label string) +Returns the SolutionConfiguration for the given label in the collection. +Input Parameters +label(string) +The label of the SolutionConfiguration. +Return +SolutionConfiguration +The item in the collection +Items () +Returns a table of SolutionConfiguration items. +Return +UnsupportedType(List of SolutionConfiguration) +The list of items in the collection +SetFrequencyGlobal (solutionconfiguration SolutionConfiguration) +Specify frequency to be global. +Input Parameters +solutionconfiguration(SolutionConfiguration) +The solution configuration to use as source for the global frequency. +SetFrequencyPerConfiguration () +Specify frequency to be per configuration. +SetLoadsGlobal (solutionconfiguration SolutionConfiguration) +Specify loads to be global. +Input Parameters +solutionconfiguration(SolutionConfiguration) +The solution configuration to use as source for the global loads. +SetLoadsPerConfiguration () +Specify loads to be per configuration. +SetPowerGlobal (solutionconfiguration SolutionConfiguration) +Specify power to be global. +Input Parameters +solutionconfiguration(SolutionConfiguration) +The solution configuration to use as source for the global power. +SetPowerPerConfiguration () +Specify power to be per configuration. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +SetSourcesGlobal (solutionconfiguration SolutionConfiguration) +Specify sources to be global. +Input Parameters +solutionconfiguration(SolutionConfiguration) +The solution configuration to use as source for the global sources. +SetSourcesPerConfiguration () +Specify sources to be per configuration. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SourceCollection +A collection of solution sources. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add a plane wave and an electric dipole to the source collection +sourceCollection = project.Contents.SolutionConfigurations.GlobalSources +planeWave = sourceCollection:AddPlaneWave(0,0) +electricDipole = sourceCollection:AddElectricDipole(cf.Point(0,0,0),0,0) + -- Remove the plane wave and electric dipole from the source collection +sourceCollection:Item(planeWave.Label):Delete() +electricDipole:Delete() +Inheritance +The SourceCollection object is derived from the Object object. +Usage locations +The SourceCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfigurationCollection collection has collection GlobalSources. +◦ CharacteristicModesConfiguration object has collection Sources. +◦ StandardConfiguration object has collection Sources. +Property List +BoundingBox +Count +Label +Type +A box indicating the bounding box of this entity. (Read only Box). (Read only Box) +The number of Source items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddCurrentSource (properties table) +Create a current source using the table of properties. (Returns a CurrentSource object.) +AddCurrentSource (portterminal FEMLinePort) +Create a current source on the specified FEM line port terminal. (Returns a CurrentSource object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +AddElectricDipole (properties table) +p.2646 +Create an electric dipole source using the table of properties. (Returns a ElectricDipole object.) +AddElectricDipole (position Point, theta Expression, phi Expression) +Create an electric dipole. (Returns a ElectricDipole object.) +AddFEMModalSource (properties table) +Create a FEM modal source using the table of properties. (Returns a FEMModalSource object.) +AddFEMModalSource (portterminal FEMModalPort) +Create a FEM modal source on the specified terminal. (Returns a FEMModalSource object.) +AddFarFieldSource (properties table) +Create a far field source using the table of properties. (Returns a FarFieldSource object.) +AddFarFieldSource (fielddata FarFieldData) +Create a far field source from the specified field data. (Returns a FarFieldSource object.) +AddImpressedCurrent (properties table) +Create an impressed current. (Returns a ImpressedCurrent object.) +AddImpressedCurrent (start Point, end Point, radius Expression) +Create an impressed current. (Returns a ImpressedCurrent object.) +AddMagneticDipole (properties table) +Create a magnetic dipole source using the table of properties. (Returns a MagneticDipole object.) +AddMagneticDipole (position Point, theta Expression, phi Expression) +Create a magnetic dipole. (Returns a MagneticDipole object.) +AddNearFieldSource (properties table) +Create a near field source using the table of properties. (Returns a NearFieldSource object.) +AddNearFieldSource (fielddata FieldData) +Create a near field source from the specified field data. (Returns a NearFieldSource object.) +AddPCBSource (properties table) +Create a PCB source using the table of properties. (Returns a PCBSource object.) +AddPCBSource (fielddata FieldData) +Create a PCB source from the specified field data. (Returns a PCBSource object.) +AddPlaneWave (properties table) +Create a plane wave using the table of properties. (Returns a PlaneWave object.) +AddPlaneWave (theta Expression, phi Expression) +Create a plane wave. (Returns a PlaneWave object.) +AddSolutionCoefficientSource (properties table) +Create a solution coefficient source using the table of properties. (Returns a +SolutionCoefficientSource object.) +AddSolutionCoefficientSource (fielddata FieldData) +Create a solution coefficient source from the specified field data. (Returns a +SolutionCoefficientSource object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +AddSphericalModeSource (properties table) +p.2647 +Create a spherical modes source using the table of properties. (Returns a SphericalModeSource +object.) +AddSphericalModeSource (fielddata FieldData) +Create a spherical modes source from the specified field data. (Returns a SphericalModeSource +object.) +AddVoltageSource (properties table) +Create a voltage source using the table of properties. (Returns a VoltageSource object.) +AddVoltageSource (portterminal Port) +Create a voltage source on the specified terminal. (Returns a VoltageSource object.) +AddWaveguideSource (properties table) +Create a waveguide source using the table of properties. (Returns a WaveguideSource object.) +AddWaveguideSource (portterminal WaveguidePort) +Create a waveguide source on the specified waveguide port terminal. (Returns a +WaveguideSource object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Source for the given index in the collection. (Returns a Source object.) +Item (label string) +Returns the Source for the given label in the collection. (Returns a Source object.) +Items () +Returns a table of Source items. (Returns a UnsupportedType(List of Source) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +BoundingBox +A box indicating the bounding box of this entity. (Read only Box). +Type +Box +Access +Read only +Count +The number of Source items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddCurrentSource (properties table) +Create a current source using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +CurrentSource +The current source. +AddCurrentSource (portterminal FEMLinePort) +Create a current source on the specified FEM line port terminal. +Input Parameters +portterminal(FEMLinePort) +The FEM line port terminal on which the current source should be created. +Return +CurrentSource +The current source. +AddElectricDipole (properties table) +Create an electric dipole source using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +ElectricDipole +The electric dipole source. +AddElectricDipole (position Point, theta Expression, phi Expression) +Create an electric dipole. +Input Parameters +position(Point) +The dipole position. +theta(Expression) +The theta orientation angle (degrees). +phi(Expression) +The phi orientation angle (degrees). +Return +ElectricDipole +The electric dipole source. +AddFEMModalSource (properties table) +Create a FEM modal source using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +FEMModalSource +The FEM modal source. +AddFEMModalSource (portterminal FEMModalPort) +Create a FEM modal source on the specified terminal. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +portterminal(FEMModalPort) +p.2650 +The FEM modal port terminal on which the FEM modal source should be created. +Return +FEMModalSource +The FEM modal source. +AddFarFieldSource (properties table) +Create a far field source using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +FarFieldSource +The far field source. +AddFarFieldSource (fielddata FarFieldData) +Create a far field source from the specified field data. +Input Parameters +fielddata(FarFieldData) +The field data that defines the radiation pattern. +Return +FarFieldSource +The far field source. +AddImpressedCurrent (properties table) +Create an impressed current. +Input Parameters +properties(table) +The table of properties. +Return +ImpressedCurrent +The impressed current. +AddImpressedCurrent (start Point, end Point, radius Expression) +Create an impressed current. +Input Parameters +start(Point) +The segment current start point. +end(Point) +The segment current end point. +radius(Expression) +The impressed current radius. +Return +ImpressedCurrent +The impressed current. +AddMagneticDipole (properties table) +Create a magnetic dipole source using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +MagneticDipole +The magnetic dipole source. +AddMagneticDipole (position Point, theta Expression, phi Expression) +Create a magnetic dipole. +Input Parameters +position(Point) +The dipole position. +theta(Expression) +The theta orientation angle (degrees). +phi(Expression) +The phi orientation angle (degrees). +Return +MagneticDipole +The magnetic dipole. +AddNearFieldSource (properties table) +Create a near field source using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +NearFieldSource +The near field source. +AddNearFieldSource (fielddata FieldData) +Create a near field source from the specified field data. +Input Parameters +fielddata(FieldData) +The field data that defines the near field source. +Return +NearFieldSource +The near field source. +AddPCBSource (properties table) +Create a PCB source using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +PCBSource +The PCB source. +AddPCBSource (fielddata FieldData) +Create a PCB source from the specified field data. +Input Parameters +fielddata(FieldData) +The field data that defines the PCB. +Return +PCBSource +The PCB source. +AddPlaneWave (properties table) +Create a plane wave using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +PlaneWave +The plane wave. +AddPlaneWave (theta Expression, phi Expression) +Create a plane wave. +Input Parameters +theta(Expression) +The theta direction (degrees). +phi(Expression) +The phi direction (degrees). +Return +PlaneWave +The plane wave. +AddSolutionCoefficientSource (properties table) +Create a solution coefficient source using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +SolutionCoefficientSource +The solution coefficient source. +AddSolutionCoefficientSource (fielddata FieldData) +Create a solution coefficient source from the specified field data. +Input Parameters +fielddata(FieldData) +The field data that defines the solution coefficient. +Return +SolutionCoefficientSource +The solution coefficient source. +AddSphericalModeSource (properties table) +Create a spherical modes source using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +SphericalModeSource +The spherical modes source. +AddSphericalModeSource (fielddata FieldData) +Create a spherical modes source from the specified field data. +Input Parameters +fielddata(FieldData) +The field data that defines the spherical modes. +Return +SphericalModeSource +The spherical modes source. +AddVoltageSource (properties table) +Create a voltage source using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +VoltageSource +The voltage source. +AddVoltageSource (portterminal Port) +Create a voltage source on the specified terminal. +Input Parameters +portterminal(Port) +The terminal on which the voltage source should be created. +Return +VoltageSource +The voltage source. +AddWaveguideSource (properties table) +Create a waveguide source using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +WaveguideSource +The waveguide source. +AddWaveguideSource (portterminal WaveguidePort) +Create a waveguide source on the specified waveguide port terminal. +Input Parameters +portterminal(WaveguidePort) +The waveguide port terminal on which the waveguide source should be created. +Return +WaveguideSource +The waveguide source. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Source for the given index in the collection. +Input Parameters +index(number) +The index of the Source. +Return +Source +The item in the collection +Item (label string) +Returns the Source for the given label in the collection. +Input Parameters +label(string) +The label of the Source. +Return +Source +The item in the collection +Items () +Returns a table of Source items. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +UnsupportedType(List of Source) +The list of items in the collection +SetProperties (properties Object) +p.2656 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +SphericalModeReceivingAntennaCollection +A collection of spherical modes receiving antennas. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +standardConfiguration = + project.Contents.SolutionConfigurations:AddStandardConfiguration() + -- Get the 'SphericalModeReceivingAntennaCollections' +sphericalModeReceivingAntennaCollection = + standardConfiguration.SphericalModeReceivingAntennas + -- Get the number of 'SphericalModeReceivingAntenna' in the collection +numberOfSphericalModesRxAntennas = #sphericalModeReceivingAntennaCollection +Inheritance +The SphericalModeReceivingAntennaCollection object is derived from the Object object. +Usage locations +The SphericalModeReceivingAntennaCollection object can be accessed from the following locations: +• Collection lists +◦ StandardConfiguration object has collection SphericalModeReceivingAntennas. +Property List +Count +Label +Type +The number of SphericalModeReceivingAntenna items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Create a spherical modes receiving antenna request using the table of properties. (Returns a +SphericalModeReceivingAntenna object.) +Add (fielddata FieldData) +Create a spherical modes receiving antenna request from the specified field data. (Returns a +SphericalModeReceivingAntenna object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the SphericalModeReceivingAntenna for the given index in the collection. (Returns a +SphericalModeReceivingAntenna object.) +Item (label string) +Returns the SphericalModeReceivingAntenna for the given label in the collection. (Returns a +SphericalModeReceivingAntenna object.) +Items () +Returns a table of SphericalModeReceivingAntenna items. (Returns a UnsupportedType(List of +SphericalModeReceivingAntenna) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of SphericalModeReceivingAntenna items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Create a spherical modes receiving antenna request using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +SphericalModeReceivingAntenna +The near field receiving antenna request. +Add (fielddata FieldData) +Create a spherical modes receiving antenna request from the specified field data. +Input Parameters +fielddata(FieldData) +The field data that the spherical modes receiving antenna writes to. +Return +SphericalModeReceivingAntenna +The spherical modes receiving antenna request. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the SphericalModeReceivingAntenna for the given index in the collection. +Input Parameters +index(number) +The index of the SphericalModeReceivingAntenna. +Return +SphericalModeReceivingAntenna +The item in the collection +Item (label string) +Returns the SphericalModeReceivingAntenna for the given label in the collection. +Input Parameters +label(string) +The label of the SphericalModeReceivingAntenna. +Return +SphericalModeReceivingAntenna +The item in the collection +Items () +Returns a table of SphericalModeReceivingAntenna items. +Return +UnsupportedType(List of SphericalModeReceivingAntenna) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +TerminalCollection +A collection of terminals on a component. +Example +p.2661 +application = cf.Application.GetInstance() +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) +terminalCollection = project.Contents.CableHarnesses[1].CableSchematic.Terminals + -- Use the TerminalsCollection to retrieve the terminals connected to a schematic + component +numberOfTerminals = terminalCollection.Count +terminal = terminalCollection:Item(1) + -- Use the TerminalsCollection to retrieve the terminals connected to a general + network +project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/ +CharacteristicModes.cfx]]}) +generalNetworkTerminalCollection = + project.Contents.SolutionConfigurations.GlobalNetworks[1].Ports +generalNetworkTerminal = generalNetworkTerminalCollection:Item(1) + -- Use the TerminalsCollection to retrieve the terminals connected to a + transmission line +transmissionLineTerminalCollection = + project.Contents.SolutionConfigurations.GlobalNetworks[2].Ports +transmissionLineTerminal = transmissionLineTerminalCollection:Item(1) +Inheritance +The TerminalCollection object is derived from the Object object. +Usage locations +The TerminalCollection object can be accessed from the following locations: +• Collection lists +◦ Schematic object has collection Terminals. +Property List +Count +Label +Type +The number of Terminal items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Terminal for the given index in the collection. (Returns a Terminal object.) +Item (label string) +Returns the Terminal for the given label in the collection. (Returns a Terminal object.) +Items () +Returns a table of Terminal items. (Returns a UnsupportedType(List of Terminal) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Terminal items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Terminal for the given index in the collection. +Input Parameters +index(number) +The index of the Terminal. +Return +Terminal +The item in the collection +Item (label string) +Returns the Terminal for the given label in the collection. +Input Parameters +label(string) +The label of the Terminal. +Return +Terminal +The item in the collection +Items () +Returns a table of Terminal items. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +UnsupportedType(List of Terminal) +The list of items in the collection +SetProperties (properties Object) +p.2664 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +TopologyEntityCollectionOf_Edge +An abstract (base) collection of edge entities with topology information. +Example +-- This is an abstract object, see derived objects for examples +Inheritance +The TopologyEntityCollectionOf_Edge object is derived from the Object object. +The following objects are derived (specialisations) from the TopologyEntityCollectionOf_Edge object: +• EdgeCollection +• WireCollection +Property List +Count +Label +Type +The number of Edge items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Edge for the given index in the collection. (Returns a Edge object.) +Item (label string) +Returns the Edge for the given label in the collection. (Returns a Edge object.) +Items () +Returns a table of Edge items. (Returns a UnsupportedType(List of Edge) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Edge items in the collection. +p.2666 +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Edge for the given index in the collection. +Input Parameters +index(number) +The index of the Edge. +Return +Edge +The item in the collection +Item (label string) +Returns the Edge for the given label in the collection. +Input Parameters +label(string) +The label of the Edge. +Return +Edge +The item in the collection +Items () +Returns a table of Edge items. +Return +UnsupportedType(List of Edge) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +TransformCollection +A collection of transforms applied to the geometry. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0,0,0),1,1,1) + -- Use the TransformCollection to add a geometry transform +transformGeometryCollection = cuboid.Transforms +transformGeometryCollection:AddTranslate(cf.Point(0,0,0),cf.Point(1,1,1)) + -- Retrieve and delete the transform +transformGeometryCollection:Item(1):Delete() +Inheritance +The TransformCollection object is derived from the Object object. +Usage locations +The TransformCollection object can be accessed from the following locations: +• Collection lists +◦ GeometryGroup collection has collection Transforms. +◦ Transform object has collection Transforms. +◦ Align object has collection Transforms. +◦ Mirror object has collection Transforms. +◦ Rotate object has collection Transforms. +◦ Scale object has collection Transforms. +◦ Translate object has collection Transforms. +◦ NamedPoint object has collection Transforms. +◦ Workplane object has collection Transforms. +◦ AbstractAntennaArray object has collection Transforms. +◦ CylindricalAntennaArray object has collection Transforms. +◦ LinearPlanarArray object has collection Transforms. +◦ CustomAntennaArray object has collection Transforms. +◦ Cutplane object has collection Transforms. +◦ CablePath object has collection Transforms. +◦ MeshRefinementRule object has collection Transforms. +◦ AdaptiveRefinement object has collection Transforms. +◦ PointRefinement object has collection Transforms. +◦ PolylineRefinement object has collection Transforms. +◦ Mesh object has collection Transforms. +◦ Geometry object has collection Transforms. +◦ SpiralCross object has collection Transforms. +◦ Ring object has collection Transforms. +◦ OpenRing object has collection Transforms. +◦ SplitRing object has collection Transforms. +◦ Cross object has collection Transforms. +◦ StripCross object has collection Transforms. +◦ Trifilar object has collection Transforms. +◦ AnalyticalCurve object has collection Transforms. +◦ BezierCurve object has collection Transforms. +◦ Cone object has collection Transforms. +◦ ConstrainedSurface object has collection Transforms. +◦ Cuboid object has collection Transforms. +◦ Cylinder object has collection Transforms. +◦ Ellipse object has collection Transforms. +◦ EllipticArc object has collection Transforms. +◦ FittedSpline object has collection Transforms. +◦ Flare object has collection Transforms. +◦ Helix object has collection Transforms. +◦ Hexagon object has collection Transforms. +◦ StripHexagon object has collection Transforms. +◦ HyperbolicArc object has collection Transforms. +◦ +◦ +ImprintPoints object has collection Transforms. +Intersect object has collection Transforms. +◦ Loft object has collection Transforms. +◦ PathSweep object has collection Transforms. +◦ ProjectGeometry object has collection Transforms. +◦ RepairAndSewFaces object has collection Transforms. +◦ RepairPart object has collection Transforms. +◦ Spin object has collection Transforms. +◦ Split object has collection Transforms. +◦ Stitch object has collection Transforms. +◦ Subtract object has collection Transforms. +◦ Sweep object has collection Transforms. +◦ Union object has collection Transforms. +◦ Simplify object has collection Transforms. +◦ Line object has collection Transforms. +◦ NurbsSurface object has collection Transforms. +◦ ParabolicArc object has collection Transforms. +◦ Paraboloid object has collection Transforms. +◦ Polygon object has collection Transforms. +◦ Polyline object has collection Transforms. +◦ Primitive object has collection Transforms. +◦ Rectangle object has collection Transforms. +◦ Sphere object has collection Transforms. +◦ AbstractSurfaceCurve object has collection Transforms. +◦ SurfaceBezierCurve object has collection Transforms. +◦ SurfaceLine object has collection Transforms. +◦ SurfaceRegularLines object has collection Transforms. +◦ TCross object has collection Transforms. +◦ FieldData object has collection Transforms. +◦ SolutionCoefficientData object has collection Transforms. +◦ PCBCurrentData object has collection Transforms. +◦ SphericalModeDataManuallySpecified object has collection Transforms. +◦ SphericalModeDataFromFile object has collection Transforms. +◦ NearFieldDataFullImport object has collection Transforms. +◦ NearFieldDataFileStructure object has collection Transforms. +◦ FarFieldData object has collection Transforms. +◦ AbstractFEMLinePort object has collection Transforms. +◦ FEMLineMeshPort object has collection Transforms. +◦ FEMLinePort object has collection Transforms. +◦ FEMModalMeshPort object has collection Transforms. +◦ FEMModalPort object has collection Transforms. +◦ AbstractIdealSource object has collection Transforms. +◦ AbstractPointSource object has collection Transforms. +◦ ElectricDipole object has collection Transforms. +◦ MagneticDipole object has collection Transforms. +◦ +ImpressedCurrent object has collection Transforms. +◦ FarFieldSource object has collection Transforms. +◦ NearFieldSource object has collection Transforms. +◦ PCBSource object has collection Transforms. +◦ SolutionCoefficientSource object has collection Transforms. +◦ SphericalModeSource object has collection Transforms. +◦ PlaneWave object has collection Transforms. +◦ FarField object has collection Transforms. +◦ BaseFieldReceivingAntenna object has collection Transforms. +◦ FarFieldReceivingAntenna object has collection Transforms. +◦ NearFieldReceivingAntenna object has collection Transforms. +◦ SphericalModeReceivingAntenna object has collection Transforms. +◦ NearField object has collection Transforms. +◦ PeriodicBoundary object has collection Transforms. +◦ ProtectedModel object has collection Transforms. +Property List +Count +Label +Type +The number of Transform items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddAlign (properties table) +Apply a align using a table defining the properties. (Returns a Align object.) +AddAlign (sourceorigin Point, sourceuvector Vector, sourcevvector Vector, destinationorigin Point, +destinationuvector Vector, destinationvvector Vector) +Returns a Align object. (Returns a Align object.) +AddRotate (origin Point, rotationaxis Vector, angle Expression) +Apply a rotation. (Returns a Rotate object.) +AddRotate (properties table) +Apply a rotation using a table defining the properties. (Returns a Rotate object.) +AddScale (origin Point, factor Expression) +Apply a scale. (Returns a Scale object.) +AddScale (properties table) +Apply a scale using a table defining the properties. (Returns a Scale object.) +AddTranslate (from Point, to Point) +Apply a translate between the given coordinates. (Returns a Transform object.) +AddTranslate (properties table) +Apply a translate using a table defining the properties. (Returns a Translate object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Item (index number) +p.2672 +Returns the Transform for the given index in the collection. (Returns a Transform object.) +Item (label string) +Returns the Transform for the given label in the collection. (Returns a Transform object.) +Items () +Returns a table of Transform items. (Returns a UnsupportedType(List of Transform) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Transform items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddAlign (properties table) +Apply a align using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the align transform. +Return +Align +The align transform. +AddAlign (sourceorigin Point, sourceuvector Vector, sourcevvector Vector, destinationorigin Point, +destinationuvector Vector, destinationvvector Vector) +Returns a Align object. +Input Parameters +sourceorigin(Point) +Source origin coordinate. +sourceuvector(Vector) +Source U vector direction. +sourcevvector(Vector) +Source V vector direction. +destinationorigin(Point) +Destination origin coordinate. +destinationuvector(Vector) +Destination U vector direction. +destinationvvector(Vector) +Destination V vector direction. +Return +Align +Returns a Align object. +AddRotate (origin Point, rotationaxis Vector, angle Expression) +Apply a rotation. +Input Parameters +origin(Point) +The coordinates of the origin of the rotation. +rotationaxis(Vector) +The axis of rotation. +angle(Expression) +The angle of rotation (degrees). +Return +Rotate +The rotate transform. +AddRotate (properties table) +Apply a rotation using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the rotate transform. +Return +Rotate +The rotate transform. +AddScale (origin Point, factor Expression) +Apply a scale. +Input Parameters +origin(Point) +The coordinates of the origin of the scale transformation. +factor(Expression) +The factor to scale by. +Return +Scale +The scale transform. +AddScale (properties table) +Apply a scale using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the scale transform. +Return +Scale +The scale transform. +AddTranslate (from Point, to Point) +Apply a translate between the given coordinates. +Input Parameters +from(Point) +Translate from coordinate. +to(Point) +Translate to coordinate. +Return +Transform +The translate transform. +AddTranslate (properties table) +Apply a translate using a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the translate transform. +Return +Translate +The translate transform. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Transform for the given index in the collection. +Input Parameters +index(number) +The index of the Transform. +Return +Transform +The item in the collection +Item (label string) +Returns the Transform for the given label in the collection. +Input Parameters +label(string) +The label of the Transform. +Return +Transform +The item in the collection +Items () +Returns a table of Transform items. +Return +UnsupportedType(List of Transform) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +TransmissionReflectionCollection +p.2677 +A collection of transmission / reflection coefficient calculations requests for this solution configuration. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Use the TransmissionReflectionCollection to create TransmissionReflection + requests +transmissionReflectionCollection = + project.Contents.SolutionConfigurations[1].TransmissionReflection +transmissionReflectionCollection:Add(0,0,0) + -- Retrieve and delete the TransmissionReflection request +transmissionReflectionCollection:Item(1):Delete() +Inheritance +The TransmissionReflectionCollection object is derived from the Object object. +Usage locations +The TransmissionReflectionCollection object can be accessed from the following locations: +• Collection lists +◦ StandardConfiguration object has collection TransmissionReflection. +Property List +Count +Label +Type +The number of TransmissionReflection items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (x Expression, y Expression, z Expression) +Create a transmission / reflection coefficient calculations request. (Returns a +TransmissionReflection object.) +Add (properties table) +Create a transmission / reflection coefficient calculations request using the table of properties. +(Returns a TransmissionReflection object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the TransmissionReflection for the given index in the collection. (Returns a +TransmissionReflection object.) +Item (label string) +Returns the TransmissionReflection for the given label in the collection. (Returns a +TransmissionReflection object.) +Items () +Returns a table of TransmissionReflection items. (Returns a UnsupportedType(List of +TransmissionReflection) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of TransmissionReflection items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (x Expression, y Expression, z Expression) +Create a transmission / reflection coefficient calculations request. +Input Parameters +x(Expression) +The X position. +y(Expression) +The Y position. +z(Expression) +The Z position. +Return +TransmissionReflection +The transmission / reflection request. +Add (properties table) +Create a transmission / reflection coefficient calculations request using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +TransmissionReflection +The transmission / reflection request. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the TransmissionReflection for the given index in the collection. +Input Parameters +index(number) +The index of the TransmissionReflection. +Return +TransmissionReflection +The item in the collection +Item (label string) +Returns the TransmissionReflection for the given label in the collection. +Input Parameters +label(string) +The label of the TransmissionReflection. +Return +TransmissionReflection +The item in the collection +Items () +Returns a table of TransmissionReflection items. +Return +UnsupportedType(List of TransmissionReflection) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +UnitCellCollection +A collection of unit cells. +Example +application = cf.Application.GetInstance() +project = application:NewProject() +-- Create a ring shape +ringShape = project.Definitions.PeriodicStructures.Shapes:AddRing(1.0, 0.9) +-- Create a unit cell +properties = cf.UnitCell.GetDefaultProperties() +properties.Layers[1].Method = cf.Enums.UnitCellLayerMethodTypeEnum.Aperture +properties.Layers[1].Shape = ringShape +properties.Layers[1].Rotation = "0.0" +properties.Label = "UnitCell1" +unitCell = project.Definitions.PeriodicStructures.UnitCells:AddUnitCell(properties) +-- Retrive an existing unit cell +unitCell1 = project.Definitions.PeriodicStructures.UnitCells:Item("UnitCell1") +Inheritance +The UnitCellCollection object is derived from the Object object. +Property List +Count +Label +Type +The number of UnitCell items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddUnitCell (properties table) +Add a new unit cell definition using table of properties. (Returns a UnitCell object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the UnitCell for the given index in the collection. (Returns a UnitCell object.) +Item (label string) +Returns the UnitCell for the given label in the collection. (Returns a UnitCell object.) +Items () +Returns a table of UnitCell items. (Returns a UnsupportedType(List of UnitCell) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of UnitCell items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddUnitCell (properties table) +Add a new unit cell definition using table of properties. +Input Parameters +properties(table) +The table of properties. +Return +UnitCell +The unit cell. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the UnitCell for the given index in the collection. +Input Parameters +index(number) +The index of the UnitCell. +Return +UnitCell +The item in the collection +Item (label string) +Returns the UnitCell for the given label in the collection. +Input Parameters +label(string) +The label of the UnitCell. +Return +UnitCell +The item in the collection +Altair Feko 2022.3 +2 Application Programming Interface (API) +Items () +Returns a table of UnitCell items. +Return +UnsupportedType(List of UnitCell) +The list of items in the collection +SetProperties (properties Object) +p.2684 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +VariableCollection +A collection of variables in the model. +Example +p.2685 +application = cf.Application.GetInstance() +project = application:NewProject() + -- List all predefined variables in the application with their expressions +for key,var in pairs(project.Definitions.Variables) do + print(tostring(var).." = "..var.Expression) +end +Inheritance +The VariableCollection object is derived from the Object object. +Usage locations +The VariableCollection object can be accessed from the following locations: +• Collection lists +◦ ModelDefinitions object has collection Variables. +Property List +Count +Label +Type +The number of Variable items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (expression table) +Create a variable from the given expression. (Returns a Variable object.) +Add (name string, expression Expression) +Create a variable from the given expression. (Returns a Variable object.) +Add (name string, expression Expression, description string) +Create a variable from the given expression. (Returns a Variable object.) +Add (name string, other Variable) +Create a variable using another variable's label as expression. (Returns a Variable object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2686 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Variable for the given index in the collection. (Returns a Variable object.) +Item (label string) +Returns the Variable for the given label in the collection. (Returns a Variable object.) +Items () +Returns a table of Variable items. (Returns a UnsupportedType(List of Variable) object.) +SetExpressions (variablelist Map) +Change the expressions for several variables simultaneously. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Variable items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (expression table) +Create a variable from the given expression. +Input Parameters +expression(table) +The variable expression. +Return +Variable +Returns a Variable object. +Add (name string, expression Expression) +Create a variable from the given expression. +Input Parameters +name(string) +The variable name. +expression(Expression) +The variable expression. +Return +Variable +The new variable. +Add (name string, expression Expression, description string) +Create a variable from the given expression. +Input Parameters +name(string) +The variable name. +expression(Expression) +The variable expression. +description(string) +The variable description. +Return +Variable +The new variable. +Add (name string, other Variable) +Create a variable using another variable's label as expression. +Input Parameters +name(string) +The variable name. +other(Variable) +The other variable. +Return +Variable +The new variable. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Variable for the given index in the collection. +Input Parameters +index(number) +The index of the Variable. +Return +Variable +The item in the collection +Item (label string) +Returns the Variable for the given label in the collection. +Input Parameters +label(string) +The label of the Variable. +Return +Variable +The item in the collection +Items () +Returns a table of Variable items. +Return +UnsupportedType(List of Variable) +The list of items in the collection +SetExpressions (variablelist Map) +Change the expressions for several variables simultaneously. +Input Parameters +variablelist(Map) +The map of variable names with the updated expressions. +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +WindscreenCollection +A collection of windscreens. +Example +p.2690 +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create dielectric to be used for the windscreens +dielectric = project.Definitions.Media.Dielectric:AddDielectric() +layeredDielectric1 = + project.Definitions.Media.LayeredDielectric:AddLayeredDielectric({0.1}, + {dielectric}) +layeredDielectric2 = + project.Definitions.Media.LayeredDielectric:AddLayeredDielectric({0.3}, + {dielectric}) + -- Create some windscreen media +windscreen1 = + project.Definitions.Media.Windscreen:AddWindscreen(layeredDielectric1, 0.1) +windscreen2 = + project.Definitions.Media.Windscreen:AddWindscreen(layeredDielectric2, 0.4) +Inheritance +The WindscreenCollection object is derived from the Object object. +Usage locations +The WindscreenCollection object can be accessed from the following locations: +• Collection lists +◦ Media object has collection Windscreen. +Property List +Count +Label +Type +The number of Windscreen items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +AddWindscreen (properties table) +Create a windscreen medium from a table defining the properties. (Returns a Windscreen object.) +AddWindscreen (medium LayeredIsotropicDielectric, offset Expression) +Create a windscreen medium. (Returns a Windscreen object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Windscreen for the given index in the collection. (Returns a Windscreen object.) +Item (label string) +Returns the Windscreen for the given label in the collection. (Returns a Windscreen object.) +Items () +Returns a table of Windscreen items. (Returns a UnsupportedType(List of Windscreen) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Windscreen items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +AddWindscreen (properties table) +Create a windscreen medium from a table defining the properties. +Input Parameters +properties(table) +A table of properties defining the new windscreen medium. +Return +Windscreen +The windscreen medium. +AddWindscreen (medium LayeredIsotropicDielectric, offset Expression) +Create a windscreen medium. +Input Parameters +medium(LayeredIsotropicDielectric) +The layered dielectric contained in the windscreen layers. +offset(Expression) +The distance (in the model unit) from the windscreen curvature reference to the top of +layer 1. +Return +Windscreen +The windscreen medium. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Windscreen for the given index in the collection. +Input Parameters +index(number) +The index of the Windscreen. +Return +Windscreen +The item in the collection +Item (label string) +Returns the Windscreen for the given label in the collection. +Input Parameters +label(string) +The label of the Windscreen. +Return +Windscreen +The item in the collection +Items () +Returns a table of Windscreen items. +Return +UnsupportedType(List of Windscreen) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +WireCollection +A collection of wires. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Create geometry which contains wires +polyline = + project.Contents.Geometry:AddPolyline({cf.Point(0, 0, 0), cf.Point(1, 1, 1), cf.Point(0, 1, 0)}) + -- Set the local mesh size of each wire +for key,value in pairs(polyline.Wires) do + value.LocalMeshSize = 0.1 +end +Inheritance +The WireCollection object is derived from the TopologyEntityCollectionOf_Edge object. +Usage locations +The WireCollection object can be accessed from the following locations: +• Collection lists +◦ Geometry object has collection Wires. +◦ SpiralCross object has collection Wires. +◦ Ring object has collection Wires. +◦ OpenRing object has collection Wires. +◦ SplitRing object has collection Wires. +◦ Cross object has collection Wires. +◦ StripCross object has collection Wires. +◦ Trifilar object has collection Wires. +◦ AnalyticalCurve object has collection Wires. +◦ BezierCurve object has collection Wires. +◦ Cone object has collection Wires. +◦ ConstrainedSurface object has collection Wires. +◦ Cuboid object has collection Wires. +◦ Cylinder object has collection Wires. +◦ Ellipse object has collection Wires. +◦ EllipticArc object has collection Wires. +◦ FittedSpline object has collection Wires. +◦ Flare object has collection Wires. +◦ Helix object has collection Wires. +◦ Hexagon object has collection Wires. +◦ StripHexagon object has collection Wires. +◦ HyperbolicArc object has collection Wires. +◦ +◦ +ImprintPoints object has collection Wires. +Intersect object has collection Wires. +◦ Loft object has collection Wires. +◦ PathSweep object has collection Wires. +◦ ProjectGeometry object has collection Wires. +◦ RepairAndSewFaces object has collection Wires. +◦ RepairPart object has collection Wires. +◦ Spin object has collection Wires. +◦ Split object has collection Wires. +◦ Stitch object has collection Wires. +◦ Subtract object has collection Wires. +◦ Sweep object has collection Wires. +◦ Union object has collection Wires. +◦ Simplify object has collection Wires. +◦ Line object has collection Wires. +◦ NurbsSurface object has collection Wires. +◦ ParabolicArc object has collection Wires. +◦ Paraboloid object has collection Wires. +◦ Polygon object has collection Wires. +◦ Polyline object has collection Wires. +◦ Primitive object has collection Wires. +◦ Rectangle object has collection Wires. +◦ Sphere object has collection Wires. +◦ AbstractSurfaceCurve object has collection Wires. +◦ SurfaceBezierCurve object has collection Wires. +◦ SurfaceLine object has collection Wires. +◦ SurfaceRegularLines object has collection Wires. +◦ TCross object has collection Wires. +Property List +Count +Label +The number of Edge items in the collection. (Read only number) +The object label. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Method List +Delete () +Deletes the entity. +Duplicate () +p.2696 +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Edge for the given index in the collection. (Returns a Edge object.) +Item (label string) +Returns the Edge for the given label in the collection. (Returns a Edge object.) +Items () +Returns a table of Edge items. (Returns a UnsupportedType(List of Edge) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Edge items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Edge for the given index in the collection. +Input Parameters +index(number) +The index of the Edge. +Return +Edge +The item in the collection +Item (label string) +Returns the Edge for the given label in the collection. +Input Parameters +label(string) +The label of the Edge. +Return +Edge +The item in the collection +Altair Feko 2022.3 +2 Application Programming Interface (API) +Items () +Returns a table of Edge items. +Return +UnsupportedType(List of Edge) +The list of items in the collection +SetProperties (properties Object) +p.2698 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +WorkSurfaceCollection +A collection of work surfaces in the model. +Example +p.2699 +application = cf.Application.GetInstance() +project = application:NewProject() +cylinder = project.Contents.Geometry:AddCylinder(cf.Cylinder.GetDefaultProperties()) + -- Add work surfaces around the cylinder at three intervals +project.Definitions.WorkSurfaces:Add(cylinder.Faces["Face3"], 0) +project.Definitions.WorkSurfaces:Add(cylinder.Faces["Face3"], 0.5) +project.Definitions.WorkSurfaces:Add(cylinder.Faces["Face3"], 1) + -- Remove the first work surface from the collection of work surfaces +project.Definitions.WorkSurfaces[1]:Delete() +Inheritance +The WorkSurfaceCollection object is derived from the Object object. +Usage locations +The WorkSurfaceCollection object can be accessed from the following locations: +• Collection lists +◦ ModelDefinitions object has collection WorkSurfaces. +Property List +Count +Label +Type +The number of WorkSurface items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Create a work surface using the table of properties. (Returns a WorkSurface object.) +Add (referenceface Face, offset Expression) +Create a work surface with the specified face. (Returns a WorkSurface object.) +Add (label string, referenceface Face, offset Expression) +Create a work surface with the specified label. (Returns a WorkSurface object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the WorkSurface for the given index in the collection. (Returns a WorkSurface object.) +Item (label string) +Returns the WorkSurface for the given label in the collection. (Returns a WorkSurface object.) +Items () +Returns a table of WorkSurface items. (Returns a UnsupportedType(List of WorkSurface) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of WorkSurface items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Create a work surface using the table of properties. +Input Parameters +properties(table) +The table of properties. +Return +WorkSurface +The work surface. +Add (referenceface Face, offset Expression) +Create a work surface with the specified face. +Input Parameters +referenceface(Face) +The reference face to use. +offset(Expression) +The offset from the reference face. +Return +WorkSurface +The work surface. +Add (label string, referenceface Face, offset Expression) +Create a work surface with the specified label. +Input Parameters +label(string) +The label for the work surface. +referenceface(Face) +The reference face to use. +offset(Expression) +The offset from the reference face. +Return +WorkSurface +The work surface. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Object +The new (duplicated) entity. +GetProperties () +p.2702 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the WorkSurface for the given index in the collection. +Input Parameters +index(number) +The index of the WorkSurface. +Return +WorkSurface +The item in the collection +Item (label string) +Returns the WorkSurface for the given label in the collection. +Input Parameters +label(string) +The label of the WorkSurface. +Return +WorkSurface +The item in the collection +Items () +Returns a table of WorkSurface items. +Return +UnsupportedType(List of WorkSurface) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +p.2703 +Altair Feko 2022.3 +2 Application Programming Interface (API) +WorkplaneCollection +A collection of workplanes in the model. +Example +application = cf.Application.GetInstance() +project = application:NewProject() + -- Add two saved workplanes to the collection +p.2704 +wp1 = + project.Definitions.Workplanes:Add(cf.Point(1, 1, 1), cf.Point(1, 0, 0), cf.Point(0, 0, 1)) +wp2 = + project.Definitions.Workplanes:Add(cf.Point(0, 0, -1), cf.Point(0, 1, 0), cf.Point(0, 0, 1)) + -- Get the current default workplane +wpDefault = project.Definitions.Workplanes.DefaultWorkplane +Inheritance +The WorkplaneCollection object is derived from the Object object. +Usage locations +The WorkplaneCollection object can be accessed from the following locations: +• Collection lists +◦ ModelDefinitions object has collection Workplanes. +Property List +Count +Label +Type +The number of Workplane items in the collection. (Read only number) +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Add (properties table) +Create a workplane using a table of properties. (Returns a Workplane object.) +Add (origin Point, uvector Point, vvector Point) +Create a workplane with the given parameters. (Returns a Workplane object.) +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. (Returns a Object object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2705 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Item (index number) +Returns the Workplane for the given index in the collection. (Returns a Workplane object.) +Item (label string) +Returns the Workplane for the given label in the collection. (Returns a Workplane object.) +Items () +Returns a table of Workplane items. (Returns a UnsupportedType(List of Workplane) object.) +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Static Function List +GetDefaultProperties () +Creates a table containing the default settings to create an object. (Returns a table object.) +Property Details +Count +The number of Workplane items in the collection. +Type +number +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (properties table) +Create a workplane using a table of properties. +Input Parameters +properties(table) +The table of properties defining the workplane. +Return +Workplane +The new workplane. +Add (origin Point, uvector Point, vvector Point) +Create a workplane with the given parameters. +Input Parameters +origin(Point) +Origin coordinate. +uvector(Point) +U vector coordinate. +vvector(Point) +V vector coordinate. +Return +Workplane +The workplane. +Delete () +Deletes the entity. +Duplicate () +Duplicates the entity. +Return +Object +The new (duplicated) entity. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A table defining the properties. +Item (index number) +Returns the Workplane for the given index in the collection. +Input Parameters +index(number) +The index of the Workplane. +Return +Workplane +The item in the collection +Item (label string) +Returns the Workplane for the given label in the collection. +Input Parameters +label(string) +The label of the Workplane. +Return +Workplane +The item in the collection +Items () +Returns a table of Workplane items. +Return +UnsupportedType(List of Workplane) +The list of items in the collection +SetProperties (properties Object) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(Object) +A table of properties defining the new state of the object. +Static Function Details +GetDefaultProperties () +Creates a table containing the default settings to create an object. +Return +table +A table containing the default properties. +2.1.3 Namespaces and Static Functions +Many objects have static functions, but only a limited number of functions are available directly in the +application namespace (cf) or sub-namespace. +Namespace List +cf +The namespace that contains all of the application namespaces, objects, functions, collections, +enumerations and constants. +Altair Feko 2022.3 +2 Application Programming Interface (API) +The cf namespace +p.2709 +Many objects have static functions, but only a limited number of functions are available directly in the cf +namespace. Numerous namespaces exist under the cf namespace that also contain static functions. +2.1.4 Enumeration Types (API) +Enumerations are lists of values that can be used. The enumerations CADFEKO are available under the +cf namespace and grouped together under enums. +• AdvancedSolverTypeEnum +• AnalyticalCurveDefinitionMethodEnum +• ApproximationMethodEnum +• BasisFunctionAccuracyEnum +• BoundaryFaceDefinitionEnum +• BoundaryFacePropertiesEnum +• BoxSizeSpecificationTypeEnum +• CableBundleShieldTypeEnum +• CableBundleTwistDirectionEnum +• CableCoaxialDefinitionEnum +• CableConnectorPositionDefinitionEnum +• CableHarnessCouplingEnum +• CableHarnessSchematicProjectionMethodEnum +• CableHarnessSolutionMethodEnum +• CablePerUnitLengthAccuracyEnum +• CablePredefinedCoaxialTypeEnum +• CableProbeLocationTypeEnum +• CableProbeTypeEnum +• CableShieldAdmittanceDefinitionEnum +• CableShieldDefinitionEnum +• CableShieldInterpolationMethodEnum +• CableShieldLayerOptionsEnum +• CableShieldStretchingOptimisationMethodEnum +• CableShieldSurfaceImpedanceFrequencyDefinitionSourceEnum +• CableShieldTransferAdmittanceFrequencyDefinitionSourceEnum +• CableShieldTransferImpedanceFrequencyDefinitionSourceEnum +• CableShieldWeaveDefinitionMethodEnum +• CableSpiceNetworkSourceTypeEnum +• CableTransformerPhaseDefinitionEnum +• ComplexLoadTypeEnum +• ConeDefinitionMethodEnum +• ConstrainedSurfSymmetryPlaneConstParamEnum +• ConstrainedSurfSymmetryPlaneEnum +• CuboidDefinitionMethodEnum +• CurrentsScopeTypeEnum +• CylinderDefinitionMethodEnum +• EdgePortGroundConnectionEnum +• EdgeSolutionMethodEnum +• ElementDistributionEnum +• EllipticArcDefinitionMethodEnum +• EllipticArcMajorAxisDirectionEnum +• ErrorEstimationCalculationScopeEnum +• ExportACISVersionEnum +• ExportCATIAV5VersionEnum +• ExportGeometryFileFormatEnum +• ExportMeshFileFormatEnum +• ExportMeshTypeEnum +• ExportParasolidVersionEnum +• FEMElementOrderEnum +• FEMLineMeshPortDefinitionMethodEnum +• FEMLinePortDefinitionMethodEnum +• FEMModalMeshPortDefinitionMethodEnum +• FEMModalPortDefinitionMethodEnum +• FaceAbsorptionTypeEnum +• FaceSolutionMethodEnum +• FacetedUTDAccelerationEnum +• FactorisationTypeEnum +• FarFieldCalculationDirectionEnum +• FarFieldCoordinateSystemEnum +• FarFieldDataFileTypeEnum +• FarFieldRequestTypeEnum +• FieldCalculationScopeTypeEnum +• FieldDataFileImportDefinitionEnum +• FillHoleBoundaryTransitionTypeEnum +• FillHolePatchTopologyTypeEnum +• FlareDefinitionMethodEnum +• FormLayoutEnum +• FormSeparatorEnum +• FrequencyConvergenceAccuracyTypeEnum +• FrequencyExportSamplingTypeEnum +• FrequencyFDTDTimeIntervalTypeEnum +• FrequencyRangeTypeEnum +• GeneralNetworkDataTypeEnum +• GeneralNetworkSPICEPortReferenceEnum +• GeneralNetworkSourceEnum +• GeometryEdgeEnum +• GroundBottomTypeEnum +• GroundPlaneDefinitionMethodEnum +• HOBFElementOrderEnum +• HelixDefinitionMethodEnum +• HighFrequencyPOMoMCouplingTypeEnum +• HyperbolicArcDefinitionMethodEnum +• ImageSizeEnum +• ImportHealingTypeEnum +• ImportMeshConversionTypeEnum +• ImportMeshFileFormatEnum +• ImpressedCurrentClosestVertexTypeEnum +• IntegralEquationTypeEnum +• LibraryMediumSourceEnum +• LibraryMediumTypeEnum +• LoadTypeEnum +• LoopedPlaneWaveCompressionEnum +• LowFrequencyStabilisationModeEnum +• MLFMMFarFieldCalculationMethodEnum +• MLFMMNearFieldCalculationMethodEnum +• MagneticDipoleCurrentTypeEnum +• MagnetostaticFieldDirectionEnum +• MediumDielectricConductivityTypeEnum +• MediumDielectricDefinitionMethodEnum +• MediumImpedanceDefinitionMethodEnum +• MediumMagneticDefinitionMethodEnum +• MediumMetallicDefinitionMethodEnum +• MediumSourceDefinitionMethodEnum +• MeshCurvilinearOptionsEnum +• MeshSizeOptionEnum +• MeshSmallGeometryOptionsEnum +• MeshVoxelAspectRatioOptionsEnum +• MeshVoxelGrowthRateOptionsEnum +• MeshVoxelSmallGeometryOptionsEnum +• MirrorPlaneEnum +• ModelDecompositionScopeTypeEnum +• ModelSolutionSolveTypeEnum +• ModelSymmetryTypeEnum +• ModelUnitEnum +• NGFControlTypeEnum +• NearFieldCalculationTypeEnum +• NearFieldDataCoordinateTypeEnum +• NearFieldDataFileStructureDataTypeEnum +• NearFieldDataFullImportDataTypeEnum +• NearFieldDataReferencePointEnum +• NearFieldDataSourceTypeEnum +• NearFieldDefinitionMethodEnum +• NearFieldPotentialTypeEnum +• NearFieldReceivingAntennaDataTypeEnum +• OptimisationCombineTypeEnum +• OptimisationConstraintRelationEnum +• OptimisationConvergenceAccuracyEnum +• OptimisationFarFieldFocusTypeEnum +• OptimisationFarFieldPolarisationTypeEnum +• OptimisationFocusSourceTypeEnum +• OptimisationGoalOperatorEnum +• OptimisationGoalProcessingStepsEnum +• OptimisationImpedanceFocusTypeEnum +• OptimisationMethodTypeEnum +• OptimisationNearFieldCoordSystemEnum +• OptimisationNearFieldDirectComponentEnum +• OptimisationNearFieldFocusTypeEnum +• OptimisationPowerFocusTypeEnum +• OptimisationRandomNumberGenerationOptionEnum +• OptimisationReceivingAntennaFocusTypeEnum +• OptimisationSARFocusTypeEnum +• OptimisationSParameterFocusTypeEnum +• OptimisationTargetValueTypeEnum +• OptimisationTransmissionReflectionFocusTypeEnum +• OptimisationTransmissionReflectionPolarisationTypeEnum +• OutputFileSettingsEnum +• PCBImportTypeEnum +• ParabolicArcDefinitionMethodEnum +• ParallelAuthenticationMethodEnum +• ParasolidExportFileFormatEnum +• ParasolidTopologyTypeEnum +• PathSweepAlignmentEnum +• PeriodicBoundaryDimensionsEnum +• PeriodicBoundaryPhaseShiftMethodEnum +• PlaneGridEnum +• PlaneWaveDefinitionMethodEnum +• PlaneWavePolarityTypeEnum +• PointSpecificationEnum +• PowerScaleSettingsEnum +• PrecisionSettingsEnum +• PreconditionerTypeEnum +• ProcessPriorityTypeEnum +• RLGOConvergenceAccuracyTypeEnum +• RLGOIncrementTypeEnum +• RectangleDefinitionMethodEnum +• RegionDefinitionMethodEnum +• RegionSolutionMethodEnum +• RemoteExecutionMethodEnum +• RenderingSpeedOptionsEnum +• RepairSearchEnum +• SARCalculationTypeEnum +• SARMediumSelectEnum +• SARRegionTypeEnum +• SParameterWaveguideModeTypeEnum +• SamplingPointDensityEnum +• SimplifyBlendTypeEnum +• SphericalModeDataIndexSchemeMethodEnum +• SphericalModeDataPropagationDirectionMethodEnum +• SphericalModeDataTeTmTypeMethodEnum +• SpheroidDefinitionMethodEnum +• SplitPlanesEnum +• SurfaceCoatingTypeEnum +• SurfaceRegularLinesConstantParameterEnum +• SurfaceRegularLinesSpacingMethodEnum +• TensorDescriptionMethodEnum +• TransmissionLineDefinitionMethodEnum +• TwistDirectionEnum +• UTDRayContributionsTypeEnum +• UnitCellLayerMethodTypeEnum +• UnitCellReferenceVectorEnum +• UnlinkMeshOptionEnum +• ViewDirectionEnum +• ViewDisplayModeEnum +• ViewModelColourStyleEnum +• WaveguidePortReferenceDirectionRotationEnum +• WaveguideSourceDefinitionTypeEnum +• WindscreenElementTypeEnum +• WirePortDefinitionMethodEnum +• WirePortLocationEnum +Altair Feko 2022.3 +2 Application Programming Interface (API) +AdvancedSolverTypeEnum +Enumeration Option List +The AdvancedSolverTypeEnum enumeration is accessed as illustrated below. +cf.Enums.AdvancedSolverTypeEnum. +p.2716 +Default +Default +DirectSparse +DirectSparse +Iterative +Iterative +AnalyticalCurveDefinitionMethodEnum +Enumeration Option List +The AnalyticalCurveDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.AnalyticalCurveDefinitionMethodEnum. +Cartesian +Cartesian +Cylindrical +Cylindrical +Spherical +Spherical +Altair Feko 2022.3 +2 Application Programming Interface (API) +ApproximationMethodEnum +Enumeration Option List +The ApproximationMethodEnum enumeration is accessed as illustrated below. +cf.Enums.ApproximationMethodEnum. +FarFieldApproximation +FarFieldApproximation +SphericalModesApproximation +SphericalModesApproximation +p.2718 +Altair Feko 2022.3 +2 Application Programming Interface (API) +BasisFunctionAccuracyEnum +Enumeration Option List +The BasisFunctionAccuracyEnum enumeration is accessed as illustrated below. +cf.Enums.BasisFunctionAccuracyEnum. +p.2719 +High +Low +High +Low +Normal +Normal +Altair Feko 2022.3 +2 Application Programming Interface (API) +BoundaryFaceDefinitionEnum +Enumeration Option List +The BoundaryFaceDefinitionEnum enumeration is accessed as illustrated below. +cf.Enums.BoundaryFaceDefinitionEnum. +p.2720 +Open +Open +PEC +PMC +PEC +PMC +Altair Feko 2022.3 +2 Application Programming Interface (API) +BoundaryFacePropertiesEnum +Enumeration Option List +The BoundaryFacePropertiesEnum enumeration is accessed as illustrated below. +cf.Enums.BoundaryFacePropertiesEnum. +p.2721 +Auto +Auto +NoBuffer +NoBuffer +SpecifyBufferSize +SpecifyBufferSize +SpecifyPosition +SpecifyPosition +Altair Feko 2022.3 +2 Application Programming Interface (API) +BoxSizeSpecificationTypeEnum +Enumeration Option List +The BoxSizeSpecificationTypeEnum enumeration is accessed as illustrated below. +cf.Enums.BoxSizeSpecificationTypeEnum. +p.2722 +Default +Default +SpecifiedManually +SpecifiedManually +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableBundleShieldTypeEnum +Enumeration Option List +The CableBundleShieldTypeEnum enumeration is accessed as illustrated below. +cf.Enums.CableBundleShieldTypeEnum. +p.2723 +InBackgroundMedium +InBackgroundMedium +InDielectricNoShield +InDielectricNoShield +InDielectricWithShield +InDielectricWithShield +SheathInBackgroundMedium +SheathInBackgroundMedium +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableBundleTwistDirectionEnum +Enumeration Option List +The CableBundleTwistDirectionEnum enumeration is accessed as illustrated below. +cf.Enums.CableBundleTwistDirectionEnum. +p.2724 +LeftHanded +LeftHanded +NoTwist +NoTwist +RightHanded +RightHanded +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableCoaxialDefinitionEnum +Enumeration Option List +The CableCoaxialDefinitionEnum enumeration is accessed as illustrated below. +cf.Enums.CableCoaxialDefinitionEnum. +p.2725 +Predefined +Predefined +SpecifyCharacteristics +SpecifyCharacteristics +SpecifyDimensions +SpecifyDimensions +CableConnectorPositionDefinitionEnum +Enumeration Option List +The CableConnectorPositionDefinitionEnum enumeration is accessed as illustrated below. +cf.Enums.CableConnectorPositionDefinitionEnum. +Coordinate +Coordinate +PathTerminal +PathTerminal +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableHarnessCouplingEnum +Enumeration Option List +The CableHarnessCouplingEnum enumeration is accessed as illustrated below. +cf.Enums.CableHarnessCouplingEnum. +p.2727 +CircuitCrosstalk +CircuitCrosstalk +Irradiating +Irradiating +Radiating +Radiating +RadiatingWithIrradiating +RadiatingWithIrradiating +CableHarnessSchematicProjectionMethodEnum +Enumeration Option List +The CableHarnessSchematicProjectionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.CableHarnessSchematicProjectionMethodEnum. +XYPlane +XYPlane +XZPlane +XZPlane +YZPlane +YZPlane +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableHarnessSolutionMethodEnum +Enumeration Option List +The CableHarnessSolutionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.CableHarnessSolutionMethodEnum. +p.2729 +MTL +MoM +MTL +MoM +Altair Feko 2022.3 +2 Application Programming Interface (API) +CablePerUnitLengthAccuracyEnum +Enumeration Option List +The CablePerUnitLengthAccuracyEnum enumeration is accessed as illustrated below. +cf.Enums.CablePerUnitLengthAccuracyEnum. +p.2730 +High +High +Normal +Normal +VeryHigh +VeryHigh +Altair Feko 2022.3 +2 Application Programming Interface (API) +CablePredefinedCoaxialTypeEnum +Enumeration Option List +The CablePredefinedCoaxialTypeEnum enumeration is accessed as illustrated below. +cf.Enums.CablePredefinedCoaxialTypeEnum. +p.2731 +M17_113_RG316 +M17_113_RG316 +M17_75_RG214 +M17_75_RG214 +M17_84_RG223 +M17_84_RG223 +M17_94_RG179 +M17_94_RG179 +RG11_A_U +RG11_A_U +RG142_B_U +RG142_B_U +RG174_U +RG174_U +RG179_U +RG179_U +RG180_B_U +RG180_B_U +RG213_U +RG213_U +RG214_U +RG214_U +RG217_U +RG217_U +RG223_U +RG223_U +RG316_U +RG316_U +RG393_U +RG393_U +RG58_C_U +RG58_C_U +RG59_B_U +RG59_B_U +RG62_U +RG62_U +RG63_B_U +RG63_B_U +RG71_B_U +RG71_B_U +SS402 +SS402 +SS405 +SS405 +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableProbeLocationTypeEnum +Enumeration Option List +The CableProbeLocationTypeEnum enumeration is accessed as illustrated below. +cf.Enums.CableProbeLocationTypeEnum. +p.2733 +DistanceOnPath +DistanceOnPath +PercentageOnPath +PercentageOnPath +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableProbeTypeEnum +Enumeration Option List +The CableProbeTypeEnum enumeration is accessed as illustrated below. +cf.Enums.CableProbeTypeEnum. +p.2734 +Current +Current +CurrentAndVoltage +CurrentAndVoltage +Voltage +Voltage +CableShieldAdmittanceDefinitionEnum +Enumeration Option List +The CableShieldAdmittanceDefinitionEnum enumeration is accessed as illustrated below. +cf.Enums.CableShieldAdmittanceDefinitionEnum. +Custom +Custom +SameAsImpedanceDefinition +SameAsImpedanceDefinition +TransferCapacitance +TransferCapacitance +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableShieldDefinitionEnum +Enumeration Option List +The CableShieldDefinitionEnum enumeration is accessed as illustrated below. +cf.Enums.CableShieldDefinitionEnum. +p.2736 +BraidedDemoulin +BraidedDemoulin +BraidedKley +BraidedKley +BraidedTyni +BraidedTyni +BraidedVance +BraidedVance +Custom +Custom +Solid +Solid +CableShieldInterpolationMethodEnum +Enumeration Option List +The CableShieldInterpolationMethodEnum enumeration is accessed as illustrated below. +cf.Enums.CableShieldInterpolationMethodEnum. +Constant +Constant +Default +Default +Linear +Linear +Rational +Rational +Spline +Spline +Altair Feko 2022.3 +2 Application Programming Interface (API) +CableShieldLayerOptionsEnum +Enumeration Option List +The CableShieldLayerOptionsEnum enumeration is accessed as illustrated below. +cf.Enums.CableShieldLayerOptionsEnum. +p.2738 +DoubleLayer +DoubleLayer +SingleLayer +SingleLayer +CableShieldStretchingOptimisationMethodEnum +Enumeration Option List +The CableShieldStretchingOptimisationMethodEnum enumeration is accessed as illustrated below. +cf.Enums.CableShieldStretchingOptimisationMethodEnum. +MaximiseOpticalCoverage +MaximiseOpticalCoverage +SpecifyManually +SpecifyManually +CableShieldSurfaceImpedanceFrequencyDefinitionSourceEnum +Enumeration Option List +The CableShieldSurfaceImpedanceFrequencyDefinitionSourceEnum enumeration is accessed as +illustrated below. +cf.Enums.CableShieldSurfaceImpedanceFrequencyDefinitionSourceEnum. +FromFile +FromFile +LowFrequencyBraidApproximation +LowFrequencyBraidApproximation +SolidMetal +SolidMetal +SpecifyManually +SpecifyManually +CableShieldTransferAdmittanceFrequencyDefinitionSourceEnum +Enumeration Option List +The CableShieldTransferAdmittanceFrequencyDefinitionSourceEnum enumeration is accessed as +illustrated below. +cf.Enums.CableShieldTransferAdmittanceFrequencyDefinitionSourceEnum. +FromFile +FromFile +Manually +Manually +CableShieldTransferImpedanceFrequencyDefinitionSourceEnum +Enumeration Option List +The CableShieldTransferImpedanceFrequencyDefinitionSourceEnum enumeration is accessed as +illustrated below. +cf.Enums.CableShieldTransferImpedanceFrequencyDefinitionSourceEnum. +FromFile +FromFile +Manually +Manually +CableShieldWeaveDefinitionMethodEnum +Enumeration Option List +The CableShieldWeaveDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.CableShieldWeaveDefinitionMethodEnum. +DefinedWithOpticalCoverage +DefinedWithOpticalCoverage +DefinedWithWeaveAngle +DefinedWithWeaveAngle +CableSpiceNetworkSourceTypeEnum +Enumeration Option List +The CableSpiceNetworkSourceTypeEnum enumeration is accessed as illustrated below. +cf.Enums.CableSpiceNetworkSourceTypeEnum. +File +File +Manual +Manual +CableTransformerPhaseDefinitionEnum +Enumeration Option List +The CableTransformerPhaseDefinitionEnum enumeration is accessed as illustrated below. +cf.Enums.CableTransformerPhaseDefinitionEnum. +InPhase +InPhase +OutOfPhase +OutOfPhase +Altair Feko 2022.3 +2 Application Programming Interface (API) +ComplexLoadTypeEnum +Enumeration Option List +The ComplexLoadTypeEnum enumeration is accessed as illustrated below. +cf.Enums.ComplexLoadTypeEnum. +Complex +Complex +SinglePortTouchstone +SinglePortTouchstone +p.2746 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ConeDefinitionMethodEnum +Enumeration Option List +The ConeDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.ConeDefinitionMethodEnum. +p.2747 +AngleAndHeight +AngleAndHeight +AngleAndTopCentre +AngleAndTopCentre +TopRadiusAndHeight +TopRadiusAndHeight +TopRadiusAndTopCentre +TopRadiusAndTopCentre +ConstrainedSurfSymmetryPlaneConstParamEnum +Enumeration Option List +The ConstrainedSurfSymmetryPlaneConstParamEnum enumeration is accessed as illustrated below. +cf.Enums.ConstrainedSurfSymmetryPlaneConstParamEnum. +ConstrainedSurfSymmetryPlaneEnum +Enumeration Option List +The ConstrainedSurfSymmetryPlaneEnum enumeration is accessed as illustrated below. +cf.Enums.ConstrainedSurfSymmetryPlaneEnum. +UN +UV +VN +UN +UV +VN +Altair Feko 2022.3 +2 Application Programming Interface (API) +CuboidDefinitionMethodEnum +Enumeration Option List +The CuboidDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.CuboidDefinitionMethodEnum. +p.2750 +BaseAtCentre +BaseAtCentre +BaseAtCorner +BaseAtCorner +Altair Feko 2022.3 +2 Application Programming Interface (API) +CurrentsScopeTypeEnum +Enumeration Option List +The CurrentsScopeTypeEnum enumeration is accessed as illustrated below. +cf.Enums.CurrentsScopeTypeEnum. +p.2751 +AllCurrents +AllCurrents +SegmentCurrents +SegmentCurrents +SpecifiedEntities +SpecifiedEntities +TriangleCurrents +TriangleCurrents +Altair Feko 2022.3 +2 Application Programming Interface (API) +CylinderDefinitionMethodEnum +Enumeration Option List +The CylinderDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.CylinderDefinitionMethodEnum. +p.2752 +Height +Height +TopCoordinate +TopCoordinate +Altair Feko 2022.3 +2 Application Programming Interface (API) +EdgePortGroundConnectionEnum +Enumeration Option List +The EdgePortGroundConnectionEnum enumeration is accessed as illustrated below. +cf.Enums.EdgePortGroundConnectionEnum. +p.2753 +NegativeTerminal +NegativeTerminal +PositiveTerminal +PositiveTerminal +Altair Feko 2022.3 +2 Application Programming Interface (API) +EdgeSolutionMethodEnum +Enumeration Option List +The EdgeSolutionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.EdgeSolutionMethodEnum. +p.2754 +None +None +Windscreen +Windscreen +Altair Feko 2022.3 +2 Application Programming Interface (API) +ElementDistributionEnum +Enumeration Option List +The ElementDistributionEnum enumeration is accessed as illustrated below. +cf.Enums.ElementDistributionEnum. +p.2755 +Specified +Specified +Uniform +Uniform +Altair Feko 2022.3 +2 Application Programming Interface (API) +EllipticArcDefinitionMethodEnum +Enumeration Option List +The EllipticArcDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.EllipticArcDefinitionMethodEnum. +p.2756 +ApertureCentrePoint +ApertureCentrePoint +EllipseCentrePoint +EllipseCentrePoint +Altair Feko 2022.3 +2 Application Programming Interface (API) +EllipticArcMajorAxisDirectionEnum +Enumeration Option List +The EllipticArcMajorAxisDirectionEnum enumeration is accessed as illustrated below. +cf.Enums.EllipticArcMajorAxisDirectionEnum. +p.2757 +ErrorEstimationCalculationScopeEnum +Enumeration Option List +The ErrorEstimationCalculationScopeEnum enumeration is accessed as illustrated below. +cf.Enums.ErrorEstimationCalculationScopeEnum. +AllMeshElements +AllMeshElements +OnlySegments +OnlySegments +OnlyTetrahedra +OnlyTetrahedra +OnlyTriangles +OnlyTriangles +SpecifiedEntities +SpecifiedEntities +Altair Feko 2022.3 +2 Application Programming Interface (API) +ExportACISVersionEnum +Enumeration Option List +The ExportACISVersionEnum enumeration is accessed as illustrated below. +cf.Enums.ExportACISVersionEnum. +p.2759 +Latest +Latest +v18 +v19 +v20 +v21 +v22 +v23 +v24 +v25 +v26 +v27 +v28 +v29 +v30 +v31 +v18 +v19 +v20 +v21 +v22 +v23 +v24 +v25 +v26 +v27 +v28 +v29 +v30 +v31 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ExportCATIAV5VersionEnum +Enumeration Option List +The ExportCATIAV5VersionEnum enumeration is accessed as illustrated below. +cf.Enums.ExportCATIAV5VersionEnum. +p.2760 +Latest +Latest +R15 +R16 +R17 +R18 +R19 +R20 +R21 +R22 +R23 +R24 +R25 +R26 +R27 +R28 +R29 +R15 +R16 +R17 +R18 +R19 +R20 +R21 +R22 +R23 +R24 +R25 +R26 +R27 +R28 +R29 +R30 +R31 +R30 +R31 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ExportGeometryFileFormatEnum +Enumeration Option List +The ExportGeometryFileFormatEnum enumeration is accessed as illustrated below. +cf.Enums.ExportGeometryFileFormatEnum. +p.2762 +ACIS +ACIS +CATIAV4 +CATIAV4 +CATIAV5 +CATIAV5 +IGES +IGES +Parasolid +Parasolid +STEP +STEP +Altair Feko 2022.3 +2 Application Programming Interface (API) +ExportMeshFileFormatEnum +Enumeration Option List +The ExportMeshFileFormatEnum enumeration is accessed as illustrated below. +cf.Enums.ExportMeshFileFormatEnum. +p.2763 +CADFEKOMesh +CADFEKOMesh +DXF +DXF +FekoHyperMesh +FekoHyperMesh +Gerber +Gerber +NASTRAN +NASTRAN +STL +UNV +STL +UNV +Altair Feko 2022.3 +2 Application Programming Interface (API) +ExportMeshTypeEnum +Enumeration Option List +The ExportMeshTypeEnum enumeration is accessed as illustrated below. +cf.Enums.ExportMeshTypeEnum. +ModelMesh +ModelMesh +SimulationMesh +SimulationMesh +p.2764 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ExportParasolidVersionEnum +Enumeration Option List +The ExportParasolidVersionEnum enumeration is accessed as illustrated below. +cf.Enums.ExportParasolidVersionEnum. +p.2765 +Latest +Latest +v16 +v17 +v18 +v19 +v20 +v21 +v22 +v23 +v24 +v25 +v26 +v27 +v28 +v29 +v30 +v16 +v17 +v18 +v19 +v20 +v21 +v22 +v23 +v24 +v25 +v26 +v27 +v28 +v29 +v30 +v31 +v32 +v33 +v34 +v31 +v32 +v33 +v34 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FEMElementOrderEnum +Enumeration Option List +The FEMElementOrderEnum enumeration is accessed as illustrated below. +cf.Enums.FEMElementOrderEnum. +p.2767 +Auto +First +Auto +First +Second +Second +FEMLineMeshPortDefinitionMethodEnum +Enumeration Option List +The FEMLineMeshPortDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.FEMLineMeshPortDefinitionMethodEnum. +UsingPoints +UsingPoints +UsingVertices +UsingVertices +FEMLinePortDefinitionMethodEnum +Enumeration Option List +The FEMLinePortDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.FEMLinePortDefinitionMethodEnum. +UsingEdges +UsingEdges +UsingPoints +UsingPoints +FEMModalMeshPortDefinitionMethodEnum +Enumeration Option List +The FEMModalMeshPortDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.FEMModalMeshPortDefinitionMethodEnum. +UsingPoints +UsingPoints +UsingVertices +UsingVertices +FEMModalPortDefinitionMethodEnum +Enumeration Option List +The FEMModalPortDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.FEMModalPortDefinitionMethodEnum. +UsingFaces +UsingFaces +UsingPoints +UsingPoints +Altair Feko 2022.3 +2 Application Programming Interface (API) +FaceAbsorptionTypeEnum +Enumeration Option List +The FaceAbsorptionTypeEnum enumeration is accessed as illustrated below. +cf.Enums.FaceAbsorptionTypeEnum. +p.2772 +ConsiderAllSources +ConsiderAllSources +None +None +Altair Feko 2022.3 +2 Application Programming Interface (API) +FaceSolutionMethodEnum +Enumeration Option List +The FaceSolutionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.FaceSolutionMethodEnum. +p.2773 +Aperture +Aperture +FacetedUTD +FacetedUTD +LEPOAlwaysIlluminated +LEPOAlwaysIlluminated +LEPOFrontIlluminated +LEPOFrontIlluminated +LEPOFullRayTracing +LEPOFullRayTracing +None +None +POAlwaysIlluminated +POAlwaysIlluminated +POFrontIlluminated +POFrontIlluminated +POFullRayTracing +POFullRayTracing +RLGO +UTD +RLGO +UTD +Windscreen +Windscreen +Altair Feko 2022.3 +2 Application Programming Interface (API) +FacetedUTDAccelerationEnum +Enumeration Option List +The FacetedUTDAccelerationEnum enumeration is accessed as illustrated below. +cf.Enums.FacetedUTDAccelerationEnum. +p.2774 +Auto +Auto +Off +On +Off +On +Altair Feko 2022.3 +2 Application Programming Interface (API) +FactorisationTypeEnum +Enumeration Option List +The FactorisationTypeEnum enumeration is accessed as illustrated below. +cf.Enums.FactorisationTypeEnum. +p.2775 +Auto +Auto +BlockLowRank +BlockLowRank +Default +Default +StandardFullRank +StandardFullRank +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldCalculationDirectionEnum +Enumeration Option List +The FarFieldCalculationDirectionEnum enumeration is accessed as illustrated below. +cf.Enums.FarFieldCalculationDirectionEnum. +p.2776 +IncidentPlaneWave +IncidentPlaneWave +SpecifiedPoint +SpecifiedPoint +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldCoordinateSystemEnum +Enumeration Option List +The FarFieldCoordinateSystemEnum enumeration is accessed as illustrated below. +cf.Enums.FarFieldCoordinateSystemEnum. +p.2777 +Cartesian +Cartesian +Spherical +Spherical +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldDataFileTypeEnum +Enumeration Option List +The FarFieldDataFileTypeEnum enumeration is accessed as illustrated below. +cf.Enums.FarFieldDataFileTypeEnum. +p.2778 +CSTFile +CSTFile +DataFile +DataFile +FFEFile +FFEFile +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldRequestTypeEnum +Enumeration Option List +The FarFieldRequestTypeEnum enumeration is accessed as illustrated below. +cf.Enums.FarFieldRequestTypeEnum. +p.2779 +Directivity +Directivity +Gain +Gain +Altair Feko 2022.3 +2 Application Programming Interface (API) +FieldCalculationScopeTypeEnum +Enumeration Option List +The FieldCalculationScopeTypeEnum enumeration is accessed as illustrated below. +cf.Enums.FieldCalculationScopeTypeEnum. +p.2780 +All +All +SpecifiedEntities +SpecifiedEntities +FieldDataFileImportDefinitionEnum +Enumeration Option List +The FieldDataFileImportDefinitionEnum enumeration is accessed as illustrated below. +cf.Enums.FieldDataFileImportDefinitionEnum. +AllBlocks +AllBlocks +SpecifiedBlock +SpecifiedBlock +SpecifiedPointRange +SpecifiedPointRange +FillHoleBoundaryTransitionTypeEnum +Enumeration Option List +The FillHoleBoundaryTransitionTypeEnum enumeration is accessed as illustrated below. +cf.Enums.FillHoleBoundaryTransitionTypeEnum. +CorneredTransition +CorneredTransition +ExtendBoundingFaces +ExtendBoundingFaces +SmoothTransition +SmoothTransition +Altair Feko 2022.3 +2 Application Programming Interface (API) +FillHolePatchTopologyTypeEnum +Enumeration Option List +The FillHolePatchTopologyTypeEnum enumeration is accessed as illustrated below. +cf.Enums.FillHolePatchTopologyTypeEnum. +p.2783 +MinimumTopologies +MinimumTopologies +MultipleTopologies +MultipleTopologies +SingleTopology +SingleTopology +Altair Feko 2022.3 +2 Application Programming Interface (API) +FlareDefinitionMethodEnum +Enumeration Option List +The FlareDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.FlareDefinitionMethodEnum. +p.2784 +BaseCentreAndAllDimensions +BaseCentreAndAllDimensions +BaseCentreAndFlareAngles +BaseCentreAndFlareAngles +BaseCornerAndAllDimensions +BaseCornerAndAllDimensions +BaseCornerAndTopCorner +BaseCornerAndTopCorner +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormLayoutEnum +Enumeration Option List +The FormLayoutEnum enumeration is accessed as illustrated below. +cf.Enums.FormLayoutEnum. +p.2785 +Grid +Grid +Horizontal +Horizontal +Vertical +Vertical +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormSeparatorEnum +Enumeration Option List +The FormSeparatorEnum enumeration is accessed as illustrated below. +cf.Enums.FormSeparatorEnum. +Horizontal +Horizontal +Vertical +Vertical +p.2786 +FrequencyConvergenceAccuracyTypeEnum +Enumeration Option List +The FrequencyConvergenceAccuracyTypeEnum enumeration is accessed as illustrated below. +cf.Enums.FrequencyConvergenceAccuracyTypeEnum. +High +Low +High +Low +Normal +Normal +FrequencyExportSamplingTypeEnum +Enumeration Option List +The FrequencyExportSamplingTypeEnum enumeration is accessed as illustrated below. +cf.Enums.FrequencyExportSamplingTypeEnum. +Linear +Linear +Log +Log +FrequencyFDTDTimeIntervalTypeEnum +Enumeration Option List +The FrequencyFDTDTimeIntervalTypeEnum enumeration is accessed as illustrated below. +cf.Enums.FrequencyFDTDTimeIntervalTypeEnum. +Auto +Auto +Periods +Periods +Seconds +Seconds +Altair Feko 2022.3 +2 Application Programming Interface (API) +FrequencyRangeTypeEnum +Enumeration Option List +The FrequencyRangeTypeEnum enumeration is accessed as illustrated below. +cf.Enums.FrequencyRangeTypeEnum. +p.2790 +Continuous +Continuous +DiscreteList +DiscreteList +LinearSpacedDiscrete +LinearSpacedDiscrete +LogarithmicSpacedDiscrete +LogarithmicSpacedDiscrete +Single +Single +Altair Feko 2022.3 +2 Application Programming Interface (API) +GeneralNetworkDataTypeEnum +Enumeration Option List +The GeneralNetworkDataTypeEnum enumeration is accessed as illustrated below. +cf.Enums.GeneralNetworkDataTypeEnum. +p.2791 +SMatrix +SMatrix +SPICENetwork +SPICENetwork +YMatrix +YMatrix +ZMatrix +ZMatrix +GeneralNetworkSPICEPortReferenceEnum +Enumeration Option List +The GeneralNetworkSPICEPortReferenceEnum enumeration is accessed as illustrated below. +cf.Enums.GeneralNetworkSPICEPortReferenceEnum. +Absolute +Absolute +Relative +Relative +Altair Feko 2022.3 +2 Application Programming Interface (API) +GeneralNetworkSourceEnum +Enumeration Option List +The GeneralNetworkSourceEnum enumeration is accessed as illustrated below. +cf.Enums.GeneralNetworkSourceEnum. +p.2793 +Manual +Manual +Touchstone +Touchstone +Altair Feko 2022.3 +2 Application Programming Interface (API) +GeometryEdgeEnum +Enumeration Option List +The GeometryEdgeEnum enumeration is accessed as illustrated below. +cf.Enums.GeometryEdgeEnum. +Edge +Wire +Edge +Wire +p.2794 +Altair Feko 2022.3 +2 Application Programming Interface (API) +GroundBottomTypeEnum +Enumeration Option List +The GroundBottomTypeEnum enumeration is accessed as illustrated below. +cf.Enums.GroundBottomTypeEnum. +p.2795 +None +PEC +None +PEC +GroundPlaneDefinitionMethodEnum +Enumeration Option List +The GroundPlaneDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.GroundPlaneDefinitionMethodEnum. +HalfspaceReflectionCoefficient +HalfspaceReflectionCoefficient +HalfspaceSommerfeld +HalfspaceSommerfeld +Homogeneous +Homogeneous +MultilayerSubstrate +MultilayerSubstrate +PEC +PMC +PEC +PMC +Altair Feko 2022.3 +2 Application Programming Interface (API) +HOBFElementOrderEnum +Enumeration Option List +The HOBFElementOrderEnum enumeration is accessed as illustrated below. +cf.Enums.HOBFElementOrderEnum. +p.2797 +Auto +Auto +Order0_5 +Order0_5 +Order1_5 +Order1_5 +Order2_5 +Order2_5 +Order3_5 +Order3_5 +Altair Feko 2022.3 +2 Application Programming Interface (API) +HelixDefinitionMethodEnum +Enumeration Option List +The HelixDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.HelixDefinitionMethodEnum. +p.2798 +ConstantRadiusAndHeight +ConstantRadiusAndHeight +ConstantRadiusAndTurns +ConstantRadiusAndTurns +VariableRadiusAndTurns +VariableRadiusAndTurns +HighFrequencyPOMoMCouplingTypeEnum +Enumeration Option List +The HighFrequencyPOMoMCouplingTypeEnum enumeration is accessed as illustrated below. +cf.Enums.HighFrequencyPOMoMCouplingTypeEnum. +Decoupled +Decoupled +Full +Full +Iterative +Iterative +HyperbolicArcDefinitionMethodEnum +Enumeration Option List +The HyperbolicArcDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.HyperbolicArcDefinitionMethodEnum. +ApertureCentre +ApertureCentre +BaseCentre +BaseCentre +Altair Feko 2022.3 +2 Application Programming Interface (API) +ImageSizeEnum +Enumeration Option List +The ImageSizeEnum enumeration is accessed as illustrated below. +cf.Enums.ImageSizeEnum. +p.2801 +Custom +Custom +QQVGA (160x120) +QQVGA (160x120) +QVGA (320x240) +QVGA (320x240) +SVGA (800x600) +SVGA (800x600) +SXGA (1280x1024) +SXGA (1280x1024) +Same As Source +Same As Source +VGA (640x480) +VGA (640x480) +XGA (1024x768) +XGA (1024x768) +Altair Feko 2022.3 +2 Application Programming Interface (API) +ImportHealingTypeEnum +Enumeration Option List +The ImportHealingTypeEnum enumeration is accessed as illustrated below. +cf.Enums.ImportHealingTypeEnum. +p.2802 +Advanced +Advanced +None +None +Standard +Standard +Altair Feko 2022.3 +2 Application Programming Interface (API) +ImportMeshConversionTypeEnum +Enumeration Option List +The ImportMeshConversionTypeEnum enumeration is accessed as illustrated below. +cf.Enums.ImportMeshConversionTypeEnum. +p.2803 +Automatic +Automatic +Tetrahedra +Tetrahedra +Triangles +Triangles +Altair Feko 2022.3 +2 Application Programming Interface (API) +ImportMeshFileFormatEnum +Enumeration Option List +The ImportMeshFileFormatEnum enumeration is accessed as illustrated below. +cf.Enums.ImportMeshFileFormatEnum. +p.2804 +ABAQUS +ABAQUS +ASCII_DATA_FORMAT +ASCII_DATA_FORMAT +All +CDB +CFM +All +CDB +CFM +CONCEPT +CONCEPT +DXF +FEK +DXF +FEK +FEMAP +FEMAP +FHM +GID +FHM +GID +NASTRAN +NASTRAN +NEC +NEC +PATRAN +PATRAN +RAW +STL +RAW +STL +UNV +UNV +ImpressedCurrentClosestVertexTypeEnum +Enumeration Option List +The ImpressedCurrentClosestVertexTypeEnum enumeration is accessed as illustrated below. +cf.Enums.ImpressedCurrentClosestVertexTypeEnum. +Segment +Segment +Triangle +Triangle +Altair Feko 2022.3 +2 Application Programming Interface (API) +IntegralEquationTypeEnum +Enumeration Option List +The IntegralEquationTypeEnum enumeration is accessed as illustrated below. +cf.Enums.IntegralEquationTypeEnum. +p.2807 +CombinedField +CombinedField +ElectricField +ElectricField +MagneticField +MagneticField +Altair Feko 2022.3 +2 Application Programming Interface (API) +LibraryMediumSourceEnum +Enumeration Option List +The LibraryMediumSourceEnum enumeration is accessed as illustrated below. +cf.Enums.LibraryMediumSourceEnum. +p.2808 +AltairFeko +AltairFeko +User +User +Altair Feko 2022.3 +2 Application Programming Interface (API) +LibraryMediumTypeEnum +Enumeration Option List +The LibraryMediumTypeEnum enumeration is accessed as illustrated below. +cf.Enums.LibraryMediumTypeEnum. +p.2809 +Dielectric +Dielectric +ImpedanceSheet +ImpedanceSheet +Metal +Metal +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadTypeEnum +Enumeration Option List +The LoadTypeEnum enumeration is accessed as illustrated below. +cf.Enums.LoadTypeEnum. +p.2810 +Complex +Complex +Parallel +Parallel +Series +Series +SinglePortTouchstone +SinglePortTouchstone +SpiceCircuit +SpiceCircuit +LoopedPlaneWaveCompressionEnum +Enumeration Option List +The LoopedPlaneWaveCompressionEnum enumeration is accessed as illustrated below. +cf.Enums.LoopedPlaneWaveCompressionEnum. +Auto +Auto +Disabled +Disabled +Enabled +Enabled +LowFrequencyStabilisationModeEnum +Enumeration Option List +The LowFrequencyStabilisationModeEnum enumeration is accessed as illustrated below. +cf.Enums.LowFrequencyStabilisationModeEnum. +AlwaysOn +AlwaysOn +Auto +Auto +MLFMMFarFieldCalculationMethodEnum +Enumeration Option List +The MLFMMFarFieldCalculationMethodEnum enumeration is accessed as illustrated below. +cf.Enums.MLFMMFarFieldCalculationMethodEnum. +Default +Default +TraditionalIntegrationScheme +TraditionalIntegrationScheme +MLFMMNearFieldCalculationMethodEnum +Enumeration Option List +The MLFMMNearFieldCalculationMethodEnum enumeration is accessed as illustrated below. +cf.Enums.MLFMMNearFieldCalculationMethodEnum. +Default +Default +TraditionalIntegrationScheme +TraditionalIntegrationScheme +Altair Feko 2022.3 +2 Application Programming Interface (API) +MagneticDipoleCurrentTypeEnum +Enumeration Option List +The MagneticDipoleCurrentTypeEnum enumeration is accessed as illustrated below. +cf.Enums.MagneticDipoleCurrentTypeEnum. +p.2815 +ElectricRingCurrent +ElectricRingCurrent +MagneticLineCurrent +MagneticLineCurrent +Altair Feko 2022.3 +2 Application Programming Interface (API) +MagnetostaticFieldDirectionEnum +Enumeration Option List +The MagnetostaticFieldDirectionEnum enumeration is accessed as illustrated below. +cf.Enums.MagnetostaticFieldDirectionEnum. +p.2816 +XDirected +XDirected +YDirected +YDirected +ZDirected +ZDirected +MediumDielectricConductivityTypeEnum +Enumeration Option List +The MediumDielectricConductivityTypeEnum enumeration is accessed as illustrated below. +cf.Enums.MediumDielectricConductivityTypeEnum. +Conductivity +Conductivity +LossTangent +LossTangent +MediumDielectricDefinitionMethodEnum +Enumeration Option List +The MediumDielectricDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.MediumDielectricDefinitionMethodEnum. +ColeCole +ColeCole +DebyeRelaxation +DebyeRelaxation +DjordjevicSarkar +DjordjevicSarkar +FrequencyIndependent +FrequencyIndependent +FrequencyList +FrequencyList +HavriliakNegami +HavriliakNegami +MediumImpedanceDefinitionMethodEnum +Enumeration Option List +The MediumImpedanceDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.MediumImpedanceDefinitionMethodEnum. +FrequencyIndependent +FrequencyIndependent +FrequencyList +FrequencyList +MediumMagneticDefinitionMethodEnum +Enumeration Option List +The MediumMagneticDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.MediumMagneticDefinitionMethodEnum. +FrequencyIndependent +FrequencyIndependent +FrequencyList +FrequencyList +NonMagnetic +NonMagnetic +MediumMetallicDefinitionMethodEnum +Enumeration Option List +The MediumMetallicDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.MediumMetallicDefinitionMethodEnum. +FrequencyIndependent +FrequencyIndependent +FrequencyList +FrequencyList +MediumSourceDefinitionMethodEnum +Enumeration Option List +The MediumSourceDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.MediumSourceDefinitionMethodEnum. +DefineManually +DefineManually +ImportFromFile +ImportFromFile +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshCurvilinearOptionsEnum +Enumeration Option List +The MeshCurvilinearOptionsEnum enumeration is accessed as illustrated below. +cf.Enums.MeshCurvilinearOptionsEnum. +p.2823 +Auto +Auto +Disabled +Disabled +Enabled +Enabled +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshSizeOptionEnum +Enumeration Option List +The MeshSizeOptionEnum enumeration is accessed as illustrated below. +cf.Enums.MeshSizeOptionEnum. +p.2824 +Coarse +Coarse +Custom +Custom +Fine +Fine +Standard +Standard +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshSmallGeometryOptionsEnum +Enumeration Option List +The MeshSmallGeometryOptionsEnum enumeration is accessed as illustrated below. +cf.Enums.MeshSmallGeometryOptionsEnum. +p.2825 +Default +Default +Ignore +Ignore +Optimise +Optimise +MeshVoxelAspectRatioOptionsEnum +Enumeration Option List +The MeshVoxelAspectRatioOptionsEnum enumeration is accessed as illustrated below. +cf.Enums.MeshVoxelAspectRatioOptionsEnum. +Auto +Auto +Disabled +Disabled +Manual +Manual +MeshVoxelGrowthRateOptionsEnum +Enumeration Option List +The MeshVoxelGrowthRateOptionsEnum enumeration is accessed as illustrated below. +cf.Enums.MeshVoxelGrowthRateOptionsEnum. +Auto +Auto +Disabled +Disabled +Manual +Manual +MeshVoxelSmallGeometryOptionsEnum +Enumeration Option List +The MeshVoxelSmallGeometryOptionsEnum enumeration is accessed as illustrated below. +cf.Enums.MeshVoxelSmallGeometryOptionsEnum. +Auto +Auto +Disabled +Disabled +Manual +Manual +Altair Feko 2022.3 +2 Application Programming Interface (API) +MirrorPlaneEnum +Enumeration Option List +The MirrorPlaneEnum enumeration is accessed as illustrated below. +cf.Enums.MirrorPlaneEnum. +p.2829 +UN +UV +VN +UN +UV +VN +ModelDecompositionScopeTypeEnum +Enumeration Option List +The ModelDecompositionScopeTypeEnum enumeration is accessed as illustrated below. +cf.Enums.ModelDecompositionScopeTypeEnum. +AllModelDecomposition +AllModelDecomposition +SpecifiedEntities +SpecifiedEntities +Altair Feko 2022.3 +2 Application Programming Interface (API) +ModelSolutionSolveTypeEnum +Enumeration Option List +The ModelSolutionSolveTypeEnum enumeration is accessed as illustrated below. +cf.Enums.ModelSolutionSolveTypeEnum. +p.2831 +ACA +ACA +MLFMM +MLFMM +None +None +Altair Feko 2022.3 +2 Application Programming Interface (API) +ModelSymmetryTypeEnum +Enumeration Option List +The ModelSymmetryTypeEnum enumeration is accessed as illustrated below. +cf.Enums.ModelSymmetryTypeEnum. +p.2832 +Electric +Electric +Geometric +Geometric +Magnetic +Magnetic +NoSymmetry +NoSymmetry +Altair Feko 2022.3 +2 Application Programming Interface (API) +ModelUnitEnum +Enumeration Option List +The ModelUnitEnum enumeration is accessed as illustrated below. +cf.Enums.ModelUnitEnum. +p.2833 +Centimetres +Centimetres +Feet +Feet +Inches +Inches +Metres +Metres +Millimetres +Millimetres +Specified +Specified +Altair Feko 2022.3 +2 Application Programming Interface (API) +NGFControlTypeEnum +Enumeration Option List +The NGFControlTypeEnum enumeration is accessed as illustrated below. +cf.Enums.NGFControlTypeEnum. +p.2834 +NoAction +NoAction +Read +Read +ReadFromOrCreate +ReadFromOrCreate +Save +Save +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldCalculationTypeEnum +Enumeration Option List +The NearFieldCalculationTypeEnum enumeration is accessed as illustrated below. +cf.Enums.NearFieldCalculationTypeEnum. +p.2835 +Fields +Fields +Potentials +Potentials +NearFieldDataCoordinateTypeEnum +Enumeration Option List +The NearFieldDataCoordinateTypeEnum enumeration is accessed as illustrated below. +cf.Enums.NearFieldDataCoordinateTypeEnum. +Cartesian +Cartesian +Cylindrical +Cylindrical +Spherical +Spherical +NearFieldDataFileStructureDataTypeEnum +Enumeration Option List +The NearFieldDataFileStructureDataTypeEnum enumeration is accessed as illustrated below. +cf.Enums.NearFieldDataFileStructureDataTypeEnum. +Electric +Electric +ElectricMagnetic +ElectricMagnetic +Magnetic +Magnetic +NearFieldDataFullImportDataTypeEnum +Enumeration Option List +The NearFieldDataFullImportDataTypeEnum enumeration is accessed as illustrated below. +cf.Enums.NearFieldDataFullImportDataTypeEnum. +CartesianBoundary +CartesianBoundary +Cst +Cst +OrbitSatimo +OrbitSatimo +Sigrity +Sigrity +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldDataReferencePointEnum +Enumeration Option List +The NearFieldDataReferencePointEnum enumeration is accessed as illustrated below. +cf.Enums.NearFieldDataReferencePointEnum. +p.2839 +BaseCorner +BaseCorner +BoxCentre +BoxCentre +FaceCentreNMax +FaceCentreNMax +FaceCentreNMin +FaceCentreNMin +FaceCentreUMax +FaceCentreUMax +FaceCentreUMin +FaceCentreUMin +FaceCentreVMax +FaceCentreVMax +FaceCentreVMin +FaceCentreVMin +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldDataSourceTypeEnum +Enumeration Option List +The NearFieldDataSourceTypeEnum enumeration is accessed as illustrated below. +cf.Enums.NearFieldDataSourceTypeEnum. +p.2840 +LoadEfe +LoadEfe +LoadEfeHfe +LoadEfeHfe +LoadHfe +LoadHfe +LoadOneAscii +LoadOneAscii +LoadPre +LoadPre +LoadTwoAscii +LoadTwoAscii +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldDefinitionMethodEnum +Enumeration Option List +The NearFieldDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.NearFieldDefinitionMethodEnum. +p.2841 +Cartesian +Cartesian +CartesianBoundary +CartesianBoundary +Conical +Conical +Cylindrical +Cylindrical +CylindricalX +CylindricalX +CylindricalY +CylindricalY +SpecifiedPoints +SpecifiedPoints +Spherical +Spherical +TetrahedralMesh +TetrahedralMesh +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldPotentialTypeEnum +Enumeration Option List +The NearFieldPotentialTypeEnum enumeration is accessed as illustrated below. +cf.Enums.NearFieldPotentialTypeEnum. +p.2842 +ElectricScalarPotential +ElectricScalarPotential +ElectricVectorPotential +ElectricVectorPotential +GradientScalarElectricPotential +GradientScalarElectricPotential +GradientScalarMagneticPotential +GradientScalarMagneticPotential +MagneticScalarPotential +MagneticScalarPotential +MagneticVectorPotential +MagneticVectorPotential +NearFieldReceivingAntennaDataTypeEnum +Enumeration Option List +The NearFieldReceivingAntennaDataTypeEnum enumeration is accessed as illustrated below. +cf.Enums.NearFieldReceivingAntennaDataTypeEnum. +CombineIndividualFaces +CombineIndividualFaces +ReferenceEnclosedRegion +ReferenceEnclosedRegion +Altair Feko 2022.3 +2 Application Programming Interface (API) +OptimisationCombineTypeEnum +Enumeration Option List +The OptimisationCombineTypeEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationCombineTypeEnum. +p.2844 +Average +Average +Maximum +Maximum +Minimum +Minimum +OptimisationConstraintRelationEnum +Enumeration Option List +The OptimisationConstraintRelationEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationConstraintRelationEnum. +Greater +Greater +GreaterOrEqual +GreaterOrEqual +Less +Less +LessOrEqual +LessOrEqual +NotEqual +NotEqual +OptimisationConvergenceAccuracyEnum +Enumeration Option List +The OptimisationConvergenceAccuracyEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationConvergenceAccuracyEnum. +High +Low +High +Low +Normal +Normal +OptimisationFarFieldFocusTypeEnum +Enumeration Option List +The OptimisationFarFieldFocusTypeEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationFarFieldFocusTypeEnum. +Directivity +Directivity +Gain +RCS +Gain +RCS +RadiatedField +RadiatedField +RadiatedPower +RadiatedPower +RealisedGain +RealisedGain +OptimisationFarFieldPolarisationTypeEnum +Enumeration Option List +The OptimisationFarFieldPolarisationTypeEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationFarFieldPolarisationTypeEnum. +AxialRatioMajorMinor +AxialRatioMajorMinor +AxialRatioMajorMinorMagnitude +AxialRatioMajorMinorMagnitude +AxialRatioMinorMajor +AxialRatioMinorMajor +AxialRatioMinorMajorMagnitude +AxialRatioMinorMajorMagnitude +Horizontal +Horizontal +LHC +LHC +LudwigIIICo +LudwigIIICo +LudwigIIICross +LudwigIIICross +RHC +RHC +SPolarisation +SPolarisation +Total +Total +Vertical +Vertical +ZPolarisation +ZPolarisation +OptimisationFocusSourceTypeEnum +Enumeration Option List +The OptimisationFocusSourceTypeEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationFocusSourceTypeEnum. +FocusSourceByLabel +FocusSourceByLabel +FocusSourceByReference +FocusSourceByReference +Altair Feko 2022.3 +2 Application Programming Interface (API) +OptimisationGoalOperatorEnum +Enumeration Option List +The OptimisationGoalOperatorEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationGoalOperatorEnum. +p.2850 +Between +Between +Equal +Equal +GreaterThan +GreaterThan +LessThan +LessThan +Maximise +Maximise +Minimise +Minimise +OptimisationGoalProcessingStepsEnum +Enumeration Option List +The OptimisationGoalProcessingStepsEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationGoalProcessingStepsEnum. +AbsoluteValue +AbsoluteValue +Average +Average +Exponent +Exponent +Imaginary +Imaginary +Log +Log +Magnitude +Magnitude +Max +Min +Max +Min +NoProcessing +NoProcessing +Normalise +Normalise +Offset +Phase +Offset +Phase +Real +Scale +Real +Scale +Unwrap +Unwrap +dB +dB +OptimisationImpedanceFocusTypeEnum +Enumeration Option List +The OptimisationImpedanceFocusTypeEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationImpedanceFocusTypeEnum. +Current +Current +InputAdmittance +InputAdmittance +InputImpedance +InputImpedance +ReflectionCoefficient +ReflectionCoefficient +ReturnLosses +ReturnLosses +TransmissionCoefficient +TransmissionCoefficient +VSWR +VSWR +Altair Feko 2022.3 +2 Application Programming Interface (API) +OptimisationMethodTypeEnum +Enumeration Option List +The OptimisationMethodTypeEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationMethodTypeEnum. +p.2853 +AdaptiveResponseSurfaceMethod +AdaptiveResponseSurfaceMethod +AutoMethod +AutoMethod +GeneticAlgorithm +GeneticAlgorithm +GlobalResponseSurfaceMethod +GlobalResponseSurfaceMethod +GridSearch +GridSearch +ParticleSwarmOptimisation +ParticleSwarmOptimisation +Simplex +Simplex +OptimisationNearFieldCoordSystemEnum +Enumeration Option List +The OptimisationNearFieldCoordSystemEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationNearFieldCoordSystemEnum. +Cartesian +Cartesian +CylindricalX +CylindricalX +CylindricalY +CylindricalY +CylindricalZ +CylindricalZ +Spherical +Spherical +OptimisationNearFieldDirectComponentEnum +Enumeration Option List +The OptimisationNearFieldDirectComponentEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationNearFieldDirectComponentEnum. +Combined +Combined +Phi +Phi +Radial +Theta +Radial +Theta +OptimisationNearFieldFocusTypeEnum +Enumeration Option List +The OptimisationNearFieldFocusTypeEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationNearFieldFocusTypeEnum. +ElectricField +ElectricField +ElectricFluxDensity +ElectricFluxDensity +MagneticField +MagneticField +MagneticFluxDensity +MagneticFluxDensity +OptimisationPowerFocusTypeEnum +Enumeration Option List +The OptimisationPowerFocusTypeEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationPowerFocusTypeEnum. +ActivePower +ActivePower +Efficiency +Efficiency +PowerLoss +PowerLoss +OptimisationRandomNumberGenerationOptionEnum +Enumeration Option List +The OptimisationRandomNumberGenerationOptionEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationRandomNumberGenerationOptionEnum. +DefaultSeed +DefaultSeed +RandomSeed +RandomSeed +SpecifiedSeed +SpecifiedSeed +OptimisationReceivingAntennaFocusTypeEnum +Enumeration Option List +The OptimisationReceivingAntennaFocusTypeEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationReceivingAntennaFocusTypeEnum. +ActivePower +ActivePower +Efficiency +Efficiency +PowerLoss +PowerLoss +Altair Feko 2022.3 +2 Application Programming Interface (API) +OptimisationSARFocusTypeEnum +Enumeration Option List +The OptimisationSARFocusTypeEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationSARFocusTypeEnum. +SAR +SAR +p.2860 +OptimisationSParameterFocusTypeEnum +Enumeration Option List +The OptimisationSParameterFocusTypeEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationSParameterFocusTypeEnum. +Coupling +Coupling +Reflect +Reflect +ReturnLoss +ReturnLoss +Transmission +Transmission +VSWR +VSWR +OptimisationTargetValueTypeEnum +Enumeration Option List +The OptimisationTargetValueTypeEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationTargetValueTypeEnum. +MaskValue +MaskValue +SingleValue +SingleValue +OptimisationTransmissionReflectionFocusTypeEnum +Enumeration Option List +The OptimisationTransmissionReflectionFocusTypeEnum enumeration is accessed as illustrated below. +cf.Enums.OptimisationTransmissionReflectionFocusTypeEnum. +Reflection +Reflection +Transmission +Transmission +OptimisationTransmissionReflectionPolarisationTypeEnum +Enumeration Option List +The OptimisationTransmissionReflectionPolarisationTypeEnum enumeration is accessed as illustrated +below. +cf.Enums.OptimisationTransmissionReflectionPolarisationTypeEnum. +CoPolarisation +CoPolarisation +CrossPolarisation +CrossPolarisation +Altair Feko 2022.3 +2 Application Programming Interface (API) +OutputFileSettingsEnum +Enumeration Option List +The OutputFileSettingsEnum enumeration is accessed as illustrated below. +cf.Enums.OutputFileSettingsEnum. +p.2865 +NormalExecution +NormalExecution +ReadFromFile +ReadFromFile +ReadFromFileIfAvailable +ReadFromFileIfAvailable +SaveToFile +SaveToFile +Altair Feko 2022.3 +2 Application Programming Interface (API) +PCBImportTypeEnum +Enumeration Option List +The PCBImportTypeEnum enumeration is accessed as illustrated below. +cf.Enums.PCBImportTypeEnum. +p.2866 +AltiumDesigner +AltiumDesigner +AltiumPCAD +AltiumPCAD +AutodeskEagle +AutodeskEagle +CadenceAllegro +CadenceAllegro +CadenceSpecctra +CadenceSpecctra +Cadvance +Cadvance +IPC2581 +IPC2581 +MentorBoard +MentorBoard +MentorNeutral +MentorNeutral +MentorPADs +MentorPADs +MentorXpedition +MentorXpedition +ODBPlusPlus +ODBPlusPlus +PEMA +PEMA +ZukenCR5000 +ZukenCR5000 +ZukenCR5000PWS +ZukenCR5000PWS +ZukenCadstar +ZukenCadstar +ParabolicArcDefinitionMethodEnum +Enumeration Option List +The ParabolicArcDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.ParabolicArcDefinitionMethodEnum. +ApertureCentreAndDepth +ApertureCentreAndDepth +BaseCentreAndDepth +BaseCentreAndDepth +BaseCentreAndFocalDepth +BaseCentreAndFocalDepth +ParallelAuthenticationMethodEnum +Enumeration Option List +The ParallelAuthenticationMethodEnum enumeration is accessed as illustrated below. +cf.Enums.ParallelAuthenticationMethodEnum. +Default +Default +None +None +RegistryCredentials +RegistryCredentials +SSPI +SSPI +Altair Feko 2022.3 +2 Application Programming Interface (API) +ParasolidExportFileFormatEnum +Enumeration Option List +The ParasolidExportFileFormatEnum enumeration is accessed as illustrated below. +cf.Enums.ParasolidExportFileFormatEnum. +p.2869 +Binary +Binary +Text +Text +Altair Feko 2022.3 +2 Application Programming Interface (API) +ParasolidTopologyTypeEnum +Enumeration Option List +The ParasolidTopologyTypeEnum enumeration is accessed as illustrated below. +cf.Enums.ParasolidTopologyTypeEnum. +p.2870 +General +General +Manifold +Manifold +Altair Feko 2022.3 +2 Application Programming Interface (API) +PathSweepAlignmentEnum +Enumeration Option List +The PathSweepAlignmentEnum enumeration is accessed as illustrated below. +cf.Enums.PathSweepAlignmentEnum. +p.2871 +Normal +Normal +Parallel +Parallel +Altair Feko 2022.3 +2 Application Programming Interface (API) +PeriodicBoundaryDimensionsEnum +Enumeration Option List +The PeriodicBoundaryDimensionsEnum enumeration is accessed as illustrated below. +cf.Enums.PeriodicBoundaryDimensionsEnum. +p.2872 +None +None +OneDimension +OneDimension +TwoDimensions +TwoDimensions +PeriodicBoundaryPhaseShiftMethodEnum +Enumeration Option List +The PeriodicBoundaryPhaseShiftMethodEnum enumeration is accessed as illustrated below. +cf.Enums.PeriodicBoundaryPhaseShiftMethodEnum. +BeamSquintAngle +BeamSquintAngle +PlaneWaveSource +PlaneWaveSource +SpecifyManually +SpecifyManually +Altair Feko 2022.3 +2 Application Programming Interface (API) +PlaneGridEnum +Enumeration Option List +The PlaneGridEnum enumeration is accessed as illustrated below. +cf.Enums.PlaneGridEnum. +p.2874 +AutoGrid +AutoGrid +Continuous +Continuous +FixedGrid +FixedGrid +Altair Feko 2022.3 +2 Application Programming Interface (API) +PlaneWaveDefinitionMethodEnum +Enumeration Option List +The PlaneWaveDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.PlaneWaveDefinitionMethodEnum. +p.2875 +Multiple +Multiple +Single +Single +Altair Feko 2022.3 +2 Application Programming Interface (API) +PlaneWavePolarityTypeEnum +Enumeration Option List +The PlaneWavePolarityTypeEnum enumeration is accessed as illustrated below. +cf.Enums.PlaneWavePolarityTypeEnum. +p.2876 +LeftHand +LeftHand +Linear +Linear +RightHand +RightHand +Altair Feko 2022.3 +2 Application Programming Interface (API) +PointSpecificationEnum +Enumeration Option List +The PointSpecificationEnum enumeration is accessed as illustrated below. +cf.Enums.PointSpecificationEnum. +Increment +Increment +NumberOfPoints +NumberOfPoints +p.2877 +Altair Feko 2022.3 +2 Application Programming Interface (API) +PowerScaleSettingsEnum +Enumeration Option List +The PowerScaleSettingsEnum enumeration is accessed as illustrated below. +cf.Enums.PowerScaleSettingsEnum. +p.2878 +IncidentPower +IncidentPower +NoPowerScaling +NoPowerScaling +TotalSourcePower +TotalSourcePower +Altair Feko 2022.3 +2 Application Programming Interface (API) +PrecisionSettingsEnum +Enumeration Option List +The PrecisionSettingsEnum enumeration is accessed as illustrated below. +cf.Enums.PrecisionSettingsEnum. +p.2879 +Double +Double +Single +Single +Altair Feko 2022.3 +2 Application Programming Interface (API) +PreconditionerTypeEnum +Enumeration Option List +The PreconditionerTypeEnum enumeration is accessed as illustrated below. +cf.Enums.PreconditionerTypeEnum. +p.2880 +BlockJacobiLU_64 +BlockJacobiLU_64 +BlockJacobiMLFMM_4096 +BlockJacobiMLFMM_4096 +Default +Default +IncompleteLU_128 +IncompleteLU_128 +MultiLevelILU_512 +MultiLevelILU_512 +MultiLevelLU_2050 +MultiLevelLU_2050 +MultilevelFEMMLFMMLU_2010 +MultilevelFEMMLFMMLU_2010 +SparseApproxInverse_8192 +SparseApproxInverse_8192 +SparseLU_8193 +SparseLU_8193 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ProcessPriorityTypeEnum +Enumeration Option List +The ProcessPriorityTypeEnum enumeration is accessed as illustrated below. +cf.Enums.ProcessPriorityTypeEnum. +p.2881 +High +High +Highest +Highest +Idle +Low +Idle +Low +Normal +Normal +RLGOConvergenceAccuracyTypeEnum +Enumeration Option List +The RLGOConvergenceAccuracyTypeEnum enumeration is accessed as illustrated below. +cf.Enums.RLGOConvergenceAccuracyTypeEnum. +High +Low +High +Low +Normal +Normal +Altair Feko 2022.3 +2 Application Programming Interface (API) +RLGOIncrementTypeEnum +Enumeration Option List +The RLGOIncrementTypeEnum enumeration is accessed as illustrated below. +cf.Enums.RLGOIncrementTypeEnum. +p.2883 +Adaptive +Adaptive +FixedGridIncrements +FixedGridIncrements +Altair Feko 2022.3 +2 Application Programming Interface (API) +RectangleDefinitionMethodEnum +Enumeration Option List +The RectangleDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.RectangleDefinitionMethodEnum. +p.2884 +BaseAtCentre +BaseAtCentre +BaseAtCorner +BaseAtCorner +Altair Feko 2022.3 +2 Application Programming Interface (API) +RegionDefinitionMethodEnum +Enumeration Option List +The RegionDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.RegionDefinitionMethodEnum. +p.2885 +Cartesian +Cartesian +Cylindrical +Cylindrical +Spherical +Spherical +Altair Feko 2022.3 +2 Application Programming Interface (API) +RegionSolutionMethodEnum +Enumeration Option List +The RegionSolutionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.RegionSolutionMethodEnum. +p.2886 +DSIA +DSIA +FEM +SEP +UTD +VEP +FEM +SEP +UTD +VEP +Altair Feko 2022.3 +2 Application Programming Interface (API) +RemoteExecutionMethodEnum +Enumeration Option List +The RemoteExecutionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.RemoteExecutionMethodEnum. +p.2887 +MPI +MPI +SSH_RSH +SSH_RSH +Altair Feko 2022.3 +2 Application Programming Interface (API) +RenderingSpeedOptionsEnum +Enumeration Option List +The RenderingSpeedOptionsEnum enumeration is accessed as illustrated below. +cf.Enums.RenderingSpeedOptionsEnum. +p.2888 +Default +Default +Fast +Fast +Faster +Faster +Altair Feko 2022.3 +2 Application Programming Interface (API) +RepairSearchEnum +Enumeration Option List +The RepairSearchEnum enumeration is accessed as illustrated below. +cf.Enums.RepairSearchEnum. +p.2889 +Entire +Entire +Faulty +Faulty +Selected +Selected +Altair Feko 2022.3 +2 Application Programming Interface (API) +SARCalculationTypeEnum +Enumeration Option List +The SARCalculationTypeEnum enumeration is accessed as illustrated below. +cf.Enums.SARCalculationTypeEnum. +p.2890 +SpatialPeak10g +SpatialPeak10g +SpatialPeak1g +SpatialPeak1g +VolumeAverage +VolumeAverage +Altair Feko 2022.3 +2 Application Programming Interface (API) +SARMediumSelectEnum +Enumeration Option List +The SARMediumSelectEnum enumeration is accessed as illustrated below. +cf.Enums.SARMediumSelectEnum. +p.2891 +All +All +Specified +Specified +Altair Feko 2022.3 +2 Application Programming Interface (API) +SARRegionTypeEnum +Enumeration Option List +The SARRegionTypeEnum enumeration is accessed as illustrated below. +cf.Enums.SARRegionTypeEnum. +p.2892 +EntireModel +EntireModel +Medium +Medium +Position +Position +Substrate +Substrate +SParameterWaveguideModeTypeEnum +Enumeration Option List +The SParameterWaveguideModeTypeEnum enumeration is accessed as illustrated below. +cf.Enums.SParameterWaveguideModeTypeEnum. +Fundamental +Fundamental +TE +TEM +TM +TE +TEM +TM +Altair Feko 2022.3 +2 Application Programming Interface (API) +SamplingPointDensityEnum +Enumeration Option List +The SamplingPointDensityEnum enumeration is accessed as illustrated below. +cf.Enums.SamplingPointDensityEnum. +Auto +Auto +SpecifyMaximumSeparationDistance +SpecifyMaximumSeparationDistance +p.2894 +Altair Feko 2022.3 +2 Application Programming Interface (API) +SimplifyBlendTypeEnum +Enumeration Option List +The SimplifyBlendTypeEnum enumeration is accessed as illustrated below. +cf.Enums.SimplifyBlendTypeEnum. +p.2895 +DontSimplifyToBlend +DontSimplifyToBlend +MaxSimplifyToBlend +MaxSimplifyToBlend +SimplifyToBlend +SimplifyToBlend +SphericalModeDataIndexSchemeMethodEnum +Enumeration Option List +The SphericalModeDataIndexSchemeMethodEnum enumeration is accessed as illustrated below. +cf.Enums.SphericalModeDataIndexSchemeMethodEnum. +Compressed +Compressed +Normal +Normal +SphericalModeDataPropagationDirectionMethodEnum +Enumeration Option List +The SphericalModeDataPropagationDirectionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.SphericalModeDataPropagationDirectionMethodEnum. +Inward +Inward +Outward +Outward +SphericalModeDataTeTmTypeMethodEnum +Enumeration Option List +The SphericalModeDataTeTmTypeMethodEnum enumeration is accessed as illustrated below. +cf.Enums.SphericalModeDataTeTmTypeMethodEnum. +Empty +Empty +TE +TM +TE +TM +Altair Feko 2022.3 +2 Application Programming Interface (API) +SpheroidDefinitionMethodEnum +Enumeration Option List +The SpheroidDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.SpheroidDefinitionMethodEnum. +p.2899 +Sphere +Sphere +Spheroid +Spheroid +Altair Feko 2022.3 +2 Application Programming Interface (API) +SplitPlanesEnum +Enumeration Option List +The SplitPlanesEnum enumeration is accessed as illustrated below. +cf.Enums.SplitPlanesEnum. +p.2900 +UN +UV +VN +UN +UV +VN +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfaceCoatingTypeEnum +Enumeration Option List +The SurfaceCoatingTypeEnum enumeration is accessed as illustrated below. +cf.Enums.SurfaceCoatingTypeEnum. +p.2901 +CharacterisedSurface +CharacterisedSurface +ElectricallyThick +ElectricallyThick +ElectricallyThin +ElectricallyThin +SurfaceRegularLinesConstantParameterEnum +Enumeration Option List +The SurfaceRegularLinesConstantParameterEnum enumeration is accessed as illustrated below. +cf.Enums.SurfaceRegularLinesConstantParameterEnum. +SurfaceRegularLinesSpacingMethodEnum +Enumeration Option List +The SurfaceRegularLinesSpacingMethodEnum enumeration is accessed as illustrated below. +cf.Enums.SurfaceRegularLinesSpacingMethodEnum. +SpecifyLineSpacing +SpecifyLineSpacing +SpecifyNumberOfLines +SpecifyNumberOfLines +Altair Feko 2022.3 +2 Application Programming Interface (API) +TensorDescriptionMethodEnum +Enumeration Option List +The TensorDescriptionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.TensorDescriptionMethodEnum. +p.2904 +ComplexTensor +ComplexTensor +DiagonalisedTensor +DiagonalisedTensor +FullTensor +FullTensor +PolderTensor +PolderTensor +TransmissionLineDefinitionMethodEnum +Enumeration Option List +The TransmissionLineDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.TransmissionLineDefinitionMethodEnum. +MediumAttenuation +MediumAttenuation +SpecifiedAttenuation +SpecifiedAttenuation +VelocityOfPropagation +VelocityOfPropagation +Altair Feko 2022.3 +2 Application Programming Interface (API) +TwistDirectionEnum +Enumeration Option List +The TwistDirectionEnum enumeration is accessed as illustrated below. +cf.Enums.TwistDirectionEnum. +Left +Right +Left +Right +p.2906 +Altair Feko 2022.3 +2 Application Programming Interface (API) +UTDRayContributionsTypeEnum +Enumeration Option List +The UTDRayContributionsTypeEnum enumeration is accessed as illustrated below. +cf.Enums.UTDRayContributionsTypeEnum. +p.2907 +Advanced +Advanced +Default +Default +Altair Feko 2022.3 +2 Application Programming Interface (API) +UnitCellLayerMethodTypeEnum +Enumeration Option List +The UnitCellLayerMethodTypeEnum enumeration is accessed as illustrated below. +cf.Enums.UnitCellLayerMethodTypeEnum. +p.2908 +Aperture +Aperture +Metal +Metal +Substrate +Substrate +Altair Feko 2022.3 +2 Application Programming Interface (API) +UnitCellReferenceVectorEnum +Enumeration Option List +The UnitCellReferenceVectorEnum enumeration is accessed as illustrated below. +cf.Enums.UnitCellReferenceVectorEnum. +p.2909 +UVector +UVector +VVector +VVector +Altair Feko 2022.3 +2 Application Programming Interface (API) +UnlinkMeshOptionEnum +Enumeration Option List +The UnlinkMeshOptionEnum enumeration is accessed as illustrated below. +cf.Enums.UnlinkMeshOptionEnum. +UseExistingPorts +UseExistingPorts +UseNewPorts +UseNewPorts +p.2910 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ViewDirectionEnum +Enumeration Option List +The ViewDirectionEnum enumeration is accessed as illustrated below. +cf.Enums.ViewDirectionEnum. +p.2911 +Back +Back +Bottom +Bottom +Front +Front +Isometric +Isometric +Left +Right +Top +Left +Right +Top +Altair Feko 2022.3 +2 Application Programming Interface (API) +ViewDisplayModeEnum +Enumeration Option List +The ViewDisplayModeEnum enumeration is accessed as illustrated below. +cf.Enums.ViewDisplayModeEnum. +ModelView +ModelView +SimulationMesh +SimulationMesh +p.2912 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ViewModelColourStyleEnum +Enumeration Option List +The ViewModelColourStyleEnum enumeration is accessed as illustrated below. +cf.Enums.ViewModelColourStyleEnum. +p.2913 +ElementNormal +ElementNormal +FaceMedia +FaceMedia +FaceNormalMedia +FaceNormalMedia +RegionMedia +RegionMedia +WaveguidePortReferenceDirectionRotationEnum +Enumeration Option List +The WaveguidePortReferenceDirectionRotationEnum enumeration is accessed as illustrated below. +cf.Enums.WaveguidePortReferenceDirectionRotationEnum. +Rotate0 +Rotate0 +Rotate180 +Rotate180 +Rotate270 +Rotate270 +Rotate90 +Rotate90 +WaveguideSourceDefinitionTypeEnum +Enumeration Option List +The WaveguideSourceDefinitionTypeEnum enumeration is accessed as illustrated below. +cf.Enums.WaveguideSourceDefinitionTypeEnum. +ExciteFundamentalModeOnly +ExciteFundamentalModeOnly +SpecifyModesManually +SpecifyModesManually +Altair Feko 2022.3 +2 Application Programming Interface (API) +WindscreenElementTypeEnum +Enumeration Option List +The WindscreenElementTypeEnum enumeration is accessed as illustrated below. +cf.Enums.WindscreenElementTypeEnum. +p.2916 +Reference +Reference +Solution +Solution +Altair Feko 2022.3 +2 Application Programming Interface (API) +WirePortDefinitionMethodEnum +Enumeration Option List +The WirePortDefinitionMethodEnum enumeration is accessed as illustrated below. +cf.Enums.WirePortDefinitionMethodEnum. +p.2917 +UsingSegment +UsingSegment +UsingVertex +UsingVertex +Altair Feko 2022.3 +2 Application Programming Interface (API) +WirePortLocationEnum +Enumeration Option List +The WirePortLocationEnum enumeration is accessed as illustrated below. +cf.Enums.WirePortLocationEnum. +p.2918 +End +End +Middle +Middle +SpecifiedManually +SpecifiedManually +Start +Start +Altair Feko 2022.3 +2 Application Programming Interface (API) +2.1.5 Data Types (API) +CableRoute +A Lua table of Point entities describing the path of a cable. +p.2919 +Coordinate +A coordinate is a point in 3D space and can be described by either a Point or NamedPoint. +Expression +An expression is a Lua string containing variables and numbers. Eg: “(1+5)*10”. +GridLocation +A Lua table of two values representing the X and Y coordinates on the schematic. +List +A Lua table containing a list (or array) of items of the given type. +Map +A Lua table mapping a key type to a value type. +ObjectReference +A reference (pointer) to an Object. +PointExpression +A value which can be a string or Point. +TerminalType +A terminal type that describes either a Port or a Terminal. +Unit +A string containing a unit. Eg: “m/s^2” +Variant +A value which can be a number, string, boolean, Complex or Point. +boolean +A standard Lua boolean. See Lua documentation for more details. +function +A standard Lua function. See Lua documentation for more details. +number +A standard Lua number. See Lua documentation for more details. +string +A standard Lua string. See Lua documentation for more details. +table +A standard Lua table. See Lua documentation for more details. +2.1.6 Constants (API) +Constants have been defined for use in expressions and calculations. +Constants +The constants are accessed as illustrated below. +cf.Const. +c0 +eps0 +mu0 +pi +zf0 +Speed of light in free space in m/sec. The value of c0 is 299792458.000176. +Permittivity of free space in F/m. The value of eps0 is 8.854187817609999e-12. +Permeability of free space in H/m. The value of mu0 is 1.25663706143592e-06. +Mathematical constant pi (Ludolph's number). The value of pi is 3.141592653589793. +Characteristic impedance of free space in Ohm. The value of zf0 is 376.730313461992. +2.2 POSTFEKO API +The POSTFEKO application programming interface provides details regarding the hierarchy of the object +as well as the methods, functions and properties available for each object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +2.2.1 Objects (API) +p.2923 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ADAPTFEKOLaunchOptions +ADAPTFEKO launch options. +Example +p.2924 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Access the 'ADAPTFEKOLaunchOptions' object and check if temporary files are + deleted +deleteTemporaryFiles = + app.Models[1].Launcher.Settings.ADAPTFEKO.DeleteTemporaryFilesEnabled +Usage locations +The ADAPTFEKOLaunchOptions object can be accessed from the following locations: +• Properties +◦ ComponentLaunchOptions object has property ADAPTFEKO. +Property List +AnalysisRestartNumber +Specifies the model number the analysis can be restarted at. (Read/Write number) +DeleteTemporaryFilesEnabled +Enables/disables if the temporary files generated by the ADAPTFEKO run should be deleted. +(Read/Write boolean) +IncompleteAnalysisRestartEnabled +Enables/disables running the solver from the the first unfinished model if the run was +discontinued (and the temporary files were not deleted). (Read/Write boolean) +Property Details +AnalysisRestartNumber +Specifies the model number the analysis can be restarted at. +Type +number +Access +Read/Write +DeleteTemporaryFilesEnabled +Enables/disables if the temporary files generated by the ADAPTFEKO run should be deleted. +Type +boolean +Access +Read/Write +IncompleteAnalysisRestartEnabled +Enables/disables running the solver from the the first unfinished model if the run was +discontinued (and the temporary files were not deleted). +Type +boolean +Access +Read/Write +AngularGraphAxis +The graph angular axis properties. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.PolarGraphs:Add() + -- SetProperties angular axis settings on the polar graph +axis = graph.AngularAxis +axis.Labels.NumberFormat = pf.Enums.NumberFormatEnum.Scientific +axis.MajorGrid.AutoSpacingEnabled = false +axis.MajorGrid.Spacing = 10 +Usage locations +The AngularGraphAxis object can be accessed from the following locations: +• Properties +◦ PolarGraph object has property AngularAxis. +Property List +Labels +The graph angular axis labels. (Read only GraphAxisLabels) +MajorGrid +The graph angular axis major grid spacing. (Read only AxisGridSpacing) +MinorGridSubdivisions +The number of minor grid subdivisions. (Read/Write number) +Range +The polar graph angular range specified by the AngularRangeEnum, e.g. From0to180 and +From180to360. (Read/Write AngularRangeEnum) +Property Details +Labels +The graph angular axis labels. +Type +GraphAxisLabels +Access +Read only +MajorGrid +The graph angular axis major grid spacing. +Type +AxisGridSpacing +Access +Read only +MinorGridSubdivisions +The number of minor grid subdivisions. +Type +number +Access +Read/Write +Range +The polar graph angular range specified by the AngularRangeEnum, e.g. From0to180 and +From180to360. +Type +AngularRangeEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Application +p.2928 +The POSTFEKO application object which is returned by the pf.GetApplication() method. +Example + -- The "GetApplication" function lives in the "pf" namespace and + -- returns the current POSTFEKO application object. +app = pf.GetApplication() + -- Start a new project to ensure the session is clean +app:NewProject() + -- Open an example file located in the FEKO_HOME folder and cascade the windows +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) +app:CascadeWindows() +Property List +MSPowerPointInstalled +A flag indicating if Microsoft PowerPoint is installed on the system. (Read only boolean) +MSWordInstalled +A flag indicating if Microsoft Word is installed on the system. (Read only boolean) +Modified +True if the current session is modified and needs to be saved. (Read only boolean) +SessionName +The session name if it has one. (Read only string) +SessionPath +The path of the project file if it has one or the current working directory path. (Read only string) +Type +The object type string. (Read only string) +Version +The application version. (Read only Version) +Collection List +CartesianGraphs +The collection of Cartesian graphs in the project. (CartesianGraphCollection of CartesianGraph.) +CartesianSurfaceGraphs +The collection of Cartesian surface graphs in the project. (CartesianSurfaceGraphCollection of +CartesianSurfaceGraph.) +ImportedDataSets +The collection of imported data sets in the project. (ImportedDataSetCollection of ImportSet.) +MathScripts +The collection of math scripts in the project. (MathScriptCollection of MathScript.) +Models +The collection of models in the project. (ModelCollection of Model.) +PolarGraphs +The collection of Polar graphs in the project. (PolarGraphCollection of PolarGraph.) +Reports +The collection of report templates in the project. (ReportsCollection of ReportTemplate.) +SmithCharts +The collection of Smith charts in the project. (SmithChartCollection of SmithChart.) +StoredData +The collection of stored data in the project. (StoredDataCollection of ResultData.) +Views +The collection of 3D model views in the project. (ViewCollection of View.) +Windows +The collection of all the 3D model views and 3d graphs in the project. (WindowCollection of +Window.) +Method List +CascadeWindows () +Cascade the windows. +Close () +Close the POSTFEKO application. +CloseAllWindows () +Close all windows. +CreateQuickReport (filename string, type ReportDocumentTypeEnum) +Create a quick report. (Returns a QuickReport object.) +ExportAllWindowsAsImages (directory string, fileformat string) +Export all window images to a specified directory. +ExportAllWindowsAsImages (directory string, fileformat string, imagewidth number, imageheight +number) +Export all window images to a specified directory. +ImportResults (filename string, type ImportFileTypeEnum) +Import results data from a specified file. (Returns a ImportSet object.) +ImportResults (filenames List of string, type ImportFileTypeEnum) +Import results data from specified files. (Returns a List of ImportSet object.) +NewProject () +Starts a new project. +OpenFile (filename string) +Opens a file. +Redo () +Redo the last model operation. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReloadChangedFiles () +p.2930 +All models and imported files are compared to the versions that were loaded. If they have +changed, they will be reloaded or indicated as modified. The operation happens periodically during +an interactive POSTFEKO session but does is not performed automatically during script execution. +Save () +Saves the current session. +SaveAs (filename string) +Saves the current session with the given name. +TileWindows () +Tile the windows. +Undo () +Undo the last model operation. +Property Details +MSPowerPointInstalled +A flag indicating if Microsoft PowerPoint is installed on the system. +Type +boolean +Access +Read only +MSWordInstalled +A flag indicating if Microsoft Word is installed on the system. +Type +boolean +Access +Read only +Modified +True if the current session is modified and needs to be saved. +Type +boolean +Access +Read only +SessionName +The session name if it has one. +Type +string +Access +Read only +SessionPath +The path of the project file if it has one or the current working directory path. +Type +string +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Version +The application version. +Type +Version +Access +Read only +Collection Details +CartesianGraphs +The collection of Cartesian graphs in the project. +Type +CartesianGraphCollection +CartesianSurfaceGraphs +The collection of Cartesian surface graphs in the project. +Type +CartesianSurfaceGraphCollection +ImportedDataSets +The collection of imported data sets in the project. +Type +ImportedDataSetCollection +MathScripts +The collection of math scripts in the project. +Type +MathScriptCollection +Models +The collection of models in the project. +Type +ModelCollection +PolarGraphs +The collection of Polar graphs in the project. +Type +PolarGraphCollection +Reports +The collection of report templates in the project. +Type +ReportsCollection +SmithCharts +The collection of Smith charts in the project. +Type +SmithChartCollection +StoredData +The collection of stored data in the project. +Type +StoredDataCollection +Views +The collection of 3D model views in the project. +Type +ViewCollection +Windows +The collection of all the 3D model views and 3d graphs in the project. +Type +WindowCollection +Method Details +CascadeWindows () +Cascade the windows. +Close () +Close the POSTFEKO application. +CloseAllWindows () +Close all windows. +CreateQuickReport (filename string, type ReportDocumentTypeEnum) +Create a quick report. +Input Parameters +filename(string) +The filename of the quick report to generate. +type(ReportDocumentTypeEnum) +The document type specified by the ReportDocumentTypeEnum, e.g. PDF, MSWord or +MSPowerPoint. +Return +QuickReport +The quick report to generate. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.pfs]]) + -- Create a PDF quick report (called exampleReport.pdf) and give it a heading +report = app:CreateQuickReport([[temp_exampleReport1]], pf.Enums.ReportDocumentTypeEnum.PDF) +report.DocumentHeading = "Example report" + -- Exclude the cartesian graph window +report:SetPageIncluded("Cartesian graph1", false) + -- Generate the document +report:Generate() +ExportAllWindowsAsImages (directory string, fileformat string) +Export all window images to a specified directory. +Input Parameters +directory(string) +The directory to export the files to. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +ExportAllWindowsAsImages (directory string, fileformat string, imagewidth number, imageheight +number) +Export all window images to a specified directory. +Input Parameters +directory(string) +The directory to export the files to. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +imagewidth(number) +The export width in pixels. +imageheight(number) +The export height in pixels. +ImportResults (filename string, type ImportFileTypeEnum) +Import results data from a specified file. +Input Parameters +filename(string) +The name of the file to import. +type(ImportFileTypeEnum) +The data type of the file to import specified by the ImportFileTypeEnum, e.g. +FEKOFarField, FEKOMagneticNearField, Touchstone, etc. +Return +ImportSet +The import set containing the imported result data. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +nearField = app.Models[1].Configurations[1].NearFields[1] +fileName = "temp_nearField" +nearField:ExportData(fileName, pf.Enums.NearFieldsExportTypeEnum.Electric, 51) + -- Import the near field results that have just been exported +importSet = + app:ImportResults(fileName..".efe",pf.Enums.ImportFileTypeEnum.FEKOElectricNearField) + -- Compare the original and imported near fields +view = app.Views[1] +view.Plots:Add(nearField) +viewCopy = view:Duplicate() +viewCopy.Plots:Add(importSet.ImportedData[1]) +app:TileWindows() +ImportResults (filenames List of string, type ImportFileTypeEnum) +Import results data from specified files. +Input Parameters +filenames(List of string) +The names of the files to import (List of string). +type(ImportFileTypeEnum) +The data type of the file to import specified by the ImportFileTypeEnum, e.g. +FEKOFarField, FEKOMagneticNearField, Touchstone, etc. +Return +List of ImportSet +The list of import sets containing the imported result data. +NewProject () +Starts a new project. +OpenFile (filename string) +Opens a file. +Input Parameters +filename(string) +The name of the file to open. +Redo () +Redo the last model operation. +ReloadChangedFiles () +All models and imported files are compared to the versions that were loaded. If they have +changed, they will be reloaded or indicated as modified. The operation happens periodically during +an interactive POSTFEKO session but does is not performed automatically during script execution. +Save () +Saves the current session. +SaveAs (filename string) +Saves the current session with the given name. +Input Parameters +filename(string) +The name of the pfs file. +TileWindows () +Tile the windows. +Undo () +Undo the last model operation. +Arrows3DFormat +The 3D plot arrows properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Display instantaneous current arrows +surfaceCurrents = + app.Views[1].Plots:Add(app.Models[1].Configurations[1].SurfaceCurrents[1]) +surfaceCurrents.Quantity.ComplexComponent + = pf.Enums.ComplexComponentEnum.Instantaneous +surfaceCurrents.Quantity.InstantaneousPhase = 240 +surfaceCurrents.Arrows.Visible = true +surfaceCurrents.Arrows.FixedSize = true +surfaceCurrents.Arrows.Colour = "ByMagnitude" +Usage locations +The Arrows3DFormat object can be accessed from the following locations: +• Properties +◦ WireCurrents3DPlot object has property Arrows. +◦ SurfaceCurrents3DPlot object has property Arrows. +◦ NearField3DPlot object has property Arrows. +Property List +Colour +The colour of the instantaneous arrows. (Read/Write MagnitudeColour) +FixedSize +Specifies whether the instantaneous arrows should be drawn at a fixed size. (Read/Write boolean) +Size +The size (%) of the instantaneous arrows in the range [0,280]. (Read/Write number) +Visible +Specifies whether the instantaneous arrows must be shown or hidden. (Read/Write boolean) +Property Details +Colour +The colour of the instantaneous arrows. +Type +MagnitudeColour +Access +Read/Write +FixedSize +Specifies whether the instantaneous arrows should be drawn at a fixed size. +Type +boolean +Access +Read/Write +Size +The size (%) of the instantaneous arrows in the range [0,280]. +Type +number +Access +Read/Write +Visible +Specifies whether the instantaneous arrows must be shown or hidden. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Axes3DFormat +The 3D plot local coordinate axis properties. +Example +p.2938 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farField = app.Views[1].Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Show local axis +farField.LocalCoordAxes.Visible = true +Usage locations +The Axes3DFormat object can be accessed from the following locations: +• Properties +◦ FarField3DPlot object has property LocalCoordAxes. +◦ NearField3DPlot object has property LocalCoordAxes. +Property List +Visible +Specifies whether the local coordinate axes must be shown or hidden for the 3D plot. (Read/Write +boolean) +Property Details +Visible +Specifies whether the local coordinate axes must be shown or hidden for the 3D plot. +Type +boolean +Access +Read/Write +AxisGridSpacing +The axis grid spacing properties. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianGraphs:Add() + -- Set horizontal display range +graph.HorizontalAxis.Range.AutoRangeEnabled = false +graph.HorizontalAxis.Range.Min = 0 +graph.HorizontalAxis.Range.Max = 1 + -- Set grid spacing +graph.HorizontalAxis.MajorGrid.AutoSpacingEnabled = false +graph.HorizontalAxis.MajorGrid.Spacing = 0.25 +Usage locations +The AxisGridSpacing object can be accessed from the following locations: +• Properties +◦ AngularGraphAxis object has property MajorGrid. +◦ RadialGraphAxis object has property MajorGrid. +◦ VerticalGraphAxis object has property MajorGrid. +◦ HorizontalGraphAxis object has property MajorGrid. +Property List +AutoSpacingEnabled +Use automatically generated major grid spacing for the axis. (Read/Write boolean) +Spacing +Major axis grid spacing. (Read/Write number) +Property Details +AutoSpacingEnabled +Use automatically generated major grid spacing for the axis. +Type +boolean +Access +Read/Write +Spacing +Major axis grid spacing. +Type +number +Access +Read/Write +AxisRange +The axis range properties. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianGraphs:Add() + -- Set horizontal display range +graph.HorizontalAxis.Range.AutoRangeEnabled = false +graph.HorizontalAxis.Range.Min = 0 +graph.HorizontalAxis.Range.Max = 5 +Usage locations +The AxisRange object can be accessed from the following locations: +• Properties +◦ RadialGraphAxis object has property Range. +◦ VerticalGraphAxis object has property Range. +◦ HorizontalGraphAxis object has property Range. +Property List +AutoRangeEnabled +Enable the automatic range of the axis. (Read/Write boolean) +Max +Min +Axis range maximum value. (Read/Write number) +Axis range minimum value. (Read/Write number) +Property Details +AutoRangeEnabled +Enable the automatic range of the axis. +Type +boolean +Access +Read/Write +Max +Axis range maximum value. +Type +number +Access +Read/Write +Min +Axis range minimum value. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +BandwidthAnnotation +A 2D graph bandwidth annotation. +Example +p.2943 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +app.Views[1]:Close() + -- Add a Cartesian graph to the application's collection and obtain + -- the annoation collection +graph = app.CartesianGraphs:Add() +sourceTrace = graph.Traces:Add(app.Models[1].Configurations[1].Excitations[1]) +graph:ZoomToExtents() +annotations = graph.Annotations + -- Add annotations +annotation1 = annotations:AddBandwidthAnnotation(sourceTrace, + pf.Enums.AnnotationBandwidthTypeEnum.PassiveReflection, 5.0) +annotation2 = annotations:AddBandwidth3dBAnnotation(sourceTrace, + pf.Enums.AnnotationBandwidthTypeEnum.PassiveReflection) +annotation3 = annotations:AddBandwidth10dBAnnotation(sourceTrace, + pf.Enums.AnnotationBandwidthTypeEnum.PassiveReflection) +annotation4 = annotations:AddBandwidth15dBAnnotation(sourceTrace, + pf.Enums.AnnotationBandwidthTypeEnum.PassiveReflection) +Inheritance +The BandwidthAnnotation object is derived from the GraphAnnotation object. +Property List +AnnotationRelativeType +For annotations that are relative to other graph positions, this values sets what it is relative to. +(Read/Write AnnotationRelativeTypeEnum) +AutoTextEnabled +Toggle between auto text and custom annotation text. (Read/Write boolean) +BandwidthLevel +The bandwidth level. (Read/Write number) +BandwidthType +The single point annotation type. (Read/Write AnnotationBandwidthTypeEnum) +Label +The object label. (Read/Write string) +OffsetX +Annotation text box offset (pixels) in the x-direction. A positive value moves the annotation to the +right, a negative value moves it to the left. If both the OffsetX and OffsetY is zero, it will be placed +automatically. (Read/Write number) +Altair Feko 2022.3 +2 Application Programming Interface (API) +OffsetY +p.2944 +Annotation text box offset (pixels) in the y-direction. A positive value moves the annotation to +the bottom, a negative value moves it to the top. If both the OffsetX and OffsetY is zero, it will be +placed automatically. (Read/Write number) +Text +Trace +Type +The annotation text. (Read/Write string) +The ResultTrace of the annotation. (Read/Write ResultTrace) +The object type string. (Read only string) +Method List +Delete () +Delete the annotation. +Duplicate () +Duplicate the annotation. (Returns a GraphAnnotation object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +GetValues () +Get table of values associated with the annotation. (Returns a Map of string:Expression object.) +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Property Details +AnnotationRelativeType +For annotations that are relative to other graph positions, this values sets what it is relative to. +Type +AnnotationRelativeTypeEnum +Access +Read/Write +AutoTextEnabled +Toggle between auto text and custom annotation text. +Type +boolean +Access +Read/Write +BandwidthLevel +The bandwidth level. +Type +number +Access +Read/Write +BandwidthType +The single point annotation type. +Type +AnnotationBandwidthTypeEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +OffsetX +Annotation text box offset (pixels) in the x-direction. A positive value moves the annotation to the +right, a negative value moves it to the left. If both the OffsetX and OffsetY is zero, it will be placed +automatically. +Type +number +Access +Read/Write +OffsetY +Annotation text box offset (pixels) in the y-direction. A positive value moves the annotation to +the bottom, a negative value moves it to the top. If both the OffsetX and OffsetY is zero, it will be +placed automatically. +Type +number +Access +Read/Write +Text +The annotation text. +Type +string +Access +Read/Write +Trace +The ResultTrace of the annotation. +Type +ResultTrace +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the annotation. +Duplicate () +Duplicate the annotation. +Return +GraphAnnotation +The new annotation. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +GetValues () +A properties table. +Get table of values associated with the annotation. +Return +Map of string:Expression +Table of key-value pairs. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +BeamwidthAnnotation +A 2D graph beam width annotation. +Example +p.2948 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +app.Views[1]:Close() + -- Add a Cartesian graph to the application's collection and obtain + -- the annoation collection +graph = app.CartesianGraphs:Add() +farFieldTrace = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) +farFieldTrace.IndependentAxis = "Theta" +farFieldTrace:SetFixedAxisValue("Frequency", 7.85, "GHz") +farFieldTrace.Quantity.Component = pf.Enums.FarFieldQuantityComponentEnum.Theta +graph:ZoomToExtents() +annotations = graph.Annotations + -- Add annotations +annotation1 = annotations:AddBeamwidthAnnotation(farFieldTrace, + pf.Enums.AnnotationBeamwidthTypeEnum.HalfPowerBeamwidth, + pf.Enums.AnnotationRelativeTypeEnum.RelativeToGlobalMax) +annotation2 = annotations:AddFirstNullBeamwidthAnnotation(farFieldTrace) +Inheritance +The BeamwidthAnnotation object is derived from the GraphAnnotation object. +Property List +AnnotationRelativeType +For annotations that are relative to other graph positions, this values sets what it is relative to. +(Read/Write AnnotationRelativeTypeEnum) +AutoTextEnabled +Toggle between auto text and custom annotation text. (Read/Write boolean) +BeamwidthType +The single point annotation type. (Read/Write AnnotationBeamwidthTypeEnum) +Label +The object label. (Read/Write string) +OffsetX +Annotation text box offset (pixels) in the x-direction. A positive value moves the annotation to the +right, a negative value moves it to the left. If both the OffsetX and OffsetY is zero, it will be placed +automatically. (Read/Write number) +OffsetY +Annotation text box offset (pixels) in the y-direction. A positive value moves the annotation to +the bottom, a negative value moves it to the top. If both the OffsetX and OffsetY is zero, it will be +placed automatically. (Read/Write number) +Text +Trace +Type +The annotation text. (Read/Write string) +The ResultTrace of the annotation. (Read/Write ResultTrace) +The object type string. (Read only string) +Method List +Delete () +Delete the annotation. +Duplicate () +Duplicate the annotation. (Returns a GraphAnnotation object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +GetValues () +Get table of values associated with the annotation. (Returns a Map of string:Expression object.) +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Property Details +AnnotationRelativeType +For annotations that are relative to other graph positions, this values sets what it is relative to. +Type +AnnotationRelativeTypeEnum +Access +Read/Write +AutoTextEnabled +Toggle between auto text and custom annotation text. +Type +boolean +Access +Read/Write +BeamwidthType +The single point annotation type. +Type +AnnotationBeamwidthTypeEnum +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +OffsetX +Annotation text box offset (pixels) in the x-direction. A positive value moves the annotation to the +right, a negative value moves it to the left. If both the OffsetX and OffsetY is zero, it will be placed +automatically. +Type +number +Access +Read/Write +OffsetY +Annotation text box offset (pixels) in the y-direction. A positive value moves the annotation to +the bottom, a negative value moves it to the top. If both the OffsetX and OffsetY is zero, it will be +placed automatically. +Type +number +Access +Read/Write +Text +The annotation text. +Type +string +Access +Read/Write +Trace +The ResultTrace of the annotation. +Type +ResultTrace +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the annotation. +Duplicate () +Duplicate the annotation. +Return +GraphAnnotation +The new annotation. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +GetValues () +A properties table. +Get table of values associated with the annotation. +Return +Map of string:Expression +Table of key-value pairs. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CartesianGraph +A 2D Cartesian graph where results can be plotted. +Example +p.2952 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a graph with a trace +graph = app.CartesianGraphs:Add() +farFieldTrace = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Export an image at a specific aspect ratio +graph:Restore() +graph:SetSize(800,400) +graph:ExportImage("temp_FarFieldGraph", "png", 1000, 500) +Inheritance +The CartesianGraph object is derived from the Graph object. +Usage locations +The CartesianGraph object can be accessed from the following locations: +• Methods +◦ SmithChart object has method DuplicateAsCartesian(). +◦ PolarGraph object has method DuplicateAsCartesian(). +◦ CartesianGraphCollection collection has method Items(). +◦ CartesianGraphCollection collection has method Item(number). +◦ CartesianGraphCollection collection has method Item(string). +◦ CartesianGraphCollection collection has method Add(). +Property List +BackColour +The background colour of the graph. (Read/Write Colour) +Footer +The graph footer properties. (Read only TextBox) +GreyscaleEnabled +Set the graph's colour scheme to greyscale. (Read/Write boolean) +Grid +The Cartesian graph grid properties. (Read only CartesianGraphGrid) +Height +The height of the window. (Read only number) +HorizontalAxis +The Cartesian graph horizontal axis properties. (Read only HorizontalGraphAxis) +Legend +The graph legend properties. (Read only GraphLegend) +Normalisation +The Cartesian vertical axis normalisation properties. (Read only Normalisation) +Title +Type +The graph title properties. (Read only TextBox) +The object type string. (Read only string) +VerticalAxis +The Cartesian graph vertical axis properties. (Read only VerticalGraphAxis) +Width +The width of the window. (Read only number) +WindowActive +True if this window is the active window. (Read only boolean) +WindowTitle +The title of the window. (Read/Write string) +XPosition +The X position of the window. (Read only number) +YPosition +The Y position of the window. (Read only number) +Collection List +Annotations +The collection of 2D annotations on the graph. (ResultAnnotationCollection of GraphAnnotation.) +Arrows +The collection of 2D arrows on the graph. (ResultArrowCollection of ResultArrow.) +Shapes +The collection of 2D shapes on the graph. (ResultTextBoxCollection of ResultTextBox.) +Traces +The collection of 2D traces on the graph. (ResultTraceCollection of ResultTrace.) +Method List +AddChartImage (view View, posX number, posY number) +Add a 3D view image to this 2D Graph. +AddChartImageFromFile (file string, posX number, posY number) +Add an image file to this 2D Graph. +AddMathTrace () +Adds a math trace to the 2D graph. (Returns a MathTrace object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +BlockGraphRedraws () +p.2954 +Disables graph redraws for performance purposes. When all the changes to the graph are +complete, call UnblockGraphRedraws to re-enable graph updates. +Close () +Close the window. +Duplicate () +Duplicate the 2D graph. (Returns a Graph object.) +DuplicateAsPolar () +Creates a polar graph with the same data as the Cartesian graph. (Returns a PolarGraph object.) +DuplicateAsSmith () +Creates a Smith chart with the same data as the Cartesian graph. (Returns a SmithChart object.) +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +ExportTraces (filename string, samples number) +Export the graph traces to the specified tab separated file. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Show () +Shows the view. +UnblockGraphRedraws () +Enables graph redraws. This method is used in conjunction with BlockGraphRedraws for +performance purposes. The graph is redrawn when this method is called and normals redraws will +occur on changes. +ZoomToExtents () +Zoom the content of the window to its extent. +Property Details +BackColour +The background colour of the graph. +Type +Colour +Access +Read/Write +Footer +The graph footer properties. +Type +TextBox +Access +Read only +GreyscaleEnabled +Set the graph's colour scheme to greyscale. +Type +boolean +Access +Read/Write +Grid +The Cartesian graph grid properties. +Type +CartesianGraphGrid +Access +Read only +Height +The height of the window. +Type +number +Access +Read only +HorizontalAxis +The Cartesian graph horizontal axis properties. +Type +HorizontalGraphAxis +Access +Read only +Legend +The graph legend properties. +Type +GraphLegend +Access +Read only +Normalisation +The Cartesian vertical axis normalisation properties. +Type +Normalisation +Access +Read only +Title +The graph title properties. +Type +TextBox +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VerticalAxis +The Cartesian graph vertical axis properties. +Type +VerticalGraphAxis +Access +Read only +Width +The width of the window. +Type +number +Access +Read only +WindowActive +True if this window is the active window. +Type +boolean +Access +Read only +WindowTitle +The title of the window. +Type +string +Access +Read/Write +XPosition +The X position of the window. +Type +number +Access +Read only +YPosition +The Y position of the window. +Type +number +Access +Read only +Collection Details +Annotations +The collection of 2D annotations on the graph. +Type +Arrows +ResultAnnotationCollection +The collection of 2D arrows on the graph. +Type +ResultArrowCollection +Shapes +The collection of 2D shapes on the graph. +Type +Traces +ResultTextBoxCollection +The collection of 2D traces on the graph. +Type +ResultTraceCollection +Method Details +AddChartImage (view View, posX number, posY number) +Add a 3D view image to this 2D Graph. +Input Parameters +view(View) +The 3D view. +posX(number) +The x-position of the added chart image. +posY(number) +The y-position of the added chart image. +AddChartImageFromFile (file string, posX number, posY number) +Add an image file to this 2D Graph. +Input Parameters +file(string) +The file. +posX(number) +The x-position of the added chart image. +posY(number) +The y-position of the added chart image. +AddMathTrace () +Adds a math trace to the 2D graph. +Return +MathTrace +The math trace. +BlockGraphRedraws () +Disables graph redraws for performance purposes. When all the changes to the graph are +complete, call UnblockGraphRedraws to re-enable graph updates. +Close () +Close the window. +Duplicate () +Duplicate the 2D graph. +Return +Graph +The duplicated 2D graph. +DuplicateAsPolar () +Creates a polar graph with the same data as the Cartesian graph. +Return +PolarGraph +The copied polar graph. +DuplicateAsSmith () +Creates a Smith chart with the same data as the Cartesian graph. +Return +SmithChart +The copied Smith chart. +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +imagewidth(number) +The export width in pixels. +imageheight(number) +The export height in pixels. +ExportTraces (filename string, samples number) +Export the graph traces to the specified tab separated file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +Altair Feko 2022.3 +2 Application Programming Interface (API) +samples(number) +p.2960 +The number of samples for continuous data. This value will be ignored if the first trace +on the graph is discrete. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +Input Parameters +xposition(number) +The view X position. +yposition(number) +The view Y position. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Input Parameters +imagewidth(number) +The view width in pixels. +imageheight(number) +The view height in pixels. +Show () +Shows the view. +Altair Feko 2022.3 +2 Application Programming Interface (API) +UnblockGraphRedraws () +p.2961 +Enables graph redraws. This method is used in conjunction with BlockGraphRedraws for +performance purposes. The graph is redrawn when this method is called and normals redraws will +occur on changes. +ZoomToExtents () +Zoom the content of the window to its extent. +CartesianGraphGrid +The Cartesian graph grid properties. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianGraphs:Add() + -- Update grid visualisation properties +graph.Grid.Minor.Visible = true +graph.Grid.BackColour = pf.Enums.ColourEnum.DarkGreen +Usage locations +The CartesianGraphGrid object can be accessed from the following locations: +• Properties +◦ CartesianGraph object has property Grid. +Property List +BackColour +The background colour of the Cartesian graph grid. (Read/Write Colour) +Border +The line format for the Cartesian graph grid border. (Read only GraphLineFormat) +Major +Minor +The Cartesian graph major grid properties. (Read only CartesianGridLines) +The Cartesian graph minor grid properties. (Read only CartesianGridLines) +Property Details +BackColour +The background colour of the Cartesian graph grid. +Type +Colour +Access +Read/Write +Border +The line format for the Cartesian graph grid border. +Type +GraphLineFormat +Access +Read only +Major +Minor +The Cartesian graph major grid properties. +Type +CartesianGridLines +Access +Read only +The Cartesian graph minor grid properties. +Type +CartesianGridLines +Access +Read only +CartesianGridLines +The Cartesian graph grid lines properties. +Example +app = pf.GetApplication() +app:NewProject() + -- Edit 'CartesianGridLines' properties +graph = app.CartesianGraphs:Add() +graph.Grid.Minor.Visible = true +graph.Grid.Major.HorizontalLine.Weight = 3 +graph.Grid.Major.VerticalLine.Weight = 3 +Usage locations +The CartesianGridLines object can be accessed from the following locations: +• Properties +◦ CartesianGraphGrid object has property Major. +◦ CartesianGraphGrid object has property Minor. +Property List +HorizontalLabelsVisible +Controls the visibility of the horizontal Cartesian graph grid line labels. Only valid for minor grid +labels. (Read/Write boolean) +HorizontalLine +The line format for the Cartesian graph horizontal grid. (Read only GraphLineFormat) +VerticalLabelsVisible +Controls the visibility of the vertical Cartesian graph grid line labels. Only valid for minor grid +labels. (Read/Write boolean) +VerticalLine +The line format for the Cartesian graph vertical grid. (Read only GraphLineFormat) +Visible +Controls the visibility of the Cartesian graph grid lines. (Read/Write boolean) +Property Details +HorizontalLabelsVisible +Controls the visibility of the horizontal Cartesian graph grid line labels. Only valid for minor grid +labels. +Type +boolean +Access +Read/Write +HorizontalLine +The line format for the Cartesian graph horizontal grid. +Type +GraphLineFormat +Access +Read only +VerticalLabelsVisible +Controls the visibility of the vertical Cartesian graph grid line labels. Only valid for minor grid +labels. +Type +boolean +Access +Read/Write +VerticalLine +The line format for the Cartesian graph vertical grid. +Type +GraphLineFormat +Access +Read only +Visible +Controls the visibility of the Cartesian graph grid lines. +Type +boolean +Access +Read/Write +CartesianSurfaceGraph +A Cartesian surface graph where results can be plotted. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a surface graph with a trace +graph = app.CartesianSurfaceGraphs:Add() +farFieldPlot = graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Export an image at a specific aspect ratio +graph:Restore() +graph:SetSize(800,400) +graph:ExportImage("temp_FarFieldGraph", "png", 1000, 500) +Inheritance +The CartesianSurfaceGraph object is derived from the SurfaceGraph object. +Usage locations +The CartesianSurfaceGraph object can be accessed from the following locations: +• Methods +◦ CartesianSurfaceGraph object has method Duplicate(). +◦ SurfaceGraph object has method Duplicate(). +◦ CartesianSurfaceGraphCollection collection has method Items(). +◦ CartesianSurfaceGraphCollection collection has method Item(number). +◦ CartesianSurfaceGraphCollection collection has method Item(string). +◦ CartesianSurfaceGraphCollection collection has method Add(). +Property List +Footer +The surface graph footer properties. (Read only SurfaceGraphTextBox) +GreyscaleEnabled +Set the graph's colour scheme to greyscale. (Read/Write boolean) +Grid +The Cartesian surface graph grid properties. (Read only CartesianSurfaceGraphGrid) +Height +The height of the window. (Read only number) +HorizontalAxis +The Cartesian surface graph horizontal axis properties. (Read only HorizontalSurfaceGraphAxis) +Legend +The surface graph legend properties. (Read only SurfaceGraphLegend) +LockedAspectRatio +Links the horizontal and vertical graph axes so as to keep a one-to-one aspect. Specified by the +LockedAspectRatioEnum, e.g. Auto, On or Off. (Read/Write LockedAspectRatioEnum) +Title +Type +The surface graph title properties. (Read only SurfaceGraphTextBox) +The object type string. (Read only string) +VerticalAxis +The Cartesian surface graph vertical axis properties. (Read only VerticalSurfaceGraphAxis) +Width +The width of the window. (Read only number) +WindowActive +True if this window is the active window. (Read only boolean) +WindowTitle +The title of the window. (Read/Write string) +XPosition +The X position of the window. (Read only number) +YPosition +The Y position of the window. (Read only number) +Collection List +Plots +The collection of surface plots on the graph. (ResultSurfacePlotCollection of ResultSurfacePlot.) +Method List +BlockGraphRedraws () +Disables graph redraws for performance purposes. When all the changes to the graph are +complete, call UnblockGraphRedraws to re-enable graph updates. +Close () +Close the window. +Duplicate () +Duplicate the surface graph. (Returns a CartesianSurfaceGraph object.) +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.2968 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Show () +Shows the view. +UnblockGraphRedraws () +Enables graph redraws. This method is used in conjunction with BlockGraphRedraws for +performance purposes. The graph is redrawn when this method is called and normals redraws will +occur on changes. +ZoomToExtents () +Zoom the content of the window to its extent. +Property Details +Footer +The surface graph footer properties. +Type +SurfaceGraphTextBox +Access +Read only +GreyscaleEnabled +Set the graph's colour scheme to greyscale. +Type +boolean +Access +Read/Write +Grid +The Cartesian surface graph grid properties. +Type +CartesianSurfaceGraphGrid +Access +Read only +Height +The height of the window. +Type +number +Access +Read only +HorizontalAxis +The Cartesian surface graph horizontal axis properties. +Type +HorizontalSurfaceGraphAxis +Access +Read only +Legend +The surface graph legend properties. +Type +SurfaceGraphLegend +Access +Read only +LockedAspectRatio +Links the horizontal and vertical graph axes so as to keep a one-to-one aspect. Specified by the +LockedAspectRatioEnum, e.g. Auto, On or Off. +Type +LockedAspectRatioEnum +Access +Read/Write +Title +The surface graph title properties. +Type +SurfaceGraphTextBox +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VerticalAxis +The Cartesian surface graph vertical axis properties. +Type +VerticalSurfaceGraphAxis +Access +Read only +Width +The width of the window. +Type +number +Access +Read only +WindowActive +True if this window is the active window. +Type +boolean +Access +Read only +WindowTitle +The title of the window. +Type +string +Access +Read/Write +XPosition +The X position of the window. +Type +number +Access +Read only +YPosition +The Y position of the window. +Type +number +Access +Read only +Collection Details +Plots +The collection of surface plots on the graph. +Type +ResultSurfacePlotCollection +Method Details +BlockGraphRedraws () +Disables graph redraws for performance purposes. When all the changes to the graph are +complete, call UnblockGraphRedraws to re-enable graph updates. +Close () +Close the window. +Duplicate () +Duplicate the surface graph. +Return +CartesianSurfaceGraph +The duplicated surface graph. +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +imagewidth(number) +The export width in pixels. +Altair Feko 2022.3 +2 Application Programming Interface (API) +imageheight(number) +The export height in pixels. +GetProperties () +p.2972 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +Input Parameters +xposition(number) +The view X position. +yposition(number) +The view Y position. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Input Parameters +imagewidth(number) +The view width in pixels. +imageheight(number) +The view height in pixels. +Show () +Shows the view. +Altair Feko 2022.3 +2 Application Programming Interface (API) +UnblockGraphRedraws () +p.2973 +Enables graph redraws. This method is used in conjunction with BlockGraphRedraws for +performance purposes. The graph is redrawn when this method is called and normals redraws will +occur on changes. +ZoomToExtents () +Zoom the content of the window to its extent. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CartesianSurfaceGraphGrid +The Cartesian graph grid properties. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianSurfaceGraphs:Add() + -- Update grid visualisation properties +graph.Grid.Minor.Visible = true +p.2974 +Usage locations +The CartesianSurfaceGraphGrid object can be accessed from the following locations: +• Properties +◦ CartesianSurfaceGraph object has property Grid. +Property List +Major +Minor +The Cartesian surface graph major grid properties. (Read only CartesianSurfaceGraphGridLines) +The Cartesian surface graph minor grid properties. (Read only CartesianSurfaceGraphGridLines) +Property Details +Major +The Cartesian surface graph major grid properties. +Type +CartesianSurfaceGraphGridLines +Access +Read only +Minor +The Cartesian surface graph minor grid properties. +Type +CartesianSurfaceGraphGridLines +Access +Read only +CartesianSurfaceGraphGridLines +The Cartesian graph grid lines properties. +Example +app = pf.GetApplication() +app:NewProject() + -- Edit 'CartesianSurfaceGraphGridLines' properties +graph = app.CartesianSurfaceGraphs:Add() +graph.Grid.Minor.Visible = true +graph.Grid.Major.HorizontalLine.Weight = 3 +graph.Grid.Major.VerticalLine.Weight = 3 +Usage locations +The CartesianSurfaceGraphGridLines object can be accessed from the following locations: +• Properties +◦ CartesianSurfaceGraphGrid object has property Major. +◦ CartesianSurfaceGraphGrid object has property Minor. +Property List +HorizontalLabelsVisible +Controls the visibility of the horizontal Cartesian surface graph grid line labels. Only valid for +minor grid labels. (Read/Write boolean) +HorizontalLine +The line format for the Cartesian surface graph horizontal grid. (Read only +SurfaceGraphLineFormat) +VerticalLabelsVisible +Controls the visibility of the vertical Cartesian surface graph grid line labels. Only valid for minor +grid labels. (Read/Write boolean) +VerticalLine +The line format for the Cartesian surface graph vertical grid. (Read only SurfaceGraphLineFormat) +Visible +Controls the visibility of the Cartesian surface graph grid lines. (Read/Write boolean) +Property Details +HorizontalLabelsVisible +Controls the visibility of the horizontal Cartesian surface graph grid line labels. Only valid for +minor grid labels. +Type +boolean +Access +Read/Write +HorizontalLine +The line format for the Cartesian surface graph horizontal grid. +Type +SurfaceGraphLineFormat +Access +Read only +VerticalLabelsVisible +Controls the visibility of the vertical Cartesian surface graph grid line labels. Only valid for minor +grid labels. +Type +boolean +Access +Read/Write +VerticalLine +The line format for the Cartesian surface graph vertical grid. +Type +SurfaceGraphLineFormat +Access +Read only +Visible +Controls the visibility of the Cartesian surface graph grid lines. +Type +boolean +Access +Read/Write +CharacteristicModeData +Characteristic mode results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CharacteristicModes.fek]]) + -- Retrieve the 'CharacteristicModeData' called 'CharacteristicModes1' from the + -- characteristic mode configuration +charMode = app.Models[1].Configurations["CharacteristicModeConfiguration1"]. + CharacteristicModes["CharacteristicModes1"] + -- Manipulate the CharacteristicModes data. See 'DataSet' for faster and more + comprehensive + -- options +dataSet = charMode:GetDataSet() +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Find the frequency start and end values +frequencyAxis = dataSet.Axes["Frequency"] +frequencyStartValue = frequencyAxis:ValueAt(1) +frequencyEndValue = frequencyAxis:ValueAt(#frequencyAxis) + -- Scale the characteristic mode eigen values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + for modeIndex = 1, #dataSet.Axes["Mode"] do + indexedValue = dataSet[freqIndex][modeIndex] + indexedValue.EigenValue = indexedValue.EigenValue * scale + end +end + -- Store the manipulated data +scaledCharacteristicModes = + dataSet:StoreData(pf.Enums.StoredDataTypeEnum.CharacteristicMode) + -- Compare the original CharacteristicModes to the manipulated + CharacteristicModes +graph = app.CartesianGraphs:Add() +CharacteristicModesTrace1 = graph.Traces:Add(charMode) +CharacteristicModesTrace1.IndependentAxis = "Frequency" +CharacteristicModesTrace1:SetFixedAxisValue("Mode index", 2, "") +CharacteristicModesTrace2 = graph.Traces:Add(scaledCharacteristicModes) +CharacteristicModesTrace2:SetFixedAxisValue("Mode index", 2, "") +Inheritance +The CharacteristicModeData object is derived from the ResultData object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Usage locations +The CharacteristicModeData object can be accessed from the following locations: +• Methods +◦ CharacteristicModeCollection collection has method Items(). +◦ CharacteristicModeCollection collection has method Item(number). +◦ CharacteristicModeCollection collection has method Item(string). +p.2978 +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the characteristic mode values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the characteristic mode values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the characteristic mode values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the characteristic mode values. +Return +DataSet +The data set containing the characteristic mode values. +GetDataSet (samplePoints number) +Returns a data set containing the characteristic mode values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the characteristic mode values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the characteristic mode values. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +startFrequency(number) +p.2980 +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the characteristic mode values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CharacteristicModeQuantity +The characteristic mode quantity properties. +Example +p.2981 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CharacteristicModes.fek]]) +graph = app.CartesianGraphs:Add() +charModeTrace = + graph.Traces:Add( app.Models[1].Configurations[1].CharacteristicModes[1]) + -- Adjust 'CharacteristicModeQuantity' of the trace +charModeTrace.Quantity.Type + = pf.Enums.CharacteristicModeQuantityTypeEnum.ModalSignificance +Usage locations +The CharacteristicModeQuantity object can be accessed from the following locations: +• Properties +◦ CharacteristicModeTrace object has property Quantity. +Property List +ComplexComponent +The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. +Magnitude, Phase, Real, Imaginary. (Read/Write ComplexComponentEnum) +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. (Read/Write boolean) +Type +The type of quantity to be plotted, specified by the CharacteristicModeQuantityTypeEnum, e.g. +EigenValue, ModalSignificance, etc. (Read/Write CharacteristicModeQuantityTypeEnum) +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. (Read/Write boolean) +Property Details +ComplexComponent +The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. +Magnitude, Phase, Real, Imaginary. +Type +ComplexComponentEnum +Access +Read/Write +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +Type +The type of quantity to be plotted, specified by the CharacteristicModeQuantityTypeEnum, e.g. +EigenValue, ModalSignificance, etc. +Type +CharacteristicModeQuantityTypeEnum +Access +Read/Write +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +CharacteristicModeStoredData +Stored characteristic mode results. +Example +p.2983 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CharacteristicModes.fek]]) + -- Retrieve the 'CharacteristicModeData' from the characteristic mode + configuration +charMode = + app.Models[1].Configurations["CharacteristicModeConfiguration1"].CharacteristicModes[1] + -- Store a copy of the CharacteristicModes data. +storedData = + charMode:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.CharacteristicMode) +Inheritance +The CharacteristicModeStoredData object is derived from the ResultData object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the characteristic mode values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the characteristic mode values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the characteristic mode values. (Returns a DataSet object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the characteristic mode values. +Return +DataSet +The data set containing the characteristic mode values. +GetDataSet (samplePoints number) +Returns a data set containing the characteristic mode values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the characteristic mode values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the characteristic mode values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the characteristic mode values. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CharacteristicModeTrace +A characteristic mode 2D trace. +Example +p.2986 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CharacteristicModes.fek]]) +charMode = + app.Models[1].Configurations[1].CharacteristicModes["CharacteristicModes1"] + -- Create a Cartesian graph and the characteristic mode data +graph = app.CartesianGraphs:Add() +charModeTrace = graph.Traces:Add(charMode) + -- Configure the trace axes +charModeTrace.IndependentAxis = "Frequency" +charModeTrace:SetFixedAxisValue("Mode index", 5, "") + -- Configure the trace quantity +charModeTrace.Quantity.Type + = pf.Enums.CharacteristicModeQuantityTypeEnum.CharacteristicAngle +Inheritance +The CharacteristicModeTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The characteristic mode trace math expression properties. (Read only TraceMathExpression) +Quantity +The characteristic mode trace quantity properties. (Read only CharacteristicModeQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +p.2988 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The characteristic mode trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The characteristic mode trace quantity properties. +Type +CharacteristicModeQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +Complex +A complex number. +Example + -- Create a complex number +c1 = pf.Complex(3,4) + -- Determine magnitude and phase of the complex number +mag = c1:Magnitude() +phase = c1:Phase() + -- Some of the valid operators for 'Complex' +c2 = 2 + j*1 +c3 = c1 * 2 +c4 = c1 / 2 +c5 = c1 - c2 +c6 = c1 + c2 +c7 = c1 * c2 +c8 = c1.re * c2.re +Usage locations +The Complex object can be accessed from the following locations: +• Properties +◦ DataSetMetaData object has property Impedance. +• Methods +◦ Complex object has method Conjugate(). +◦ Complex object has method Conj(). +◦ ComplexMatrix object has method Determinant(). +◦ ComplexMatrix object has method Max(). +◦ ComplexMatrix object has method Min(). +◦ ComplexMatrix object has method Mean(). +◦ ComplexMatrix object has method Sum(). +• Static functions +◦ Complex object has static function Conj(number). +◦ Complex object has static function Conj(Complex). +◦ Complex object has static function Conjugate(number). +◦ Complex object has static function Conjugate(Complex). +◦ Complex object has static function Tan(Complex). +◦ Complex object has static function Sqrt(Complex). +◦ Complex object has static function Sin(Complex). +◦ Complex object has static function Power(Complex, Complex). +◦ Complex object has static function Power(Complex, number). +◦ Complex object has static function Log10(Complex). +◦ Complex object has static function Log(Complex). +◦ Complex object has static function Floor(Complex). +◦ Complex object has static function Exponent(Complex). +◦ Complex object has static function Ceil(Complex). +◦ Complex object has static function Cos(Complex). +◦ Complex object has static function Atan(Complex). +◦ Complex object has static function Asin(Complex). +◦ Complex object has static function Acos(Complex). +◦ Complex object has static function New(number, number). +◦ Complex object has static function New(number). +◦ Complex object has static function New(). +◦ ComplexMatrix object has static function Sum(ComplexMatrix). +◦ ComplexMatrix object has static function Mean(ComplexMatrix). +◦ ComplexMatrix object has static function Min(ComplexMatrix). +◦ ComplexMatrix object has static function Max(ComplexMatrix). +Property List +Type +im +re +The object type string. (Read only string) +The imaginary value of the complex number. (Read/Write number) +The real value of the complex number. (Read/Write number) +Method List +Abs () +Returns the absolute value of the complex value. Same as the magnitude. (Returns a number +object.) +Angle () +Returns the angle of the complex value in radians. Same as the phase. (Returns a number +object.) +Conj () +Returns the complex conjugate of the complex value. (Returns a Complex object.) +Conjugate () +Returns the complex conjugate of the complex value. (Returns a Complex object.) +Imag () +Returns the imaginary component of the complex value. (Returns a number object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +IsInfinite () +p.2995 +Returns true if either the real or imaginary part is infinite, returns false if both parts are finite. +(Returns a boolean object.) +IsNotANumber () +Returns true if either the real or imaginary part is not a number, returns false if both parts are +valid. (Returns a boolean object.) +Magnitude () +Returns the magnitude of the complex value. (Returns a number object.) +Phase () +Returns the phase of the complex value in radians. (Returns a number object.) +Real () +Returns the real component of the complex value. (Returns a number object.) +Constructor Function List +New (real number, imag number) +Creates a new complex. (Returns a Complex object.) +New (real number) +Creates a new complex. (Returns a Complex object.) +New () +Creates a new complex. (Returns a Complex object.) +Static Function List +Abs (real number) +Calculates the absolute value of the complex value. (Returns a number object.) +Abs (complex Complex) +Calculates the absolute value of the complex value. (Returns a number object.) +Acos (complex Complex) +Calculates arc cosine of a complex value. (Returns a Complex object.) +Angle (real number) +Returns the angle of the complex value in radians. (Returns a number object.) +Angle (complex Complex) +Returns the angle of the complex value in radians. (Returns a number object.) +Asin (complex Complex) +Calculates arc sine of a complex value. (Returns a Complex object.) +Atan (complex Complex) +Calculates arc tan of a complex value. (Returns a Complex object.) +Ceil (complex Complex) +Calculates the ceiling of each component of a complex value. (Returns a Complex object.) +Conj (real number) +Returns the complex conjugate of the complex value. (Returns a Complex object.) +Conj (complex Complex) +Returns the complex conjugate of the complex value. (Returns a Complex object.) +Conjugate (real number) +Calculates the complex conjugate of the complex value. (Returns a Complex object.) +Conjugate (complex Complex) +Calculates the complex conjugate of the complex value. (Returns a Complex object.) +Cos (complex Complex) +Calculates cosine of a complex value. (Returns a Complex object.) +Exponent (complex Complex) +Calculates exponent of a complex value. (Returns a Complex object.) +Floor (complex Complex) +Calculates the floor of each component a complex value. (Returns a Complex object.) +Imag (complex number) +Returns the imaginary component of the complex value. (Returns a number object.) +Imag (complex Complex) +Returns the imaginary component of the complex value. (Returns a number object.) +IsEqual (param complex1 Complex, param complex2 Complex) +Compares two complex numbers. (Returns a boolean object.) +IsEqual (param complex Complex, param value number) +Compares a complex number with a real number. (Returns a boolean object.) +IsInfinite (complex Complex) +Returns true if either the real or imaginary part is infinite, returns false if both parts are finite. +(Returns a boolean object.) +IsNotANumber (complex Complex) +Returns true if either the real or imaginary part is not a number, returns false if both parts are +valid. (Returns a boolean object.) +Log (complex Complex) +Calculates the log of a complex value. (Returns a Complex object.) +Log10 (complex Complex) +Calculates the log10 of a the complex value. (Returns a Complex object.) +Magnitude (real number) +Calculates the magnitude of the complex value. (Returns a number object.) +Magnitude (complex Complex) +Calculates the magnitude of the complex value. (Returns a number object.) +Phase (real number) +Calculates the phase of the complex value in radians. (Returns a number object.) +Phase (complex Complex) +Calculates the phase of the complex value in radians. (Returns a number object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Power (complex Complex, complex Complex) +p.2997 +Calculates the power of a the complex value with a complex exponent. (Returns a Complex +object.) +Power (complex Complex, value number) +Calculates the power of a complex value with a real exponent. (Returns a Complex object.) +Real (real number) +Returns the real component of the complex value. (Returns a number object.) +Real (complex Complex) +Returns the real component of the complex value. (Returns a number object.) +Sin (complex Complex) +Calculates the sine value of the complex value. (Returns a Complex object.) +Sqrt (complex Complex) +Calculates the square root value of the complex value. (Returns a Complex object.) +Tan (complex Complex) +Calculates the tan value of the complex value. (Returns a Complex object.) +Index List +[number] +Index a component of the complex value.The real component has index 1 and the complex +component index 2. (Read number) +[number] +Index a component of the complex value.The real component has index 1 and the complex +component index 2. (Write number) +Property Details +Type +The object type string. +Type +string +Access +Read only +im +re +The imaginary value of the complex number. +Type +number +Access +Read/Write +The real value of the complex number. +Type +number +Access +Read/Write +Method Details +Abs () +Returns the absolute value of the complex value. Same as the magnitude. +Return +number +The absolute value of the complex value. +Angle () +Returns the angle of the complex value in radians. Same as the phase. +Return +number +The angle of the complex value. +Conj () +Returns the complex conjugate of the complex value. +Return +Complex +The complex conjugate of the complex value. +Conjugate () +Returns the complex conjugate of the complex value. +Return +Complex +The complex conjugate of the complex value. +Imag () +Returns the imaginary component of the complex value. +Return +number +The imaginary component of the complex value. +IsInfinite () +Returns true if either the real or imaginary part is infinite, returns false if both parts are finite. +Return +boolean +True if either part is Inf. +Altair Feko 2022.3 +2 Application Programming Interface (API) +IsNotANumber () +p.2999 +Returns true if either the real or imaginary part is not a number, returns false if both parts are +valid. +Return +boolean +True if either part is NaN. +Magnitude () +Returns the magnitude of the complex value. +Return +number +The magnitude of the complex value. +Phase () +Returns the phase of the complex value in radians. +Return +number +The phase of the complex value. +Real () +Returns the real component of the complex value. +Return +number +The real component of the complex value. +Static Function Details +Abs (real number) +Calculates the absolute value of the complex value. +Input Parameters +real(number) +The real part of a complex number. +Return +number +The result complex value. +Abs (complex Complex) +Calculates the absolute value of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +number +The result complex value. +Acos (complex Complex) +Calculates arc cosine of a complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Angle (real number) +Returns the angle of the complex value in radians. +Input Parameters +real(number) +The real part of a complex number. +Return +number +The result complex value. +Angle (complex Complex) +Returns the angle of the complex value in radians. +Input Parameters +complex(Complex) +A complex number. +Return +number +The result complex value. +Asin (complex Complex) +Calculates arc sine of a complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Atan (complex Complex) +Calculates arc tan of a complex value. +Input Parameters +complex(Complex) +Complex number. +Return +Complex +The result complex value. +Ceil (complex Complex) +Calculates the ceiling of each component of a complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Conj (real number) +Returns the complex conjugate of the complex value. +Input Parameters +real(number) +The real part of a complex number. +Return +Complex +The complex conjugate of the complex value. +Conj (complex Complex) +Returns the complex conjugate of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The complex conjugate of the complex value. +Conjugate (real number) +Calculates the complex conjugate of the complex value. +Input Parameters +real(number) +The real part of a complex number. +Return +Complex +The result complex value. +Conjugate (complex Complex) +Calculates the complex conjugate of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Cos (complex Complex) +Calculates cosine of a complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Exponent (complex Complex) +Calculates exponent of a complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Floor (complex Complex) +Calculates the floor of each component a complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Imag (complex number) +Returns the imaginary component of the complex value. +Input Parameters +complex(number) +The real part of a complex number. +Return +number +The result complex value. +Imag (complex Complex) +Returns the imaginary component of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +number +The result complex value. +IsEqual (param complex1 Complex, param complex2 Complex) +Compares two complex numbers. +Input Parameters +param complex1(Complex) +The first complex number. +param complex2(Complex) +The second complex number. +Return +boolean +True if the two complex numbers are equal, else false. +IsEqual (param complex Complex, param value number) +Compares a complex number with a real number. +Input Parameters +param complex(Complex) +A complex number. +Altair Feko 2022.3 +2 Application Programming Interface (API) +param value(number) +A value to compare to. +Return +boolean +p.3004 +True if the complex number only has a real component which is equal to the +parameter, else false. +IsInfinite (complex Complex) +Returns true if either the real or imaginary part is infinite, returns false if both parts are finite. +Input Parameters +complex(Complex) +A complex number. +Return +boolean +True if either part is Inf. +IsNotANumber (complex Complex) +Returns true if either the real or imaginary part is not a number, returns false if both parts are +valid. +Input Parameters +complex(Complex) +A complex number. +Return +boolean +True if either part is NaN. +Log (complex Complex) +Calculates the log of a complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Log10 (complex Complex) +Calculates the log10 of a the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Magnitude (real number) +Calculates the magnitude of the complex value. +Input Parameters +real(number) +The real part of a complex number. +Return +number +The result complex value. +Magnitude (complex Complex) +Calculates the magnitude of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +number +The result complex value. +New (real number, imag number) +Creates a new complex. +Input Parameters +real(number) +The real component. +imag(number) +The imaginary component. +Return +Complex +The new complex. +New (real number) +Creates a new complex. +Input Parameters +real(number) +The real component. +Return +Complex +The new complex. +New () +Creates a new complex. +Return +Complex +The new complex. +Phase (real number) +Calculates the phase of the complex value in radians. +Input Parameters +real(number) +The real part of a complex number. +Return +number +The result complex value. +Phase (complex Complex) +Calculates the phase of the complex value in radians. +Input Parameters +complex(Complex) +A complex number. +Return +number +The result complex value. +Power (complex Complex, complex Complex) +Calculates the power of a the complex value with a complex exponent. +Input Parameters +complex(Complex) +A complex number. +complex(Complex) +A complex exponent. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Complex +The result complex value. +Power (complex Complex, value number) +Calculates the power of a complex value with a real exponent. +p.3007 +Input Parameters +complex(Complex) +A complex number. +value(number) +A real exponent number. +Return +Complex +The result complex value. +Real (real number) +Returns the real component of the complex value. +Input Parameters +real(number) +The real part of a complex number. +Return +number +The result complex value. +Real (complex Complex) +Returns the real component of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +number +The result complex value. +Sin (complex Complex) +Calculates the sine value of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Sqrt (complex Complex) +Calculates the square root value of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +Tan (complex Complex) +Calculates the tan value of the complex value. +Input Parameters +complex(Complex) +A complex number. +Return +Complex +The result complex value. +ComplexMatrix +A two-dimensional matrix. +Example + -- Create a default 2x2 complex matrix of zeros +cm1 = pf.ComplexMatrix.Zeros(2) + -- Assign values to each element of the matrix +cm1[1][1] = 1 + j +cm1[2][1] = 2 + 2*j +cm1[1][2] = 3 + 3*j +cm1[2][2] = 4 + 4*j + -- Create a 2x2 complex matrix with a fill value of 2 + j +cm2 = pf.ComplexMatrix(2, 2, 2 + j) + -- Determine the transpose and determinant of the matrix +transpose = cm1:Transpose() +determinant = cm1:Determinant() + -- Some of the valid operators for 'ComplexMatrix' +cm3 = cm1 * 2 +cm4 = cm2 * (3 + j) +cm5 = cm1 + 2 +cm6 = cm1 - 1 +cm7 = cm1 + cm2 +cm8 = cm1 - cm2 +Usage locations +The ComplexMatrix object can be accessed from the following locations: +• Methods +◦ DataSet object has method ToComplexMatrix(List of string). +◦ DataSet object has method ToComplexMatrix(List of string, string). +◦ DataSetIndexer object has method ToComplexMatrix(List of string). +◦ ComplexMatrix object has method Duplicate(). +◦ ComplexMatrix object has method Inverse(). +◦ ComplexMatrix object has method Transpose(). +◦ ComplexMatrix object has method SubMatrix(number, number, number, number). +◦ ComplexMatrix object has method FFT(). +◦ ComplexMatrix object has method IFFT(). +◦ ComplexMatrix object has method Conj(). +◦ Matrix object has method FFT(). +◦ Matrix object has method IFFT(). +Altair Feko 2022.3 +2 Application Programming Interface (API) +◦ Matrix object has method Conj(). +• Static functions +p.3010 +◦ ComplexMatrix object has static function Power(ComplexMatrix, ComplexMatrix). +◦ ComplexMatrix object has static function MultiplyByElement(ComplexMatrix, ComplexMatrix). +◦ ComplexMatrix object has static function Max(ComplexMatrix, ComplexMatrix). +◦ ComplexMatrix object has static function Min(ComplexMatrix, ComplexMatrix). +◦ ComplexMatrix object has static function MultiplyByElement(ComplexMatrix, Complex). +◦ ComplexMatrix object has static function Power(ComplexMatrix, Complex). +◦ ComplexMatrix object has static function MultiplyByElement(ComplexMatrix, number). +◦ ComplexMatrix object has static function Power(ComplexMatrix, number). +◦ ComplexMatrix object has static function Power(ComplexMatrix, Matrix). +◦ ComplexMatrix object has static function Conj(ComplexMatrix). +◦ ComplexMatrix object has static function Negate(ComplexMatrix). +◦ ComplexMatrix object has static function Zeros(number). +◦ ComplexMatrix object has static function Ones(number). +◦ ComplexMatrix object has static function Diagonal(List of Complex). +◦ ComplexMatrix object has static function Identity(number). +◦ ComplexMatrix object has static function New(number, List of Complex). +◦ ComplexMatrix object has static function New(List of Complex, number). +◦ ComplexMatrix object has static function New(number, number, Complex). +◦ ComplexMatrix object has static function New(number, number). +◦ ComplexMatrix object has static function Tan(ComplexMatrix). +◦ ComplexMatrix object has static function Sqrt(ComplexMatrix). +◦ ComplexMatrix object has static function Sin(ComplexMatrix). +◦ ComplexMatrix object has static function Log10(ComplexMatrix). +◦ ComplexMatrix object has static function Log(ComplexMatrix). +◦ ComplexMatrix object has static function Floor(ComplexMatrix). +◦ ComplexMatrix object has static function Exponent(ComplexMatrix). +◦ ComplexMatrix object has static function Ceil(ComplexMatrix). +◦ ComplexMatrix object has static function Cos(ComplexMatrix). +◦ ComplexMatrix object has static function Atan(ComplexMatrix). +◦ ComplexMatrix object has static function Asin(ComplexMatrix). +◦ ComplexMatrix object has static function Acos(ComplexMatrix). +Property List +ColumnCount +The number of columns in the matrix. (Read only number) +Im +The imaginary component of the complex matrix. (Read/Write Matrix) +Re +The real component of the complex matrix. (Read/Write Matrix) +RowCount +The number of rows in the matrix. (Read only number) +Type +im +re +The object type string. (Read only string) +The imaginary values of the ComplexMatrix. (Read/Write Matrix) +The real values of the ComplexMatrix. (Read/Write Matrix) +Method List +Abs () +Calculate the absolute value of all the entries in the matrix. (Returns a Matrix object.) +Angle () +Calculate the angle of all the entries in the matrix. (Returns a Matrix object.) +Conj () +Calculate the conjugate of all the entries in the matrix. (Returns a ComplexMatrix object.) +Determinant () +Calculate the determinant of the matrix. (Returns a Complex object.) +Duplicate () +Duplicate the matrix. (Returns a ComplexMatrix object.) +ExportMatFile (filename string, varname string) +Writes the given ComplexMatrix object to a *.mat file. (Returns a boolean object.) +FFT () +Calculates the fast Fourier transform of the column or row matrix. For a matrix containing multiple +columns and rows, the fast Fourier transform will be calculated for each of the columns. (Returns +a ComplexMatrix object.) +IFFT () +Calculates the inverse fast Fourier transform of the column or row matrix. For a matrix containing +multiple columns and rows, the inverse fast Fourier transform will be calculated for each of the +columns. (Returns a ComplexMatrix object.) +Imag () +Extract the imaginary part of all the entries in the matrix. (Returns a Matrix object.) +Inverse () +Calculate the inverse matrix. (Returns a ComplexMatrix object.) +Magnitude () +Calculate the magnitude of all the entries in the matrix. (Returns a Matrix object.) +Max () +Extracts the maximum from the matrix. (Returns a Complex object.) +Mean () +Calculates the mean value of the elements of the matrix. (Returns a Complex object.) +Min () +Extracts the minimum from the matrix. (Returns a Complex object.) +Phase () +Calculate the phase of all the entries in the matrix. (Returns a Matrix object.) +Real () +Extract the real part of all the entries in the matrix. (Returns a Matrix object.) +ReplaceSubMatrix (matrix ComplexMatrix, rowstart number, columnstart number) +Replace the sub matrix starting at the given indices with the provided matrix. +SubMatrix (rowstart number, rowend number, columnstart number, columnend number) +Obtain the sub matrix from the given parameters. (Returns a ComplexMatrix object.) +Sum () +Calculates the sum of all the elements of the matrix. (Returns a Complex object.) +Transpose () +Calculate the transpose of the matrix. (Returns a ComplexMatrix object.) +Constructor Function List +Diagonal (values List of Complex) +Creates a diagonal matrix. (Returns a ComplexMatrix object.) +Identity (size number) +Creates an identity matrix. (Returns a ComplexMatrix object.) +New (rows number, columnValues List of Complex) +Creates a new matrix. (Returns a ComplexMatrix object.) +New (rowValues List of Complex, columns number) +Creates a new matrix. (Returns a ComplexMatrix object.) +New (rows number, columns number, fill Complex) +Creates a new matrix. (Returns a ComplexMatrix object.) +New (rows number, columns number) +Creates a new matrix with uninitialised elements. (Returns a ComplexMatrix object.) +Ones (size number) +Creates a new matrix filled with ones. (Returns a ComplexMatrix object.) +Zeros (size number) +Creates a new matrix filled with zeros. (Returns a ComplexMatrix object.) +Static Function List +Abs (matrix ComplexMatrix) +Calculates the absolute value of each entry. (Returns a Matrix object.) +Acos (matrix ComplexMatrix) +Calculate the arc cosine of all the entries in the matrix. (Returns a ComplexMatrix object.) +Angle (matrix ComplexMatrix) +Calculates the angle value of each entry. (Returns a Matrix object.) +Asin (matrix ComplexMatrix) +Calculate the arc sine of all the entries in the matrix. (Returns a ComplexMatrix object.) +Atan (matrix ComplexMatrix) +Calculate the arc tangent of all the entries in the matrix. (Returns a ComplexMatrix object.) +Ceil (matrix ComplexMatrix) +Calculate the ceiling of all the elements in the matrix. (Returns a ComplexMatrix object.) +Conj (matrix ComplexMatrix) +Calculates the angle value of each entry. (Returns a ComplexMatrix object.) +Cos (matrix ComplexMatrix) +Calculate the cosine of all the entries in the matrix. (Returns a ComplexMatrix object.) +Exponent (matrix ComplexMatrix) +Calculate the exponent of all the entries in the matrix. (Returns a ComplexMatrix object.) +Find (matrix Matrix) +Finds all entries in the matrix that are non-zero. (Returns a table object.) +Floor (matrix ComplexMatrix) +Calculate the floor of all the entries in the matrix. (Returns a ComplexMatrix object.) +GreaterThan (matrix ComplexMatrix, matrix ComplexMatrix) +Determines if the entries of two matrices are greater than each other. (Returns a Matrix object.) +GreaterThan (matrix ComplexMatrix, matrix Matrix) +Determines if the entries of two matrices are greater than each other. (Returns a Matrix object.) +GreaterThan (matrix ComplexMatrix, value Complex) +Determines if a matrix has entries greater than the specified value. (Returns a Matrix object.) +GreaterThan (matrix ComplexMatrix, value number) +Determines if a matrix has entries greater than the specified value. (Returns a Matrix object.) +GreaterThanOrEqual (matrix ComplexMatrix, matrix ComplexMatrix) +Determines if the entries of two matrices are greater than or equal to each other. (Returns a +Matrix object.) +GreaterThanOrEqual (matrix ComplexMatrix, matrix Matrix) +Determines if the entries of two matrices are greater than or equal to each other. (Returns a +Matrix object.) +GreaterThanOrEqual (matrix ComplexMatrix, value Complex) +Determines if a matrix has entries greater than or equal to the specified value. (Returns a Matrix +object.) +GreaterThanOrEqual (matrix ComplexMatrix, value number) +Determines if a matrix has entries greater than or equal to the specified value. (Returns a Matrix +object.) +Imag (matrix ComplexMatrix) +Calculates the imaginary value of each entry. (Returns a Matrix object.) +IsEqual (matrix ComplexMatrix, matrix ComplexMatrix) +Determines if the entries of two matrices are equal. (Returns a Matrix object.) +IsEqual (matrix ComplexMatrix, matrix Matrix) +Determines if the entries of two matrices are equal. (Returns a Matrix object.) +IsEqual (matrix ComplexMatrix, value Complex) +Determines if a matrix has entries equal to the specified value. (Returns a Matrix object.) +IsEqual (matrix ComplexMatrix, value number) +Determines if a matrix has entries equal to the specified value. (Returns a Matrix object.) +LessThan (matrix ComplexMatrix, matrix ComplexMatrix) +Determines if the entries of two matrices are less than each other. (Returns a Matrix object.) +LessThan (matrix ComplexMatrix, matrix Matrix) +Determines if the entries of two matrices are less than each other. (Returns a Matrix object.) +LessThan (matrix ComplexMatrix, value Complex) +Determines if a matrix has entries less than the specified value. (Returns a Matrix object.) +LessThan (matrix ComplexMatrix, value number) +Determines if a matrix has entries less than the specified value. (Returns a Matrix object.) +LessThanOrEqual (matrix ComplexMatrix, matrix ComplexMatrix) +Determines if the entries of two matrices are less than or equal to each other. (Returns a Matrix +object.) +LessThanOrEqual (matrix ComplexMatrix, matrix Matrix) +Determines if the entries of two matrices are less than or equal to each other. (Returns a Matrix +object.) +LessThanOrEqual (matrix ComplexMatrix, value Complex) +Determines if a matrix has entries less than or equal to the specified value. (Returns a Matrix +object.) +LessThanOrEqual (matrix ComplexMatrix, value number) +Determines if a matrix has entries less than or equal to the specified value. (Returns a Matrix +object.) +Log (matrix ComplexMatrix) +Calculate the log of all the entries in the matrix. (Returns a ComplexMatrix object.) +Log10 (matrix ComplexMatrix) +Calculate the log10 of all the entries in the matrix. (Returns a ComplexMatrix object.) +Magnitude (matrix ComplexMatrix) +Calculates the magnitude value of each entry. (Returns a Matrix object.) +Max (matrix ComplexMatrix, matrix ComplexMatrix) +Calculate the maximum of two corresponding entries from two matrices. (Returns a +ComplexMatrix object.) +Max (matrix ComplexMatrix) +Calculate the maximum of all the entries in the matrix. (Returns a Complex object.) +Mean (matrix ComplexMatrix) +Calculate the mean of all the entries in the matrix. (Returns a Complex object.) +Min (matrix ComplexMatrix, matrix ComplexMatrix) +Calculate the minimum of two corresponding entries from two matrices. (Returns a +ComplexMatrix object.) +Min (matrix ComplexMatrix) +Calculate the minimum of all the entries in the matrix. (Returns a Complex object.) +MultiplyByElement (matrix ComplexMatrix, matrix ComplexMatrix) +Calculate the exponent of all the elements in the matrix. (Returns a ComplexMatrix object.) +MultiplyByElement (matrix ComplexMatrix, value Complex) +Calculate the exponent of all the elements in the matrix. (Returns a ComplexMatrix object.) +MultiplyByElement (matrix ComplexMatrix, value number) +Calculate the exponent of all the elements in the matrix. (Returns a ComplexMatrix object.) +Negate (matrix ComplexMatrix) +Negate each entry of the matrix. (Returns a ComplexMatrix object.) +NotEqual (matrix ComplexMatrix, matrix ComplexMatrix) +Determines if the entries of two matrices are not equal. (Returns a Matrix object.) +NotEqual (matrix ComplexMatrix, matrix Matrix) +Determines if the entries of two matrices are not equal. (Returns a Matrix object.) +NotEqual (matrix ComplexMatrix, value Complex) +Determines if a matrix has entries not equal to the specified value. (Returns a Matrix object.) +NotEqual (matrix ComplexMatrix, value number) +Determines if a matrix has entries not equal to the specified value. (Returns a Matrix object.) +Phase (matrix ComplexMatrix) +Calculates the phase value of each entry. (Returns a Matrix object.) +Power (matrix ComplexMatrix, matrix ComplexMatrix) +Raise all entries of the first matrix to the power of each entry in the second matrix. (Returns a +ComplexMatrix object.) +Power (matrix ComplexMatrix, exponent Complex) +Raise each entry to the power of the exponent. (Returns a ComplexMatrix object.) +Power (matrix ComplexMatrix, exponent number) +Raise each entry to the power of the exponent. (Returns a ComplexMatrix object.) +Power (matrix ComplexMatrix, matrix Matrix) +Raise all entries of the first matrix to the power of each entry in the second matrix. (Returns a +ComplexMatrix object.) +Real (matrix ComplexMatrix) +Calculates the real value of each entry. (Returns a Matrix object.) +Sin (matrix ComplexMatrix) +Calculate the sine of all the entries in the matrix. (Returns a ComplexMatrix object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Sqrt (matrix ComplexMatrix) +p.3016 +Calculate the square root of all the entries in the matrix. (Returns a ComplexMatrix object.) +Sum (matrix ComplexMatrix) +Calculate the sum of all the entries in the matrix. (Returns a Complex object.) +Tan (matrix ComplexMatrix) +Calculate the tan of all the entries in the matrix. (Returns a ComplexMatrix object.) +Index List +[number] +Access the specified row in the matrix. (Read ComplexMatrixIndexer) +Property Details +ColumnCount +The number of columns in the matrix. +Type +number +Access +Read only +The imaginary component of the complex matrix. +Type +Matrix +Access +Read/Write +Im +Re +The real component of the complex matrix. +Type +Matrix +Access +Read/Write +RowCount +The number of rows in the matrix. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +im +re +The imaginary values of the ComplexMatrix. +Type +Matrix +Access +Read/Write +The real values of the ComplexMatrix. +Type +Matrix +Access +Read/Write +Method Details +Abs () +Calculate the absolute value of all the entries in the matrix. +Return +Matrix +The absolute value. +Angle () +Calculate the angle of all the entries in the matrix. +Return +Matrix +The angle. +Conj () +Calculate the conjugate of all the entries in the matrix. +Return +ComplexMatrix +The conjugate. +Determinant () +Calculate the determinant of the matrix. +Return +Complex +The determinant of the matrix. +Duplicate () +Duplicate the matrix. +Return +ComplexMatrix +The duplicated matrix. +ExportMatFile (filename string, varname string) +Writes the given ComplexMatrix object to a *.mat file. +Input Parameters +filename(string) +The name of the file. +varname(string) +The name of the variable to export. +Return +boolean +Boolean indicating success. +FFT () +Calculates the fast Fourier transform of the column or row matrix. For a matrix containing multiple +columns and rows, the fast Fourier transform will be calculated for each of the columns. +Return +ComplexMatrix +The calculated FFT complex matrix. +IFFT () +Calculates the inverse fast Fourier transform of the column or row matrix. For a matrix containing +multiple columns and rows, the inverse fast Fourier transform will be calculated for each of the +columns. +Return +ComplexMatrix +The calculated IFFT complex matrix. +Imag () +Extract the imaginary part of all the entries in the matrix. +Return +Matrix +The imaginary value. +Inverse () +Calculate the inverse matrix. +Return +ComplexMatrix +The inverse of the matrix. +Magnitude () +Calculate the magnitude of all the entries in the matrix. +Return +Matrix +The magnitude value. +Max () +Extracts the maximum from the matrix. +Return +Complex +The maximum value. +Mean () +Calculates the mean value of the elements of the matrix. +Return +Complex +The mean value. +Min () +Extracts the minimum from the matrix. +Return +Complex +The minimum value. +Phase () +Calculate the phase of all the entries in the matrix. +Return +Matrix +The phase. +Real () +Extract the real part of all the entries in the matrix. +Return +Matrix +The real value. +ReplaceSubMatrix (matrix ComplexMatrix, rowstart number, columnstart number) +Replace the sub matrix starting at the given indices with the provided matrix. +Input Parameters +matrix(ComplexMatrix) +The new sub matrix. +rowstart(number) +Starting row index of the sub matrix. +columnstart(number) +Starting column index of the sub matrix. +SubMatrix (rowstart number, rowend number, columnstart number, columnend number) +Obtain the sub matrix from the given parameters. +Input Parameters +rowstart(number) +Row start index. +rowend(number) +Row end index. +columnstart(number) +Column start index. +columnend(number) +Column end index. +Return +ComplexMatrix +The sub matrix. +Sum () +Calculates the sum of all the elements of the matrix. +Return +Complex +The sum. +Transpose () +Calculate the transpose of the matrix. +Return +ComplexMatrix +The transpose of the matrix. +Static Function Details +Abs (matrix ComplexMatrix) +Calculates the absolute value of each entry. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +Matrix +The result matrix. +Acos (matrix ComplexMatrix) +Calculate the arc cosine of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +ComplexMatrix +The result matrix. +Angle (matrix ComplexMatrix) +Calculates the angle value of each entry. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +Matrix +The result matrix. +Asin (matrix ComplexMatrix) +Calculate the arc sine of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +ComplexMatrix +The result matrix. +Atan (matrix ComplexMatrix) +Calculate the arc tangent of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +ComplexMatrix +The result matrix. +Ceil (matrix ComplexMatrix) +Calculate the ceiling of all the elements in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +ComplexMatrix +The result matrix. +Conj (matrix ComplexMatrix) +Calculates the angle value of each entry. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +ComplexMatrix +The result matrix. +Cos (matrix ComplexMatrix) +Calculate the cosine of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +ComplexMatrix +The result matrix. +Diagonal (values List of Complex) +Creates a diagonal matrix. +Input Parameters +values(List of Complex) +The values to fill the matrix. +Return +ComplexMatrix +The new matrix. +Exponent (matrix ComplexMatrix) +Calculate the exponent of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +ComplexMatrix +The result matrix. +Find (matrix Matrix) +Finds all entries in the matrix that are non-zero. +Input Parameters +matrix(Matrix) +The matrix. +Return +table +The result matrix. +Floor (matrix ComplexMatrix) +Calculate the floor of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +ComplexMatrix +The result matrix. +GreaterThan (matrix ComplexMatrix, matrix ComplexMatrix) +Determines if the entries of two matrices are greater than each other. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(ComplexMatrix) +The matrix used to test each entry. +Return +Matrix +One and zero filled matrix. +GreaterThan (matrix ComplexMatrix, matrix Matrix) +Determines if the entries of two matrices are greater than each other. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(Matrix) +The matrix used to test each entry. +Return +Matrix +One and zero filled matrix. +GreaterThan (matrix ComplexMatrix, value Complex) +Determines if a matrix has entries greater than the specified value. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +value(Complex) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +GreaterThan (matrix ComplexMatrix, value number) +Determines if a matrix has entries greater than the specified value. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +value(number) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +GreaterThanOrEqual (matrix ComplexMatrix, matrix ComplexMatrix) +Determines if the entries of two matrices are greater than or equal to each other. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(ComplexMatrix) +The value used to test each entry. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Matrix +One and zero filled matrix. +GreaterThanOrEqual (matrix ComplexMatrix, matrix Matrix) +Determines if the entries of two matrices are greater than or equal to each other. +p.3025 +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(Matrix) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +GreaterThanOrEqual (matrix ComplexMatrix, value Complex) +Determines if a matrix has entries greater than or equal to the specified value. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +value(Complex) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +GreaterThanOrEqual (matrix ComplexMatrix, value number) +Determines if a matrix has entries greater than or equal to the specified value. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +value(number) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +Identity (size number) +Creates an identity matrix. +Input Parameters +size(number) +The size of the matrix. +Return +ComplexMatrix +The new matrix. +Imag (matrix ComplexMatrix) +Calculates the imaginary value of each entry. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +Matrix +The result matrix. +IsEqual (matrix ComplexMatrix, matrix ComplexMatrix) +Determines if the entries of two matrices are equal. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(ComplexMatrix) +The second matrix. +Return +Matrix +One and zero filled matrix. +IsEqual (matrix ComplexMatrix, matrix Matrix) +Determines if the entries of two matrices are equal. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(Matrix) +The second matrix. +Return +Matrix +One and zero filled matrix. +IsEqual (matrix ComplexMatrix, value Complex) +Determines if a matrix has entries equal to the specified value. +Input Parameters +matrix(ComplexMatrix) +The matrix. +value(Complex) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +IsEqual (matrix ComplexMatrix, value number) +Determines if a matrix has entries equal to the specified value. +Input Parameters +matrix(ComplexMatrix) +The matrix. +value(number) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +LessThan (matrix ComplexMatrix, matrix ComplexMatrix) +Determines if the entries of two matrices are less than each other. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(ComplexMatrix) +The matrix used to test each entry. +Return +Matrix +One and zero filled matrix. +LessThan (matrix ComplexMatrix, matrix Matrix) +Determines if the entries of two matrices are less than each other. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(Matrix) +The matrix used to test each entry. +Return +Matrix +One and zero filled matrix. +LessThan (matrix ComplexMatrix, value Complex) +Determines if a matrix has entries less than the specified value. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +value(Complex) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +LessThan (matrix ComplexMatrix, value number) +Determines if a matrix has entries less than the specified value. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +value(number) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +LessThanOrEqual (matrix ComplexMatrix, matrix ComplexMatrix) +Determines if the entries of two matrices are less than or equal to each other. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(ComplexMatrix) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +LessThanOrEqual (matrix ComplexMatrix, matrix Matrix) +Determines if the entries of two matrices are less than or equal to each other. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(Matrix) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +LessThanOrEqual (matrix ComplexMatrix, value Complex) +Determines if a matrix has entries less than or equal to the specified value. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +value(Complex) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +LessThanOrEqual (matrix ComplexMatrix, value number) +Determines if a matrix has entries less than or equal to the specified value. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +value(number) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +Log (matrix ComplexMatrix) +Calculate the log of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +ComplexMatrix +The result matrix. +Log10 (matrix ComplexMatrix) +Calculate the log10 of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +ComplexMatrix +The result matrix. +Magnitude (matrix ComplexMatrix) +Calculates the magnitude value of each entry. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +Matrix +The result matrix. +Max (matrix ComplexMatrix, matrix ComplexMatrix) +Calculate the maximum of two corresponding entries from two matrices. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(ComplexMatrix) +The second matrix. +Return +ComplexMatrix +The result matrix. +Max (matrix ComplexMatrix) +Calculate the maximum of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +Complex +The maximum value. +Mean (matrix ComplexMatrix) +Calculate the mean of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +Complex +The mean value. +Min (matrix ComplexMatrix, matrix ComplexMatrix) +Calculate the minimum of two corresponding entries from two matrices. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(ComplexMatrix) +The second matrix. +Return +ComplexMatrix +The result matrix. +Min (matrix ComplexMatrix) +Calculate the minimum of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +Complex +The minimum value. +MultiplyByElement (matrix ComplexMatrix, matrix ComplexMatrix) +Calculate the exponent of all the elements in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix used to perform operation. +matrix(ComplexMatrix) +The multiply matrix. +Return +ComplexMatrix +The result of the two matrices entries multiplied with each other. +MultiplyByElement (matrix ComplexMatrix, value Complex) +Calculate the exponent of all the elements in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix used to perform operation. +value(Complex) +The value that will be multiplied to each of the entries in the matrix. +Return +ComplexMatrix +The result of all the entries multiplied by the scalar value. +MultiplyByElement (matrix ComplexMatrix, value number) +Calculate the exponent of all the elements in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix used to perform operation. +value(number) +The value that will be multiplied to each of the entries in the matrix. +Return +ComplexMatrix +The result of all the entries multiplied by the scalar value. +Negate (matrix ComplexMatrix) +Negate each entry of the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +ComplexMatrix +The result matrix. +New (rows number, columnValues List of Complex) +Creates a new matrix. +Input Parameters +rows(number) +The number of rows in the matrix. Each column value will be duplicated for every row. +columnValues(List of Complex) +The values to place in each of the columns. +Return +ComplexMatrix +The new matrix. +New (rowValues List of Complex, columns number) +Creates a new matrix. +Input Parameters +rowValues(List of Complex) +The values to place in each of the rows. +columns(number) +The number of columns in the matrix. Each row value will be duplicated for every +column. +Return +ComplexMatrix +The new matrix. +New (rows number, columns number, fill Complex) +Creates a new matrix. +Input Parameters +rows(number) +The number of rows in the matrix. +columns(number) +The number of columns in the matrix. +fill(Complex) +The value used to fill the matrix. +Return +ComplexMatrix +The new matrix. +New (rows number, columns number) +Creates a new matrix with uninitialised elements. +Input Parameters +rows(number) +The number of rows in the matrix. +columns(number) +The number of columns in the matrix. +Return +ComplexMatrix +The new matrix. +NotEqual (matrix ComplexMatrix, matrix ComplexMatrix) +Determines if the entries of two matrices are not equal. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(ComplexMatrix) +The second matrix. +Return +Matrix +One and zero filled matrix. +NotEqual (matrix ComplexMatrix, matrix Matrix) +Determines if the entries of two matrices are not equal. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(Matrix) +The second matrix. +Return +Matrix +One and zero filled matrix. +NotEqual (matrix ComplexMatrix, value Complex) +Determines if a matrix has entries not equal to the specified value. +Input Parameters +matrix(ComplexMatrix) +The matrix. +value(Complex) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +NotEqual (matrix ComplexMatrix, value number) +Determines if a matrix has entries not equal to the specified value. +Input Parameters +matrix(ComplexMatrix) +The matrix. +value(number) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +Ones (size number) +Creates a new matrix filled with ones. +Input Parameters +size(number) +The size of the matrix. +Return +ComplexMatrix +The new matrix. +Phase (matrix ComplexMatrix) +Calculates the phase value of each entry. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +Matrix +The result matrix. +Power (matrix ComplexMatrix, matrix ComplexMatrix) +Raise all entries of the first matrix to the power of each entry in the second matrix. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(ComplexMatrix) +The second matrix. +Return +ComplexMatrix +The power of all the elements in the matrix. +Power (matrix ComplexMatrix, exponent Complex) +Raise each entry to the power of the exponent. +Input Parameters +matrix(ComplexMatrix) +The matrix. +exponent(Complex) +The exponent. +Return +ComplexMatrix +The result matrix. +Power (matrix ComplexMatrix, exponent number) +Raise each entry to the power of the exponent. +Input Parameters +matrix(ComplexMatrix) +The matrix. +exponent(number) +The exponent. +Return +ComplexMatrix +The result matrix. +Power (matrix ComplexMatrix, matrix Matrix) +Raise all entries of the first matrix to the power of each entry in the second matrix. +Input Parameters +matrix(ComplexMatrix) +The first matrix. +matrix(Matrix) +The second matrix. +Return +ComplexMatrix +The power of all the elements in the matrix. +Real (matrix ComplexMatrix) +Calculates the real value of each entry. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +Matrix +The result matrix. +Sin (matrix ComplexMatrix) +Calculate the sine of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +ComplexMatrix +The result matrix. +Sqrt (matrix ComplexMatrix) +Calculate the square root of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +ComplexMatrix +The result matrix. +Sum (matrix ComplexMatrix) +Calculate the sum of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +Complex +The sum. +Tan (matrix ComplexMatrix) +Calculate the tan of all the entries in the matrix. +Input Parameters +matrix(ComplexMatrix) +The matrix. +Return +ComplexMatrix +The result matrix. +Zeros (size number) +Creates a new matrix filled with zeros. +Input Parameters +size(number) +The size of the matrix. +Return +ComplexMatrix +The new matrix. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ComplexMatrixIndexer +p.3039 +This is an intermediate object that allows convenient indexing of multidimensional matrices. +Example + -- Create a default 2x2 complex matrix of zeros +cm1 = pf.ComplexMatrix.Zeros(2) + -- Assign values to an element of the matrix +cm1[1][1] = 1+j +cm1[2][1] = 2+2*j +cm1[1][2] = 3+3*j +cm1[2][2] = 4+4*j + -- Assign a value to an element explicitly using the indexer. + -- This is equivalent to cm1[1][2] = 2+j +indexer = cm1[1] +indexer[2] = 2+j +Property List +Type +The object type string. (Read only string) +Index List +[number] +Access a value at the specified indices in the matrix. (Read Complex) +[number] +Access a value at the specified indices in the matrix. (Write Complex) +Property Details +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +ComponentLaunchOptions +p.3040 +The components launch options that specifies the command line parameters for the various Altair Feko +components. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Access the 'ComponentLaunchOptions' object and check the environment variables +environmentVariables = app.Models[1].Launcher.Settings.Environment +Usage locations +The ComponentLaunchOptions object can be accessed from the following locations: +• Properties +◦ Launcher object has property Settings. +Property List +ADAPTFEKO +The object containing the ADAPTFEKO options to be used when it is launched. (Read only +ADAPTFEKOLaunchOptions) +Environment +The string to define ENVIRONMENT variables to be used during the launching of processes. The +format is VARIABLE=VALUE. (Read/Write string) +FEKO +The object containing the Feko Solver options to be used when it is launched. (Read only +FEKOLaunchOptions) +OPTFEKO +The object containing the OPTFEKO options to be used when it is launched. (Read only +OPTFEKOLaunchOptions) +PREFEKO +The object containing the PREFEKO options to be used when it is launched. (Read only +PREFEKOLaunchOptions) +Type +The object type string. (Read only string) +Method List +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +RestoreDefaults () +Restores the default components launch options. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Property Details +ADAPTFEKO +The object containing the ADAPTFEKO options to be used when it is launched. +Type +ADAPTFEKOLaunchOptions +Access +Read only +Environment +The string to define ENVIRONMENT variables to be used during the launching of processes. The +format is VARIABLE=VALUE. +Type +string +Access +Read/Write +FEKO +The object containing the Feko Solver options to be used when it is launched. +Type +FEKOLaunchOptions +Access +Read only +OPTFEKO +The object containing the OPTFEKO options to be used when it is launched. +Type +OPTFEKOLaunchOptions +Access +Read only +PREFEKO +The object containing the PREFEKO options to be used when it is launched. +Type +PREFEKOLaunchOptions +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +RestoreDefaults () +Restores the default components launch options. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Contours3DFormat +The 3D plot contours properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Show contour lines on a near field plot +nearField = app.Views[1].Plots:Add(app.Models[1].Configurations[1].NearFields[1]) +nearField.Contours.Visible = true +nearField.Contours.Colour = "ByMagnitude" +nearField.Contours.Count = 5 +Usage locations +The Contours3DFormat object can be accessed from the following locations: +• Properties +◦ CustomData3DPlot object has property Contours. +◦ SurfaceCurrents3DPlot object has property Contours. +◦ FarField3DPlot object has property Contours. +◦ NearField3DPlot object has property Contours. +Property List +Colour +The colour of the contour lines. (Read/Write MagnitudeColour) +Count +Type +Specify the number of contours to show for the plot in the range [0,100]. This value depends on +Type to be set to the “SpecifyByCount” ContourTypeEnum. (Read/Write number) +Method used to plot the contours specified by the ContourTypeEnum, e.g. SpecifyByCount or +SpecifyByValue. (Read/Write ContourTypeEnum) +Values +The list of contour values used to plot the contours when ContourSpecifiedByType is set to +SpecifyByValue. The format of the values is according to the ContourValuesType. (Read/Write List +of Expression) +ValuesType +The type of the values of the contours when the ContourSpecifiedByType is set to SpecifyByValue. +(Read/Write ContourValueTypeEnum) +Visible +Specifies whether the plot contours must be shown or hidden. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property Details +Colour +The colour of the contour lines. +Type +MagnitudeColour +Access +Read/Write +p.3044 +Count +Type +Specify the number of contours to show for the plot in the range [0,100]. This value depends on +Type to be set to the “SpecifyByCount” ContourTypeEnum. +Type +number +Access +Read/Write +Method used to plot the contours specified by the ContourTypeEnum, e.g. SpecifyByCount or +SpecifyByValue. +Type +ContourTypeEnum +Access +Read/Write +Values +The list of contour values used to plot the contours when ContourSpecifiedByType is set to +SpecifyByValue. The format of the values is according to the ContourValuesType. +Access +Read/Write +ValuesType +The type of the values of the contours when the ContourSpecifiedByType is set to SpecifyByValue. +Type +ContourValueTypeEnum +Access +Read/Write +Visible +Specifies whether the plot contours must be shown or hidden. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Currents3DFormat +The currents 3D plot visualisation properties. +Example +p.3045 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Display flat shaded current plot +current = app.Views[1].Plots:Add(app.Models[1].Configurations[1].SurfaceCurrents[1]) +current.Visualisation.FlatShaded = true +Usage locations +The Currents3DFormat object can be accessed from the following locations: +• Properties +◦ WireCurrents3DPlot object has property Visualisation. +◦ SurfaceCurrents3DPlot object has property Visualisation. +Property List +FlatShaded +Specifies whether discrete colours (flat shading) should be enabled or disabled for the currents +plot. (Read/Write boolean) +Property Details +FlatShaded +Specifies whether discrete colours (flat shading) should be enabled or disabled for the currents +plot. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +CustomData3DFormat +The custom data 3D plot visualisation properties. +Example +p.3046 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CustomDataSession.pfs]]) + -- Retrieve the custom math script and plot it on the 3D view +customData = app.MathScripts["CustomMath1"] +customDataPlot = app.Views[1].Plots:Add(customData) +customDataPlot.Quantity.Type = "TotalEField" +app.Views[1]:ZoomToExtents() + -- SetProperties the custom data plot visualisation +customDataPlot.Visualisation.Opacity = 50 +customDataPlot.Visualisation.AutoExtruded = false +customDataPlot.Visualisation.Extrusion = 50 +customDataPlot.Visualisation.GridVisible = true +Usage locations +The CustomData3DFormat object can be accessed from the following locations: +• Properties +◦ CustomData3DPlot object has property Visualisation. +Property List +AutoExtruded +Specifies whether auto extrusion is enabled or disabled for the plot. (Read/Write boolean) +AutoSizingEnabled +Specifies whether auto size is enabled or disabled for the plot. (Read/Write boolean) +Extrusion +The amount (%) the plot should be extruded in range [0,100]. (Read/Write number) +FlatShaded +Specifies whether discrete colours (flat shading) should be enabled or disabled for the plot. (Read/ +Write boolean) +GridVisible +Specifies whether the plot grid must be shown or hidden. (Read/Write boolean) +Opacity +Specify the plot opacity % in the range [0, 100]. (Read/Write number) +Size +The custom size (m) of the plot. AutoSizingEnabled needs to be disabled for this property to take +affect. (Read/Write number) +SizeFactor +The amount (%) the plot should be scaled in range [0,600]. (Read/Write number) +SurfaceVisible +Specifies whether the plot surface must be shown or hidden. (Read/Write boolean) +Property Details +AutoExtruded +Specifies whether auto extrusion is enabled or disabled for the plot. +Type +boolean +Access +Read/Write +AutoSizingEnabled +Specifies whether auto size is enabled or disabled for the plot. +Type +boolean +Access +Read/Write +Extrusion +The amount (%) the plot should be extruded in range [0,100]. +Type +number +Access +Read/Write +FlatShaded +Specifies whether discrete colours (flat shading) should be enabled or disabled for the plot. +Type +boolean +Access +Read/Write +GridVisible +Specifies whether the plot grid must be shown or hidden. +Type +boolean +Access +Read/Write +Opacity +Specify the plot opacity % in the range [0, 100]. +Type +number +Access +Read/Write +Size +The custom size (m) of the plot. AutoSizingEnabled needs to be disabled for this property to take +affect. +Type +number +Access +Read/Write +SizeFactor +The amount (%) the plot should be scaled in range [0,600]. +Type +number +Access +Read/Write +SurfaceVisible +Specifies whether the plot surface must be shown or hidden. +Type +boolean +Access +Read/Write +CustomData3DPlot +A custom data 3D result. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CustomDataSession.pfs]]) + -- Retrieve the custom math script and plot it on the 3D view +customData = app.MathScripts["CustomMath1"] +customDataPlot = app.Views[1].Plots:Add(customData) +app.Views[1]:ZoomToExtents() + -- SetProperties the custom data plot +customDataPlot.Quantity.Type = "TotalEField" +customDataPlot:SetFixedAxisValue("Z position", 0.2, "m") +customDataPlot.Visualisation.Opacity = 50 +Inheritance +The CustomData3DPlot object is derived from the Result3DPlot object. +Property List +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +Contours +The custom data plot contours properties. (Read only Contours3DFormat) +DataSource +The object that is the data source for this plot. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +Label +The object label. (Read/Write string) +Legend +The 3D plot legend properties. (Read only Plot3DLegendFormat) +PlotType +The type of plot to be displayed, e.g., 3D Surface, Phi cut, Theta cut, XY surface. (Read/Write +string) +PlotTypesAvailable +The list of available plot types. (Read only List of string) +Quantity +The custom data 3D plot quantity properties. (Read only CustomDataQuantity) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Visible +Specifies whether the plot must be shown or hidden. (Read/Write boolean) +Visualisation +The custom data visualisation properties. (Read only CustomData3DFormat) +p.3050 +Method List +Delete () +Delete the plot. +Duplicate () +Duplicate the plot. (Returns a Result3DPlot object.) +GetAxisUnit (axis string) +Returns the SI unit for the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Stores a copy of the plot. (Returns a Result3DPlot object.) +Property Details +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +Contours +The custom data plot contours properties. +Type +Contours3DFormat +Access +Read only +DataSource +The object that is the data source for this plot. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Legend +The 3D plot legend properties. +Type +Plot3DLegendFormat +Access +Read only +PlotType +The type of plot to be displayed, e.g., 3D Surface, Phi cut, Theta cut, XY surface. +Type +string +Access +Read/Write +PlotTypesAvailable +The list of available plot types. +Access +Read only +Quantity +The custom data 3D plot quantity properties. +Type +CustomDataQuantity +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Visible +Specifies whether the plot must be shown or hidden. +Type +boolean +Access +Read/Write +Visualisation +The custom data visualisation properties. +Type +CustomData3DFormat +Access +Read only +Method Details +Delete () +Delete the plot. +Duplicate () +Duplicate the plot. +Return +Result3DPlot +The duplicated plot. +GetAxisUnit (axis string) +Returns the SI unit for the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Stores a copy of the plot. +Return +Result3DPlot +The new plot associated with the stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CustomDataQuantity +The custom data quantity properties. +Example +p.3055 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CustomDataSession.pfs]]) + -- Retrieve the custom math script and plot it on a Cartesian graph +customData = app.MathScripts["CustomMath1"] +graph = app.CartesianGraphs:Add() +customDataTrace = graph.Traces:Add(customData) +customDataTrace.IndependentAxis = "X position" + -- SetProperties the custom data trace +customDataTrace.Quantity.Type = "TotalEField" +customDataTrace.Quantity.ComplexComponent = pf.Enums.ComplexComponentEnum.Real +customDataTrace.Quantity.ValuesNormalised = true +graph:ZoomToExtents() +Usage locations +The CustomDataQuantity object can be accessed from the following locations: +• Properties +◦ CustomData3DPlot object has property Quantity. +◦ CustomDataSurfacePlot object has property Quantity. +◦ CustomDataTrace object has property Quantity. +Property List +ComplexComponent +The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. +Magnitude, Phase, Real, Imaginary. (Read/Write ComplexComponentEnum) +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. (Read/Write boolean) +Type +The type of quantity to be plotted. (Read/Write string) +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before +plotting. This property can be used together with dB scaling. This property is not valid when +ComplexComponent is Phase. (Read/Write boolean) +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when ComplexComponent is Magnitude. (Read/Write boolean) +Property Details +ComplexComponent +The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. +Magnitude, Phase, Real, Imaginary. +Type +ComplexComponentEnum +Access +Read/Write +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +Type +The type of quantity to be plotted. +Type +string +Access +Read/Write +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before +plotting. This property can be used together with dB scaling. This property is not valid when +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when ComplexComponent is Magnitude. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +CustomDataSmithTrace +A custom data 2D Smith trace. +Example +p.3057 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CustomDataSession.pfs]]) + -- Retrieve the custom math script and plot it on a Smith chart +customData = app.MathScripts["CustomMath1"] +graph = app.SmithCharts:Add() +customDataTrace = graph.Traces:Add(customData) +Inheritance +The CustomDataSmithTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Quantity +The custom data Smith trace quantity properties. (Read only CustomSmithTraceQuantity) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Sampling +p.3058 +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +The object label. +Type +string +Label +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Quantity +The custom data Smith trace quantity properties. +Type +CustomSmithTraceQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CustomDataSurfacePlot +A custom data surface plot result. +Example +p.3064 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CustomDataSession.pfs]]) + -- Retrieve the custom math script and plot it on a Cartesian graph +customData = app.MathScripts["CustomMath1"] +graph = app.CartesianSurfaceGraphs:Add() +customDataPlot = graph.Plots:Add(customData) + -- SetProperties the custom data surface plot +customDataPlot.Quantity.Type = "TotalEField" +customDataPlot.HorizontalIndependentAxis = "Z position" +customDataPlot:SetFixedAxisValue("Frequency", 1.7, "GHz") +Inheritance +The CustomDataSurfacePlot object is derived from the ResultSurfacePlot object. +Property List +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the surface plot. (Read/Write ResultData) +DiscretePlotEnabled +Specifies whether the discrete plot property is enabled or disabled for this surface plot. (Read/ +Write boolean) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxes as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +HorizontalIndependentAxis +The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/ +Write string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +Label +The object label. (Read/Write string) +Legend +The surface plot legend properties. (Read only SurfacePlotLegendFormat) +Quantity +The custom data surface plot quantity properties. (Read only CustomDataQuantity) +Sampling +The continuous surface plot sampling settings. These settings only apply to traces when the +independent axis is continuously sampled. (Read only SurfacePlotSamplingFormat) +Type +The object type string. (Read only string) +VerticalIndependentAxis +The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write +string) +Visible +Specifies whether the surface plot must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the surface plot. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SwitchIndependentAxes () +Switches the horizontal and vertical independent axes. +Property Details +AxisNames +The names of all the axes on the ResultPlot. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read only +DataSource +The source of the surface plot. +Type +ResultData +Access +Read/Write +DiscretePlotEnabled +p.3066 +Specifies whether the discrete plot property is enabled or disabled for this surface plot. +Type +boolean +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxes as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +HorizontalIndependentAxis +The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Legend +The surface plot legend properties. +Type +SurfacePlotLegendFormat +Access +Read only +Quantity +The custom data surface plot quantity properties. +Type +CustomDataQuantity +Access +Read only +Sampling +The continuous surface plot sampling settings. These settings only apply to traces when the +independent axis is continuously sampled. +Type +SurfacePlotSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VerticalIndependentAxis +The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Visible +Specifies whether the surface plot must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the surface plot. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +SwitchIndependentAxes () +Switches the horizontal and vertical independent axes. +CustomDataTrace +A custom data 2D trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CustomDataSession.pfs]]) + -- Retrieve the custom math script and plot it on a Cartesian graph +customData = app.MathScripts["CustomMath1"] +graph = app.CartesianGraphs:Add() +customDataTrace = graph.Traces:Add(customData) + -- SetProperties the custom data trace +customDataTrace.Quantity.Type = "TotalEField" +customDataTrace.IndependentAxis = "X position" +customDataTrace:SetFixedAxisValue("Frequency", 1.7, "GHz") +graph:ZoomToExtents() +Inheritance +The CustomDataTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The custom data trace math expression properties. (Read only TraceMathExpression) +Quantity +The custom data trace quantity properties. (Read only CustomDataQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +p.3072 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The custom data trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The custom data trace quantity properties. +Type +CustomDataQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CustomMathScript +Custom math script data that can be plotted. +Example +p.3077 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a custom math script +customMathScript = app.MathScripts:Add(pf.Enums.MathScriptTypeEnum.Custom) + -- Create the script that will be executed by the custom math script +script = +[[ +-- Create a new DataSet +customDataSet = pf.DataSet.New() + -- Build the axes and quantities: + -- Frequency axis spanning from 1GHz to 2GHz with 11 values + -- Add a X axis spanning from -1m to 1m with 11 values + -- Add a Y axis spanning from -1m to 1m with 11 values + -- Add a Z axis spanning from -1m to 1m with 11 values +customDataSet.Axes:Add( pf.Enums.DataSetAxisEnum.Frequency, "GHz", 1 ,2 ,11) +customDataSet.Axes:Add( pf.Enums.DataSetAxisEnum.X,"m", -1, 1, 11) +customDataSet.Axes:Add( pf.Enums.DataSetAxisEnum.Y,"m", -1, 1, 11) +customDataSet.Axes:Add( pf.Enums.DataSetAxisEnum.Z,"m", -1, 1, 11) + -- Add some quantities to the quantity collection +customDataSet.Quantities:Add( "Threshold", pf.Enums.DataSetQuantityTypeEnum.Scalar, + "") +customDataSet.Quantities:Add( "TotalEField", + pf.Enums.DataSetQuantityTypeEnum.Complex, "V/m") +customDataSet.Quantities:Add( "Impedance", pf.Enums.DataSetQuantityTypeEnum.Complex, + "Ohm") + -- An iterator function that is used by ForAllValues to populate the data set + values +function initialise( index, customDataSet ) + indexedValue = customDataSet[index] + freqValue = indexedValue:AxisValue("Frequency") + xValue = indexedValue:AxisValue(pf.Enums.DataSetAxisEnum.X) + yValue = indexedValue:AxisValue(pf.Enums.DataSetAxisEnum.Y) + zValue = indexedValue:AxisValue(pf.Enums.DataSetAxisEnum.Z) + r = math.sqrt((xValue*xValue)+(yValue*yValue)+(zValue*zValue)) + indexedValue.TotalEField = 1/r + j*(1/r) + indexedValue.Threshold = 1 + indexedValue.Impedance = 50 + j*((-1.5+freqValue)*300) +end +pf.DataSet.ForAllValues( initialise, customDataSet ) +return customDataSet +]] +customMathScript.Script = script +-- Execute the math script +customMathScript:Run() + -- Store the custom data set and plot it on a 3D view +customDataPlot = app.Views[1].Plots:Add(customMathScript) +customDataPlot.Quantity.Type = "TotalEField" +app.Views[1]:ZoomToExtents() +Inheritance +The CustomMathScript object is derived from the MathScript object. +Property List +DataSetAvailable +Label +Script +Type +Valid result data exist. (Read only boolean) +The object label. (Read/Write string) +The script code to execute. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. (Returns a MathScript object.) +GetDataSet () +Returns a data set containing the math script values. (Returns a DataSet object.) +Run () +Run the math script. +Property Details +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Script +The script code to execute. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. +Return +MathScript +The duplicated math script. +GetDataSet () +Returns a data set containing the math script values. +Return +DataSet +The data set containing the math script values. +Run () +Run the math script. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CustomSmithTraceQuantity +The custom data Smith trace quantity properties. +Example +p.3080 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CustomDataSession.pfs]]) + -- Retrieve the custom math script and plot it on a Smith chart +customData = app.MathScripts["CustomMath1"] +graph = app.SmithCharts:Add() +customDataTrace = graph.Traces:Add(customData) + -- SetProperties the trace quantities +customDataTrace.Quantity.ReferenceImpedance = 100 +customDataTrace.Quantity.PhaseAdditionEnabled = true +customDataTrace.Quantity.Phase = 30 +Usage locations +The CustomSmithTraceQuantity object can be accessed from the following locations: +• Properties +◦ CustomDataSmithTrace object has property Quantity. +Property List +Phase +The phase to be added to the trace. The value is in degrees [-360,360]. (Read/Write number) +PhaseAdditionEnabled +Enable phase addition for the trace. (Read/Write boolean) +ReferenceImpedance +The reference impedance value in ohm to use. (Read/Write number) +Type +The type of quantity to be plotted. (Read/Write string) +Property Details +Phase +The phase to be added to the trace. The value is in degrees [-360,360]. +Type +number +Access +Read/Write +PhaseAdditionEnabled +Enable phase addition for the trace. +Type +boolean +Access +Read/Write +ReferenceImpedance +The reference impedance value in ohm to use. +Type +number +Access +Read/Write +Type +The type of quantity to be plotted. +Type +string +Access +Read/Write +CustomStoredData +Stored custom data. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Stored_Data.pfs]]) + -- Retrieve the 'CustomStoredData' called 'CustomData' +customData = app.StoredData["CustomData"] +graph = app.CartesianGraphs:Add() +customDataTrace = graph.Traces:Add(customData) + -- Store a copy of the custom data +storedData = customData:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.Custom) +Inheritance +The CustomStoredData object is derived from the ResultData object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +ExportData (filename string) +Export the custom data to the specified tab-separated file. +GetDataSet () +Returns a data set containing the custom data values. (Returns a DataSet object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +ExportData (filename string) +Export the custom data to the specified tab-separated file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +GetDataSet () +Returns a data set containing the custom data values. +Return +DataSet +The data set containing the custom data values. +Altair Feko 2022.3 +2 Application Programming Interface (API) +DataSet +p.3084 +The structure used for containing math results. A DataSet contains axes that indicate where quantities +are defined, as well as the values for those quantities at each point. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +-- Create a new DataSet +myDataSet = pf.DataSet.New() + -- Build the axes and quantities: + -- Frequency axis spanning from 1GHz to 2GHz with 11 values + -- Add a X axis spanning from -1m to 1m with 11 values + -- Add a Y axis spanning from -1m to 1m with 11 values + -- Add a Z axis spanning from -1m to 1m with 11 values +myDataSet.Axes:Add( pf.Enums.DataSetAxisEnum.Frequency, "GHz", 1 ,2 ,11) +myDataSet.Axes:Add( pf.Enums.DataSetAxisEnum.X,"m", -1, 1, 11) +myDataSet.Axes:Add( pf.Enums.DataSetAxisEnum.Y,"m", -1, 1, 11) +myDataSet.Axes:Add( pf.Enums.DataSetAxisEnum.Z,"m", -1, 1, 11) + -- Add some quantities to the quantity collection +myDataSet.Quantities:Add( "Threshold", pf.Enums.DataSetQuantityTypeEnum.Scalar, "") +myDataSet.Quantities:Add( "TotalEField", pf.Enums.DataSetQuantityTypeEnum.Complex, "V/ +m") + -- Iterate over all the axes and populate the data set values +for freqIndex = 1, #myDataSet.Axes["Frequency"] do + for xIndex = 1, #myDataSet.Axes["X"] do + for yIndex = 1, #myDataSet.Axes["Y"] do + for zIndex = 1, #myDataSet.Axes["Z"] do + indexedValue = myDataSet[freqIndex][xIndex][yIndex][zIndex] + xValue = indexedValue:AxisValue(pf.Enums.DataSetAxisEnum.X) + yValue = indexedValue:AxisValue(pf.Enums.DataSetAxisEnum.Y) + zValue = indexedValue:AxisValue(pf.Enums.DataSetAxisEnum.Z) + r = math.sqrt((xValue*xValue)+(yValue*yValue)+(zValue*zValue)) + indexedValue.TotalEField = 1/r + j*(1/r) + indexedValue.Threshold = 1 + end + end + end +end + -- An iterator function that is used by ForAllValues to populate the data set + values + -- This is equivalent to the above method. +function initialise( index, myDataSet ) + indexedValue = myDataSet[index] + xValue = indexedValue:AxisValue(pf.Enums.DataSetAxisEnum.X) + yValue = indexedValue:AxisValue(pf.Enums.DataSetAxisEnum.Y) + zValue = indexedValue:AxisValue(pf.Enums.DataSetAxisEnum.Z) + r = math.sqrt((xValue*xValue)+(yValue*yValue)+(zValue*zValue)) + indexedValue.TotalEField = 1/r + j*(1/r) +indexedValue.Threshold = 1 +end +pf.DataSet.ForAllValues( initialise, myDataSet ) + -- Store the custom data set and plot it on a 3D view +storedCustomData = myDataSet:StoreData(pf.Enums.StoredDataTypeEnum.Custom) +customDataPlot = app.Views[1].Plots:Add(storedCustomData) +customDataPlot.Quantity.Type = "TotalEField" +app.Views[1]:ZoomToExtents() +Usage locations +The DataSet object can be accessed from the following locations: +• Methods +◦ SurfaceCurrentsAndChargesStoredData object has method GetDataSet(). +◦ SurfaceCurrentsAndChargesStoredData object has method GetDataSet(number). +◦ SurfaceCurrentsAndChargesStoredData object has method GetDataSet(number, number, +number). +◦ SARStoredData object has method GetDataSet(). +◦ SARStoredData object has method GetDataSet(number). +◦ SARStoredData object has method GetDataSet(number, number, number). +◦ WireCurrentsAndChargesStoredData object has method GetDataSet(). +◦ WireCurrentsAndChargesStoredData object has method GetDataSet(number). +◦ WireCurrentsAndChargesStoredData object has method GetDataSet(number, number, +number). +◦ FarFieldPowerIntegralStoredData object has method GetDataSet(). +◦ ModalExcitationStoredData object has method GetDataSet(). +◦ ModalExcitationStoredData object has method GetDataSet(number). +◦ ModalExcitationStoredData object has method GetDataSet(number, number, number). +◦ WaveguideExcitationStoredData object has method GetDataSet(). +◦ WaveguideExcitationStoredData object has method GetDataSet(number). +◦ WaveguideExcitationStoredData object has method GetDataSet(number, number, number). +◦ ExcitationStoredData object has method GetDataSet(). +◦ ExcitationStoredData object has method GetDataSet(number). +◦ ExcitationStoredData object has method GetDataSet(number, number, number). +◦ CustomStoredData object has method GetDataSet(). +◦ LoadStoredData object has method GetDataSet(). +◦ LoadStoredData object has method GetDataSet(number). +◦ LoadStoredData object has method GetDataSet(number, number, number). +◦ NetworkStoredData object has method GetDataSet(). +◦ NetworkStoredData object has method GetDataSet(number). +◦ NetworkStoredData object has method GetDataSet(number, number, number). +◦ CharacteristicModeStoredData object has method GetDataSet(). +◦ CharacteristicModeStoredData object has method GetDataSet(number). +◦ CharacteristicModeStoredData object has method GetDataSet(number, number, number). +◦ TRCoefficientStoredData object has method GetDataSet(). +◦ TRCoefficientStoredData object has method GetDataSet(number). +◦ TRCoefficientStoredData object has method GetDataSet(number, number, number). +◦ PowerStoredData object has method GetDataSet(). +◦ PowerStoredData object has method GetDataSet(number). +◦ PowerStoredData object has method GetDataSet(number, number, number). +◦ FarFieldStoredData object has method GetDataSet(). +◦ FarFieldStoredData object has method GetDataSet(number). +◦ FarFieldStoredData object has method GetDataSet(number, number, number). +◦ SParameterStoredData object has method GetDataSet(). +◦ SParameterStoredData object has method GetDataSet(number). +◦ SParameterStoredData object has method GetDataSet(number, number, number). +◦ NearFieldStoredData object has method GetDataSet(). +◦ NearFieldStoredData object has method GetDataSet(number). +◦ NearFieldStoredData object has method GetDataSet(number, number, number). +◦ LoadComplex object has method GetDataSet(). +◦ LoadComplex object has method GetDataSet(number). +◦ LoadComplex object has method GetDataSet(number, number, number). +◦ LoadVoxel object has method GetDataSet(). +◦ LoadVoxel object has method GetDataSet(number). +◦ LoadVoxel object has method GetDataSet(number, number, number). +◦ LoadSeries object has method GetDataSet(). +◦ LoadSeries object has method GetDataSet(number). +◦ LoadSeries object has method GetDataSet(number, number, number). +◦ LoadParallel object has method GetDataSet(). +◦ LoadParallel object has method GetDataSet(number). +◦ LoadParallel object has method GetDataSet(number, number, number). +◦ LoadNetwork object has method GetDataSet(). +◦ LoadNetwork object has method GetDataSet(number). +◦ LoadNetwork object has method GetDataSet(number, number, number). +◦ LoadFEM object has method GetDataSet(). +◦ LoadFEM object has method GetDataSet(number). +◦ LoadFEM object has method GetDataSet(number, number, number). +◦ LoadEdge object has method GetDataSet(). +◦ LoadEdge object has method GetDataSet(number). +◦ LoadEdge object has method GetDataSet(number, number, number). +◦ LoadCable object has method GetDataSet(). +◦ LoadCable object has method GetDataSet(number). +◦ LoadCable object has method GetDataSet(number, number, number). +◦ LoadCoaxial object has method GetDataSet(). +◦ LoadCoaxial object has method GetDataSet(number). +◦ LoadCoaxial object has method GetDataSet(number, number, number). +◦ LoadVertex object has method GetDataSet(). +◦ LoadVertex object has method GetDataSet(number). +◦ LoadVertex object has method GetDataSet(number, number, number). +◦ SourceWaveguide object has method GetDataSet(). +◦ SourceWaveguide object has method GetDataSet(number). +◦ SourceWaveguide object has method GetDataSet(number, number, number). +◦ SourceVoltageNetwork object has method GetDataSet(). +◦ SourceVoltageNetwork object has method GetDataSet(number). +◦ SourceVoltageNetwork object has method GetDataSet(number, number, number). +◦ SourceVoltageCable object has method GetDataSet(). +◦ SourceVoltageCable object has method GetDataSet(number). +◦ SourceVoltageCable object has method GetDataSet(number, number, number). +◦ SourceCurrentRegion object has method GetDataSet(). +◦ SourceCurrentRegion object has method GetDataSet(number). +◦ SourceCurrentRegion object has method GetDataSet(number, number, number). +◦ SourceVoltageEdge object has method GetDataSet(). +◦ SourceVoltageEdge object has method GetDataSet(number). +◦ SourceVoltageEdge object has method GetDataSet(number, number, number). +◦ SourceModal object has method GetDataSet(). +◦ SourceModal object has method GetDataSet(number). +◦ SourceModal object has method GetDataSet(number, number, number). +◦ SourceCoaxial object has method GetDataSet(). +◦ SourceCoaxial object has method GetDataSet(number). +◦ SourceCoaxial object has method GetDataSet(number, number, number). +◦ SourceMagneticFrill object has method GetDataSet(). +◦ SourceMagneticFrill object has method GetDataSet(number). +◦ SourceMagneticFrill object has method GetDataSet(number, number, number). +◦ SourceVoltageVertex object has method GetDataSet(). +◦ SourceVoltageVertex object has method GetDataSet(number). +◦ SourceVoltageVertex object has method GetDataSet(number, number, number). +◦ SourceVoltageSegment object has method GetDataSet(). +◦ SourceVoltageSegment object has method GetDataSet(number). +◦ SourceVoltageSegment object has method GetDataSet(number, number, number). +◦ CharacteristicModeData object has method GetDataSet(). +◦ CharacteristicModeData object has method GetDataSet(number). +◦ CharacteristicModeData object has method GetDataSet(number, number, number). +◦ WireCurrentsMathScript object has method GetDataSet(). +◦ SurfaceCurrentsMathScript object has method GetDataSet(). +◦ CustomMathScript object has method GetDataSet(). +◦ TRCoefficientMathScript object has method GetDataSet(). +◦ PowerMathScript object has method GetDataSet(). +◦ SParameterMathScript object has method GetDataSet(). +◦ NetworkMathScript object has method GetDataSet(). +◦ LoadMathScript object has method GetDataSet(). +◦ ExcitationMathScript object has method GetDataSet(). +◦ FarFieldMathScript object has method GetDataSet(). +◦ NearFieldMathScript object has method GetDataSet(). +◦ FarFieldPowerIntegralData object has method GetDataSet(). +◦ TRCoefficientData object has method GetDataSet(). +◦ TRCoefficientData object has method GetDataSet(number). +◦ TRCoefficientData object has method GetDataSet(number, number, number). +◦ SphericalModesReceivingAntennaData object has method GetDataSet(). +◦ SphericalModesReceivingAntennaData object has method GetDataSet(number). +◦ SphericalModesReceivingAntennaData object has method GetDataSet(number, number, +number). +◦ NearFieldReceivingAntennaData object has method GetDataSet(). +◦ NearFieldReceivingAntennaData object has method GetDataSet(number). +◦ NearFieldReceivingAntennaData object has method GetDataSet(number, number, number). +◦ FarFieldReceivingAntennaData object has method GetDataSet(). +◦ FarFieldReceivingAntennaData object has method GetDataSet(number). +◦ FarFieldReceivingAntennaData object has method GetDataSet(number, number, number). +◦ ReceivingAntennaData object has method GetDataSet(). +◦ ReceivingAntennaData object has method GetDataSet(number). +◦ ReceivingAntennaData object has method GetDataSet(number, number, number). +◦ TransmissionLineData object has method GetDataSet(). +◦ TransmissionLineData object has method GetDataSet(number). +◦ TransmissionLineData object has method GetDataSet(number, number, number). +◦ NetworkData object has method GetDataSet(). +◦ NetworkData object has method GetDataSet(number). +◦ NetworkData object has method GetDataSet(number, number, number). +◦ SARData object has method GetDataSet(). +◦ SARData object has method GetDataSet(number). +◦ SARData object has method GetDataSet(number, number, number). +◦ WireCurrentsData object has method GetDataSet(). +◦ WireCurrentsData object has method GetDataSet(number). +◦ WireCurrentsData object has method GetDataSet(number, number, number). +◦ SurfaceCurrentsData object has method GetDataSet(). +◦ SurfaceCurrentsData object has method GetDataSet(number). +◦ SurfaceCurrentsData object has method GetDataSet(number, number, number). +◦ SParameterData object has method GetDataSet(). +◦ SParameterData object has method GetDataSet(number). +◦ SParameterData object has method GetDataSet(number, number, number). +◦ PowerData object has method GetDataSet(). +◦ PowerData object has method GetDataSet(number). +◦ PowerData object has method GetDataSet(number, number, number). +◦ FarFieldData object has method GetDataSet(). +◦ FarFieldData object has method GetDataSet(number). +◦ FarFieldData object has method GetDataSet(number, number, number). +◦ FarFieldData object has method GetSampledDataSet(number, number). +◦ FarFieldData object has method GetSampledDataSet(number, number, number, number, +number, number). +◦ FarFieldData object has method GetSampledDataSet(number, number, number). +◦ FarFieldData object has method GetSampledDataSet(number, number, number, number, +number, number, number, number, number). +◦ NearFieldData object has method GetDataSet(). +◦ NearFieldData object has method GetDataSet(number). +◦ NearFieldData object has method GetDataSet(number, number, number). +◦ NearFieldData object has method GetMediaDataSet(). +◦ NearFieldData object has method GetMediaDataSet(number). +◦ NearFieldData object has method GetMediaDataSet(number, number, number). +◦ DataSet object has method Clone(). +◦ DataSet object has method CloneStructure(). +• Static functions +◦ DataSet object has static function CombineDataSets(string, Unit, List of Variant, List of +DataSet). +◦ DataSet object has static function New(). +Property List +MetaData +Metadata that is associated with the data set. (Read only DataSetMetaData) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +The object type string. (Read only string) +Collection List +Axes +p.3090 +The collection of axes defining the positions in the data set where quantities are defined. +(DataSetAxisCollection of DataSetAxis.) +Quantities +The collection of quantities that are defined at each point in the data set. +(DataSetQuantityCollection of DataSetQuantity.) +Method List +Clone () +Makes a copy of this dataset and returns it. (Returns a DataSet object.) +CloneStructure () +Creates a copy of the structure of the dataset but none of its values. (Returns a DataSet object.) +ExportMatFile (filename string, varname string) +Writes the given DataSet object to a *.mat file. (Returns a boolean object.) +FromComplexMatrix (matrix ComplexMatrix, quantityNames List of string) +Fills the data set from a matrix. +FromComplexMatrix (matrix ComplexMatrix, quantityNames List of string, dataAxisName string) +Fills the data set from a matrix. +FromMatrix (matrix Matrix, quantityNames List of string) +Fills the data set from a matrix. +FromMatrix (matrix Matrix, quantityNames List of string, dataAxisName string) +Fills the data set from a matrix. +StoreData (type StoredDataTypeEnum) +Creates a stored copy of the dataset. (Returns a ResultData object.) +ToComplexMatrix (quantityNames List of string) +Extracts data from the data set. (Returns a ComplexMatrix object.) +ToComplexMatrix (quantityNames List of string, dataAxisName string) +Extracts data from the data set. (Returns a ComplexMatrix object.) +ToMatrix (quantityNames List of string) +Extracts data from the data set. (Returns a Matrix object.) +ToMatrix (quantityNames List of string, dataAxisName string) +Extracts data from the data set. (Returns a Matrix object.) +UpdateStoredData (type StoredDataTypeEnum, entity ResultData) +Updates the contents of a stored data entity from the dataset. +Constructor Function List +New () +Creates a new data set. (Returns a DataSet object.) +Static Function List +CombineDataSets (name string, unit Unit, values List of Variant, sets List of DataSet) +Combines the data sets creating a new outer axis. (Returns a DataSet object.) +ForAllValues (valueFunction function, data DataSet, ...) +Iterates over every point on every axis of the data set. +Index List +[list] +Index into the values of the data set using a table of indices. (Read DataSetIndexer) +[number] +Index into the values of the data set. (Read DataSetIndexer) +Property Details +MetaData +Metadata that is associated with the data set. +Type +DataSetMetaData +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Axes +The collection of axes defining the positions in the data set where quantities are defined. +Type +DataSetAxisCollection +Quantities +The collection of quantities that are defined at each point in the data set. +Type +DataSetQuantityCollection +Method Details +Clone () +Makes a copy of this dataset and returns it. +Return +DataSet +A copy of the current DataSet. +CloneStructure () +Creates a copy of the structure of the dataset but none of its values. +Return +DataSet +A structural copy of the current DataSet. +ExportMatFile (filename string, varname string) +Writes the given DataSet object to a *.mat file. +Input Parameters +filename(string) +The name of the file. +varname(string) +The name of the variable to export. +Return +boolean +Boolean indicating success. +FromComplexMatrix (matrix ComplexMatrix, quantityNames List of string) +Fills the data set from a matrix. +Input Parameters +matrix(ComplexMatrix) +Matrix to fill the dataset with. +quantityNames(List of string) +List of quantities the matrix represents. +FromComplexMatrix (matrix ComplexMatrix, quantityNames List of string, dataAxisName string) +Fills the data set from a matrix. +Input Parameters +matrix(ComplexMatrix) +Matrix to fill the dataset with. +quantityNames(List of string) +List of quantities the matrix represents. +dataAxisName(string) +Data axis the matrix represents. +FromMatrix (matrix Matrix, quantityNames List of string) +Fills the data set from a matrix. +Input Parameters +matrix(Matrix) +Matrix to fill the dataset with. +quantityNames(List of string) +List of quantities the matrix represents. +FromMatrix (matrix Matrix, quantityNames List of string, dataAxisName string) +Fills the data set from a matrix. +Input Parameters +matrix(Matrix) +Matrix to fill the dataset with. +quantityNames(List of string) +List of quantities the matrix represents. +dataAxisName(string) +Data axis the matrix represents. +StoreData (type StoredDataTypeEnum) +Creates a stored copy of the dataset. +Input Parameters +type(StoredDataTypeEnum) +The type of stored data entity specified by StoredDataTypeEnum, e.g. FarField, +NearField, Custom, etc. +Return +ResultData +The new stored data. +ToComplexMatrix (quantityNames List of string) +Extracts data from the data set. +Input Parameters +quantityNames(List of string) +List of quantities to extract. +Return +ComplexMatrix +A matrix with a quantity in each column. +ToComplexMatrix (quantityNames List of string, dataAxisName string) +Extracts data from the data set. +Input Parameters +quantityNames(List of string) +List of quantities to extract. +dataAxisName(string) +Data of the quantity to extract. +Return +ComplexMatrix +A matrix with the quantities as rows and the axis as columns. +ToMatrix (quantityNames List of string) +Extracts data from the data set. +Input Parameters +quantityNames(List of string) +List of quantities to extract. +Return +Matrix +A matrix with a quantity in each column. +ToMatrix (quantityNames List of string, dataAxisName string) +Extracts data from the data set. +Input Parameters +quantityNames(List of string) +List of quantities to extract. +dataAxisName(string) +Data of the quantity to extract. +Return +Matrix +A matrix with the quantities as rows and the axis as columns. +UpdateStoredData (type StoredDataTypeEnum, entity ResultData) +Updates the contents of a stored data entity from the dataset. +Input Parameters +type(StoredDataTypeEnum) +The type of stored data entity specified by StoredDataTypeEnum, e.g. FarField, +NearField, Custom, etc. +entity(ResultData) +The stored data entity that must be updated. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +CombineDataSets (name string, unit Unit, values List of Variant, sets List of DataSet) +Combines the data sets creating a new outer axis. +p.3095 +Input Parameters +name(string) +The name of the axis. +unit(Unit) +The unit of the axis. +values(List of Variant) +The values of the axis in a table. +sets(List of DataSet) +A list of data sets to combine. +Return +DataSet +The new data set with the combined values. +ForAllValues (valueFunction function, data DataSet, ...) +Iterates over every point on every axis of the data set. +Input Parameters +valueFunction(function) +A function that that processes each of the values. Must take at least two arguments +(index, dataset, ...). +data(DataSet) +The data set that is iterated over. +... +Example +Any extra arguments that will be passed directly to the value function. +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +-- Create a new DataSet +myDataSet = pf.DataSet.New() + -- Build the axes and quantities: + -- Frequency axis spanning from 1GHz to 2GHz with 11 values + -- Add a X axis spanning from -1m to 1m with 11 values + -- Add a Y axis spanning from -1m to 1m with 11 values + -- Add a Z axis spanning from -1m to 1m with 11 values +myDataSet.Axes:Add(pf.Enums.DataSetAxisEnum.Frequency, "GHz", 1 ,2 ,11) +myDataSet.Axes:Add(pf.Enums.DataSetAxisEnum.X,"m", -1, 1, 11) +myDataSet.Axes:Add(pf.Enums.DataSetAxisEnum.Y,"m", -1, 1, 11) +myDataSet.Axes:Add(pf.Enums.DataSetAxisEnum.Z,"m", -1, 1, 11) + -- Add a "Threshold" scalar quantity with no unit +myDataSet.Quantities:Add( "Threshold", pf.Enums.DataSetQuantityTypeEnum.Scalar, "") +-- An iterator function that initialises all of the defined values + -- to to the value provided as an extra argument to the 'forAllValues' + -- function. +function initialise( index, myDataSet, initialValue ) + myDataSet[index].Threshold = initialValue +end +pf.DataSet.ForAllValues(initialise, myDataSet, 2) + -- Store the custom data set and plot it on a 3D view +storedCustomData = myDataSet:StoreData(pf.Enums.StoredDataTypeEnum.Custom) +app.Views[1].Plots:Add(storedCustomData) +app.Views[1]:ZoomToExtents() +New () +Creates a new data set. +Return +DataSet +The new data set. +Altair Feko 2022.3 +2 Application Programming Interface (API) +DataSetAxis +p.3097 +Every DataSet contains axes and quantities. The DataSetAxis describes the definition of an axis. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the far field data set +farFieldDataSet = + app.Models[1].Configurations[1].FarFields["FarFields"]:GetDataSet(51) + -- Print a list of the far field axes +printlist( farFieldDataSet.Axes:Items() ) + -- Access information about the "Phi" axis +phiAxis = farFieldDataSet.Axes["Phi"] +phiAxisName = phiAxis.Name +phiAxisUnit = phiAxis.Unit +phiAxisDescription = phiAxis.Description +phiAxisValues = phiAxis.Values -- The actual phi values in degrees +numberPhiAxisValues = #phiAxis +firstPhiValue = phiAxis[1] +lastPhiValue = phiAxis[#phiAxis] +Usage locations +The DataSetAxis object can be accessed from the following locations: +• Methods +◦ DataSetAxisCollection collection has method Items(). +◦ DataSetAxisCollection collection has method Item(number). +◦ DataSetAxisCollection collection has method Item(string). +◦ DataSetAxisCollection collection has method Add(DataSetAxisEnum). +◦ DataSetAxisCollection collection has method Add(DataSetAxisEnum, number, number, +number). +◦ DataSetAxisCollection collection has method Add(DataSetAxisEnum, List of Variant). +◦ DataSetAxisCollection collection has method Add(string, Unit). +◦ DataSetAxisCollection collection has method Add(string, Unit, Variant). +◦ DataSetAxisCollection collection has method Add(string, Unit, number, number, number). +◦ DataSetAxisCollection collection has method Add(string, Unit, List of Variant). +◦ DataSetAxisCollection collection has method Add(DataSetAxis). +Property List +Count +The number of values on the axis. (Read only number) +Description +A text description of the axis. (Read only string) +Name +Type +Unit +The name of the axis. (Read/Write string) +The object type string. (Read only string) +The unit for the axis. (Read/Write Unit) +Values +The values of the axis. (Read/Write List of Variant) +Method List +Delete () +Deletes the axis from the dataset. +SetValueAt (index number, value Variant) +Set the value on the axis at the given index. +ValueAt (index number) +Returns the value on the axis at the given index. (Returns a Variant object.) +Index List +[number] +The value at the given index. (Read Variant) +[number] +The value at the given index. (Write Variant) +Property Details +Count +The number of values on the axis. +Type +number +Access +Read only +Description +A text description of the axis. +Type +string +Access +Read only +Name +The name of the axis. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Unit +The unit for the axis. +Type +Unit +Access +Read/Write +Values +The values of the axis. +Access +Read/Write +Method Details +Delete () +Deletes the axis from the dataset. +SetValueAt (index number, value Variant) +Set the value on the axis at the given index. +Input Parameters +index(number) +The index of the value to access. +value(Variant) +The value to assign to the given index. +ValueAt (index number) +Returns the value on the axis at the given index. +Input Parameters +index(number) +The index of the value to access. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Variant +The value at the given index. +p.3100 +Altair Feko 2022.3 +2 Application Programming Interface (API) +DataSetIndexer +p.3101 +When iterating over a data set, the DataSetIndexer provides a means to access the currently indexed +point and to retrieve information about its position in the data set. For instance, it is possible to +determine where in space a point is located and at what frequency. By using the indexed point, the +index, name, unit and value of the associated axes can be determined. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a new DataSet. +myDataSet = pf.DataSet.New() + -- Build the axes and quantities: + -- Frequency axis spanning from 1GHz to 2GHz with 11 values + -- Add a X axis spanning from -1m to 1m with 11 values + -- Add a Y axis spanning from -1m to 1m with 11 values + -- Add a Z axis spanning from -1m to 1m with 11 values +myDataSet.Axes:Add( pf.Enums.DataSetAxisEnum.Frequency, "GHz", 1, 2, 11) +myDataSet.Axes:Add( pf.Enums.DataSetAxisEnum.X,"m", -1, 1, 11) +myDataSet.Axes:Add( pf.Enums.DataSetAxisEnum.Y,"m", -1, 1, 11) +myDataSet.Axes:Add( pf.Enums.DataSetAxisEnum.Z,"m", -1, 1, 11) +-- Add a "Threshold" scalar quantity with no unit +myDataSet.Quantities:Add( "Threshold", pf.Enums.DataSetQuantityTypeEnum.Scalar, "") + -- Iterator function that will be used by the ForAllValues function. It + -- calculates the absolute distance from the origin and divides by the + -- square of the frequency (in GHz). Similar calculations are common + -- in radiation hazard applications. +function distanceOverFrequency(index, myDS) + local fVal = myDS[index]:AxisValue(pf.Enums.DataSetAxisEnum.Frequency) + local xVal = myDS[index]:AxisValue(pf.Enums.DataSetAxisEnum.X) + local yVal = myDS[index]:AxisValue(pf.Enums.DataSetAxisEnum.Y) + local zVal = myDS[index]:AxisValue(pf.Enums.DataSetAxisEnum.Z) + myDS[index].Threshold = math.sqrt(xVal^2 + yVal^2 + zVal^2)/fVal^2 +end +pf.DataSet.ForAllValues(distanceOverFrequency, myDataSet) + -- Store the custom data set and plot it on a 3D view +storedCustomData = myDataSet:StoreData(pf.Enums.StoredDataTypeEnum.Custom) +app.Views[1].Plots:Add(storedCustomData) +app.Views[1]:ZoomToExtents() +Property List +Type +The object type string. (Read only string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method List +AxisIndex (index number) +p.3102 +The index specifies an axis in the axes collection and returns the current position on this axis as +an index. (Returns a number object.) +AxisIndex (name string) +The name specifies an axis in the axes collection and returns the current position on this axis as +an index. (Returns a number object.) +AxisName (index number) +The index specifies an axis in the axes collection and returns its name. (Returns a string object.) +AxisUnit (index number) +The index specifies an axis in the axes collection and returns its unit. (Returns a Unit object.) +AxisUnit (name string) +The name specifies an axis in the axes collection and returns its unit. (Returns a Unit object.) +AxisValue (index number) +The index specifies an axis in the axes collection and returns the value at the current position of +this axis. (Returns a Variant object.) +AxisValue (name string) +The name specifies an axis in the axes collection and returns the value at the current position of +this axis. (Returns a Variant object.) +FromComplexMatrix (matrix ComplexMatrix, quantityNames List of string) +Fills the data set from a matrix. +FromMatrix (matrix Matrix, quantityNames List of string) +Fills the data set from a matrix. +ToComplexMatrix (quantityNames List of string) +Extracts data from the data set. (Returns a ComplexMatrix object.) +ToMatrix (quantityNames List of string) +Extracts data from the data set. (Returns a Matrix object.) +Index List +[number] +Index into the next axis. (Read DataSetIndexer) +[string] +Set or get a quantity value. (Read Variant) +[string] +Set or get a quantity value. (Write Variant) +Property Details +Type +The object type string. +Type +string +Access +Read only +Method Details +AxisIndex (index number) +The index specifies an axis in the axes collection and returns the current position on this axis as +an index. +Input Parameters +index(number) +The index specifies an axis in the axis collection. +Return +number +The current position as index of the axis at the specified index. +AxisIndex (name string) +The name specifies an axis in the axes collection and returns the current position on this axis as +an index. +Input Parameters +name(string) +The name specifies an axis in the axis collection. +Return +number +The current position as index of the axis at the specified name. +AxisName (index number) +The index specifies an axis in the axes collection and returns its name. +Input Parameters +index(number) +The index specifies an axis in the axis collection. +Return +string +The name of the axis at the specified index. +AxisUnit (index number) +The index specifies an axis in the axes collection and returns its unit. +Input Parameters +index(number) +The index specifies an axis in the axis collection. +Return +Unit +The unit of the axis at the specified index. +AxisUnit (name string) +The name specifies an axis in the axes collection and returns its unit. +Input Parameters +name(string) +The name specifies an axis in the axis collection. +Return +Unit +The unit of the axis at the specified name. +AxisValue (index number) +The index specifies an axis in the axes collection and returns the value at the current position of +this axis. +Input Parameters +index(number) +The index specifies an axis in the axis collection. +Return +Variant +The value of the axis at the specified index. +AxisValue (name string) +The name specifies an axis in the axes collection and returns the value at the current position of +this axis. +Input Parameters +name(string) +The name specifies an axis in the axis collection. +Return +Variant +The value of the axis at the specified name. +FromComplexMatrix (matrix ComplexMatrix, quantityNames List of string) +Fills the data set from a matrix. +Input Parameters +matrix(ComplexMatrix) +Matrix to fill the dataset with. +quantityNames(List of string) +List of quantities the matrix represents. +FromMatrix (matrix Matrix, quantityNames List of string) +Fills the data set from a matrix. +Input Parameters +matrix(Matrix) +Matrix to fill the dataset with. +quantityNames(List of string) +List of quantities the matrix represents. +ToComplexMatrix (quantityNames List of string) +Extracts data from the data set. +Input Parameters +quantityNames(List of string) +List of quantities to extract. +Return +ComplexMatrix +A matrix with a quantity in each column. +ToMatrix (quantityNames List of string) +Extracts data from the data set. +Input Parameters +quantityNames(List of string) +List of quantities to extract. +Return +Matrix +A matrix with a quantity in each column. +DataSetMetaData +Additional information that further helps to define a data set. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the far field data set +farFieldDataSet = + app.Models[1].Configurations[1].FarFields["FarFields"]:GetDataSet(51) + -- Adjust the origin of the far field +farFieldDataSet.MetaData.Origin = pf.Point(0,0,0.01) + -- Store the far field and plot it +storedFarField = farFieldDataSet:StoreData(pf.Enums.StoredDataTypeEnum.FarField) +plot = app.Views[1].Plots:Add(storedFarField) +Usage locations +The DataSetMetaData object can be accessed from the following locations: +• Properties +◦ DataSet object has property MetaData. +Property List +Conical +Indicates whether a near field is defined in the conical coordinate system. Note that +“RhoStepSize” must also be set. (Read/Write boolean) +Impedance +The source Impedance. Applies to power data sets. (Read/Write Complex) +MediumNames +The media names for near field media data sets. An index to this table is provided as a quantity +that is defined for each point of a qualifying near field. (Read/Write List of string) +ModalExcitationCoefficientIsCalculated +Indicates whether calculating modal excitation coefficients was requested. (Read/Write boolean) +Origin +The origin of a math result data set in Cartesian coordinates. Applies to near field and far field +data sets. (Read/Write Point) +PowerScaling +The source power scaling type. Applies to power data sets. (Read/Write PowerScaleSettingsEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +RhoStepSize +p.3107 +The Rho step size for conical near fields. Note that “Conical” must also be set. (Read/Write +number) +SourcePower +The source power (Watt). This is only applicable when PowerScaling is not “NoPowerScaling”. +Applies to power data sets. (Read/Write number) +SourcePowerDecoupled +Whether the source power is decoupled. Applies to power data sets. (Read/Write boolean) +UVector +The U Vector of a math result data set in Cartesian coordinates. Applies to near field and far field +data sets. (Read/Write Point) +VVector +The V Vector of a math result data set in Cartesian coordinates. Applies to near field and far field +data sets. (Read/Write Point) +Property Details +Conical +Indicates whether a near field is defined in the conical coordinate system. Note that +“RhoStepSize” must also be set. +Type +boolean +Access +Read/Write +Impedance +The source Impedance. Applies to power data sets. +Type +Complex +Access +Read/Write +MediumNames +The media names for near field media data sets. An index to this table is provided as a quantity +that is defined for each point of a qualifying near field. +Access +Read/Write +ModalExcitationCoefficientIsCalculated +Indicates whether calculating modal excitation coefficients was requested. +Type +boolean +Access +Read/Write +Origin +The origin of a math result data set in Cartesian coordinates. Applies to near field and far field +data sets. +Type +Point +Access +Read/Write +PowerScaling +The source power scaling type. Applies to power data sets. +Type +PowerScaleSettingsEnum +Access +Read/Write +RhoStepSize +The Rho step size for conical near fields. Note that “Conical” must also be set. +Type +number +Access +Read/Write +SourcePower +The source power (Watt). This is only applicable when PowerScaling is not “NoPowerScaling”. +Applies to power data sets. +Type +number +Access +Read/Write +SourcePowerDecoupled +Whether the source power is decoupled. Applies to power data sets. +Type +boolean +Access +Read/Write +UVector +The U Vector of a math result data set in Cartesian coordinates. Applies to near field and far field +data sets. +Type +Point +Access +Read/Write +VVector +The V Vector of a math result data set in Cartesian coordinates. Applies to near field and far field +data sets. +Type +Point +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +DataSetQuantity +p.3110 +Every DataSet contains axes and quantities. The DataSetQuantity describes the definition of a quantity. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the far field data set +farFieldDataSet = + app.Models[1].Configurations[1].FarFields["FarFields"]:GetDataSet(51) + -- Print a list of the far field quantities +printlist( farFieldDataSet.Quantities:Items() ) + -- Access information about the "EFieldTheta" quantity +EFieldThetaQuantity = farFieldDataSet.Quantities["EFieldTheta"] +quantityName = EFieldThetaQuantity.Name +quantityType = EFieldThetaQuantity.QuantityType +quantityUnit = EFieldThetaQuantity.Unit + -- Access the 'EFieldTheta' value at the first frequency, theta and phi point +EFieldThetaValue = farFieldDataSet[1][1][1].EFieldTheta +Usage locations +The DataSetQuantity object can be accessed from the following locations: +• Methods +◦ DataSetQuantityCollection collection has method Items(). +◦ DataSetQuantityCollection collection has method Item(number). +◦ DataSetQuantityCollection collection has method Item(string). +◦ DataSetQuantityCollection collection has method Add(string, DataSetQuantityTypeEnum, Unit). +◦ DataSetQuantityCollection collection has method Add(DataSetQuantity). +Property List +Name +The name of the quantity. (Read only string) +QuantityType +The value type of the quantity. (Read/Write DataSetQuantityTypeEnum) +Type +Unit +The object type string. (Read only string) +The unit for the quantity. (Read/Write Unit) +Method List +Delete () +Deletes the quantity from the dataset. +Property Details +Name +The name of the quantity. +Type +string +Access +Read only +QuantityType +The value type of the quantity. +Type +DataSetQuantityTypeEnum +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Unit +The unit for the quantity. +Type +Unit +Access +Read/Write +Method Details +Delete () +Deletes the quantity from the dataset. +Altair Feko 2022.3 +2 Application Programming Interface (API) +DependentAxisFormat +The trace dependent axis properties. +Example +p.3112 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) +cartesianGraph = app.CartesianGraphs:Add() +trace = cartesianGraph.Traces:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Set axes properties +trace.Axes.Dependent.Unit = "kV/m" +cartesianGraph:ZoomToExtents() +Usage locations +The DependentAxisFormat object can be accessed from the following locations: +• Properties +◦ TraceAxes object has property Dependent. +Property List +Unit +The unit of the dependent axis of the trace. (Read/Write string) +Property Details +Unit +The unit of the dependent axis of the trace. +Type +string +Access +Read/Write +ErrorEstimate3DPlot +An error estimate 3D result. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Horn_error_estimates.fek]]) +errorEstimateData = + app.Models[1].Configurations[1].ErrorEstimates["ErrorEstimation1"] + -- Add the error estimation to the 3D view +errorEstimationPlot1 = app.Views[1].Plots:Add(errorEstimateData) + -- SetProperties the quantity +errorEstimationPlot1.Quantity.ValuesScaledToLog = true +Inheritance +The ErrorEstimate3DPlot object is derived from the Result3DPlot object. +Property List +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The object that is the data source for this plot. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +Label +The object label. (Read/Write string) +Legend +The 3D plot legend properties. (Read only Plot3DLegendFormat) +Quantity +The error estimate 3D plot quantity properties. (Read only ErrorEstimatesQuantity) +Type +The object type string. (Read only string) +Visible +Specifies whether the plot must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the plot. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Stores a copy of the plot. (Returns a Result3DPlot object.) +Property Details +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The object that is the data source for this plot. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Legend +The 3D plot legend properties. +Type +Plot3DLegendFormat +Access +Read only +Quantity +The error estimate 3D plot quantity properties. +Type +ErrorEstimatesQuantity +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Visible +Specifies whether the plot must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the plot. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Stores a copy of the plot. +Return +Result3DPlot +The new plot associated with the stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ErrorEstimateData +Error estimates generated by the Feko Solver. +Example +p.3118 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Horn_error_estimates.fek]]) + -- Retrieve the 'ErrorEstimateData' called 'ErrorEstimation1' +errorEstimateData = + app.Models[1].Configurations[1].ErrorEstimates["ErrorEstimation1"] + -- Add the error estimation to the 3D view +errorEstimationPlot1 = app.Views[1].Plots:Add(errorEstimateData) +Inheritance +The ErrorEstimateData object is derived from the ResultData object. +Usage locations +The ErrorEstimateData object can be accessed from the following locations: +• Methods +◦ ErrorEstimateCollection collection has method Items(). +◦ ErrorEstimateCollection collection has method Item(number). +◦ ErrorEstimateCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +ErrorEstimatesQuantity +The error estimate quantity properties. +Example +p.3120 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Horn_error_estimates.fek]]) +errorEstimateData = + app.Models[1].Configurations[1].ErrorEstimates["ErrorEstimation1"] + -- Add the error estimation to the 3D view +errorEstimationPlot1 = app.Views[1].Plots:Add(errorEstimateData) + -- SetProperties the quantity +errorEstimationPlot1.Quantity.ValuesScaledToLog = true +Usage locations +The ErrorEstimatesQuantity object can be accessed from the following locations: +• Properties +◦ ErrorEstimate3DPlot object has property Quantity. +Property List +Type +The type of quantity to be plotted, e.g. All mesh elements, Triangles and Segments. (Read/Write +ErrorEstimateQuantityTypeEnum) +ValuesScaledToLog +Specifies whether the quantity values must be logarithmic scaled before plotting. (Read/Write +boolean) +Property Details +Type +The type of quantity to be plotted, e.g. All mesh elements, Triangles and Segments. +Type +ErrorEstimateQuantityTypeEnum +Access +Read/Write +ValuesScaledToLog +Specifies whether the quantity values must be logarithmic scaled before plotting. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ExcitationData +Excitation results generated by the Feko Solver. +Example +p.3122 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the 'ExcitationData' called 'VoltageSource' +excitationData = app.Models[1].Configurations[1].Excitations["VoltageSource"] + -- Manipulate the excitation data. See 'DataSet' for faster and more + comprehensive options +dataSet = excitationData:GetDataSet(51) +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Find the frequency start and end values +frequencyAxis = dataSet.Axes["Frequency"] +frequencyStartValue = frequencyAxis:ValueAt(1) +frequencyEndValue = frequencyAxis:ValueAt(#frequencyAxis) + -- Scale the power values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.Power = indexedValue.Power * scale +end + -- Store the manipulated data +scaledExcitation = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Source) + -- Compare the original excitation to the manipulated excitation +graph = app.CartesianGraphs:Add() +excitationTrace1 = graph.Traces:Add(excitationData) +excitationTrace1.Quantity.Type = pf.Enums.ImpedanceQuantityTypeEnum.SourcePower +excitationTrace2 = graph.Traces:Add(scaledExcitation) +excitationTrace2.Quantity.Type = pf.Enums.ImpedanceQuantityTypeEnum.SourcePower +Inheritance +The ExcitationData object is derived from the ResultData object. +The following objects are derived (specialisations) from the ExcitationData object: +• SourceAperture +• SourceCoaxial +• SourceCurrentRegion +• SourceCurrentSpace +• SourceCurrentTriangle +• SourceElectricDipole +• SourceMagneticDipole +• SourceMagneticFrill +• SourceModal +• SourcePCB +• SourcePlaneWave +• SourceRadiationPattern +• SourceSolutionCoefficient +• SourceSphericalModes +• SourceVoltageCable +• SourceVoltageEdge +• SourceVoltageNetwork +• SourceVoltageSegment +• SourceVoltageVertex +• SourceWaveguide +Usage locations +The ExcitationData object can be accessed from the following locations: +• Methods +◦ ExcitationCollection collection has method Items(). +◦ ExcitationCollection collection has method Item(number). +◦ ExcitationCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +The object label. (Read/Write string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ExcitationMathScript +Excitation math script data that can be plotted. +Example +p.3126 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a excitation math script +excitationMathScript = app.MathScripts:Add(pf.Enums.MathScriptTypeEnum.Source) +script = +[[ +dataSet = pf.Excitation.GetDataSet("startup.StandardConfiguration1.VoltageSource", + 51) +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.Power = indexedValue.Power * scale +end +return dataSet +]] +excitationMathScript.Script = script +excitationMathScript:Run() + -- Plot the math script +graph = app.CartesianGraphs:Add() +excitationTrace1 = graph.Traces:Add(excitationMathScript) +excitationTrace1.Quantity.Type = pf.Enums.ImpedanceQuantityTypeEnum.SourcePower +Inheritance +The ExcitationMathScript object is derived from the MathScript object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Script +Type +The object label. (Read/Write string) +The script code to execute. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. (Returns a MathScript object.) +GetDataSet () +Returns a data set containing the math script values. (Returns a DataSet object.) +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Script +The script code to execute. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. +Return +MathScript +The duplicated math script. +GetDataSet () +Returns a data set containing the math script values. +Return +DataSet +The data set containing the math script values. +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ExcitationQuantity +The excitation quantity properties. +Example +p.3129 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +excitationData = app.Models[1].Configurations[1].Excitations["VoltageSource"] + -- Create a cartesian graph and add the excitation data +graph = app.CartesianGraphs:Add() +excitationTrace = graph.Traces:Add(excitationData) + -- Configure the trace quantity +excitationTrace.Quantity.Type = pf.Enums.ImpedanceQuantityTypeEnum.VSWR +excitationTrace.Quantity.LoadSubtractionEnabled = true +excitationTrace.Quantity.LoadSubtractionType = pf.Enums.LoadingTypeEnum.Admittance +excitationTrace.Quantity.LoadExpression = "50" +Usage locations +The ExcitationQuantity object can be accessed from the following locations: +• Properties +◦ ExcitationTrace object has property Quantity. +Property List +ComplexComponent +The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. +Magnitude, Phase, Real, Imaginary. (Read/Write ComplexComponentEnum) +LoadExpression +The load value to use. The value is a complex expression, e.g. “50+j*0”. (Read/Write Expression) +LoadSubtractionEnabled +Specifies whether the loading value must be subtracted before plotting. (Read/Write boolean) +LoadSubtractionType +The type of load subtraction to be plotted, specified by the LoadingTypeEnum, e.g. Impedance or +Admittance. (Read/Write LoadingTypeEnum) +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. (Read/Write boolean) +ReferenceImpedanceExpression +The reference impedance value to use. The value is a complex expression, e.g. “50+j*0”. (Read/ +Write Expression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +p.3130 +The type of quantity to be plotted, specified by the ImpedanceQuantityTypeEnum, e.g. +Impedance, Admittance, Voltage, Current, etc. (Read/Write ImpedanceQuantityTypeEnum) +UseCustomReferenceImpedance +Specifies whether a custom reference impedance should be used. (Read/Write boolean) +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. (Read/Write boolean) +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when the ComplexComponent is Magnitude. (Read/Write boolean) +Property Details +ComplexComponent +The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. +Magnitude, Phase, Real, Imaginary. +Type +ComplexComponentEnum +Access +Read/Write +LoadExpression +The load value to use. The value is a complex expression, e.g. “50+j*0”. +Type +Expression +Access +Read/Write +LoadSubtractionEnabled +Specifies whether the loading value must be subtracted before plotting. +Type +boolean +Access +Read/Write +LoadSubtractionType +The type of load subtraction to be plotted, specified by the LoadingTypeEnum, e.g. Impedance or +Admittance. +Type +LoadingTypeEnum +Access +Read/Write +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +ReferenceImpedanceExpression +The reference impedance value to use. The value is a complex expression, e.g. “50+j*0”. +Type +Expression +Access +Read/Write +Type +The type of quantity to be plotted, specified by the ImpedanceQuantityTypeEnum, e.g. +Impedance, Admittance, Voltage, Current, etc. +Type +ImpedanceQuantityTypeEnum +Access +Read/Write +UseCustomReferenceImpedance +Specifies whether a custom reference impedance should be used. +Type +boolean +Access +Read/Write +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ValuesScaledToDB +p.3132 +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when the ComplexComponent is Magnitude. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ExcitationSmithQuantity +The Smith excitation quantity properties. +Example +p.3133 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +excitationData = app.Models[1].Configurations[1].Excitations["VoltageSource"] + -- Create a smith chart and add the excitation data +graph = app.SmithCharts:Add() +excitationTrace = graph.Traces:Add(excitationData) + -- Configure the trace quantity +excitationTrace.Quantity.PhaseAdditionEnabled = true +excitationTrace.Quantity.Phase = 50 +excitationTrace.Quantity.LoadSubtractionEnabled = true +excitationTrace.Quantity.LoadSubtractionType = pf.Enums.LoadingTypeEnum.Admittance +excitationTrace.Quantity.LoadExpression = "50" +Usage locations +The ExcitationSmithQuantity object can be accessed from the following locations: +• Properties +◦ ExcitationSmithTrace object has property Quantity. +Property List +LoadExpression +The load value to use. The value is a complex expression, e.g. “50+j*0”. (Read/Write Expression) +LoadSubtractionEnabled +Specifies whether the loading value must be subtracted before plotting. (Read/Write boolean) +LoadSubtractionType +The type of load subtraction to be plotted, specified by the LoadingTypeEnum, e.g. Impedance or +Admittance. (Read/Write LoadingTypeEnum) +Phase +The phase to be added to the trace. The value is in degrees [-360,360]. (Read/Write number) +PhaseAdditionEnabled +Enable phase addition for the trace. (Read/Write boolean) +ReferenceImpedanceExpression +The reference impedance value to use. The value is a complex expression, e.g. “50+j*0”. (Read/ +Write Expression) +Type +The type of quantity to be plotted, specified by the ImpedanceQuantityTypeEnum, e.g. +Impedance, Admittance, Voltage, Current, etc. (Read/Write ImpedanceQuantityTypeEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UseCustomReferenceImpedance +Specifies whether a custom reference impedance should be used. (Read/Write boolean) +Property Details +LoadExpression +The load value to use. The value is a complex expression, e.g. “50+j*0”. +p.3134 +Type +Expression +Access +Read/Write +LoadSubtractionEnabled +Specifies whether the loading value must be subtracted before plotting. +Type +boolean +Access +Read/Write +LoadSubtractionType +The type of load subtraction to be plotted, specified by the LoadingTypeEnum, e.g. Impedance or +Admittance. +Type +LoadingTypeEnum +Access +Read/Write +Phase +The phase to be added to the trace. The value is in degrees [-360,360]. +Type +number +Access +Read/Write +PhaseAdditionEnabled +Enable phase addition for the trace. +Type +boolean +Access +Read/Write +ReferenceImpedanceExpression +The reference impedance value to use. The value is a complex expression, e.g. “50+j*0”. +Type +Expression +Access +Read/Write +Type +The type of quantity to be plotted, specified by the ImpedanceQuantityTypeEnum, e.g. +Impedance, Admittance, Voltage, Current, etc. +Type +ImpedanceQuantityTypeEnum +Access +Read/Write +UseCustomReferenceImpedance +Specifies whether a custom reference impedance should be used. +Type +boolean +Access +Read/Write +ExcitationSmithTrace +An excitation 2D Smith trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +excitationData = app.Models[1].Configurations[1].Excitations["VoltageSource"] + -- Create a smith chart and add the excitation data +graph = app.SmithCharts:Add() +excitationTrace = graph.Traces:Add(excitationData) + -- Configure the trace quantity +excitationTrace.Quantity.PhaseAdditionEnabled = true +excitationTrace.Quantity.Phase = 50 +Inheritance +The ExcitationSmithTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Quantity +The excitation trace quantity properties. (Read only ExcitationSmithQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties table) +p.3138 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Quantity +The excitation trace quantity properties. +Type +ExcitationSmithQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +ExcitationStoredData +Stored excitation results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the 'ExcitationData' called 'VoltageSource' +excitationData = app.Models[1].Configurations[1].Excitations["VoltageSource"] + -- Store a copy of the excitation data. +storedData = + excitationData:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.Source) +Inheritance +The ExcitationStoredData object is derived from the ResultData object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +GetDataSet () +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the source values. +Return +DataSet +The data set containing the source values. +GetDataSet (samplePoints number) +Returns a data set containing the source values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +ExcitationTrace +A excitation 2D trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +excitationData = app.Models[1].Configurations[1].Excitations["VoltageSource"] + -- Create a cartesian graph and add the excitation data +graph = app.CartesianGraphs:Add() +excitationTrace = graph.Traces:Add(excitationData) + -- Configure the trace quantity +excitationTrace.Quantity.Type = pf.Enums.ImpedanceQuantityTypeEnum.VSWR +Inheritance +The ExcitationTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The excitation trace math expression properties. (Read only TraceMathExpression) +Quantity +The excitation trace quantity properties. (Read only ExcitationQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The excitation trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The excitation trace quantity properties. +Type +ExcitationQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ResultTrace +A copy of the trace. +p.3151 +FEKOGPUOptions +Feko Solver graphical processing units (GPU) launch options. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Access the 'FEKOGPUOptions' object and inspect if NVidia CUDA devices are + enabled +cudaEnabled = app.Models[1].Launcher.Settings.FEKO.GPU.NVIDIAEnabled +Usage locations +The FEKOGPUOptions object can be accessed from the following locations: +• Properties +◦ FEKOLaunchOptions object has property GPU. +Property List +Count +List +Number of GPUs (empty = all). (Read/Write string) +List of GPUs (optional comma separated list). (Read/Write string) +NVIDIAEnabled +Enables/disables GPU for NIVIDIA CUDA devices. (Read/Write boolean) +NotificationEnabled +Enables/disables GPU notification. (Read/Write boolean) +Property Details +Count +Number of GPUs (empty = all). +Type +string +Access +Read/Write +List +List of GPUs (optional comma separated list). +Type +string +Access +Read/Write +NVIDIAEnabled +Enables/disables GPU for NIVIDIA CUDA devices. +Type +boolean +Access +Read/Write +NotificationEnabled +Enables/disables GPU notification. +Type +boolean +Access +Read/Write +FEKOLaunchOptions +Feko Solver launch options. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Access the 'FEKOLaunchOptions' object and inspect the geometry only check + option +onlyCheckGeometry = app.Models[1].Launcher.Settings.FEKO.OnlyCheckGeometryEnabled +Usage locations +The FEKOLaunchOptions object can be accessed from the following locations: +• Properties +◦ ComponentLaunchOptions object has property FEKO. +Property List +Advanced +Advanced command line options for launching the Feko Solver. (Read/Write string) +ExportSPICEMTLCircuitFilesEnabled +Special execution mode to export SPICE MTL circuit files. (Read/Write boolean) +GPU +Graphical processing units launch options. (Read/Write FEKOGPUOptions) +OnlyCheckGeometryEnabled +Enables/disables if the Feko Solver will perform all the geometry checks and exit before any +computations commence. (Read/Write boolean) +Parallel +Parallel execution launch options. (Read/Write FEKOParallelExecutionOptions) +ProcessPriority +The priority of the Feko Solver run. When set to Low the run will take slightly longer, but the +computer will still be responsive for other work. (Read/Write ProcessPriorityTypeEnum) +Remote +Remote execution launch options. (Read/Write FEKORemoteExecutionOptions) +Property Details +Advanced +Advanced command line options for launching the Feko Solver. +Type +string +Access +Read/Write +ExportSPICEMTLCircuitFilesEnabled +Special execution mode to export SPICE MTL circuit files. +Type +boolean +Access +Read/Write +GPU +Graphical processing units launch options. +Type +FEKOGPUOptions +Access +Read/Write +OnlyCheckGeometryEnabled +Enables/disables if the Feko Solver will perform all the geometry checks and exit before any +computations commence. +Type +boolean +Access +Read/Write +Parallel +Parallel execution launch options. +Type +FEKOParallelExecutionOptions +Access +Read/Write +ProcessPriority +The priority of the Feko Solver run. When set to Low the run will take slightly longer, but the +computer will still be responsive for other work. +Type +ProcessPriorityTypeEnum +Access +Read/Write +Remote +Remote execution launch options. +Type +FEKORemoteExecutionOptions +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FEKOParallelDiagnosticTests +p.3157 +Feko Solver parallel diagnostic test launch options. These settings should be disabled for normal Feko +Solver runs to not degrade performance. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Access the 'FEKOParallelDiagnosticTests' and check if network diagnostics are + enabled +networkDiagnostics = + app.Models[1].Launcher.Settings.FEKO.Parallel.DiagnosticTests.NetworkEnabled +Usage locations +The FEKOParallelDiagnosticTests object can be accessed from the following locations: +• Properties +◦ FEKOParallelExecutionOptions object has property DiagnosticTests. +Property List +CPURunTimesEnabled +Enables/disables full CPU report with run times for individual processes. (Read/Write boolean) +MFLOPSRateEnabled +Enables/disables output of the MFLOPS rate of each process (without network communication +time). (Read/Write boolean) +NetworkEnabled +Enables/disables output of network latency and bandwidth. (Read/Write boolean) +Property Details +CPURunTimesEnabled +Enables/disables full CPU report with run times for individual processes. +Type +boolean +Access +Read/Write +MFLOPSRateEnabled +Enables/disables output of the MFLOPS rate of each process (without network communication +time). +Type +boolean +Access +Read/Write +NetworkEnabled +Enables/disables output of network latency and bandwidth. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FEKOParallelExecutionOptions +Feko Solver parallel execution launch options. +Example +p.3159 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Access the 'FEKOParallelExecutionOptions' and check if parallel execution is + enabled +parallelEnabled = app.Models[1].Launcher.Settings.FEKO.Parallel.Enabled +Usage locations +The FEKOParallelExecutionOptions object can be accessed from the following locations: +• Properties +◦ FEKOLaunchOptions object has property Parallel. +Property List +AuthenticationMethod +Specifies the mechanism to be used for authenticating the parallel processes on the individual +machines. (Read/Write ParallelAuthenticationMethodEnum) +DiagnosticTests +Feko Solver parallel diagnostic test options. (Read/Write FEKOParallelDiagnosticTests) +Enabled +Enables/disables parallel execution for the Feko Solver runs. (Read/Write boolean) +NumberOfProcessesEnabled +Enables/disables the specification of the number of processes to be used for parallel launching. +(Read/Write boolean) +ProcessCount +Specifies the total number of parallel processes to be launched. Changing this property will set +NumberOfProcessesEnabled to true. (Read/Write number) +Property Details +AuthenticationMethod +Specifies the mechanism to be used for authenticating the parallel processes on the individual +machines. +Type +ParallelAuthenticationMethodEnum +Access +Read/Write +DiagnosticTests +Feko Solver parallel diagnostic test options. +Type +FEKOParallelDiagnosticTests +Access +Read/Write +Enabled +Enables/disables parallel execution for the Feko Solver runs. +Type +boolean +Access +Read/Write +NumberOfProcessesEnabled +Enables/disables the specification of the number of processes to be used for parallel launching. +Type +boolean +Access +Read/Write +ProcessCount +Specifies the total number of parallel processes to be launched. Changing this property will set +NumberOfProcessesEnabled to true. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FEKORemoteExecutionOptions +Feko Solver remote execution launch options. +Example +p.3161 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Access the 'FEKORemoteExecutionOptions' object and check for remote execution +remoteExecutionEnabled = app.Models[1].Launcher.Settings.FEKO.Remote.Enabled +Usage locations +The FEKORemoteExecutionOptions object can be accessed from the following locations: +• Properties +◦ FEKOLaunchOptions object has property Remote. +Property List +Enabled +Enables/disables running Feko Solver on a remote machine. (Read/Write boolean) +ExecutionMethod +Remote execution method. MPI is only supported between windows machines where ssh/rsh can +be used between different platforms. (Read/Write RemoteExecutionMethodEnum) +Host +The remote host (hostname of IP address). (Read/Write string) +Property Details +Enabled +Enables/disables running Feko Solver on a remote machine. +Type +boolean +Access +Read/Write +ExecutionMethod +Remote execution method. MPI is only supported between windows machines where ssh/rsh can +be used between different platforms. +Type +RemoteExecutionMethodEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Host +The remote host (hostname of IP address). +Type +string +Access +Read/Write +p.3162 +FarField3DFormat +The far field 3D plot visualisation properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farFieldData = app.Models[1].Configurations[1].FarFields["FarFields"] +farFieldPlot = app.Views[1].Plots:Add(farFieldData) + -- Configure the plot visualisation +farFieldPlot.Visualisation.FlatShaded = true +farFieldPlot.Visualisation.Opacity = 50 +farFieldPlot.Visualisation.Origin = pf.Point(0, 0, 0.002) +Usage locations +The FarField3DFormat object can be accessed from the following locations: +• Properties +◦ FarField3DPlot object has property Visualisation. +Property List +AutoExtruded +Specifies whether auto extrusion is enabled or disabled for the far field plot. (Read/Write boolean) +AutoSizingEnabled +Specifies whether auto size is enabled or disabled for the far field plot. (Read/Write boolean) +Extrusion +The amount (%) the far field plot should be extruded in range [0,100]. (Read/Write number) +FlatShaded +Specifies whether discrete colours (flat shading) should be enabled or disabled for the far field +plot. (Read/Write boolean) +GridVisible +Specifies whether the far field plot grid must be shown or hidden. (Read/Write boolean) +Opacity +Specify the far field plot opacity (%) in the range [0, 100]. (Read/Write number) +Origin +The origin position of the far field plot. (Read/Write Point) +Size +The custom size (m) of the far field plot. AutoSizingEnabled needs to be disabled for this property +to take affect. (Read/Write number) +SizeFactor +The amount (%) the far field plot should be scaled in range [0,600]. (Read/Write number) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfaceVisible +p.3164 +Specifies whether the far field plot surface must be shown or hidden. (Read/Write boolean) +Property Details +AutoExtruded +Specifies whether auto extrusion is enabled or disabled for the far field plot. +Type +boolean +Access +Read/Write +AutoSizingEnabled +Specifies whether auto size is enabled or disabled for the far field plot. +Type +boolean +Access +Read/Write +Extrusion +The amount (%) the far field plot should be extruded in range [0,100]. +Type +number +Access +Read/Write +FlatShaded +Specifies whether discrete colours (flat shading) should be enabled or disabled for the far field +plot. +Type +boolean +Access +Read/Write +GridVisible +Specifies whether the far field plot grid must be shown or hidden. +Type +boolean +Access +Read/Write +Opacity +Specify the far field plot opacity (%) in the range [0, 100]. +Type +number +Access +Read/Write +Origin +The origin position of the far field plot. +Type +Point +Access +Read/Write +Size +The custom size (m) of the far field plot. AutoSizingEnabled needs to be disabled for this property +to take affect. +Type +number +Access +Read/Write +SizeFactor +The amount (%) the far field plot should be scaled in range [0,600]. +Type +number +Access +Read/Write +SurfaceVisible +Specifies whether the far field plot surface must be shown or hidden. +Type +boolean +Access +Read/Write +FarField3DPlot +A far field 3D result. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farFieldData = app.Models[1].Configurations[1].FarFields["FarFields"] + -- Create a 3D Plot of the far field +farFieldPlot = app.Views[1].Plots:Add(farFieldData) + -- Configure the plot axes +farFieldPlot.PlotType = "Phi cut" +farFieldPlot:SetFixedAxisValue("Frequency", 7.0, "GHz") +farFieldPlot:SetFixedAxisValue("Phi", 60, "deg") +Inheritance +The FarField3DPlot object is derived from the Result3DPlot object. +Property List +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +Contours +The far field plot contours properties. (Read only Contours3DFormat) +DataSource +The object that is the data source for this plot. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +Label +The object label. (Read/Write string) +Legend +The 3D plot legend properties. (Read only Plot3DLegendFormat) +LocalCoordAxes +The far field local coordinate axis properties. (Read only Axes3DFormat) +PlotType +The type of plot to be displayed, e.g., 3D Surface, Phi cut, Theta cut, XY surface. (Read/Write +string) +PlotTypesAvailable +The list of available plot types. (Read only List of string) +Quantity +The far field 3D plot quantity properties. (Read only FarFieldQuantity) +RequestPoints +The far field request points properties. (Read only RequestPoints3DFormat) +Sampling +The continuous plot sampling settings. These settings only apply to plots that have continuous +axes. (Read only PlotSamplingFormat) +Type +The object type string. (Read only string) +Visible +Specifies whether the plot must be shown or hidden. (Read/Write boolean) +Visualisation +The far field visualisation properties. (Read only FarField3DFormat) +Method List +Delete () +Delete the plot. +Duplicate () +Duplicate the plot. (Returns a Result3DPlot object.) +GetAxisUnit (axis string) +Returns the SI unit for the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Stores a copy of the plot. (Returns a Result3DPlot object.) +Property Details +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +Contours +The far field plot contours properties. +Type +Contours3DFormat +Access +Read only +DataSource +The object that is the data source for this plot. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Legend +The 3D plot legend properties. +Type +Plot3DLegendFormat +Access +Read only +LocalCoordAxes +The far field local coordinate axis properties. +Type +Axes3DFormat +Access +Read only +PlotType +The type of plot to be displayed, e.g., 3D Surface, Phi cut, Theta cut, XY surface. +Type +string +Access +Read/Write +PlotTypesAvailable +The list of available plot types. +Access +Read only +Quantity +The far field 3D plot quantity properties. +Type +FarFieldQuantity +Access +Read only +RequestPoints +The far field request points properties. +Type +RequestPoints3DFormat +Access +Read only +Sampling +The continuous plot sampling settings. These settings only apply to plots that have continuous +axes. +Type +PlotSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Visible +Specifies whether the plot must be shown or hidden. +Type +boolean +Access +Read/Write +Visualisation +The far field visualisation properties. +Type +FarField3DFormat +Access +Read only +Method Details +Delete () +Delete the plot. +Duplicate () +Duplicate the plot. +Return +Result3DPlot +The duplicated plot. +GetAxisUnit (axis string) +Returns the SI unit for the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Stores a copy of the plot. +Return +Result3DPlot +The new plot associated with the stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldData +Far field results generated by the Feko Solver. +Example +p.3173 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the 'FarFieldData' called 'FarFields' +farFieldData = app.Models[1].Configurations[1].FarFields["FarFields"] + -- Manipulate the far field data. See 'DataSet' for faster and more comprehensive + options +dataSet = farFieldData:GetDataSet(51) +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Find the theta start and end values +thetaAxis = dataSet.Axes["Theta"] +thetaStartValue = thetaAxis:ValueAt(1) +thetaEndValue = thetaAxis:ValueAt(#thetaAxis) + -- Scale the far field field values +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 + -- Store the manipulated data +scaledFarField = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.FarField) + -- Compare the original far field to the manipulated far field +farFieldPlot1 = app.Views[1].Plots:Add(farFieldData) +farFieldPlot2 = app.Views[1].Plots:Add(scaledFarField) +graph = app.CartesianGraphs:Add() +farFieldTrace1 = graph.Traces:Add(farFieldData) +farFieldTrace2 = graph.Traces:Add(scaledFarField) +Inheritance +The FarFieldData object is derived from the ResultData object. +Usage locations +The FarFieldData object can be accessed from the following locations: +• Methods +◦ FarFieldCollection collection has method Items(). +◦ FarFieldCollection collection has method Item(number). +◦ FarFieldCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +ContinuousPhiAxis +Continuous phi axis exists. (Read only boolean) +ContinuousThetaAxis +Continuous theta axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, quantity FarFieldsExportTypeEnum, samples number) +Export the result far field data to the specified *.ffe file. +GetDataSet () +Returns a data set containing the far field values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the far field values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the far field values. (Returns a DataSet object.) +GetSampledDataSet (theta number, phi number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. (Returns a DataSet object.) +GetSampledDataSet (thetaStart number, thetaEnd number, thetaCount number, phiStart number, +phiEnd number, phiCount number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. (Returns a DataSet object.) +GetSampledDataSet (frequency number, theta number, phi number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. (Returns a DataSet object.) +GetSampledDataSet (freqStart number, freqEnd number, freqCount number, thetaStart number, +thetaEnd number, thetaCount number, phiStart number, phiEnd number, phiCount number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +ContinuousPhiAxis +Continuous phi axis exists. +Type +boolean +Access +Read only +ContinuousThetaAxis +Continuous theta axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, quantity FarFieldsExportTypeEnum, samples number) +Export the result far field data to the specified *.ffe file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +quantity(FarFieldsExportTypeEnum) +The quantity type to export specified by the FarFieldsExportTypeEnum, e.g. Gain, +Directivity, RCS, etc. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Export the far field data to the current working directory +farFieldData = app.Models[1].Configurations[1].FarFields["FarFields"] +farFieldData:ExportData("temp_farFieldExport", + pf.Enums.FarFieldsExportTypeEnum.Directivity, + 51) +GetDataSet () +Returns a data set containing the far field values. +Return +DataSet +The data set containing the far field values. +GetDataSet (samplePoints number) +Returns a data set containing the far field values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the far field values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the far field values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the far field values. +GetSampledDataSet (theta number, phi number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. +Input Parameters +theta(number) +The theta sample density. +phi(number) +The phi sample density. +Return +DataSet +A far field data set. +GetSampledDataSet (thetaStart number, thetaEnd number, thetaCount number, phiStart number, +phiEnd number, phiCount number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. +Input Parameters +thetaStart(number) +The start of the theta range to sample. +thetaEnd(number) +The end of the theta range to sample. +thetaCount(number) +The theta sample density. +phiStart(number) +The start of the phi range to sample. +phiEnd(number) +The end of the phi range to sample. +phiCount(number) +The phi sample density. +Return +DataSet +A far field data set. +GetSampledDataSet (frequency number, theta number, phi number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. +Input Parameters +frequency(number) +The frequency sample density. +theta(number) +The theta sample density. +phi(number) +The phi sample density. +Return +DataSet +A far field data set. +GetSampledDataSet (freqStart number, freqEnd number, freqCount number, thetaStart number, +thetaEnd number, thetaCount number, phiStart number, phiEnd number, phiCount number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. +Input Parameters +freqStart(number) +The start of the frequency range to sample. +freqEnd(number) +The end of the frequency range to sample. +freqCount(number) +The frequency sample density. +thetaStart(number) +The start of the theta range to sample. +thetaEnd(number) +The end of the theta range to sample. +thetaCount(number) +The theta sample density. +phiStart(number) +The start of the phi range to sample. +phiEnd(number) +The end of the phi range to sample. +phiCount(number) +The phi sample density. +Return +DataSet +A far field data set. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldMathScript +Far field math script data that can be plotted. +Example +p.3180 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a far field 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 +farFieldMathScript:Run() + -- Plot the math script +farFieldPlot = app.Views[1].Plots:Add(farFieldMathScript) +Inheritance +The FarFieldMathScript object is derived from the MathScript object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Script +Type +The object label. (Read/Write string) +The script code to execute. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. (Returns a MathScript object.) +GetDataSet () +Returns a data set containing the math script values. (Returns a DataSet object.) +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Script +The script code to execute. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. +Return +MathScript +The duplicated math script. +GetDataSet () +Returns a data set containing the math script values. +Return +DataSet +The data set containing the math script values. +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +FarFieldPowerIntegralData +Far field power integral results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the 'FarFieldPowerIntegralData' called 'FarFields' +farFieldPowerData = + app.Models[1].Configurations[1].FarFieldPowerIntegrals["FarFields"] + -- Create a graph and add the far field power data to it +graph = app.CartesianGraphs:Add() +trace = graph.Traces:Add(farFieldPowerData) +Inheritance +The FarFieldPowerIntegralData object is derived from the ResultData object. +Usage locations +The FarFieldPowerIntegralData object can be accessed from the following locations: +• Methods +◦ FarFieldPowerIntegralCollection collection has method Items(). +◦ FarFieldPowerIntegralCollection collection has method Item(number). +◦ FarFieldPowerIntegralCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the far field power integral values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the far field power integral values. +Return +DataSet +The data set containing the far field power integral values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldPowerIntegralStoredData +Stored far field power integral results. +Example +p.3186 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Store the 'FarFieldPowerIntegralData' +farFieldPowerData = + app.Models[1].Configurations[1].FarFieldPowerIntegrals["FarFields"] +farFieldPowerStoredData = farFieldPowerData:StoreData() + -- Create a graph and add the far field power integral using the stored data +graph = app.CartesianGraphs:Add() +trace = graph.Traces:Add(farFieldPowerStoredData) +Inheritance +The FarFieldPowerIntegralStoredData object is derived from the ResultData object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the far field power integral values. (Returns a DataSet object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the far field power integral values. +Return +DataSet +The data set containing the far field power integral values. +FarFieldPowerIntegralTrace +A far field power integral 2D trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farFieldPowerData = + app.Models[1].Configurations[1].FarFieldPowerIntegrals["FarFields"] + -- Create a graph and add the far field power data to it +graph = app.CartesianGraphs:Add() +trace = graph.Traces:Add(farFieldPowerData) + -- Set the trace to dB +trace.Quantity.ValuesScaledToDB = true +Inheritance +The FarFieldPowerIntegralTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The far field power integral trace math expression properties. (Read only TraceMathExpression) +Quantity +The far field power integral trace quantity properties. (Read only PowerIntegralQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties table) +p.3190 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The far field power integral trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The far field power integral trace quantity properties. +Type +PowerIntegralQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +FarFieldQuantity +The far field quantity properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farFieldData = app.Models[1].Configurations[1].FarFields["FarFields"] + -- Create a polar graph and the far field data +polarGraph = app.PolarGraphs:Add() +farFieldTrace = polarGraph.Traces:Add(farFieldData) + -- Configure the trace quantity +farFieldTrace.Quantity.Type = pf.Enums.FarFieldQuantityTypeEnum.Directivity +farFieldTrace.Quantity.Component = pf.Enums.FarFieldQuantityComponentEnum.Ludwig3Co +farFieldTrace.Quantity.ValuesScaledToDB = true +Usage locations +The FarFieldQuantity object can be accessed from the following locations: +• Properties +◦ FarField3DPlot object has property Quantity. +◦ FarFieldSurfacePlot object has property Quantity. +◦ FarFieldTrace object has property Quantity. +Property List +ComplexComponent +The complex component of the far field value to plot, specified by the ComplexComponentEnum, +e.g. Magnitude, Phase, Real, Imaginary. (Read/Write ComplexComponentEnum) +Component +The component of the far field quantity type to be plotted, specified by the +FarFieldQuantityComponentEnum, e.g., Total, Theta, Phi, Ludwig3Co, Ludwig3Cross, MajorMinor, +MinorMajor, etc. (Read/Write FarFieldQuantityComponentEnum) +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. (Read/Write boolean) +Type +The type of far field quantity to be plotted, specified by the FarFieldQuantityTypeEnum, e.g. +EField, Gain, Directivity, RCS, etc. (Read/Write FarFieldQuantityTypeEnum) +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before +plotting. This property can be used together with dB scaling. This property is not valid when +ComplexComponent is Phase. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +ValuesScaledToDB +p.3196 +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when ComplexComponent is Magnitude. (Read/Write boolean) +Property Details +ComplexComponent +The complex component of the far field value to plot, specified by the ComplexComponentEnum, +e.g. Magnitude, Phase, Real, Imaginary. +Type +ComplexComponentEnum +Access +Read/Write +Component +The component of the far field quantity type to be plotted, specified by the +FarFieldQuantityComponentEnum, e.g., Total, Theta, Phi, Ludwig3Co, Ludwig3Cross, MajorMinor, +MinorMajor, etc. +Type +FarFieldQuantityComponentEnum +Access +Read/Write +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +Type +The type of far field quantity to be plotted, specified by the FarFieldQuantityTypeEnum, e.g. +EField, Gain, Directivity, RCS, etc. +Type +FarFieldQuantityTypeEnum +Access +Read/Write +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before +plotting. This property can be used together with dB scaling. This property is not valid when +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when ComplexComponent is Magnitude. +Type +boolean +Access +Read/Write +FarFieldReceivingAntennaData +Receiving antenna results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) +solutionConfig = app.Models[1].Configurations[1] + -- Retrieve the 'FarFieldReceivingAntennaData' called 'FarFieldReceivingAntenna1' + -- Note that the 'FarFieldReceivingAntennaData' is retrieved in the same way as + the + -- 'ReceivingAntennaData' +farFieldRxAntennaData = solutionConfig.ReceivingAntennas["FarFieldReceivingAntenna1"] + -- Add the receiving antenna data to a Cartesian graph +graph = app.CartesianGraphs:Add() +receivingAntennaTrace1 = graph.Traces:Add(farFieldRxAntennaData) +Inheritance +The FarFieldReceivingAntennaData object is derived from the ReceivingAntennaData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the power values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the power values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the power values. (Returns a DataSet object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the power values. +Return +DataSet +The data set containing the power values. +GetDataSet (samplePoints number) +Returns a data set containing the power values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the power values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the power values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the power values. +FarFieldStoredData +Stored far field results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the 'FarFieldData' called 'FarFields' +farFieldData = app.Models[1].Configurations[1].FarFields["FarFields"] + -- Store a copy of the far field data. +storedData = + farFieldData:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.FarField) +Inheritance +The FarFieldStoredData object is derived from the ResultData object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +ExportData (filename string, quantity FarFieldsExportTypeEnum, samples number) +Export the result far field data to the specified *.ffe file. +GetDataSet () +Returns a data set containing the far field values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the far field values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the far field values. (Returns a DataSet object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +ExportData (filename string, quantity FarFieldsExportTypeEnum, samples number) +Export the result far field data to the specified *.ffe file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +quantity(FarFieldsExportTypeEnum) +The quantity type to export specified by the FarFieldsExportTypeEnum, e.g. Gain, +Directivity, RCS, etc. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the far field values. +Return +DataSet +The data set containing the far field values. +GetDataSet (samplePoints number) +Returns a data set containing the far field values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the far field values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the far field values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the far field values. +FarFieldSurfacePlot +A far field surface plot. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farFieldData = app.Models[1].Configurations[1].FarFields["FarFields"] +graph = app.CartesianSurfaceGraphs:Add() + -- Add the far field data to a Cartesian surface graph +farFieldPlot = graph.Plots:Add(farFieldData) + -- Configure the plot axes +farFieldPlot.HorizontalIndependentAxis = "Frequency" +farFieldPlot.VerticalIndependentAxis = "Theta" +farFieldPlot:SetFixedAxisValue("Phi", 10.0, "deg") + -- Configure the plot quantity +farFieldPlot.Quantity.Type = pf.Enums.FarFieldQuantityTypeEnum.Directivity +Inheritance +The FarFieldSurfacePlot object is derived from the ResultSurfacePlot object. +Property List +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the surface plot. (Read/Write ResultData) +DiscretePlotEnabled +Specifies whether the discrete plot property is enabled or disabled for this surface plot. (Read/ +Write boolean) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +HorizontalIndependentAxis +The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/ +Write string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +Label +The object label. (Read/Write string) +Legend +The surface plot legend properties. (Read only SurfacePlotLegendFormat) +Quantity +The far field surface plot quantity properties. (Read only FarFieldQuantity) +Sampling +The continuous surface plot sampling settings. These settings only apply to traces when the +independent axis is continuously sampled. (Read only SurfacePlotSamplingFormat) +Type +The object type string. (Read only string) +VerticalIndependentAxis +The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write +string) +Visible +Specifies whether the surface plot must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the surface plot. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the surface plot. +SwitchIndependentAxes () +Switches the horizontal and vertical independent axes. +Property Details +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the surface plot. +Type +ResultData +Access +Read/Write +DiscretePlotEnabled +Specifies whether the discrete plot property is enabled or disabled for this surface plot. +Type +boolean +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +HorizontalIndependentAxis +The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +IndependentAxesAvailable +The list of available independent axes. +Label +Access +Read only +The object label. +Type +string +Access +Read/Write +Legend +The surface plot legend properties. +Type +SurfacePlotLegendFormat +Access +Read only +Quantity +The far field surface plot quantity properties. +Type +FarFieldQuantity +Access +Read only +Sampling +The continuous surface plot sampling settings. These settings only apply to traces when the +independent axis is continuously sampled. +Type +SurfacePlotSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VerticalIndependentAxis +The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Visible +Specifies whether the surface plot must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the surface plot. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the surface plot. +SwitchIndependentAxes () +Switches the horizontal and vertical independent axes. +FarFieldTrace +A far field 2D trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farFieldData = app.Models[1].Configurations[1].FarFields["FarFields"] + -- Create a polar graph and the far field data +polarGraph = app.PolarGraphs:Add() +farFieldTrace = polarGraph.Traces:Add(farFieldData) + -- Configure the trace axes +farFieldTrace.IndependentAxis = "Phi" +farFieldTrace:SetFixedAxisValue("Frequency", 7.0, "GHz") +farFieldTrace:SetFixedAxisValue("Theta", 50, "deg") + -- Configure the trace quantity +farFieldTrace.Quantity.Type = pf.Enums.FarFieldQuantityTypeEnum.Directivity +Inheritance +The FarFieldTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The far field trace math expression properties. (Read only TraceMathExpression) +Quantity +The far field trace quantity properties. (Read only FarFieldQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The far field trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The far field trace quantity properties. +Type +FarFieldQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +FontFormat +The font format property. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianGraphs:Add() +graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Edit title 'FontFormat' +graph.Title.Font.Boldfaced = true +graph.Title.Font.Size = 20 + -- The font family can be set to any font available on the system. For example + -- graph.Title.Font.Family = "Courier New" +Usage locations +The FontFormat object can be accessed from the following locations: +• Properties +◦ SmithChart object has property ReactanceAxisFont. +◦ SmithChart object has property ResistanceAxisFont. +◦ TextBox object has property Font. +◦ GraphLegend object has property Font. +◦ GraphAxisLabels object has property Font. +◦ GraphAxisTitle object has property Font. +Property List +Boldfaced +Enables font bold. (Read/Write boolean) +Colour +The font colour. (Read/Write Colour) +Family +The font family. (Read/Write string) +Italicised +Enables font italic. (Read/Write boolean) +Size +The font size. (Read/Write number) +Underlined +Enables font underline. (Read/Write boolean) +Property Details +Boldfaced +Enables font bold. +Type +boolean +Access +Read/Write +Colour +The font colour. +Type +Colour +Access +Read/Write +Family +The font family. +Type +string +Access +Read/Write +Italicised +Enables font italic. +Size +Type +boolean +Access +Read/Write +The font size. +Type +number +Access +Read/Write +Underlined +Enables font underline. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Form +p.3219 +A fully customisable dialog. The form can be used as the base component for facilitating feedback from +interactive scripts. +Example + -- Create a 'Form' and a 'Label' to put on it +form = pf.Form.New("My Custom Dialog") +label = pf.FormLabel.New("Hello world!") + -- Add the label to the form's layout +form:Add(label) + -- Execute the form, potentially waiting for user input from buttons and widgets + added + -- to the form +form:Run() +Usage locations +The Form object can be accessed from the following locations: +• Static functions +◦ Form object has static function New(string, FormLayoutEnum). +◦ Form object has static function New(string). +◦ Form object has static function New(). +Property List +Buttons +A grouping that contains the OK and Cancel buttons. (Read only FormButtons) +Height +The height in pixels of the form window. (Read only number) +Title +Type +Width +The title that will be displayed in the title bar at the top of the form. (Read/Write string) +The object type string. (Read only string) +The width in pixels of the form window. (Read only number) +Collection List +FormItems +The collection of item widgets contained in the form. (FormItemCollection of FormItem.) +Method List +Accept () +Close the dialog and return true as return code for the Run() method. +Add (item FormItem) +Adds the given item to the form. Items can be any of the defined form item types. +Add (item FormItem, row number, column number) +Adds the given item to the form at the specified position. Positions are defined as a row and +column, starting at (1,1). +Reject () +Close the dialog and return false as return code for the Run() method. +Remove (item FormItem) +Removes the given item from the form. The item can be any of the items that resides in the +collection of the form items. +Resize () +Resize form to fit visible contents. +Run () +Executes the form. The values of any items will be modified and made accessible in a script once +the OK button on the form is pressed. (Returns a boolean object.) +SetSize (width number, height number) +Set the width and height of the form in pixels. Ensure that width and height are larger than zero. +Constructor Function List +Critical (title string, message string) +Creates a new critical message form and displays it. Further execution of the script is halted. +Info (title string, message string) +Creates an information message form and displays it. +New (title string, layout FormLayoutEnum) +Creates a new form with a specified label and layout. (Returns a Form object.) +New (title string) +Creates a new form with a specified label and vertical layout. (Returns a Form object.) +New () +Creates a new form with a vertical layout. (Returns a Form object.) +Warning (title string, message string) +Creates a new warning message form and displays it. +Property Details +Buttons +A grouping that contains the OK and Cancel buttons. +Type +FormButtons +Access +Read only +Height +The height in pixels of the form window. +Type +number +Access +Read only +Title +The title that will be displayed in the title bar at the top of the form. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Width +The width in pixels of the form window. +Type +number +Access +Read only +Collection Details +FormItems +The collection of item widgets contained in the form. +Type +FormItemCollection +Method Details +Accept () +Close the dialog and return true as return code for the Run() method. +Add (item FormItem) +Adds the given item to the form. Items can be any of the defined form item types. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +item(FormItem) +The form item to add to the form. +Add (item FormItem, row number, column number) +p.3222 +Adds the given item to the form at the specified position. Positions are defined as a row and +column, starting at (1,1). +Input Parameters +item(FormItem) +The form item to add to the form. +row(number) +The layout row position. +column(number) +The layout column position. +Reject () +Close the dialog and return false as return code for the Run() method. +Remove (item FormItem) +Removes the given item from the form. The item can be any of the items that resides in the +collection of the form items. +Input Parameters +item(FormItem) +The form item to remove from the form. +Resize () +Resize form to fit visible contents. +Run () +Executes the form. The values of any items will be modified and made accessible in a script once +the OK button on the form is pressed. +Return +boolean +True for the OK button and false for the Cancel button. +SetSize (width number, height number) +Set the width and height of the form in pixels. Ensure that width and height are larger than zero. +Input Parameters +width(number) +Width of the form in pixels. +height(number) +Height of the form in pixels. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +Critical (title string, message string) +p.3223 +Creates a new critical message form and displays it. Further execution of the script is halted. +Input Parameters +title(string) +The form window title. +message(string) +The critical message to display on the form. +Info (title string, message string) +Creates an information message form and displays it. +Input Parameters +title(string) +The form window title. +message(string) +The information message to display on the form. +New (title string, layout FormLayoutEnum) +Creates a new form with a specified label and layout. +Input Parameters +title(string) +The form window title. +layout(FormLayoutEnum) +A value indicating how new items will be arranged. +Return +Form +New (title string) +The newly created form. +Creates a new form with a specified label and vertical layout. +Input Parameters +title(string) +The form window title. +Return +Form +The newly created form. +New () +Creates a new form with a vertical layout. +Return +Form +The newly created form. +Warning (title string, message string) +Creates a new warning message form and displays it. +Input Parameters +title(string) +The form window title. +message(string) +The warning message to display on the form. +FormButtons +The form buttons. +Example +form = pf.Form.New("Default buttons") + -- Retrieve which button the user pressed +okPressed = form:Run() +Usage locations +The FormButtons object can be accessed from the following locations: +• Properties +◦ Form object has property Buttons. +Property List +Cancel +The Cancel button. (Read only FormPushButton) +OK +The OK button. (Read only FormPushButton) +Property Details +Cancel +The Cancel button. +OK +Type +FormPushButton +Access +Read only +The OK button. +Type +FormPushButton +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormCheckBox +p.3226 +A check box item. Check boxes are used mainly in two cases. The first case is when a simple yes/no +response is required. The second case is when multiple selections from a number options is permitted. +In this case each option will be presented by a separate check box. +Example +form = pf.Form.New("Export settings") + -- Create check boxes +checkbox1 = pf.FormCheckBox.New("Export electric near fields.") +checkbox1.Checked = true +checkbox2 = pf.FormCheckBox.New("Export magnetic near fields.") + -- Add check boxes to 'Form' layout +form:Add(checkbox1) +form:Add(checkbox2) + -- Run the form and retrieve the user input +form:Run() +mustExportEFields = checkbox1.Checked +mustExportHFields = checkbox2.Checked +Inheritance +The FormCheckBox object is derived from the FormItem object. +Usage locations +The FormCheckBox object can be accessed from the following locations: +• Static functions +◦ FormCheckBox object has static function New(string). +◦ FormCheckBox object has static function New(). +Property List +Checked +The state of the check box. True indicates that the box is checked, false indicates that it is +unchecked. (Read/Write boolean) +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +Altair Feko 2022.3 +2 Application Programming Interface (API) +FixedWidth +p.3227 +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +Label +The label of the push button. (Read/Write string) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +The object type string. (Read only string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +SetCallBack (callback function) +Set the function that will be called when the check box state changes. +Constructor Function List +New (label string) +Create a new check box item. The text describing the check box is determined by the specified +label. (Returns a FormCheckBox object.) +New () +Create a new check box item. (Returns a FormCheckBox object.) +Property Details +Checked +The state of the check box. True indicates that the box is checked, false indicates that it is +unchecked. +Type +boolean +Access +Read/Write +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +Label +The label of the push button. +Type +string +Access +Read/Write +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +SetCallBack (callback function) +Set the function that will be called when the check box state changes. +Input Parameters +callback(function) +The function call back. +Static Function Details +New (label string) +Create a new check box item. The text describing the check box is determined by the specified +label. +Input Parameters +label(string) +The label describing the check box. +Return +FormCheckBox +A check box form item created with the specified label. +New () +Create a new check box item. +Return +FormCheckBox +A check box form item created with the specified label. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormComboBox +p.3231 +A combo box item. A combo box provides a list of options of which at least one must be selected. +Example +form = pf.Form.New("Export settings") + -- Prepare input parameter and create combo box +options = {} +table.insert(options, "Only electric near fields") +table.insert(options, "Only magnetic near fields") +table.insert(options, "Both electric and magnetic near fields") +combobox = pf.FormComboBox.New("Results to export:", options) +form:Add(combobox) + -- Run the form and retrieve the user input +form:Run() +exportOptionSelected = combobox.Value +Inheritance +The FormComboBox object is derived from the FormLabelledItem object. +Usage locations +The FormComboBox object can be accessed from the following locations: +• Static functions +◦ FormComboBox object has static function New(string, Map of number:Expression). +◦ FormComboBox object has static function New(Map of number:Expression). +Property List +Count +The number of combo box items. (Read only number) +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +Index +The index of the selected item in the combo box item. (Read/Write number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Options +The options available in the combo box. (Read/Write Map of number:Expression) +Type +Value +The object type string. (Read only string) +The text of the selected item in the combo box item. (Read/Write Expression) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Constructor Function List +New (label string, map Map of number:Expression) +Create a new combo box item. (Returns a FormComboBox object.) +New (map Map of number:Expression) +Create a new combo box item. (Returns a FormComboBox object.) +Property Details +Count +The number of combo box items. +Type +number +Access +Read only +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +Index +The index of the selected item in the combo box item. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Options +The options available in the combo box. +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The text of the selected item in the combo box item. +Type +Expression +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Return +FormLabel +The form label item. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Input Parameters +callback(function) +The function call back. +Static Function Details +New (label string, map Map of number:Expression) +Create a new combo box item. +Input Parameters +label(string) +The text description that will appear next to the combo box. +map(Map of number:Expression) +The combo box value index map. The map refers to a standard Lua table with numeric +indexing. +Return +FormComboBox +The combo box item created. +New (map Map of number:Expression) +Create a new combo box item. +Input Parameters +map(Map of number:Expression) +The combo box value index map. The map refers to a standard Lua table with numeric +indexing. +Return +FormComboBox +The combo box item created. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormConfigurationSelector +Selects a solution configuration. +Example +p.3237 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a from and add a 'FormConfigurationSelector' +form = pf.Form.New("Generate antenna report") +configSelector = pf.FormConfigurationSelector.New("Choose antenna configuration") +form:Add(configSelector) + -- Run the form and retrieve the user input +form:Run() +solutionConfiguration = configSelector.Value +Inheritance +The FormConfigurationSelector object is derived from the FormItem object. +Usage locations +The FormConfigurationSelector object can be accessed from the following locations: +• Static functions +◦ FormConfigurationSelector object has static function New(string). +◦ FormConfigurationSelector object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +Index +The index of the selected configuration. (Read only number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The selected configuration. (Read only SolutionConfiguration) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Constructor Function List +New (label string) +Create a configuration selector. The selector will contain a list of solution configurations available +in the application. (Returns a FormConfigurationSelector object.) +New () +Create a configuration selector. The selector will contain a list of solution configurations available +in the application. (Returns a FormConfigurationSelector object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FixedHeight +p.3239 +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +Index +The index of the selected configuration. +Type +number +Access +Read only +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The selected configuration. +Type +SolutionConfiguration +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Static Function Details +New (label string) +Create a configuration selector. The selector will contain a list of solution configurations available +in the application. +Input Parameters +label(string) +The item label. +Return +FormConfigurationSelector +The label item created. +New () +Create a configuration selector. The selector will contain a list of solution configurations available +in the application. +Return +FormConfigurationSelector +The label item created. +FormDataSelector +Select result data of the specified type. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a from and add a 'FormDataSelector' for 'FarField' +form = pf.Form.New("Export far field") +selector = pf.FormDataSelector.New("Choose far field:", + pf.Enums.FormDataSelectorType.FarField) +form:Add(selector) + -- Run the form and retrieve the selection +form:Run() +resultData = selector.Value +Inheritance +The FormDataSelector object is derived from the FormItem object. +Usage locations +The FormDataSelector object can be accessed from the following locations: +• Static functions +◦ FormDataSelector object has static function New(string, FormDataSelectorType). +◦ FormDataSelector object has static function New(FormDataSelectorType). +Property List +Count +The number of data selector items. (Read only number) +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +IncludeMissingData +Setting this property to true will populate the data selector with valid and invalid result data. +Setting this property to false will populate the data selector with valid result data only. Changing +this property alone will have no effect, the refresh method must be called to re-populate the data +selector. (Read/Write boolean) +Index +The index of the selected item from the data selector. (Read/Write number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +SelectorType +The data selector type. (Read only FormDataSelectorType) +Type +Value +The object type string. (Read only string) +The selected data. (Read only ResultData) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +Refresh () +This method re-populates the data selector with the currently available result data. +SetCallBack (callback function) +Set the function that will be called when the data selector state changes. +Constructor Function List +New (label string, type FormDataSelectorType) +Create a specified data selector type. The selector will contain a list of result data available in the +model. (Returns a FormDataSelector object.) +New (type FormDataSelectorType) +Create a specified data selector type. The selector will contain a list of result data available in the +model. (Returns a FormDataSelector object.) +Property Details +Count +The number of data selector items. +Type +number +Access +Read only +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +IncludeMissingData +Setting this property to true will populate the data selector with valid and invalid result data. +Setting this property to false will populate the data selector with valid result data only. Changing +this property alone will have no effect, the refresh method must be called to re-populate the data +selector. +Type +boolean +Access +Read/Write +Index +The index of the selected item from the data selector. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +MinimumWidth +p.3246 +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +SelectorType +The data selector type. +Type +FormDataSelectorType +Access +Read only +Type +The object type string. +Value +Type +string +Access +Read only +The selected data. +Type +ResultData +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +Refresh () +This method re-populates the data selector with the currently available result data. +SetCallBack (callback function) +Set the function that will be called when the data selector state changes. +Input Parameters +callback(function) +The function call back. +Static Function Details +New (label string, type FormDataSelectorType) +Create a specified data selector type. The selector will contain a list of result data available in the +model. +Input Parameters +label(string) +The item label. +type(FormDataSelectorType) +The data selector type. +Return +FormDataSelector +The label item created. +New (type FormDataSelectorType) +Create a specified data selector type. The selector will contain a list of result data available in the +model. +Input Parameters +type(FormDataSelectorType) +The data selector type. +Return +FormDataSelector +The label item created. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormDirectoryBrowser +p.3248 +A directory browser item. When working with multiple files, it is often simplest to specify only the +directory where the files are located. When generating multiple files, it is also useful to specify where +the files should be stored. The directory browser is then a tool for navigating through the operating +system's directory structures to set an active directory of interest. +Example +form = pf.Form.New("Export data") +dirBrowser = pf.FormDirectoryBrowser.New("Output directory:") +form:Add(dirBrowser) + -- Run the form and retrieve the selection +form:Run() +selectedPath = dirBrowser.Value +Inheritance +The FormDirectoryBrowser object is derived from the FormLabelledItem object. +Usage locations +The FormDirectoryBrowser object can be accessed from the following locations: +• Static functions +◦ FormDirectoryBrowser object has static function New(string). +◦ FormDirectoryBrowser object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The directory path. (Read/Write string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Constructor Function List +New (label string) +Create a new directory browser item. (Returns a FormDirectoryBrowser object.) +New () +Create a new directory browser item. (Returns a FormDirectoryBrowser object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The directory path. +Type +string +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +FormLabel +The form label item. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +p.3252 +Input Parameters +callback(function) +The function call back. +Static Function Details +New (label string) +Create a new directory browser item. +Input Parameters +label(string) +The item label. +Return +FormDirectoryBrowser +The directory browser item created. +New () +Create a new directory browser item. +Return +FormDirectoryBrowser +The directory browser item created. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormDoubleSpinBox +p.3253 +A spin box item supporting doubles. Spin boxes are sometimes also referred to as numeric steppers +or spinners. Spin boxes are used to obtain a numerical value. Up and down arrows are provided to +increment or decrement the value respectively. Alternatively, the numerical value can be typed into the +input field. +Example +form = pf.Form.New("Generate views") + -- Create 'FormDoubleSpinBox' and adjust its initial settings +spinbox = pf.FormDoubleSpinBox.New("Frequency step between views:") +spinbox:SetMinimum(12.5) +spinbox:SetMaximum(250) +spinbox:SetSingleStep(12.5) +form:Add(spinbox) + -- Run the form and retrieve the user input +form:Run() +selectedFrequency = spinbox.Value +Inheritance +The FormDoubleSpinBox object is derived from the FormLabelledItem object. +Usage locations +The FormDoubleSpinBox object can be accessed from the following locations: +• Static functions +◦ FormDoubleSpinBox object has static function New(string). +◦ FormDoubleSpinBox object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The starting value of the spin box. (Read/Write number) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +SetDecimals (decimals number) +The precision of the spin box, in decimals. +SetMaximum (maximum number) +Set the maximum value of the spin box. +SetMinimum (minimum number) +Set the minimum value of the spin box. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetSingleStep (step number) +p.3255 +The single step size of the spin box item. When the user uses the arrows to change the spin box's +value the value will be incremented/decremented by the amount of the single step. The default +value is 1.0. Setting a step size value of less than 0 does nothing. +Constructor Function List +New (label string) +Create a new spin box item. (Returns a FormDoubleSpinBox object.) +New () +Create a new spin box item. (Returns a FormDoubleSpinBox object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +p.3256 +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The starting value of the spin box. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Visible +p.3257 +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Return +FormLabel +The form label item. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Input Parameters +callback(function) +The function call back. +SetDecimals (decimals number) +The precision of the spin box, in decimals. +Input Parameters +decimals(number) +The precision. +SetMaximum (maximum number) +Set the maximum value of the spin box. +Input Parameters +maximum(number) +The maximum value. +SetMinimum (minimum number) +Set the minimum value of the spin box. +Input Parameters +minimum(number) +The minimum value. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetSingleStep (step number) +p.3258 +The single step size of the spin box item. When the user uses the arrows to change the spin box's +value the value will be incremented/decremented by the amount of the single step. The default +value is 1.0. Setting a step size value of less than 0 does nothing. +Input Parameters +step(number) +The step size. +Static Function Details +New (label string) +Create a new spin box item. +Input Parameters +label(string) +The label next to the spin box describing the meaning of the value. +Return +FormDoubleSpinBox +The newly created spin box item. +New () +Create a new spin box item. +Return +FormDoubleSpinBox +The newly created spin box item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormFileBrowser +p.3259 +A file browser item. The file browser can be used to navigate an operating system's directory structure +to look for and select a file. +Example +form = pf.Form.New("Process model") + --- Create 'FormFileBrowser' and adjust its initial settings +fileBrowser = pf.FormFileBrowser.New("Model:") +fileBrowser:SetFilter("*.fek") +fileBrowser.MultiSelect = false +form:Add(fileBrowser) + -- Run the form and retrieve the user input +form:Run() +selectedPath = fileBrowser.Value +Inheritance +The FormFileBrowser object is derived from the FormLabelledItem object. +Usage locations +The FormFileBrowser object can be accessed from the following locations: +• Static functions +◦ FormFileBrowser object has static function New(string). +◦ FormFileBrowser object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +MultiSelect +Set multiple selection for file browsing. (Read/Write boolean) +Type +Value +The object type string. (Read only string) +The path of the file(s) separated by “;”. (Read/Write List of string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +Run () +Displays the file open dialog and places the resulting file selection into the Value property. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +SetFilter (filter string) +Sets a filter for the file types. It must be in the standard Qt form, i.e. File type name (*.ex1 +*.ex2);;Second type (*.*). +Altair Feko 2022.3 +2 Application Programming Interface (API) +Constructor Function List +New (label string) +Create a new file browser item. (Returns a FormFileBrowser object.) +New () +Create a new file browser item. (Returns a FormFileBrowser object.) +p.3261 +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +MultiSelect +Set multiple selection for file browsing. +Type +boolean +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The path of the file(s) separated by “;”. +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Visible +p.3263 +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Return +FormLabel +The form label item. +Run () +Displays the file open dialog and places the resulting file selection into the Value property. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Input Parameters +callback(function) +The function call back. +SetFilter (filter string) +Sets a filter for the file types. It must be in the standard Qt form, i.e. File type name (*.ex1 +*.ex2);;Second type (*.*). +Input Parameters +filter(string) +The file filter. +Static Function Details +New (label string) +Create a new file browser item. +Input Parameters +label(string) +The item label. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +FormFileBrowser +The file browser item created. +New () +Create a new file browser item. +Return +FormFileBrowser +The file browser item created. +p.3264 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormFileSaveAsBrowser +p.3265 +A file browser item. The file browser can be used to navigate an operating system's directory structure +to look for and select a file. +Example +app = pf.GetApplication() +project = app:NewProject() +form = pf.Form.New() + -- Create a 'FormFileSaveAsBrowser' form item +formFileSaveAsBrowser = pf.FormFileSaveAsBrowser.New("File name") + -- Add 'FormFileSaveAsBrowser' item to the form +form:Add(formFileSaveAsBrowser) + -- Show and run the form +form:Run() +Inheritance +The FormFileSaveAsBrowser object is derived from the FormLabelledItem object. +Usage locations +The FormFileSaveAsBrowser object can be accessed from the following locations: +• Static functions +◦ FormFileSaveAsBrowser object has static function New(string). +◦ FormFileSaveAsBrowser object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The path of the file. (Read/Write string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +Run () +Displays the file open dialog and places the resulting file selection into the Value property. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +SetFilter (filter string) +Sets a filter for the file types. It must be in the standard Qt form, i.e. File type name (*.ex1 +*.ex2);;Second type (*.*). +Constructor Function List +New (label string) +Create a new file save as browser item. (Returns a FormFileSaveAsBrowser object.) +New () +Create a new file save as browser item. (Returns a FormFileSaveAsBrowser object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The path of the file. +Type +string +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Return +FormLabel +The form label item. +Run () +Displays the file open dialog and places the resulting file selection into the Value property. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Input Parameters +callback(function) +The function call back. +SetFilter (filter string) +Sets a filter for the file types. It must be in the standard Qt form, i.e. File type name (*.ex1 +*.ex2);;Second type (*.*). +Input Parameters +filter(string) +The file filter. +Static Function Details +New (label string) +Create a new file save as browser item. +Input Parameters +label(string) +The item label. +Return +FormFileSaveAsBrowser +The file browser item created. +New () +Create a new file save as browser item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +FormFileSaveAsBrowser +The file browser item created. +p.3270 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormGroupBox +p.3271 +A group box is a type of frame that contains other items. Group boxes are often used to make logical +groupings of items and are therefore mainly design components. Functionally, group boxes make it +easier to hide or disable several items simultaneously by simply modifying the properties of the group +box container. +Example +form = pf.Form.New("Convert format") +inputFile = pf.FormFileBrowser.New("Input filename") +group = pf.FormGroupBox.New("Output options") +outputFile = pf.FormLineEdit.New("Output filename") +checkbox1 = pf.FormCheckBox.New("Export angles in degrees") + -- Add items into the 'FormGroupBox' layout +group:Add(outputFile) +group:Add(checkbox1) + -- Add the 'FormGroupBox' and other items into the top level 'Form' layout +form:Add(inputFile) +form:Add(group) +form:Run() +Inheritance +The FormGroupBox object is derived from the FormItem object. +Usage locations +The FormGroupBox object can be accessed from the following locations: +• Static functions +◦ FormGroupBox object has static function New(string, FormLayoutEnum). +◦ FormGroupBox object has static function New(string). +◦ FormGroupBox object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +Altair Feko 2022.3 +2 Application Programming Interface (API) +FixedWidth +p.3272 +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +The object type string. (Read only string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Collection List +FormItems +The collection of item widgets contained in the group box. (FormGroupBoxItemCollection of +FormItem.) +Method List +Add (item FormItem) +Adds the given item to the group box. Items can be any of the defined form item types. +Add (item FormItem, row number, column number) +Adds the given item to the group box at the specified position. Positions are defined as a row and +column, starting at (1,1). +Remove (item FormItem) +Removes the given item from the group box. The item can be any of the items that resides in the +collection of the form items contained in the group box. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Constructor Function List +New (label string, layout FormLayoutEnum) +p.3273 +Create a new group box item with a specified label and layout. (Returns a FormGroupBox object.) +New (label string) +Create a new group box item with a specified label and vertical layout. (Returns a FormGroupBox +object.) +New () +Create a new group box item with a vertical layout. (Returns a FormGroupBox object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +p.3274 +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Collection Details +FormItems +The collection of item widgets contained in the group box. +Type +FormGroupBoxItemCollection +Method Details +Add (item FormItem) +Adds the given item to the group box. Items can be any of the defined form item types. +Input Parameters +item(FormItem) +The item widget to add to the group. +Add (item FormItem, row number, column number) +Adds the given item to the group box at the specified position. Positions are defined as a row and +column, starting at (1,1). +Input Parameters +item(FormItem) +The form item to add to the group. +row(number) +The layout row position. +column(number) +The layout column position. +Remove (item FormItem) +Removes the given item from the group box. The item can be any of the items that resides in the +collection of the form items contained in the group box. +Input Parameters +item(FormItem) +The form item to remove from the group. +Static Function Details +New (label string, layout FormLayoutEnum) +Create a new group box item with a specified label and layout. +Input Parameters +label(string) +The item label. +layout(FormLayoutEnum) +A value indicating how new items will be arranged. +Return +FormGroupBox +The newly created group box item. +New (label string) +Create a new group box item with a specified label and vertical layout. +Input Parameters +label(string) +The item label. +Return +FormGroupBox +The newly created group box item. +New () +Create a new group box item with a vertical layout. +Return +FormGroupBox +The newly created group box item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormImage +p.3277 +An image item. Images can be added to any form or group box. Supported formats include PNG, BMP +and JPG/JPEG files. +Example +form = pf.Form.New() +item1 = pf.FormLabel.New("Coordinate system:") +form:Add(item1); + -- Load an image from file and add it to the form +image = pf.FormImage.New(FEKO_HOME..[[/shared/Resources/Automation/axisar.png]]) +form:Add(image) +form:Run() +Inheritance +The FormImage object is derived from the FormItem object. +Usage locations +The FormImage object can be accessed from the following locations: +• Static functions +��� FormImage object has static function New(string). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +Height +Height of the image in pixels. (Read only number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The path location of source file that will be used for the image. (Read/Write string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Width +Width of the image in pixels. (Read only number) +Method List +ResetSize () +Reset the width/height to the image's default. +SetSize (width number, height number) +Set the width and height of the image in pixels. Ensure that width and height are larger than zero. +Constructor Function List +New (path string) +Create a new image. (Returns a FormImage object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +Height +Height of the image in pixels. +Type +number +Access +Read only +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +MinimumHeight +p.3280 +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The path location of source file that will be used for the image. +Type +string +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Width +Width of the image in pixels. +Type +number +Access +Read only +Method Details +ResetSize () +Reset the width/height to the image's default. +SetSize (width number, height number) +Set the width and height of the image in pixels. Ensure that width and height are larger than zero. +Input Parameters +width(number) +Width of the image in pixels. +height(number) +Height of the image in pixels. +Static Function Details +New (path string) +Create a new image. +Input Parameters +path(string) +The file path of the source image. +Return +FormImage +The newly created image item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormIntegerSpinBox +p.3282 +A spin box item. Spin boxes are sometimes also referred to as numeric steppers or spinners. Spin boxes +can be used to obtain an integer value. Up and down arrows are provided to increment or decrement +the value respectively. Alternatively, the numerical value can be typed into the input field. +Example +form = pf.Form.New("Re-sample data") + -- Create 'FormIntegerSpinBox' and adjust its initial settings +spinbox = pf.FormIntegerSpinBox.New("Number of samples:") +spinbox:SetMinimum(3) +spinbox:SetMaximum(101) +form:Add(spinbox) + -- Run the form and retrieve the user input +form:Run() +numberOfSamplesSelected = spinbox.Value +Inheritance +The FormIntegerSpinBox object is derived from the FormLabelledItem object. +Usage locations +The FormIntegerSpinBox object can be accessed from the following locations: +• Static functions +◦ FormIntegerSpinBox object has static function New(string). +◦ FormIntegerSpinBox object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The starting value of the spin box. (Read/Write number) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +SetMaximum (maximum number) +Set the maximum value of the spin box. +SetMinimum (minimum number) +Set the minimum value of the spin box. +SetSingleStep (step number) +The single step size of the spin box item. When the user uses the arrows to change the spin box's +value the value will be incremented/decremented by the amount of the single step. The default +value is 1. Setting a step size value of less than 0 does nothing. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Constructor Function List +New (label string) +Create a new spin box item. (Returns a FormIntegerSpinBox object.) +New () +Create a new spin box item. (Returns a FormIntegerSpinBox object.) +p.3284 +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The starting value of the spin box. +Type +number +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Return +FormLabel +The form label item. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Input Parameters +callback(function) +The function call back. +SetMaximum (maximum number) +Set the maximum value of the spin box. +Input Parameters +maximum(number) +The maximum value. +SetMinimum (minimum number) +Set the minimum value of the spin box. +Input Parameters +minimum(number) +The minimum value. +SetSingleStep (step number) +The single step size of the spin box item. When the user uses the arrows to change the spin box's +value the value will be incremented/decremented by the amount of the single step. The default +value is 1. Setting a step size value of less than 0 does nothing. +Input Parameters +step(number) +The step size. +Static Function Details +New (label string) +Create a new spin box item. +Input Parameters +label(string) +The label next to the spin box describing the meaning of the value. +Return +FormIntegerSpinBox +The newly created spin box item. +New () +Create a new spin box item. +Return +FormIntegerSpinBox +The newly created spin box item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormItem +p.3288 +The structure of all form items. All form items share a set of common properties that are listed here. +Example +form = pf.Form.New() + -- Create a variety of form items +checkbox = pf.FormCheckBox.New("Export electric near fields.") +label = pf.FormLabel.New("Item 1") +dirBrowser = pf.FormDirectoryBrowser.New("Output directory:") +form:Add(checkbox) +form:Add(label) +form:Add(dirBrowser) + -- All form items share the Enabled and Visible properties +checkbox.Enabled = false +label.Enabled = false +dirBrowser.Visible = false +form:Run() +Inheritance +The following objects are derived (specialisations) from the FormItem object: +• FormCheckBox +• FormConfigurationSelector +• FormDataSelector +• FormGroupBox +• FormImage +• FormLabel +• FormLabelledItem +• FormLayout +• FormModelSelector +• FormPushButton +• FormRadioButtonGroup +• FormScrollArea +• FormSeparator +• FormTree +Usage locations +The FormItem object can be accessed from the following locations: +• Methods +◦ FormScrollAreaItemCollection collection has method Items(). +◦ FormScrollAreaItemCollection collection has method Item(number). +◦ FormScrollAreaItemCollection collection has method Item(string). +◦ FormLayoutItemCollection collection has method Items(). +◦ FormLayoutItemCollection collection has method Item(number). +◦ FormLayoutItemCollection collection has method Item(string). +◦ FormGroupBoxItemCollection collection has method Items(). +◦ FormGroupBoxItemCollection collection has method Item(number). +◦ FormGroupBoxItemCollection collection has method Item(string). +◦ FormItemCollection collection has method Items(). +◦ FormItemCollection collection has method Item(number). +◦ FormItemCollection collection has method Item(string). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormLabel +p.3292 +A label item or a simple string of text. Labels are typically used to explain the contents of a form. Note +that most form items already have a built-in label associated with it. +Example +form = pf.Form.New("Dialog with label") +label = pf.FormLabel.New("Hello world!") +form:Add(label) +form:Run() +Inheritance +The FormLabel object is derived from the FormItem object. +Usage locations +The FormLabel object can be accessed from the following locations: +• Methods +◦ FormDirectoryBrowser object has method LabelItem(). +◦ FormFileSaveAsBrowser object has method LabelItem(). +◦ FormFileBrowser object has method LabelItem(). +◦ FormComboBox object has method LabelItem(). +◦ FormDoubleSpinBox object has method LabelItem(). +◦ FormIntegerSpinBox object has method LabelItem(). +◦ FormLineEdit object has method LabelItem(). +◦ FormLabelledItem object has method LabelItem(). +• Static functions +◦ FormLabel object has static function New(string). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The text that should be displayed in the label. (Read/Write string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Constructor Function List +New (label string) +Create a new label item. (Returns a FormLabel object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The text that should be displayed in the label. +Type +string +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Static Function Details +New (label string) +Create a new label item. +Input Parameters +label(string) +The text that should be displayed. +Return +FormLabel +The newly created label item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormLabelledItem +Allows access to built-in label objects associated with the derived form item. +p.3296 +Example +app = pf.GetApplication() +project = app:NewProject() +form = pf.Form.New() + -- Create a form item that are derived from 'FormLabelItem' +formFileSaveAsBrowser = pf.FormFileSaveAsBrowser.New("File name") + -- Add item to the form +form:Add(formFileSaveAsBrowser) + -- Obtain the 'FormLabelledItem' +formLabelledItem = formFileSaveAsBrowser:LabelItem() + -- Set the label invisible +formLabelledItem.Visible = false +form:Run() +Inheritance +The FormLabelledItem object is derived from the FormItem object. +The following objects are derived (specialisations) from the FormLabelledItem object: +• FormComboBox +• FormDirectoryBrowser +• FormDoubleSpinBox +• FormFileBrowser +• FormFileSaveAsBrowser +• FormIntegerSpinBox +• FormLineEdit +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Return +FormLabel +The form label item. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Input Parameters +callback(function) +The function call back. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormLayout +p.3300 +A layout is a type of frame that contains other items. Layouts are often used to make logical groupings +of items and are therefore mainly design components. Functionally, layouts make it easier to hide or +disable several items simultaneously by simply modifying the properties of the layout. +Example +app = pf.GetApplication() +project = app:NewProject() +form = pf.Form.New() + -- Create a few form items +checkbox = pf.FormCheckBox.New("Include currents.") +lineEdit = pf.FormLineEdit.New("Frequency:") + -- Create a 'FormLayout' item +formLayout = pf.FormLayout.New(pf.Enums.FormLayoutEnum.Horizontal) + -- Add items to the layout +formLayout:Add(checkbox) +formLayout:Add(lineEdit) + -- Add the layout to the form +form:Add(formLayout) +form:Run() +Inheritance +The FormLayout object is derived from the FormItem object. +Usage locations +The FormLayout object can be accessed from the following locations: +• Static functions +◦ FormLayout object has static function New(FormLayoutEnum). +◦ FormLayout object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +The object type string. (Read only string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Collection List +FormItems +The collection of item widgets contained in the layout. (FormLayoutItemCollection of FormItem.) +Method List +Add (item FormItem) +Adds the given item to the layout. Items can be any of the defined form item types. +Add (item FormItem, row number, column number) +Adds the given item to the layout at the specified position. Positions are defined as a row and +column, starting at (1,1). +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (item FormItem) +p.3302 +Removes the given item from the layout. The item can be any of the items that resides in the +collection of the form items contained in the layout. +Constructor Function List +New (layout FormLayoutEnum) +Create a new layout item with a specified item arrangement. (Returns a FormLayout object.) +New () +Create a new layout item with a vertical item arrangement. (Returns a FormLayout object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +p.3303 +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Collection Details +FormItems +The collection of item widgets contained in the layout. +Type +FormLayoutItemCollection +Method Details +Add (item FormItem) +Adds the given item to the layout. Items can be any of the defined form item types. +Input Parameters +item(FormItem) +The item widget to add to the layout. +Add (item FormItem, row number, column number) +Adds the given item to the layout at the specified position. Positions are defined as a row and +column, starting at (1,1). +Input Parameters +item(FormItem) +The form item to add to the layout. +row(number) +The layout row position. +column(number) +The layout column position. +Remove (item FormItem) +Removes the given item from the layout. The item can be any of the items that resides in the +collection of the form items contained in the layout. +Input Parameters +item(FormItem) +The form item to remove from the layout. +Static Function Details +New (layout FormLayoutEnum) +Create a new layout item with a specified item arrangement. +Input Parameters +layout(FormLayoutEnum) +A value indicating how new items will be arranged. +Return +FormLayout +The newly created layout item. +New () +Create a new layout item with a vertical item arrangement. +Return +FormLayout +The newly created layout item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormLineEdit +p.3306 +A line edit item; also known as a text box or text field. A line edit is used to obtain text-based input +from a user. +Example +form = pf.Form.New("My Custom Dialog") + -- Create line edit and initialise default contents if desired +lineEdit = pf.FormLineEdit.New("Project name") +lineEdit.Value = "Default name" +form:Add(lineEdit) + -- Run the form and retrieve the user input +form:Run() +userTypedInput = lineEdit.Value +Inheritance +The FormLineEdit object is derived from the FormLabelledItem object. +Usage locations +The FormLineEdit object can be accessed from the following locations: +• Static functions +◦ FormLineEdit object has static function New(string). +◦ FormLineEdit object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The default text that will be contained in the line edit when the form is run. (Read/Write string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. (Returns a FormLabel object.) +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Constructor Function List +New (label string) +Create a new line edit item. (Returns a FormLineEdit object.) +New () +Create a new line edit item. (Returns a FormLineEdit object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +MinimumHeight +p.3309 +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The default text that will be contained in the line edit when the form is run. +Type +string +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +LabelItem () +Returns the built-in label object associated with the form item. This allows access to the label like +a normal form label. +Return +FormLabel +The form label item. +SetCallBack (callback function) +Set the function that will be called when the item's action has triggered. +Input Parameters +callback(function) +The function call back. +Static Function Details +New (label string) +Create a new line edit item. +Input Parameters +label(string) +A label describing the purpose and/or contents of a line edit. +Return +FormLineEdit +The newly created line edit item. +New () +Create a new line edit item. +Return +FormLineEdit +The newly created line edit item. +FormModelSelector +Selects a Feko model. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Create a form with a model selector +form = pf.Form.New("Generate antenna report") +modelSelector = pf.FormModelSelector.New("Choose antenna model") +form:Add(modelSelector) + -- Run the form and retrieve the user input +form:Run() +model = modelSelector.Value +Inheritance +The FormModelSelector object is derived from the FormItem object. +Usage locations +The FormModelSelector object can be accessed from the following locations: +• Static functions +◦ FormModelSelector object has static function New(string). +◦ FormModelSelector object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +Index +The index of the selected model. (Read only number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +Value +The object type string. (Read only string) +The selected model. (Read only Model) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Constructor Function List +New (label string) +Create a model selector. The selector will contain a list of Feko models available in the application. +(Returns a FormModelSelector object.) +New () +Create a model selector. The selector will contain a list of Feko models available in the application. +(Returns a FormModelSelector object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +Index +The index of the selected model. +Type +number +Access +Read only +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +MinimumHeight +p.3314 +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The selected model. +Type +Model +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Static Function Details +New (label string) +p.3315 +Create a model selector. The selector will contain a list of Feko models available in the application. +Input Parameters +label(string) +The item label. +Return +FormModelSelector +The label item created. +New () +Create a model selector. The selector will contain a list of Feko models available in the application. +Return +FormModelSelector +The label item created. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormProgressDialog +p.3316 +A progress dialog provides feedback for actions that take a long time to execute.When the progress +value reaches 100 the dialog automatically closes. +Example +app = pf.GetApplication() +project = app:NewProject() +form = pf.Form.New() + -- Create a 'FormProgressDialog' item +formProgressDialog = pf.FormProgressDialog.New("Loop example","Progress") + -- Log the progress while work is done +for i = 1, 100 do + for j = 1, 1000 do + -- Do some interesting calculations or work + end + -- formProgressDialog:LogProgress(i) +end +Usage locations +The FormProgressDialog object can be accessed from the following locations: +• Static functions +◦ FormProgressDialog object has static function New(string, string). +◦ FormProgressDialog object has static function New(). +Property List +Cancelled +This property is true if the cancel button was pressed, else it remains false.It is reset when the +Reset method is called. (Read only boolean) +Height +The height in pixels of the form window. (Read only number) +Label +Title +Type +Value +The label of the progress dialog. (Read/Write string) +The title that will be displayed in the title bar at the top of the form. (Read/Write string) +The object type string. (Read only string) +The progress bar's current progress value from 0 to 100. (Read only number) +Width +The width in pixels of the form window. (Read only number) +Method List +LogProgress (progress number) +This method shows the progress dialog form and updates the progress value. Pressing the Cancel +button will close the form. +LogProgress (progress number, label string) +This method shows the progress dialog form and updates the progress value and caption. +Pressing the Cancel button will close the form. +Reset () +Resets the progress dialog. This sets the progress value back to zero, resets the cancelled status +and hides the dialog.The label of the dialog remains unchanged. +SetSize (width number, height number) +Set the width and height of the form in pixels. The width and height must be larger than zero and +they cannot exceed the current screen resolution. If the size is set the dialog will no longer auto- +resize. +Constructor Function List +New (title string, label string) +Creates a new progress dialog form with a specified label. (Returns a FormProgressDialog object.) +New () +Creates a new progress dialog form. (Returns a FormProgressDialog object.) +Property Details +Cancelled +This property is true if the cancel button was pressed, else it remains false.It is reset when the +Reset method is called. +Type +boolean +Access +Read only +Height +The height in pixels of the form window. +Type +number +Access +Read only +Label +The label of the progress dialog. +Type +string +Access +Read/Write +Title +The title that will be displayed in the title bar at the top of the form. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +The progress bar's current progress value from 0 to 100. +Type +number +Access +Read only +Value +Width +The width in pixels of the form window. +Type +number +Access +Read only +Method Details +LogProgress (progress number) +This method shows the progress dialog form and updates the progress value. Pressing the Cancel +button will close the form. +Input Parameters +progress(number) +Updates the progress value of the progress bar on the dialog. Progress is only valid +from 0 to 100. If values outside this range are given an error will be thrown. +LogProgress (progress number, label string) +This method shows the progress dialog form and updates the progress value and caption. +Pressing the Cancel button will close the form. +Input Parameters +progress(number) +Updates the progress value of the progress bar on the dialog. Progress is only valid +from 0 to 100. If values outside this range are given an error will be thrown. +label(string) +Updates the label of the progress dialog. +Reset () +Resets the progress dialog. This sets the progress value back to zero, resets the cancelled status +and hides the dialog.The label of the dialog remains unchanged. +SetSize (width number, height number) +Set the width and height of the form in pixels. The width and height must be larger than zero and +they cannot exceed the current screen resolution. If the size is set the dialog will no longer auto- +resize. +Input Parameters +width(number) +Width of the form in pixels. +height(number) +Height of the form in pixels. +Static Function Details +New (title string, label string) +Creates a new progress dialog form with a specified label. +Input Parameters +title(string) +The form window title. +label(string) +The form label. +Return +FormProgressDialog +The newly created progress dialog form. +New () +Creates a new progress dialog form. +Return +FormProgressDialog +The newly created progress dialog form. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormPushButton +p.3320 +A push button item. Push button are used to trigger a function/call back that is associated with the +button. +Example +app = pf.GetApplication() +project = app:NewProject() + -- Call back function for the button on the form. +function exampleCallBack() + print("Hello!") +end +form = pf.Form.New() + -- Create a 'FormPushButton' form item +formPushButton = pf.FormPushButton.New(exampleCallBack,"Hello") + -- Add button to the form +form:Add(formPushButton) + -- Show and run the form +form:Run() +Inheritance +The FormPushButton object is derived from the FormItem object. +Usage locations +The FormPushButton object can be accessed from the following locations: +• Properties +◦ FormButtons object has property OK. +◦ FormButtons object has property Cancel. +• Static functions +◦ FormPushButton object has static function New(function, string, string). +◦ FormPushButton object has static function New(function, string). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +IconPath +The icon of the push button. (Read/Write string) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +Label +The label of the push button. (Read/Write string) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +The object type string. (Read only string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the button is pressed. +SetCallBack (callback function) +Set the function that will be called when the button is pressed. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Constructor Function List +New (callBack function, label string, path string) +p.3322 +Create a new push button item with an icon. (Returns a FormPushButton object.) +New (callBack function, label string) +Create a new push button item. (Returns a FormPushButton object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +IconPath +The icon of the push button. +Type +string +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +Label +The label of the push button. +Type +string +Access +Read/Write +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the button is pressed. +SetCallBack (callback function) +Set the function that will be called when the button is pressed. +Input Parameters +callback(function) +The function call back. +Static Function Details +New (callBack function, label string, path string) +Create a new push button item with an icon. +Input Parameters +callBack(function) +The function call back. +label(string) +The item label. +path(string) +The file path of the icon image. +Return +FormPushButton +The newly created push button item. +New (callBack function, label string) +Create a new push button item. +Input Parameters +callBack(function) +The function call back. +label(string) +The item label. +Return +FormPushButton +The newly created push button item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormRadioButtonGroup +p.3326 +A radio button group item. Radio button groups are used when precisely one option out of a set of +options can be selected. +Example +form = pf.Form.New("Export settings") + -- Prepare input parameter and radio button group +options = {} +table.insert(options, "Only electric near fields") +table.insert(options, "Only magnetic near fields") +table.insert(options, "Both electric and magnetic near fields") +radioButtonGroup = pf.FormRadioButtonGroup.New("Results to export:", options) +form:Add(radioButtonGroup) + -- Run the form and retrieve the user input +form:Run() +selectedOptionIndexNumber = radioButtonGroup.Value +Inheritance +The FormRadioButtonGroup object is derived from the FormItem object. +Usage locations +The FormRadioButtonGroup object can be accessed from the following locations: +• Static functions +◦ FormRadioButtonGroup object has static function New(string, Map of number:Expression). +◦ FormRadioButtonGroup object has static function New(Map of number:Expression). +Property List +Count +The number of radio buttons. (Read only number) +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Options +The options available in the radio group. (Read/Write Map of number:Expression) +Type +Value +The object type string. (Read only string) +The index of the selected radio button item in the index map table. (Read/Write number) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +ClearCallBack () +Clear the function that will be called when the check box state changes. +SetCallBack (callback function) +Set the function that will be called when a radiobutton is pressed. +Constructor Function List +New (label string, map Map of number:Expression) +Create a new radio button group item. (Returns a FormRadioButtonGroup object.) +New (map Map of number:Expression) +Create a new radio button group item. (Returns a FormRadioButtonGroup object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property Details +Count +The number of radio buttons. +Type +number +Access +Read only +Enabled +p.3328 +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +p.3329 +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Options +The options available in the radio group. +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Value +The index of the selected radio button item in the index map table. +Type +number +Access +Read/Write +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +ClearCallBack () +Clear the function that will be called when the check box state changes. +SetCallBack (callback function) +Set the function that will be called when a radiobutton is pressed. +Input Parameters +callback(function) +The function call back. +Static Function Details +New (label string, map Map of number:Expression) +Create a new radio button group item. +Input Parameters +label(string) +The item label. +map(Map of number:Expression) +A list of values that will be available for selection in the button group. The index map +is a Lua table containing an array of indexed values. +Return +FormRadioButtonGroup +The newly created radio button group item. +New (map Map of number:Expression) +Create a new radio button group item. +Input Parameters +map(Map of number:Expression) +A list of values that will be available for selection in the button group. The index map +is a Lua table containing an array of indexed values. +Return +FormRadioButtonGroup +The newly created radio button group item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormScrollArea +p.3332 +A scroll area is a type of frame that contains a scrolling view of other items. Scroll areas are often used +to make logical groupings of items where many items need to be displayed. +Example +app = pf.GetApplication() +project = app:NewProject() +form = pf.Form.New() + -- Create a 'FormScrollArea' form item +formScrollArea = pf.FormScrollArea.New() + -- Create a few form items +formScrollArea:Add(pf.FormLabel.New("A lot of text.")) +formScrollArea:Add(pf.FormLabel.New("even more text")) +formScrollArea:Add(pf.FormLabel.New("... more text")) +formScrollArea:Add(pf.FormLabel.New("... more text")) +formScrollArea:Add(pf.FormLabel.New("... more text")) +formScrollArea:Add(pf.FormLabel.New("lost more text")) + -- Add scroll area item to the form +form:Add(formScrollArea) + -- Show and run the form +form:Run() +Inheritance +The FormScrollArea object is derived from the FormItem object. +Usage locations +The FormScrollArea object can be accessed from the following locations: +• Static functions +◦ FormScrollArea object has static function New(FormLayoutEnum). +◦ FormScrollArea object has static function New(). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +The object type string. (Read only string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Collection List +FormItems +The collection of item widgets contained in the scroll area. (FormScrollAreaItemCollection of +FormItem.) +Method List +Add (item FormItem) +Adds the given item to the scroll area. Items can be any of the defined form item types. +Add (item FormItem, row number, column number) +Adds the given item to the scroll area at the specified position. Positions are defined as a row and +column, starting at (1,1). +Altair Feko 2022.3 +2 Application Programming Interface (API) +Remove (item FormItem) +p.3334 +Removes the given item from the scroll area. The item can be any of the items that resides in the +collection of the form items contained in the scroll area. +Constructor Function List +New (layout FormLayoutEnum) +Create a new scroll area item with a specified layout. (Returns a FormScrollArea object.) +New () +Create a new scroll area item with a vertical layout. (Returns a FormScrollArea object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +p.3335 +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Collection Details +FormItems +The collection of item widgets contained in the scroll area. +Type +FormScrollAreaItemCollection +Method Details +Add (item FormItem) +Adds the given item to the scroll area. Items can be any of the defined form item types. +Input Parameters +item(FormItem) +The item widget to add to the scroll area. +Add (item FormItem, row number, column number) +Adds the given item to the scroll area at the specified position. Positions are defined as a row and +column, starting at (1,1). +Input Parameters +item(FormItem) +The form item to add to the scroll area. +row(number) +The layout row position. +column(number) +The layout column position. +Remove (item FormItem) +Removes the given item from the scroll area. The item can be any of the items that resides in the +collection of the form items contained in the scroll area. +Input Parameters +item(FormItem) +The form item to remove from the scroll area. +Static Function Details +New (layout FormLayoutEnum) +Create a new scroll area item with a specified layout. +Input Parameters +layout(FormLayoutEnum) +A value indicating how new items will be arranged. +Return +FormScrollArea +The newly created scroll area item. +New () +Create a new scroll area item with a vertical layout. +Return +FormScrollArea +The newly created scroll area item. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormSeparator +p.3338 +A Separator item. Separators are used to visually group (or separate) items on a form. Both horizontal +and vertical separators are available. +Example +form = pf.Form.New() +checkbox1 = pf.FormCheckBox.New("Check box 1.") +checkbox2 = pf.FormCheckBox.New("Check box 2.") +checkbox3 = pf.FormCheckBox.New("Check box 3.") +checkbox4 = pf.FormCheckBox.New("Check box 4.") +checkbox5 = pf.FormCheckBox.New("Check box 5.") + -- Create separators initialised to horizontal +horizontalSeparator1 = pf.FormSeparator.New(pf.Enums.FormSeparatorEnum.Horizontal) +horizontalSeparator2 = pf.FormSeparator.New(pf.Enums.FormSeparatorEnum.Horizontal) + -- Add items to form layout +form:Add(checkbox1) +form:Add(horizontalSeparator1) +form:Add(checkbox2) +form:Add(checkbox3) +form:Add(horizontalSeparator2) +form:Add(checkbox4) +form:Add(checkbox5) +form:Run() +Inheritance +The FormSeparator object is derived from the FormItem object. +Usage locations +The FormSeparator object can be accessed from the following locations: +• Static functions +◦ FormSeparator object has static function New(FormSeparatorEnum). +Property List +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +The object type string. (Read only string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Constructor Function List +New (orientation FormSeparatorEnum) +Create a new separator item. (Returns a FormSeparator object.) +Property Details +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FixedHeight +p.3340 +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +MinimumWidth +p.3341 +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Static Function Details +New (orientation FormSeparatorEnum) +Create a new separator item. +Input Parameters +orientation(FormSeparatorEnum) +The separator orientation which is either Horizontal or Vertical. +Return +FormSeparator +The newly created Separator item. +FormTree +A tree. +Example +form = pf.Form.New("Tree structure") + -- Prepare input parameter and tree items +treeWidget = pf.FormTree.New("Tree") +treeItem1 = pf.FormTreeItem.New("A", FEKO_HOME..[[/shared/Resources/Automation/ +axisar.png]]) +treeItem1:AddChild(pf.FormTreeItem.New("A1")) +treeWidget:AddChild(treeItem1) +treeItem2 = pf.FormTreeItem.New("B") +treeWidget:AddChild(treeItem2) + -- Expands the tree item +treeItem1.Expanded = true + -- Call back function for item selection in the tree. +function exampleCallBack() + local path = tostring(treeWidget.CurrentSelectedItem) + parentItem = treeWidget.CurrentSelectedItem.Parent + while ( parentItem ) do + path = tostring(parentItem) .. "." .. path + parentItem = parentItem.Parent + end + print(path) +end +treeWidget:SetCallBack(exampleCallBack) +form:Add(treeWidget) + -- Run the form and retrieve the user input +form:Run() +Inheritance +The FormTree object is derived from the FormItem object. +Usage locations +The FormTree object can be accessed from the following locations: +• Static functions +◦ FormTree object has static function New(). +◦ FormTree object has static function New(string). +Property List +CurrentSelectedItem +The current selected tree item. (Read/Write FormTreeItem) +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. (Read/Write boolean) +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +(Read/Write number) +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write +number) +ItemHeight +The height of the item in pixels. (Read only number) +ItemWidth +The width of the item in pixels. (Read only number) +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero +or a negative value will restore the default/auto setting where no minimum height is enforced. +(Read/Write number) +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. (Read/ +Write number) +Type +The object type string. (Read only string) +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. (Read/Write boolean) +Method List +AddChild (item FormTreeItem) +Adds the given FormTreeItem as a child. +ClearCallBack () +Clear the function that will be called when the tree selection changes. +SetCallBack (callback function) +Set the function that will be called when a tree item is selected. +Constructor Function List +New () +Create a new tree. (Returns a FormTree object.) +New (label string) +Create a new tree. (Returns a FormTree object.) +Property Details +CurrentSelectedItem +The current selected tree item. +Type +FormTreeItem +Access +Read/Write +Enabled +Controls the item enabled state. Setting the enabled state of an item to false will also disable +items or their contents. +Type +boolean +Access +Read/Write +FixedHeight +The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the +height of the item. Setting the fixed height to zero or a negative value will restore the default/ +auto setting and the height will be dynamically determined. The fixed height takes precedence +over the minimum height and thus the minimum height is ignored when a fixed height is set. +Type +number +Access +Read/Write +FixedWidth +The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the +width of the item. Setting the fixed width to zero or a negative value will restore the default/auto +setting and the width will be dynamically determined. The fixed width takes precedence over the +minimum width and thus the minimum width is ignored when a fixed width is set. +Type +number +Access +Read/Write +ItemHeight +The height of the item in pixels. +Type +number +Access +Read only +ItemWidth +The width of the item in pixels. +Type +number +Access +Read only +MinimumHeight +The minimum height of the item in pixels. When the height is dynamically determined, it will not +be less than the minimum height setting. The minimum height value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or +a negative value will restore the default/auto setting where no minimum height is enforced. +Type +number +Access +Read/Write +MinimumWidth +The minimum width of the item in pixels. When the width is dynamically determined, it will not +be less than the minimum width setting. The minimum width value will only be used when the +FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or +a negative value will restore the default/auto setting where no minimum width is enforced. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Visible +Controls the item visibility. Setting the visibility of an item to false will also hide items or their +contents. +Type +boolean +Access +Read/Write +Method Details +AddChild (item FormTreeItem) +Adds the given FormTreeItem as a child. +Input Parameters +item(FormTreeItem) +The child item. +ClearCallBack () +Clear the function that will be called when the tree selection changes. +SetCallBack (callback function) +Set the function that will be called when a tree item is selected. +Input Parameters +callback(function) +The function call back. +Static Function Details +New () +Create a new tree. +Return +FormTree +The newly created tree. +New (label string) +Create a new tree. +Input Parameters +label(string) +The tree column header. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +FormTree +The newly created tree. +p.3347 +FormTreeItem +A tree item. +Example +form = pf.Form.New("Tree structure") + -- Prepare input parameter and tree items +treeWidget = pf.FormTree.New("Tree") +treeItem1 = pf.FormTreeItem.New("A", FEKO_HOME..[[/shared/Resources/Automation/ +axisar.png]]) +treeItem1:AddChild(pf.FormTreeItem.New("A1")) +treeWidget:AddChild(treeItem1) +treeItem2 = pf.FormTreeItem.New("B") +treeWidget:AddChild(treeItem2) + -- Expands the tree item +treeItem1.Expanded = true + -- Call back function for item selection in the tree. +function exampleCallBack() + local path = tostring(treeWidget.CurrentSelectedItem) + parentItem = treeWidget.CurrentSelectedItem.Parent + while ( parentItem ) do + path = tostring(parentItem) .. "." .. path + parentItem = parentItem.Parent + end + print(path) +end +treeWidget:SetCallBack(exampleCallBack) +form:Add(treeWidget) + -- Run the form and retrieve the user input +form:Run() +Usage locations +The FormTreeItem object can be accessed from the following locations: +• Properties +◦ FormTree object has property CurrentSelectedItem. +◦ FormTreeItem object has property Parent. +• Static functions +◦ FormTreeItem object has static function New(string, string). +◦ FormTreeItem object has static function New(string). +Property List +Expanded +Controls the tree item's expanded state. Setting it expand/collapse only the item. (Read/Write +boolean) +Parent +The tree item parent. (Read only FormTreeItem) +Type +The object type string. (Read only string) +Method List +AddChild (item FormTreeItem) +Adds the given FormTreeItem as a child. +Constructor Function List +New (label string, path string) +Create a new tree item with an icon. (Returns a FormTreeItem object.) +New (label string) +Create a new tree item. (Returns a FormTreeItem object.) +Property Details +Expanded +Controls the tree item's expanded state. Setting it expand/collapse only the item. +Type +boolean +Access +Read/Write +Parent +The tree item parent. +Type +FormTreeItem +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +AddChild (item FormTreeItem) +Adds the given FormTreeItem as a child. +Input Parameters +item(FormTreeItem) +The child item. +Static Function Details +New (label string, path string) +Create a new tree item with an icon. +Input Parameters +label(string) +The tree item label. +path(string) +The file path of the icon image. +Return +FormTreeItem +The newly created tree item. +New (label string) +Create a new tree item. +Input Parameters +label(string) +The tree item label. +Return +FormTreeItem +The newly created tree item. +FrameFormat +The frame format property. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianGraphs:Add() + -- Edit title 'FrameFormat' colour property +graph.Title.Frame.BackColour = pf.Enums.ColourEnum.Grey +Usage locations +The FrameFormat object can be accessed from the following locations: +• Properties +◦ TextBox object has property Frame. +◦ GraphLegend object has property Frame. +◦ GraphAxisTitle object has property Frame. +Property List +BackColour +The background colour. (Read/Write Colour) +Line +The line style for text item frame. (Read only GraphLineFormat) +Shadow +The frame shadow format properties. (Read only ShadowFormat) +Property Details +BackColour +The background colour. +Type +Colour +Access +Read/Write +Line +The line style for text item frame. +Type +GraphLineFormat +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +Shadow +The frame shadow format properties. +Type +ShadowFormat +Access +Read only +p.3352 +Graph +A 2D graph where results can be plotted. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Add a Cartesian graph and a trace +graph = app.CartesianGraphs:Add() +excitation = app.Models["startup"].Configurations[1].Excitations[1] +excitationTrace = graph.Traces:Add(excitation) + -- Change properties of the graph +graph.BackColour = pf.Enums.ColourEnum.LightGrey +graph.Grid.Minor.Visible = true +graph.Grid.Border.Weight = 2 +Inheritance +The Graph object is derived from the Window object. +The following objects are derived (specialisations) from the Graph object: +• CartesianGraph +• PolarGraph +• SmithChart +Usage locations +The Graph object can be accessed from the following locations: +• Methods +◦ SmithChart object has method Duplicate(). +◦ PolarGraph object has method Duplicate(). +◦ CartesianGraph object has method Duplicate(). +◦ Graph object has method Duplicate(). +Property List +BackColour +The background colour of the graph. (Read/Write Colour) +Footer +The graph footer properties. (Read only TextBox) +GreyscaleEnabled +Set the graph's colour scheme to greyscale. (Read/Write boolean) +Height +The height of the window. (Read only number) +Legend +The graph legend properties. (Read only GraphLegend) +Title +Width +The graph title properties. (Read only TextBox) +The width of the window. (Read only number) +WindowActive +True if this window is the active window. (Read only boolean) +WindowTitle +The title of the window. (Read/Write string) +XPosition +The X position of the window. (Read only number) +YPosition +The Y position of the window. (Read only number) +Collection List +Annotations +The collection of 2D annotations on the graph. (ResultAnnotationCollection of GraphAnnotation.) +Arrows +The collection of 2D arrows on the graph. (ResultArrowCollection of ResultArrow.) +Shapes +The collection of 2D shapes on the graph. (ResultTextBoxCollection of ResultTextBox.) +Traces +The collection of 2D traces on the graph. (ResultTraceCollection of ResultTrace.) +Method List +AddChartImage (view View, posX number, posY number) +Add a 3D view image to this 2D Graph. +AddChartImageFromFile (file string, posX number, posY number) +Add an image file to this 2D Graph. +BlockGraphRedraws () +Disables graph redraws for performance purposes. When all the changes to the graph are +complete, call UnblockGraphRedraws to re-enable graph updates. +Close () +Close the window. +Duplicate () +Duplicate the 2D graph. (Returns a Graph object.) +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +ExportTraces (filename string, samples number) +Export the graph traces to the specified tab separated file. +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Show () +Shows the view. +UnblockGraphRedraws () +Enables graph redraws. This method is used in conjunction with BlockGraphRedraws for +performance purposes. The graph is redrawn when this method is called and normals redraws will +occur on changes. +ZoomToExtents () +Zoom the content of the window to its extent. +Property Details +BackColour +The background colour of the graph. +Type +Colour +Access +Read/Write +Footer +The graph footer properties. +Type +TextBox +Access +Read only +GreyscaleEnabled +Set the graph's colour scheme to greyscale. +Type +boolean +Access +Read/Write +Height +The height of the window. +Type +number +Access +Read only +Legend +The graph legend properties. +Type +GraphLegend +Access +Read only +Title +The graph title properties. +Type +TextBox +Access +Read only +Width +The width of the window. +Type +number +Access +Read only +WindowActive +True if this window is the active window. +Type +boolean +Access +Read only +WindowTitle +The title of the window. +Type +string +Access +Read/Write +XPosition +The X position of the window. +Type +number +Access +Read only +YPosition +The Y position of the window. +Type +number +Access +Read only +Collection Details +Annotations +The collection of 2D annotations on the graph. +Type +Arrows +ResultAnnotationCollection +The collection of 2D arrows on the graph. +Type +ResultArrowCollection +Shapes +The collection of 2D shapes on the graph. +Type +Traces +ResultTextBoxCollection +The collection of 2D traces on the graph. +Type +ResultTraceCollection +Method Details +AddChartImage (view View, posX number, posY number) +Add a 3D view image to this 2D Graph. +Input Parameters +view(View) +The 3D view. +posX(number) +The x-position of the added chart image. +posY(number) +The y-position of the added chart image. +AddChartImageFromFile (file string, posX number, posY number) +Add an image file to this 2D Graph. +Input Parameters +file(string) +The file. +posX(number) +The x-position of the added chart image. +posY(number) +The y-position of the added chart image. +BlockGraphRedraws () +Disables graph redraws for performance purposes. When all the changes to the graph are +complete, call UnblockGraphRedraws to re-enable graph updates. +Close () +Close the window. +Duplicate () +Duplicate the 2D graph. +Return +Graph +The duplicated 2D graph. +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +imagewidth(number) +The export width in pixels. +imageheight(number) +The export height in pixels. +ExportTraces (filename string, samples number) +Export the graph traces to the specified tab separated file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +samples(number) +The number of samples for continuous data. This value will be ignored if the first trace +on the graph is discrete. +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +Input Parameters +xposition(number) +The view X position. +yposition(number) +The view Y position. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Input Parameters +imagewidth(number) +The view width in pixels. +imageheight(number) +The view height in pixels. +Show () +Shows the view. +UnblockGraphRedraws () +Enables graph redraws. This method is used in conjunction with BlockGraphRedraws for +performance purposes. The graph is redrawn when this method is called and normals redraws will +occur on changes. +ZoomToExtents () +Zoom the content of the window to its extent. +GraphAnnotation +A 2D graph annotation. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +app.Views[1]:Close() + -- Add a Cartesian graph to the application's collection and obtain + -- the arrow collection +graph = app.CartesianGraphs:Add() +farFieldTrace = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) +graph:ZoomToExtents() +annotations = graph.Annotations +annotation1 = annotations:AddGlobalMaximum(farFieldTrace) +annotation2 = annotation1:Duplicate() +annotation1:Delete() +Inheritance +The following objects are derived (specialisations) from the GraphAnnotation object: +• BandwidthAnnotation +• BeamwidthAnnotation +• ImplicitPointsAnnotation +• SimpleAnnotation +• WidthAnnotation +Usage locations +The GraphAnnotation object can be accessed from the following locations: +• Methods +◦ WidthAnnotation object has method Duplicate(). +◦ SimpleAnnotation object has method Duplicate(). +◦ +ImplicitPointsAnnotation object has method Duplicate(). +◦ BeamwidthAnnotation object has method Duplicate(). +◦ BandwidthAnnotation object has method Duplicate(). +◦ GraphAnnotation object has method Duplicate(). +◦ ResultAnnotationCollection collection has method Items(). +◦ ResultAnnotationCollection collection has method Item(number). +◦ ResultAnnotationCollection collection has method Item(string). +◦ ResultAnnotationCollection collection has method AddGlobalMaximum(ResultTrace). +◦ ResultAnnotationCollection collection has method AddGlobalMinimum(ResultTrace). +◦ ResultAnnotationCollection collection has method AddFirstLocalMaximum(ResultTrace, +AnnotationRelativeTypeEnum). +◦ ResultAnnotationCollection collection has method AddFirstLocalMaximumToLeft(ResultTrace, +AnnotationRelativeTypeEnum). +◦ ResultAnnotationCollection collection has method AddFirstLocalMaximumToRight(ResultTrace, +AnnotationRelativeTypeEnum). +◦ ResultAnnotationCollection collection has method AddGreatestLocalMaximum(ResultTrace, +AnnotationRelativeTypeEnum). +◦ ResultAnnotationCollection collection has method +AddGreatestLocalMaximumToLeft(ResultTrace, AnnotationRelativeTypeEnum). +◦ ResultAnnotationCollection collection has method +AddGreatestLocalMaximumToRight(ResultTrace, AnnotationRelativeTypeEnum). +◦ ResultAnnotationCollection collection has method AddFirstLocalMinimum(ResultTrace, +AnnotationRelativeTypeEnum). +◦ ResultAnnotationCollection collection has method AddFirstLocalMinimumToLeft(ResultTrace, +AnnotationRelativeTypeEnum). +◦ ResultAnnotationCollection collection has method AddFirstLocalMinimumToRight(ResultTrace, +AnnotationRelativeTypeEnum). +◦ ResultAnnotationCollection collection has method AddGreatestLocalMinimum(ResultTrace, +AnnotationRelativeTypeEnum). +◦ ResultAnnotationCollection collection has method AddGreatestLocalMinimumToLeft(ResultTrace, +AnnotationRelativeTypeEnum). +◦ ResultAnnotationCollection collection has method +AddGreatestLocalMinimumToRight(ResultTrace, AnnotationRelativeTypeEnum). +◦ ResultAnnotationCollection collection has method AddValueAtHorizontalPosition(ResultTrace, +number). +◦ ResultAnnotationCollection collection has method AddIndependentValue(ResultTrace, number, +number). +◦ ResultAnnotationCollection collection has method AddBandwidthAnnotation(ResultTrace, +AnnotationBandwidthTypeEnum, number). +◦ ResultAnnotationCollection collection has method AddBandwidth3dBAnnotation(ResultTrace, +AnnotationBandwidthTypeEnum). +◦ ResultAnnotationCollection collection has method AddBandwidth10dBAnnotation(ResultTrace, +AnnotationBandwidthTypeEnum). +◦ ResultAnnotationCollection collection has method AddBandwidth15dBAnnotation(ResultTrace, +AnnotationBandwidthTypeEnum). +◦ ResultAnnotationCollection collection has method AddBeamwidthAnnotation(ResultTrace, +AnnotationBeamwidthTypeEnum, AnnotationRelativeTypeEnum). +◦ ResultAnnotationCollection collection has method +AddHalfPowerBeamwidthAnnotation(ResultTrace). +◦ ResultAnnotationCollection collection has method +AddFirstNullBeamwidthAnnotation(ResultTrace). +◦ ResultAnnotationCollection collection has method +AddNullToNullBeamwidthAnnotation(ResultTrace). +◦ ResultAnnotationCollection collection has method AddDerivedWidthAnnotation(ResultTrace, +AnnotationRelativeTypeEnum, AnnotationWidthDefinitionTypeEnum, number). +◦ ResultAnnotationCollection collection has method AddSideLobeLevelAnnotation(ResultTrace). +◦ ResultAnnotationCollection collection has method AddDeltaAnnotation(ResultTrace). +Property List +AnnotationRelativeType +For annotations that are relative to other graph positions, this values sets what it is relative to. +(Read/Write AnnotationRelativeTypeEnum) +AutoTextEnabled +Toggle between auto text and custom annotation text. (Read/Write boolean) +Label +The object label. (Read/Write string) +OffsetX +Annotation text box offset (pixels) in the x-direction. A positive value moves the annotation to the +right, a negative value moves it to the left. If both the OffsetX and OffsetY is zero, it will be placed +automatically. (Read/Write number) +OffsetY +Annotation text box offset (pixels) in the y-direction. A positive value moves the annotation to +the bottom, a negative value moves it to the top. If both the OffsetX and OffsetY is zero, it will be +placed automatically. (Read/Write number) +Text +Trace +The annotation text. (Read/Write string) +The ResultTrace of the annotation. (Read/Write ResultTrace) +Method List +Delete () +Delete the annotation. +Duplicate () +Duplicate the annotation. (Returns a GraphAnnotation object.) +Property Details +AnnotationRelativeType +For annotations that are relative to other graph positions, this values sets what it is relative to. +Type +AnnotationRelativeTypeEnum +Access +Read/Write +AutoTextEnabled +Toggle between auto text and custom annotation text. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +OffsetX +Annotation text box offset (pixels) in the x-direction. A positive value moves the annotation to the +right, a negative value moves it to the left. If both the OffsetX and OffsetY is zero, it will be placed +automatically. +Type +number +Access +Read/Write +OffsetY +Annotation text box offset (pixels) in the y-direction. A positive value moves the annotation to +the bottom, a negative value moves it to the top. If both the OffsetX and OffsetY is zero, it will be +placed automatically. +Type +number +Access +Read/Write +Text +The annotation text. +Type +string +Access +Read/Write +Trace +The ResultTrace of the annotation. +Type +ResultTrace +Access +Read/Write +Method Details +Delete () +Delete the annotation. +Duplicate () +Duplicate the annotation. +Return +GraphAnnotation +The new annotation. +GraphAxisLabels +The graph axis labels properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianGraphs:Add() + -- Edit 'GraphAxisLabels' property +graph.HorizontalAxis.Labels.NumberFormat = pf.Enums.NumberFormatEnum.Scientific +graph.HorizontalAxis.Labels.SignificantDigits = 1 +Usage locations +The GraphAxisLabels object can be accessed from the following locations: +• Properties +◦ AngularGraphAxis object has property Labels. +◦ RadialGraphAxis object has property Labels. +◦ VerticalGraphAxis object has property Labels. +◦ HorizontalGraphAxis object has property Labels. +Property List +AutoSignificantDigitsEnabled +Automatically determine the number of significant digits. (Read/Write boolean) +Font +The font format for the graph axis title. (Read only FontFormat) +NumberFormat +The number format used for axis labels specified by NumberFormatEnum, e.g. Scientific or +Decimal. (Read/Write NumberFormatEnum) +SignificantDigits +The number of significant digits of the axis. (Read/Write number) +Property Details +AutoSignificantDigitsEnabled +Automatically determine the number of significant digits. +Type +boolean +Access +Read/Write +Font +The font format for the graph axis title. +Type +FontFormat +Access +Read only +NumberFormat +The number format used for axis labels specified by NumberFormatEnum, e.g. Scientific or +Decimal. +Type +NumberFormatEnum +Access +Read/Write +SignificantDigits +The number of significant digits of the axis. +Type +number +Access +Read/Write +GraphAxisTitle +The graph axis title properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianGraphs:Add() +graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Edit 'GraphAxisTitle' properties +graph.HorizontalAxis.Title.Caption = "Frequency measured in Gigahertz" +graph.HorizontalAxis.Title.CaptionIncludesUnit = false +Usage locations +The GraphAxisTitle object can be accessed from the following locations: +• Properties +◦ VerticalGraphAxis object has property Title. +◦ HorizontalGraphAxis object has property Title. +Property List +AutoCaptionEnabled +Specifies whether the automatic caption text of the graph axis must be used. (Read/Write +boolean) +Caption +The caption of the graph axis. (Read/Write string) +CaptionIncludesUnit +Include the unit in the axis caption. (Read/Write boolean) +Font +The font format for the graph axis title. (Read only FontFormat) +Frame +The frame format for the graph axis title. (Read only FrameFormat) +Property Details +AutoCaptionEnabled +Specifies whether the automatic caption text of the graph axis must be used. +Type +boolean +Access +Read/Write +Caption +The caption of the graph axis. +Type +string +Access +Read/Write +CaptionIncludesUnit +Include the unit in the axis caption. +Type +boolean +Access +Read/Write +Font +Frame +The font format for the graph axis title. +Type +FontFormat +Access +Read only +The frame format for the graph axis title. +Type +FrameFormat +Access +Read only +GraphLegend +The graph legend properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianGraphs:Add() +excitation = app.Models["startup"].Configurations[1].Excitations[1] +excitationTrace = graph.Traces:Add(excitation) + -- Change properties of the graph legend +graph.Legend.Position = pf.Enums.GraphLegendPositionEnum.CustomPosition +graph.Legend.CustomPositionX = 10 +graph.Legend.CustomPositionY = 10 +Usage locations +The GraphLegend object can be accessed from the following locations: +• Properties +◦ SmithChart object has property Legend. +◦ PolarGraph object has property Legend. +◦ CartesianGraph object has property Legend. +◦ Graph object has property Legend. +Property List +AutoNumberOfColumns +Specifies whether the number of legend columns are chosen automatically. (Read/Write boolean) +CustomPositionX +The custom X coordinate position of the legend. Measured in pixels relative to the top left corner +of the graph, with x increasing from left to right. (Read/Write number) +CustomPositionY +The custom Y coordinate position of the legend. Measured in pixels relative to the top left corner +of the graph, with y increasing from top to bottom. (Read/Write number) +Font +The font format for the graph legend. (Read only FontFormat) +Frame +The frame format for the graph legend. (Read only FrameFormat) +NumberOfColumns +The number of columns on the legend. (Read/Write number) +Position +The position of the graph legend specified by the GraphLegendPositionEnum, e.g. Top, Bottom, +Left, etc. (Read/Write GraphLegendPositionEnum) +Property Details +AutoNumberOfColumns +Specifies whether the number of legend columns are chosen automatically. +Type +boolean +Access +Read/Write +CustomPositionX +The custom X coordinate position of the legend. Measured in pixels relative to the top left corner +of the graph, with x increasing from left to right. +Type +number +Access +Read/Write +CustomPositionY +The custom Y coordinate position of the legend. Measured in pixels relative to the top left corner +of the graph, with y increasing from top to bottom. +Type +number +Access +Read/Write +Font +Frame +The font format for the graph legend. +Type +FontFormat +Access +Read only +The frame format for the graph legend. +Type +FrameFormat +Access +Read only +NumberOfColumns +The number of columns on the legend. +Type +number +Access +Read/Write +Position +The position of the graph legend specified by the GraphLegendPositionEnum, e.g. Top, Bottom, +Left, etc. +Type +GraphLegendPositionEnum +Access +Read/Write +GraphLineFormat +The line format property. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianGraphs:Add() + -- Edit 'GraphLineFormat' properties of the grid border +graph.Grid.Border.Weight = 2 + -- Edit 'GraphLineFormat' of the title frame +graph.Title.Frame.Line.Colour = pf.Enums.ColourEnum.Grey +Usage locations +The GraphLineFormat object can be accessed from the following locations: +• Properties +◦ SmithChartGrid object has property Border. +◦ SmithChartGrid object has property ReactanceLine. +◦ SmithChartGrid object has property ResistanceLine. +◦ PolarGridLines object has property RadialLine. +◦ PolarGridLines object has property AngularLine. +◦ PolarGraphGrid object has property Border. +◦ CartesianGridLines object has property HorizontalLine. +◦ CartesianGridLines object has property VerticalLine. +◦ CartesianGraphGrid object has property Border. +◦ FrameFormat object has property Line. +Property List +Colour +The line colour. (Read/Write Colour) +Style +The line style. (Read/Write LineStyleEnum) +Weight +The line weight. (Read/Write number) +Property Details +Colour +The line colour. +Type +Colour +Access +Read/Write +Style +The line style. +Type +LineStyleEnum +Access +Read/Write +Weight +The line weight. +Type +number +Access +Read/Write +HorizontalGraphAxis +The graph horizontal axis properties. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianGraphs:Add() + -- Edit 'HorizontalGraphAxis' property +graph.HorizontalAxis.LogScaled = true +Usage locations +The HorizontalGraphAxis object can be accessed from the following locations: +• Properties +◦ CartesianGraph object has property HorizontalAxis. +Property List +Labels +The graph horizontal axis labels. (Read only GraphAxisLabels) +LogScaled +Set the graph horizontal axis to a logarithmic scale. (Read/Write boolean) +MajorGrid +The graph horizontal axis major grid spacing. (Read only AxisGridSpacing) +MinorGridSubdivisions +The number of minor grid subdivisions. (Read/Write number) +Range +The graph horizontal axis range. (Read only AxisRange) +ReversedOrder +Set the graph horizontal axis to a reversed order. (Read/Write boolean) +Title +The graph horizontal axis title. (Read only GraphAxisTitle) +Property Details +Labels +The graph horizontal axis labels. +Type +GraphAxisLabels +Access +Read only +LogScaled +Set the graph horizontal axis to a logarithmic scale. +Type +boolean +Access +Read/Write +MajorGrid +The graph horizontal axis major grid spacing. +Type +AxisGridSpacing +Access +Read only +MinorGridSubdivisions +The number of minor grid subdivisions. +Type +number +Access +Read/Write +Range +The graph horizontal axis range. +Type +AxisRange +Access +Read only +ReversedOrder +Set the graph horizontal axis to a reversed order. +Type +boolean +Access +Read/Write +Title +The graph horizontal axis title. +Type +GraphAxisTitle +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +HorizontalSurfaceGraphAxis +The graph horizontal axis properties. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianSurfaceGraphs:Add() + -- Edit 'HorizontalSurfaceGraphAxis' property +graph.HorizontalAxis.Title.CaptionIncludesUnit = true +p.3377 +Usage locations +The HorizontalSurfaceGraphAxis object can be accessed from the following locations: +• Properties +◦ CartesianSurfaceGraph object has property HorizontalAxis. +Property List +Labels +The graph horizontal axis labels. (Read only SurfaceGraphAxisLabels) +MajorGrid +The graph horizontal axis major grid spacing. (Read only SurfaceGraphAxisGridSpacing) +MinorGridSubdivisions +The number of minor grid subdivisions. (Read/Write number) +Range +The graph horizontal axis range. (Read only SurfaceGraphAxisRange) +ReversedOrder +Set the graph horizontal axis to a reversed order. (Read/Write boolean) +Title +The graph horizontal axis title. (Read only SurfaceGraphAxisTitle) +Property Details +Labels +The graph horizontal axis labels. +Type +SurfaceGraphAxisLabels +Access +Read only +MajorGrid +The graph horizontal axis major grid spacing. +Type +SurfaceGraphAxisGridSpacing +Access +Read only +MinorGridSubdivisions +The number of minor grid subdivisions. +Type +number +Access +Read/Write +Range +The graph horizontal axis range. +Type +SurfaceGraphAxisRange +Access +Read only +ReversedOrder +Set the graph horizontal axis to a reversed order. +Type +boolean +Access +Read/Write +Title +The graph horizontal axis title. +Type +SurfaceGraphAxisTitle +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +ImplicitPointsAnnotation +A 2D graph implicit points annotation. +Example +p.3379 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +app.Views[1]:Close() + -- Add a Cartesian graph and far field trace +graph = app.CartesianGraphs:Add() +farFieldTrace = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Configure the far field trace +farFieldTrace.IndependentAxis = farFieldTrace.IndependentAxesAvailable[3] +farFieldTrace:SetFixedAxisValue("Frequency", 7.85, "GHz") +farFieldTrace.Quantity.Component = + pf.Enums.FarFieldQuantityComponentEnum.Theta +farFieldTrace:SetFixedAxisValue("Phi", 40, "deg") + -- Zoom to extents +graph:ZoomToExtents() + -- Add annotations +annotations = graph.Annotations +annotation1 = annotations:AddDerivedWidthAnnotation(farFieldTrace, + pf.Enums.AnnotationRelativeTypeEnum.RelativeToGlobalMax, + pf.Enums.AnnotationWidthDefinitionTypeEnum.Scale, 0.5) +Inheritance +The ImplicitPointsAnnotation object is derived from the GraphAnnotation object. +Property List +AnnotationRelativeType +For annotations that are relative to other graph positions, this values sets what it is relative to. +(Read/Write AnnotationRelativeTypeEnum) +AutoTextEnabled +Toggle between auto text and custom annotation text. (Read/Write boolean) +Label +Offset +The object label. (Read/Write string) +The offset level. (Read/Write number) +OffsetType +The annotation offset type. (Read/Write AnnotationWidthDefinitionTypeEnum) +OffsetX +Annotation text box offset (pixels) in the x-direction. A positive value moves the annotation to the +right, a negative value moves it to the left. If both the OffsetX and OffsetY is zero, it will be placed +automatically. (Read/Write number) +Altair Feko 2022.3 +2 Application Programming Interface (API) +OffsetY +p.3380 +Annotation text box offset (pixels) in the y-direction. A positive value moves the annotation to +the bottom, a negative value moves it to the top. If both the OffsetX and OffsetY is zero, it will be +placed automatically. (Read/Write number) +Text +Trace +Type +The annotation text. (Read/Write string) +The ResultTrace of the annotation. (Read/Write ResultTrace) +The object type string. (Read only string) +Method List +Delete () +Delete the annotation. +Duplicate () +Duplicate the annotation. (Returns a GraphAnnotation object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +GetValues () +Get table of values associated with the annotation. (Returns a Map of string:Expression object.) +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Property Details +AnnotationRelativeType +For annotations that are relative to other graph positions, this values sets what it is relative to. +Type +AnnotationRelativeTypeEnum +Access +Read/Write +AutoTextEnabled +Toggle between auto text and custom annotation text. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Offset +The offset level. +Type +number +Access +Read/Write +OffsetType +The annotation offset type. +Type +AnnotationWidthDefinitionTypeEnum +Access +Read/Write +OffsetX +Annotation text box offset (pixels) in the x-direction. A positive value moves the annotation to the +right, a negative value moves it to the left. If both the OffsetX and OffsetY is zero, it will be placed +automatically. +Type +number +Access +Read/Write +OffsetY +Annotation text box offset (pixels) in the y-direction. A positive value moves the annotation to +the bottom, a negative value moves it to the top. If both the OffsetX and OffsetY is zero, it will be +placed automatically. +Type +number +Access +Read/Write +Text +The annotation text. +Type +string +Access +Read/Write +Trace +The ResultTrace of the annotation. +Type +ResultTrace +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the annotation. +Duplicate () +Duplicate the annotation. +Return +GraphAnnotation +The new annotation. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +GetValues () +A properties table. +Get table of values associated with the annotation. +Return +Map of string:Expression +Table of key-value pairs. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ImportSet +Sets of imported data from external files. +Example +app = pf.GetApplication() +app:NewProject() +p.3384 +graph = app.CartesianGraphs:Add() + -- Import S-parameter results from the specified Touchstone file +importSet = app:ImportResults(FEKO_HOME..[[/shared/Resources/Automation/ +SParameters.s2p]], + pf.Enums.ImportFileTypeEnum.Touchstone) + -- Duplicate the import set and change the source file of the copied import set + -- to a different Touchstone file +importSetCopy = importSet:Duplicate() +importSetCopy.Filename = FEKO_HOME..[[/shared/Resources/Automation/SParameters.s3p]] + -- Retrieve the result data from the import sets. +s2p = importSet.ImportedData[1] +s3p = importSetCopy.ImportedData[1] + -- Plot the result data on the Cartesian graph and change the trace labels + accordingly +s2pTrace = graph.Traces:Add(s2p) +s2pTrace.Label = "s2p" +s3pTrace = graph.Traces:Add(s3p) +s3pTrace.Label = "s3p" +Usage locations +The ImportSet object can be accessed from the following locations: +• Methods +◦ +◦ +◦ +◦ +ImportSet object has method Duplicate(). +ImportedDataSetCollection collection has method Items(). +ImportedDataSetCollection collection has method Item(number). +ImportedDataSetCollection collection has method Item(string). +◦ Application object has method ImportResults(string, ImportFileTypeEnum). +◦ Application object has method ImportResults(List of string, ImportFileTypeEnum). +Property List +Filename +The file containing the import data. Changing this property will re-import the results from the +newly specified file. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Collection List +ImportedData +p.3385 +The collection of imported data in the import set. (ImportedDataCollection of ResultData.) +Method List +Delete () +Delete the import set. +Duplicate () +Create a duplicate import set. (Returns a ImportSet object.) +Refresh () +Refresh the imported data. +Property Details +Filename +The file containing the import data. Changing this property will re-import the results from the +newly specified file. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Collection Details +ImportedData +The collection of imported data in the import set. +Type +ImportedDataCollection +Method Details +Delete () +Delete the import set. +Duplicate () +Create a duplicate import set. +Return +ImportSet +The duplicated import set. +Refresh () +Refresh the imported data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +IndependentAxisFormat +The trace independent axis properties. +Example +p.3387 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) +cartesianGraph = app.CartesianGraphs:Add() +trace = cartesianGraph.Traces:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Set axes properties +trace.Axes.Independent.Unit = "mm" +trace.Axes.Independent.Offset = 0.01 -- Offset is in SI unit, i.e. 'm' +trace.Axes.Independent.Scale = 0.5 +cartesianGraph:ZoomToExtents() +Usage locations +The IndependentAxisFormat object can be accessed from the following locations: +• Properties +◦ TraceAxes object has property Independent. +Property List +Offset +Scale +Unit +The independent axis offset for the trace. (Read/Write number) +The independent axis scale for the trace. (Read/Write number) +The unit of the independent axis of the trace. (Read/Write string) +Property Details +Offset +The independent axis offset for the trace. +Type +number +Access +Read/Write +Scale +The independent axis scale for the trace. +Type +number +Access +Read/Write +Unit +The unit of the independent axis of the trace. +Type +string +Access +Read/Write +Interpolator +An interpolator object. +Example +app = feko.GetApplication() +app:NewProject() + -- The simulated values +local simulated = {} +simulated.independent = { 1e9, 2e9, 3e9, 4e9, 5e9, 6e9, 7e9, 8e9, 9e9, 10e9 } +simulated.dependent = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 } + -- Setup and configure 'Interpolator' object +local Interpolator = feko.Interpolator.Rational( simulated.independent, + simulated.dependent ) + -- Print 'Interpolator' type +print(Interpolator.Type) +Usage locations +The Interpolator object can be accessed from the following locations: +• Static functions +◦ +◦ +Interpolator object has static function Rational(List of number, List of Complex). +Interpolator object has static function Rational(List of number, List of number). +Property List +Errors +The error messages for the interpolation. (Read only string) +Settings +Additional settings that are required by the interpolation algorithm. (Read only +InterpolatorSettings) +Succeeded +The success of the interpolation. (Read only boolean) +Type +The object type string. (Read only string) +Warnings +The warning messages for the interpolation. (Read only string) +Method List +Resample (resampledscalaraxis List of number) +Returns a table with estimated values corresponding to the independent axis sampling that has +been provided. (Returns a List of Variant object.) +Resample (resampledcomplexaxis List of Complex) +Returns a table with estimated values corresponding to the independent axis sampling that has +been provided. (Returns a List of Variant object.) +Constructor Function List +Rational (independentvalues List of number, dependentcomplexvalues List of Complex) +Creates an object that can be used for rational interpolation (using adaptive sampling +techniques). The parameters specify the known list of independent and dependent values. +(Returns a Interpolator object.) +Rational (independentvalues List of number, dependentscalarvalues List of number) +Creates an object that can be used for rational interpolation (using adaptive sampling +techniques). The parameters specify the known list of independent and dependent values. +(Returns a Interpolator object.) +Property Details +Errors +The error messages for the interpolation. +Type +string +Access +Read only +Settings +Additional settings that are required by the interpolation algorithm. +Type +InterpolatorSettings +Access +Read only +Succeeded +The success of the interpolation. +Type +boolean +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +Warnings +The warning messages for the interpolation. +Type +string +Access +Read only +p.3391 +Method Details +Resample (resampledscalaraxis List of number) +Returns a table with estimated values corresponding to the independent axis sampling that has +been provided. +Input Parameters +resampledscalaraxis(List of number) +The re-sampled scalar independent axis. +Return +List of Variant +A table with estimated values. +Resample (resampledcomplexaxis List of Complex) +Returns a table with estimated values corresponding to the independent axis sampling that has +been provided. +Input Parameters +resampledcomplexaxis(List of Complex) +The re-sampled complex independent axis. +Return +List of Variant +A table with estimated values. +Static Function Details +Rational (independentvalues List of number, dependentcomplexvalues List of Complex) +Creates an object that can be used for rational interpolation (using adaptive sampling +techniques). The parameters specify the known list of independent and dependent values. +Input Parameters +independentvalues(List of number) +The independent values. +dependentcomplexvalues(List of Complex) +The dependent complex values. +Return +Interpolator +Returns an Interpolator object. +Rational (independentvalues List of number, dependentscalarvalues List of number) +Creates an object that can be used for rational interpolation (using adaptive sampling +techniques). The parameters specify the known list of independent and dependent values. +Input Parameters +independentvalues(List of number) +The independent values. +dependentscalarvalues(List of number) +The dependent scalar values. +Return +Interpolator +Returns an Interpolator object. +InterpolatorSettings +Interpolator settings object. +Example +app = feko.GetApplication() +app:NewProject() + -- The simulated values +local simulated = {} +simulated.independent = { 1e9, 2e9, 3e9, 4e9, 5e9, 6e9, 7e9, 8e9, 9e9, 10e9 } +simulated.dependent = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 } + -- Setup and configure 'Interpolator' object +local interpolator = feko.Interpolator.Rational( simulated.independent, + simulated.dependent ) + -- The 'InterpolateSettings' object +settings = interpolator.Settings + -- Print 'InterpolatorSettings' type +print(settings.Type) +Usage locations +The InterpolatorSettings object can be accessed from the following locations: +• Properties +◦ +Interpolator object has property Settings. +Property List +DependentAxisValues +The known dependent axis values for the interpolation routine input. (Read/Write List of Variant) +IndependentAxisValues +The known independent axis values for the interpolation routine input. (Read/Write List of +number) +Type +The object type string. (Read only string) +Method List +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties table) +p.3394 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Property Details +DependentAxisValues +The known dependent axis values for the interpolation routine input. +Access +Read/Write +IndependentAxisValues +The known independent axis values for the interpolation routine input. +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +IsoSurface3DFormat +The near field plot isosurface properties. +Example +p.3395 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) +firstActive3DView = app.Views[1] +nearFieldPlot = + firstActive3DView.Plots:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Set plot type to isosurface and adjust its properties +nearFieldPlot.PlotType = nearFieldPlot.PlotTypesAvailable[4] +nearFieldPlot.IsoSurface.ValuePercentage = 12 +Usage locations +The IsoSurface3DFormat object can be accessed from the following locations: +• Properties +◦ NearField3DPlot object has property IsoSurface. +Property List +Colour +The colour of the isosurface when the near field plot type is set to isosurface. (Read/Write Colour) +Value +The value of the isosurface near field plot. The value is in the trace's QuantityType unit. (Read/ +Write number) +ValuePercentage +The value of the isosurface near field plot as a percentage. (Read/Write number) +Property Details +Colour +The colour of the isosurface when the near field plot type is set to isosurface. +Type +Colour +Access +Read/Write +Value +The value of the isosurface near field plot. The value is in the trace's QuantityType unit. +Type +number +Access +Read/Write +ValuePercentage +The value of the isosurface near field plot as a percentage. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +LaunchResult +The result of last Feko or external process run. +Example +p.3397 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Launch PREFEKO on the model +results = app.Models[1].Launcher:RunFEKO() + -- Check the result of the run +success = results.Succeeded +Usage locations +The LaunchResult object can be accessed from the following locations: +• Methods +◦ Launcher object has method RunFEKO(). +◦ Launcher object has method RunPREFEKO(). +◦ Launcher object has method RunOPTFEKO(). +• Static functions +◦ Launcher object has static function Run(string, List of string). +◦ Launcher object has static function Run(string). +Property List +Errors +The error messages for the process run. (Read only string) +ExitCode +The exit code of the process run. (Read only number) +Notices +The notices for the process run. (Read only string) +Output +The standard output for the process run. (Read only string) +Succeeded +The success of the process run. (Read only boolean) +Type +The object type string. (Read only string) +Warnings +The warning messages for the process run. (Read only string) +Property Details +Errors +The error messages for the process run. +Type +string +Access +Read only +ExitCode +The exit code of the process run. +Type +number +Access +Read only +Notices +The notices for the process run. +Type +string +Access +Read only +Output +The standard output for the process run. +Type +string +Access +Read only +Succeeded +The success of the process run. +Type +boolean +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +Warnings +The warning messages for the process run. +Type +string +Access +Read only +p.3399 +Altair Feko 2022.3 +2 Application Programming Interface (API) +Launcher +p.3400 +The object coordinating the launching of Feko and external processes. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Launch PREFEKO on the model +results = app.Models[1].Launcher:RunFEKO() + -- Check the result of the run +success = results.Succeeded +Usage locations +The Launcher object can be accessed from the following locations: +• Properties +◦ Model object has property Launcher. +Property List +Settings +The components launch options. (Read only ComponentLaunchOptions) +Type +The object type string. (Read only string) +Method List +GetCommandRunCADFEKO () +Get the command that will be executed by the RunCADFEKO method. (Returns a string object.) +GetCommandRunEDITFEKO () +Get the command that will be executed by the RunEDITFEKO method. (Returns a string object.) +GetCommandRunFEKO () +Get the command that will be executed by the RunFEKO method. (Returns a string object.) +GetCommandRunOPTFEKO () +Get the command that will be executed by the RunOPTFEKO method. (Returns a string object.) +GetCommandRunPOSTFEKO () +Get the command that will be executed by the RunPOSTFEKO method. (Returns a string object.) +GetCommandRunPREFEKO () +Get the command that will be executed by the RunPREFEKO method. (Returns a string object.) +RunCADFEKO () +Run CADFEKO. (Returns a boolean object.) +RunEDITFEKO () +Run EDITFEKO. (Returns a boolean object.) +RunFEKO () +Run Feko Solver. (Returns a LaunchResult object.) +RunOPTFEKO () +Run OPTFEKO. (Returns a LaunchResult object.) +RunPOSTFEKO () +Run POSTFEKO. (Returns a boolean object.) +RunPREFEKO () +Run PREFEKO. (Returns a LaunchResult object.) +Constructor Function List +Run (executable string, arguments List of string) +Launch the given executable with a list of arguments and process the output. CAUTION, the +process that is called could be blocking and will halt your program execution until it is complete. +(Returns a LaunchResult object.) +Run (command string) +Launch the given command and process the output. CAUTION, the process that is called could +be blocking and will halt your program execution until it is complete. (Returns a LaunchResult +object.) +Property Details +Settings +The components launch options. +Type +ComponentLaunchOptions +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +GetCommandRunCADFEKO () +Get the command that will be executed by the RunCADFEKO method. +Return +string +The command string. +GetCommandRunEDITFEKO () +Get the command that will be executed by the RunEDITFEKO method. +Return +string +The command string. +GetCommandRunFEKO () +Get the command that will be executed by the RunFEKO method. +Return +string +The command string. +GetCommandRunOPTFEKO () +Get the command that will be executed by the RunOPTFEKO method. +Return +string +The command string. +GetCommandRunPOSTFEKO () +Get the command that will be executed by the RunPOSTFEKO method. +Return +string +The command string. +GetCommandRunPREFEKO () +Get the command that will be executed by the RunPREFEKO method. +Return +string +The command string. +RunCADFEKO () +Run CADFEKO. +Return +boolean +The success of launching CADFEKO. +RunEDITFEKO () +Run EDITFEKO. +Return +boolean +The success of launching EDITFEKO. +RunFEKO () +Run Feko Solver. +Return +LaunchResult +The process run result. +RunOPTFEKO () +Run OPTFEKO. +Return +LaunchResult +The process run result. +RunPOSTFEKO () +Run POSTFEKO. +Return +boolean +The success of launching POSTFEKO. +RunPREFEKO () +Run PREFEKO. +Return +LaunchResult +The process run result. +Static Function Details +Run (executable string, arguments List of string) +Launch the given executable with a list of arguments and process the output. CAUTION, the +process that is called could be blocking and will halt your program execution until it is complete. +Input Parameters +executable(string) +The program to execute. +arguments(List of string) +The arguments send to the executable. +Return +LaunchResult +A LaunchResult containing the results of this run. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Run (command string) +p.3404 +Launch the given command and process the output. CAUTION, the process that is called could be +blocking and will halt your program execution until it is complete. +Input Parameters +command(string) +The command to execute. +Return +LaunchResult +A LaunchResult containing the results of this run. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Legend3DLinearRangeFormat +The 3D plot legend linear range properties. +Example +p.3405 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farField = app.Views[1].Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- SetProperties legend linear range +farField.Legend.LinearRange.Type = pf.Enums.LinearScaleRangeTypeEnum.Fixed +farField.Legend.LinearRange.FixedRangeMin = 0.8 +farField.Legend.LinearRange.FixedRangeMax = 3.2 +Usage locations +The Legend3DLinearRangeFormat object can be accessed from the following locations: +• Properties +◦ Plot3DLegendFormat object has property LinearRange. +Property List +FixedRangeMax +Specify the linear scale maximum value for the fixed range of the plot legend. (Read/Write +number) +FixedRangeMin +Specify the linear scale minimum value for the fixed range of the plot legend. (Read/Write +number) +Type +Method by which the linear scale range limits should be determined, specified by the +LinearScaleRangeTypeEnum, e.g. Auto or Fixed. (Read/Write LinearScaleRangeTypeEnum) +Property Details +FixedRangeMax +Specify the linear scale maximum value for the fixed range of the plot legend. +Type +number +Access +Read/Write +FixedRangeMin +Specify the linear scale minimum value for the fixed range of the plot legend. +Type +number +Access +Read/Write +Type +Method by which the linear scale range limits should be determined, specified by the +LinearScaleRangeTypeEnum, e.g. Auto or Fixed. +Type +LinearScaleRangeTypeEnum +Access +Read/Write +Legend3DLogarithmicRangeFormat +The 3D plot legend logarithmic range properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farField = app.Views[1].Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- SetProperties legend logarithmic range +farField.Legend.LogarithmicRange.Type = pf.Enums.LogScaleRangeTypeEnum.Max +farField.Legend.LogarithmicRange.DynamicRangeMax = 30 +Usage locations +The Legend3DLogarithmicRangeFormat object can be accessed from the following locations: +• Properties +◦ Plot3DLegendFormat object has property LogarithmicRange. +Property List +DynamicRangeMax +Specify the log scale maximum value in dB for the dynamic range of the plot legend. (Read/Write +number) +FixedRangeMax +Specify the log scale maximum value in dB for the fixed range of the plot legend. (Read/Write +number) +FixedRangeMin +Specify the log scale minimum value in dB for the fixed range of the plot legend. (Read/Write +number) +Type +Method by which the log scale range limits should be determined, specified by +LogScaleRangeTypeEnum, e.g. Auto, Max or Fixed. (Read/Write LogScaleRangeTypeEnum) +Property Details +DynamicRangeMax +Specify the log scale maximum value in dB for the dynamic range of the plot legend. +Type +number +Access +Read/Write +FixedRangeMax +Specify the log scale maximum value in dB for the fixed range of the plot legend. +Type +number +Access +Read/Write +FixedRangeMin +Specify the log scale minimum value in dB for the fixed range of the plot legend. +Type +number +Access +Read/Write +Type +Method by which the log scale range limits should be determined, specified by +LogScaleRangeTypeEnum, e.g. Auto, Max or Fixed. +Type +LogScaleRangeTypeEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadCable +Cable load results generated by the Feko Solver. +Example +p.3409 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Retrieve the 'LoadCable' called 'LCLoad1' +loadCable = app.Models[1].Configurations[1].Loads["LCLoad1"] + -- Manipulate the cable load data. See 'DataSet' for faster and more + comprehensive options +dataSet = loadCable:GetDataSet() +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Scale the cable load current values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.Current = indexedValue.Current * scale +end + -- Store the manipulated data +scaledCableLoad = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Load) + -- Compare the original cable load to the manipulated cable load +graph = app.CartesianGraphs:Add() +loadTrace1 = graph.Traces:Add(loadCable) +loadTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +loadTrace2 = graph.Traces:Add(scaledCableLoad) +loadTrace2.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +Inheritance +The LoadCable object is derived from the LoadData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +Type +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the network values. +Return +DataSet +The data set containing the network values. +GetDataSet (samplePoints number) +Returns a data set containing the network values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +StoreData () +Creates a local stored version of the result data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ResultData +The new stored data. +p.3412 +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadCoaxial +Coaxial load results generated by the Feko Solver. +Example +p.3413 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/A4_source.fek]]) + -- Retrieve the 'LoadCoaxial' called 'L4Load1' +loadCoaxial = app.Models[1].Configurations[1].Loads["L4Load1"] + -- Manipulate the coaxial load data. See 'DataSet' for faster and more + comprehensive options +dataSet = loadCoaxial:GetDataSet() +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Scale the coaxial load current values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.Current = indexedValue.Current * scale +end + -- Store the manipulated data +scaledCoaxialLoad = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Load) + -- Compare the original coaxial load to the manipulated coaxial load +graph = app.CartesianGraphs:Add() +loadTrace1 = graph.Traces:Add(loadCoaxial) +loadTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +loadTrace2 = graph.Traces:Add(scaledCoaxialLoad) +loadTrace2.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +Inheritance +The LoadCoaxial object is derived from the LoadData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +Type +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the network values. +Return +DataSet +The data set containing the network values. +GetDataSet (samplePoints number) +Returns a data set containing the network values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +StoreData () +Creates a local stored version of the result data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ResultData +The new stored data. +p.3416 +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadComplex +Complex load results generated by the Feko Solver. +Example +p.3417 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Retrieve the 'LoadComplex' called 'ComplexLoad' +loadComplex = app.Models[1].Configurations[1].Loads["ComplexLoad"] + -- Manipulate the complex load data. See 'DataSet' for faster and more + comprehensive options +dataSet = loadComplex:GetDataSet() +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Scale the complex load current values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.Current = indexedValue.Current * scale +end + -- Store the manipulated data +scaledComplexLoad = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Load) + -- Compare the original complex load to the manipulated complex load +graph = app.CartesianGraphs:Add() +loadTrace1 = graph.Traces:Add(loadComplex) +loadTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +loadTrace2 = graph.Traces:Add(scaledComplexLoad) +loadTrace2.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +Inheritance +The LoadComplex object is derived from the LoadData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +Type +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the network values. +Return +DataSet +The data set containing the network values. +GetDataSet (samplePoints number) +Returns a data set containing the network values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +StoreData () +Creates a local stored version of the result data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ResultData +The new stored data. +p.3420 +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadData +Load results generated by the Feko Solver. +Example +p.3421 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) + -- Retrieve the 'LoadData' called 'EdgeLoad' +loadData = app.Models[1].Configurations[1].Loads["EdgeLoad"] + -- Manipulate the load data. See 'DataSet' for faster and more comprehensive + options +dataSet = loadData:GetDataSet() +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Find the frequency start and end values +frequencyAxis = dataSet.Axes["Frequency"] +frequencyStartValue = frequencyAxis:ValueAt(1) +frequencyEndValue = frequencyAxis:ValueAt(#frequencyAxis) + -- Scale the power values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.Power = indexedValue.Power * scale +end + -- Store the manipulated data +scaledLoad = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Load) + -- Compare the original load to the manipulated load +graph = app.CartesianGraphs:Add() +excitationTrace1 = graph.Traces:Add(loadData) +excitationTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Power +excitationTrace2 = graph.Traces:Add(scaledLoad) +excitationTrace2.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Power +Inheritance +The LoadData object is derived from the ResultData object. +The following objects are derived (specialisations) from the LoadData object: +• LoadCable +• LoadCoaxial +• LoadComplex +• LoadDistributed +• LoadEdge +• LoadFEM +• LoadNetwork +• LoadParallel +• LoadSeries +• LoadVertex +• LoadVoxel +Usage locations +The LoadData object can be accessed from the following locations: +• Methods +◦ LoadCollection collection has method Items(). +◦ LoadCollection collection has method Item(number). +◦ LoadCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +The object label. (Read/Write string) +Method List +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Method Details +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadDistributed +Distributed load results generated by the Feko Solver. +Example +p.3424 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Retrieve the 'LoadDistributed' called 'LDLoad1'. +loadDistributed = app.Models[1].Configurations[1].Loads["LDLoad1"] + -- Retrieve the load label and its associated solution configuration +configuration = loadDistributed.Configuration +label = loadDistributed.label +Inheritance +The LoadDistributed object is derived from the LoadData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Label +Access +Read only +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadEdge +Edge load results generated by the Feko Solver. +Example +p.3426 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) + -- Retrieve the 'LoadEdge' called 'EdgeLoad' +loadEdge = app.Models[1].Configurations[1].Loads["EdgeLoad"] + -- Manipulate the edge load data. See 'DataSet' for faster and more comprehensive + options +dataSet = loadEdge:GetDataSet() +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Scale the edge load current values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.Current = indexedValue.Current * scale +end + -- Store the manipulated data +scaledEdgeLoad = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Load) + -- Compare the original edge load to the manipulated edge load +graph = app.CartesianGraphs:Add() +loadTrace1 = graph.Traces:Add(loadEdge) +loadTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +loadTrace2 = graph.Traces:Add(scaledEdgeLoad) +loadTrace2.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +Inheritance +The LoadEdge object is derived from the LoadData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +Type +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the network values. +Return +DataSet +The data set containing the network values. +GetDataSet (samplePoints number) +Returns a data set containing the network values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +StoreData () +Creates a local stored version of the result data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ResultData +The new stored data. +p.3429 +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadFEM +FEM load results generated by the Feko Solver. +Example +p.3430 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/AF_source.fek]]) + -- Retrieve the 'loadFEM' called 'FEMLoad' +loadFEM = app.Models[1].Configurations[1].Loads["FEMLoad"] + -- Manipulate the FEM load data. See 'DataSet' for faster and more comprehensive + options +dataSet = loadFEM:GetDataSet() +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Scale the FEM load current values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.Current = indexedValue.Current * scale +end + -- Store the manipulated data +scaledFEMLoad = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Load) + -- Compare the original FEM load to the manipulated FEM load +graph = app.CartesianGraphs:Add() +loadTrace1 = graph.Traces:Add(loadFEM) +loadTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +loadTrace2 = graph.Traces:Add(scaledFEMLoad) +loadTrace2.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +Inheritance +The LoadFEM object is derived from the LoadData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +Type +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the network values. +Return +DataSet +The data set containing the network values. +GetDataSet (samplePoints number) +Returns a data set containing the network values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +StoreData () +Creates a local stored version of the result data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ResultData +The new stored data. +p.3433 +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadMathScript +Load math script data that can be plotted. +Example +p.3434 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) + -- Create a load math script +loadMathScript = app.MathScripts:Add(pf.Enums.MathScriptTypeEnum.Load) +script = +[[ +dataSet = pf.Load.GetDataSet("Example_Expanded.StandardConfiguration1.EdgeLoad") +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.Power = indexedValue.Power * scale +end +return dataSet +]] +loadMathScript.Script = script +loadMathScript:Run() + -- Plot the math script +graph = app.CartesianGraphs:Add() +excitationTrace1 = graph.Traces:Add(loadMathScript) +excitationTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Voltage +Inheritance +The LoadMathScript object is derived from the MathScript object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Script +Type +The object label. (Read/Write string) +The script code to execute. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. (Returns a MathScript object.) +GetDataSet () +Returns a data set containing the math script values. (Returns a DataSet object.) +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Script +The script code to execute. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. +Return +MathScript +The duplicated math script. +GetDataSet () +Returns a data set containing the math script values. +Return +DataSet +The data set containing the math script values. +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadNetwork +Network load results generated by the Feko Solver. +Example +p.3437 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Retrieve the 'LoadNetwork' called 'NetworkLoad' +loadNetwork = app.Models[1].Configurations[1].Loads["NetworkLoad"] + -- Manipulate the network load data. See 'DataSet' for faster and more + comprehensive options +dataSet = loadNetwork:GetDataSet() +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Scale the network load current values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.Current = indexedValue.Current * scale +end + -- Store the manipulated data +scaledNetworkLoad = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Load) + -- Compare the original network load to the manipulated network load +graph = app.CartesianGraphs:Add() +loadTrace1 = graph.Traces:Add(loadNetwork) +loadTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +loadTrace2 = graph.Traces:Add(scaledNetworkLoad) +loadTrace2.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +Inheritance +The LoadNetwork object is derived from the LoadData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +Type +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the network values. +Return +DataSet +The data set containing the network values. +GetDataSet (samplePoints number) +Returns a data set containing the network values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +StoreData () +Creates a local stored version of the result data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ResultData +The new stored data. +p.3440 +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadParallel +Parallel load results generated by the Feko Solver. +Example +p.3441 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Retrieve the 'LoadParallel' called 'ParallelLoad' +loadParallel = app.Models[1].Configurations[1].Loads["ParallelLoad"] + -- Manipulate the parallel load data. See 'DataSet' for faster and more + comprehensive options +dataSet = loadParallel:GetDataSet() +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Scale the parallel load current values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.Current = indexedValue.Current * scale +end + -- Store the manipulated data +scaledParallelLoad = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Load) + -- Compare the original parallel load to the manipulated parallel load +graph = app.CartesianGraphs:Add() +loadTrace1 = graph.Traces:Add(loadParallel) +loadTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +loadTrace2 = graph.Traces:Add(scaledParallelLoad) +loadTrace2.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +Inheritance +The LoadParallel object is derived from the LoadData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +Type +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the network values. +Return +DataSet +The data set containing the network values. +GetDataSet (samplePoints number) +Returns a data set containing the network values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +StoreData () +Creates a local stored version of the result data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ResultData +The new stored data. +p.3444 +LoadQuantity +The load quantity properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) +loadData = app.Models[1].Configurations[1].Loads[1] + -- Create a cartesian graph and the load data +cartesianGraph = app.CartesianGraphs:Add() +loadTrace = cartesianGraph.Traces:Add(loadData) + -- Configure the trace quantity +loadTrace.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +loadTrace.Quantity.ComplexComponent = pf.Enums.ComplexComponentEnum.Phase +loadTrace.Quantity.PhaseUnwrapped = true +Usage locations +The LoadQuantity object can be accessed from the following locations: +• Properties +◦ LoadTrace object has property Quantity. +◦ NetworkTrace object has property Quantity. +Property List +ComplexComponent +The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. +Magnitude, Phase, Real, Imaginary. (Read/Write ComplexComponentEnum) +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. (Read/Write boolean) +Type +The type of quantity to be plotted, specified by the NetworkQuantityTypeEnum, e.g. Impedance, +Voltage, Current, etc. (Read/Write NetworkQuantityTypeEnum) +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. (Read/Write boolean) +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when the ComplexComponent is Magnitude. (Read/Write boolean) +Property Details +ComplexComponent +The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. +Magnitude, Phase, Real, Imaginary. +Type +ComplexComponentEnum +Access +Read/Write +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +Type +The type of quantity to be plotted, specified by the NetworkQuantityTypeEnum, e.g. Impedance, +Voltage, Current, etc. +Type +NetworkQuantityTypeEnum +Access +Read/Write +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when the ComplexComponent is Magnitude. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadSeries +Series load results generated by the Feko Solver. +Example +p.3447 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Retrieve the 'LoadSeries' called 'SeriesLoad' +loadSeries = app.Models[1].Configurations[1].Loads["SeriesLoad"] + -- Manipulate the series load data. See 'DataSet' for faster and more + comprehensive options +dataSet = loadSeries:GetDataSet() +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Scale the series load current values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.Current = indexedValue.Current * scale +end + -- Store the manipulated data +scaledSeriesLoad = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Load) + -- Compare the original series load to the manipulated series load +graph = app.CartesianGraphs:Add() +loadTrace1 = graph.Traces:Add(loadSeries) +loadTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +loadTrace2 = graph.Traces:Add(scaledSeriesLoad) +loadTrace2.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +Inheritance +The LoadSeries object is derived from the LoadData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +Type +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the network values. +Return +DataSet +The data set containing the network values. +GetDataSet (samplePoints number) +Returns a data set containing the network values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +StoreData () +Creates a local stored version of the result data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ResultData +The new stored data. +p.3450 +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadSmithQuantity +The Smith load quantity properties. +Example +p.3451 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Create a Smith charts with a load trace +graph = app.SmithCharts:Add() +complexLoadTrace = + graph.Traces:Add(app.Models[1].Configurations[1].Loads["ComplexLoad"]) + -- Configure the trace quantity +complexLoadTrace.Quantity.PhaseAdditionEnabled = true +complexLoadTrace.Quantity.Phase = 50 +Usage locations +The LoadSmithQuantity object can be accessed from the following locations: +• Properties +◦ LoadSmithTrace object has property Quantity. +Property List +LoadExpression +The load value to use. The value is a complex expression, e.g. “50+j*0”. (Read/Write Expression) +LoadSubtractionEnabled +Specifies whether the loading value must be subtracted before plotting. (Read/Write boolean) +Phase +The phase to be added to the trace. The value is in degrees [-360,360]. (Read/Write number) +PhaseAdditionEnabled +Enable phase addition for the trace. (Read/Write boolean) +ReferenceImpedanceExpression +The reference impedance value to use. The value is a complex expression, e.g. “50+j*0”. (Read/ +Write Expression) +UseCustomReferenceImpedance +Specifies whether a custom reference impedance should be used. (Read/Write boolean) +Property Details +LoadExpression +The load value to use. The value is a complex expression, e.g. “50+j*0”. +Type +Expression +Access +Read/Write +LoadSubtractionEnabled +Specifies whether the loading value must be subtracted before plotting. +Type +boolean +Access +Read/Write +Phase +The phase to be added to the trace. The value is in degrees [-360,360]. +Type +number +Access +Read/Write +PhaseAdditionEnabled +Enable phase addition for the trace. +Type +boolean +Access +Read/Write +ReferenceImpedanceExpression +The reference impedance value to use. The value is a complex expression, e.g. “50+j*0”. +Type +Expression +Access +Read/Write +UseCustomReferenceImpedance +Specifies whether a custom reference impedance should be used. +Type +boolean +Access +Read/Write +LoadSmithTrace +A load 2D Smith trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Create a Smith charts with a load trace +graph = app.SmithCharts:Add() +complexLoadTrace = + graph.Traces:Add(app.Models[1].Configurations[1].Loads["ComplexLoad"]) + -- Configure the trace quantity +complexLoadTrace.Quantity.PhaseAdditionEnabled = true +complexLoadTrace.Quantity.Phase = 50 +Inheritance +The LoadSmithTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Quantity +The loads trace quantity properties. (Read only LoadSmithQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties table) +p.3455 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Quantity +The loads trace quantity properties. +Type +LoadSmithQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +LoadStoredData +Stored load results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Retrieve the 'LoadSeries' called 'SeriesLoad' +loadSeries = app.Models[1].Configurations[1].Loads["SeriesLoad"] + -- Store a copy of the network data. +storedData = loadSeries:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.Load) +Inheritance +The LoadStoredData object is derived from the ResultData object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the network values. +Return +DataSet +The data set containing the network values. +GetDataSet (samplePoints number) +Returns a data set containing the network values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +LoadTrace +A loads 2D trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) +loadData = app.Models[1].Configurations[1].Loads[1] + -- Create a cartesian graph and the load data +cartesianGraph = app.CartesianGraphs:Add() +loadTrace = cartesianGraph.Traces:Add(loadData) + -- Configure the trace quantity +loadTrace.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +loadTrace.Quantity.ComplexComponent = pf.Enums.ComplexComponentEnum.Phase +Inheritance +The LoadTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The loads trace math expression properties. (Read only TraceMathExpression) +Quantity +The loads trace quantity properties. (Read only LoadQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +p.3465 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The loads trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The loads trace quantity properties. +Type +LoadQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadVertex +Vertex load results generated by the Feko Solver. +Example +p.3470 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Retrieve the 'LoadVertex' called 'L2Load1' +loadVertex = app.Models[1].Configurations[1].Loads["L2Load1"] + -- Manipulate the vertex load data. See 'DataSet' for faster and more + comprehensive options +dataSet = loadVertex:GetDataSet() +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Scale the vertex load current values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.Current = indexedValue.Current * scale +end + -- Store the manipulated data +scaledVertexLoad = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Load) + -- Compare the original vertex load to the manipulated vertex load +graph = app.CartesianGraphs:Add() +loadTrace1 = graph.Traces:Add(loadVertex) +loadTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +loadTrace2 = graph.Traces:Add(scaledVertexLoad) +loadTrace2.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +Inheritance +The LoadVertex object is derived from the LoadData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +Type +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the network values. +Return +DataSet +The data set containing the network values. +GetDataSet (samplePoints number) +Returns a data set containing the network values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +StoreData () +Creates a local stored version of the result data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ResultData +The new stored data. +p.3473 +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadVoxel +Load results generated by the Feko Solver. +Example +p.3474 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/SourceFDTD.fek]]) + -- Get the voxel load and its label, configuration and type +voxelLoad = app.Models[1].Configurations[1].Loads["Load1"] +configurationName = voxelLoad.Configuration +loadLabel = voxelLoad.Label +loadType = voxelLoad.Type +Inheritance +The LoadVoxel object is derived from the LoadData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the network values. +Return +DataSet +The data set containing the network values. +GetDataSet (samplePoints number) +Returns a data set containing the network values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MathScript +Math script data that can be plotted. +Example +p.3477 +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 +Script +The object label. (Read/Write string) +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. +MathTrace +A 2D math trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a graph with a trace +graph = app.CartesianGraphs:Add() +farFieldTrace = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Add a math trace that performs some calculation +mathTrace = graph:AddMathTrace() +mathTrace.Expression = string.format("%s * 1.5", farFieldTrace.Label) +graph:ZoomToExtents() +Inheritance +The MathTrace object is derived from the ResultTrace object. +Usage locations +The MathTrace object can be accessed from the following locations: +• Methods +◦ PolarGraph object has method AddMathTrace(). +◦ CartesianGraph object has method AddMathTrace(). +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +CommonRangeEnabled +Specifies whether the range is limited to the range common to all traces used in the expression. +(Read/Write boolean) +DataSource +The source of the trace. (Read/Write ResultData) +Expression +The math expression used to calculate this trace, e.g. “ramp(0,1,100)”. (Read/Write string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Sampling +p.3481 +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +CommonRangeEnabled +Specifies whether the range is limited to the range common to all traces used in the expression. +Type +boolean +Access +Read/Write +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +Expression +The math expression used to calculate this trace, e.g. “ramp(0,1,100)”. +Type +string +Access +Read/Write +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +Values +p.3484 +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Matrix +A two-dimensional matrix. +Example + -- Create a default 2x2 double matrix of zeros +m1 = pf.Matrix.Zeros(2) + -- Assign values to each element of the matrix +m1[1][1] = 1 +m1[2][1] = 2 +m1[1][2] = 3 +m1[2][2] = 4 + -- Create a 2x2 double matrix with a fill value of 3 +m2 = pf.Matrix(2, 2, 3) + -- Determine the transpose and determinant of the matrix +transpose = m1:Transpose() +determinant = m1:Determinant() + -- Some of the valid operators for 'Matrix' +m3 = m1 * 2 +m4 = m2 * (3 + j) +m5 = m1 + 2 +m6 = m1 - 1 +m7 = m1 + m2 +m8 = m1 - m2 +Usage locations +The Matrix object can be accessed from the following locations: +• Properties +◦ CharacteristicModeTrace object has property Values. +◦ CustomDataSmithTrace object has property Values. +◦ CustomDataTrace object has property Values. +◦ MathTrace object has property Values. +◦ SpiceProbeTrace object has property Values. +◦ FarFieldPowerIntegralTrace object has property Values. +◦ NearFieldPowerIntegralTrace object has property Values. +◦ TRCoefficientTrace object has property Values. +◦ LoadSmithTrace object has property Values. +◦ ExcitationSmithTrace object has property Values. +◦ SARTrace object has property Values. +◦ WireCurrentsTrace object has property Values. +◦ SParameterTrace object has property Values. +◦ PowerTrace object has property Values. +◦ LoadTrace object has property Values. +◦ ExcitationTrace object has property Values. +◦ FarFieldTrace object has property Values. +◦ NearFieldTrace object has property Values. +◦ ReceivingAntennaTrace object has property Values. +◦ NetworkTrace object has property Values. +◦ ResultTrace object has property Values. +◦ ComplexMatrix object has property Im. +◦ ComplexMatrix object has property Re. +◦ ComplexMatrix object has property re. +◦ ComplexMatrix object has property im. +◦ Matrix object has property Im. +◦ Matrix object has property Re. +• Methods +◦ Mesh object has method GetPointMatrixForTriangleMeshIndexList(List of number). +◦ Mesh object has method GetPointMatrixForSegmentMeshIndexList(List of number). +◦ DataSet object has method ToMatrix(List of string). +◦ DataSet object has method ToMatrix(List of string, string). +◦ DataSetIndexer object has method ToMatrix(List of string). +◦ ComplexMatrix object has method Abs(). +◦ ComplexMatrix object has method Magnitude(). +◦ ComplexMatrix object has method Angle(). +◦ ComplexMatrix object has method Imag(). +◦ ComplexMatrix object has method Phase(). +◦ ComplexMatrix object has method Real(). +◦ Matrix object has method Duplicate(). +◦ Matrix object has method Inverse(). +◦ Matrix object has method Transpose(). +◦ Matrix object has method SubMatrix(number, number, number, number). +◦ Matrix object has method Abs(). +◦ Matrix object has method Magnitude(). +◦ Matrix object has method Angle(). +◦ Matrix object has method Imag(). +◦ Matrix object has method Phase(). +◦ Matrix object has method Real(). +• Static functions +◦ ComplexMatrix object has static function GreaterThanOrEqual(ComplexMatrix, ComplexMatrix). +◦ ComplexMatrix object has static function GreaterThan(ComplexMatrix, ComplexMatrix). +◦ ComplexMatrix object has static function LessThanOrEqual(ComplexMatrix, ComplexMatrix). +◦ ComplexMatrix object has static function LessThan(ComplexMatrix, ComplexMatrix). +◦ ComplexMatrix object has static function NotEqual(ComplexMatrix, ComplexMatrix). +◦ ComplexMatrix object has static function IsEqual(ComplexMatrix, ComplexMatrix). +◦ ComplexMatrix object has static function GreaterThanOrEqual(ComplexMatrix, Matrix). +◦ ComplexMatrix object has static function GreaterThan(ComplexMatrix, Matrix). +◦ ComplexMatrix object has static function LessThanOrEqual(ComplexMatrix, Matrix). +◦ ComplexMatrix object has static function LessThan(ComplexMatrix, Matrix). +◦ ComplexMatrix object has static function NotEqual(ComplexMatrix, Matrix). +◦ ComplexMatrix object has static function IsEqual(ComplexMatrix, Matrix). +◦ ComplexMatrix object has static function GreaterThanOrEqual(ComplexMatrix, Complex). +◦ ComplexMatrix object has static function GreaterThan(ComplexMatrix, Complex). +◦ ComplexMatrix object has static function LessThanOrEqual(ComplexMatrix, Complex). +◦ ComplexMatrix object has static function LessThan(ComplexMatrix, Complex). +◦ ComplexMatrix object has static function NotEqual(ComplexMatrix, Complex). +◦ ComplexMatrix object has static function IsEqual(ComplexMatrix, Complex). +◦ ComplexMatrix object has static function GreaterThanOrEqual(ComplexMatrix, number). +◦ ComplexMatrix object has static function GreaterThan(ComplexMatrix, number). +◦ ComplexMatrix object has static function LessThanOrEqual(ComplexMatrix, number). +◦ ComplexMatrix object has static function LessThan(ComplexMatrix, number). +◦ ComplexMatrix object has static function NotEqual(ComplexMatrix, number). +◦ ComplexMatrix object has static function IsEqual(ComplexMatrix, number). +◦ ComplexMatrix object has static function Real(ComplexMatrix). +◦ ComplexMatrix object has static function Imag(ComplexMatrix). +◦ ComplexMatrix object has static function Phase(ComplexMatrix). +◦ ComplexMatrix object has static function Angle(ComplexMatrix). +◦ ComplexMatrix object has static function Magnitude(ComplexMatrix). +◦ ComplexMatrix object has static function Abs(ComplexMatrix). +◦ Matrix object has static function Modulo(Matrix, Matrix). +◦ Matrix object has static function Modulo(Matrix, number). +◦ Matrix object has static function Atan2(Matrix, Matrix). +◦ Matrix object has static function Power(Matrix, Matrix). +◦ Matrix object has static function MultiplyByElement(Matrix, Matrix). +◦ Matrix object has static function Max(Matrix, Matrix). +◦ Matrix object has static function Min(Matrix, Matrix). +◦ Matrix object has static function GreaterThanOrEqual(Matrix, Matrix). +◦ Matrix object has static function GreaterThan(Matrix, Matrix). +◦ Matrix object has static function LessThanOrEqual(Matrix, Matrix). +◦ Matrix object has static function LessThan(Matrix, Matrix). +◦ Matrix object has static function NotEqual(Matrix, Matrix). +◦ Matrix object has static function IsEqual(Matrix, Matrix). +◦ Matrix object has static function MultiplyByElement(Matrix, number). +◦ Matrix object has static function Power(Matrix, number). +◦ Matrix object has static function GreaterThanOrEqual(Matrix, number). +◦ Matrix object has static function GreaterThan(Matrix, number). +◦ Matrix object has static function LessThanOrEqual(Matrix, number). +◦ Matrix object has static function LessThan(Matrix, number). +◦ Matrix object has static function NotEqual(Matrix, number). +◦ Matrix object has static function IsEqual(Matrix, number). +◦ Matrix object has static function Negate(Matrix). +◦ Matrix object has static function Magnitude(Matrix). +◦ Matrix object has static function Abs(Matrix). +◦ Matrix object has static function Zeros(number). +◦ Matrix object has static function Ones(number). +◦ Matrix object has static function Diagonal(List of number). +◦ Matrix object has static function Identity(number). +◦ Matrix object has static function New(number, List of number). +◦ Matrix object has static function New(List of number, number). +◦ Matrix object has static function New(number, number, number). +◦ Matrix object has static function New(number, number). +◦ Matrix object has static function Tan(Matrix). +◦ Matrix object has static function Sqrt(Matrix). +◦ Matrix object has static function Sin(Matrix). +◦ Matrix object has static function Log10(Matrix). +◦ Matrix object has static function Log(Matrix). +◦ Matrix object has static function Floor(Matrix). +◦ Matrix object has static function Exponent(Matrix). +◦ Matrix object has static function Ceil(Matrix). +◦ Matrix object has static function Cos(Matrix). +◦ Matrix object has static function Atan(Matrix). +◦ Matrix object has static function Asin(Matrix). +◦ Matrix object has static function Acos(Matrix). +Property List +ColumnCount +The number of columns in the matrix. (Read only number) +Im +Re +The imaginary component of the complex matrix. (Read/Write Matrix) +The real component of the complex matrix. (Read/Write Matrix) +RowCount +The number of rows in the matrix. (Read only number) +Type +The object type string. (Read only string) +Method List +Abs () +Calculate the absolute value of all the entries in the matrix. (Returns a Matrix object.) +Angle () +Calculate the angle of all the entries in the matrix. (Returns a Matrix object.) +Conj () +Calculate the conjugate of all the entries in the matrix. (Returns a ComplexMatrix object.) +Determinant () +Calculate the determinant of the matrix. (Returns a number object.) +Duplicate () +Duplicate the matrix. (Returns a Matrix object.) +ExportMatFile (filename string, varname string) +Writes the given ComplexMatrix object to a *.mat file. (Returns a boolean object.) +FFT () +Calculates the fast Fourier transform of the column or row matrix. For a matrix containing multiple +columns and rows, the fast Fourier transform will be calculated for each of the columns. (Returns +a ComplexMatrix object.) +IFFT () +Calculates the inverse fast Fourier transform of the column or row matrix. For a matrix containing +multiple columns and rows, the inverse fast Fourier transform will be calculated for each of the +columns. (Returns a ComplexMatrix object.) +Imag () +Extract the imaginary part of all the entries in the matrix. (Returns a Matrix object.) +Inverse () +Calculate the inverse matrix. (Returns a Matrix object.) +Magnitude () +Calculate the magnitude of all the entries in the matrix. (Returns a Matrix object.) +Max () +Extracts the maximum from the matrix. (Returns a number object.) +Mean () +Calculates the mean value of the elements of the matrix. (Returns a number object.) +Min () +Extracts the minimum from the matrix. (Returns a number object.) +Phase () +Calculate the phase of all the entries in the matrix. (Returns a Matrix object.) +Real () +Extract the real part of all the entries in the matrix. (Returns a Matrix object.) +ReplaceSubMatrix (matrix Matrix, rowstart number, columnstart number) +Replace the sub matrix starting at the given indices with the provided matrix. +SubMatrix (rowstart number, rowend number, columnstart number, columnend number) +Obtain the sub matrix from the given parameters. (Returns a Matrix object.) +Sum () +Calculates the sum of all the elements of the matrix. (Returns a number object.) +Transpose () +Calculate the transpose of the matrix. (Returns a Matrix object.) +Constructor Function List +Diagonal (values List of number) +Creates a diagonal matrix. (Returns a Matrix object.) +Identity (size number) +Creates an identity matrix. (Returns a Matrix object.) +New (rows number, columnValues List of number) +Creates a new matrix. (Returns a Matrix object.) +New (rowValues List of number, columns number) +Creates a new matrix. (Returns a Matrix object.) +New (rows number, columns number, fill number) +Creates a new matrix. (Returns a Matrix object.) +New (rows number, columns number) +Creates a new matrix with uninitialised elements. (Returns a Matrix object.) +Ones (size number) +Creates a new matrix filled with ones. (Returns a Matrix object.) +Zeros (size number) +Creates a new matrix filled with zeros. (Returns a Matrix object.) +Static Function List +Abs (matrix Matrix) +Calculates the absolute value of each entry. (Returns a Matrix object.) +Acos (matrix Matrix) +Calculate the arc cosine of all the entries in the matrix. (Returns a Matrix object.) +Asin (matrix Matrix) +Calculate the arc sine of all the entries in the matrix. (Returns a Matrix object.) +Atan (matrix Matrix) +Calculate the arc tangent of all the entries in the matrix. (Returns a Matrix object.) +Atan2 (matrix Matrix, matrix Matrix) +Calculate the arc tangent of all the entries in the matrix. (Returns a Matrix object.) +Ceil (matrix Matrix) +Calculate the ceiling of all the elements in the matrix. (Returns a Matrix object.) +Cos (matrix Matrix) +Calculate the cosine of all the entries in the matrix. (Returns a Matrix object.) +Exponent (matrix Matrix) +Calculate the exponent of all the entries in the matrix. (Returns a Matrix object.) +Find (matrix Matrix) +Finds all entries in the matrix that are non-zero. (Returns a table object.) +Floor (matrix Matrix) +Calculate the floor of all the entries in the matrix. (Returns a Matrix object.) +GreaterThan (matrix Matrix, matrix Matrix) +Determines if the entries of two matrices are greater than each other. (Returns a Matrix object.) +GreaterThan (matrix Matrix, value number) +Determines if a matrix has entries greater than the specified value. (Returns a Matrix object.) +GreaterThanOrEqual (matrix Matrix, matrix Matrix) +Determines if the entries of two matrices are greater than or equal to each other. (Returns a +Matrix object.) +GreaterThanOrEqual (matrix Matrix, value number) +Determines if a matrix has entries greater than or equal to the specified value. (Returns a Matrix +object.) +IsEqual (matrix Matrix, matrix Matrix) +Determines if the entries of two matrices are equal. (Returns a Matrix object.) +IsEqual (matrix Matrix, value number) +Determines if a matrix has entries equal to the specified value. (Returns a Matrix object.) +LessThan (matrix Matrix, matrix Matrix) +Determines if the entries of two matrices are less than each other. (Returns a Matrix object.) +LessThan (matrix Matrix, value number) +Determines if a matrix has entries less than the specified value. (Returns a Matrix object.) +LessThanOrEqual (matrix Matrix, matrix Matrix) +Determines if the entries of two matrices are less than or equal to each other. (Returns a Matrix +object.) +LessThanOrEqual (matrix Matrix, value number) +Determines if a matrix has entries less than or equal to the specified value. (Returns a Matrix +object.) +Log (matrix Matrix) +Calculate the log of all the entries in the matrix. (Returns a Matrix object.) +Log10 (matrix Matrix) +Calculate the log10 of all the entries in the matrix. (Returns a Matrix object.) +Magnitude (matrix Matrix) +Calculates the magnitude value of each entry. (Returns a Matrix object.) +Max (matrix Matrix, matrix Matrix) +Calculate the maximum of two corresponding entries from two matrices. (Returns a Matrix +object.) +Max (matrix Matrix) +Calculate the maximum of all the entries in the matrix. (Returns a number object.) +Mean (matrix Matrix) +Calculate the mean of all the entries in the matrix. (Returns a number object.) +Min (matrix Matrix, matrix Matrix) +Calculate the minimum of two corresponding entries from two matrices. (Returns a Matrix object.) +Min (matrix Matrix) +Calculate the minimum of all the entries in the matrix. (Returns a number object.) +Modulo (matrix Matrix, matrix Matrix) +Calculates the Modulo of each entry with the corresponding entry in the second matrix. (Returns a +Matrix object.) +Modulo (matrix Matrix, value number) +Calculates the Modulo of each entry with the value. (Returns a Matrix object.) +MultiplyByElement (matrix Matrix, matrix Matrix) +Calculate the exponent of all the elements in the matrix. (Returns a Matrix object.) +MultiplyByElement (matrix Matrix, value number) +Calculate the exponent of all the elements in the matrix. (Returns a Matrix object.) +Negate (matrix Matrix) +Negate each entry of the matrix. (Returns a Matrix object.) +NotEqual (matrix Matrix, matrix Matrix) +Determines if the entries of two matrices are not equal. (Returns a Matrix object.) +NotEqual (matrix Matrix, value number) +Determines if a matrix has entries not equal to the specified value. (Returns a Matrix object.) +Power (matrix Matrix, matrix Matrix) +Raise all entries of the first matrix to the power of each entry in the second matrix. (Returns a +Matrix object.) +Power (matrix Matrix, exponent number) +Raise each entry to the power of the exponent. (Returns a Matrix object.) +Sin (matrix Matrix) +Calculate the sine of all the entries in the matrix. (Returns a Matrix object.) +Sqrt (matrix Matrix) +Calculate the square root of all the entries in the matrix. (Returns a Matrix object.) +Sum (matrix Matrix) +Calculate the sum of all the entries in the matrix. (Returns a number object.) +Tan (matrix Matrix) +Calculate the tan of all the entries in the matrix. (Returns a Matrix object.) +Index List +[number] +Access the specified row in the matrix. (Read MatrixIndexer) +Property Details +ColumnCount +The number of columns in the matrix. +Type +number +Access +Read only +Im +Re +The imaginary component of the complex matrix. +Type +Matrix +Access +Read/Write +The real component of the complex matrix. +Type +Matrix +Access +Read/Write +RowCount +The number of rows in the matrix. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Abs () +Calculate the absolute value of all the entries in the matrix. +Return +Matrix +The absolute value. +Angle () +Calculate the angle of all the entries in the matrix. +Return +Matrix +The angle. +Conj () +Calculate the conjugate of all the entries in the matrix. +Return +ComplexMatrix +The conjugate. +Determinant () +Calculate the determinant of the matrix. +Return +number +The determinant of the matrix. +Duplicate () +Duplicate the matrix. +Return +Matrix +The duplicated matrix. +ExportMatFile (filename string, varname string) +Writes the given ComplexMatrix object to a *.mat file. +Input Parameters +filename(string) +The name of the file. +varname(string) +The name of the variable to export. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +boolean +Boolean indicating success. +FFT () +p.3496 +Calculates the fast Fourier transform of the column or row matrix. For a matrix containing multiple +columns and rows, the fast Fourier transform will be calculated for each of the columns. +Return +ComplexMatrix +The calculated FFT complex matrix. +IFFT () +Calculates the inverse fast Fourier transform of the column or row matrix. For a matrix containing +multiple columns and rows, the inverse fast Fourier transform will be calculated for each of the +columns. +Return +ComplexMatrix +The calculated IFFT complex matrix. +Imag () +Extract the imaginary part of all the entries in the matrix. +Return +Matrix +The imaginary value. +Inverse () +Calculate the inverse matrix. +Return +Matrix +The inverse of the matrix. +Magnitude () +Calculate the magnitude of all the entries in the matrix. +Return +Matrix +The magnitude value. +Max () +Extracts the maximum from the matrix. +Return +number +The maximum value. +Mean () +Calculates the mean value of the elements of the matrix. +Return +number +The mean value. +Min () +Extracts the minimum from the matrix. +Return +number +The minimum value. +Phase () +Calculate the phase of all the entries in the matrix. +Return +Matrix +The phase. +Real () +Extract the real part of all the entries in the matrix. +Return +Matrix +The real value. +ReplaceSubMatrix (matrix Matrix, rowstart number, columnstart number) +Replace the sub matrix starting at the given indices with the provided matrix. +Input Parameters +matrix(Matrix) +The new sub matrix. +rowstart(number) +Starting row index of the sub matrix. +columnstart(number) +Starting column index of the sub matrix. +SubMatrix (rowstart number, rowend number, columnstart number, columnend number) +Obtain the sub matrix from the given parameters. +Input Parameters +rowstart(number) +Row start index. +rowend(number) +Row end index. +columnstart(number) +Column start index. +columnend(number) +Column end index. +Return +Matrix +The sub matrix. +Sum () +Calculates the sum of all the elements of the matrix. +Return +number +The sum. +Transpose () +Calculate the transpose of the matrix. +Return +Matrix +The transpose of the matrix. +Static Function Details +Abs (matrix Matrix) +Calculates the absolute value of each entry. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +Acos (matrix Matrix) +Calculate the arc cosine of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +Asin (matrix Matrix) +Calculate the arc sine of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +Atan (matrix Matrix) +Calculate the arc tangent of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +Atan2 (matrix Matrix, matrix Matrix) +Calculate the arc tangent of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The first matrix. +matrix(Matrix) +The second matrix. +Return +Matrix +The result matrix. +Ceil (matrix Matrix) +Calculate the ceiling of all the elements in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +Cos (matrix Matrix) +Calculate the cosine of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +Diagonal (values List of number) +Creates a diagonal matrix. +Input Parameters +values(List of number) +The values to fill the matrix. +Return +Matrix +The new matrix. +Exponent (matrix Matrix) +Calculate the exponent of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +Find (matrix Matrix) +Finds all entries in the matrix that are non-zero. +Input Parameters +matrix(Matrix) +The matrix. +Return +table +The result matrix. +Floor (matrix Matrix) +Calculate the floor of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +GreaterThan (matrix Matrix, matrix Matrix) +Determines if the entries of two matrices are greater than each other. +Input Parameters +matrix(Matrix) +The first matrix. +matrix(Matrix) +The matrix used to test each entry. +Return +Matrix +One and zero filled matrix. +GreaterThan (matrix Matrix, value number) +Determines if a matrix has entries greater than the specified value. +Input Parameters +matrix(Matrix) +The first matrix. +value(number) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +GreaterThanOrEqual (matrix Matrix, matrix Matrix) +Determines if the entries of two matrices are greater than or equal to each other. +Input Parameters +matrix(Matrix) +The first matrix. +matrix(Matrix) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +GreaterThanOrEqual (matrix Matrix, value number) +Determines if a matrix has entries greater than or equal to the specified value. +Input Parameters +matrix(Matrix) +The first matrix. +value(number) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +Identity (size number) +Creates an identity matrix. +Input Parameters +size(number) +The size of the matrix. +Return +Matrix +The new matrix. +IsEqual (matrix Matrix, matrix Matrix) +Determines if the entries of two matrices are equal. +Input Parameters +matrix(Matrix) +The first matrix. +matrix(Matrix) +The second matrix. +Return +Matrix +One and zero filled matrix. +IsEqual (matrix Matrix, value number) +Determines if a matrix has entries equal to the specified value. +Input Parameters +matrix(Matrix) +The matrix. +value(number) +The value used to test each entry. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Matrix +One and zero filled matrix. +LessThan (matrix Matrix, matrix Matrix) +Determines if the entries of two matrices are less than each other. +p.3503 +Input Parameters +matrix(Matrix) +The first matrix. +matrix(Matrix) +The matrix used to test each entry. +Return +Matrix +One and zero filled matrix. +LessThan (matrix Matrix, value number) +Determines if a matrix has entries less than the specified value. +Input Parameters +matrix(Matrix) +The first matrix. +value(number) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +LessThanOrEqual (matrix Matrix, matrix Matrix) +Determines if the entries of two matrices are less than or equal to each other. +Input Parameters +matrix(Matrix) +The first matrix. +matrix(Matrix) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +LessThanOrEqual (matrix Matrix, value number) +Determines if a matrix has entries less than or equal to the specified value. +Input Parameters +matrix(Matrix) +The first matrix. +value(number) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +Log (matrix Matrix) +Calculate the log of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +Log10 (matrix Matrix) +Calculate the log10 of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +Magnitude (matrix Matrix) +Calculates the magnitude value of each entry. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +Max (matrix Matrix, matrix Matrix) +Calculate the maximum of two corresponding entries from two matrices. +Input Parameters +matrix(Matrix) +The first matrix. +matrix(Matrix) +The second matrix. +Return +Matrix +The result matrix. +Max (matrix Matrix) +Calculate the maximum of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +number +The maximum value. +Mean (matrix Matrix) +Calculate the mean of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +number +The mean value. +Min (matrix Matrix, matrix Matrix) +Calculate the minimum of two corresponding entries from two matrices. +Input Parameters +matrix(Matrix) +The first matrix. +matrix(Matrix) +The second matrix. +Return +Matrix +The result matrix. +Min (matrix Matrix) +Calculate the minimum of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +number +The minimum value. +Modulo (matrix Matrix, matrix Matrix) +Calculates the Modulo of each entry with the corresponding entry in the second matrix. +Input Parameters +matrix(Matrix) +The first matrix. +matrix(Matrix) +The second matrix. +Return +Matrix +The result matrix. +Modulo (matrix Matrix, value number) +Calculates the Modulo of each entry with the value. +Input Parameters +matrix(Matrix) +The matrix. +value(number) +The value used to do the modulus on each entry in the matrix. +Return +Matrix +The result matrix. +MultiplyByElement (matrix Matrix, matrix Matrix) +Calculate the exponent of all the elements in the matrix. +Input Parameters +matrix(Matrix) +The matrix used to perform operation. +matrix(Matrix) +The multiply matrix. +Return +Matrix +The result of the two matrices entries multiplied with each other. +MultiplyByElement (matrix Matrix, value number) +Calculate the exponent of all the elements in the matrix. +Input Parameters +matrix(Matrix) +The matrix used to perform operation. +value(number) +The value that will be multiplied to each of the entries in the matrix. +Return +Matrix +The result of all the entries multiplied by the scalar value. +Negate (matrix Matrix) +Negate each entry of the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +New (rows number, columnValues List of number) +Creates a new matrix. +Input Parameters +rows(number) +The number of rows in the matrix. Each column value will be duplicated for every row. +columnValues(List of number) +The values to place in each of the columns. +Return +Matrix +The new matrix. +New (rowValues List of number, columns number) +Creates a new matrix. +Input Parameters +rowValues(List of number) +The values to place in each of the rows. +Altair Feko 2022.3 +2 Application Programming Interface (API) +columns(number) +p.3508 +The number of columns in the matrix. Each row value will be duplicated for every +column. +Return +Matrix +The new matrix. +New (rows number, columns number, fill number) +Creates a new matrix. +Input Parameters +rows(number) +The number of rows in the matrix. +columns(number) +The number of columns in the matrix. +fill(number) +The value used to fill the matrix. +Return +Matrix +The new matrix. +New (rows number, columns number) +Creates a new matrix with uninitialised elements. +Input Parameters +rows(number) +The number of rows in the matrix. +columns(number) +The number of columns in the matrix. +Return +Matrix +The new matrix. +NotEqual (matrix Matrix, matrix Matrix) +Determines if the entries of two matrices are not equal. +Input Parameters +matrix(Matrix) +The first matrix. +matrix(Matrix) +The second matrix. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Matrix +One and zero filled matrix. +NotEqual (matrix Matrix, value number) +Determines if a matrix has entries not equal to the specified value. +p.3509 +Input Parameters +matrix(Matrix) +The matrix. +value(number) +The value used to test each entry. +Return +Matrix +One and zero filled matrix. +Ones (size number) +Creates a new matrix filled with ones. +Input Parameters +size(number) +The size of the matrix. +Return +Matrix +The new matrix. +Power (matrix Matrix, matrix Matrix) +Raise all entries of the first matrix to the power of each entry in the second matrix. +Input Parameters +matrix(Matrix) +The first matrix. +matrix(Matrix) +The second matrix. +Return +Matrix +The power of all the elements in the matrix. +Power (matrix Matrix, exponent number) +Raise each entry to the power of the exponent. +Input Parameters +matrix(Matrix) +The matrix. +exponent(number) +The exponent. +Return +Matrix +The result matrix. +Sin (matrix Matrix) +Calculate the sine of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +Sqrt (matrix Matrix) +Calculate the square root of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +Sum (matrix Matrix) +Calculate the sum of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +number +The sum. +Tan (matrix Matrix) +Calculate the tan of all the entries in the matrix. +Input Parameters +matrix(Matrix) +The matrix. +Return +Matrix +The result matrix. +Zeros (size number) +Creates a new matrix filled with zeros. +Input Parameters +size(number) +The size of the matrix. +Return +Matrix +The new matrix. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MatrixIndexer +p.3512 +This is an intermediate object that allows convenient indexing of multidimensional matrices. +Example + -- Create a default 2x2 double matrix of ones +m1 = pf.Matrix.Zeros(2) + -- Assign values to each element of the matrix +m1[1][1] = 1 +m1[2][1] = 2 +m1[1][2] = 3 +m1[2][2] = 4 +Property List +Type +The object type string. (Read only string) +Index List +[number] +Access a value at the specified indices in the matrix. (Read number) +[number] +Access a value at the specified indices in the matrix. (Write number) +Property Details +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +Mesh +A mesh consisting of mesh entities that represents the simulated model. +Example +p.3513 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +sConf = app.Models["startup"].Configurations[1] +mesh = sConf.Mesh +points = mesh.Points + -- Iterate through 'TriangleFaces' and print the first two 'Triangles' + -- vertex indices as well as their locations +TriangleFaces_count = mesh.TriangleFaces.Count +for i = 1, TriangleFaces_count do + triangle = mesh.TriangleFaces[i].Triangles -- Create a member to ensure the best + performance + for j = 1, 2 do + print("Triangle "..j) + print(triangle[j]) + print("Vertex locations") + print(points[triangle[j].VertexIndices[1]]) -- Accessing member here will be + faster than + print(points[triangle[j].VertexIndices[2]]) -- querying the mesh for its + points each time + print(points[triangle[j].VertexIndices[3]]) + end +end +Usage locations +The Mesh object can be accessed from the following locations: +• Properties +◦ SolutionConfiguration object has property Mesh. +Property List +Points +The collection of mesh points that form the mesh model. (Read only Points) +Type +The object type string. (Read only string) +Collection List +CubeRegions +The collection of regions meshed with cubes. The regions that form part of the mesh model. +(MeshCubeRegionCollection of MeshCubeRegion.) +CurvilinearSegmentWires +The collection of wires meshed with curvilinear segments. The wires form part of the mesh model. +(MeshCurvilinearSegmentWireCollection of MeshCurvilinearSegmentWire.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +CurvilinearTriangleFaces +p.3514 +The collection of faces meshed with curvilinear triangles. The faces form part of the mesh model. +(MeshCurvilinearTriangleFaceCollection of MeshCurvilinearTriangleFace.) +SegmentWires +The collection of wires meshed with segments. The wires form part of the mesh model. +(MeshSegmentWireCollection of MeshSegmentWire.) +TetrahedronRegions +The collection of regions meshed with tetrahedra. The regions form part of the mesh model. +(MeshTetrahedronRegionCollection of MeshTetrahedronRegion.) +TriangleFaces +The collection of faces meshed with flat triangles. The faces form part of the mesh model. +(MeshTriangleFaceCollection of MeshTriangleFace.) +UnmeshedCylinderRegions +The collection of unmeshed cylinders that form part of the mesh model. +(MeshUnmeshedCylinderRegionCollection of MeshUnmeshedCylinderRegion.) +UnmeshedPolygonFaces +The collection of unmeshed faces that form part of the mesh model. +(MeshUnmeshedPolygonFaceCollection of MeshUnmeshedPolygonFace.) +Method List +GetPointMatrixForSegmentMeshIndexList (indexlist List of number) +Creates a matrix of points for the given segment mesh index list. (Returns a Matrix object.) +GetPointMatrixForTriangleMeshIndexList (indexlist List of number) +Creates a matrix of points for the given triangle mesh index list. (Returns a Matrix object.) +Property Details +Points +The collection of mesh points that form the mesh model. +Type +Points +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +CubeRegions +The collection of regions meshed with cubes. The regions that form part of the mesh model. +Type +MeshCubeRegionCollection +CurvilinearSegmentWires +The collection of wires meshed with curvilinear segments. The wires form part of the mesh model. +Type +MeshCurvilinearSegmentWireCollection +CurvilinearTriangleFaces +The collection of faces meshed with curvilinear triangles. The faces form part of the mesh model. +Type +MeshCurvilinearTriangleFaceCollection +SegmentWires +The collection of wires meshed with segments. The wires form part of the mesh model. +Type +MeshSegmentWireCollection +TetrahedronRegions +The collection of regions meshed with tetrahedra. The regions form part of the mesh model. +Type +MeshTetrahedronRegionCollection +TriangleFaces +The collection of faces meshed with flat triangles. The faces form part of the mesh model. +Type +MeshTriangleFaceCollection +UnmeshedCylinderRegions +The collection of unmeshed cylinders that form part of the mesh model. +Type +MeshUnmeshedCylinderRegionCollection +UnmeshedPolygonFaces +The collection of unmeshed faces that form part of the mesh model. +Type +MeshUnmeshedPolygonFaceCollection +Method Details +GetPointMatrixForSegmentMeshIndexList (indexlist List of number) +Creates a matrix of points for the given segment mesh index list. +Input Parameters +indexlist(List of number) +A mesh index list. +Return +Matrix +A point matrix. +GetPointMatrixForTriangleMeshIndexList (indexlist List of number) +Creates a matrix of points for the given triangle mesh index list. +Input Parameters +indexlist(List of number) +A mesh index list. +Return +Matrix +A point matrix. +MeshCube +A cube in 3D space. Exists as part of a mesh. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cube_example1.fek]]) +sConf = app.Models["Cube_example1"].Configurations[1] +mesh = sConf.Mesh +meshCubeRegion = mesh.CubeRegions[1] + -- Get one of the 'MeshCube's from the 'MeshCubeRegion' +meshCube = meshCubeRegion.Cubes[1] + -- Query the index of the third vertex +thirdIndex = meshCube.VertexIndices[3] +Property List +Type +The object type string. (Read only string) +VertexIndices +Returns a list of the vertex indices of the cube. (Read only List of number) +Property Details +Type +The object type string. +Type +string +Access +Read only +VertexIndices +Returns a list of the vertex indices of the cube. +Access +Read only +MeshCubeRegion +A mesh entity representing a region meshed with cubes. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cube_example1.fek]]) +sConf = app.Models["Cube_example1"].Configurations[1] +mesh = sConf.Mesh + -- Get a 'MeshCubeRegion' of a specified mesh entity +meshCubeRegion = mesh.CubeRegions[1] + -- Get the label of the 'MeshCubeRegion' and the number of 'Cubes' + -- contained the 'MeshCubeRegion'. +label = meshCubeRegion.Label +count = meshCubeRegion.Cubes.Count +Inheritance +The MeshCubeRegion object is derived from the MeshEntity object. +Usage locations +The MeshCubeRegion object can be accessed from the following locations: +• Methods +◦ MeshCubeRegionCollection collection has method Items(). +◦ MeshCubeRegionCollection collection has method Item(number). +◦ MeshCubeRegionCollection collection has method Item(string). +Property List +Cubes +The collection of mesh cubes that form the mesh cube region. (Read only MeshCubes) +Label +Type +The object label. (Read only string) +The object type string. (Read only string) +Property Details +Cubes +The collection of mesh cubes that form the mesh cube region. +Type +MeshCubes +Access +Read only +Label +The object label. +Type +string +Access +Read only +Type +The object type string. +Type +string +Access +Read only +MeshCubes +The list of mesh cubes. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cube_example1.fek]]) +sConf = app.Models["Cube_example1"].Configurations[1] +mesh = sConf.Mesh +meshCubeRegion = mesh.CubeRegions[1] + -- Get the list of of the 'MeshCube's from the 'MeshCubeRegion' +meshCubes = meshCubeRegion.Cubes + -- Query the number of cubes in the region +numberOfCubes = meshCubes.Count +Usage locations +The MeshCubes object can be accessed from the following locations: +• Properties +◦ MeshCubeRegion object has property Cubes. +Property List +Count +Type +The number of cubes in the mesh entity. (Read only number) +The object type string. (Read only string) +Index List +[number] +Returns the Cube at the given index. (Read MeshCube) +Property Details +Count +The number of cubes in the mesh entity. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +MeshCurvilinearSegment +A curvilinear segment in 3D space. Exists as part of a mesh. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Helix_dipole.fek]]) +sConf = app.Models["Helix_dipole"].Configurations[1] +mesh = sConf.Mesh +meshCurvilinearWireSegment = mesh.CurvilinearSegmentWires[1] + -- Get a 'MeshCurvilinearSegment' +meshCurvilinearSegment = meshCurvilinearWireSegment.CurvilinearSegments[1] + -- Query the index of the second vertex +secondIndex = meshCurvilinearSegment.VertexIndices[2] +Property List +Type +The object type string. (Read only string) +VertexIndices +Returns a list of the vertex indices of the segment. The first two are the vertex indices at the +segment end points and the third is the midpoint vertex index. (Read only List of number) +Property Details +Type +The object type string. +Type +string +Access +Read only +VertexIndices +Returns a list of the vertex indices of the segment. The first two are the vertex indices at the +segment end points and the third is the midpoint vertex index. +Access +Read only +MeshCurvilinearSegmentWire +A mesh entity representing a wire meshed using curvilinear segments. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Helix_dipole.fek]]) +sConf = app.Models["Helix_dipole"].Configurations[1] +mesh = sConf.Mesh + -- Get one of the 'MeshCurvilinearWire's in the mesh +meshCurvilinearWireSegment = mesh.CurvilinearSegmentWires[1] + -- Query the label +label = meshCurvilinearWireSegment.Label +Inheritance +The MeshCurvilinearSegmentWire object is derived from the MeshEntity object. +Usage locations +The MeshCurvilinearSegmentWire object can be accessed from the following locations: +• Methods +◦ MeshCurvilinearSegmentWireCollection collection has method Items(). +◦ MeshCurvilinearSegmentWireCollection collection has method Item(number). +◦ MeshCurvilinearSegmentWireCollection collection has method Item(string). +Property List +CurvilinearSegments +The collection of mesh segments that form the mesh wire. (Read only MeshCurvilinearSegments) +Label +Type +The object label. (Read only string) +The object type string. (Read only string) +Property Details +CurvilinearSegments +The collection of mesh segments that form the mesh wire. +Type +MeshCurvilinearSegments +Access +Read only +Label +The object label. +Type +string +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshCurvilinearSegments +The list of mesh curvilinear segments. +Example +p.3525 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Helix_dipole.fek]]) +sConf = app.Models["Helix_dipole"].Configurations[1] +mesh = sConf.Mesh +meshCurvilinearWireSegment = mesh.CurvilinearSegmentWires[1] + -- Get the 'MeshCurvilinearSegments' from the 'MeshCurvilinearWireSegment' +meshCurvilinearSegments = meshCurvilinearWireSegment.CurvilinearSegments + -- Query the number of segments in the collection +numberOfSegments = meshCurvilinearSegments.Count +Usage locations +The MeshCurvilinearSegments object can be accessed from the following locations: +• Properties +◦ MeshCurvilinearSegmentWire object has property CurvilinearSegments. +Property List +Count +Type +The number of curvilinear segments in the mesh entity. (Read only number) +The object type string. (Read only string) +Index List +[number] +Returns the CurvilinearSegment at the given index. (Read MeshCurvilinearSegment) +Property Details +Count +The number of curvilinear segments in the mesh entity. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshCurvilinearTriangle +p.3527 +A curvilinear triangle in 3D space defined by three corner points and three midpoints halfway along each +side. Exists as part of a mesh. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME.."/shared/Resources/Automation/ +RCS_of_a_Curvilinear_Dielectric_Sphere.fek") +sConf = app.Models["RCS_of_a_Curvilinear_Dielectric_Sphere"].Configurations[1] +mesh = sConf.Mesh + -- Get the vertices of a 'MeshCurvilinearTriangle' +vertices = mesh.CurvilinearTriangleFaces[1].CurvilinearTriangles[1].VertexIndices +Property List +Type +The object type string. (Read only string) +VertexIndices +Returns a list of the vertex indices of the triangle. The first three [1 to 3] indices are corner +indices. The next three indices are midpoints. Index 4 references the midpoint between the points +referenced by indices 1 and 2, index 5 is between 2 and 3, while index 6 is between 3 and 1. +(Read only List of number) +Property Details +Type +The object type string. +Type +string +Access +Read only +VertexIndices +Returns a list of the vertex indices of the triangle. The first three [1 to 3] indices are corner +indices. The next three indices are midpoints. Index 4 references the midpoint between the points +referenced by indices 1 and 2, index 5 is between 2 and 3, while index 6 is between 3 and 1. +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshCurvilinearTriangleFace +A mesh entity representing a face meshed using curvilinear triangles. +Example +p.3528 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME.."/shared/Resources/Automation/ +RCS_of_a_Curvilinear_Dielectric_Sphere.fek") +sConf = app.Models["RCS_of_a_Curvilinear_Dielectric_Sphere"].Configurations[1] +mesh = sConf.Mesh + -- Get the label of the specified mesh entity +label = mesh.CurvilinearTriangleFaces[1].Label + -- Get the number of curvilinear triangles of the specified mesh entity +count = mesh.CurvilinearTriangleFaces[1].CurvilinearTriangles.Count +Inheritance +The MeshCurvilinearTriangleFace object is derived from the MeshEntity object. +Usage locations +The MeshCurvilinearTriangleFace object can be accessed from the following locations: +• Methods +◦ MeshCurvilinearTriangleFaceCollection collection has method Items(). +◦ MeshCurvilinearTriangleFaceCollection collection has method Item(number). +◦ MeshCurvilinearTriangleFaceCollection collection has method Item(string). +Property List +CurvilinearTriangles +The collection of curvilinear mesh triangles that form the curvilinear mesh face. (Read only +MeshCurvilinearTriangles) +Label +Type +The object label. (Read only string) +The object type string. (Read only string) +Property Details +CurvilinearTriangles +The collection of curvilinear mesh triangles that form the curvilinear mesh face. +Type +MeshCurvilinearTriangles +Access +Read only +Label +The object label. +Type +string +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshCurvilinearTriangles +The list of mesh curvilinear triangles. +Example +p.3530 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME.."/shared/Resources/Automation/ +RCS_of_a_Curvilinear_Dielectric_Sphere.fek") +sConf = app.Models["RCS_of_a_Curvilinear_Dielectric_Sphere"].Configurations[1] +mesh = sConf.Mesh + -- Get the number of curvilinear triangles on a meshed face +count = mesh.CurvilinearTriangleFaces[1].CurvilinearTriangles.Count + -- Get a handle on a particular 'MeshCurvilinearTriangle' +triangle = mesh.CurvilinearTriangleFaces[1].CurvilinearTriangles[3] +Usage locations +The MeshCurvilinearTriangles object can be accessed from the following locations: +• Properties +◦ MeshCurvilinearTriangleFace object has property CurvilinearTriangles. +Property List +Count +Type +The number of curvilinear triangles in the mesh entity. (Read only number) +The object type string. (Read only string) +Index List +[number] +Returns the CurvilinearTriangle at the given index. (Read MeshCurvilinearTriangle) +Property Details +Count +The number of curvilinear triangles in the mesh entity. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshCylinder +p.3532 +A cylinder in 3D space. A geometry cylinder's mesh equivalent that can be directly interpreted by the +solver (e.g. using the UTD solution method). +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Infinite_Cylinder_a.fek]]) +mesh = app.Models["Infinite_Cylinder_a"].Configurations[1].Mesh + -- Get a 'MeshCylinder' of a specified mesh entity +meshCylinder = mesh.UnmeshedCylinderRegions[1].Cylinders[1] + -- Get the 'VertexIndices' contained the 'MeshCylinder'. +vertices = meshCylinder.VertexIndices +Property List +Type +The object type string. (Read only string) +VertexIndices +Returns the two vertex indices defining a line down the centre of the cylinder. (Read only List of +number) +Property Details +Type +The object type string. +Type +string +Access +Read only +VertexIndices +Returns the two vertex indices defining a line down the centre of the cylinder. +Access +Read only +MeshCylinders +The list of mesh cylinders. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Infinite_Cylinder_a.fek]]) +mesh = app.Models["Infinite_Cylinder_a"].Configurations[1].Mesh + -- Get the number of 'Cylinders' contained the 'UnmeshedCylinderRegions'. +count = mesh.UnmeshedCylinderRegions[1].Cylinders.Count +Usage locations +The MeshCylinders object can be accessed from the following locations: +• Properties +◦ MeshUnmeshedCylinderRegion object has property Cylinders. +Property List +Count +Type +The number of cylinders in the mesh entity. (Read only number) +The object type string. (Read only string) +Index List +[number] +Returns the Cylinder at the given index. (Read MeshCylinder) +Property Details +Count +The number of cylinders in the mesh entity. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +MeshEdgesFormat +The mesh edge properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +sConf = app.Models["startup"].Configurations[1] +view = app.Views[1] + -- Show metallic edges +view.MeshRendering.Edges.MetallicVisible = true +Usage locations +The MeshEdgesFormat object can be accessed from the following locations: +• Properties +◦ MeshRendering object has property Edges. +Property List +ApertureVisible +Enables/disables the visibility of aperture edges. (Read/Write boolean) +CuboidVisible +Enables/disables the visibility of cuboid edges. (Read/Write boolean) +DielectricVisible +Enables/disables the visibility of dielectric edges. (Read/Write boolean) +MetallicVisible +Enables/disables the visibility of metallic edges. (Read/Write boolean) +TetrahedraVisible +Enables/disables the visibility of tetrahedra edges. (Read/Write boolean) +UTDCylinderVisible +Enables/disables the visibility of UTD cylinder edges. (Read/Write boolean) +UTDPolygonVisible +Enables/disables the visibility of UTD polygon edges. (Read/Write boolean) +WindscreenVisible +Enables/disables the visibility of windscreen edges. (Read/Write boolean) +Property Details +ApertureVisible +Enables/disables the visibility of aperture edges. +Type +boolean +Access +Read/Write +CuboidVisible +Enables/disables the visibility of cuboid edges. +Type +boolean +Access +Read/Write +DielectricVisible +Enables/disables the visibility of dielectric edges. +Type +boolean +Access +Read/Write +MetallicVisible +Enables/disables the visibility of metallic edges. +Type +boolean +Access +Read/Write +TetrahedraVisible +Enables/disables the visibility of tetrahedra edges. +Type +boolean +Access +Read/Write +UTDCylinderVisible +Enables/disables the visibility of UTD cylinder edges. +Type +boolean +Access +Read/Write +UTDPolygonVisible +Enables/disables the visibility of UTD polygon edges. +Type +boolean +Access +Read/Write +WindscreenVisible +Enables/disables the visibility of windscreen edges. +Type +boolean +Access +Read/Write +MeshEntity +A mesh entity forming part of a mesh. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +sConf = app.Models["startup"].Configurations[1] +mesh = sConf.Mesh + -- Get the label of the specified mesh entity +label = mesh.TriangleFaces[1].Label +Inheritance +The following objects are derived (specialisations) from the MeshEntity object: +• MeshCubeRegion +• MeshCurvilinearSegmentWire +• MeshCurvilinearTriangleFace +• MeshSegmentWire +• MeshTetrahedronRegion +• MeshTriangleFace +• MeshUnmeshedCylinderRegion +• MeshUnmeshedPolygonFace +Property List +Label +The object label. (Read only string) +Property Details +Label +The object label. +Type +string +Access +Read only +MeshFacesFormat +The mesh face properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +sConf = app.Models["startup"].Configurations[1] +view = app.Views[1] + -- Show the face outlines and set the outline colour to Green +view.MeshRendering.Faces.OutlineVisible = true +view.MeshRendering.Faces.OutlineColour = pf.Enums.ColourEnum.Green + -- Hide the metallic faces +view.MeshRendering.Faces.MetallicVisible = false +Usage locations +The MeshFacesFormat object can be accessed from the following locations: +• Properties +◦ MeshRendering object has property Faces. +Property List +ApertureVisible +Enables/disables the visibility of aperture faces. (Read/Write boolean) +CuboidVisible +Enables/disables the visibility of cuboid faces. (Read/Write boolean) +DielectricVisible +Enables/disables the visibility of dielectric faces. (Read/Write boolean) +MetallicVisible +Enables/disables the visibility of metallic faces. (Read/Write boolean) +OutlineColour +The outline colour of the model faces. (Read/Write Colour) +OutlineVisible +Display an outline around model face elements. (Read/Write boolean) +TetrahedraVisible +Enables/disables the visibility of tetrahedra faces. (Read/Write boolean) +UTDCylinderVisible +Enables/disables the visibility of UTD cylinder faces. (Read/Write boolean) +UTDPolygonVisible +Enables/disables the visibility of UTD polygon faces. (Read/Write boolean) +WindscreenVisible +Enables/disables the visibility of windscreen faces. (Read/Write boolean) +Property Details +ApertureVisible +Enables/disables the visibility of aperture faces. +Type +boolean +Access +Read/Write +CuboidVisible +Enables/disables the visibility of cuboid faces. +Type +boolean +Access +Read/Write +DielectricVisible +Enables/disables the visibility of dielectric faces. +Type +boolean +Access +Read/Write +MetallicVisible +Enables/disables the visibility of metallic faces. +Type +boolean +Access +Read/Write +OutlineColour +The outline colour of the model faces. +Type +Colour +Access +Read/Write +OutlineVisible +Display an outline around model face elements. +Type +boolean +Access +Read/Write +TetrahedraVisible +Enables/disables the visibility of tetrahedra faces. +Type +boolean +Access +Read/Write +UTDCylinderVisible +Enables/disables the visibility of UTD cylinder faces. +Type +boolean +Access +Read/Write +UTDPolygonVisible +Enables/disables the visibility of UTD polygon faces. +Type +boolean +Access +Read/Write +WindscreenVisible +Enables/disables the visibility of windscreen faces. +Type +boolean +Access +Read/Write +MeshLegendFormat +The mesh legend properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +sConf = app.Models["startup"].Configurations[1] +view = app.Views[1] + -- Show a legend at the top right corner with a custom title +view.MeshRendering.Legend.Position = pf.Enums.ViewLegendPositionEnum.TopRight +view.MeshRendering.Legend.AutoTextEnabled = false +view.MeshRendering.Legend.Text = "Custom legend title" +Usage locations +The MeshLegendFormat object can be accessed from the following locations: +• Properties +◦ MeshRendering object has property Legend. +Property List +AutoTextEnabled +Specifies if the auto text of the mesh legend on the 3D view at the specified position should be +enabled. (Read/Write boolean) +Position +The mesh legend position on the 3D view, specified by the ViewLegendPositionEnum, e.g. TopLeft, +BottomLeft, etc. (Read/Write ViewLegendPositionEnum) +Text +The text of the mesh legend on the 3D view at the specified position. LegendAutoTextEnabled +must be disabled for this setting to take affect. (Read/Write string) +Property Details +AutoTextEnabled +Specifies if the auto text of the mesh legend on the 3D view at the specified position should be +enabled. +Type +boolean +Access +Read/Write +Position +The mesh legend position on the 3D view, specified by the ViewLegendPositionEnum, e.g. TopLeft, +BottomLeft, etc. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +ViewLegendPositionEnum +Access +Read/Write +Text +p.3542 +The text of the mesh legend on the 3D view at the specified position. LegendAutoTextEnabled +must be disabled for this setting to take affect. +Type +string +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshPolygon +p.3543 +A polygon in 3D space. A geometry polygon's mesh equivalent that can be directly interpreted by the +solver (e.g. using the UTD solution method). +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Antenna_and_UTD_Plate.fek]]) +mesh = app.Models["Dipole_Antenna_and_UTD_Plate"].Configurations[1].Mesh + -- Get a 'MeshPolygon' of a specified mesh entity +meshPolygon = mesh.UnmeshedPolygonFaces[1].Polygons[1] + -- Get the 'VertexIndices' contained the 'MeshPolygon'. +vertices = meshPolygon.VertexIndices +Property List +Type +The object type string. (Read only string) +VertexIndices +Returns a list of the vertex indices of the polygon. (Read only List of number) +Property Details +Type +The object type string. +Type +string +Access +Read only +VertexIndices +Returns a list of the vertex indices of the polygon. +Access +Read only +MeshPolygons +The list of mesh polygons. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Antenna_and_UTD_Plate.fek]]) +mesh = app.Models["Dipole_Antenna_and_UTD_Plate"].Configurations[1].Mesh + -- Get the number of 'Polygons' contained the 'UnmeshedPolygonFaces'. +count = mesh.UnmeshedPolygonFaces[1].Polygons.Count +Usage locations +The MeshPolygons object can be accessed from the following locations: +• Properties +◦ MeshUnmeshedPolygonFace object has property Polygons. +Property List +Count +Type +The number of polygons in the mesh entity. (Read only number) +The object type string. (Read only string) +Index List +[number] +Returns the Polygon at the given index. (Read MeshPolygon) +Property Details +Count +The number of polygons in the mesh entity. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +MeshRendering +The mesh rendering properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +sConf = app.Models["startup"].Configurations[1] +view = app.Views[1] + -- Show metallic edges +view.MeshRendering.Edges.MetallicVisible = true + -- Show the model bounding box +view.MeshRendering.BoundingBoxVisible = true +Usage locations +The MeshRendering object can be accessed from the following locations: +• Properties +◦ View object has property MeshRendering. +Property List +ApertureOpacity +Aperture mesh opacity as a percentage. (Read/Write number) +BoundingBoxVisible +Display the model bounding box. (Read/Write boolean) +CoatingsVisible +Display coatings. (Read/Write boolean) +ColourOption +Mesh colouring option applied to the view, specified by the MeshColouringOptionsEnum, e.g. +FaceMedia, RegionMedia, etc. (Read/Write MeshColouringOptionsEnum) +ConnectivityVisible +Displays the main mesh connectivity for the 3D view. (Read/Write boolean) +Edges +Faces +The mesh edges properties. (Read/Write MeshEdgesFormat) +The mesh faces properties. (Read/Write MeshFacesFormat) +HighlightingOption +Mesh electro magnetic property highlighting applied to the view, specified by +the MeshHighlightingOptionsEnum, e.g. LossyMetal, UTD, VEP, etc. (Read/Write +MeshHighlightingOptionsEnum) +Legend +The mesh legend properties. (Read/Write MeshLegendFormat) +ModelOpacity +Mesh model opacity as a percentage. (Read/Write number) +NonIncludedAngle +Threshold angle when highlighting non-included angles. (Read/Write number) +NonIncludedAnglesVisible +Displays the the non-included angle between flat mesh triangles for the 3D view. (Read/Write +boolean) +TriangleNormalsVisible +Display triangle normals. (Read/Write boolean) +Vertices +The mesh vertices properties. (Read/Write MeshVerticesFormat) +Volumes +The mesh volumes properties. (Read/Write MeshVolumesFormat) +WindscreenLayersVisible +Displays the individual windscreen layers. (Read/Write boolean) +WindscreenOpacity +Windscreen mesh opacity as a percentage. (Read/Write number) +Wires +The mesh wires properties. (Read/Write MeshWiresFormat) +Property Details +ApertureOpacity +Aperture mesh opacity as a percentage. +Type +number +Access +Read/Write +BoundingBoxVisible +Display the model bounding box. +Type +boolean +Access +Read/Write +CoatingsVisible +Display coatings. +Type +boolean +Access +Read/Write +ColourOption +Mesh colouring option applied to the view, specified by the MeshColouringOptionsEnum, e.g. +FaceMedia, RegionMedia, etc. +Type +MeshColouringOptionsEnum +Access +Read/Write +ConnectivityVisible +Displays the main mesh connectivity for the 3D view. +Type +boolean +Access +Read/Write +Edges +Faces +The mesh edges properties. +Type +MeshEdgesFormat +Access +Read/Write +The mesh faces properties. +Type +MeshFacesFormat +Access +Read/Write +HighlightingOption +Mesh electro magnetic property highlighting applied to the view, specified by the +MeshHighlightingOptionsEnum, e.g. LossyMetal, UTD, VEP, etc. +Type +MeshHighlightingOptionsEnum +Access +Read/Write +Legend +The mesh legend properties. +Type +MeshLegendFormat +Access +Read/Write +ModelOpacity +Mesh model opacity as a percentage. +Type +number +Access +Read/Write +NonIncludedAngle +Threshold angle when highlighting non-included angles. +Type +number +Access +Read/Write +NonIncludedAnglesVisible +Displays the the non-included angle between flat mesh triangles for the 3D view. +Type +boolean +Access +Read/Write +TriangleNormalsVisible +Display triangle normals. +Type +boolean +Access +Read/Write +Vertices +The mesh vertices properties. +Type +MeshVerticesFormat +Access +Read/Write +Volumes +The mesh volumes properties. +Type +MeshVolumesFormat +Access +Read/Write +WindscreenLayersVisible +Displays the individual windscreen layers. +Type +boolean +Access +Read/Write +WindscreenOpacity +Windscreen mesh opacity as a percentage. +Type +number +Access +Read/Write +Wires +The mesh wires properties. +Type +MeshWiresFormat +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshSegment +A segment in 3D space. Exists as part of a mesh. +Example +p.3550 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) +mesh = app.Models["Dipole_Example"].Configurations[1].Mesh + -- Get a 'MeshSegments' of a specified mesh entity +meshSegment = mesh.SegmentWires[1].Segments[1] + -- Get the 'VertexIndices' contained the 'MeshSegments'. +vertices = meshSegment.VertexIndices +Property List +Type +The object type string. (Read only string) +VertexIndices +Returns a list of the vertex indices of the segment. (Read only List of number) +Property Details +Type +The object type string. +Type +string +Access +Read only +VertexIndices +Returns a list of the vertex indices of the segment. +Access +Read only +MeshSegmentWire +A mesh entity representing a wire meshed using segments. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) +sConf = app.Models["Dipole_Example"].Configurations[1] +mesh = sConf.Mesh + -- Get the label of the specified mesh entity +label = mesh.SegmentWires[1].Label + -- Get the segment count of the specified mesh entity +wireSegmentCount = mesh.SegmentWires[1].Segments.Count +Inheritance +The MeshSegmentWire object is derived from the MeshEntity object. +Usage locations +The MeshSegmentWire object can be accessed from the following locations: +• Methods +◦ MeshSegmentWireCollection collection has method Items(). +◦ MeshSegmentWireCollection collection has method Item(number). +◦ MeshSegmentWireCollection collection has method Item(string). +Property List +Label +The object label. (Read only string) +Segments +The collection of mesh segments that form the mesh wire. (Read only MeshSegments) +Type +The object type string. (Read only string) +Property Details +Label +The object label. +Type +string +Access +Read only +Segments +The collection of mesh segments that form the mesh wire. +Type +MeshSegments +Access +Read only +Type +The object type string. +Type +string +Access +Read only +MeshSegments +The list of mesh segments. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) +mesh = app.Models["Dipole_Example"].Configurations[1].Mesh + -- Get the number of 'MeshSegments' contained the 'MeshSegmentWire'. +count = mesh.SegmentWires[1].Segments.Count +Usage locations +The MeshSegments object can be accessed from the following locations: +• Properties +◦ MeshSegmentWire object has property Segments. +Property List +Count +Type +The number of segments in the mesh entity. (Read only number) +The object type string. (Read only string) +Index List +[number] +Returns the Segment at the given index. (Read MeshSegment) +Property Details +Count +The number of segments in the mesh entity. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshSegmentsFormat +The mesh segments properties. +Example +p.3554 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) +view = app.Views[1] + -- Show the lines of the segments + -- Hide the surfaces of the segments + -- Show the vertices of the segments +view.MeshRendering.Wires.Segments.LinesVisible = true +view.MeshRendering.Wires.Segments.SurfacesVisible = false +view.MeshRendering.Wires.Segments.VerticesVisible = true +Usage locations +The MeshSegmentsFormat object can be accessed from the following locations: +• Properties +◦ MeshWiresFormat object has property Segments. +Property List +LinesVisible +Enables/disables the visibility of segment lines. (Read/Write boolean) +Radius +Segment surface radius magnification factor. (Read/Write number) +SurfacesVisible +Enables/disables the visibility of segment surfaces. (Read/Write boolean) +VerticesVisible +Enables/disables the visibility of segment vertices. (Read/Write boolean) +Property Details +LinesVisible +Enables/disables the visibility of segment lines. +Type +boolean +Access +Read/Write +Radius +Segment surface radius magnification factor. +Type +number +Access +Read/Write +SurfacesVisible +Enables/disables the visibility of segment surfaces. +Type +boolean +Access +Read/Write +VerticesVisible +Enables/disables the visibility of segment vertices. +Type +boolean +Access +Read/Write +MeshTetrahedra +The list of mesh tetrahedra. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME.. + [[/shared/Resources/Automation/ +Shielding_Factor_of_Thin_Metal_Sphere_FEM.fek]]) +mesh = app.Models["Shielding_Factor_of_Thin_Metal_Sphere_FEM"].Configurations[1].Mesh + -- Get the number of 'MeshTetrahedra' contained the 'MeshTetrahedronRegion'. +count = mesh.TetrahedronRegions[1].Tetrahedra.Count +Usage locations +The MeshTetrahedra object can be accessed from the following locations: +• Properties +◦ MeshTetrahedronRegion object has property Tetrahedra. +Property List +Count +Type +The number of tetrahedra in the mesh entity. (Read only number) +The object type string. (Read only string) +Index List +[number] +Returns the Tetrahedron at the given index. (Read MeshTetrahedron) +Property Details +Count +The number of tetrahedra in the mesh entity. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshTetrahedron +A tetrahedron in 3D space. Exists as part of a mesh. +Example +p.3558 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME.. + [[/shared/Resources/Automation/ +Shielding_Factor_of_Thin_Metal_Sphere_FEM.fek]]) +mesh = app.Models["Shielding_Factor_of_Thin_Metal_Sphere_FEM"].Configurations[1].Mesh + -- Get a 'MeshTetrahedra' of a specified mesh entity +meshTetrahedra = mesh.TetrahedronRegions[1].Tetrahedra[1] + -- Get the 'VertexIndices' contained the 'MeshTetrahedra'. +vertices = meshTetrahedra.VertexIndices +Property List +Type +The object type string. (Read only string) +VertexIndices +Returns a list of the vertex indices of the tetrahedron. (Read only List of number) +Property Details +Type +The object type string. +Type +string +Access +Read only +VertexIndices +Returns a list of the vertex indices of the tetrahedron. +Access +Read only +MeshTetrahedronRegion +A mesh entity representing a region meshed with tetrahedra. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME.. + [[/shared/Resources/Automation/Shielding_Factor_of_Thin_Metal_Sphere_FEM.fek]]) +sConf = app.Models["Shielding_Factor_of_Thin_Metal_Sphere_FEM"].Configurations[1] +mesh = sConf.Mesh + -- Get the label of the specified mesh entity +label = mesh.TetrahedronRegions[1].Label + -- Get the tetrahedra count of the specified mesh entity +regionTetrahedraCount = mesh.TetrahedronRegions[1].Tetrahedra.Count +Inheritance +The MeshTetrahedronRegion object is derived from the MeshEntity object. +Usage locations +The MeshTetrahedronRegion object can be accessed from the following locations: +• Methods +◦ MeshTetrahedronRegionCollection collection has method Items(). +◦ MeshTetrahedronRegionCollection collection has method Item(number). +◦ MeshTetrahedronRegionCollection collection has method Item(string). +Property List +Label +The object label. (Read only string) +Tetrahedra +The collection of mesh tetrahedra that form the mesh region. (Read only MeshTetrahedra) +Type +The object type string. (Read only string) +Property Details +Label +The object label. +Type +string +Access +Read only +Tetrahedra +The collection of mesh tetrahedra that form the mesh region. +Type +MeshTetrahedra +Access +Read only +Type +The object type string. +Type +string +Access +Read only +MeshTriangle +A triangle in 3D space defined by three points. Exists as part of a mesh. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Obtain a handle to the mesh model and its points +model = app.Models["startup"] +mesh = model.Configurations[1].Mesh +points = mesh.Points + -- Obtain a handle to the first 'MeshTriangle' +meshTriangles = mesh.TriangleFaces[1].Triangles +meshTriangle = meshTriangles[1] + -- Print coordinates of the 'MeshTriangle' +print("X=" .. points[meshTriangle.VertexIndices[1]]) +print("Y=" .. points[meshTriangle.VertexIndices[2]]) +print("Z=" .. points[meshTriangle.VertexIndices[3]]) +Property List +Type +The object type string. (Read only string) +VertexIndices +Returns a list of the vertex indices of the triangle. (Read only List of number) +Property Details +Type +The object type string. +Type +string +Access +Read only +VertexIndices +Returns a list of the vertex indices of the triangle. +Access +Read only +MeshTriangleFace +A mesh entity representing a face meshed using triangles. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +sConf = app.Models["startup"].Configurations[1] +mesh = sConf.Mesh + -- Get the label of the specified mesh entity +label = mesh.TriangleFaces[1].Label + -- Get the triangle count of the specified mesh entity +faceTriangleCount = mesh.TriangleFaces[1].Triangles.Count +Inheritance +The MeshTriangleFace object is derived from the MeshEntity object. +Usage locations +The MeshTriangleFace object can be accessed from the following locations: +• Methods +◦ MeshTriangleFaceCollection collection has method Items(). +◦ MeshTriangleFaceCollection collection has method Item(number). +◦ MeshTriangleFaceCollection collection has method Item(string). +Property List +Label +The object label. (Read only string) +Triangles +The collection of mesh triangles that form the mesh Triangle face. (Read only MeshTriangles) +Type +The object type string. (Read only string) +Property Details +Label +The object label. +Type +string +Access +Read only +Triangles +The collection of mesh triangles that form the mesh Triangle face. +Type +MeshTriangles +Access +Read only +Type +The object type string. +Type +string +Access +Read only +MeshTriangles +The list of mesh triangles. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Obtain a handle to the mesh model and its points +model = app.Models["startup"] +mesh = model.Configurations[1].Mesh +points = mesh.Points + -- Obtain a handle to the 'MeshTriangles' +meshTriangles = mesh.TriangleFaces[1].Triangles + -- Get the number of mesh triangles +meshTriangleCount = meshTriangles.Count +Usage locations +The MeshTriangles object can be accessed from the following locations: +• Properties +◦ MeshTriangleFace object has property Triangles. +Property List +Count +Type +The number of triangles in the mesh entity. (Read only number) +The object type string. (Read only string) +Index List +[number] +Returns the Triangle at the given index. (Read MeshTriangle) +Property Details +Count +The number of triangles in the mesh entity. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshUnmeshedCylinderRegion +p.3566 +A mesh entity representing one or more unmeshed cylinders. This type of mesh is typically solved using +a solution method that does not require fine subdivision, like the uniform theory of diffraction. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Infinite_Cylinder_a.fek]]) +sConf = app.Models["Infinite_Cylinder_a"].Configurations[1] +mesh = sConf.Mesh + -- Get the label of the specified mesh entity +label = mesh.UnmeshedCylinderRegions[1].Label + -- Get the cylinder count of the specified mesh entity +count = mesh.UnmeshedCylinderRegions[1].Cylinders.Count +Inheritance +The MeshUnmeshedCylinderRegion object is derived from the MeshEntity object. +Usage locations +The MeshUnmeshedCylinderRegion object can be accessed from the following locations: +• Methods +◦ MeshUnmeshedCylinderRegionCollection collection has method Items(). +◦ MeshUnmeshedCylinderRegionCollection collection has method Item(number). +◦ MeshUnmeshedCylinderRegionCollection collection has method Item(string). +Property List +Cylinders +The collection of unmeshed cylinders that form the mesh region. (Read only MeshCylinders) +Label +Type +The object label. (Read only string) +The object type string. (Read only string) +Property Details +Cylinders +The collection of unmeshed cylinders that form the mesh region. +Type +MeshCylinders +Access +Read only +Label +The object label. +Type +string +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshUnmeshedPolygonFace +p.3568 +A mesh entity representing one or more unmeshed polygons. This type of mesh is typically solved using +a solution method that does not require fine subdivision, like the uniform theory of diffraction. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Antenna_and_UTD_Plate.fek]]) +sConf = app.Models["Dipole_Antenna_and_UTD_Plate"].Configurations[1] +mesh = sConf.Mesh + -- Get the label of the specified mesh entity +label = mesh.UnmeshedPolygonFaces[1].Label + -- Get the polygon count of the first unmeshed polygon face +count = mesh.UnmeshedPolygonFaces[1].Polygons.Count +Inheritance +The MeshUnmeshedPolygonFace object is derived from the MeshEntity object. +Usage locations +The MeshUnmeshedPolygonFace object can be accessed from the following locations: +• Methods +◦ MeshUnmeshedPolygonFaceCollection collection has method Items(). +◦ MeshUnmeshedPolygonFaceCollection collection has method Item(number). +◦ MeshUnmeshedPolygonFaceCollection collection has method Item(string). +Property List +Label +The object label. (Read only string) +Polygons +The collection of unmeshed polygons that form the mesh face. (Read only MeshPolygons) +Type +The object type string. (Read only string) +Property Details +Label +The object label. +Type +string +Access +Read only +Polygons +The collection of unmeshed polygons that form the mesh face. +Type +MeshPolygons +Access +Read only +Type +The object type string. +Type +string +Access +Read only +MeshVerticesFormat +The mesh vertices properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +view = app.Views[1] + -- Show the vertices on the metallic faces +view.MeshRendering.Vertices.MetallicVisible = true +Usage locations +The MeshVerticesFormat object can be accessed from the following locations: +• Properties +◦ MeshRendering object has property Vertices. +Property List +ApertureVisible +Enables/disables the visibility of aperture vertices. (Read/Write boolean) +CuboidVisible +Enables/disables the visibility of cuboid vertices. (Read/Write boolean) +DielectricVisible +Enables/disables the visibility of dielectric vertices. (Read/Write boolean) +MetallicVisible +Enables/disables the visibility of metallic vertices. (Read/Write boolean) +TetrahedraVisible +Enables/disables the visibility of tetrahedra vertices. (Read/Write boolean) +UTDPolygonVisible +Enables/disables the visibility of UTD polygon vertices. (Read/Write boolean) +WindscreenVisible +Enables/disables the visibility of windscreen vertices. (Read/Write boolean) +Property Details +ApertureVisible +Enables/disables the visibility of aperture vertices. +Type +boolean +Access +Read/Write +CuboidVisible +Enables/disables the visibility of cuboid vertices. +Type +boolean +Access +Read/Write +DielectricVisible +Enables/disables the visibility of dielectric vertices. +Type +boolean +Access +Read/Write +MetallicVisible +Enables/disables the visibility of metallic vertices. +Type +boolean +Access +Read/Write +TetrahedraVisible +Enables/disables the visibility of tetrahedra vertices. +Type +boolean +Access +Read/Write +UTDPolygonVisible +Enables/disables the visibility of UTD polygon vertices. +Type +boolean +Access +Read/Write +WindscreenVisible +Enables/disables the visibility of windscreen vertices. +Type +boolean +Access +Read/Write +MeshVolumesFormat +The mesh volume properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME.. + [[/shared/Resources/Automation/Shielding_Factor_of_Thin_Metal_Sphere_FEM.fek]]) +view = app.Views[1] + -- Show the tetrahedra inside the volume +view.MeshRendering.Volumes.TetrahedraVisible = true +Usage locations +The MeshVolumesFormat object can be accessed from the following locations: +• Properties +◦ MeshRendering object has property Volumes. +Property List +TetrahedraVisible +Enables/disables the visibility of tetrahedra volumes. (Read/Write boolean) +Property Details +TetrahedraVisible +Enables/disables the visibility of tetrahedra volumes. +Type +boolean +Access +Read/Write +MeshWiresFormat +The mesh wires properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) +view = app.Views[1] + -- Show the vertices of the wire segments +view.MeshRendering.Wires.Segments.VerticesVisible = true +Usage locations +The MeshWiresFormat object can be accessed from the following locations: +• Properties +◦ MeshRendering object has property Wires. +Property List +Segments +The mesh wire segments properties. (Read/Write MeshSegmentsFormat) +Property Details +Segments +The mesh wire segments properties. +Type +MeshSegmentsFormat +Access +Read/Write +ModalExcitationStoredData +Stored excitation results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/AB_source.fek]]) +modalSource + = pf.GetApplication().Models[1].Configurations[1].Excitations["ABSource1"] + -- Store a copy of the Modal port excitation data. +storedData = modalSource:StoreData() +Inheritance +The ModalExcitationStoredData object is derived from the ResultData object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the source values. +Return +DataSet +The data set containing the source values. +GetDataSet (samplePoints number) +Returns a data set containing the source values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Model +A model object containing simulated results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Print the names of all the opened models +p.3577 +for modelCount = 1, app.Models.Count do + print(app.Models[modelCount].Label) +end +Usage locations +The Model object can be accessed from the following locations: +• Properties +◦ SolutionConfiguration object has property Model. +◦ FormModelSelector object has property Value. +• Methods +◦ ModelCollection collection has method Items(). +◦ ModelCollection collection has method Item(number). +◦ ModelCollection collection has method Item(string). +Property List +Label +The object label. (Read only string) +Launcher +The application process runner. (Read only Launcher) +Type +The object type string. (Read only string) +Collection List +Configurations +The collection of solution configurations in the model. (ConfigurationCollection of +SolutionConfiguration.) +Method List +Delete () +Deletes the model from the session. This also removes all 3DViews and traces associated with the +model. +GetPath () +Returns the path to the model. (Returns a string object.) +ReassociateModel (filename string) +Re associates this model with a different set of model files. +Property Details +Label +The object label. +Type +string +Access +Read only +Launcher +The application process runner. +Type +Launcher +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +Configurations +The collection of solution configurations in the model. +Type +ConfigurationCollection +Method Details +Delete () +Deletes the model from the session. This also removes all 3DViews and traces associated with the +model. +GetPath () +Returns the path to the model. +Return +string +The path of the model. +ReassociateModel (filename string) +Re associates this model with a different set of model files. +Input Parameters +filename(string) +The name of the file to associate this model. +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearField3DFormat +The near field 3D plot visualisation properties. +Example +p.3580 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +nearFieldPlot = app.Views[1].Plots:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Adjust near field 3D plot visualisation properties +nearFieldPlot.Visualisation.BoundingBoxVisible = true +nearFieldPlot.Visualisation.FlatShaded = true +Usage locations +The NearField3DFormat object can be accessed from the following locations: +• Properties +◦ NearField3DPlot object has property Visualisation. +Property List +AutoExtruded +Specifies whether auto extrusion is enabled or disabled for the near field plot. (Read/Write +boolean) +BoundingBoxVisible +Specifies whether the near field plot bounding box must be shown or hidden. (Read/Write +boolean) +Extrusion +The amount (%) the near field plot should be extruded in range [0,100]. (Read/Write number) +FlatShaded +Specifies whether discrete colours (flat shading) should be enabled or disabled for the near field +plot. (Read/Write boolean) +GridVisible +Specifies whether the near field plot grid must be shown or hidden. (Read/Write boolean) +Opacity +Specify the near field plot opacity (%) in the range [0, 100]. (Read/Write number) +SurfaceVisible +Specifies whether the near field plot surface must be shown or hidden. (Read/Write boolean) +Property Details +AutoExtruded +Specifies whether auto extrusion is enabled or disabled for the near field plot. +Type +boolean +Access +Read/Write +BoundingBoxVisible +Specifies whether the near field plot bounding box must be shown or hidden. +Type +boolean +Access +Read/Write +Extrusion +The amount (%) the near field plot should be extruded in range [0,100]. +Type +number +Access +Read/Write +FlatShaded +Specifies whether discrete colours (flat shading) should be enabled or disabled for the near field +plot. +Type +boolean +Access +Read/Write +GridVisible +Specifies whether the near field plot grid must be shown or hidden. +Type +boolean +Access +Read/Write +Opacity +Specify the near field plot opacity (%) in the range [0, 100]. +Type +number +Access +Read/Write +SurfaceVisible +Specifies whether the near field plot surface must be shown or hidden. +Type +boolean +Access +Read/Write +NearField3DPlot +A near field 3D result. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) +firstActive3DView = app.Views[1] + -- Add near field to the Plots collection of the 3D view +nearFieldPlot = + firstActive3DView.Plots:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Adjust plot type and axis values +nearFieldPlot.PlotType = nearFieldPlot.PlotTypesAvailable[3] +printlist(nearFieldPlot.FixedAxes) +printlist(nearFieldPlot:GetFixedAxisAvailableValues("Y position")) +nearFieldPlot:SetFixedAxisValue("Y position", 2, "mm") +Inheritance +The NearField3DPlot object is derived from the Result3DPlot object. +Property List +Arrows +The near field plot arrows properties. (Read only Arrows3DFormat) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +Contours +The near field plot contours properties. (Read only Contours3DFormat) +DataSource +The object that is the data source for this plot. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IsoSurface +The near field isosurface properties. (Read only IsoSurface3DFormat) +Label +The object label. (Read/Write string) +Legend +The 3D plot legend properties. (Read only Plot3DLegendFormat) +LocalCoordAxes +The near field local coordinate axis properties. (Read only Axes3DFormat) +PlotType +The type of plot to be displayed, e.g., 3D Surface, Phi cut, Theta cut, XY surface. (Read/Write +string) +PlotTypesAvailable +The list of available plot types. (Read only List of string) +Quantity +The near field plot quantity properties. (Read only NearFieldQuantity) +RequestPoints +The near field request points properties. (Read only RequestPoints3DFormat) +Type +The object type string. (Read only string) +Visible +Specifies whether the plot must be shown or hidden. (Read/Write boolean) +Visualisation +The near field visualisation properties. (Read only NearField3DFormat) +Method List +Delete () +Delete the plot. +Duplicate () +Duplicate the plot. (Returns a Result3DPlot object.) +ExportIsoSurfaceToSTL (filename string) +Export a near field isosurface to an STL file. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties table) +p.3585 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Stores a copy of the plot. (Returns a Result3DPlot object.) +Property Details +Arrows +The near field plot arrows properties. +Type +Arrows3DFormat +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +Contours +The near field plot contours properties. +Type +Contours3DFormat +Access +Read only +DataSource +The object that is the data source for this plot. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IsoSurface +The near field isosurface properties. +Type +IsoSurface3DFormat +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Legend +The 3D plot legend properties. +Type +Plot3DLegendFormat +Access +Read only +LocalCoordAxes +The near field local coordinate axis properties. +Type +Axes3DFormat +Access +Read only +PlotType +The type of plot to be displayed, e.g., 3D Surface, Phi cut, Theta cut, XY surface. +Type +string +Access +Read/Write +PlotTypesAvailable +The list of available plot types. +Access +Read only +Quantity +The near field plot quantity properties. +Type +NearFieldQuantity +Access +Read only +RequestPoints +The near field request points properties. +Type +RequestPoints3DFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Visible +Specifies whether the plot must be shown or hidden. +Type +boolean +Access +Read/Write +Visualisation +The near field visualisation properties. +Type +NearField3DFormat +Access +Read only +Method Details +Delete () +Delete the plot. +Duplicate () +Duplicate the plot. +Return +Result3DPlot +The duplicated plot. +ExportIsoSurfaceToSTL (filename string) +Export a near field isosurface to an STL file. +Input Parameters +filename(string) +STL filename. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Stores a copy of the plot. +Return +Result3DPlot +The new plot associated with the stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldData +Near field results generated by the Feko Solver. +Example +p.3590 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the 'NearFieldData' called 'NearFields' +nearFieldData = app.Models[1].Configurations[1].NearFields["NearFields"] + -- Manipulate the near field data. See 'DataSet' for faster and more + comprehensive options +dataSet = nearFieldData:GetDataSet(51) +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Find the x start and end values +xAxis = dataSet.Axes["X"] +xStartValue = xAxis:ValueAt(1) +xEndValue = xAxis:ValueAt(#xAxis) + -- Scale the near field field values +scale = 2 +constantZIndex = 1 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + for xIndex = 1, #dataSet.Axes["X"] do + for yIndex = 1, #dataSet.Axes["Y"] do + indexedValue = dataSet[freqIndex][xIndex][yIndex][constantZIndex] + indexedValue.EFieldComp1 = indexedValue.EFieldComp1 * scale + indexedValue.EFieldComp2 = indexedValue.EFieldComp2 * scale + indexedValue.EFieldComp3 = indexedValue.EFieldComp3 * scale + end + end +end + -- Store the manipulated data +scaledNearField = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.NearField) + -- Compare the original far field to the manipulated far field +nearFieldPlot1 = app.Views[1].Plots:Add(nearFieldData) +nearFieldPlot2 = app.Views[1].Plots:Add(scaledNearField) +graph = app.CartesianGraphs:Add() +nearFieldTrace1 = graph.Traces:Add(nearFieldData) +nearFieldTrace2 = graph.Traces:Add(scaledNearField) +Inheritance +The NearFieldData object is derived from the ResultData object. +Usage locations +The NearFieldData object can be accessed from the following locations: +• Methods +◦ NearFieldCollection collection has method Items(). +◦ NearFieldCollection collection has method Item(number). +◦ NearFieldCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, components NearFieldsExportTypeEnum, samples number) +Export the result near field data to the specified *.efe / *.hfe file. +GetDataSet () +Returns a data set containing the near field values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the near field values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the near field values. (Returns a DataSet object.) +GetMediaDataSet () +Returns a data set containing the media information for the near field. (Returns a DataSet object.) +GetMediaDataSet (samplePoints number) +Returns a data set containing the media information for the near field. (Returns a DataSet object.) +GetMediaDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the media information for the near field. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, components NearFieldsExportTypeEnum, samples number) +Export the result near field data to the specified *.efe / *.hfe file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +components(NearFieldsExportTypeEnum) +The components to export specified by the NearFieldsExportTypeEnum, e.g. Both +(*.efe and *.hfe), Electric (*.efe) or Magnetic (*.hfe). +Altair Feko 2022.3 +2 Application Programming Interface (API) +samples(number) +p.3593 +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +nearField = app.Models[1].Configurations[1].NearFields[1] + -- Export the near field data to the current working directory +fileName = "temp_nearField" +nearField:ExportData(fileName, pf.Enums.NearFieldsExportTypeEnum.Electric, 51) +GetDataSet () +Returns a data set containing the near field values. +Return +DataSet +The data set containing the near field values. +GetDataSet (samplePoints number) +Returns a data set containing the near field values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the near field values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the near field values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the near field values. +GetMediaDataSet () +Returns a data set containing the media information for the near field. +Return +DataSet +The near field media data set. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) +nearField = app.Models[1].Configurations[1].NearFields[1] + -- Get and inspect the near field media data +mediaData = nearField:GetMediaDataSet() +print(mediaData) +numberOfMediaInNearFieldRequest = mediaData.Axes[2].Count + -- get the medium index at a given near field request point +nearFieldData = nearField:GetDataSet() +freqIndex = 1 +U, V, N = 12, 17, 1 +mediumIndexAtRequestPoint = nearFieldData[freqIndex][U][V][N].MediumIndex + -- use the index to access media properties at the given near field request point +permittivityAtFirstPoint = mediaData[freqIndex] +[mediumIndexAtRequestPoint].RelativePermittivity +massDensityAtFirstPoint = mediaData[freqIndex][mediumIndexAtRequestPoint].MassDensity +GetMediaDataSet (samplePoints number) +Returns a data set containing the media information for the near field. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The near field media data set. +GetMediaDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the media information for the near field. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The near field media data set. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldMathScript +Near field math script data that can be plotted. +Example +p.3596 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a near field math script +nearFieldMathScript = app.MathScripts:Add(pf.Enums.MathScriptTypeEnum.NearField) +script = +[[ +dataSet = pf.NearField.GetDataSet("startup.StandardConfiguration1.NearFields", 51) +scale = 2 +constantZIndex = 1 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + for xIndex = 1, #dataSet.Axes["X"] do + for yIndex = 1, #dataSet.Axes["Y"] do + indexedValue = dataSet[freqIndex][xIndex][yIndex][constantZIndex] + indexedValue.EFieldComp1 = indexedValue.EFieldComp1 * scale + indexedValue.EFieldComp2 = indexedValue.EFieldComp2 * scale + indexedValue.EFieldComp3 = indexedValue.EFieldComp3 * scale + end + end +end +return dataSet +]] +nearFieldMathScript.Script = script +nearFieldMathScript:Run() + -- Plot the math script +nearFieldPlot = app.Views[1].Plots:Add(nearFieldMathScript) +Inheritance +The NearFieldMathScript object is derived from the MathScript object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Script +Type +The object label. (Read/Write string) +The script code to execute. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. (Returns a MathScript object.) +GetDataSet () +Returns a data set containing the math script values. (Returns a DataSet object.) +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Script +The script code to execute. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. +Return +MathScript +The duplicated math script. +GetDataSet () +Returns a data set containing the math script values. +Return +DataSet +The data set containing the math script values. +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +NearFieldPowerIntegralData +Near field power integral results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) + -- Retrieve the 'NearFieldPowerIntegralData' called 'NearFields' +nearFieldPowerData = + app.Models[1].Configurations[1].NearFieldPowerIntegrals["NearFields"] + -- Create a graph and add the near field power data to it +graph = app.CartesianGraphs:Add() +trace = graph.Traces:Add(nearFieldPowerData) +Inheritance +The NearFieldPowerIntegralData object is derived from the ResultData object. +Usage locations +The NearFieldPowerIntegralData object can be accessed from the following locations: +• Methods +◦ NearFieldPowerIntegralCollection collection has method Items(). +◦ NearFieldPowerIntegralCollection collection has method Item(number). +◦ NearFieldPowerIntegralCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +SolutionConfiguration +p.3600 +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +NearFieldPowerIntegralStoredData +Stored near field results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Horn_error_estimates.fek]]) + -- Obtain a 'NearFieldPowerIntegralStoredData' object +nearFieldPowerIntegrals = app.Models[1].Configurations[1].NearFieldPowerIntegrals +nearFieldPowerIntegralData = nearFieldPowerIntegrals["NearField1"] +nearFieldPowerIntegralStoredData = nearFieldPowerIntegralData:StoreData() + -- Get the label of the'NearFieldPowerIntegralStoredData' object +label = nearFieldPowerIntegralStoredData.Label +Inheritance +The NearFieldPowerIntegralStoredData object is derived from the ResultData object. +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldPowerIntegralTrace +A near field power integral 2D trace. +Example +p.3603 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) +nearFieldPowerData = + app.Models[1].Configurations[1].NearFieldPowerIntegrals["NearFields"] + -- Create a graph and add the near field power data to it +graph = app.CartesianGraphs:Add() +trace = graph.Traces:Add(nearFieldPowerData) + -- Set the trace to dB +trace.Quantity.ValuesScaledToDB = true +Inheritance +The NearFieldPowerIntegralTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The near field power integral trace math expression properties. (Read only TraceMathExpression) +Quantity +The near field power integral trace quantity properties. (Read only PowerIntegralQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +SurfaceAreaDefinition +The surface area definition. (Read/Write string) +SurfaceAreaDefinitionsAvailable +The list of available surface area definitions. (Read only List of string) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetProperties (properties table) +p.3605 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The near field power integral trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The near field power integral trace quantity properties. +Type +PowerIntegralQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +SurfaceAreaDefinition +The surface area definition. +Type +string +Access +Read/Write +SurfaceAreaDefinitionsAvailable +The list of available surface area definitions. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.3609 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldQuantity +The near field quantity properties. +Example +p.3610 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +nearFieldPlot = app.Views[1].Plots:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Adjust 'NearFieldQuantity' of the plot +nearFieldPlot.Quantity.Type = pf.Enums.NearFieldQuantityTypeEnum.SAR +nearFieldPlot.Quantity.ValuesNormalised = true +nearFieldPlot.Quantity.ValuesScaledToDB = true +Usage locations +The NearFieldQuantity object can be accessed from the following locations: +• Properties +◦ NearField3DPlot object has property Quantity. +◦ NearFieldSurfacePlot object has property Quantity. +◦ NearFieldTrace object has property Quantity. +Property List +ComplexComponent +The complex component of the near field value to plot, specified by the ComplexComponentEnum, +e.g. Magnitude, Phase, Real, Imaginary. (Read/Write ComplexComponentEnum) +IncludesPhi +Specifies whether the Phi component should be included in the near field quantity. (Read/Write +boolean) +IncludesRadius +Specifies whether the Radius component should be included in the near field quantity. (Read/Write +boolean) +IncludesRho +Specifies whether the Rho component should be included in the near field quantity. (Read/Write +boolean) +IncludesTheta +Specifies whether the Theta component should be included in the near field quantity. (Read/Write +boolean) +IncludesX +Specifies whether the X component should be included in the near field quantity. (Read/Write +boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +IncludesY +p.3611 +Specifies whether the Y component should be included in the near field quantity. (Read/Write +boolean) +IncludesZ +Specifies whether the Z component should be included in the near field quantity. (Read/Write +boolean) +InstantaneousPhase +The phase value (wt) to use when ComplexComponent is Instantaneous. The value is in degrees +[0,360]. (Read/Write number) +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. (Read/Write boolean) +PowerScalingEnabled +Specifies whether near field power scaling is enabled. (Read/Write boolean) +PowerScalingFactor +The power scaling factor to apply when PowerScalingEnabled is enabled. (Read/Write number) +Type +The type of near field quantity to be plotted, specified by the NearFieldQuantityTypeEnum, e.g. +EField, HField, Poynting, SAR, etc. (Read/Write NearFieldQuantityTypeEnum) +ValuesNormalised +Specifies whether the near field quantity values must be normalised to the range [0,1] before +plotting. This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. (Read/Write boolean) +ValuesScaledToDB +Specifies whether the near field quantity values is scaled to dB before plotting. This property is +only valid when the ComplexComponent is Magnitude. (Read/Write boolean) +Property Details +ComplexComponent +The complex component of the near field value to plot, specified by the ComplexComponentEnum, +e.g. Magnitude, Phase, Real, Imaginary. +Type +ComplexComponentEnum +Access +Read/Write +IncludesPhi +Specifies whether the Phi component should be included in the near field quantity. +Type +boolean +Access +Read/Write +IncludesRadius +Specifies whether the Radius component should be included in the near field quantity. +Type +boolean +Access +Read/Write +IncludesRho +Specifies whether the Rho component should be included in the near field quantity. +Type +boolean +Access +Read/Write +IncludesTheta +Specifies whether the Theta component should be included in the near field quantity. +Type +boolean +Access +Read/Write +IncludesX +Specifies whether the X component should be included in the near field quantity. +Type +boolean +Access +Read/Write +IncludesY +Specifies whether the Y component should be included in the near field quantity. +Type +boolean +Access +Read/Write +IncludesZ +Specifies whether the Z component should be included in the near field quantity. +Type +boolean +Access +Read/Write +InstantaneousPhase +The phase value (wt) to use when ComplexComponent is Instantaneous. The value is in degrees +[0,360]. +Type +number +Access +Read/Write +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +PowerScalingEnabled +Specifies whether near field power scaling is enabled. +Type +boolean +Access +Read/Write +PowerScalingFactor +The power scaling factor to apply when PowerScalingEnabled is enabled. +Type +number +Access +Read/Write +Type +The type of near field quantity to be plotted, specified by the NearFieldQuantityTypeEnum, e.g. +EField, HField, Poynting, SAR, etc. +Type +NearFieldQuantityTypeEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ValuesNormalised +p.3614 +Specifies whether the near field quantity values must be normalised to the range [0,1] before +plotting. This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +ValuesScaledToDB +Specifies whether the near field quantity values is scaled to dB before plotting. This property is +only valid when the ComplexComponent is Magnitude. +Type +boolean +Access +Read/Write +NearFieldReceivingAntennaData +Receiving antenna results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Antenna_Coupling_Receiving_Antenna.fek]]) + -- Obtain a 'NearFieldReceivingAntennaData' object +receivingAntennas = app.Models[1].Configurations[1].ReceivingAntennas +nearFieldReceivingAntennaData = receivingAntennas["NearFieldReceivingAntenna1"] + -- Get the 'NearFieldReceivingAntennaData' object's dataset +dataSet = nearFieldReceivingAntennaData:GetDataSet() +Inheritance +The NearFieldReceivingAntennaData object is derived from the ReceivingAntennaData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the power values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the power values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the power values. (Returns a DataSet object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the power values. +Return +DataSet +The data set containing the power values. +GetDataSet (samplePoints number) +Returns a data set containing the power values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the power values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the power values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the power values. +NearFieldStoredData +Stored near field results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the 'NearFieldData' called 'NearFields' +nearFieldData = app.Models[1].Configurations[1].NearFields["NearFields"] + -- Store a copy of the network data. +storedData = + nearFieldData:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.NearField) +Inheritance +The NearFieldStoredData object is derived from the ResultData object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +ExportData (filename string, components NearFieldsExportTypeEnum, samples number) +Export the stored near field data to the specified *.efe / *.hfe file. +GetDataSet () +Returns a data set containing the near field values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the near field values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the near field values. (Returns a DataSet object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +ExportData (filename string, components NearFieldsExportTypeEnum, samples number) +Export the stored near field data to the specified *.efe / *.hfe file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +components(NearFieldsExportTypeEnum) +The components to export specified by the NearFieldsExportTypeEnum, e.g. Both +(*.efe and *.hfe), Electric (*.efe) or Magnetic (*.hfe). +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the near field values. +Return +DataSet +The data set containing the near field values. +GetDataSet (samplePoints number) +Returns a data set containing the near field values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the near field values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the near field values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the near field values. +NearFieldSurfacePlot +A near field surface plot. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +nearFieldData = app.Models[1].Configurations[1].NearFields[1] +graph = app.CartesianSurfaceGraphs:Add() + -- Add the near field data to a Cartesian surface graph +nearFieldPlot = graph.Plots:Add(nearFieldData) + -- Configure the plot axes +nearFieldPlot.HorizontalIndependentAxis = "Frequency" +nearFieldPlot.VerticalIndependentAxis = "Z position" +nearFieldPlot:SetFixedAxisValue("Y position", 9, "mm") + -- Configure the plot quantity +nearFieldPlot.Quantity.Type = pf.Enums.NearFieldQuantityTypeEnum.EField +Inheritance +The NearFieldSurfacePlot object is derived from the ResultSurfacePlot object. +Property List +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the surface plot. (Read/Write ResultData) +DiscretePlotEnabled +Specifies whether the discrete plot property is enabled or disabled for this surface plot. (Read/ +Write boolean) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +HorizontalIndependentAxis +The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/ +Write string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +Label +The object label. (Read/Write string) +Legend +The surface plot legend properties. (Read only SurfacePlotLegendFormat) +PlotType +The type of plot to be displayed, e.g., X+ surface, Y- surface, Z+ surface. (Read/Write string) +PlotTypesAvailable +The list of available plot types. (Read only List of string) +Quantity +The near field surface plot quantity properties. (Read only NearFieldQuantity) +Sampling +The continuous surface plot sampling settings. These settings only apply to traces when the +independent axis is continuously sampled. (Read only SurfacePlotSamplingFormat) +Type +The object type string. (Read only string) +VerticalIndependentAxis +The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write +string) +Visible +Specifies whether the surface plot must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the surface plot. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the surface plot. +SwitchIndependentAxes () +Switches the horizontal and vertical independent axes. +Property Details +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the surface plot. +Type +ResultData +Access +Read/Write +DiscretePlotEnabled +Specifies whether the discrete plot property is enabled or disabled for this surface plot. +Type +boolean +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +HorizontalIndependentAxis +The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Legend +The surface plot legend properties. +Type +SurfacePlotLegendFormat +Access +Read only +PlotType +The type of plot to be displayed, e.g., X+ surface, Y- surface, Z+ surface. +Type +string +Access +Read/Write +PlotTypesAvailable +The list of available plot types. +Access +Read only +Quantity +The near field surface plot quantity properties. +Type +NearFieldQuantity +Access +Read only +Sampling +The continuous surface plot sampling settings. These settings only apply to traces when the +independent axis is continuously sampled. +Type +SurfacePlotSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VerticalIndependentAxis +The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Visible +Specifies whether the surface plot must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the surface plot. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Store () +Store a copy of the surface plot. +SwitchIndependentAxes () +Switches the horizontal and vertical independent axes. +p.3627 +NearFieldTrace +A near field 2D trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) +cartesianGraph = app.CartesianGraphs:Add() + -- Add a near field trace +nearFieldTrace = + cartesianGraph.Traces:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Investigate and set independent axis +printlist(nearFieldTrace.IndependentAxesAvailable) +nearFieldTrace.IndependentAxis = nearFieldTrace.IndependentAxesAvailable[3] + -- Investigate and set fixed axes +printlist(nearFieldTrace.FixedAxes) +print(nearFieldTrace:GetAxisUnit(nearFieldTrace.FixedAxes[2])) +printlist(nearFieldTrace:GetFixedAxisAvailableValues(nearFieldTrace.FixedAxes[2])) +nearFieldTrace:SetFixedAxisValue("X position", -8, "mm") +cartesianGraph:ZoomToExtents() +Inheritance +The NearFieldTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The near field trace math expression properties. (Read only TraceMathExpression) +Quantity +The near field trace quantity properties. (Read only NearFieldQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +SurfaceAreaDefinition +The surface area definition to be displayed, e.g., X+ surface, XY-surface, Conical surface. (Read/ +Write string) +SurfaceAreaDefinitionsAvailable +The list of available surface area definitions. (Read only List of string) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.3630 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, point Point) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FixedAxes +p.3631 +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The near field trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The near field trace quantity properties. +Type +NearFieldQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +SurfaceAreaDefinition +The surface area definition to be displayed, e.g., X+ surface, XY-surface, Conical surface. +Type +string +Access +Read/Write +SurfaceAreaDefinitionsAvailable +The list of available surface area definitions. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +Values +p.3633 +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, point Point) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +point(Point) +The axis value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +NetworkData +Network results generated by the Feko Solver. +Example +p.3636 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Matching_SPICE.fek]]) + -- Retrieve the 'NetworkData' called 'MatchingNetwork' +networkData = app.Models[1].Configurations[1].Networks["MatchingNetwork"] + -- Manipulate the network data. See 'DataSet' for faster and more comprehensive + options +dataSet = networkData:GetDataSet(51) +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Find the number of ports +portAxis = dataSet.Axes["Arbitrary"] +noPorts = #portAxis + -- Scale the network power values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + for portIndex = 1, #dataSet.Axes["Arbitrary"] do + indexedValue = dataSet[freqIndex][portIndex] + indexedValue.Voltage = indexedValue.Voltage * scale + indexedValue.Power = indexedValue.Power * scale + end +end + -- Store the manipulated data +scaledNetwork = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Network) + -- Compare the original network to the manipulated network +graph = app.CartesianGraphs:Add() +networkTrace1 = graph.Traces:Add(networkData) +networkTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Voltage +networkTrace2 = graph.Traces:Add(scaledNetwork) +networkTrace2.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Voltage +Inheritance +The NetworkData object is derived from the ResultData object. +Usage locations +The NetworkData object can be accessed from the following locations: +• Methods +◦ NetworkCollection collection has method Items(). +◦ NetworkCollection collection has method Item(number). +◦ NetworkCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the network values. +Return +DataSet +The data set containing the network values. +GetDataSet (samplePoints number) +Returns a data set containing the network values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Input Parameters +startFrequency(number) +p.3639 +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +NetworkMathScript +Network math script data that can be plotted. +Example +p.3640 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Matching_SPICE.fek]]) + -- Create a network math script +networkMathScript = app.MathScripts:Add(pf.Enums.MathScriptTypeEnum.Network) +script = +[[ +dataSet = + pf.Network.GetDataSet("Dipole_Matching_SPICE.StandardConfiguration1.MatchingNetwork", + 51) +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + for portIndex = 1, #dataSet.Axes["Arbitrary"] do + indexedValue = dataSet[freqIndex][portIndex] + indexedValue.Current = indexedValue.Current * scale + indexedValue.Power = indexedValue.Power * scale + end +end +return dataSet +]] +networkMathScript.Script = script +networkMathScript:Run() + -- Plot the math script +graph = app.CartesianGraphs:Add() +networkTrace1 = graph.Traces:Add(networkMathScript) +networkTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Current +Inheritance +The NetworkMathScript object is derived from the MathScript object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Script +Type +The object label. (Read/Write string) +The script code to execute. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. (Returns a MathScript object.) +GetDataSet () +Returns a data set containing the math script values. (Returns a DataSet object.) +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Script +The script code to execute. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. +Return +MathScript +The duplicated math script. +GetDataSet () +Returns a data set containing the math script values. +Return +DataSet +The data set containing the math script values. +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +NetworkStoredData +Stored network results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Matching_SPICE.fek]]) + -- Retrieve the 'NetworkData' called 'MatchingNetwork' +networkData = app.Models[1].Configurations[1].Networks["MatchingNetwork"] + -- Store a copy of the network data. +storedData = networkData:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.Network) +Inheritance +The NetworkStoredData object is derived from the ResultData object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. (Returns a DataSet object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the network values. +Return +DataSet +The data set containing the network values. +GetDataSet (samplePoints number) +Returns a data set containing the network values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the network values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the network values. +NetworkTrace +A Networks 2D trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Matching_SPICE.fek]]) +networkData = app.Models[1].Configurations[1].Networks["MatchingNetwork"] + -- Create a cartesian graph and add the network data +graph = app.CartesianGraphs:Add() +networkTrace = graph.Traces:Add(networkData) + -- Configure the trace to display port 2 +networkTrace:SetFixedAxisValue("Port number", 2, "") +Inheritance +The NetworkTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The networks trace math expression properties. (Read only TraceMathExpression) +Quantity +The networks trace quantity properties. (Read only LoadQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties table) +p.3648 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The networks trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The networks trace quantity properties. +Type +LoadQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Normalisation +The axis normalisation properties. +Example +p.3653 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/multiple_configurations.fek]]) + -- Add two different traces to a graph +graph = app.CartesianGraphs:Add() +farField1 = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) +farField2 = graph.Traces:Add(app.Models[1].Configurations[2].FarFields[1]) + -- Normalise across all traces on the graph +graph.Normalisation.Enabled = true +graph.Normalisation.Method = pf.Enums.NormalisationMethodEnum.AllTraces +graph:ZoomToExtents() +Usage locations +The Normalisation object can be accessed from the following locations: +• Properties +◦ PolarGraph object has property Normalisation. +◦ CartesianGraph object has property Normalisation. +Property List +Enabled +Normalise the graph axis. (Read/Write boolean) +Method +The normalisation method used specified by the NormalisationMethodEnum, e.g. AllTraces or +IndividualTraces. Normalisation must be enabled for this property to take affect. (Read/Write +NormalisationMethodEnum) +Property Details +Enabled +Normalise the graph axis. +Type +boolean +Access +Read/Write +Method +The normalisation method used specified by the NormalisationMethodEnum, e.g. AllTraces or +IndividualTraces. Normalisation must be enabled for this property to take affect. +Type +NormalisationMethodEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +OPTFEKOLaunchOptions +OPTFEKO launch options. +Example +p.3655 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Access the 'OPTFEKOLaunchOptions' object and check if files are deleted +areFilesDeleted = app.Models[1].Launcher.Settings.OPTFEKO.FilesDeleted +Usage locations +The OPTFEKOLaunchOptions object can be accessed from the following locations: +• Properties +◦ ComponentLaunchOptions object has property OPTFEKO. +Property List +FarmOutEnabled +Enables/disables running OPTFEKO on multiple remote machines. (Read/Write boolean) +FilesDeleted +Enables/disables if the files generated by the optimisation run (except the optimum) should be +deleted. (Read/Write boolean) +ProcessFarmOutCount +Specifies the total number of processes to farm out. (Read/Write number) +RestartFromRunNumber +Specifies the number the optimisation can be restarted at from the last completed optimisation +iteration. (Read/Write number) +RestartRunEnabled +Enables/disables running the solver from the last completed optimisation iteration. No changes +whatsoever may be made to the model before restarting the optimisation process. (Read/Write +boolean) +Property Details +FarmOutEnabled +Enables/disables running OPTFEKO on multiple remote machines. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +FilesDeleted +p.3656 +Enables/disables if the files generated by the optimisation run (except the optimum) should be +deleted. +Type +boolean +Access +Read/Write +ProcessFarmOutCount +Specifies the total number of processes to farm out. +Type +number +Access +Read/Write +RestartFromRunNumber +Specifies the number the optimisation can be restarted at from the last completed optimisation +iteration. +Type +number +Access +Read/Write +RestartRunEnabled +Enables/disables running the solver from the last completed optimisation iteration. No changes +whatsoever may be made to the model before restarting the optimisation process. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +PREFEKOLaunchOptions +PREFEKO launch options. +Example +p.3657 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Access the 'PREFEKOLaunchOptions' object and check if errors are ignored +errorsIgnored = app.Models[1].Launcher.Settings.PREFEKO.ErrorsIgnored +Usage locations +The PREFEKOLaunchOptions object can be accessed from the following locations: +• Properties +◦ ComponentLaunchOptions object has property PREFEKO. +Property List +Advanced +Advanced command line options for launching PREFEKO. (Read/Write string) +ErrorsIgnored +Enables/disables treating errors as non-fatal, print error messages but then continue. (Read/Write +boolean) +ExportVariables +Variables (names, values, comments) export launch options. (Read/Write +PREFEKOVariableExportOptions) +Property Details +Advanced +Advanced command line options for launching PREFEKO. +Type +string +Access +Read/Write +ErrorsIgnored +Enables/disables treating errors as non-fatal, print error messages but then continue. +Type +boolean +Access +Read/Write +ExportVariables +Variables (names, values, comments) export launch options. +Type +PREFEKOVariableExportOptions +Access +Read/Write +PREFEKOVariableExportOptions +PREFEKO variables (names, values, comments) export launch options. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Access the 'PREFEKOVariableExportOptions' object and check if + -- variables are exported to the OUT file +variablesExported = + app.Models[1].Launcher.Settings.PREFEKO.ExportVariables.OutFileEnabled +Usage locations +The PREFEKOVariableExportOptions object can be accessed from the following locations: +• Properties +◦ PREFEKOLaunchOptions object has property ExportVariables. +Property List +OutFileEnabled +Enables/disables exporting variables to the Feko *.out file. (Read/Write boolean) +StdOutEnabled +Enables/disables exporting variables to the screen (stdout). (Read/Write boolean) +Property Details +OutFileEnabled +Enables/disables exporting variables to the Feko *.out file. +Type +boolean +Access +Read/Write +StdOutEnabled +Enables/disables exporting variables to the screen (stdout). +Type +boolean +Access +Read/Write +Plot3DLegendFormat +The 3D plot legend properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farField = app.Views[1].Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- SetProperties legend +farField.Legend.AutoTextEnabled = false +farField.Legend.Text = "My custom legend title" +Usage locations +The Plot3DLegendFormat object can be accessed from the following locations: +• Properties +◦ CustomData3DPlot object has property Legend. +◦ SAR3DPlot object has property Legend. +◦ ErrorEstimate3DPlot object has property Legend. +◦ WireCurrents3DPlot object has property Legend. +◦ SurfaceCurrents3DPlot object has property Legend. +◦ FarField3DPlot object has property Legend. +◦ NearField3DPlot object has property Legend. +◦ Ray3DPlot object has property Legend. +◦ Result3DPlot object has property Legend. +Property List +AutoTextEnabled +Specifies if the auto text of the legend on the 3D view at the specified position should be enabled. +(Read/Write boolean) +LinearRange +The 3D plot legend linear range properties. (Read/Write Legend3DLinearRangeFormat) +LogarithmicRange +The 3D plot legend logarithmic range properties. (Read/Write Legend3DLogarithmicRangeFormat) +Position +The Result3DPlot legend position on the 3D view, specified by the ViewLegendPositionEnum, e.g. +TopLeft, BottomLeft, etc. (Read/Write ViewLegendPositionEnum) +Text +The text of the legend on the 3D view at the specified position. LegendAutoTextEnabled must be +disabled for this setting to take affect. (Read/Write string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UnitIncluded +p.3661 +Specifies if the unit should be included in the legend on the 3D view at the specified position. +(Read/Write boolean) +Property Details +AutoTextEnabled +Specifies if the auto text of the legend on the 3D view at the specified position should be enabled. +Type +boolean +Access +Read/Write +LinearRange +The 3D plot legend linear range properties. +Type +Legend3DLinearRangeFormat +Access +Read/Write +LogarithmicRange +The 3D plot legend logarithmic range properties. +Type +Legend3DLogarithmicRangeFormat +Access +Read/Write +Position +The Result3DPlot legend position on the 3D view, specified by the ViewLegendPositionEnum, e.g. +TopLeft, BottomLeft, etc. +Type +ViewLegendPositionEnum +Access +Read/Write +Text +The text of the legend on the 3D view at the specified position. LegendAutoTextEnabled must be +disabled for this setting to take affect. +Type +string +Access +Read/Write +UnitIncluded +Specifies if the unit should be included in the legend on the 3D view at the specified position. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +PlotSamplingFormat +The plot sampling format property. +Example +p.3663 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +helix_6_2_PBC_1x1_ContinuousFarField.fek]]) +farFieldData = app.Models[1].Configurations[1].FarFields[1] +farFieldPlot = app.Views[1].Plots:Add(farFieldData) + -- Edit the 'PlotSamplingFormat' +farFieldPlot.Sampling.Method = pf.Enums.PlotSamplingMethodEnum.SpecifiedResolution +farFieldPlot.Sampling.AngularResolution = 3 +Usage locations +The PlotSamplingFormat object can be accessed from the following locations: +• Properties +◦ FarField3DPlot object has property Sampling. +Property List +AngularResolution +The size of the sampling interval (in degrees) when the Method is SpecifiedResolution. (Read/ +Write number) +Method +The method for determining where sample points of the plot are calculated, specified by +the PlotSamplingMethodEnum, e.g. Auto, RequestPoints, SpecifiedResolution. (Read/Write +PlotSamplingMethodEnum) +Property Details +AngularResolution +The size of the sampling interval (in degrees) when the Method is SpecifiedResolution. +Type +number +Access +Read/Write +Method +The method for determining where sample points of the plot are calculated, specified by the +PlotSamplingMethodEnum, e.g. Auto, RequestPoints, SpecifiedResolution. +Type +PlotSamplingMethodEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Point +p.3665 +A point in 3D space. This object lives in the Lua session only. Points are defined by numbers and cannot +be defined with expressions. Mathematical operations can be done on points. +Example + -- Create a default 'Point' at (0,0,0) +p1 = pf.Point.New() + -- Assign values to each component of the point +p1.x = 1 +p1.y = 1 +p1.z = 1 + -- Create a 'Point' with number values +p2 = pf.Point(2,2,2) + -- Determine the distance between two points +distance = p1:distanceTo(p2) + -- Some of the valid operators for 'Point' +p3 = 2 * p1 +p4 = p2 * 2 +p5 = p2 / 2 +p6 = -p2 +p7 = p1 + p2 +p8 = p1 - p2 +if (p1 ~= p2) then + print(p1.." is not equal to "..p2) +end +Usage locations +The Point object can be accessed from the following locations: +• Properties +◦ FarField3DFormat object has property Origin. +◦ View3DFormat object has property Origin. +◦ DataSetMetaData object has property Origin. +◦ DataSetMetaData object has property UVector. +◦ DataSetMetaData object has property VVector. +• Methods +• Static functions +◦ Point object has static function New(number, number, number). +◦ Point object has static function New(). +Property List +Type +The object type string. (Read only string) +The x component of the point. (Read/Write number) +The y component of the point. (Read/Write number) +The z component of the point. (Read/Write number) +Method List +DistanceTo (point Point) +Returns the distance between this point and another. (Returns a number object.) +Constructor Function List +New (x number, y number, z number) +Creates a new point. (Returns a Point object.) +New () +Creates a new point. (Returns a Point object.) +Index List +[number] +Index a component of the point. (Read number) +[number] +Index a component of the point. (Write number) +Property Details +Type +The object type string. +Type +string +Access +Read only +The x component of the point. +Type +number +Access +Read/Write +The y component of the point. +Type +number +Access +Read/Write +The z component of the point. +Type +number +Access +Read/Write +Method Details +DistanceTo (point Point) +Returns the distance between this point and another. +Input Parameters +point(Point) +The point to measure the distance To from this point. +Return +number +The distance between the points. +Static Function Details +New (x number, y number, z number) +Creates a new point. +Input Parameters +x(number) +The x component. +y(number) +The y component. +z(number) +The z component. +Return +Point +The new point. +New () +Creates a new point. +Return +Point +The new point. +Points +A list of points in 3D space. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Retrieve the list of mesh points +mesh = app.Models[1].Configurations[1].Mesh +meshPoints = mesh.Points + -- Compare the first and last point +firstPt = meshPoints[1] +lastPt = meshPoints[meshPoints.Count] +if firstPt ~= lastPt then + print(firstPt.." is not equal to "..lastPt) +end +Usage locations +The Points object can be accessed from the following locations: +• Properties +◦ Mesh object has property Points. +Property List +Count +Type +The number of points in the collection. (Read only number) +The object type string. (Read only string) +Index List +[number] +Returns the Point at the given index. (Read Point) +Property Details +Count +The number of points in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +PolarGraph +A 2D Polar graph where results can be plotted. +Example +p.3671 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a graph with a trace +graph = app.PolarGraphs:Add() +farFieldTrace = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Export an image +graph:ExportImage("temp_FarFieldGraph", "pdf") +Inheritance +The PolarGraph object is derived from the Graph object. +Usage locations +The PolarGraph object can be accessed from the following locations: +• Methods +◦ CartesianGraph object has method DuplicateAsPolar(). +◦ PolarGraphCollection collection has method Items(). +◦ PolarGraphCollection collection has method Item(number). +◦ PolarGraphCollection collection has method Item(string). +◦ PolarGraphCollection collection has method Add(). +Property List +AngularAxis +The polar graph angular axis properties. (Read only AngularGraphAxis) +BackColour +The background colour of the graph. (Read/Write Colour) +Direction +The polar graph direction specified by the PolarGraphDirectionEnum, e.g. Clockwise and +Anticlockwise. (Read/Write PolarGraphDirectionEnum) +Footer +The graph footer properties. (Read only TextBox) +GreyscaleEnabled +Set the graph's colour scheme to greyscale. (Read/Write boolean) +Grid +The polar graph grid properties. (Read only PolarGraphGrid) +Height +The height of the window. (Read only number) +Legend +The graph legend properties. (Read only GraphLegend) +Normalisation +The polar radial axis normalisation properties. (Read only Normalisation) +Orientation +The polar graph orientation specified by the PolarGraphOrientationEnum, e.g. ZeroAtTop, +ZeroAtRight, etc. (Read/Write PolarGraphOrientationEnum) +RadialAxis +The polar graph radial axis properties. (Read only RadialGraphAxis) +Title +Type +Width +The graph title properties. (Read only TextBox) +The object type string. (Read only string) +The width of the window. (Read only number) +WindowActive +True if this window is the active window. (Read only boolean) +WindowTitle +The title of the window. (Read/Write string) +XPosition +The X position of the window. (Read only number) +YPosition +The Y position of the window. (Read only number) +Collection List +Annotations +The collection of 2D annotations on the graph. (ResultAnnotationCollection of GraphAnnotation.) +Arrows +The collection of 2D arrows on the graph. (ResultArrowCollection of ResultArrow.) +Shapes +The collection of 2D shapes on the graph. (ResultTextBoxCollection of ResultTextBox.) +Traces +The collection of 2D traces on the graph. (ResultTraceCollection of ResultTrace.) +Method List +AddChartImage (view View, posX number, posY number) +Add a 3D view image to this 2D Graph. +AddChartImageForTrace (trace ResultTrace, posX number, posY number) +Add a trace linked image to this 2D Graph. +AddChartImageFromFile (file string, posX number, posY number) +Add an image file to this 2D Graph. +AddMathTrace () +Adds a math trace to the 2D graph. (Returns a MathTrace object.) +BlockGraphRedraws () +Disables graph redraws for performance purposes. When all the changes to the graph are +complete, call UnblockGraphRedraws to re-enable graph updates. +Close () +Close the window. +Duplicate () +Duplicate the 2D graph. (Returns a Graph object.) +DuplicateAsCartesian () +Creates a Cartesian graph with the same data as the polar graph. (Returns a CartesianGraph +object.) +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +ExportTraces (filename string, samples number) +Export the graph traces to the specified tab separated file. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Show () +Shows the view. +UnblockGraphRedraws () +Enables graph redraws. This method is used in conjunction with BlockGraphRedraws for +performance purposes. The graph is redrawn when this method is called and normals redraws will +occur on changes. +ZoomToExtents () +Zoom the content of the window to its extent. +Property Details +AngularAxis +The polar graph angular axis properties. +Type +AngularGraphAxis +Access +Read only +BackColour +The background colour of the graph. +Type +Colour +Access +Read/Write +Direction +The polar graph direction specified by the PolarGraphDirectionEnum, e.g. Clockwise and +Anticlockwise. +Type +PolarGraphDirectionEnum +Access +Read/Write +Footer +The graph footer properties. +Type +TextBox +Access +Read only +GreyscaleEnabled +Set the graph's colour scheme to greyscale. +Type +boolean +Access +Read/Write +Grid +The polar graph grid properties. +Type +PolarGraphGrid +Access +Read only +Height +The height of the window. +Type +number +Access +Read only +Legend +The graph legend properties. +Type +GraphLegend +Access +Read only +Normalisation +The polar radial axis normalisation properties. +Type +Normalisation +Access +Read only +Orientation +The polar graph orientation specified by the PolarGraphOrientationEnum, e.g. ZeroAtTop, +ZeroAtRight, etc. +Type +PolarGraphOrientationEnum +Access +Read/Write +RadialAxis +The polar graph radial axis properties. +Type +RadialGraphAxis +Access +Read only +Title +The graph title properties. +Type +TextBox +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Width +The width of the window. +Type +number +Access +Read only +WindowActive +True if this window is the active window. +Type +boolean +Access +Read only +WindowTitle +The title of the window. +Type +string +Access +Read/Write +XPosition +The X position of the window. +Type +number +Access +Read only +YPosition +The Y position of the window. +Type +number +Access +Read only +Collection Details +Annotations +The collection of 2D annotations on the graph. +Type +Arrows +ResultAnnotationCollection +The collection of 2D arrows on the graph. +Type +ResultArrowCollection +Shapes +The collection of 2D shapes on the graph. +Type +Traces +ResultTextBoxCollection +The collection of 2D traces on the graph. +Type +ResultTraceCollection +Method Details +AddChartImage (view View, posX number, posY number) +Add a 3D view image to this 2D Graph. +Input Parameters +view(View) +The 3D view. +posX(number) +The x-position of the added chart image. +posY(number) +The y-position of the added chart image. +AddChartImageForTrace (trace ResultTrace, posX number, posY number) +Add a trace linked image to this 2D Graph. +Input Parameters +trace(ResultTrace) +The trace. +posX(number) +The x-position of the added chart image. +posY(number) +The y-position of the added chart image. +AddChartImageFromFile (file string, posX number, posY number) +Add an image file to this 2D Graph. +Input Parameters +file(string) +The file. +posX(number) +The x-position of the added chart image. +posY(number) +The y-position of the added chart image. +AddMathTrace () +Adds a math trace to the 2D graph. +Return +MathTrace +The math trace. +BlockGraphRedraws () +Disables graph redraws for performance purposes. When all the changes to the graph are +complete, call UnblockGraphRedraws to re-enable graph updates. +Close () +Close the window. +Duplicate () +Duplicate the 2D graph. +Return +Graph +The duplicated 2D graph. +DuplicateAsCartesian () +Creates a Cartesian graph with the same data as the polar graph. +Return +CartesianGraph +The copied Cartesian graph. +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +imagewidth(number) +The export width in pixels. +imageheight(number) +The export height in pixels. +ExportTraces (filename string, samples number) +Export the graph traces to the specified tab separated file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +samples(number) +The number of samples for continuous data. This value will be ignored if the first trace +on the graph is discrete. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +Input Parameters +xposition(number) +The view X position. +yposition(number) +The view Y position. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Input Parameters +imagewidth(number) +The view width in pixels. +imageheight(number) +The view height in pixels. +Show () +Shows the view. +UnblockGraphRedraws () +Enables graph redraws. This method is used in conjunction with BlockGraphRedraws for +performance purposes. The graph is redrawn when this method is called and normals redraws will +occur on changes. +ZoomToExtents () +Zoom the content of the window to its extent. +PolarGraphGrid +The polar graph grid properties. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.PolarGraphs:Add() + -- Update grid visualisation properties +graph.Grid.Minor.Visible = true +graph.Grid.BackColour = pf.Enums.ColourEnum.DarkGreen +Usage locations +The PolarGraphGrid object can be accessed from the following locations: +• Properties +◦ PolarGraph object has property Grid. +Property List +BackColour +The background colour of the polar graph grid. (Read/Write Colour) +Border +The line format for the polar graph grid border. (Read only GraphLineFormat) +Major +Minor +The polar graph major grid properties. (Read only PolarGridLines) +The polar graph minor grid properties. (Read only PolarGridLines) +Property Details +BackColour +The background colour of the polar graph grid. +Type +Colour +Access +Read/Write +Border +The line format for the polar graph grid border. +Type +GraphLineFormat +Access +Read only +Major +Minor +The polar graph major grid properties. +Type +PolarGridLines +Access +Read only +The polar graph minor grid properties. +Type +PolarGridLines +Access +Read only +PolarGridLines +The polar graph grid lines properties. +Example +app = pf.GetApplication() +app:NewProject() + -- Edit 'PolarGridLines' properties +graph = app.PolarGraphs:Add() +graph.Grid.Minor.Visible = true +graph.Grid.Major.AngularLine.Weight = 3 +graph.Grid.Major.RadialLine.Weight = 3 +Usage locations +The PolarGridLines object can be accessed from the following locations: +• Properties +◦ PolarGraphGrid object has property Major. +◦ PolarGraphGrid object has property Minor. +Property List +AngularLabelsVisible +Controls the visibility of the angular polar graph grid line labels. Only valid for minor grid labels. +(Read/Write boolean) +AngularLine +The line format for the polar graph angular grid. (Read only GraphLineFormat) +RadialLabelsVisible +Controls the visibility of the radial polar graph grid line labels. Only valid for minor grid labels. +(Read/Write boolean) +RadialLine +The line format for the polar graph radial grid. (Read only GraphLineFormat) +Visible +Controls the visibility of the polar graph grid lines. (Read/Write boolean) +Property Details +AngularLabelsVisible +Controls the visibility of the angular polar graph grid line labels. Only valid for minor grid labels. +Type +boolean +Access +Read/Write +AngularLine +The line format for the polar graph angular grid. +Type +GraphLineFormat +Access +Read only +RadialLabelsVisible +Controls the visibility of the radial polar graph grid line labels. Only valid for minor grid labels. +Type +boolean +Access +Read/Write +RadialLine +The line format for the polar graph radial grid. +Type +GraphLineFormat +Access +Read only +Visible +Controls the visibility of the polar graph grid lines. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +PowerData +Power results generated by the Feko Solver. +Example +p.3685 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the 'PowerData' called 'Power' +powerData = app.Models[1].Configurations[1].Power["Power"] + -- Manipulate the power data. See 'DataSet' for faster and more comprehensive + options +dataSet = powerData:GetDataSet(51) +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Find the frequency start and end values +frequencyAxis = dataSet.Axes["Frequency"] +frequencyStartValue = frequencyAxis:ValueAt(1) +frequencyEndValue = frequencyAxis:ValueAt(#frequencyAxis) + -- Scale the power values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.ActivePower = indexedValue.ActivePower * scale +end + -- Store the manipulated data +scaledPower = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Power) + -- Compare the original power to the manipulated power +graph = app.CartesianGraphs:Add() +powerTrace1 = graph.Traces:Add(powerData) +powerTrace1.Quantity.Type = pf.Enums.PowerQuantityTypeEnum.ActivePower +powerTrace2 = graph.Traces:Add(scaledPower) +powerTrace2.Quantity.Type = pf.Enums.PowerQuantityTypeEnum.ActivePower +Inheritance +The PowerData object is derived from the ResultData object. +Usage locations +The PowerData object can be accessed from the following locations: +• Methods +◦ PowerCollection collection has method Items(). +◦ PowerCollection collection has method Item(number). +◦ PowerCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the power values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the power values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the power values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the power values. +Return +DataSet +The data set containing the power values. +GetDataSet (samplePoints number) +Returns a data set containing the power values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the power values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the power values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the power values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +PowerIntegralQuantity +The power integral quantity properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farFieldPowerData = + app.Models[1].Configurations[1].FarFieldPowerIntegrals["FarFields"] + -- Create a graph and add the far field power data to it +graph = app.CartesianGraphs:Add() +trace = graph.Traces:Add(farFieldPowerData) + -- Set the trace to dB +trace.Quantity.ValuesScaledToDB = true +Usage locations +The PowerIntegralQuantity object can be accessed from the following locations: +• Properties +◦ FarFieldPowerIntegralTrace object has property Quantity. +◦ NearFieldPowerIntegralTrace object has property Quantity. +Property List +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. (Read/Write boolean) +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when the ComplexComponent is Magnitude. (Read/Write boolean) +Property Details +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ValuesScaledToDB +p.3690 +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when the ComplexComponent is Magnitude. +Type +boolean +Access +Read/Write +PowerMathScript +Power math script data that can be plotted. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a power math script +powerMathScript = app.MathScripts:Add(pf.Enums.MathScriptTypeEnum.Power) +script = +[[ +dataSet = pf.Power.GetDataSet("startup.StandardConfiguration1.Power", 51) +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.ActivePower = indexedValue.ActivePower * scale +end +return dataSet +]] +powerMathScript.Script = script +powerMathScript:Run() + -- Plot the math script +graph = app.CartesianGraphs:Add() +powerTrace1 = graph.Traces:Add(powerMathScript) +powerTrace1.Quantity.Type = pf.Enums.PowerQuantityTypeEnum.ActivePower +Inheritance +The PowerMathScript object is derived from the MathScript object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Script +Type +The object label. (Read/Write string) +The script code to execute. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. (Returns a MathScript object.) +GetDataSet () +Returns a data set containing the math script values. (Returns a DataSet object.) +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Script +The script code to execute. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. +Return +MathScript +The duplicated math script. +GetDataSet () +Returns a data set containing the math script values. +Return +DataSet +The data set containing the math script values. +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +PowerQuantity +The power quantity properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +powerData = app.Models[1].Configurations[1].Power["Power"] + -- Create a cartesian graph and add the power data +graph = app.CartesianGraphs:Add() +powerTrace = graph.Traces:Add(powerData) + -- Configure the trace quantity +powerTrace.Quantity.Type = pf.Enums.PowerQuantityTypeEnum.ActivePower +powerTrace.Quantity.ValuesScaledToDB = true +Usage locations +The PowerQuantity object can be accessed from the following locations: +• Properties +◦ PowerTrace object has property Quantity. +Property List +Type +The type of quantity to be plotted, specified by the PowerQuantityTypeEnum, e.g. Active power, +Loss power or Efficiency. (Read/Write PowerQuantityTypeEnum) +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. (Read/Write boolean) +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. (Read/Write boolean) +Property Details +Type +The type of quantity to be plotted, specified by the PowerQuantityTypeEnum, e.g. Active power, +Loss power or Efficiency. +Type +PowerQuantityTypeEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ValuesNormalised +p.3695 +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. +Type +boolean +Access +Read/Write +PowerStoredData +Stored power results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the 'PowerData' called 'Power' +powerData = app.Models[1].Configurations[1].Power["Power"] + -- Store a copy of the power data. +storedData = powerData:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.Power) +Inheritance +The PowerStoredData object is derived from the ResultData object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the power values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the power values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the power values. (Returns a DataSet object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the power values. +Return +DataSet +The data set containing the power values. +GetDataSet (samplePoints number) +Returns a data set containing the power values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the power values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the power values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the power values. +PowerTrace +A power 2D trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +powerData = app.Models[1].Configurations[1].Power["Power"] + -- Create a cartesian graph and add the power data +graph = app.CartesianGraphs:Add() +powerTrace = graph.Traces:Add(powerData) + -- Configure the trace quantity +powerTrace.Quantity.Type = pf.Enums.PowerQuantityTypeEnum.ActivePower +powerTrace.Quantity.ValuesScaledToDB = true +Inheritance +The PowerTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The power trace math expression properties. (Read only TraceMathExpression) +Quantity +The power trace quantity properties. (Read only PowerQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +p.3701 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The power trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The power trace quantity properties. +Type +PowerQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +QuickReport +A quick report document to generate. +Example +p.3706 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.pfs]]) + -- Create a PDF quick report (called exampleReport.pdf) and give it a heading +report = + app:CreateQuickReport([[temp_exampleReport2]], pf.Enums.ReportDocumentTypeEnum.PDF) +report.DocumentHeading = "Example report" + -- Exclude the cartesian graph window +report:SetPageIncluded("Cartesian graph1", false) + -- Generate the document +report:GenerateAndOpen() +Inheritance +The QuickReport object is derived from the ResultReport object. +Usage locations +The QuickReport object can be accessed from the following locations: +• Methods +◦ Application object has method CreateQuickReport(string, ReportDocumentTypeEnum). +Property List +DocumentHeading +The report document heading. (Read/Write string) +ImageFormat +The image format to use when exporting images for the template report. (Read/Write string) +ImageSize +Report image export size options. (Read only ReportImageSizeSetting) +PageOrientation +The page orientation of the report document, e.g. Portrait or Landscape. (Read/Write +ReportOrientationEnum) +ReportPageOptions +Gives the list of windows that will be exported to the report. The order of the list is the page order +in which they will be placed in the report. (Read only List of string) +Type +The object type string. (Read only string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method List +Generate () +Generates the quick report. +GenerateAndOpen () +Generates and opens the quick report. +SetPageCaption (windowtitle string, caption string) +p.3707 +Specifies what the given window's page image caption should be in the report. The list of window +titles can be retrieved with ReportPageOptions. +SetPageIncluded (windowtitle string, included boolean) +Specifies whether the given window should be included in the report. The list of window titles can +be retrieved with ReportPageOptions. +SetPageTitle (windowtitle string, pagetitle string) +Specifies what the given window's page title should be in the report. The list of window titles can +be retrieved with ReportPageOptions. +Property Details +DocumentHeading +The report document heading. +Type +string +Access +Read/Write +ImageFormat +The image format to use when exporting images for the template report. +Type +string +Access +Read/Write +ImageSize +Report image export size options. +Type +ReportImageSizeSetting +Access +Read only +PageOrientation +The page orientation of the report document, e.g. Portrait or Landscape. +Type +ReportOrientationEnum +Access +Read/Write +ReportPageOptions +Gives the list of windows that will be exported to the report. The order of the list is the page order +in which they will be placed in the report. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Generate () +Generates the quick report. +GenerateAndOpen () +Generates and opens the quick report. +SetPageCaption (windowtitle string, caption string) +Specifies what the given window's page image caption should be in the report. The list of window +titles can be retrieved with ReportPageOptions. +Input Parameters +windowtitle(string) +The title of the window which attributes needs to be modified. +caption(string) +The exported image caption. +SetPageIncluded (windowtitle string, included boolean) +Specifies whether the given window should be included in the report. The list of window titles can +be retrieved with ReportPageOptions. +Input Parameters +windowtitle(string) +The title of the window which attributes needs to be modified. +included(boolean) +Specifies if the window should be included in the report. +SetPageTitle (windowtitle string, pagetitle string) +Specifies what the given window's page title should be in the report. The list of window titles can +be retrieved with ReportPageOptions. +Input Parameters +windowtitle(string) +The title of the window which attributes needs to be modified. +pagetitle(string) +The title of the page. +RadialGraphAxis +The graph radial axis properties. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.PolarGraphs:Add() + -- SetProperties angular radial axis settings on the polar +axis = graph.RadialAxis +axis.Labels.NumberFormat = pf.Enums.NumberFormatEnum.Scientific +axis.MajorGrid.AutoSpacingEnabled = false +axis.MajorGrid.Spacing = 10 +axis.LogScaled = true +Usage locations +The RadialGraphAxis object can be accessed from the following locations: +• Properties +◦ PolarGraph object has property RadialAxis. +Property List +DynamicRange +Dynamic range of radial axis. (Read/Write number) +Labels +The graph radial axis labels. (Read only GraphAxisLabels) +LogScaled +Set the polar graph radial axis to a logarithmic scale. (Read/Write boolean) +MajorGrid +The graph radial axis major grid spacing. (Read only AxisGridSpacing) +MinorGridSubdivisions +The number of minor grid subdivisions. (Read/Write number) +Range +The graph radial axis range. (Read only AxisRange) +Property Details +DynamicRange +Dynamic range of radial axis. +Type +number +Access +Read/Write +Labels +The graph radial axis labels. +Type +GraphAxisLabels +Access +Read only +LogScaled +Set the polar graph radial axis to a logarithmic scale. +Type +boolean +Access +Read/Write +MajorGrid +The graph radial axis major grid spacing. +Type +AxisGridSpacing +Access +Read only +MinorGridSubdivisions +The number of minor grid subdivisions. +Type +number +Access +Read/Write +Range +The graph radial axis range. +Type +AxisRange +Access +Read only +Ray3DPlot +Rays 3D result. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Antenna_and_UTD_Plate.fek]]) +rayData = app.Models[1].Configurations[1].Rays["Rays1"] + -- Add the ray data to the 3D view +rayPlot = app.Views[1].Plots:Add(rayData) + -- SetProperties the ray quantity options +rayPlot.Quantity.GroupsSelected = {1,2,3,4,5,6,7,8,9,10} +Inheritance +The Ray3DPlot object is derived from the Result3DPlot object. +Property List +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The object that is the data source for this plot. (Read/Write ResultData) +Label +The object label. (Read/Write string) +Legend +The 3D plot legend properties. (Read only Plot3DLegendFormat) +Quantity +The rays 3D plot quantity properties. (Read only RaysQuantity) +Type +The object type string. (Read only string) +Visible +Specifies whether the plot must be shown or hidden. (Read/Write boolean) +Visualisation +The rays visualisation properties. (Read only Rays3DFormat) +Method List +Delete () +Delete the plot. +Duplicate () +Duplicate the plot. (Returns a Result3DPlot object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.3713 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Stores a copy of the plot. (Returns a Result3DPlot object.) +Property Details +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The object that is the data source for this plot. +Type +ResultData +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The 3D plot legend properties. +Type +Plot3DLegendFormat +Access +Read only +Quantity +The rays 3D plot quantity properties. +Type +RaysQuantity +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Visible +Specifies whether the plot must be shown or hidden. +Type +boolean +Access +Read/Write +Visualisation +The rays visualisation properties. +Type +Rays3DFormat +Access +Read only +Method Details +Delete () +Delete the plot. +Duplicate () +Duplicate the plot. +Return +Result3DPlot +The duplicated plot. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Stores a copy of the plot. +Return +Result3DPlot +The new plot associated with the stored data. +RayData +Ray results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Antenna_and_UTD_Plate.fek]]) + -- Retrieve the 'RayData' called 'Rays' +rayData = app.Models[1].Configurations[1].Rays["Rays1"] + -- Add the ray data to the 3D view +RayPlot = app.Views[1].Plots:Add(rayData) +Inheritance +The RayData object is derived from the ResultData object. +Usage locations +The RayData object can be accessed from the following locations: +• Methods +◦ RayCollection collection has method Items(). +◦ RayCollection collection has method Item(number). +◦ RayCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +Rays3DFormat +The rays 3D plot visualisation properties. +Example +p.3718 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Antenna_and_UTD_Plate.fek]]) + -- Retrieve the 'RayData' called 'Rays' and plot it on the 3D view +rayData = app.Models[1].Configurations[1].Rays["Rays1"] +rayPlot = app.Views[1].Plots:Add(rayData) +rayPlot.Quantity.GroupsSelected = {1,2,3,4,5,6,7,8,9,10} + -- SetProperties the 3D display options for rays +rayPlot.Visualisation.RayGroupsVisible = true +rayPlot.Visualisation.NumbersVisible = true +rayPlot.Visualisation.AmplitudesEnabled = true +Usage locations +The Rays3DFormat object can be accessed from the following locations: +• Properties +◦ Ray3DPlot object has property Visualisation. +Property List +AmplitudesEnabled +Specifies whether colour by magnitude as display option for the rays must be enabled. (Read/ +Write boolean) +IntersectionsVisible +Specifies whether the ray intersection points must be shown or hidden. (Read/Write boolean) +LinesVisible +Specifies whether the ray lines must be shown or hidden. (Read/Write boolean) +NumbersVisible +Specifies whether the ray numbers must be shown or hidden. (Read/Write boolean) +Opacity +Specify the rays plot opacity % in the range [0, 100]. (Read/Write number) +RayGroupsVisible +Specifies whether the ray group numbers must be shown or hidden. (Read/Write boolean) +Threshold +Specify the visibility threshold (%) of the rays for the range [0,100]. (Read/Write number) +Property Details +AmplitudesEnabled +Specifies whether colour by magnitude as display option for the rays must be enabled. +Type +boolean +Access +Read/Write +IntersectionsVisible +Specifies whether the ray intersection points must be shown or hidden. +Type +boolean +Access +Read/Write +LinesVisible +Specifies whether the ray lines must be shown or hidden. +Type +boolean +Access +Read/Write +NumbersVisible +Specifies whether the ray numbers must be shown or hidden. +Type +boolean +Access +Read/Write +Opacity +Specify the rays plot opacity % in the range [0, 100]. +Type +number +Access +Read/Write +RayGroupsVisible +Specifies whether the ray group numbers must be shown or hidden. +Type +boolean +Access +Read/Write +Threshold +Specify the visibility threshold (%) of the rays for the range [0,100]. +Type +number +Access +Read/Write +RaysQuantity +The rays quantity properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Antenna_and_UTD_Plate.fek]]) +rayData = app.Models[1].Configurations[1].Rays["Rays1"] + -- Add the ray data to the 3D view +rayPlot = app.Views[1].Plots:Add(rayData) + -- SetProperties the ray quantity options +rayPlot.Quantity.GroupsSelected = {1,2,3,4,5,6,7,8,9,10} +rayPlot.Quantity.AllRaysSelected = false +rayPlot.Quantity.RaysSelected = {1,2,3,4,5,6,7,8,9,10} +Usage locations +The RaysQuantity object can be accessed from the following locations: +• Properties +◦ Ray3DPlot object has property Quantity. +Property List +AllRaysSelected +Specifies whether all the rays should be selected. (Read/Write boolean) +GroupsSelected +The list of groups that must be selected for the ray plot. (Read/Write List of number) +InteractionsUpTo +Specify the maximum number of ray interactions plot. (Read/Write number) +RayFieldType +The rays field type that must be displayed, specified by the RayFieldTypeEnum, +e.g. NearElectricRequest, FarFieldRequest, NearMagneticCoupling, etc. (Read/Write +RayFieldTypeEnum) +RaysSelected +The list of rays that must be selected for the ray plot. AllRaysSelected must be disabled first +before this property can be set.Ensure the group in which the ray is contained is selected as well. +(Read/Write List of number) +Type +The ray type that must be displayed, specified by the RayTypeEnum, e.g. AllRays, ReflectionRay, +TransmissionRay, etc. (Read/Write RayTypeEnum) +Altair Feko 2022.3 +2 Application Programming Interface (API) +ValuesNormalised +p.3722 +Specifies whether the rays quantity values must be normalised to the range [0,1] before +plotting. This property can be used together with dB scaling. This property is not valid when +ComplexComponent is Phase. (Read/Write boolean) +ValuesScaledToDB +Specifies whether the rays quantity values are scaled to dB before plotting. (Read/Write boolean) +Property Details +AllRaysSelected +Specifies whether all the rays should be selected. +Type +boolean +Access +Read/Write +GroupsSelected +The list of groups that must be selected for the ray plot. +Access +Read/Write +InteractionsUpTo +Specify the maximum number of ray interactions plot. +Type +number +Access +Read/Write +RayFieldType +The rays field type that must be displayed, specified by the RayFieldTypeEnum, e.g. +NearElectricRequest, FarFieldRequest, NearMagneticCoupling, etc. +Type +RayFieldTypeEnum +Access +Read/Write +RaysSelected +The list of rays that must be selected for the ray plot. AllRaysSelected must be disabled first +before this property can be set.Ensure the group in which the ray is contained is selected as well. +Access +Read/Write +Type +The ray type that must be displayed, specified by the RayTypeEnum, e.g. AllRays, ReflectionRay, +TransmissionRay, etc. +Type +RayTypeEnum +Access +Read/Write +ValuesNormalised +Specifies whether the rays quantity values must be normalised to the range [0,1] before +plotting. This property can be used together with dB scaling. This property is not valid when +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +ValuesScaledToDB +Specifies whether the rays quantity values are scaled to dB before plotting. +Type +boolean +Access +Read/Write +ReceivingAntennaData +Receiving antenna results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Retrieve the 'ReceivingAntennaData' called 'FarFieldReceivingAntenna1' +rxAntennaData = + app.Models[1].Configurations[1].ReceivingAntennas["FarFieldReceivingAntenna1"] + -- Add the receiving antenna data to a Cartesian graph +graph = app.CartesianGraphs:Add() +receivingAntennaTrace1 = graph.Traces:Add(rxAntennaData) +Inheritance +The ReceivingAntennaData object is derived from the ResultData object. +The following objects are derived (specialisations) from the ReceivingAntennaData object: +• FarFieldReceivingAntennaData +• NearFieldReceivingAntennaData +• SphericalModesReceivingAntennaData +Usage locations +The ReceivingAntennaData object can be accessed from the following locations: +• Methods +◦ ReceivingAntennaCollection collection has method Items(). +◦ ReceivingAntennaCollection collection has method Item(number). +◦ ReceivingAntennaCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +Method List +GetDataSet () +Returns a data set containing the power values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the power values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the power values. (Returns a DataSet object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Method Details +GetDataSet () +Returns a data set containing the power values. +Return +DataSet +The data set containing the power values. +GetDataSet (samplePoints number) +Returns a data set containing the power values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the power values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the power values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the power values. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReceivingAntennaQuantity +The receiving antenna quantity properties. +Example +p.3727 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) +rxAntennaData = + app.Models[1].Configurations[1].ReceivingAntennas["FarFieldReceivingAntenna1"] + -- Add the receiving antenna data to a Cartesian graph +graph = app.CartesianGraphs:Add() +receivingAntennaTrace1 = graph.Traces:Add(rxAntennaData) + -- SetProperties the quantity +receivingAntennaTrace1.Quantity.Type = pf.Enums.PowerQuantityTypeEnum.Efficiency +Usage locations +The ReceivingAntennaQuantity object can be accessed from the following locations: +• Properties +◦ ReceivingAntennaTrace object has property Quantity. +Property List +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. (Read/Write boolean) +Type +The type of quantity to be plotted, specified by the PowerQuantityTypeEnum, e.g. Active power, +Loss power or Efficiency. (Read/Write ReceivingAntennaQuantityTypeEnum) +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. (Read/Write boolean) +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when the ComplexComponent is Magnitude. (Read/Write boolean) +Property Details +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +Type +The type of quantity to be plotted, specified by the PowerQuantityTypeEnum, e.g. Active power, +Loss power or Efficiency. +Type +ReceivingAntennaQuantityTypeEnum +Access +Read/Write +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when the ComplexComponent is Magnitude. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReceivingAntennaTrace +A receiving antenna 2D trace. +Example +p.3729 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) +rxAntennaData = + app.Models[1].Configurations[1].ReceivingAntennas["FarFieldReceivingAntenna1"] + -- Create a Cartesian graph and the Receiving antenna data +graph = app.CartesianGraphs:Add() +ReceivingAntennaTrace = graph.Traces:Add(rxAntennaData) + -- Configure the trace quantity +ReceivingAntennaTrace.Quantity.Type = pf.Enums.PowerQuantityTypeEnum.Efficiency +Inheritance +The ReceivingAntennaTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The receiving antenna trace math expression properties. (Read only TraceMathExpression) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Quantity +p.3730 +The receiving antenna trace quantity properties. (Read only ReceivingAntennaQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The receiving antenna trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The receiving antenna trace quantity properties. +Type +ReceivingAntennaQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ResultTrace +A copy of the trace. +p.3734 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReportImageSizeSetting +Image export size properties. +Example +p.3735 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.pfs]]) + -- Create a PDF quick report (called exampleReport.pdf) and give it a heading +report = + app:CreateQuickReport([[temp_exampleReport2]], pf.Enums.ReportDocumentTypeEnum.PDF) +report.DocumentHeading = "Example report" + -- Set the image export size to Custom and specify a resolution +report.ImageSize.SizeType = pf.Enums.ReportImageSizeEnum.Custom +report.ImageSize.Width = 1600 +report.ImageSize.Height = 1200 + -- Generate the document +report:GenerateAndOpen() +Usage locations +The ReportImageSizeSetting object can be accessed from the following locations: +• Properties +◦ QuickReport object has property ImageSize. +◦ ReportTemplate object has property ImageSize. +◦ ResultReport object has property ImageSize. +Property List +Height +The height of the exported image. (Read/Write number) +SizeType +The size that should be used to export the image, e.g. SVGA. (Read/Write ReportImageSizeEnum) +Width +The width of the exported image. (Read/Write number) +Property Details +Height +The height of the exported image. +Type +number +Access +Read/Write +SizeType +The size that should be used to export the image, e.g. SVGA. +Type +ReportImageSizeEnum +Access +Read/Write +Width +The width of the exported image. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReportTemplate +A report template document to generate. +Example +p.3737 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.pfs]]) + -- Only generate the report if Microsoft Word is installed +if ( app.MSWordInstalled ) then + -- Add a Word 2007 report template to the POSTFEKO session + reportTemplate = app.Reports:Add( + FEKO_HOME..[[/shared/Resources/Automation/StartupModel.dotx]], + pf.Enums.ReportDocumentTypeEnum.MSWord) + -- Extract the tags from the template document and get a list of the open + windows in the + -- current session + tags = reportTemplate.Tags + windows = reportTemplate.Windows + -- Build a map of tags to window titles + tagwindownames = {} + tagwindownames["Graph1:"] = "startup1" + tagwindownames[tags[2]] = windows[3] + reportTemplate.TagSettings:Modify(tagwindownames) + -- Generate the report + reportTemplate:Generate([[temp_StartupModelReport.docx]]) +end +Inheritance +The ReportTemplate object is derived from the ResultReport object. +Usage locations +The ReportTemplate object can be accessed from the following locations: +• Methods +◦ ReportTemplate object has method Duplicate(). +◦ ReportsCollection collection has method Items(). +◦ ReportsCollection collection has method Item(number). +◦ ReportsCollection collection has method Item(string). +◦ ReportsCollection collection has method Add(string, ReportDocumentTypeEnum). +Property List +DocumentType +The report template document type. (Read/Write ReportDocumentTypeEnum) +ImageFormat +The image format to use when exporting images for the template report. (Read/Write string) +ImageSize +Report image export size options. (Read only ReportImageSizeSetting) +Label +Tags +The object label. (Read/Write string) +The tags extracted from the template file. (Read only List of string) +TemplateFilename +The template document used to generate the report. (Read/Write string) +Type +The object type string. (Read only string) +Windows +Gives the list of windows that can be exported to the report. (Read only List of string) +Collection List +TagSettings +The report template tag and window settings. (ReportTemplateTagCollection of +ReportTemplateTagSettings.) +Method List +Delete () +Delete the report template. +Duplicate () +Duplicate the report template. (Returns a ReportTemplate object.) +ExportReportTemplate (filename string) +Export a report template to a (*.xml) file. +Generate (filename string) +Generates the report template. +GenerateAndOpen (filename string) +Generates and opens the report template. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetProperties (properties table) +p.3739 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Property Details +DocumentType +The report template document type. +Type +ReportDocumentTypeEnum +Access +Read/Write +ImageFormat +The image format to use when exporting images for the template report. +Type +string +Access +Read/Write +ImageSize +Report image export size options. +Type +ReportImageSizeSetting +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Tags +The tags extracted from the template file. +Access +Read only +TemplateFilename +The template document used to generate the report. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Windows +Gives the list of windows that can be exported to the report. +Access +Read only +Collection Details +TagSettings +The report template tag and window settings. +Type +ReportTemplateTagCollection +Method Details +Delete () +Delete the report template. +Duplicate () +Duplicate the report template. +Return +ReportTemplate +The duplicated report template. +ExportReportTemplate (filename string) +Export a report template to a (*.xml) file. +Input Parameters +filename(string) +The filename of the report template file (*.xml) to be exported. +Generate (filename string) +Generates the report template. +Input Parameters +filename(string) +The filename of the report document without its extension. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GenerateAndOpen (filename string) +Generates and opens the report template. +Input Parameters +filename(string) +p.3741 +The filename of the report document without its extension. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +ReportTemplateTagSettings +The report template tag and associated window settings. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.pfs]]) + -- Only generate the report if Microsoft Word is installed +if ( app.MSWordInstalled ) then + -- Add a Word 2007 report template to the POSTFEKO session + reportTemplate = app.Reports:Add( + FEKO_HOME..[[/shared/Resources/Automation/StartupModel.dotx]], + pf.Enums.ReportDocumentTypeEnum.MSWord) + -- Extract the tags from the template document and get a list of the open windows + in the + -- current session + reportTemplate.TagSettings[1].Window = "startup1" + reportTemplate.TagSettings[2].Window = "Cartesian graph1" + -- Generate the report + reportTemplate:Generate([[temp_StartupModelReport.docx]]) +end +Usage locations +The ReportTemplateTagSettings object can be accessed from the following locations: +• Methods +◦ ReportTemplateTagCollection collection has method Item(number). +Property List +Tag +The tag extracted from the template file associated with the 'Window' property. (Read only string) +Window +The window that should be included in the report at the associated tag. (Read/Write string) +Property Details +Tag +The tag extracted from the template file associated with the 'Window' property. +Type +string +Access +Read only +Window +The window that should be included in the report at the associated tag. +Type +string +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +RequestPoints3DFormat +The 3D plot request points properties. +Example +p.3744 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +nearFieldPlot = app.Views[1].Plots:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Adjust 'RequestPoints3DFormat' of the plot +nearFieldPlot.RequestPoints.DisplayType = pf.Enums.RequestPointsDisplayTypeEnum.On +nearFieldPlot.RequestPoints.VisualisationType + = pf.Enums.RequestsVisualisationTypeEnum.Lines +Usage locations +The RequestPoints3DFormat object can be accessed from the following locations: +• Properties +◦ FarField3DPlot object has property RequestPoints. +◦ NearField3DPlot object has property RequestPoints. +Property List +Colour +The colour of the request points. (Read/Write Colour) +DisplayType +Control the request points display specified by the RequestPointsDisplayTypeEnum, e.g. Auto, On +or Off. (Read/Write RequestPointsDisplayTypeEnum) +MarkerSize +Specify the marker size for request points in the range [0.0, 2.0]. (Read/Write number) +VisualisationType +How the request points should be visualised specified by the RequestPointsVisualisationTypeEnum, +e.g. Points, Lines or Surface. (Read/Write RequestsVisualisationTypeEnum) +Property Details +Colour +The colour of the request points. +Type +Colour +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +DisplayType +p.3745 +Control the request points display specified by the RequestPointsDisplayTypeEnum, e.g. Auto, On +or Off. +Type +RequestPointsDisplayTypeEnum +Access +Read/Write +MarkerSize +Specify the marker size for request points in the range [0.0, 2.0]. +Type +number +Access +Read/Write +VisualisationType +How the request points should be visualised specified by the RequestPointsVisualisationTypeEnum, +e.g. Points, Lines or Surface. +Type +RequestsVisualisationTypeEnum +Access +Read/Write +Result3DPlot +A 3D plot of result. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Get the first 3D view from the collection of Views in the application +view = app.Views[1] + -- Add far field, near field and surface current 3D plots to the 3D view +farFieldPlot = view.Plots:Add(app.Models[1].Configurations[1].FarFields[1]) +nearFieldPlot = view.Plots:Add(app.Models[1].Configurations[1].NearFields[1]) +surfaceCurrentPlot = + view.Plots:Add(app.Models[1].Configurations[1].SurfaceCurrents[1]) + -- Hide the near field plot +nearFieldPlot.Visible = false + -- Set the legend position for the surface currents plot +surfaceCurrentPlot.Legend.Position = pf.Enums.ViewLegendPositionEnum.TopRight + -- Change the legend scaling range for the far field +farFieldPlot.Legend.LinearRange.FixedRangeMax = 2 +farFieldPlot.Legend.LinearRange.FixedRangeMin = -3 +farFieldPlot.Legend.LinearRange.Type = pf.Enums.LinearScaleRangeTypeEnum.Fixed +Inheritance +The Result3DPlot object is derived from the ResultPlot object. +The following objects are derived (specialisations) from the Result3DPlot object: +• CustomData3DPlot +• ErrorEstimate3DPlot +• FarField3DPlot +• NearField3DPlot +• Ray3DPlot +• SAR3DPlot +• SurfaceCurrents3DPlot +• WireCurrents3DPlot +Usage locations +The Result3DPlot object can be accessed from the following locations: +• Methods +◦ CustomData3DPlot object has method Duplicate(). +◦ CustomData3DPlot object has method Store(). +◦ SAR3DPlot object has method Duplicate(). +◦ SAR3DPlot object has method Store(). +◦ ErrorEstimate3DPlot object has method Store(). +◦ WireCurrents3DPlot object has method Store(). +◦ SurfaceCurrents3DPlot object has method Store(). +◦ FarField3DPlot object has method Duplicate(). +◦ FarField3DPlot object has method Store(). +◦ NearField3DPlot object has method Duplicate(). +◦ NearField3DPlot object has method Store(). +◦ Ray3DPlot object has method Duplicate(). +◦ Ray3DPlot object has method Store(). +◦ Result3DPlot object has method Store(). +◦ Result3DPlotCollection collection has method Items(). +◦ Result3DPlotCollection collection has method Item(number). +◦ Result3DPlotCollection collection has method Item(string). +Property List +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The object that is the data source for this plot. (Read/Write ResultData) +Label +The object label. (Read/Write string) +Legend +The 3D plot legend properties. (Read only Plot3DLegendFormat) +Visible +Specifies whether the plot must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the plot. +Store () +Stores a copy of the plot. (Returns a Result3DPlot object.) +Property Details +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The object that is the data source for this plot. +Type +ResultData +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The 3D plot legend properties. +Type +Plot3DLegendFormat +Access +Read only +Visible +Specifies whether the plot must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the plot. +Store () +Stores a copy of the plot. +Return +Result3DPlot +The new plot associated with the stored data. +ResultArrow +A 2D results arrow. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +app.Views[1]:Close() + -- Add a Cartesian graph to the application's collection and obtain + -- the arrow collection +graph = app.CartesianGraphs:Add() +arrows = graph.Arrows +arrow1 = arrows:AddArrow(30, 40, 50, 50) +arrow1.LineColour = pf.Enums.ColourEnum.Red +arrow1.LineStyle = pf.Enums.LineStyleEnum.DashLine +arrow1.LineWeight = 4 +arrow2 = arrow1:Duplicate() +arrow1:Delete() +Usage locations +The ResultArrow object can be accessed from the following locations: +• Methods +◦ ResultArrow object has method Duplicate(). +◦ ResultArrowCollection collection has method Items(). +◦ ResultArrowCollection collection has method Item(number). +◦ ResultArrowCollection collection has method Item(string). +◦ ResultArrowCollection collection has method AddLine(number, number, number, number). +◦ ResultArrowCollection collection has method AddArrow(number, number, number, number). +◦ ResultArrowCollection collection has method AddDoubleHeadArrow(number, number, number, +number). +Property List +EndPositionX +The X coordinate end position of the arrow. (Read/Write number) +EndPositionY +The Y coordinate end position of the arrow. (Read/Write number) +LineColour +The line colour. See ColourEnum. (Read/Write string) +LineStyle +The line style. See LineStyleEnum. (Read/Write string) +LineWeight +The line weight. (Read/Write number) +StartPositionX +The X coordinate start position of the arrow. (Read/Write number) +StartPositionY +The Y coordinate start position of the arrow. (Read/Write number) +Type +The object type string. (Read only string) +Method List +Delete () +Delete the arrow. +Duplicate () +Duplicate the arrow. (Returns a ResultArrow object.) +Lower () +Lower the arrow. +Raise () +Raise the arrow. +Property Details +EndPositionX +The X coordinate end position of the arrow. +Type +number +Access +Read/Write +EndPositionY +The Y coordinate end position of the arrow. +Type +number +Access +Read/Write +LineColour +The line colour. See ColourEnum. +Type +string +Access +Read/Write +LineStyle +The line style. See LineStyleEnum. +Type +string +Access +Read/Write +LineWeight +The line weight. +Type +number +Access +Read/Write +StartPositionX +The X coordinate start position of the arrow. +Type +number +Access +Read/Write +StartPositionY +The Y coordinate start position of the arrow. +Type +number +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the arrow. +Duplicate () +Duplicate the arrow. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ResultArrow +The duplicated arrow. +Lower () +Lower the arrow. +Raise () +Raise the arrow. +p.3752 +ResultData +Result data that can be plotted. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Get some result data items +resultDataTable = {} +resultDataTable[1] = app.Models[1].Configurations[1].FarFields[1] +resultDataTable[2] = app.Models[1].Configurations[1].Power[1] +resultDataTable[3] = app.Models[1].Configurations[1].NearFields[1] + -- Print the labels of the data items +for index, item in pairs(resultDataTable) do + print("ResultData item " .. index .. " has label \"" .. item.Label .. "\"") +end +Inheritance +The following objects are derived (specialisations) from the ResultData object: +• CharacteristicModeData +• CharacteristicModeStoredData +• CustomStoredData +• ErrorEstimateData +• ExcitationData +• ExcitationStoredData +• FarFieldData +• FarFieldPowerIntegralData +• FarFieldPowerIntegralStoredData +• FarFieldStoredData +• LoadData +• LoadStoredData +• MathScript +• ModalExcitationStoredData +• NearFieldData +• NearFieldPowerIntegralData +• NearFieldPowerIntegralStoredData +• NearFieldStoredData +• NetworkData +• NetworkStoredData +• PowerData +• PowerStoredData +• RayData +• ReceivingAntennaData +• SARData +• SARStoredData +• SParameterData +• SParameterStoredData +• SpiceProbeData +• SpiceProbeStoredData +• SurfaceCurrentsAndChargesStoredData +• SurfaceCurrentsData +• TRCoefficientData +• TRCoefficientStoredData +• TransmissionLineData +• WaveguideExcitationStoredData +• WireCurrentsAndChargesStoredData +• WireCurrentsData +Usage locations +The ResultData object can be accessed from the following locations: +• Properties +◦ CustomData3DPlot object has property DataSource. +◦ SAR3DPlot object has property DataSource. +◦ ErrorEstimate3DPlot object has property DataSource. +◦ WireCurrents3DPlot object has property DataSource. +◦ SurfaceCurrents3DPlot object has property DataSource. +◦ FarField3DPlot object has property DataSource. +◦ NearField3DPlot object has property DataSource. +◦ Ray3DPlot object has property DataSource. +◦ Result3DPlot object has property DataSource. +◦ SParameterSurfacePlot object has property DataSource. +◦ CustomDataSurfacePlot object has property DataSource. +◦ NearFieldSurfacePlot object has property DataSource. +◦ FarFieldSurfacePlot object has property DataSource. +◦ ResultSurfacePlot object has property DataSource. +◦ CharacteristicModeTrace object has property DataSource. +◦ CustomDataSmithTrace object has property DataSource. +◦ CustomDataTrace object has property DataSource. +◦ MathTrace object has property DataSource. +◦ SpiceProbeTrace object has property DataSource. +◦ FarFieldPowerIntegralTrace object has property DataSource. +◦ NearFieldPowerIntegralTrace object has property DataSource. +◦ TRCoefficientTrace object has property DataSource. +◦ LoadSmithTrace object has property DataSource. +◦ ExcitationSmithTrace object has property DataSource. +◦ SARTrace object has property DataSource. +◦ WireCurrentsTrace object has property DataSource. +◦ SParameterTrace object has property DataSource. +◦ PowerTrace object has property DataSource. +◦ LoadTrace object has property DataSource. +◦ ExcitationTrace object has property DataSource. +◦ FarFieldTrace object has property DataSource. +◦ NearFieldTrace object has property DataSource. +◦ ReceivingAntennaTrace object has property DataSource. +◦ NetworkTrace object has property DataSource. +◦ ResultTrace object has property DataSource. +◦ FormDataSelector object has property Value. +• Methods +◦ LoadComplex object has method StoreData(). +◦ LoadVoxel object has method StoreData(). +◦ LoadSeries object has method StoreData(). +◦ LoadParallel object has method StoreData(). +◦ LoadNetwork object has method StoreData(). +◦ LoadFEM object has method StoreData(). +◦ LoadEdge object has method StoreData(). +◦ LoadDistributed object has method StoreData(). +◦ LoadCable object has method StoreData(). +◦ LoadCoaxial object has method StoreData(). +◦ LoadVertex object has method StoreData(). +◦ SourceWaveguide object has method StoreData(). +◦ SourceCurrentTriangle object has method StoreData(). +◦ SourceSphericalModes object has method StoreData(). +◦ SourceRadiationPattern object has method StoreData(). +◦ SourceAperture object has method StoreData(). +◦ SourceVoltageNetwork object has method StoreData(). +◦ SourceVoltageCable object has method StoreData(). +◦ SourceSolutionCoefficient object has method StoreData(). +◦ SourcePCB object has method StoreData(). +◦ SourceCurrentSpace object has method StoreData(). +◦ SourceCurrentRegion object has method StoreData(). +◦ SourceVoltageEdge object has method StoreData(). +◦ SourceModal object has method StoreData(). +◦ SourceMagneticDipole object has method StoreData(). +◦ SourceElectricDipole object has method StoreData(). +◦ SourceCoaxial object has method StoreData(). +◦ SourceMagneticFrill object has method StoreData(). +◦ SourceVoltageVertex object has method StoreData(). +◦ SourceVoltageSegment object has method StoreData(). +◦ SourcePlaneWave object has method StoreData(). +◦ CharacteristicModeData object has method StoreData(). +◦ WireCurrentsMathScript object has method StoreData(). +◦ SurfaceCurrentsMathScript object has method StoreData(). +◦ TRCoefficientMathScript object has method StoreData(). +◦ PowerMathScript object has method StoreData(). +◦ SParameterMathScript object has method StoreData(). +◦ NetworkMathScript object has method StoreData(). +◦ LoadMathScript object has method StoreData(). +◦ ExcitationMathScript object has method StoreData(). +◦ FarFieldMathScript object has method StoreData(). +◦ NearFieldMathScript object has method StoreData(). +◦ SpiceProbeData object has method StoreData(). +◦ FarFieldPowerIntegralData object has method StoreData(). +◦ NearFieldPowerIntegralData object has method StoreData(). +◦ TRCoefficientData object has method StoreData(). +◦ TransmissionLineData object has method StoreData(). +◦ NetworkData object has method StoreData(). +◦ SARData object has method StoreData(). +◦ WireCurrentsData object has method StoreData(). +◦ SurfaceCurrentsData object has method StoreData(). +◦ SParameterData object has method StoreData(). +◦ PowerData object has method StoreData(). +◦ LoadData object has method StoreData(). +◦ ExcitationData object has method StoreData(). +◦ FarFieldData object has method StoreData(). +◦ NearFieldData object has method StoreData(). +◦ +ImportedDataCollection collection has method Items(). +◦ +◦ +ImportedDataCollection collection has method Item(number). +ImportedDataCollection collection has method Item(string). +◦ StoredDataCollection collection has method Items(). +◦ StoredDataCollection collection has method Item(number). +◦ StoredDataCollection collection has method Item(string). +◦ DataSet object has method StoreData(StoredDataTypeEnum). +Property List +Label +The object label. (Read/Write string) +Property Details +Label +The object label. +Type +string +Access +Read/Write +ResultPlot +Graph data plotted on either 2D or 3D graphs. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Plot the far field on the 3D graph +plots3D = app.Views[1].Plots +farField3DPlot = plots3D:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Create a cartesian graph and plot the far field in 2D +graph = app.CartesianGraphs:Add() +plots2D = graph.Traces +farField2DPlot = plots2D:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Obtain the axis names for each plot +print("3D Far field axes:") +printlist(farField3DPlot.AxisNames) +print("\n2D Far field axes:") +printlist(farField2DPlot.AxisNames) + -- Give each plot a convenient label +farField3DPlot.Label = "FarField_in_3D" +farField2DPlot.Label = "FarField_in_2D" +Inheritance +The following objects are derived (specialisations) from the ResultPlot object: +• Result3DPlot +• ResultSurfacePlot +• ResultTrace +Usage locations +The ResultPlot object can be accessed from the following locations: +• Methods +◦ ResultSurfacePlotCollection collection has method Add(ResultData). +◦ Result3DPlotCollection collection has method Add(ResultData). +◦ ResultTraceCollection collection has method Add(ResultData). +Property List +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +Label +The object label. (Read/Write string) +Property Details +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +ResultReport +The base class for report types. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.pfs]]) + -- Only generate the report if Microsoft Word is installed +if ( app.MSWordInstalled ) then + -- Add a Word 2007 report template to the POSTFEKO session + reportTemplate = app.Reports:Add( + FEKO_HOME..[[/shared/Resources/Automation/StartupModel.dotx]], + pf.Enums.ReportDocumentTypeEnum.MSWord) + -- Extract the tags from the template document and get a list of the open + windows in the + -- current session + tags = reportTemplate.Tags + windows = reportTemplate.Windows + -- Build a map of tags to window titles + tagwindownames = {} + tagwindownames["Graph1:"] = "startup1" + tagwindownames[tags[2]] = windows[3] + reportTemplate.TagSettings:Modify(tagwindownames) + -- Set the image export size to Custom and specify a resolution + reportTemplate.ImageSize.SizeType = pf.Enums.ReportImageSizeEnum.Custom + reportTemplate.ImageSize.Width = 1600 + reportTemplate.ImageSize.Height = 1200 + -- Generate the report + reportTemplate:Generate([[temp_StartupModelReport.docx]]) +end +Inheritance +The following objects are derived (specialisations) from the ResultReport object: +• QuickReport +• ReportTemplate +Property List +ImageFormat +The image format to use when exporting images for the template report. (Read/Write string) +ImageSize +Report image export size options. (Read only ReportImageSizeSetting) +Property Details +ImageFormat +The image format to use when exporting images for the template report. +Type +string +Access +Read/Write +ImageSize +Report image export size options. +Type +ReportImageSizeSetting +Access +Read only +ResultSurfacePlot +A result surface plot. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Add a far field surface plot to a new surface graph +graph = app.CartesianSurfaceGraphs:Add() +farFieldPlot = graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Hide the far field plot +farFieldPlot.Visible = false +Inheritance +The ResultSurfacePlot object is derived from the ResultPlot object. +The following objects are derived (specialisations) from the ResultSurfacePlot object: +• CustomDataSurfacePlot +• FarFieldSurfacePlot +• NearFieldSurfacePlot +• SParameterSurfacePlot +Usage locations +The ResultSurfacePlot object can be accessed from the following locations: +• Methods +◦ ResultSurfacePlotCollection collection has method Items(). +◦ ResultSurfacePlotCollection collection has method Item(number). +◦ ResultSurfacePlotCollection collection has method Item(string). +Property List +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the surface plot. (Read/Write ResultData) +HorizontalIndependentAxis +The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/ +Write string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Label +The object label. (Read/Write string) +Legend +p.3763 +The surface plot legend properties. (Read only SurfacePlotLegendFormat) +Sampling +The continuous surface plot sampling settings. These settings only apply to traces when the +independent axis is continuously sampled. (Read only SurfacePlotSamplingFormat) +VerticalIndependentAxis +The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write +string) +Visible +Specifies whether the surface plot must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the surface plot. +SwitchIndependentAxes () +Switches the horizontal and vertical independent axes. +Property Details +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the surface plot. +Type +ResultData +Access +Read/Write +HorizontalIndependentAxis +The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Legend +The surface plot legend properties. +Type +SurfacePlotLegendFormat +Access +Read only +Sampling +The continuous surface plot sampling settings. These settings only apply to traces when the +independent axis is continuously sampled. +Type +SurfacePlotSamplingFormat +Access +Read only +VerticalIndependentAxis +The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Visible +Specifies whether the surface plot must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the surface plot. +SwitchIndependentAxes () +Switches the horizontal and vertical independent axes. +ResultTextBox +A 2D results text box. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +app.Views[1]:Close() + -- Add a Cartesian graph to the application's collection and obtain + -- the shapes collection +graph = app.CartesianGraphs:Add() +shapes = graph.Shapes +textBox1 = shapes:AddTextBox("TextBox", 20,30) +textBox1.TextDirection = pf.Enums.TextDirectionEnum.Rotate90 +textBox1.BackColour = pf.Enums.ColourEnum.Yellow +textBox1.Width = 100 +textBox1.Height = 150 +circle1 = shapes:AddCircle(35,30) +circle1.BackColour = pf.Enums.ColourEnum.Cyan +rectangle1 = shapes:AddRectangle(50,30) +rectangle1.BackColour = pf.Enums.ColourEnum.Magenta +Usage locations +The ResultTextBox object can be accessed from the following locations: +• Methods +◦ ResultTextBox object has method Duplicate(). +◦ ResultTextBoxCollection collection has method Items(). +◦ ResultTextBoxCollection collection has method Item(number). +◦ ResultTextBoxCollection collection has method Item(string). +◦ ResultTextBoxCollection collection has method AddTextBox(string). +◦ ResultTextBoxCollection collection has method AddTextBox(string, number, number). +◦ ResultTextBoxCollection collection has method AddCircle(number, number). +◦ ResultTextBoxCollection collection has method AddRectangle(number, number). +Property List +BackColour +The background colour. See ColourEnum. (Read/Write string) +FontBoldfaced +Enables font bold. (Read/Write boolean) +FontColour +The font colour. See ColourEnum. (Read/Write string) +FontFamily +The font family. (Read/Write string) +FontItalicised +Enables font italic. (Read/Write boolean) +FontSize +The font size. (Read/Write number) +FontUnderlined +Enables font underline. (Read/Write boolean) +Height +The text box height. (Read/Write number) +LineColour +The line colour. See ColourEnum. (Read/Write string) +LineStyle +The line style. See LineStyleEnum. (Read/Write string) +LineWeight +The line weight. (Read/Write number) +PositionX +The X coordinate position of the text box. Measured as a percentage of the width of the graph. +(Read/Write number) +PositionY +The Y coordinate position of the text box. Measured as a percentage of the height of the graph. +(Read/Write number) +ShadowSize +The drop shadow size. (Read/Write number) +ShadowVisible +Enables drop shadow visibility. (Read/Write boolean) +Text +The text box text. (Read/Write string) +TextDirection +The orientation of the text box text. See TextDirectionEnum. (Read/Write string) +Type +Width +The object type string. (Read only string) +The text box width. (Read/Write number) +Method List +Delete () +Delete the text box. +Duplicate () +Duplicate the text box. (Returns a ResultTextBox object.) +Lower () +Lower the text box. +Raise () +Raise the text box. +Property Details +BackColour +The background colour. See ColourEnum. +Type +string +Access +Read/Write +FontBoldfaced +Enables font bold. +Type +boolean +Access +Read/Write +FontColour +The font colour. See ColourEnum. +Type +string +Access +Read/Write +FontFamily +The font family. +Type +string +Access +Read/Write +FontItalicised +Enables font italic. +Type +boolean +Access +Read/Write +FontSize +The font size. +Type +number +Access +Read/Write +FontUnderlined +Enables font underline. +Type +boolean +Access +Read/Write +Height +The text box height. +Type +number +Access +Read/Write +LineColour +The line colour. See ColourEnum. +Type +string +Access +Read/Write +LineStyle +The line style. See LineStyleEnum. +Type +string +Access +Read/Write +LineWeight +The line weight. +Type +number +Access +Read/Write +PositionX +The X coordinate position of the text box. Measured as a percentage of the width of the graph. +Type +number +Access +Read/Write +PositionY +The Y coordinate position of the text box. Measured as a percentage of the height of the graph. +Type +number +Access +Read/Write +ShadowSize +The drop shadow size. +Type +number +Access +Read/Write +ShadowVisible +Enables drop shadow visibility. +Type +boolean +Access +Read/Write +Text +The text box text. +Type +string +Access +Read/Write +TextDirection +The orientation of the text box text. See TextDirectionEnum. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Width +The text box width. +Type +number +Access +Read/Write +Method Details +Delete () +Delete the text box. +Duplicate () +Duplicate the text box. +Return +ResultTextBox +The duplicated text box. +Lower () +Lower the text box. +Raise () +Raise the text box. +ResultTrace +A 2D results trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +app.Views[1]:Close() + -- Add a Cartesian graph to the application's collection +graph = app.CartesianGraphs:Add() + -- Add a far field trace to the Traces collection of the Cartesian graph + -- and create a copy +trace = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) +traceCopy = trace:Duplicate() +traceCopy.Label = trace.Label.."_copy" + -- Print all the axes defined on the trace +print("Trace axes:") +printlist(trace.AxisNames) + -- Enable filled circle markers on the trace copy +traceCopy.Markers.Symbol = pf.Enums.MarkerSymbolEnum.FilledCircle + -- Print the available horizontal axes, and set the trace horizontal axis to + -- "Theta (wrapped)", the third axes in the list of available axes and the + -- copied trace to "Theta" +print("Independent axes:") +printlist(trace.IndependentAxesAvailable) +trace.IndependentAxis = trace.IndependentAxesAvailable[3] +traceCopy.IndependentAxis = traceCopy.IndependentAxesAvailable[2] +graph:ZoomToExtents() + -- SetProperties the legends of the traces accordingly +trace.Legend.Text = "Theta wrapped" +traceCopy.Legend.Text = "Theta" + -- Remove the copied trace and change the remaining trace horizontal + -- (independent) axis unit to radians +traceCopy:Delete() +trace.Axes.Independent.Unit = "rad" +graph:ZoomToExtents() +Inheritance +The ResultTrace object is derived from the ResultPlot object. +The following objects are derived (specialisations) from the ResultTrace object: +• CharacteristicModeTrace +• CustomDataSmithTrace +• CustomDataTrace +• ExcitationSmithTrace +• ExcitationTrace +• FarFieldPowerIntegralTrace +• FarFieldTrace +• LoadSmithTrace +• LoadTrace +• MathTrace +• NearFieldPowerIntegralTrace +• NearFieldTrace +• NetworkTrace +• PowerTrace +• ReceivingAntennaTrace +• SARTrace +• SParameterTrace +• SpiceProbeTrace +• TRCoefficientTrace +• WireCurrentsTrace +Usage locations +The ResultTrace object can be accessed from the following locations: +• Properties +◦ WidthAnnotation object has property Trace. +◦ SimpleAnnotation object has property Trace. +◦ +ImplicitPointsAnnotation object has property Trace. +◦ BeamwidthAnnotation object has property Trace. +◦ BandwidthAnnotation object has property Trace. +◦ GraphAnnotation object has property Trace. +• Methods +◦ CharacteristicModeTrace object has method Store(). +◦ CharacteristicModeTrace object has method Duplicate(). +◦ CustomDataSmithTrace object has method Duplicate(). +◦ CustomDataTrace object has method Duplicate(). +◦ MathTrace object has method Duplicate(). +◦ SpiceProbeTrace object has method Store(). +◦ SpiceProbeTrace object has method Duplicate(). +◦ FarFieldPowerIntegralTrace object has method Store(). +◦ FarFieldPowerIntegralTrace object has method Duplicate(). +◦ NearFieldPowerIntegralTrace object has method Store(). +◦ NearFieldPowerIntegralTrace object has method Duplicate(). +◦ TRCoefficientTrace object has method Store(). +◦ TRCoefficientTrace object has method Duplicate(). +◦ LoadSmithTrace object has method Store(). +◦ LoadSmithTrace object has method Duplicate(). +◦ ExcitationSmithTrace object has method Store(). +◦ ExcitationSmithTrace object has method Duplicate(). +◦ SARTrace object has method Store(). +◦ SARTrace object has method Duplicate(). +◦ WireCurrentsTrace object has method Store(). +◦ WireCurrentsTrace object has method Duplicate(). +◦ SParameterTrace object has method Store(). +◦ SParameterTrace object has method Duplicate(). +◦ PowerTrace object has method Store(). +◦ PowerTrace object has method Duplicate(). +◦ LoadTrace object has method Store(). +◦ LoadTrace object has method Duplicate(). +◦ ExcitationTrace object has method Store(). +◦ ExcitationTrace object has method Duplicate(). +◦ FarFieldTrace object has method Store(). +◦ FarFieldTrace object has method Duplicate(). +◦ NearFieldTrace object has method Store(). +◦ NearFieldTrace object has method Duplicate(). +◦ ReceivingAntennaTrace object has method Store(). +◦ ReceivingAntennaTrace object has method Duplicate(). +◦ NetworkTrace object has method Store(). +◦ NetworkTrace object has method Duplicate(). +◦ ResultTrace object has method Duplicate(). +◦ ResultTraceCollection collection has method Items(). +◦ ResultTraceCollection collection has method Item(number). +◦ ResultTraceCollection collection has method Item(string). +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ResultTrace +The duplicated trace. +Lower () +Lower the trace. +Raise () +Raise the trace. +p.3778 +SAR3DPlot +A SAR 3D result. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) +SARData = app.Models[1].Configurations[1].SAR["SAR2"] + -- Add the SAR to the 3D view +SARPlot = app.Views[1].Plots:Add(SARData) +Inheritance +The SAR3DPlot object is derived from the Result3DPlot object. +Property List +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The object that is the data source for this plot. (Read/Write ResultData) +Label +The object label. (Read/Write string) +Legend +The 3D plot legend properties. (Read only Plot3DLegendFormat) +Type +The object type string. (Read only string) +Visible +Specifies whether the plot must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the plot. +Duplicate () +Duplicate the plot. (Returns a Result3DPlot object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Stores a copy of the plot. (Returns a Result3DPlot object.) +Property Details +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The object that is the data source for this plot. +Type +ResultData +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The 3D plot legend properties. +Type +Plot3DLegendFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Visible +Specifies whether the plot must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the plot. +Duplicate () +Duplicate the plot. +Return +Result3DPlot +The duplicated plot. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Stores a copy of the plot. +Return +Result3DPlot +The new plot associated with the stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SARData +SAR results generated by the Feko Solver. +Example +p.3782 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Retrieve the 'SARData' called 'SAR2' +SARData = app.Models[1].Configurations[1].SAR["SAR2"] + -- Add the SAR data to the 3D view +SARPlot = app.Views[1].Plots:Add(SARData) + -- Get the SAR data set +SARDataSet = SARData:GetDataSet() +Inheritance +The SARData object is derived from the ResultData object. +Usage locations +The SARData object can be accessed from the following locations: +• Methods +◦ SARCollection collection has method Items(). +◦ SARCollection collection has method Item(number). +◦ SARCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the SAR values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the SAR values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the SAR values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the SAR values. +Return +DataSet +The data set containing the SAR values. +GetDataSet (samplePoints number) +Returns a data set containing the SAR values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the near field values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the SAR values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the SAR values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +SARQuantity +The SAR quantity properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) +SARData = app.Models[1].Configurations[1].SAR["SAR2"] + -- Add the SAR data to a Cartesian graph +graph = app.CartesianGraphs:Add() +SARTrace1 = graph.Traces:Add(SARData) + -- SetProperties the quantity +SARTrace1.Quantity.Type = pf.Enums.SARQuantityTypeEnum.PeakSAR +Usage locations +The SARQuantity object can be accessed from the following locations: +• Properties +◦ SARTrace object has property Quantity. +Property List +Type +The type of quantity to be plotted, specified by the SARQuantityTypeEnum, e.g. Peak SAR, +Average SAR over requested domain, etc. (Read/Write SARQuantityTypeEnum) +Property Details +Type +The type of quantity to be plotted, specified by the SARQuantityTypeEnum, e.g. Peak SAR, +Average SAR over requested domain, etc. +Type +SARQuantityTypeEnum +Access +Read/Write +SARStoredData +Stored SAR results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/SAR_Example.fek]]) + -- Obtain a 'SARStoredData' object +sar = app.Models[1].Configurations[1].SAR +sarData = sar["SAR1"] +sarStoredData = sarData:StoreData() + -- Print the label of the'SARStoredData' object +print("Stored data (in the project browser window) : " .. sarStoredData.Label) +Inheritance +The SARStoredData object is derived from the ResultData object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the SAR values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the SAR values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the SAR values. (Returns a DataSet object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the SAR values. +Return +DataSet +The data set containing the SAR values. +GetDataSet (samplePoints number) +Returns a data set containing the SAR values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the SAR values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the SAR values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the SAR values. +SARTrace +A SAR 2D trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) +SARData = app.Models[1].Configurations[1].SAR["SAR1"] + -- Create a Cartesian graph and the SAR data +graph = app.CartesianGraphs:Add() +SARTrace = graph.Traces:Add(SARData) + -- Configure the trace quantity +SARTrace.Quantity.Type = pf.Enums.SARQuantityTypeEnum.AverageOverTotalDomain +Inheritance +The SARTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The SAR trace math expression properties. (Read only TraceMathExpression) +Quantity +The SAR trace quantity properties. (Read only SARQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The SAR trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The SAR trace quantity properties. +Type +SARQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SParameterData +S-parameter results generated by the Feko Solver. +Example +p.3796 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Waveguide_Divider.fek]]) + -- Retrieve the 'SParameterData' called 'SParameter1' from the S-parameter + configuration +sParameterData = + app.Models[1].Configurations["SParameterConfiguration1"].SParameters["SParameter1"] + -- Manipulate the S-Parameter data. See 'DataSet' for faster and more + comprehensive options +dataSet = sParameterData:GetDataSet() +print(dataSet) -- Describes the structure of the data +inspect(dataSet) -- Gives a list of the data set contents + -- Find the frequency start and end values +frequencyAxis = dataSet.Axes["Frequency"] +frequencyStartValue = frequencyAxis:ValueAt(1) +frequencyEndValue = frequencyAxis:ValueAt(#frequencyAxis) + -- Scale the s-parameter values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + for portIndex = 1, #dataSet.Axes["Arbitrary"] do + indexedValue = dataSet[freqIndex][portIndex] + indexedValue.SParameter = indexedValue.SParameter * scale + end +end + -- Store the manipulated data +scaledSParameter = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.SParameter) + -- Compare the original S-Parameter to the manipulated S-Parameter +graph = app.CartesianGraphs:Add() +sParameterTrace1 = graph.Traces:Add(sParameterData) +sParameterTrace1:SetFixedAxisValue("S-parameter", "S3,1") +sParameterTrace2 = graph.Traces:Add(scaledSParameter) +sParameterTrace2:SetFixedAxisValue("Arbitrary", "S3,1") +Inheritance +The SParameterData object is derived from the ResultData object. +Usage locations +The SParameterData object can be accessed from the following locations: +• Methods +◦ SParameterCollection collection has method Items(). +◦ SParameterCollection collection has method Item(number). +◦ SParameterCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file (reference impedance +specified). +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file (reference impedance not +specified). +GetDataSet () +Returns a data set containing the S-parameter values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the S-parameter values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the S-parameter values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file (reference impedance +specified). +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file (reference impedance not +specified). +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the S-parameter values. +Return +DataSet +The data set containing the S-parameter values. +GetDataSet (samplePoints number) +Returns a data set containing the S-parameter values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the S-parameter values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the S-parameter values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the S-parameter values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SParameterMathScript +S-parameter math script data that can be plotted. +Example +p.3801 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Waveguide_Divider.fek]]) + -- Create a S-parameter math script +sParameterMathScript = app.MathScripts:Add(pf.Enums.MathScriptTypeEnum.SParameter) +script = +[[ +dataSet = + pf.SParameter.GetDataSet("Waveguide_Divider.SParameterConfiguration1.SParameter1") +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + for portIndex = 1, #dataSet.Axes["Arbitrary"] do + indexedValue = dataSet[freqIndex][portIndex] + indexedValue.SParameter = indexedValue.SParameter * scale + end +end +return dataSet +]] +sParameterMathScript.Script = script +sParameterMathScript:Run() + -- Plot the math script +graph = app.CartesianGraphs:Add() +sParameterTrace1 = graph.Traces:Add(sParameterMathScript) +Inheritance +The SParameterMathScript object is derived from the MathScript object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Script +Type +The object label. (Read/Write string) +The script code to execute. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. (Returns a MathScript object.) +GetDataSet () +Returns a data set containing the math script values. (Returns a DataSet object.) +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Script +The script code to execute. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. +Return +MathScript +The duplicated math script. +GetDataSet () +Returns a data set containing the math script values. +Return +DataSet +The data set containing the math script values. +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SParameterQuantity +The S-parameter quantity properties. +Example +p.3804 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Waveguide_Divider.fek]]) + -- Retrieve the 'SParameterData' called 'SParameter1' from the S-parameter + configuration +sParameterData = + app.Models[1].Configurations["SParameterConfiguration1"].SParameters["SParameter1"] + -- Add the s-parameter to the a Cartesian graph +graph = app.CartesianGraphs:Add() +sParameterTrace = graph.Traces:Add(sParameterData) + -- Configure the fixed axis +sParameterTrace.Quantity.ComplexComponent = pf.Enums.ComplexComponentEnum.Real +sParameterTrace.Quantity.ValuesNormalised = true +Usage locations +The SParameterQuantity object can be accessed from the following locations: +• Properties +◦ SParameterSurfacePlot object has property Quantity. +◦ SParameterTrace object has property Quantity. +Property List +ComplexComponent +The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. +Magnitude, Phase, Real, Imaginary. (Read/Write ComplexComponentEnum) +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. (Read/Write boolean) +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. (Read/Write boolean) +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when the ComplexComponent is Magnitude. (Read/Write boolean) +Property Details +ComplexComponent +The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. +Magnitude, Phase, Real, Imaginary. +Type +ComplexComponentEnum +Access +Read/Write +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when the ComplexComponent is Magnitude. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SParameterStoredData +Stored S-parameter results. +Example +p.3806 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Waveguide_Divider.fek]]) + -- Retrieve the 'SParameterData' called 'SParameter1' from the S-parameter + configuration +sParameterData = + app.Models[1].Configurations["SParameterConfiguration1"].SParameters["SParameter1"] + -- Store a copy of the S-parameter data. +storedData = + sParameterData:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.SParameter) +Inheritance +The SParameterStoredData object is derived from the ResultData object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +GetDataSet () +Returns a data set containing the S-parameter values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the S-parameter values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the S-parameter values. (Returns a DataSet object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the S-parameter values. +Return +DataSet +The data set containing the S-parameter values. +GetDataSet (samplePoints number) +Returns a data set containing the S-parameter values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the S-parameter values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the S-parameter values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the S-parameter values. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SParameterSurfacePlot +A S-parameter surface plot. +Example +p.3810 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/sparameter.pfs]]) +sParameterData = app.StoredData[1] +graph = app.CartesianSurfaceGraphs:Add() + -- Add the S-parameter data to a Cartesian surface graph +sParameterPlot = graph.Plots:Add(sParameterData) + -- Configure the plot quantity +sParameterPlot:SetFixedAxisValue("S-parameter", "S2,1") +Inheritance +The SParameterSurfacePlot object is derived from the ResultSurfacePlot object. +Property List +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the surface plot. (Read/Write ResultData) +DiscretePlotEnabled +Specifies whether the discrete plot property is enabled or disabled for this surface plot. (Read/ +Write boolean) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +HorizontalIndependentAxis +The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/ +Write string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +Label +The object label. (Read/Write string) +Legend +The surface plot legend properties. (Read only SurfacePlotLegendFormat) +Quantity +The S-parameter plot quantity properties. (Read only SParameterQuantity) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Sampling +p.3811 +The continuous surface plot sampling settings. These settings only apply to traces when the +independent axis is continuously sampled. (Read only SurfacePlotSamplingFormat) +Type +The object type string. (Read only string) +VerticalIndependentAxis +The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write +string) +Visible +Specifies whether the surface plot must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the surface plot. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the surface plot. +SwitchIndependentAxes () +Switches the horizontal and vertical independent axes. +Property Details +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +DataSource +The source of the surface plot. +Type +ResultData +Access +Read/Write +DiscretePlotEnabled +p.3812 +Specifies whether the discrete plot property is enabled or disabled for this surface plot. +Type +boolean +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +HorizontalIndependentAxis +The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Legend +The surface plot legend properties. +Type +SurfacePlotLegendFormat +Access +Read only +Quantity +The S-parameter plot quantity properties. +Type +SParameterQuantity +Access +Read only +Sampling +The continuous surface plot sampling settings. These settings only apply to traces when the +independent axis is continuously sampled. +Type +SurfacePlotSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VerticalIndependentAxis +The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Visible +Specifies whether the surface plot must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the surface plot. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +Altair Feko 2022.3 +2 Application Programming Interface (API) +strvalue(string) +The axis value. +SetProperties (properties table) +p.3815 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the surface plot. +SwitchIndependentAxes () +Switches the horizontal and vertical independent axes. +SParameterTrace +A S-parameter 2D trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Waveguide_Divider.fek]]) + -- Retrieve the 'SParameterData' called 'SParameter1' from the S-parameter + configuration +sParameterData = + app.Models[1].Configurations["SParameterConfiguration1"].SParameters["SParameter1"] + -- Add the s-parameter to the a Cartesian graph +graph = app.CartesianGraphs:Add() +sParameterTrace = graph.Traces:Add(sParameterData) + -- Configure the fixed axis +sParameterTrace:SetFixedAxisValue("S-parameter", "S3,1") +Inheritance +The SParameterTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The S-parameter trace math expression properties. (Read only TraceMathExpression) +Quantity +The S-parameter trace quantity properties. (Read only SParameterQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +p.3818 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The S-parameter trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The S-parameter trace quantity properties. +Type +SParameterQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +ShadowFormat +The shadow format property. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianGraphs:Add() +graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Edit title 'ShadowFormat' of the title frame +graph.Title.Frame.Shadow.Size = 1 +graph.Title.Frame.Shadow.Visible = true +Usage locations +The ShadowFormat object can be accessed from the following locations: +• Properties +◦ FrameFormat object has property Shadow. +Property List +Size +The drop shadow size. (Read/Write number) +Visible +Set the drop shadow visibility. (Read/Write boolean) +Property Details +Size +The drop shadow size. +Type +number +Access +Read/Write +Visible +Set the drop shadow visibility. +Type +boolean +Access +Read/Write +SimpleAnnotation +A 2D graph simple annotation. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +app.Views[1]:Close() + -- Add a Cartesian graph to the application's collection and obtain + -- the arrow collection +graph = app.CartesianGraphs:Add() +farFieldTrace = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) +graph:ZoomToExtents() +annotations = graph.Annotations +annotation1 = annotations:AddGlobalMaximum(farFieldTrace) +annotation2 = annotation1:Duplicate() +annotation1:Delete() +Inheritance +The SimpleAnnotation object is derived from the GraphAnnotation object. +Property List +AnnotationRelativeType +For annotations that are relative to other graph positions, this values sets what it is relative to. +(Read/Write AnnotationRelativeTypeEnum) +AutoTextEnabled +Toggle between auto text and custom annotation text. (Read/Write boolean) +Label +The object label. (Read/Write string) +OffsetX +Annotation text box offset (pixels) in the x-direction. A positive value moves the annotation to the +right, a negative value moves it to the left. If both the OffsetX and OffsetY is zero, it will be placed +automatically. (Read/Write number) +OffsetY +Annotation text box offset (pixels) in the y-direction. A positive value moves the annotation to +the bottom, a negative value moves it to the top. If both the OffsetX and OffsetY is zero, it will be +placed automatically. (Read/Write number) +PositionHorizontal +Annotation horizontal (x) position. (Read/Write number) +PositionVertical +Annotation vertical (y) position. (Read/Write number) +SinglePointAnnotationType +The single point annotation type. (Read/Write SinglePointAnnotationTypeEnum) +Text +Trace +Type +The annotation text. (Read/Write string) +The ResultTrace of the annotation. (Read/Write ResultTrace) +The object type string. (Read only string) +Method List +Delete () +Delete the annotation. +Duplicate () +Duplicate the annotation. (Returns a GraphAnnotation object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +GetValues () +Get table of values associated with the annotation. (Returns a Map of string:Expression object.) +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Property Details +AnnotationRelativeType +For annotations that are relative to other graph positions, this values sets what it is relative to. +Type +AnnotationRelativeTypeEnum +Access +Read/Write +AutoTextEnabled +Toggle between auto text and custom annotation text. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +OffsetX +Annotation text box offset (pixels) in the x-direction. A positive value moves the annotation to the +right, a negative value moves it to the left. If both the OffsetX and OffsetY is zero, it will be placed +automatically. +Type +number +Access +Read/Write +OffsetY +Annotation text box offset (pixels) in the y-direction. A positive value moves the annotation to +the bottom, a negative value moves it to the top. If both the OffsetX and OffsetY is zero, it will be +placed automatically. +Type +number +Access +Read/Write +PositionHorizontal +Annotation horizontal (x) position. +Type +number +Access +Read/Write +PositionVertical +Annotation vertical (y) position. +Type +number +Access +Read/Write +SinglePointAnnotationType +The single point annotation type. +Type +SinglePointAnnotationTypeEnum +Access +Read/Write +Text +The annotation text. +Type +string +Access +Read/Write +Trace +The ResultTrace of the annotation. +Type +ResultTrace +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the annotation. +Duplicate () +Duplicate the annotation. +Return +GraphAnnotation +The new annotation. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +GetValues () +A properties table. +Get table of values associated with the annotation. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +Map of string:Expression +Table of key-value pairs. +SetProperties (properties table) +p.3828 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SmithChart +A 2D Smith chart where results can be plotted. +Example +p.3829 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a graph with a trace +graph = app.SmithCharts:Add() +voltageSourceTrace = graph.Traces:Add(app.Models[1].Configurations[1].Excitations[1]) + -- Export an image +graph:ExportImage("temp_ExcitationGraph", "pdf") +Inheritance +The SmithChart object is derived from the Graph object. +Usage locations +The SmithChart object can be accessed from the following locations: +• Methods +◦ CartesianGraph object has method DuplicateAsSmith(). +◦ SmithChartCollection collection has method Items(). +◦ SmithChartCollection collection has method Item(number). +◦ SmithChartCollection collection has method Item(string). +◦ SmithChartCollection collection has method Add(). +Property List +BackColour +The background colour of the graph. (Read/Write Colour) +Footer +The graph footer properties. (Read only TextBox) +GreyscaleEnabled +Set the graph's colour scheme to greyscale. (Read/Write boolean) +Grid +The Smith chart grid properties. (Read only SmithChartGrid) +GridType +The Smith chart grid type. (Read/Write GridTypeEnum) +Height +The height of the window. (Read only number) +Legend +The graph legend properties. (Read only GraphLegend) +ReactanceAxisFont +The Smith chart reactance axis font style. (Read only FontFormat) +ResistanceAxisFont +The Smith chart resistance axis font style. (Read only FontFormat) +Title +Type +Width +The graph title properties. (Read only TextBox) +The object type string. (Read only string) +The width of the window. (Read only number) +WindowActive +True if this window is the active window. (Read only boolean) +WindowTitle +The title of the window. (Read/Write string) +XPosition +The X position of the window. (Read only number) +YPosition +The Y position of the window. (Read only number) +Collection List +Annotations +The collection of 2D annotations on the graph. (ResultAnnotationCollection of GraphAnnotation.) +Arrows +The collection of 2D arrows on the graph. (ResultArrowCollection of ResultArrow.) +Shapes +The collection of 2D shapes on the graph. (ResultTextBoxCollection of ResultTextBox.) +Traces +The collection of 2D traces on the graph. (ResultTraceCollection of ResultTrace.) +Method List +AddChartImage (view View, posX number, posY number) +Add a 3D view image to this 2D Graph. +AddChartImageFromFile (file string, posX number, posY number) +Add an image file to this 2D Graph. +BlockGraphRedraws () +Disables graph redraws for performance purposes. When all the changes to the graph are +complete, call UnblockGraphRedraws to re-enable graph updates. +Close () +Close the window. +Duplicate () +Duplicate the 2D graph. (Returns a Graph object.) +DuplicateAsCartesian () +Creates a Cartesian graph with the same data as the Smith chart. (Returns a CartesianGraph +object.) +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +ExportTraces (filename string, samples number) +Export the graph traces to the specified tab separated file. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Show () +Shows the view. +UnblockGraphRedraws () +Enables graph redraws. This method is used in conjunction with BlockGraphRedraws for +performance purposes. The graph is redrawn when this method is called and normals redraws will +occur on changes. +ZoomToExtents () +Zoom the content of the window to its extent. +Property Details +BackColour +The background colour of the graph. +Type +Colour +Access +Read/Write +Footer +The graph footer properties. +Type +TextBox +Access +Read only +GreyscaleEnabled +Set the graph's colour scheme to greyscale. +Type +boolean +Access +Read/Write +Grid +The Smith chart grid properties. +Type +SmithChartGrid +Access +Read only +GridType +The Smith chart grid type. +Type +GridTypeEnum +Access +Read/Write +Height +The height of the window. +Type +number +Access +Read only +Legend +The graph legend properties. +Type +GraphLegend +Access +Read only +ReactanceAxisFont +The Smith chart reactance axis font style. +Type +FontFormat +Access +Read only +ResistanceAxisFont +The Smith chart resistance axis font style. +Type +FontFormat +Access +Read only +Title +The graph title properties. +Type +TextBox +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Width +The width of the window. +Type +number +Access +Read only +WindowActive +True if this window is the active window. +Type +boolean +Access +Read only +WindowTitle +The title of the window. +Type +string +Access +Read/Write +XPosition +The X position of the window. +Type +number +Access +Read only +YPosition +The Y position of the window. +Type +number +Access +Read only +Collection Details +Annotations +The collection of 2D annotations on the graph. +Type +Arrows +ResultAnnotationCollection +The collection of 2D arrows on the graph. +Type +ResultArrowCollection +Shapes +The collection of 2D shapes on the graph. +Type +Traces +ResultTextBoxCollection +The collection of 2D traces on the graph. +Type +ResultTraceCollection +Method Details +AddChartImage (view View, posX number, posY number) +Add a 3D view image to this 2D Graph. +Input Parameters +view(View) +The 3D view. +posX(number) +The x-position of the added chart image. +posY(number) +The y-position of the added chart image. +AddChartImageFromFile (file string, posX number, posY number) +Add an image file to this 2D Graph. +Input Parameters +file(string) +The file. +posX(number) +The x-position of the added chart image. +posY(number) +The y-position of the added chart image. +BlockGraphRedraws () +Disables graph redraws for performance purposes. When all the changes to the graph are +complete, call UnblockGraphRedraws to re-enable graph updates. +Close () +Close the window. +Duplicate () +Duplicate the 2D graph. +Return +Graph +The duplicated 2D graph. +DuplicateAsCartesian () +Creates a Cartesian graph with the same data as the Smith chart. +Return +CartesianGraph +The copied Cartesian graph. +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +imagewidth(number) +The export width in pixels. +imageheight(number) +The export height in pixels. +ExportTraces (filename string, samples number) +Export the graph traces to the specified tab separated file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +samples(number) +The number of samples for continuous data. This value will be ignored if the first trace +on the graph is discrete. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +Input Parameters +xposition(number) +The view X position. +yposition(number) +The view Y position. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Input Parameters +imagewidth(number) +The view width in pixels. +imageheight(number) +The view height in pixels. +Show () +Shows the view. +UnblockGraphRedraws () +Enables graph redraws. This method is used in conjunction with BlockGraphRedraws for +performance purposes. The graph is redrawn when this method is called and normals redraws will +occur on changes. +ZoomToExtents () +Zoom the content of the window to its extent. +SmithChartGrid +The Smith chart grid properties. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.SmithCharts:Add() + -- Update grid visualisation properties +graph.Grid.ReactanceLine.Weight = 2 +graph.Grid.BackColour = pf.Enums.ColourEnum.DarkGreen +Usage locations +The SmithChartGrid object can be accessed from the following locations: +• Properties +◦ SmithChart object has property Grid. +Property List +BackColour +The background colour of the Smith chart grid. (Read/Write Colour) +Border +The line format for the Smith chart grid border. (Read only GraphLineFormat) +ReactanceLine +The line format for the Smith chart reactance grid. (Read only GraphLineFormat) +ResistanceLine +The line format for the Smith chart resistance grid. (Read only GraphLineFormat) +Property Details +BackColour +The background colour of the Smith chart grid. +Type +Colour +Access +Read/Write +Border +The line format for the Smith chart grid border. +Type +GraphLineFormat +Access +Read only +ReactanceLine +The line format for the Smith chart reactance grid. +Type +GraphLineFormat +Access +Read only +ResistanceLine +The line format for the Smith chart resistance grid. +Type +GraphLineFormat +Access +Read only +SolutionConfiguration +A solution configuration for which the model is simulated. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Get the first configuration in the configuration collection +config = app.Models[1].Configurations[1] + -- Get the far field, near field and currents collections from the configuration +startFrequency = config.StartFrequency +endFrequency = config.EndFrequency + -- Export the first near field + -- if it is a frequency configuration and it contains at least one far field +if (config.FrequencyConfiguration and config.FarFields.Count >= 1) then + config:ExportNearFields("temp_Export.efe", pf.Enums.NearFieldsExportTypeEnum.Electric, 10) +end +Usage locations +The SolutionConfiguration object can be accessed from the following locations: +• Properties +◦ LoadComplex object has property Configuration. +◦ LoadVoxel object has property Configuration. +◦ LoadSeries object has property Configuration. +◦ LoadParallel object has property Configuration. +◦ LoadNetwork object has property Configuration. +◦ LoadFEM object has property Configuration. +◦ LoadEdge object has property Configuration. +◦ LoadDistributed object has property Configuration. +◦ LoadCable object has property Configuration. +◦ LoadCoaxial object has property Configuration. +◦ LoadVertex object has property Configuration. +◦ SourceWaveguide object has property Configuration. +◦ SourceCurrentTriangle object has property Configuration. +◦ SourceSphericalModes object has property Configuration. +◦ SourceRadiationPattern object has property Configuration. +◦ SourceAperture object has property Configuration. +◦ SourceVoltageNetwork object has property Configuration. +◦ SourceVoltageCable object has property Configuration. +◦ SourceSolutionCoefficient object has property Configuration. +◦ SourcePCB object has property Configuration. +◦ SourceCurrentSpace object has property Configuration. +◦ SourceCurrentRegion object has property Configuration. +◦ SourceVoltageEdge object has property Configuration. +◦ SourceModal object has property Configuration. +◦ SourceMagneticDipole object has property Configuration. +◦ SourceElectricDipole object has property Configuration. +◦ SourceCoaxial object has property Configuration. +◦ SourceMagneticFrill object has property Configuration. +◦ SourceVoltageVertex object has property Configuration. +◦ SourceVoltageSegment object has property Configuration. +◦ SourcePlaneWave object has property Configuration. +◦ CharacteristicModeData object has property Configuration. +◦ SpiceProbeData object has property Configuration. +◦ FarFieldPowerIntegralData object has property Configuration. +◦ NearFieldPowerIntegralData object has property Configuration. +◦ TRCoefficientData object has property Configuration. +◦ RayData object has property Configuration. +◦ SphericalModesReceivingAntennaData object has property Configuration. +◦ NearFieldReceivingAntennaData object has property Configuration. +◦ FarFieldReceivingAntennaData object has property Configuration. +◦ ReceivingAntennaData object has property Configuration. +◦ TransmissionLineData object has property Configuration. +◦ NetworkData object has property Configuration. +◦ SARData object has property Configuration. +◦ WireCurrentsData object has property Configuration. +◦ SurfaceCurrentsData object has property Configuration. +◦ ErrorEstimateData object has property Configuration. +◦ SParameterData object has property Configuration. +◦ PowerData object has property Configuration. +◦ LoadData object has property Configuration. +◦ ExcitationData object has property Configuration. +◦ FarFieldData object has property Configuration. +◦ NearFieldData object has property Configuration. +◦ FormConfigurationSelector object has property Value. +• Methods +◦ ConfigurationCollection collection has method Items(). +◦ ConfigurationCollection collection has method Item(number). +◦ ConfigurationCollection collection has method Item(string). +Property List +EndFrequency +The end frequency of the configuration. (Read only number) +FrequencyConfiguration +The configuration is a frequency configuration. (Read only boolean) +Label +Mesh +Model +The object label. (Read only string) +The mesh used to simulate the configuration. (Read only Mesh) +The solution configuration's associated model. (Read only Model) +StartFrequency +The start frequency of the configuration. (Read only number) +Type +The object type string. (Read only string) +Collection List +CharacteristicModes +The characteristic modes result in the configuration. This collection will only contain one item. +(CharacteristicModeCollection of CharacteristicModeData.) +ErrorEstimates +The collection of error estimates in the configuration. (ErrorEstimateCollection of +ErrorEstimateData.) +Excitations +The collection of excitations in the configuration. (ExcitationCollection of ExcitationData.) +FarFieldPowerIntegrals +The collection of far field power integrals in the configuration. (FarFieldPowerIntegralCollection of +FarFieldPowerIntegralData.) +FarFields +The collection of far fields in the configuration. (FarFieldCollection of FarFieldData.) +Loads +The collection of loads in the configuration. (LoadCollection of LoadData.) +NearFieldPowerIntegrals +The collection of near field power integrals in the configuration. (NearFieldPowerIntegralCollection +of NearFieldPowerIntegralData.) +NearFields +The collection of near fields in the configuration. (NearFieldCollection of NearFieldData.) +Networks +The collection of networks in the configuration. (NetworkCollection of NetworkData.) +Power +The power result in the configuration. This collection will only contain one item. (PowerCollection +of PowerData.) +Rays +The rays result in the configuration. This collection will only contain one item. (RayCollection of +RayData.) +ReceivingAntennas +The collection of receiving antennas in the configuration. (ReceivingAntennaCollection of +ReceivingAntennaData.) +SAR +The collection of SAR results in the configuration. (SARCollection of SARData.) +SParameters +The collection of S-parameters in the configuration. (SParameterCollection of SParameterData.) +SpiceProbes +The collection of SPICE probes in the configuration. (SpiceProbeCollection of SpiceProbeData.) +SurfaceCurrents +The collection of surface currents in the configuration. (SurfaceCurrentsCollection of +SurfaceCurrentsData.) +TRCoefficients +The collection of transmission reflection coefficients in the configuration. (TRCoefficientCollection +of TRCoefficientData.) +TransmissionLines +The collection of transmission lines in the configuration. (TransmissionLineCollection of +TransmissionLineData.) +WireCurrents +The collection of wire currents in the configuration. (WireCurrentsCollection of WireCurrentsData.) +Method List +ExportFarFields (filename string, quantity FarFieldsExportTypeEnum, samples number) +Export all the result far field data in the configuration to the specified *.ffe file. +ExportNearFields (filename string, components NearFieldsExportTypeEnum, samples number) +Export all the result near field data the configuration to the specified *.efe / *.hfe file. +Property Details +EndFrequency +The end frequency of the configuration. +Type +number +Access +Read only +FrequencyConfiguration +The configuration is a frequency configuration. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read only +Mesh +Model +The mesh used to simulate the configuration. +Type +Mesh +Access +Read only +The solution configuration's associated model. +Type +Model +Access +Read only +StartFrequency +The start frequency of the configuration. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Collection Details +CharacteristicModes +The characteristic modes result in the configuration. This collection will only contain one item. +Type +CharacteristicModeCollection +ErrorEstimates +The collection of error estimates in the configuration. +Type +ErrorEstimateCollection +Excitations +The collection of excitations in the configuration. +Type +ExcitationCollection +FarFieldPowerIntegrals +The collection of far field power integrals in the configuration. +Type +FarFields +FarFieldPowerIntegralCollection +The collection of far fields in the configuration. +Type +FarFieldCollection +Loads +The collection of loads in the configuration. +Type +LoadCollection +NearFieldPowerIntegrals +The collection of near field power integrals in the configuration. +Type +NearFields +NearFieldPowerIntegralCollection +The collection of near fields in the configuration. +Type +NearFieldCollection +Networks +The collection of networks in the configuration. +Type +NetworkCollection +Power +Rays +The power result in the configuration. This collection will only contain one item. +Type +PowerCollection +The rays result in the configuration. This collection will only contain one item. +Type +RayCollection +ReceivingAntennas +The collection of receiving antennas in the configuration. +Type +SAR +ReceivingAntennaCollection +The collection of SAR results in the configuration. +Type +SARCollection +SParameters +The collection of S-parameters in the configuration. +Type +SParameterCollection +SpiceProbes +The collection of SPICE probes in the configuration. +Type +SpiceProbeCollection +SurfaceCurrents +The collection of surface currents in the configuration. +Type +SurfaceCurrentsCollection +TRCoefficients +The collection of transmission reflection coefficients in the configuration. +Type +TRCoefficientCollection +TransmissionLines +The collection of transmission lines in the configuration. +Type +TransmissionLineCollection +WireCurrents +The collection of wire currents in the configuration. +Type +WireCurrentsCollection +Method Details +ExportFarFields (filename string, quantity FarFieldsExportTypeEnum, samples number) +Export all the result far field data in the configuration to the specified *.ffe file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +quantity(FarFieldsExportTypeEnum) +The quantity type to export specified by the FarFieldsExportTypeEnum, e.g. Gain, +Directivity, RCS, etc. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +ExportNearFields (filename string, components NearFieldsExportTypeEnum, samples number) +Export all the result near field data the configuration to the specified *.efe / *.hfe file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +components(NearFieldsExportTypeEnum) +The components to export specified by the NearFieldsExportTypeEnum, e.g. Both +(*.efe and *.hfe), Electric (*.efe) or Magnetic (*.hfe). +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +SourceAperture +Aperture field excitation results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Feeding_a_Horn_Antenna_Aperture_Feed.fek]]) + -- Get the aperture source and its label, configuration and type +apertureSource = app.Models[1].Configurations[1].Excitations[1] +configurationName = apertureSource.Configuration +sourceLabel = apertureSource.Label +sourceType = apertureSource.Type +Inheritance +The SourceAperture object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourceCoaxial +p.3851 +Coaxial approximation excitation results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/A4_source.fek]]) + -- Get the coaxial source and its label, configuration and type +coaxialSource = app.Models[1].Configurations[1].Excitations[1] +configurationName = coaxialSource.Configuration +sourceLabel = coaxialSource.Label +sourceType = coaxialSource.Type +Inheritance +The SourceCoaxial object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. (Read only Expression) +Type +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +GetDataSet () +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. +Type +Expression +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the source values. +Return +DataSet +The data set containing the source values. +GetDataSet (samplePoints number) +Returns a data set containing the source values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourceCurrentRegion +p.3856 +Impressed electric current in a region excitation results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/AF_source.fek]]) + -- Get the current region source and its label, configuration, type and DataSet +currentRegionSource = app.Models[1].Configurations[1].Excitations[1] +configurationName = currentRegionSource.Configuration +sourceLabel = currentRegionSource.Label +sourceType = currentRegionSource.Type +sourceDataSet = currentRegionSource:GetDataSet() +Inheritance +The SourceCurrentRegion object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. (Read only Expression) +Type +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +GetDataSet () +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. +Type +Expression +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the source values. +Return +DataSet +The data set containing the source values. +GetDataSet (samplePoints number) +Returns a data set containing the source values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourceCurrentSpace +p.3861 +Impressed electric current in space excitation results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Get the current space source and its label, configuration and type +currentSpaceSource = app.Models[1].Configurations[1].Excitations[10] +configurationName = currentSpaceSource.Configuration +sourceLabel = currentSpaceSource.Label +sourceType = currentSpaceSource.Type +Inheritance +The SourceCurrentSpace object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourceCurrentTriangle +p.3864 +Impressed current connected to triangle excitation results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Get the current triangle source and its label, configuration and type +currentTriangleSource = app.Models[1].Configurations[1].Excitations[11] +configurationName = currentTriangleSource.Configuration +sourceLabel = currentTriangleSource.Label +sourceType = currentTriangleSource.Type +Inheritance +The SourceCurrentTriangle object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +SourceElectricDipole +Electric dipole excitation results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Get the electric dipole source and its label, configuration and type +electricDipoleSource = app.Models[1].Configurations[1].Excitations[6] +configurationName = electricDipoleSource.Configuration +sourceLabel = electricDipoleSource.Label +sourceType = electricDipoleSource.Type +Inheritance +The SourceElectricDipole object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourceMagneticDipole +Magnetic dipole excitation results generated by the Feko Solver. +Example +p.3870 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Get the magnetic dipole source and its label, configuration and type +magneticDipoleSource = app.Models[1].Configurations[1].Excitations[7] +configurationName = magneticDipoleSource.Configuration +sourceLabel = magneticDipoleSource.Label +sourceType = magneticDipoleSource.Type +Inheritance +The SourceMagneticDipole object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +SourceMagneticFrill +Magnetic frill excitation results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/A3_source.fek]]) + -- Get the magnetic frill source and its label, configuration and type +magneticFrillSource = app.Models[1].Configurations[1].Excitations[1] +configurationName = magneticFrillSource.Configuration +sourceLabel = magneticFrillSource.Label +sourceType = magneticFrillSource.Type +sourceDataSet = magneticFrillSource:GetDataSet() +Inheritance +The SourceMagneticFrill object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. (Read only Expression) +Type +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +GetDataSet () +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. +Type +Expression +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the source values. +Return +DataSet +The data set containing the source values. +GetDataSet (samplePoints number) +Returns a data set containing the source values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +SourceModal +Modal port excitation results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/AB_source.fek]]) + -- Get the modal source and its label, configuration and type +modalSource = app.Models[1].Configurations[1].Excitations[1] +configurationName = modalSource.Configuration +sourceLabel = modalSource.Label +sourceType = modalSource.Type +sourceDataSet = modalSource:GetDataSet() +Inheritance +The SourceModal object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +GetDataSet () +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +p.3880 +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +Altair Feko 2022.3 +2 Application Programming Interface (API) +app:TileWindows() +p.3881 +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the source values. +Return +DataSet +The data set containing the source values. +GetDataSet (samplePoints number) +Returns a data set containing the source values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourcePCB +PCB excitation results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +p.3883 +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/AJ_source.fek]]) + -- Get the PCB source and its label, configuration and type +pcbSource = app.Models[1].Configurations[1].Excitations[1] +configurationName = pcbSource.Configuration +sourceLabel = pcbSource.Label +sourceType = pcbSource.Type +Inheritance +The SourcePCB object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +SourcePlaneWave +Plane wave excitation results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Get the plane wave source and its label, configuration and type +planeWaveSource = app.Models[1].Configurations[1].Excitations[1] +configurationName = planeWaveSource.Configuration +sourceLabel = planeWaveSource.Label +sourceType = planeWaveSource.Type +Inheritance +The SourcePlaneWave object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourceRadiationPattern +Radiation pattern excitation results generated by the Feko Solver. +Example +p.3889 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Get the radiation pattern source and its label, configuration and type +radiationPatternSource = app.Models[1].Configurations[1].Excitations[9] +configurationName = radiationPatternSource.Configuration +sourceLabel = radiationPatternSource.Label +sourceType = radiationPatternSource.Type +Inheritance +The SourceRadiationPattern object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourceSolutionCoefficient +Solution coefficient excitation results generated by the Feko Solver. +p.3892 +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/AM_source.fek]]) + -- Get the SolutionCoefficient source and its label, configuration and type +solutionCoefficientSource = app.Models[1].Configurations[1].Excitations[1] +configurationName = solutionCoefficientSource.Configuration +sourceLabel = solutionCoefficientSource.Label +sourceType = solutionCoefficientSource.Type +Inheritance +The SourceSolutionCoefficient object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourceSphericalModes +Spherical mode excitation results generated by the Feko Solver. +Example +p.3895 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Get the spherical mode source and its label, configuration and type +sphericalModeSource = app.Models[1].Configurations[1].Excitations[8] +configurationName = sphericalModeSource.Configuration +sourceLabel = sphericalModeSource.Label +sourceType = sphericalModeSource.Type +Inheritance +The SourceSphericalModes object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourceVoltageCable +Voltage on a cable excitation results generated by the Feko Solver. +Example +p.3898 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cable_Modelling.fek]]) + -- Get the cable voltage source and its label, configuration and type +cableVoltageSource = app.Models[1].Configurations[1].Excitations[1] +configurationName = cableVoltageSource.Configuration +sourceLabel = cableVoltageSource.Label +sourceType = cableVoltageSource.Type +sourceDataSet = cableVoltageSource:GetDataSet() +Inheritance +The SourceVoltageCable object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. (Read only Expression) +Type +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +GetDataSet () +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. +Type +Expression +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the source values. +Return +DataSet +The data set containing the source values. +GetDataSet (samplePoints number) +Returns a data set containing the source values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourceVoltageEdge +Voltage on an edge excitation results generated by the Feko Solver. +Example +p.3903 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Get the voltage edge source and its label, configuration and type +voltageEdgeSource = app.Models[1].Configurations[1].Excitations[12] +configurationName = voltageEdgeSource.Configuration +sourceLabel = voltageEdgeSource.Label +sourceType = voltageEdgeSource.Type +sourceDataSet = voltageEdgeSource:GetDataSet() + -- Export the data for the source +voltageEdgeSource:ExportData([[temp_Export]], pf.Enums.FrequencyUnitEnum.GHz, + pf.Enums.NetworkParameterTypeEnum.Impedance, pf.Enums.NetworkParameterFormatEnum.RI, 50, 2) +Inheritance +The SourceVoltageEdge object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. (Read only Expression) +Type +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +GetDataSet () +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. +p.3905 +Type +Expression +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the source values. +Return +DataSet +The data set containing the source values. +GetDataSet (samplePoints number) +Returns a data set containing the source values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourceVoltageNetwork +Voltage on a network excitation results generated by the Feko Solver. +Example +p.3908 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Get the voltage network source and its label, configuration and type +voltageNetworkSource = app.Models[1].Configurations[1].Excitations[14] +configurationName = voltageNetworkSource.Configuration +sourceLabel = voltageNetworkSource.Label +sourceType = voltageNetworkSource.Type +sourceDataSet = voltageNetworkSource:GetDataSet() + -- Export the data for the source +voltageNetworkSource:ExportData([[temp_Export]], pf.Enums.FrequencyUnitEnum.GHz, + pf.Enums.NetworkParameterTypeEnum.Impedance, pf.Enums.NetworkParameterFormatEnum.RI, 50, 2) +Inheritance +The SourceVoltageNetwork object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. (Read only Expression) +Type +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +GetDataSet () +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. +p.3910 +Type +Expression +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the source values. +Return +DataSet +The data set containing the source values. +GetDataSet (samplePoints number) +Returns a data set containing the source values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourceVoltageSegment +Voltage on a segment excitation results generated by the Feko Solver. +Example +p.3913 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Get the voltage segment source and its label, configuration and type +voltageSegmentSource = app.Models[1].Configurations[1].Excitations[2] +configurationName = voltageSegmentSource.Configuration +sourceLabel = voltageSegmentSource.Label +sourceType = voltageSegmentSource.Type +sourceDataSet = voltageSegmentSource:GetDataSet() + -- Export the data for the source +voltageSegmentSource:ExportData([[temp_Export]], pf.Enums.FrequencyUnitEnum.GHz, + pf.Enums.NetworkParameterTypeEnum.Impedance, pf.Enums.NetworkParameterFormatEnum.RI, 50, 2) +Inheritance +The SourceVoltageSegment object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. (Read only Expression) +Type +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +GetDataSet () +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. +p.3915 +Type +Expression +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the source values. +Return +DataSet +The data set containing the source values. +GetDataSet (samplePoints number) +Returns a data set containing the source values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourceVoltageVertex +Voltage on a vertex excitation results generated by the Feko Solver. +Example +p.3918 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Get the voltage vertex source and its label, configuration and type +voltageVertexSource = app.Models[1].Configurations[1].Excitations[5] +configurationName = voltageVertexSource.Configuration +sourceLabel = voltageVertexSource.Label +sourceType = voltageVertexSource.Type + -- Get the DataSet for the source +sourceDataSet = voltageVertexSource:GetDataSet() + -- Export the data for the source +voltageVertexSource:ExportData([[temp_Export]], pf.Enums.FrequencyUnitEnum.GHz, + pf.Enums.NetworkParameterTypeEnum.Impedance, pf.Enums.NetworkParameterFormatEnum.RI, 50, 2) +Inheritance +The SourceVoltageVertex object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +The object label. (Read/Write string) +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. (Read only Expression) +Type +The object type string. (Read only string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method List +p.3919 +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +GetDataSet () +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +ReferenceImpedance +The reference impedance that was used at the port for this source to calculate reference +impedance and realised gain. +Type +Expression +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Example +p.3921 +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in + pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the source values. +Return +DataSet +The data set containing the source values. +GetDataSet (samplePoints number) +Returns a data set containing the source values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +SourceWaveguide +Waveguide excitation results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) + -- Get the waveguide source and its label, configuration and type +waveguideSource = app.Models[1].Configurations[1].Excitations[13] +configurationName = waveguideSource.Configuration +sourceLabel = waveguideSource.Label +sourceType = waveguideSource.Type +sourceDataSet = waveguideSource:GetDataSet() + -- Export the data for the source +waveguideSource:ExportData([[temp_Export]],pf.Enums.FrequencyUnitEnum.GHz, + pf.Enums.NetworkParameterTypeEnum.Impedance,pf.Enums.NetworkParameterFormatEnum.RI,50,2) +Inheritance +The SourceWaveguide object is derived from the ExcitationData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +GetDataSet () +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, +referenceimpedance number, samples number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +referenceimpedance(number) +Specify the reference impedance. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +-- Retrieve the current application and store it in a member +app = pf.GetApplication() +-- Close the current project +app:NewProject() +-- Add the startup.fek model +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) +-- Add two Cartesian graphs to compare the results +app.Views[1]:Close() +graph = app.CartesianGraphs:Add() +graph2 = app.CartesianGraphs:Add() +-- Get the excitation result from the collection of source results of +-- the solution configuration +excitation = app.Models[1].Configurations[1].Excitations[1] +local fileName = "temp_excitation" +-- Export the excitation data to the current working directory +excitation:ExportData( + fileName, -- The name of the Touchstone file that will be + generated + pf.Enums.FrequencyUnitEnum.Hz, -- The frequency unit the data will be exported in +pf.Enums.NetworkParameterTypeEnum.Scattering , -- The network parameter type + pf.Enums.NetworkParameterFormatEnum.MA, -- The network format + 50, -- The reference impedance + 51) -- The number of samples for continuous data. + -- This value will be ignored if the data is discrete. +-- Import the excitation results from the specified Touchstone (*.s1p) file +importSet = app:ImportResults(fileName..".s1p",pf.Enums.ImportFileTypeEnum.Touchstone) +-- Compare the excitation on the Cartesian graphs, they should look the same +graph.Traces:Add(excitation) +graph2.Traces:Add(importSet.ImportedData[1]) +app:TileWindows() +ExportData (filename string, frequencyunit FrequencyUnitEnum, networkparametertype +NetworkParameterTypeEnum, networkparameterformat NetworkParameterFormatEnum, samples +number) +Export the result S-parameter data to the specified Touchstone file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +frequencyunit(FrequencyUnitEnum) +The frequency unit specified by the FrequencyUnitEnum, e.g. Hz, kHz, GHz, etc. +networkparametertype(NetworkParameterTypeEnum) +The network parameter type specified by the NetworkParameterTypeEnum, e.g. +Scattering, Admittance or Impedance. +networkparameterformat(NetworkParameterFormatEnum) +The network parameter format specified by the NetworkParameterFormatEnum, e.g. +DB, MA or RI. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the source values. +Return +DataSet +The data set containing the source values. +GetDataSet (samplePoints number) +Returns a data set containing the source values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +SphericalModesReceivingAntennaData +Receiving antenna results generated by the Feko Solver. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Spherical_Modes_Receiving_Antenna.fek]]) + -- Obtain a 'SphericalModesReceivingAntennaData' object +receivingAntennas = app.Models[1].Configurations[1].ReceivingAntennas +sphericalModeReceivingAntennaData = receivingAntennas["ReceivingAntenna1"] + -- Get the 'SphericalModesReceivingAntennaData' object's dataset +dataSet = sphericalModeReceivingAntennaData:GetDataSet() +Inheritance +The SphericalModesReceivingAntennaData object is derived from the ReceivingAntennaData object. +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the power values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the power values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the power values. (Returns a DataSet object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the power values. +Return +DataSet +The data set containing the power values. +GetDataSet (samplePoints number) +Returns a data set containing the power values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the power values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the power values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the power values. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SpiceProbeData +SpiceProbe results generated by the Feko Solver. +Example +p.3931 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/SpiceProbeTest.fek]]) + -- Retrieve the 'SpiceProbesData' called 'CableProbe1' +spiceProbeData = app.Models[1].Configurations[1].SpiceProbes["CableProbe1"] + -- Add a cartesian graph. +cartesianGraph = app.CartesianGraphs:Add() + -- Add a SPICE probe trace. +spiceProbesPlot = + cartesianGraph.Traces:Add(app.Models[1].Configurations[1].SpiceProbes[1]) +Inheritance +The SpiceProbeData object is derived from the ResultData object. +Usage locations +The SpiceProbeData object can be accessed from the following locations: +• Methods +◦ SpiceProbeCollection collection has method Items(). +◦ SpiceProbeCollection collection has method Item(number). +◦ SpiceProbeCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +SolutionConfiguration +p.3932 +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SpiceProbeQuantity +The SPICE probe quantity properties. +Example +p.3933 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/SpiceProbeTest.fek]]) + -- Add a cartesian graph. +cartesianGraph = app.CartesianGraphs:Add() + -- Add a SPICE probe trace. +spiceProbesPlot = + cartesianGraph.Traces:Add(app.Models[1].Configurations[1].SpiceProbes[1]) + -- Adjust quantity properties of the plot. +spiceProbesPlot.Quantity.ValuesNormalised = true +spiceProbesPlot.Quantity.ValuesScaledToDB = true +Usage locations +The SpiceProbeQuantity object can be accessed from the following locations: +• Properties +◦ SpiceProbeTrace object has property Quantity. +Property List +ComplexComponent +The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. +Magnitude, Phase, Real, Imaginary. (Read/Write ComplexComponentEnum) +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. (Read/Write boolean) +Type +The type of quantity to be plotted, specified by the SpiceProbeValueTypeEnum, e.g. Current or +Voltage. (Read/Write SpiceProbeValueTypeEnum) +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. (Read/Write boolean) +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when the ComplexComponent is Magnitude. (Read/Write boolean) +Property Details +ComplexComponent +The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. +Magnitude, Phase, Real, Imaginary. +Type +ComplexComponentEnum +Access +Read/Write +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +Type +The type of quantity to be plotted, specified by the SpiceProbeValueTypeEnum, e.g. Current or +Voltage. +Type +SpiceProbeValueTypeEnum +Access +Read/Write +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when the ComplexComponent is Magnitude. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SpiceProbeStoredData +Stored far field power integral results. +Example +p.3935 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/SpiceProbeTest.fek]]) + -- Obtain the first item in the collection of SPICE probes in the model +spiceProbe = app.Models[1].Configurations[1].SpiceProbes:Item(1) + -- Store a copy of the SPICE probes data. +storedData = spiceProbe:StoreData() +Inheritance +The SpiceProbeStoredData object is derived from the ResultData object. +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +SpiceProbeTrace +A SpiceProbe 2D trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/SpiceProbeTest.fek]]) +spiceProbeData = app.Models[1].Configurations[1].SpiceProbes["CableProbe1"] + -- Create a cartesian graph and the SPICE probe data +cartesianGraph = app.CartesianGraphs:Add() +spiceProbeTrace = cartesianGraph.Traces:Add(spiceProbeData) + -- Configure the SPICE probe trace quantity +spiceProbeTrace.Signal = "Cable1.Signal2" +Inheritance +The SpiceProbeTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Quantity +The SPICE probe quantity properties. (Read only SpiceProbeQuantity) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Sampling +p.3938 +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Signal +The signal that must be plotted. (Read/Write string) +Signals +The signal names that can be plotted. (Read only List of string) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Quantity +The SPICE probe quantity properties. +Type +SpiceProbeQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Signal +The signal that must be plotted. +Type +string +Access +Read/Write +Signals +The signal names that can be plotted. +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +SurfaceCurrents3DPlot +A surface currents and charges 3D result. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a new 3D View for the model configuration +model = app.Models["startup"] +conf = model.Configurations["StandardConfiguration1"] +view = app.Views:Add(conf) + -- Add the surface currents 3D plot to the view +surfaceCurrents = conf.SurfaceCurrents[1] +plot = view.Plots:Add(surfaceCurrents) + -- Give the 3D plot a convenient label and change the shading +plot.Label = "Surface_Currents_3D_Plot" +plot.Visualisation.FlatShaded = true + -- Specify the frequency to display the currents of +print("Available fixed axes:") +printlist(plot.FixedAxes) +available = plot:GetFixedAxisAvailableValues("Frequency") +print("\nAvailable frequency axis values:") +printlist(available) +plot:SetFixedAxisValue("Frequency", tonumber(available[4]), "Hz") +Inheritance +The SurfaceCurrents3DPlot object is derived from the Result3DPlot object. +Property List +Arrows +The surface currents and charges plot arrows properties. (Read only Arrows3DFormat) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +Contours +The surface currents and charges plot contours properties. (Read only Contours3DFormat) +DataSource +The object that is the data source for this plot. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +Label +The object label. (Read/Write string) +Legend +The 3D plot legend properties. (Read only Plot3DLegendFormat) +Quantity +The surface currents and charges 3D plot quantity properties. (Read only +SurfaceCurrentsQuantity) +Type +The object type string. (Read only string) +Visible +Specifies whether the plot must be shown or hidden. (Read/Write boolean) +Visualisation +The surface currents and charges visualisation properties. (Read only Currents3DFormat) +Method List +Delete () +Delete the plot. +GetAxisUnit (axis string) +Returns the SI unit for the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Stores a copy of the plot. (Returns a Result3DPlot object.) +Property Details +Arrows +The surface currents and charges plot arrows properties. +Type +Arrows3DFormat +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +Contours +The surface currents and charges plot contours properties. +Type +Contours3DFormat +Access +Read only +DataSource +The object that is the data source for this plot. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Legend +The 3D plot legend properties. +Type +Plot3DLegendFormat +Access +Read only +Quantity +The surface currents and charges 3D plot quantity properties. +Type +SurfaceCurrentsQuantity +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Visible +Specifies whether the plot must be shown or hidden. +Type +boolean +Access +Read/Write +Visualisation +The surface currents and charges visualisation properties. +Type +Currents3DFormat +Access +Read only +Method Details +Delete () +Delete the plot. +GetAxisUnit (axis string) +Returns the SI unit for the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Stores a copy of the plot. +Return +Result3DPlot +The new plot associated with the stored data. +SurfaceCurrentsAndChargesStoredData +Stored surface currents and charges results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the 'SurfaceCurrentsData' called 'Currents1' +surfaceCurrentsData = app.Models[1].Configurations[1].SurfaceCurrents["Currents1"] + -- Create a stored surface currents and charges data entity +storedData = surfaceCurrentsData:StoreData() + -- Plot surface currents data +surfaceCurrentsPlot = app.Views[1].Plots:Add(storedData) +Inheritance +The SurfaceCurrentsAndChargesStoredData object is derived from the ResultData object. +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the near field values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the near field values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the near field values. (Returns a DataSet object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the near field values. +Return +DataSet +The data set containing the near field values. +GetDataSet (samplePoints number) +Returns a data set containing the near field values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the near field values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the near field values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the near field values. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfaceCurrentsData +Surface currents generated by the Feko Solver. +Example +p.3951 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the 'SurfaceCurrentsData' called 'SurfaceCurrents' +surfaceCurrentsData = app.Models[1].Configurations[1].SurfaceCurrents["Currents1"] + -- Plot surface currents data +surfaceCurrentsPlot = app.Views[1].Plots:Add(surfaceCurrentsData) +Inheritance +The SurfaceCurrentsData object is derived from the ResultData object. +Usage locations +The SurfaceCurrentsData object can be accessed from the following locations: +• Methods +◦ SurfaceCurrentsCollection collection has method Items(). +◦ SurfaceCurrentsCollection collection has method Item(number). +◦ SurfaceCurrentsCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, components CurrentsExportTypeEnum, samples number) +Export the result surface currents and charges data to the specified *.os / *.ol file. +GetDataSet () +Returns a data set containing the current values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the current values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the current values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, components CurrentsExportTypeEnum, samples number) +Export the result surface currents and charges data to the specified *.os / *.ol file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +components(CurrentsExportTypeEnum) +The components to export specified by the CurrentsExportTypeEnum, e.g. Both (*.os +and *.ol), Currents (*.os) or Charges (*.ol). +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/startup_model/startup.fek]]) + -- Get the surface currents result from the collection of currents results of + -- the solution configuration +surfaceCurrents = app.Models[1].Configurations[1].SurfaceCurrents[1] + -- Export the surface currents data to the current working directory +fileName = "temp_SurfaceCurrents" +surfaceCurrents:ExportData(fileName, + pf.Enums.CurrentsExportTypeEnum.Both, + 51) +GetDataSet () +Returns a data set containing the current values. +Return +DataSet +The data set containing the current values. +GetDataSet (samplePoints number) +Returns a data set containing the current values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the current values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the current values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the current values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfaceCurrentsMathScript +Surface currents math script data that can be plotted. +Example +p.3955 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create a currents math script +currentsMathScript = + app.MathScripts:Add(pf.Enums.MathScriptTypeEnum.SurfaceCurrentsAndCharges) +script = +[[ +dataSet = + pf.SurfaceCurrentsAndCharges.GetDataSet("startup.StandardConfiguration1.Currents1") +scale = 2 +currentsMatrix = dataSet:ToComplexMatrix({"ElectricX", "ElectricY", "ElectricZ"}) +currentsMatrix = currentsMatrix * scale +dataSet:FromComplexMatrix(currentsMatrix, {"ElectricX", "ElectricY", "ElectricZ"}) +return dataSet +]] +currentsMathScript.Script = script +currentsMathScript:Run() + -- Plot the math script +currentsPlot = app.Views[1].Plots:Add(currentsMathScript) +Inheritance +The SurfaceCurrentsMathScript object is derived from the MathScript object. +Property List +DataSetAvailable +Label +Script +Type +Valid result data exist. (Read only boolean) +The object label. (Read/Write string) +The script code to execute. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. (Returns a MathScript object.) +GetDataSet () +Returns a data set containing the math script values. (Returns a DataSet object.) +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Script +The script code to execute. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. +Return +MathScript +The duplicated math script. +GetDataSet () +Returns a data set containing the math script values. +Return +DataSet +The data set containing the math script values. +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfaceCurrentsQuantity +The surface currents and charges quantity properties. +Example +p.3958 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +surfaceCurrentsPlot = + app.Views[1].Plots:Add(app.Models[1].Configurations[1].SurfaceCurrents[1]) + -- Adjust 'SurfaceCurrentsQuantity' of the plot +surfaceCurrentsPlot.Quantity.Type = pf.Enums.SurfaceCurrentsQuantityTypeEnum.Charges +surfaceCurrentsPlot.Quantity.ValuesNormalised = true +surfaceCurrentsPlot.Quantity.ValuesScaledToDB = true +Usage locations +The SurfaceCurrentsQuantity object can be accessed from the following locations: +• Properties +◦ SurfaceCurrents3DPlot object has property Quantity. +Property List +ComplexComponent +The complex component of the surface currents value to plot, specified by the +ComplexComponentEnum, e.g. Magnitude, Instantaneous. (Read/Write ComplexComponentEnum) +InstantaneousPhase +The phase value (wt) to use when ComplexComponent is Instantaneous. The value is in degrees +[0,360]. (Read/Write number) +Type +The type of surface currents quantity to be plotted specified by the +SurfaceCurrentsQuantityTypeEnum, e.g. ElectricCurrents, MagneticCurrents or Charges. (Read/ +Write SurfaceCurrentsQuantityTypeEnum) +ValuesNormalised +Specifies whether the surface currents quantity values must be normalised to the range [0,1] +before plotting. This property can be used together with dB scaling. (Read/Write boolean) +ValuesScaledToDB +Specifies whether the surface currents quantity values are scaled to dB before plotting. (Read/ +Write boolean) +Property Details +ComplexComponent +The complex component of the surface currents value to plot, specified by the +ComplexComponentEnum, e.g. Magnitude, Instantaneous. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +ComplexComponentEnum +Access +Read/Write +InstantaneousPhase +p.3959 +The phase value (wt) to use when ComplexComponent is Instantaneous. The value is in degrees +[0,360]. +Type +number +Access +Read/Write +Type +The type of surface currents quantity to be plotted specified by the +SurfaceCurrentsQuantityTypeEnum, e.g. ElectricCurrents, MagneticCurrents or Charges. +Type +SurfaceCurrentsQuantityTypeEnum +Access +Read/Write +ValuesNormalised +Specifies whether the surface currents quantity values must be normalised to the range [0,1] +before plotting. This property can be used together with dB scaling. +Type +boolean +Access +Read/Write +ValuesScaledToDB +Specifies whether the surface currents quantity values are scaled to dB before plotting. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfaceGraph +A surface graph where results can be plotted. +Example +p.3960 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Add a Cartesian surface graph and a surface plot +graph = app.CartesianSurfaceGraphs:Add() +farFieldPlot = graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Change properties of the graph +graph.Grid.Minor.Visible = true +Inheritance +The SurfaceGraph object is derived from the Window object. +The following objects are derived (specialisations) from the SurfaceGraph object: +• CartesianSurfaceGraph +Property List +Footer +The surface graph footer properties. (Read only SurfaceGraphTextBox) +GreyscaleEnabled +Set the graph's colour scheme to greyscale. (Read/Write boolean) +Height +The height of the window. (Read only number) +Legend +The surface graph legend properties. (Read only SurfaceGraphLegend) +Title +Width +The surface graph title properties. (Read only SurfaceGraphTextBox) +The width of the window. (Read only number) +WindowActive +True if this window is the active window. (Read only boolean) +WindowTitle +The title of the window. (Read/Write string) +XPosition +The X position of the window. (Read only number) +YPosition +The Y position of the window. (Read only number) +Collection List +Plots +The collection of surface plots on the graph. (ResultSurfacePlotCollection of ResultSurfacePlot.) +Method List +BlockGraphRedraws () +Disables graph redraws for performance purposes. When all the changes to the graph are +complete, call UnblockGraphRedraws to re-enable graph updates. +Close () +Close the window. +Duplicate () +Duplicate the surface graph. (Returns a CartesianSurfaceGraph object.) +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Show () +Shows the view. +UnblockGraphRedraws () +Enables graph redraws. This method is used in conjunction with BlockGraphRedraws for +performance purposes. The graph is redrawn when this method is called and normals redraws will +occur on changes. +ZoomToExtents () +Zoom the content of the window to its extent. +Property Details +Footer +The surface graph footer properties. +Type +SurfaceGraphTextBox +Access +Read only +GreyscaleEnabled +Set the graph's colour scheme to greyscale. +Type +boolean +Access +Read/Write +Height +The height of the window. +Type +number +Access +Read only +Legend +The surface graph legend properties. +Type +SurfaceGraphLegend +Access +Read only +Title +The surface graph title properties. +Type +SurfaceGraphTextBox +Access +Read only +Width +The width of the window. +Type +number +Access +Read only +WindowActive +True if this window is the active window. +Type +boolean +Access +Read only +WindowTitle +The title of the window. +Type +string +Access +Read/Write +XPosition +The X position of the window. +Type +number +Access +Read only +YPosition +The Y position of the window. +Type +number +Access +Read only +Collection Details +Plots +The collection of surface plots on the graph. +Type +ResultSurfacePlotCollection +Method Details +BlockGraphRedraws () +Disables graph redraws for performance purposes. When all the changes to the graph are +complete, call UnblockGraphRedraws to re-enable graph updates. +Close () +Close the window. +Duplicate () +Duplicate the surface graph. +Return +CartesianSurfaceGraph +The duplicated surface graph. +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +imagewidth(number) +The export width in pixels. +imageheight(number) +The export height in pixels. +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +Input Parameters +xposition(number) +The view X position. +yposition(number) +The view Y position. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Input Parameters +imagewidth(number) +The view width in pixels. +Altair Feko 2022.3 +2 Application Programming Interface (API) +imageheight(number) +The view height in pixels. +Show () +Shows the view. +UnblockGraphRedraws () +p.3965 +Enables graph redraws. This method is used in conjunction with BlockGraphRedraws for +performance purposes. The graph is redrawn when this method is called and normals redraws will +occur on changes. +ZoomToExtents () +Zoom the content of the window to its extent. +SurfaceGraphAxisGridSpacing +The axis grid spacing properties. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianSurfaceGraphs:Add() + -- Set horizontal display range +graph.HorizontalAxis.Range.AutoRangeEnabled = false +graph.HorizontalAxis.Range.Min = 0 +graph.HorizontalAxis.Range.Max = 1 + -- Set grid spacing +graph.HorizontalAxis.MajorGrid.AutoSpacingEnabled = false +graph.HorizontalAxis.MajorGrid.Spacing = 0.25 +Usage locations +The SurfaceGraphAxisGridSpacing object can be accessed from the following locations: +• Properties +◦ VerticalSurfaceGraphAxis object has property MajorGrid. +◦ HorizontalSurfaceGraphAxis object has property MajorGrid. +Property List +AutoSpacingEnabled +Use automatically generated major grid spacing for the axis. (Read/Write boolean) +Spacing +Major axis grid spacing. (Read/Write number) +Property Details +AutoSpacingEnabled +Use automatically generated major grid spacing for the axis. +Type +boolean +Access +Read/Write +Spacing +Major axis grid spacing. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfaceGraphAxisLabels +The graph axis labels properties. +Example +p.3968 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianSurfaceGraphs:Add() + -- Edit 'SurfaceGraphAxisLabels' property +graph.HorizontalAxis.Labels.NumberFormat = pf.Enums.NumberFormatEnum.Scientific +graph.HorizontalAxis.Labels.SignificantDigits = 1 +Usage locations +The SurfaceGraphAxisLabels object can be accessed from the following locations: +• Properties +◦ VerticalSurfaceGraphAxis object has property Labels. +◦ HorizontalSurfaceGraphAxis object has property Labels. +Property List +AutoSignificantDigitsEnabled +Automatically determine the number of significant digits. (Read/Write boolean) +Font +The font format for the graph axis title. (Read only SurfaceGraphFontFormat) +NumberFormat +The number format used for axis labels specified by NumberFormatEnum, e.g. Scientific or +Decimal. (Read/Write NumberFormatEnum) +SignificantDigits +The number of significant digits of the axis. (Read/Write number) +Property Details +AutoSignificantDigitsEnabled +Automatically determine the number of significant digits. +Type +boolean +Access +Read/Write +Font +The font format for the graph axis title. +Type +SurfaceGraphFontFormat +Access +Read only +NumberFormat +The number format used for axis labels specified by NumberFormatEnum, e.g. Scientific or +Decimal. +Type +NumberFormatEnum +Access +Read/Write +SignificantDigits +The number of significant digits of the axis. +Type +number +Access +Read/Write +SurfaceGraphAxisRange +The axis range properties. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianSurfaceGraphs:Add() + -- Set horizontal display range +graph.HorizontalAxis.Range.AutoRangeEnabled = false +graph.HorizontalAxis.Range.Min = 0 +graph.HorizontalAxis.Range.Max = 5 +Usage locations +The SurfaceGraphAxisRange object can be accessed from the following locations: +• Properties +◦ VerticalSurfaceGraphAxis object has property Range. +◦ HorizontalSurfaceGraphAxis object has property Range. +Property List +AutoRangeEnabled +Enable the automatic range of the axis. (Read/Write boolean) +Max +Min +Axis range maximum value. (Read/Write number) +Axis range minimum value. (Read/Write number) +Property Details +AutoRangeEnabled +Enable the automatic range of the axis. +Type +boolean +Access +Read/Write +Max +Axis range maximum value. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +Min +Axis range minimum value. +Type +number +Access +Read/Write +p.3971 +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfaceGraphAxisTitle +The graph axis title properties. +Example +p.3972 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianSurfaceGraphs:Add() +graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Edit 'SurfaceGraphAxisTitle' properties +graph.HorizontalAxis.Title.Caption = "Frequency measured in Gigahertz" +graph.HorizontalAxis.Title.CaptionIncludesUnit = false +Usage locations +The SurfaceGraphAxisTitle object can be accessed from the following locations: +• Properties +◦ VerticalSurfaceGraphAxis object has property Title. +◦ HorizontalSurfaceGraphAxis object has property Title. +Property List +AutoCaptionEnabled +Specifies whether the automatic caption text of the graph axis must be used. (Read/Write +boolean) +Caption +The caption of the graph axis. (Read/Write string) +CaptionIncludesUnit +Include the unit in the axis caption. (Read/Write boolean) +Font +The font format for the graph axis title. (Read only SurfaceGraphFontFormat) +Frame +The frame format for the graph axis title. (Read only SurfaceGraphFrameFormat) +Property Details +AutoCaptionEnabled +Specifies whether the automatic caption text of the graph axis must be used. +Type +boolean +Access +Read/Write +Caption +The caption of the graph axis. +Type +string +Access +Read/Write +CaptionIncludesUnit +Include the unit in the axis caption. +Type +boolean +Access +Read/Write +Font +Frame +The font format for the graph axis title. +Type +SurfaceGraphFontFormat +Access +Read only +The frame format for the graph axis title. +Type +SurfaceGraphFrameFormat +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfaceGraphFontFormat +The font format property. +Example +p.3974 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianSurfaceGraphs:Add() +graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Edit title 'SurfaceGraphFontFormat' +graph.Title.Font.Boldfaced = true +graph.Title.Font.Size = 20 + -- The font family can be set to any font available on the system. For example + -- graph.Title.Font.Family = "Courier New" +Usage locations +The SurfaceGraphFontFormat object can be accessed from the following locations: +• Properties +◦ SurfaceGraphTextBox object has property Font. +◦ SurfaceGraphLegend object has property Font. +◦ SurfaceGraphAxisLabels object has property Font. +◦ SurfaceGraphAxisTitle object has property Font. +Property List +Boldfaced +Enables font bold. (Read/Write boolean) +Colour +The font colour. (Read/Write Colour) +Family +The font family. (Read/Write string) +Italicised +Enables font italic. (Read/Write boolean) +Size +The font size. (Read/Write number) +Underlined +Enables font underline. (Read/Write boolean) +Property Details +Boldfaced +Enables font bold. +Type +boolean +Access +Read/Write +Colour +The font colour. +Type +Colour +Access +Read/Write +Family +The font family. +Type +string +Access +Read/Write +Italicised +Enables font italic. +Size +Type +boolean +Access +Read/Write +The font size. +Type +number +Access +Read/Write +Underlined +Enables font underline. +Type +boolean +Access +Read/Write +SurfaceGraphFrameFormat +The frame format property. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianSurfaceGraphs:Add() + -- Edit title 'SurfaceGraphFrameFormat' colour property +graph.Title.Frame.Line.Colour = pf.Enums.ColourEnum.Grey +Usage locations +The SurfaceGraphFrameFormat object can be accessed from the following locations: +• Properties +◦ SurfaceGraphTextBox object has property Frame. +◦ SurfaceGraphAxisTitle object has property Frame. +Property List +BackColour +The background colour. (Read/Write Colour) +Line +The line style for text item frame. (Read only SurfaceGraphLineFormat) +Shadow +The frame shadow format properties. (Read only SurfaceGraphShadowFormat) +Property Details +BackColour +The background colour. +Type +Colour +Access +Read/Write +Line +The line style for text item frame. +Type +SurfaceGraphLineFormat +Access +Read only +Shadow +The frame shadow format properties. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Type +SurfaceGraphShadowFormat +Access +Read only +p.3977 +SurfaceGraphLegend +The graph legend properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianSurfaceGraphs:Add() +farField = app.Models["startup"].Configurations[1].FarFields[1] +farFieldPlot = graph.Plots:Add(farField) + -- Change properties of the surface graph legend +graph.Legend.Font.Boldfaced = true +Usage locations +The SurfaceGraphLegend object can be accessed from the following locations: +• Properties +◦ CartesianSurfaceGraph object has property Legend. +◦ SurfaceGraph object has property Legend. +Property List +Font +The font format for the graph legend. (Read only SurfaceGraphFontFormat) +Rounded +Round off legend range and step size. (Read/Write boolean) +Property Details +Font +The font format for the graph legend. +Type +SurfaceGraphFontFormat +Access +Read only +Rounded +Round off legend range and step size. +Type +boolean +Access +Read/Write +SurfaceGraphLineFormat +The line format property. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianSurfaceGraphs:Add() + -- Edit 'SurfaceGraphLineFormat' properties of the major grid line +graph.Grid.Major.HorizontalLine.Weight = 2 +Usage locations +The SurfaceGraphLineFormat object can be accessed from the following locations: +• Properties +◦ CartesianSurfaceGraphGridLines object has property HorizontalLine. +◦ CartesianSurfaceGraphGridLines object has property VerticalLine. +◦ SurfaceGraphFrameFormat object has property Line. +Property List +Colour +The line colour. (Read/Write Colour) +Style +The line style. (Read/Write LineStyleEnum) +Weight +The line weight. (Read/Write number) +Property Details +Colour +The line colour. +Type +Colour +Access +Read/Write +Style +The line style. +Type +LineStyleEnum +Access +Read/Write +Weight +The line weight. +Type +number +Access +Read/Write +SurfaceGraphShadowFormat +The shadow format property. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianSurfaceGraphs:Add() +graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Edit title 'SurfaceGraphShadowFormat' of the title frame +graph.Title.Frame.Shadow.Size = 1 +graph.Title.Frame.Shadow.Visible = true +Usage locations +The SurfaceGraphShadowFormat object can be accessed from the following locations: +• Properties +◦ SurfaceGraphFrameFormat object has property Shadow. +Property List +Size +The drop shadow size. (Read/Write number) +Visible +Set the drop shadow visibility. (Read/Write boolean) +Property Details +Size +The drop shadow size. +Type +number +Access +Read/Write +Visible +Set the drop shadow visibility. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfaceGraphTextBox +The text box properties. +Example +p.3982 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianSurfaceGraphs:Add() +graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Edit 'SurfaceGraphTextBox' text, which automatically sets 'AutoTextEnabled' to + false +graph.Title.Text = [[My custom title.]] + -- A subset of HTML4 and HTML5 tags can also be used for advanced styling +graph.Footer.Text = [[My partly bold Footer.]] +graph.HorizontalAxis.Title.Caption = [[My HTML4 +superscripted +underlined axis.]] +graph.VerticalAxis.Title.Caption = [[My HTML5 +superscript +underlined +axis.]] +Usage locations +The SurfaceGraphTextBox object can be accessed from the following locations: +• Properties +◦ CartesianSurfaceGraph object has property Title. +◦ CartesianSurfaceGraph object has property Footer. +◦ SurfaceGraph object has property Title. +◦ SurfaceGraph object has property Footer. +Property List +AutoTextEnabled +Specifies whether the automatic text of the text item must be used. (Read/Write boolean) +Font +The font format for the text box. (Read only SurfaceGraphFontFormat) +Frame +The frame format for the text box. (Read only SurfaceGraphFrameFormat) +Text +The text of the item. The text can include HTML4 and HTML5 tags for custom formatting of the +characters.The most common HTML4 and HTML5 tags are supported. (Read/Write string) +Property Details +AutoTextEnabled +Specifies whether the automatic text of the text item must be used. +Type +boolean +Access +Read/Write +The font format for the text box. +Type +SurfaceGraphFontFormat +Access +Read only +The frame format for the text box. +Type +SurfaceGraphFrameFormat +Access +Read only +Font +Frame +Text +The text of the item. The text can include HTML4 and HTML5 tags for custom formatting of the +characters.The most common HTML4 and HTML5 tags are supported. +Type +string +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfacePlotLegendFormat +The surface plot legend properties. +Example +p.3984 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianSurfaceGraphs:Add() +farFieldPlot = graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- SetProperties legend +farFieldPlot.Legend.LinearRange.Type = pf.Enums.LinearScaleRangeTypeEnum.Auto +Usage locations +The SurfacePlotLegendFormat object can be accessed from the following locations: +• Properties +◦ SParameterSurfacePlot object has property Legend. +◦ CustomDataSurfacePlot object has property Legend. +◦ NearFieldSurfacePlot object has property Legend. +◦ FarFieldSurfacePlot object has property Legend. +◦ ResultSurfacePlot object has property Legend. +Property List +LinearRange +The surface plot legend linear range properties. (Read/Write +SurfacePlotLegendLinearRangeFormat) +LogarithmicRange +The surface plot legend logarithmic range properties. (Read/Write +SurfacePlotLegendLogarithmicRangeFormat) +Property Details +LinearRange +The surface plot legend linear range properties. +Type +SurfacePlotLegendLinearRangeFormat +Access +Read/Write +LogarithmicRange +The surface plot legend logarithmic range properties. +Type +SurfacePlotLegendLogarithmicRangeFormat +Access +Read/Write +SurfacePlotLegendLinearRangeFormat +The surface plot legend linear range properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianSurfaceGraphs:Add() +farFieldPlot = graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- SetProperties legend linear range +farFieldPlot.Legend.LinearRange.Type = pf.Enums.LinearScaleRangeTypeEnum.Auto +Usage locations +The SurfacePlotLegendLinearRangeFormat object can be accessed from the following locations: +• Properties +◦ SurfacePlotLegendFormat object has property LinearRange. +Property List +FixedRangeMax +Specify the linear scale maximum value for the fixed range of the plot legend. (Read/Write +number) +FixedRangeMin +Specify the linear scale minimum value for the fixed range of the plot legend. (Read/Write +number) +Type +Method by which the linear scale range limits should be determined, specified by the +LinearScaleRangeTypeEnum, e.g. Auto or Fixed. (Read/Write LinearScaleRangeTypeEnum) +Property Details +FixedRangeMax +Specify the linear scale maximum value for the fixed range of the plot legend. +Type +number +Access +Read/Write +FixedRangeMin +Specify the linear scale minimum value for the fixed range of the plot legend. +Type +number +Access +Read/Write +Type +Method by which the linear scale range limits should be determined, specified by the +LinearScaleRangeTypeEnum, e.g. Auto or Fixed. +Type +LinearScaleRangeTypeEnum +Access +Read/Write +SurfacePlotLegendLogarithmicRangeFormat +The surface plot legend logarithmic range properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianSurfaceGraphs:Add() +farFieldPlot = graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- SetProperties legend logarithmic range +farFieldPlot.Legend.LogarithmicRange.Type = pf.Enums.LogScaleRangeTypeEnum.Auto +Usage locations +The SurfacePlotLegendLogarithmicRangeFormat object can be accessed from the following locations: +• Properties +◦ SurfacePlotLegendFormat object has property LogarithmicRange. +Property List +DynamicRangeMax +Specify the log scale maximum value in dB for the dynamic range of the plot legend. (Read/Write +number) +FixedRangeMax +Specify the log scale maximum value in dB for the fixed range of the plot legend. (Read/Write +number) +FixedRangeMin +Specify the log scale minimum value in dB for the fixed range of the plot legend. (Read/Write +number) +Type +Method by which the log scale range limits should be determined, specified by +LogScaleRangeTypeEnum, e.g. Auto, Max or Fixed. (Read/Write LogScaleRangeTypeEnum) +Property Details +DynamicRangeMax +Specify the log scale maximum value in dB for the dynamic range of the plot legend. +Type +number +Access +Read/Write +FixedRangeMax +Specify the log scale maximum value in dB for the fixed range of the plot legend. +Type +number +Access +Read/Write +FixedRangeMin +Specify the log scale minimum value in dB for the fixed range of the plot legend. +Type +number +Access +Read/Write +Type +Method by which the log scale range limits should be determined, specified by +LogScaleRangeTypeEnum, e.g. Auto, Max or Fixed. +Type +LogScaleRangeTypeEnum +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfacePlotSamplingFormat +The surface plot sampling format property. +Example +p.3990 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +helix_6_2_PBC_1x1_ContinuousFarField.fek]]) +farFieldData = app.Models[1].Configurations[1].FarFields[1] +graph = app.CartesianSurfaceGraphs:Add() +surfacePlot = graph.Plots:Add(farFieldData) + -- Set 'SurfacePlotSamplingFormat' properties +surfacePlot.Sampling.Method = pf.Enums.SamplingMethodEnum.SpecifiedSamples +surfacePlot.Sampling.Resolution = 50 +Usage locations +The SurfacePlotSamplingFormat object can be accessed from the following locations: +• Properties +◦ SParameterSurfacePlot object has property Sampling. +◦ CustomDataSurfacePlot object has property Sampling. +◦ NearFieldSurfacePlot object has property Sampling. +◦ FarFieldSurfacePlot object has property Sampling. +◦ ResultSurfacePlot object has property Sampling. +Property List +Method +The method for determining where sample points of the surface plot are calculated, specified +by the SamplingMethodEnum, e.g. Auto, DiscretePoints, SpecifiedResolution. (Read/Write +SamplingMethodEnum) +Resolution +The number of samples to use when SamplingMethod is SpecifiedResolution. (Read/Write +number) +Property Details +Method +The method for determining where sample points of the surface plot are calculated, specified by +the SamplingMethodEnum, e.g. Auto, DiscretePoints, SpecifiedResolution. +Type +SamplingMethodEnum +Access +Read/Write +Resolution +The number of samples to use when SamplingMethod is SpecifiedResolution. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +TRCoefficientData +Transmission reflection coefficient results generated by the Feko Solver. +Example +p.3992 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Wire_Cross_tht45_eta0.fek]]) + -- Retrieve the 'TRCoefficientData' called 'TRCoefficient1' +TRCoefficientData = app.Models[1].Configurations[1].TRCoefficients["TRCoefficients1"] + -- Add the TRCoefficient to a Cartesian graph +graph = app.CartesianGraphs:Add() +transmissionReflectionTrace1 = graph.Traces:Add(TRCoefficientData) + -- Get the transmission reflection data set +TRCoefficientDataSet = TRCoefficientData:GetDataSet() +Inheritance +The TRCoefficientData object is derived from the ResultData object. +Usage locations +The TRCoefficientData object can be accessed from the following locations: +• Methods +◦ TRCoefficientCollection collection has method Items(). +◦ TRCoefficientCollection collection has method Item(number). +◦ TRCoefficientCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method List +p.3993 +ExportData (filename string, samples number) +Export the transmission reflection coefficient data to the specified *.tr file. +GetDataSet () +Returns a data set containing the transmission reflection coefficient values. (Returns a DataSet +object.) +GetDataSet (samplePoints number) +Returns a data set containing the transmission reflection coefficient values. (Returns a DataSet +object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the transmission reflection coefficient values. (Returns a DataSet +object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, samples number) +Export the transmission reflection coefficient data to the specified *.tr file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the transmission reflection coefficient values. +Return +DataSet +The data set containing the transmission reflection coefficient values. +GetDataSet (samplePoints number) +Returns a data set containing the transmission reflection coefficient values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the transmission reflection coefficient values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the transmission reflection coefficient values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the transmission reflection coefficient values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +TRCoefficientMathScript +Transmission reflection coefficient math script data that can be plotted. +Example +p.3996 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Wire_Cross_tht45_eta0.fek]]) + -- Create a TRCoefficient math script +TRCoefficientMathScript = + app.MathScripts:Add(pf.Enums.MathScriptTypeEnum.TRCoefficient) +script = +[[ +dataSet = + pf.TRCoefficients.GetDataSet("Wire_Cross_tht45_eta0.StandardConfiguration1.TRCoefficients1") +offset = 1 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + indexedValue = dataSet[freqIndex] + indexedValue.CoPolarisedReflectionCoefficient = + indexedValue.CrossPolarisedReflectionCoefficient + + offset +end +return dataSet +]] +TRCoefficientMathScript.Script = script +TRCoefficientMathScript:Run() + -- Plot the math script +graph = app.CartesianGraphs:Add() +TRCoefficientTrace1 = graph.Traces:Add(TRCoefficientMathScript) +TRCoefficientTrace1.Quantity.Type = pf.Enums.TRCoefficientQuantityTypeEnum.Reflection +Inheritance +The TRCoefficientMathScript object is derived from the MathScript object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Script +Type +The object label. (Read/Write string) +The script code to execute. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. (Returns a MathScript object.) +GetDataSet () +Returns a data set containing the math script values. (Returns a DataSet object.) +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Script +The script code to execute. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. +Return +MathScript +The duplicated math script. +GetDataSet () +Returns a data set containing the math script values. +Return +DataSet +The data set containing the math script values. +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +TRCoefficientStoredData +Stored transmission reflection coefficient results. +Example +p.3999 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Wire_Cross_tht45_eta0.fek]]) + -- Retrieve the 'TRCoefficientData' called 'TRCoefficient1' +TRCoefficientData = app.Models[1].Configurations[1].TRCoefficients["TRCoefficients1"] + -- Store a copy of the network data. +storedData = + TRCoefficientData:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.TRCoefficient) +Inheritance +The TRCoefficientStoredData object is derived from the ResultData object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +ExportData (filename string) +Export the transmission reflection coefficient data to the specified *.tr file. +ExportData (filename string, samples number) +Export the transmission reflection coefficient data to the specified *.tr file. +GetDataSet () +Returns a data set containing the transmission reflection coefficient values. (Returns a DataSet +object.) +GetDataSet (samplePoints number) +Returns a data set containing the transmission reflection coefficient values. (Returns a DataSet +object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the transmission reflection coefficient values. (Returns a DataSet +object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +ExportData (filename string) +Export the transmission reflection coefficient data to the specified *.tr file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +ExportData (filename string, samples number) +Export the transmission reflection coefficient data to the specified *.tr file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +Altair Feko 2022.3 +2 Application Programming Interface (API) +samples(number) +p.4001 +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the transmission reflection coefficient values. +Return +DataSet +The data set containing the transmission reflection coefficient values. +GetDataSet (samplePoints number) +Returns a data set containing the transmission reflection coefficient values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the transmission reflection coefficient values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the transmission reflection coefficient values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the transmission reflection coefficient values. +Altair Feko 2022.3 +2 Application Programming Interface (API) +TRCoefficientTrace +A transmission reflection coefficient 2D trace. +Example +p.4002 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Wire_Cross_tht45_eta0.fek]]) +TRCoefficientData = app.Models[1].Configurations[1].TRCoefficients["TRCoefficients1"] + -- Create a Cartesian graph and the transmission reflection data +graph = app.CartesianGraphs:Add() +TRCoefficientTrace = graph.Traces:Add(TRCoefficientData) + -- Configure the trace quantity +TRCoefficientTrace.Quantity.Type + = pf.Enums.TRCoefficientQuantityTypeEnum.Transmission +Inheritance +The TRCoefficientTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The transmission reflection coefficient trace math expression properties. (Read only +TraceMathExpression) +Quantity +The transmission reflection coefficient trace quantity properties. (Read only TRQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, point Point) +Set the fixed axis to the specified value. +SetProperties (properties table) +p.4004 +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The transmission reflection coefficient trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The transmission reflection coefficient trace quantity properties. +Type +TRQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetFixedAxisValue (axis string, point Point) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +point(Point) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +TRQuantity +The transmission reflection coefficient quantity properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Wire_Cross_tht45_eta0.fek]]) +TRCoefficientData = app.Models[1].Configurations[1].TRCoefficients["TRCoefficients1"] +graph = app.CartesianGraphs:Add() +TRCoefficientTrace = graph.Traces:Add(TRCoefficientData) + -- Configure the 'TRQuantity' of the transmission reflection trace +TRCoefficientTrace.Quantity.Type + = pf.Enums.TRCoefficientQuantityTypeEnum.Transmission +TRCoefficientTrace.Quantity.PolarisationType + = pf.Enums.PolarisationTypeEnum.CoPolarisation +Usage locations +The TRQuantity object can be accessed from the following locations: +• Properties +◦ TRCoefficientTrace object has property Quantity. +Property List +ComplexComponent +The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. +Magnitude, Phase, Real, Imaginary. (Read/Write ComplexComponentEnum) +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. (Read/Write boolean) +PolarisationType +The polarisation type of the value to plot, specified by the PolarisationTypeEnum, e.g. Total, +CoPolarisation or CrossPolarisation. (Read/Write PolarisationTypeEnum) +Type +The type of quantity to be plotted, specified by the TRCoefficientQuantityTypeEnum, e.g. +Transmission or Reflection. (Read/Write TRCoefficientQuantityTypeEnum) +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. (Read/Write boolean) +ValuesScaledToDB +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when the ComplexComponent is Magnitude. (Read/Write boolean) +Property Details +ComplexComponent +The complex component of the value to plot, specified by the ComplexComponentEnum, e.g. +Magnitude, Phase, Real, Imaginary. +Type +ComplexComponentEnum +Access +Read/Write +PhaseUnwrapped +Specifies whether the phase is unwrapped before plotting. This property is only valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +PolarisationType +The polarisation type of the value to plot, specified by the PolarisationTypeEnum, e.g. Total, +CoPolarisation or CrossPolarisation. +Type +PolarisationTypeEnum +Access +Read/Write +Type +The type of quantity to be plotted, specified by the TRCoefficientQuantityTypeEnum, e.g. +Transmission or Reflection. +Type +TRCoefficientQuantityTypeEnum +Access +Read/Write +ValuesNormalised +Specifies whether the quantity values must be normalised to the range [0,1] before plotting. +This property can be used together with dB scaling. This property is not valid when the +ComplexComponent is Phase. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +ValuesScaledToDB +p.4011 +Specifies whether the quantity values are scaled to dB before plotting. This property is only valid +when the ComplexComponent is Magnitude. +Type +boolean +Access +Read/Write +TextBox +The text box properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianGraphs:Add() +graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Edit 'TextBox' text, which automatically sets 'AutoTextEnabled' to false +graph.Title.Text = [[My custom title.]] + -- A subset of HTML4 and HTML5 tags can also be used for advanced styling +graph.Footer.Text = [[My partly bold Footer.]] +graph.HorizontalAxis.Title.Caption = [[My HTML4 +superscripted +underlined axis.]] +graph.VerticalAxis.Title.Caption = [[My HTML5 +superscript +underlined +axis.]] +Usage locations +The TextBox object can be accessed from the following locations: +• Properties +◦ SmithChart object has property Title. +◦ SmithChart object has property Footer. +◦ PolarGraph object has property Title. +◦ PolarGraph object has property Footer. +◦ CartesianGraph object has property Title. +◦ CartesianGraph object has property Footer. +◦ Graph object has property Title. +◦ Graph object has property Footer. +Property List +AutoTextEnabled +Specifies whether the automatic text of the text item must be used. (Read/Write boolean) +Font +The font format for the text box. (Read only FontFormat) +Frame +The frame format for the text box. (Read only FrameFormat) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Text +p.4013 +The text of the item. The text can include HTML4 and HTML5 tags for custom formatting of the +characters.The most common HTML4 and HTML5 tags are supported. (Read/Write string) +Property Details +AutoTextEnabled +Specifies whether the automatic text of the text item must be used. +Type +boolean +Access +Read/Write +Font +The font format for the text box. +Type +FontFormat +Access +Read only +Frame +The frame format for the text box. +Type +FrameFormat +Access +Read only +Text +The text of the item. The text can include HTML4 and HTML5 tags for custom formatting of the +characters.The most common HTML4 and HTML5 tags are supported. +Type +string +Access +Read/Write +TraceAxes +The trace axes properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) +cartesianGraph = app.CartesianGraphs:Add() +trace = cartesianGraph.Traces:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Set axes properties +trace.Axes.Independent.Unit = "inch" +trace.Axes.Independent.Scale = 0.5 +cartesianGraph:ZoomToExtents() +Usage locations +The TraceAxes object can be accessed from the following locations: +• Properties +◦ CharacteristicModeTrace object has property Axes. +◦ CustomDataSmithTrace object has property Axes. +◦ CustomDataTrace object has property Axes. +◦ MathTrace object has property Axes. +◦ SpiceProbeTrace object has property Axes. +◦ FarFieldPowerIntegralTrace object has property Axes. +◦ NearFieldPowerIntegralTrace object has property Axes. +◦ TRCoefficientTrace object has property Axes. +◦ LoadSmithTrace object has property Axes. +◦ ExcitationSmithTrace object has property Axes. +◦ SARTrace object has property Axes. +◦ WireCurrentsTrace object has property Axes. +◦ SParameterTrace object has property Axes. +◦ PowerTrace object has property Axes. +◦ LoadTrace object has property Axes. +◦ ExcitationTrace object has property Axes. +◦ FarFieldTrace object has property Axes. +◦ NearFieldTrace object has property Axes. +◦ ReceivingAntennaTrace object has property Axes. +◦ NetworkTrace object has property Axes. +◦ ResultTrace object has property Axes. +Property List +Dependent +The trace dependent axis properties. (Read only DependentAxisFormat) +Independent +The trace independent axis properties. (Read only IndependentAxisFormat) +Property Details +Dependent +The trace dependent axis properties. +Type +DependentAxisFormat +Access +Read only +Independent +The trace independent axis properties. +Type +IndependentAxisFormat +Access +Read only +TraceLegendFormat +The trace legend properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +cartesianGraph = app.CartesianGraphs:Add() +trace = cartesianGraph.Traces:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Set 'TraceLegendFormat' properties +trace.Legend.AutoTextEnabled = false +trace.Legend.Text = "My custom trace legend" +Usage locations +The TraceLegendFormat object can be accessed from the following locations: +• Properties +◦ CharacteristicModeTrace object has property Legend. +◦ CustomDataSmithTrace object has property Legend. +◦ CustomDataTrace object has property Legend. +◦ MathTrace object has property Legend. +◦ SpiceProbeTrace object has property Legend. +◦ FarFieldPowerIntegralTrace object has property Legend. +◦ NearFieldPowerIntegralTrace object has property Legend. +◦ TRCoefficientTrace object has property Legend. +◦ LoadSmithTrace object has property Legend. +◦ ExcitationSmithTrace object has property Legend. +◦ SARTrace object has property Legend. +◦ WireCurrentsTrace object has property Legend. +◦ SParameterTrace object has property Legend. +◦ PowerTrace object has property Legend. +◦ LoadTrace object has property Legend. +◦ ExcitationTrace object has property Legend. +◦ FarFieldTrace object has property Legend. +◦ NearFieldTrace object has property Legend. +◦ ReceivingAntennaTrace object has property Legend. +◦ NetworkTrace object has property Legend. +◦ ResultTrace object has property Legend. +Property List +AutoTextEnabled +Specifies whether the automatic legend text must be used in the legend. (Read/Write boolean) +LegendEntryVisible +Specifies whether the trace entry must be visible in the legend. (Read/Write boolean) +Text +The text used for the trace in the legend. (Read/Write string) +UseTraceLabelText +Specifies whether the trace label text must be used in the legend. (Read/Write boolean) +Property Details +AutoTextEnabled +Specifies whether the automatic legend text must be used in the legend. +Type +boolean +Access +Read/Write +LegendEntryVisible +Specifies whether the trace entry must be visible in the legend. +Type +boolean +Access +Read/Write +Text +The text used for the trace in the legend. +Type +string +Access +Read/Write +UseTraceLabelText +Specifies whether the trace label text must be used in the legend. +Type +boolean +Access +Read/Write +TraceLineFormat +The line format property. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +cartesianGraph = app.CartesianGraphs:Add() +trace = cartesianGraph.Traces:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Set 'TraceLineFormat' properties +trace.Line.Style = pf.Enums.LineStyleEnum.DashLine +trace.Line.Colour = pf.Enums.ColourEnum.Green +Usage locations +The TraceLineFormat object can be accessed from the following locations: +• Properties +◦ CharacteristicModeTrace object has property Line. +◦ CustomDataSmithTrace object has property Line. +◦ CustomDataTrace object has property Line. +◦ MathTrace object has property Line. +◦ SpiceProbeTrace object has property Line. +◦ FarFieldPowerIntegralTrace object has property Line. +◦ NearFieldPowerIntegralTrace object has property Line. +◦ TRCoefficientTrace object has property Line. +◦ LoadSmithTrace object has property Line. +◦ ExcitationSmithTrace object has property Line. +◦ SARTrace object has property Line. +◦ WireCurrentsTrace object has property Line. +◦ SParameterTrace object has property Line. +◦ PowerTrace object has property Line. +◦ LoadTrace object has property Line. +◦ ExcitationTrace object has property Line. +◦ FarFieldTrace object has property Line. +◦ NearFieldTrace object has property Line. +◦ ReceivingAntennaTrace object has property Line. +◦ NetworkTrace object has property Line. +◦ ResultTrace object has property Line. +Property List +Colour +The line colour. (Read/Write Colour) +Style +The line style. (Read/Write LineStyleEnum) +Weight +The line weight. (Read/Write number) +Property Details +Colour +The line colour. +Type +Colour +Access +Read/Write +Style +The line style. +Type +LineStyleEnum +Access +Read/Write +Weight +The line weight. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +TraceMarkersFormat +The trace markers format property. +Example +p.4020 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +cartesianGraph = app.CartesianGraphs:Add() +trace = cartesianGraph.Traces:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Set 'TraceMarkerFormat' properties +trace.Markers.Symbol = pf.Enums.MarkerSymbolEnum.FilledTriangle +trace.Markers.Colour = pf.Enums.ColourEnum.Red +Usage locations +The TraceMarkersFormat object can be accessed from the following locations: +• Properties +◦ CharacteristicModeTrace object has property Markers. +◦ CustomDataSmithTrace object has property Markers. +◦ CustomDataTrace object has property Markers. +◦ MathTrace object has property Markers. +◦ SpiceProbeTrace object has property Markers. +◦ FarFieldPowerIntegralTrace object has property Markers. +◦ NearFieldPowerIntegralTrace object has property Markers. +◦ TRCoefficientTrace object has property Markers. +◦ LoadSmithTrace object has property Markers. +◦ ExcitationSmithTrace object has property Markers. +◦ SARTrace object has property Markers. +◦ WireCurrentsTrace object has property Markers. +◦ SParameterTrace object has property Markers. +◦ PowerTrace object has property Markers. +◦ LoadTrace object has property Markers. +◦ ExcitationTrace object has property Markers. +◦ FarFieldTrace object has property Markers. +◦ NearFieldTrace object has property Markers. +◦ ReceivingAntennaTrace object has property Markers. +◦ NetworkTrace object has property Markers. +◦ ResultTrace object has property Markers. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property List +Colour +The colour of markers. (Read/Write Colour) +DensityOption +p.4021 +The density option of the markers, specified by the MarkerPlacementEnum, e.g. CalculatedPoints, +DenselySpaced or SparselySpaced. (Read/Write MarkerPlacementEnum) +Size +The size of the marker as a percentage in the range [20,200]. (Read/Write number) +Symbol +The symbol used for the marker, e.g. circle, cross, rectangle, etc. (Read/Write +MarkerSymbolEnum) +Property Details +Colour +The colour of markers. +Type +Colour +Access +Read/Write +DensityOption +The density option of the markers, specified by the MarkerPlacementEnum, e.g. CalculatedPoints, +DenselySpaced or SparselySpaced. +Type +MarkerPlacementEnum +Access +Read/Write +Size +The size of the marker as a percentage in the range [20,200]. +Type +number +Access +Read/Write +Symbol +The symbol used for the marker, e.g. circle, cross, rectangle, etc. +Type +MarkerSymbolEnum +Access +Read/Write +TraceMathExpression +The trace math expression. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +cartesianGraph = app.CartesianGraphs:Add() +trace = cartesianGraph.Traces:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Set 'TraceMathExpression' properties +trace.Math.Expression = "self*2.0" +trace.Math.Enabled = true +Usage locations +The TraceMathExpression object can be accessed from the following locations: +• Properties +◦ CharacteristicModeTrace object has property Math. +◦ CustomDataTrace object has property Math. +◦ FarFieldPowerIntegralTrace object has property Math. +◦ NearFieldPowerIntegralTrace object has property Math. +◦ TRCoefficientTrace object has property Math. +◦ SARTrace object has property Math. +◦ WireCurrentsTrace object has property Math. +◦ SParameterTrace object has property Math. +◦ PowerTrace object has property Math. +◦ LoadTrace object has property Math. +◦ ExcitationTrace object has property Math. +◦ FarFieldTrace object has property Math. +◦ NearFieldTrace object has property Math. +◦ ReceivingAntennaTrace object has property Math. +◦ NetworkTrace object has property Math. +Property List +CommonRangeEnabled +Specifies whether the range is limited to the range common to all traces used in the expression. +(Read/Write boolean) +Enabled +Specifies whether the math expression is enabled for this trace. (Read/Write boolean) +Expression +The math expression used to calculate this trace, e.g. “self*2.0”. (Read/Write string) +NoUnit +Specifies the no unit must be used for this trace. (Read/Write boolean) +UnitExpression +The unit for the values resulting from the math expression, e.g. “m/s^2”. Only applies if NoUnit is +false. (Read/Write string) +Property Details +CommonRangeEnabled +Specifies whether the range is limited to the range common to all traces used in the expression. +Type +boolean +Access +Read/Write +Enabled +Specifies whether the math expression is enabled for this trace. +Type +boolean +Access +Read/Write +Expression +The math expression used to calculate this trace, e.g. “self*2.0”. +Type +string +Access +Read/Write +NoUnit +Specifies the no unit must be used for this trace. +Type +boolean +Access +Read/Write +UnitExpression +The unit for the values resulting from the math expression, e.g. “m/s^2”. Only applies if NoUnit is +false. +Type +string +Access +Read/Write +TraceSamplingFormat +The trace sampling format property. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +helix_6_2_PBC_1x1_ContinuousFarField.fek]]) +farFieldData = app.Models[1].Configurations[1].FarFields[1] +cartesianGraph = app.CartesianGraphs:Add() +trace = cartesianGraph.Traces:Add(farFieldData) + -- Set 'TraceSamplingFormat' properties +trace.Sampling.Method = pf.Enums.SamplingMethodEnum.SpecifiedSamples +trace.Sampling.Resolution = 50 +Usage locations +The TraceSamplingFormat object can be accessed from the following locations: +• Properties +◦ CharacteristicModeTrace object has property Sampling. +◦ CustomDataSmithTrace object has property Sampling. +◦ CustomDataTrace object has property Sampling. +◦ MathTrace object has property Sampling. +◦ SpiceProbeTrace object has property Sampling. +◦ FarFieldPowerIntegralTrace object has property Sampling. +◦ NearFieldPowerIntegralTrace object has property Sampling. +◦ TRCoefficientTrace object has property Sampling. +◦ LoadSmithTrace object has property Sampling. +◦ ExcitationSmithTrace object has property Sampling. +◦ SARTrace object has property Sampling. +◦ WireCurrentsTrace object has property Sampling. +◦ SParameterTrace object has property Sampling. +◦ PowerTrace object has property Sampling. +◦ LoadTrace object has property Sampling. +◦ ExcitationTrace object has property Sampling. +◦ FarFieldTrace object has property Sampling. +◦ NearFieldTrace object has property Sampling. +◦ ReceivingAntennaTrace object has property Sampling. +◦ NetworkTrace object has property Sampling. +◦ ResultTrace object has property Sampling. +Property List +Method +The method for determining where sample points of the trace are calculated, specified by +the SamplingMethodEnum, e.g. Auto, DiscretePoints, SpecifiedResolution. (Read/Write +SamplingMethodEnum) +Resolution +The number of samples to use when SamplingMethod is SpecifiedResolution. (Read/Write +number) +Property Details +Method +The method for determining where sample points of the trace are calculated, specified by the +SamplingMethodEnum, e.g. Auto, DiscretePoints, SpecifiedResolution. +Type +SamplingMethodEnum +Access +Read/Write +Resolution +The number of samples to use when SamplingMethod is SpecifiedResolution. +Type +number +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +TransmissionLineData +Transmission line results generated by the Feko Solver. +Example +p.4026 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Log_Periodic_Network_Load.fek]]) + -- Retrieve the 'TransmissionLineData' called 'TransmissionLine1' +transmissionLineData = + app.Models[1].Configurations[1].TransmissionLines["TransmissionLine1"] + -- Manipulate the transmission line data. See 'DataSet' for faster, more + comprehensive options +dataSet = transmissionLineData:GetDataSet(51) + -- Find the number of ports +portAxis = dataSet.Axes["Arbitrary"] +noPorts = #portAxis + -- Scale the transmission line power values +scale = 2 +for freqIndex = 1, #dataSet.Axes["Frequency"] do + for portIndex = 1, #dataSet.Axes["Arbitrary"] do + indexedValue = dataSet[freqIndex][portIndex] + indexedValue.Impedance = indexedValue.Impedance * scale + end +end + -- Store the manipulated data +scaledData = dataSet:StoreData(pf.Enums.StoredDataTypeEnum.Network) + -- Compare the original transmission line to the manipulated transmission line +graph = app.CartesianGraphs:Add() +transmissionLineTrace1 = graph.Traces:Add(transmissionLineData) +transmissionLineTrace1.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Impedance +transmissionLineTrace2 = graph.Traces:Add(scaledData) +transmissionLineTrace2.Quantity.Type = pf.Enums.NetworkQuantityTypeEnum.Impedance +Inheritance +The TransmissionLineData object is derived from the ResultData object. +Usage locations +The TransmissionLineData object can be accessed from the following locations: +• Methods +◦ TransmissionLineCollection collection has method Items(). +◦ TransmissionLineCollection collection has method Item(number). +◦ TransmissionLineCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +GetDataSet () +Returns a data set containing the transmission line values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the transmission line values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the transmission line values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +GetDataSet () +Returns a data set containing the transmission line values. +Return +DataSet +The data set containing the transmission line values. +GetDataSet (samplePoints number) +Returns a data set containing the transmission line values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the transmission line values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the transmission line values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the transmission line values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Version +An object that describes that application version in detail. +Example +app = pf.GetApplication() + -- Retrieve the various version components +vMajor = app.Version.Major +vMinor = app.Version.Minor +vPatch = app.Version.Patch + -- Print the complete version information, including application architecture +print(app.Version) +Usage locations +The Version object can be accessed from the following locations: +• Properties +◦ Application object has property Version. +Property List +Build +Major +Minor +Patch +Type +The application build version. (Read only number) +The application major version. (Read only number) +The application minor version. (Read only number) +The application patch version. (Read only number) +The object type string. (Read only string) +Property Details +Build +The application build version. +Type +number +Access +Read only +Major +The application major version. +Type +number +Access +Read only +Minor +The application minor version. +Type +number +Access +Read only +Patch +The application patch version. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +VerticalGraphAxis +The graph vertical axis properties. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianGraphs:Add() + -- Edit 'VerticalGraphAxis' property +graph.VerticalAxis.LogScaled = true +Usage locations +The VerticalGraphAxis object can be accessed from the following locations: +• Properties +◦ CartesianGraph object has property VerticalAxis. +Property List +DynamicRange +Dynamic range of vertical axis in dB. (Read/Write number) +Labels +The graph vertical axis labels. (Read only GraphAxisLabels) +LogScaled +Set the graph vertical axis to a logarithmic scale. (Read/Write boolean) +MajorGrid +The graph vertical axis major grid spacing. (Read only AxisGridSpacing) +MinorGridSubdivisions +The number of minor grid subdivisions. (Read/Write number) +Range +The graph vertical axis range. (Read only AxisRange) +ReversedOrder +Set the graph vertical axis to a reversed order. (Read/Write boolean) +Title +The graph vertical axis title. (Read only GraphAxisTitle) +Property Details +DynamicRange +Dynamic range of vertical axis in dB. +Type +number +Access +Read/Write +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/square_loop_antenna_MATCHED.fek]]) +graph = app.CartesianGraphs:Add() +sourceTrace = graph.Traces:Add(app.Models[1].Configurations[1].Excitations[1]) + -- Limit the axis dynamic dB range +sourceTrace.Quantity.ValuesScaledToDB = true +graph.VerticalAxis.DynamicRange = 20 +Labels +The graph vertical axis labels. +Type +GraphAxisLabels +Access +Read only +LogScaled +Set the graph vertical axis to a logarithmic scale. +Type +boolean +Access +Read/Write +MajorGrid +The graph vertical axis major grid spacing. +Type +AxisGridSpacing +Access +Read only +MinorGridSubdivisions +The number of minor grid subdivisions. +Type +number +Access +Read/Write +Range +The graph vertical axis range. +Type +AxisRange +Access +Read only +ReversedOrder +Set the graph vertical axis to a reversed order. +Type +boolean +Access +Read/Write +Title +The graph vertical axis title. +Type +GraphAxisTitle +Access +Read only +VerticalSurfaceGraphAxis +The graph vertical axis properties. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianSurfaceGraphs:Add() + -- Edit 'VerticalSurfaceGraphAxis' property +graph.VerticalAxis.Title.CaptionIncludesUnit = true +Usage locations +The VerticalSurfaceGraphAxis object can be accessed from the following locations: +• Properties +◦ CartesianSurfaceGraph object has property VerticalAxis. +Property List +Labels +The graph vertical axis labels. (Read only SurfaceGraphAxisLabels) +MajorGrid +The graph vertical axis major grid spacing. (Read only SurfaceGraphAxisGridSpacing) +MinorGridSubdivisions +The number of minor grid subdivisions. (Read/Write number) +Range +The graph vertical axis range. (Read only SurfaceGraphAxisRange) +ReversedOrder +Set the graph vertical axis to a reversed order. (Read/Write boolean) +Title +The graph vertical axis title. (Read only SurfaceGraphAxisTitle) +Property Details +Labels +The graph vertical axis labels. +Type +SurfaceGraphAxisLabels +Access +Read only +MajorGrid +The graph vertical axis major grid spacing. +Type +SurfaceGraphAxisGridSpacing +Access +Read only +MinorGridSubdivisions +The number of minor grid subdivisions. +Type +number +Access +Read/Write +Range +The graph vertical axis range. +Type +SurfaceGraphAxisRange +Access +Read only +ReversedOrder +Set the graph vertical axis to a reversed order. +Type +boolean +Access +Read/Write +Title +The graph vertical axis title. +Type +SurfaceGraphAxisTitle +Access +Read only +Altair Feko 2022.3 +2 Application Programming Interface (API) +View +A 3D model view where results can be plotted. +Example +p.4037 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farField = app.Models["startup"].Configurations[1].FarFields[1] + -- Get the first 3D view (which gets created by default when adding a fek model) +resultView = app.Views[1] + -- Add a far field and duplicate the view +resultView.Plots:Add(farField) +resultViewCopy = resultView:Duplicate() +Inheritance +The View object is derived from the Window object. +Usage locations +The View object can be accessed from the following locations: +• Methods +◦ View object has method Duplicate(). +◦ ViewCollection collection has method Items(). +◦ ViewCollection collection has method Item(number). +◦ ViewCollection collection has method Item(string). +◦ ViewCollection collection has method Add(SolutionConfiguration). +◦ ViewCollection collection has method Add(). +Property List +Animation +The graph animation properties. (Read only View3DAnimationFormat) +Axes +The axes properties. (Read only View3DAxesFormat) +Format +The 3D view properties. (Read only View3DFormat) +Height +The height of the window. (Read only number) +Legend +The legend range properties. (Read only View3DLegendRangeFormat) +MeshRendering +The mesh rendering properties. (Read only MeshRendering) +SolutionEntities +The result entities properties. (Read only View3DSolutionEntityFormat) +Type +Width +The object type string. (Read only string) +The width of the window. (Read only number) +WindowActive +True if this window is the active window. (Read only boolean) +WindowTitle +The title of the window. (Read/Write string) +XPosition +The X position of the window. (Read only number) +YPosition +The Y position of the window. (Read only number) +Collection List +Plots +The collection of 3D results on the view. (Result3DPlotCollection of Result3DPlot.) +Method List +Close () +Close the window. +Duplicate () +Duplicate the 3D view. (Returns a View object.) +ExportAnimation (filename string, fileformat AnimationFormatEnum, quality AnimationQualityEnum, +width number, height number, framerate number) +Export the view animation to a specified file. The type is determined by the Animation.Type +property. +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +SetViewDirection (direction ViewDirectionEnum) +Specifies the direction from which the model is viewed, e.g., Isometric, Top, Bottom, Left, etc. +Show () +Shows the view. +ZoomToExtents () +Zoom the content of the window to its extent. +Property Details +Animation +The graph animation properties. +Type +View3DAnimationFormat +Access +Read only +Axes +The axes properties. +Type +View3DAxesFormat +Access +Read only +Format +The 3D view properties. +Type +View3DFormat +Access +Read only +Height +The height of the window. +Type +number +Access +Read only +Legend +The legend range properties. +Type +View3DLegendRangeFormat +Access +Read only +MeshRendering +The mesh rendering properties. +Type +MeshRendering +Access +Read only +SolutionEntities +The result entities properties. +Type +View3DSolutionEntityFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Width +The width of the window. +Type +number +Access +Read only +WindowActive +True if this window is the active window. +Type +boolean +Access +Read only +WindowTitle +The title of the window. +Type +string +Access +Read/Write +XPosition +The X position of the window. +Type +number +Access +Read only +YPosition +The Y position of the window. +Type +number +Access +Read only +Collection Details +Plots +The collection of 3D results on the view. +Type +Result3DPlotCollection +Method Details +Close () +Close the window. +Duplicate () +Duplicate the 3D view. +Return +View +The duplicated 3D view. +ExportAnimation (filename string, fileformat AnimationFormatEnum, quality AnimationQualityEnum, +width number, height number, framerate number) +Export the view animation to a specified file. The type is determined by the Animation.Type +property. +Input Parameters +filename(string) +The filename of the animation file without its extension. +fileformat(AnimationFormatEnum) +The animation file format specified by the AnimationFormatEnum, e.g. AVI, MOV, MKV +or GIF. +quality(AnimationQualityEnum) +The export animation quality specified by the AnimationQualityEnum, e.g. High, +Normal or Low. +width(number) +The export width in pixels of the animation. +height(number) +The export height in pixels of the animation. +framerate(number) +The frames per second the animation will be exported at. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farField = app.Models["startup"].Configurations[1].FarFields[1] +view = app.Views[1] +view.Plots:Add(farField) + -- Configure the animation type and speed for the view +animation = view.Animation +animation.Type = pf.Enums.AnimationTypeEnum.PhiRotate +animation.PhiStepSize = 25 -- deg/s + -- Export the animation to the current working directory +view:ExportAnimation([[temp_startupAnimation]], + pf.Enums.AnimationFormatEnum.AVI, + pf.Enums.AnimationQualityEnum.Normal, + 800, + 600, + 25) +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +imagewidth(number) +The export width in pixels. +Altair Feko 2022.3 +2 Application Programming Interface (API) +imageheight(number) +The export height in pixels. +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +p.4043 +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +Input Parameters +xposition(number) +The view X position. +yposition(number) +The view Y position. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Input Parameters +imagewidth(number) +The view width in pixels. +imageheight(number) +The view height in pixels. +SetViewDirection (direction ViewDirectionEnum) +Specifies the direction from which the model is viewed, e.g., Isometric, Top, Bottom, Left, etc. +Input Parameters +direction(ViewDirectionEnum) +The direction specified by ViewDirectionEnum. +Show () +Shows the view. +ZoomToExtents () +Zoom the content of the window to its extent. +View3DAnimationFormat +The animation properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +view = app.Views[1] + -- Configure the animation type and speed using 'View3DAnimationFormat' +view.Animation.Type = pf.Enums.AnimationTypeEnum.PhiRotate +view.Animation.PhiStepSize = 25 -- deg/s +view.Animation.RealTimeDuration = 5 -- seconds + -- Export the animation to the current working directory +view:ExportAnimation([[temp_startupAnimation]], + pf.Enums.AnimationFormatEnum.AVI, + pf.Enums.AnimationQualityEnum.Normal, + 800, + 600, + 25) +Usage locations +The View3DAnimationFormat object can be accessed from the following locations: +• Properties +◦ View object has property Animation. +Property List +ContinuousFrequencySamples +Number of continuous frequency samples. (Read/Write number) +FrequencyRate +Number of frequency points to step per second (points/s). (Read/Write number) +PhaseStepSize +Phase step size per second (wt/s). (Read/Write number) +PhiStepSize +Phi angle step size per second (deg/s). (Read/Write number) +RealTimeDuration +Real time duration of the time animation in seconds (s). (Read/Write number) +ThetaStepSize +Theta angle step size per second (deg/s). (Read/Write number) +Type +The animation type specified by the AnimationTypeEnum, e.g. Phase, Frequency, etc. (Read/Write +AnimationTypeEnum) +Property Details +ContinuousFrequencySamples +Number of continuous frequency samples. +Type +number +Access +Read/Write +FrequencyRate +Number of frequency points to step per second (points/s). +Type +number +Access +Read/Write +PhaseStepSize +Phase step size per second (wt/s). +Type +number +Access +Read/Write +PhiStepSize +Phi angle step size per second (deg/s). +Type +number +Access +Read/Write +RealTimeDuration +Real time duration of the time animation in seconds (s). +Type +number +Access +Read/Write +ThetaStepSize +Theta angle step size per second (deg/s). +Type +number +Access +Read/Write +Type +The animation type specified by the AnimationTypeEnum, e.g. Phase, Frequency, etc. +Type +AnimationTypeEnum +Access +Read/Write +View3DAxesFormat +The view 3D axes properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +view = app.Views[1] + -- Configure the axes tick marks using using 'View3DAxesFormat' +view.Axes.TickMarksVisible = true +view.Axes.TickMarkSpacingOption = pf.Enums.AxesTickMarkSpacingEnum.Count +view.Axes.TickMarkCount = 10 +Usage locations +The View3DAxesFormat object can be accessed from the following locations: +• Properties +◦ View object has property Axes. +Property List +Length +The length of the main axes when the SizeOption is set to “SpecifyLength”. (Read/Write number) +MainVisible +Displays the main axes for the 3D view. (Read/Write boolean) +MiniVisible +Displays the mini axes for the 3D view. (Read/Write boolean) +SizeOption +The axis size option for the main axis, specified by the AxesScaleEnum, e.g. ScaleWithWindow, +ScaleWithModel or SpecifyLength. (Read/Write AxesScaleEnum) +TickMarkCount +The number of tick marks used when the TickMarkSpacingOption is set to “Count”. (Read/Write +number) +TickMarkSpacing +The tick mark spacing used when the TickMarkSpacingOption is set to “Spacing”. (Read/Write +number) +TickMarkSpacingOption +The tick mark spacing option for the main axis, specified by the AxesTickMarkSpacingEnum, e.g. +Auto, Count, Spacing. (Read/Write AxesTickMarkSpacingEnum) +TickMarksVisible +Displays the main axes tick marks for the 3D view. (Read/Write boolean) +Property Details +Length +The length of the main axes when the SizeOption is set to “SpecifyLength”. +Type +number +Access +Read/Write +MainVisible +Displays the main axes for the 3D view. +Type +boolean +Access +Read/Write +MiniVisible +Displays the mini axes for the 3D view. +Type +boolean +Access +Read/Write +SizeOption +The axis size option for the main axis, specified by the AxesScaleEnum, e.g. ScaleWithWindow, +ScaleWithModel or SpecifyLength. +Type +AxesScaleEnum +Access +Read/Write +TickMarkCount +The number of tick marks used when the TickMarkSpacingOption is set to “Count”. +Type +number +Access +Read/Write +TickMarkSpacing +The tick mark spacing used when the TickMarkSpacingOption is set to “Spacing”. +Type +number +Access +Read/Write +TickMarkSpacingOption +The tick mark spacing option for the main axis, specified by the AxesTickMarkSpacingEnum, e.g. +Auto, Count, Spacing. +Type +AxesTickMarkSpacingEnum +Access +Read/Write +TickMarksVisible +Displays the main axes tick marks for the 3D view. +Type +boolean +Access +Read/Write +View3DFormat +The view 3D format properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +view = app.Views[1] + -- Configure the 3d view using 'View3DFormat' +view.Format.DepthLightingEnabled = true +view.Format.PhiDirection = 270 +view.Format.Origin = pf.Point.New(0.02, 0.01, 0) +Usage locations +The View3DFormat object can be accessed from the following locations: +• Properties +◦ View object has property Format. +Property List +DepthLightingEnabled +Displays the 3D view using depth lighting. (Read/Write boolean) +GreyScaleEnabled +Displays the 3D view in grey scale. (Read/Write boolean) +Origin +The view focus point origin. (Read/Write Point) +PhiDirection +Phi view direction in degrees. (Read/Write number) +Rotation +The model rotation in degrees. Changing this property will disable the Z lock. (Read/Write +number) +ThetaDirection +Theta view direction in degrees. (Read/Write number) +ZLockEnabled +Applies Z lock to 3D view manipulations. (Read/Write boolean) +ZoomDistance +The view zoom distance. (Read/Write number) +Property Details +DepthLightingEnabled +Displays the 3D view using depth lighting. +Type +boolean +Access +Read/Write +GreyScaleEnabled +Displays the 3D view in grey scale. +Type +boolean +Access +Read/Write +Origin +The view focus point origin. +Type +Point +Access +Read/Write +PhiDirection +Phi view direction in degrees. +Type +number +Access +Read/Write +Rotation +The model rotation in degrees. Changing this property will disable the Z lock. +Type +number +Access +Read/Write +ThetaDirection +Theta view direction in degrees. +Type +number +Access +Read/Write +ZLockEnabled +Applies Z lock to 3D view manipulations. +Type +boolean +Access +Read/Write +ZoomDistance +The view zoom distance. +Type +number +Access +Read/Write +View3DLegendRangeFormat +The view 3D legend range properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farField = app.Models["startup"].Configurations[1].FarFields[1] +resultView = app.Views[1] +resultView.Plots:Add(farField) + -- SetProperties the view's legend range properties using + 'View3DLegendRangeFormat' +resultView.Legend.Rounded = false +Usage locations +The View3DLegendRangeFormat object can be accessed from the following locations: +• Properties +◦ View object has property Legend. +Property List +Rounded +Round off legend range and step size. (Read/Write boolean) +ScaledToCommonQuantity +Scale legend range to visible results of the same quantity. (Read/Write boolean) +ScaledToPeakInstantaneousValues +Scale legend range to peak instantaneous values. (Read/Write boolean) +ScaledToSelectedDimensions +Scale legend range to request slice dimensions. (Read/Write boolean) +ScaledToSelectedFrequency +Scale legend range to selected frequency. (Read/Write boolean) +ScaledToSelectedTimeStep +Scale legend range to selected time step. (Read/Write boolean) +ScaledToVectorMagnitude +Scale legend range to vector magnitude. (Read/Write boolean) +Property Details +Rounded +Round off legend range and step size. +Type +boolean +Access +Read/Write +ScaledToCommonQuantity +Scale legend range to visible results of the same quantity. +Type +boolean +Access +Read/Write +ScaledToPeakInstantaneousValues +Scale legend range to peak instantaneous values. +Type +boolean +Access +Read/Write +ScaledToSelectedDimensions +Scale legend range to request slice dimensions. +Type +boolean +Access +Read/Write +ScaledToSelectedFrequency +Scale legend range to selected frequency. +Type +boolean +Access +Read/Write +ScaledToSelectedTimeStep +Scale legend range to selected time step. +Type +boolean +Access +Read/Write +ScaledToVectorMagnitude +Scale legend range to vector magnitude. +Type +boolean +Access +Read/Write +View3DSolutionEntityFormat +The view 3D solution entity properties. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farField = app.Models["startup"].Configurations[1].FarFields[1] +resultView = app.Views[1] +resultView.Plots:Add(farField) + -- SetProperties source visibility using 'View3DSolutionEntityFormat' +resultView.SolutionEntities.SourcesVisible = false +Usage locations +The View3DSolutionEntityFormat object can be accessed from the following locations: +• Properties +◦ View object has property SolutionEntities. +Property List +CablesVisible +Enables/disables the visibility of cable paths. (Read/Write boolean) +FiniteAntennaArraysVisible +Enables/disables the visibility of finite antenna arrays. (Read/Write boolean) +InfinitePlanesOpacity +Infinite planes opacity as a percentage. (Read/Write number) +InfinitePlanesVisible +Enables/disables the visibility of infinite planes. (Read/Write boolean) +LoadsVisible +Enables/disables the visibility of loads. (Read/Write boolean) +NamedPointsVisible +Enables/disables the visibility of named points. (Read/Write boolean) +NetworksVisible +Enables/disables the visibility of general networks. (Read/Write boolean) +PBCVisible +Enables/disables the visibility of periodic boundary conditions. (Read/Write boolean) +ProbesVisible +Enables/disables the visibility of SPICE probes. (Read/Write boolean) +ReceivingAntennasVisible +Enables/disables the visibility of receiving antennas. (Read/Write boolean) +SourceFormat +The source options properties. (Read/Write View3DSourceFormat) +SourcesVisible +Enables/disables the visibility of sources. (Read/Write boolean) +SymmetryVisible +Enables/disables the visibility of symmetry. (Read/Write boolean) +TransmissionLinesVisible +Enables/disables the visibility of transmission lines. (Read/Write boolean) +Property Details +CablesVisible +Enables/disables the visibility of cable paths. +Type +boolean +Access +Read/Write +FiniteAntennaArraysVisible +Enables/disables the visibility of finite antenna arrays. +Type +boolean +Access +Read/Write +InfinitePlanesOpacity +Infinite planes opacity as a percentage. +Type +number +Access +Read/Write +InfinitePlanesVisible +Enables/disables the visibility of infinite planes. +Type +boolean +Access +Read/Write +LoadsVisible +Enables/disables the visibility of loads. +Type +boolean +Access +Read/Write +NamedPointsVisible +Enables/disables the visibility of named points. +Type +boolean +Access +Read/Write +NetworksVisible +Enables/disables the visibility of general networks. +Type +boolean +Access +Read/Write +PBCVisible +Enables/disables the visibility of periodic boundary conditions. +Type +boolean +Access +Read/Write +ProbesVisible +Enables/disables the visibility of SPICE probes. +Type +boolean +Access +Read/Write +ReceivingAntennasVisible +Enables/disables the visibility of receiving antennas. +Type +boolean +Access +Read/Write +SourceFormat +The source options properties. +Type +View3DSourceFormat +Access +Read/Write +SourcesVisible +Enables/disables the visibility of sources. +Type +boolean +Access +Read/Write +SymmetryVisible +Enables/disables the visibility of symmetry. +Type +boolean +Access +Read/Write +TransmissionLinesVisible +Enables/disables the visibility of transmission lines. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +View3DSourceFormat +The view 3D source properties. +Example +p.4060 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +LEPO_Reflector_and_Aperture_source.fek]]) +resultView = app.Views[1] + -- SetProperties source rendering properties using 'View3DSourceFormat' +resultView.SolutionEntities.SourceFormat.ColouredByMagnitude = true +resultView.SolutionEntities.SourceFormat.ScaledByMagnitude = true +Usage locations +The View3DSourceFormat object can be accessed from the following locations: +• Properties +◦ View3DSolutionEntityFormat object has property SourceFormat. +Property List +ColouredByMagnitude +Colours the sources according to their magnitude. (Read/Write boolean) +ScaleType +The type of source scaling specified by the SourcesScaleTypeEnum, e.g. Decibel or Linear. (Read/ +Write SourcesScaleTypeEnum) +ScaledByMagnitude +Scales the sources according to their magnitude. (Read/Write boolean) +Property Details +ColouredByMagnitude +Colours the sources according to their magnitude. +Type +boolean +Access +Read/Write +ScaleType +The type of source scaling specified by the SourcesScaleTypeEnum, e.g. Decibel or Linear. +Type +SourcesScaleTypeEnum +Access +Read/Write +ScaledByMagnitude +Scales the sources according to their magnitude. +Type +boolean +Access +Read/Write +Altair Feko 2022.3 +2 Application Programming Interface (API) +WaveguideExcitationStoredData +Stored waveguide excitation results. +Example +p.4062 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) +waveguideSource + = pf.GetApplication().Models[1].Configurations[1].Excitations["AWSource1"] + -- Store a copy of the waveguide source data. +storedData = waveguideSource:StoreData() +Inheritance +The WaveguideExcitationStoredData object is derived from the ResultData object. +Property List +ContinuousFrequencyAxis +Continuous frequency axis exists. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. (Returns a DataSet object.) +Property Details +ContinuousFrequencyAxis +Continuous frequency axis exists. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the source values. +Return +DataSet +The data set containing the source values. +GetDataSet (samplePoints number) +Returns a data set containing the source values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the source values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the source values. +WidthAnnotation +A 2D graph width annotation. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +app.Views[1]:Close() + -- Add a Cartesian graph to the application's collection and obtain + -- the annotation collection +graph = app.CartesianGraphs:Add() +farFieldTrace = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) +annotations = graph.Annotations + -- Add a default delta annoation +annotation1 = annotations:AddDeltaAnnotation(farFieldTrace) + -- Modify the delta annoation +properties = annotation1:GetProperties() +properties.Point2AnnotationType = + pf.Enums.SinglePointAnnotationTypeEnum.GreatestLocalMinToLeft +properties.Point1RelativeType = + pf.Enums.AnnotationRelativeTypeEnum.RelativeToGlobalMax +annotation1:SetProperties(properties) +Inheritance +The WidthAnnotation object is derived from the GraphAnnotation object. +Property List +AnnotationRelativeType +For annotations that are relative to other graph positions, this values sets what it is relative to. +(Read/Write AnnotationRelativeTypeEnum) +AutoTextEnabled +Toggle between auto text and custom annotation text. (Read/Write boolean) +Label +The object label. (Read/Write string) +OffsetX +Annotation text box offset (pixels) in the x-direction. A positive value moves the annotation to the +right, a negative value moves it to the left. If both the OffsetX and OffsetY is zero, it will be placed +automatically. (Read/Write number) +OffsetY +Annotation text box offset (pixels) in the y-direction. A positive value moves the annotation to +the bottom, a negative value moves it to the top. If both the OffsetX and OffsetY is zero, it will be +placed automatically. (Read/Write number) +Point1AnnotationType +The first single point annotation type. (Read/Write SinglePointAnnotationTypeEnum) +Point1PositionHorizontal +First single point horizontal (x) position. (Read/Write number) +Point1PositionVertical +First single point vertical (y) position. (Read/Write number) +Point1RelativeType +For annotations that are relative to other graph positions, this value sets what it is relative to for +the first point. (Read/Write AnnotationRelativeTypeEnum) +Point2AnnotationType +The second single point annotation type. (Read/Write SinglePointAnnotationTypeEnum) +Point2PositionHorizontal +Second single point horizontal (x) position. (Read/Write number) +Point2PositionVertical +Second single point vertical (y) position. (Read/Write number) +Point2RelativeType +For annotations that are relative to other graph positions, this value sets what it is relative to for +the second point. (Read/Write AnnotationRelativeTypeEnum) +Text +Trace +Type +The annotation text. (Read/Write string) +The ResultTrace of the annotation. (Read/Write ResultTrace) +The object type string. (Read only string) +WidthType +The single point annotation type. (Read/Write AnnotationWidthTypeEnum) +Method List +Delete () +Delete the annotation. +Duplicate () +Duplicate the annotation. (Returns a GraphAnnotation object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +GetValues () +Get table of values associated with the annotation. (Returns a Map of string:Expression object.) +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Property Details +AnnotationRelativeType +p.4067 +For annotations that are relative to other graph positions, this values sets what it is relative to. +Type +AnnotationRelativeTypeEnum +Access +Read/Write +AutoTextEnabled +Toggle between auto text and custom annotation text. +Type +boolean +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +OffsetX +Annotation text box offset (pixels) in the x-direction. A positive value moves the annotation to the +right, a negative value moves it to the left. If both the OffsetX and OffsetY is zero, it will be placed +automatically. +Type +number +Access +Read/Write +OffsetY +Annotation text box offset (pixels) in the y-direction. A positive value moves the annotation to +the bottom, a negative value moves it to the top. If both the OffsetX and OffsetY is zero, it will be +placed automatically. +Type +number +Access +Read/Write +Point1AnnotationType +The first single point annotation type. +Type +SinglePointAnnotationTypeEnum +Access +Read/Write +Point1PositionHorizontal +First single point horizontal (x) position. +Type +number +Access +Read/Write +Point1PositionVertical +First single point vertical (y) position. +Type +number +Access +Read/Write +Point1RelativeType +For annotations that are relative to other graph positions, this value sets what it is relative to for +the first point. +Type +AnnotationRelativeTypeEnum +Access +Read/Write +Point2AnnotationType +The second single point annotation type. +Type +SinglePointAnnotationTypeEnum +Access +Read/Write +Point2PositionHorizontal +Second single point horizontal (x) position. +Type +number +Access +Read/Write +Point2PositionVertical +Second single point vertical (y) position. +Type +number +Access +Read/Write +Point2RelativeType +For annotations that are relative to other graph positions, this value sets what it is relative to for +the second point. +Type +AnnotationRelativeTypeEnum +Access +Read/Write +Text +The annotation text. +Type +string +Access +Read/Write +Trace +The ResultTrace of the annotation. +Type +ResultTrace +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +WidthType +The single point annotation type. +Type +AnnotationWidthTypeEnum +Access +Read/Write +Method Details +Delete () +Delete the annotation. +Duplicate () +Duplicate the annotation. +Return +GraphAnnotation +The new annotation. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +GetValues () +A properties table. +Get table of values associated with the annotation. +Return +Map of string:Expression +Table of key-value pairs. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Window +A view where results can be plotted. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Obtain the 3D view window +windowView3D = app.Views[1] + -- Resize the window and put it at a convenient location +windowView3D:SetSize(512, 512) +windowView3D:SetPosition(25, 25) + -- Change the title +windowView3D.WindowTitle = "3D View for the Example Project" + -- Export the contents of the window as a PNG to a file +windowView3D:ExportImage("temp_Example3DViewImage", "png") +Inheritance +The following objects are derived (specialisations) from the Window object: +• Graph +• SurfaceGraph +• View +Usage locations +The Window object can be accessed from the following locations: +• Methods +◦ WindowCollection collection has method Items(). +◦ WindowCollection collection has method Item(number). +◦ WindowCollection collection has method Item(string). +◦ WindowCollection collection has method GetActiveWindow(). +Property List +Height +The height of the window. (Read only number) +Width +The width of the window. (Read only number) +WindowActive +True if this window is the active window. (Read only boolean) +WindowTitle +The title of the window. (Read/Write string) +XPosition +The X position of the window. (Read only number) +YPosition +The Y position of the window. (Read only number) +Method List +Close () +Close the window. +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Show () +Shows the view. +ZoomToExtents () +Zoom the content of the window to its extent. +Property Details +Height +The height of the window. +Type +number +Access +Read only +Width +The width of the window. +Type +number +Access +Read only +WindowActive +True if this window is the active window. +Type +boolean +Access +Read only +WindowTitle +The title of the window. +Type +string +Access +Read/Write +XPosition +The X position of the window. +Type +number +Access +Read only +YPosition +The Y position of the window. +Type +number +Access +Read only +Method Details +Close () +Close the window. +ExportImage (filename string, fileformat string) +Export the window image at its same size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +ExportImage (filename string, fileformat string, imagewidth number, imageheight number) +Export the window image at the given size to a specified file. +Input Parameters +filename(string) +The name of the image file without its extension. +fileformat(string) +The image file format, e.g. jpg, png, pdf, etc. +imagewidth(number) +The export width in pixels. +imageheight(number) +The export height in pixels. +Maximise () +Maximise the window. +Minimise () +Minimise the window. +Restore () +Restore the window. +SetPosition (xposition number, yposition number) +Sets the view position. Note that the view is restored when this function is called. +Input Parameters +xposition(number) +The view X position. +yposition(number) +The view Y position. +SetSize (imagewidth number, imageheight number) +Sets the view size. Note that the view is restored when this function is called. +Input Parameters +imagewidth(number) +The view width in pixels. +imageheight(number) +The view height in pixels. +Show () +Shows the view. +ZoomToExtents () +Zoom the content of the window to its extent. +WireCurrents3DPlot +A wire currents 3D result. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Create a new 3D View for the model configuration +model = app.Models["Dipole_Example"] +conf = model.Configurations["StandardConfiguration1"] +view = app.Views:Add(conf) + -- Add the wire currents 3D plot to the view +wireCurrents = conf.WireCurrents[1] +plot = view.Plots:Add(wireCurrents) + -- Give the 3D plot a convenient label and change the shading +plot.Label = "Wire_Currents_3D_Plot" +plot.Visualisation.FlatShaded = true + -- Specify the frequency to display the currents of +print("Available fixed axes:") +printlist(plot.FixedAxes) +available = plot:GetFixedAxisAvailableValues("Frequency") +print("\nAvailable frequency axis values:") +printlist(available) +plot:SetFixedAxisValue("Frequency", tonumber(available[4]), "") +Inheritance +The WireCurrents3DPlot object is derived from the Result3DPlot object. +Property List +Arrows +The wire currents and charges plot arrows properties. (Read only Arrows3DFormat) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The object that is the data source for this plot. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +Label +The object label. (Read/Write string) +Legend +The 3D plot legend properties. (Read only Plot3DLegendFormat) +Quantity +The wire currents and charges 3D plot quantity properties. (Read only WireCurrentsQuantity) +Type +The object type string. (Read only string) +Visible +Specifies whether the plot must be shown or hidden. (Read/Write boolean) +Visualisation +The wire currents and charges visualisation properties. (Read only Currents3DFormat) +Method List +Delete () +Delete the plot. +GetAxisUnit (axis string) +Returns the SI unit for the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Stores a copy of the plot. (Returns a Result3DPlot object.) +Property Details +Arrows +The wire currents and charges plot arrows properties. +Type +Arrows3DFormat +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The object that is the data source for this plot. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the +contents of the ResultData object. The value for a specific fixed axis can be queried and set with +the GetFixedAxisValue() and SetFixedAxisValue() methods. +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Legend +The 3D plot legend properties. +Type +Plot3DLegendFormat +Access +Read only +Quantity +The wire currents and charges 3D plot quantity properties. +Type +WireCurrentsQuantity +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Visible +Specifies whether the plot must be shown or hidden. +Type +boolean +Access +Read/Write +Visualisation +The wire currents and charges visualisation properties. +Type +Currents3DFormat +Access +Read only +Method Details +Delete () +Delete the plot. +GetAxisUnit (axis string) +Returns the SI unit for the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +GetProperties () +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Stores a copy of the plot. +Return +Result3DPlot +The new plot associated with the stored data. +WireCurrentsAndChargesStoredData +Stored wire currents and charges results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Retrieve the 'WireCurrentsData' called 'Currents1' +wireCurrentsData = app.Models[1].Configurations[1].WireCurrents["Currents1"] + -- Create a stored wire currents and charges data entity +storedData = wireCurrentsData:StoreData() + -- Plot surface currents data +wireCurrentsPlot = app.Views[1].Plots:Add(storedData) +Inheritance +The WireCurrentsAndChargesStoredData object is derived from the ResultData object. +Property List +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the near field values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the near field values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the near field values. (Returns a DataSet object.) +Property Details +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the stored data. +GetDataSet () +Returns a data set containing the near field values. +Return +DataSet +The data set containing the near field values. +GetDataSet (samplePoints number) +Returns a data set containing the near field values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the near field values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the near field values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the near field values. +Altair Feko 2022.3 +2 Application Programming Interface (API) +WireCurrentsData +Wire currents generated by the Feko Solver. +Example +p.4083 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Obtain the wire current data from the model solution configuration +currentData = app.Models[1].Configurations[1].WireCurrents[1] + -- Export the currents and charges to a file +currentData:ExportData("temp_"..currentData.Label, pf.Enums.CurrentsExportTypeEnum.Both, 2) +Inheritance +The WireCurrentsData object is derived from the ResultData object. +Usage locations +The WireCurrentsData object can be accessed from the following locations: +• Methods +◦ WireCurrentsCollection collection has method Items(). +◦ WireCurrentsCollection collection has method Item(number). +◦ WireCurrentsCollection collection has method Item(string). +Property List +Configuration +The result data's solution configuration in the model. (Read only SolutionConfiguration) +DataSetAvailable +Valid result data exist. (Read only boolean) +Label +Type +The object label. (Read/Write string) +The object type string. (Read only string) +Method List +ExportData (filename string, components CurrentsExportTypeEnum, samples number) +Export the result wire currents and charges data to the specified *.os / *.ol file. +GetDataSet () +Returns a data set containing the current values. (Returns a DataSet object.) +GetDataSet (samplePoints number) +Returns a data set containing the current values. (Returns a DataSet object.) +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the current values. (Returns a DataSet object.) +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +Configuration +The result data's solution configuration in the model. +Type +SolutionConfiguration +Access +Read only +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +ExportData (filename string, components CurrentsExportTypeEnum, samples number) +Export the result wire currents and charges data to the specified *.os / *.ol file. +Input Parameters +filename(string) +The name of the exported data file without its extension. +components(CurrentsExportTypeEnum) +The components to export specified by the CurrentsExportTypeEnum, e.g. Both (*.os +and *.ol), Currents (*.os) or Charges (*.ol). +samples(number) +The number of samples for continuous data. This value will be ignored if the data is +discrete. +GetDataSet () +Returns a data set containing the current values. +Return +DataSet +The data set containing the current values. +GetDataSet (samplePoints number) +Returns a data set containing the current values. +Input Parameters +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the current values. +GetDataSet (startFrequency number, endFrequency number, samplePoints number) +Returns a data set containing the current values. +Input Parameters +startFrequency(number) +The start frequency used to sample the continuous frequency axis. +endFrequency(number) +The end frequency used to sample the continuous frequency axis. +samplePoints(number) +The number of sample points used to sample the continuous frequency axis. +Return +DataSet +The data set containing the current values. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +WireCurrentsMathScript +Wire currents math script data that can be plotted. +Example +p.4086 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Create a currents math script +currentsMathScript = + app.MathScripts:Add(pf.Enums.MathScriptTypeEnum.WireCurrentsAndCharges) +script = +[[ +dataSet = + pf.WireCurrentsAndCharges.GetDataSet("Dipole_example.StandardConfiguration1.Currents1") +scale = 2 +currentsMatrix = dataSet:ToComplexMatrix({"Current"}) +currentsMatrix = currentsMatrix * scale +dataSet:FromComplexMatrix(currentsMatrix, {"Current"}) +return dataSet +]] +currentsMathScript.Script = script +currentsMathScript:Run() + -- Plot the math script +currentsPlot = app.Views[1].Plots:Add(currentsMathScript) +Inheritance +The WireCurrentsMathScript object is derived from the MathScript object. +Property List +DataSetAvailable +Label +Script +Type +Valid result data exist. (Read only boolean) +The object label. (Read/Write string) +The script code to execute. (Read/Write string) +The object type string. (Read only string) +Method List +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. (Returns a MathScript object.) +GetDataSet () +Returns a data set containing the math script values. (Returns a DataSet object.) +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. (Returns a ResultData object.) +Property Details +DataSetAvailable +Valid result data exist. +Type +boolean +Access +Read only +Label +The object label. +Type +string +Access +Read/Write +Script +The script code to execute. +Type +string +Access +Read/Write +Type +The object type string. +Type +string +Access +Read only +Method Details +Delete () +Delete the math script. +Duplicate () +Duplicate the math script. +Return +MathScript +The duplicated math script. +GetDataSet () +Returns a data set containing the math script values. +Return +DataSet +The data set containing the math script values. +Run () +Run the math script. +StoreData () +Creates a local stored version of the result data. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +WireCurrentsQuantity +The wire currents and charges quantity properties. +Example +p.4089 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Obtain the 3D view and add a wire current plot +view = app.Views[1] +plot = view.Plots:Add(app.Models[1].Configurations[1].WireCurrents[1]) + -- Normalise the values on the graph and scale to dB +quantity = plot.Quantity +quantity.ValuesNormalised = true +quantity.ValuesScaledToDB = true +Usage locations +The WireCurrentsQuantity object can be accessed from the following locations: +• Properties +◦ WireCurrents3DPlot object has property Quantity. +◦ WireCurrentsTrace object has property Quantity. +Property List +ComplexComponent +The complex component of the wire currents value to plot, specified by the +ComplexComponentEnum, e.g. Magnitude, Instantaneous. (Read/Write ComplexComponentEnum) +InstantaneousPhase +The phase value (wt) to use when ComplexComponent is Instantaneous. The value is in degrees +[0,360]. (Read/Write number) +QuantityType +The type of wire currents quantity to be plotted, specified by the WireCurrentsQuantityTypeEnum, +e.g. Currents or Charges. (Read/Write WireCurrentsQuantityTypeEnum) +SortBy +The wire currents sorting dimension, specified by the WireCurrentsSortEnum, e.g. ByIndex, ByX, +ByY or ByZ. This property is only valid when the IndependentAxis is set to “Segments”. (Read/ +Write WireCurrentsSortEnum) +ValuesNormalised +Specifies whether the wire currents quantity values must be normalised to the range [0,1] before +plotting. This property can be used together with dB scaling. (Read/Write boolean) +Altair Feko 2022.3 +2 Application Programming Interface (API) +ValuesScaledToDB +p.4090 +Specifies whether the wire currents quantity values are scaled to dB before plotting. (Read/Write +boolean) +Property Details +ComplexComponent +The complex component of the wire currents value to plot, specified by the +ComplexComponentEnum, e.g. Magnitude, Instantaneous. +Type +ComplexComponentEnum +Access +Read/Write +InstantaneousPhase +The phase value (wt) to use when ComplexComponent is Instantaneous. The value is in degrees +[0,360]. +Type +number +Access +Read/Write +QuantityType +The type of wire currents quantity to be plotted, specified by the WireCurrentsQuantityTypeEnum, +e.g. Currents or Charges. +Type +WireCurrentsQuantityTypeEnum +Access +Read/Write +SortBy +The wire currents sorting dimension, specified by the WireCurrentsSortEnum, e.g. ByIndex, ByX, +ByY or ByZ. This property is only valid when the IndependentAxis is set to “Segments”. +Type +WireCurrentsSortEnum +Access +Read/Write +ValuesNormalised +Specifies whether the wire currents quantity values must be normalised to the range [0,1] before +plotting. This property can be used together with dB scaling. +Type +boolean +Access +Read/Write +ValuesScaledToDB +Specifies whether the wire currents quantity values are scaled to dB before plotting. +Type +boolean +Access +Read/Write +WireCurrentsTrace +A wire currents 2D trace. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Add a cartesian graph to plot the traces on +cartGraph = app.CartesianGraphs:Add() + -- Add the wire currents to the Traces collection of the Cartesian graph +wireCurrentTrace = + cartGraph.Traces:Add(app.Models[1].Configurations[1].WireCurrents[1]) + -- Set the independent axis to "Segments" +wireCurrentTrace.IndependentAxis = "Segments" + -- Change the value of the fixed axis (to the highest frequency) +freqValueOptions = wireCurrentTrace:GetFixedAxisAvailableValues("Frequency") +unit = wireCurrentTrace:GetAxisUnit("Frequency") +wireCurrentTrace:SetFixedAxisValue("Frequency", + tonumber(freqValueOptions[#freqValueOptions]), unit) + -- Set the fixed Segment axis to "Line1.Wire1" +wireCurrentTrace:SetFixedAxisValue("Segments", "Line1.Wire1") + -- Ensure the entire graph is visible +cartGraph:ZoomToExtents() +Inheritance +The WireCurrentsTrace object is derived from the ResultTrace object. +Property List +Axes +The trace axes properties. (Read only TraceAxes) +AxisNames +The names of all the axes on the ResultPlot. (Read only List of string) +DataSource +The source of the trace. (Read/Write ResultData) +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string) +IndependentAxesAvailable +The list of available independent axes. (Read only List of string) +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string) +Label +The object label. (Read/Write string) +Legend +The trace legend properties. (Read only TraceLegendFormat) +Line +The trace line format properties. (Read only TraceLineFormat) +Markers +The trace marker format properties. (Read only TraceMarkersFormat) +Math +The wire currents and charges trace math expression properties. (Read only +TraceMathExpression) +Quantity +The wire currents and charges trace quantity properties. (Read only WireCurrentsQuantity) +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. (Read only TraceSamplingFormat) +Type +The object type string. (Read only string) +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. (Read only Matrix) +Visible +Specifies whether the trace must be shown or hidden. (Read/Write boolean) +Method List +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. (Returns a ResultTrace object.) +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. (Returns a string object.) +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. (Returns a List of string object.) +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. (Returns a string object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.4094 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +(Returns a table object.) +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Store () +Store a copy of the trace. (Returns a ResultTrace object.) +Property Details +Axes +The trace axes properties. +Type +TraceAxes +Access +Read only +AxisNames +The names of all the axes on the ResultPlot. +Access +Read only +DataSource +The source of the trace. +Type +ResultData +Access +Read/Write +FixedAxes +The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well +as the contents of the ResultData object. The value for a specific fixed axis can be queried and set +with the GetFixedAxisValue() and SetFixedAxisValue() methods. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Access +Read only +IndependentAxesAvailable +The list of available independent axes. +Access +Read only +IndependentAxis +The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. +p.4095 +Type +string +Access +Read/Write +Label +The object label. +Type +string +Access +Read/Write +Legend +The trace legend properties. +Type +TraceLegendFormat +Access +Read only +Line +The trace line format properties. +Type +TraceLineFormat +Access +Read only +Markers +The trace marker format properties. +Type +TraceMarkersFormat +Access +Read only +Math +The wire currents and charges trace math expression properties. +Type +TraceMathExpression +Access +Read only +Quantity +The wire currents and charges trace quantity properties. +Type +WireCurrentsQuantity +Access +Read only +Sampling +The continuous trace sampling settings. These settings only apply to traces when the independent +axis is continuously sampled. +Type +TraceSamplingFormat +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Values +The values that are plotted on the graph for this trace. The first column represents the +independent axis and the second column represents the scalar quantity being displayed on the +graph. Each row represents a sampled coordinate pair. +Type +Matrix +Access +Read only +Visible +Specifies whether the trace must be shown or hidden. +Type +boolean +Access +Read/Write +Method Details +Delete () +Delete the trace. +Duplicate () +Duplicate the trace. +Return +ResultTrace +The duplicated trace. +GetAxisUnit (axis string) +Returns the SI unit of the specified axis. +Input Parameters +axis(string) +The axis. +Return +string +The SI unit string. +GetFixedAxisAvailableValues (axis string) +Returns the list of available values for the specified axis. +Input Parameters +axis(string) +The fixed axis. +Return +List of string +The axis values. +GetFixedAxisValue (axis string) +Returns the current value for the specified fixed axis. +Input Parameters +axis(string) +The fixed axis. +Return +string +The axis value. +Altair Feko 2022.3 +2 Application Programming Interface (API) +GetProperties () +p.4098 +Returns a table of properties representing the state of the object. The properties table can be +used with the SetProperties method to change multiple properties of the object in one step. +Return +table +A properties table. +Lower () +Lower the trace. +Raise () +Raise the trace. +SetFixedAxisValue (axis string, numvalue number, unit string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +numvalue(number) +The axis value. +unit(string) +The given value's unit. Provide an empty string if it has no unit. +SetFixedAxisValue (axis string, strvalue string) +Set the fixed axis to the specified value. +Input Parameters +axis(string) +The fixed axis. +strvalue(string) +The axis value. +SetProperties (properties table) +Modifies the state of the object using the provided table of properties. This method is used to +modify multiple properties of the object in a single step. +Input Parameters +properties(table) +A table of properties defining the new state of the object. +Store () +Store a copy of the trace. +Return +ResultTrace +A copy of the trace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +2.2.2 Collections (API) +p.4099 +Altair Feko 2022.3 +2 Application Programming Interface (API) +CartesianGraphCollection +A collection of Cartesian graphs. +Example +p.4100 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create graphs +farFieldGraph = app.CartesianGraphs:Add() +farFieldGraph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) +nearFieldGraph = app.CartesianGraphs:Add() +nearFieldGraph.Traces:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Export all graphs in the 'CartesianGraphCollection' +for index, graph in pairs(app.CartesianGraphs) do + graph:Maximise() + graph:ExportImage("temp_Graph"..index, "pdf") +end +Usage locations +The CartesianGraphCollection object can be accessed from the following locations: +• Collection lists +◦ Application object has collection CartesianGraphs. +Property List +Count +Type +The number of CartesianGraph items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Add () +Adds a new Cartesian graph to the collection. (Returns a CartesianGraph object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the CartesianGraph at the given index. (Returns a CartesianGraph object.) +Item (label string) +Returns the CartesianGraph with the given label. (Returns a CartesianGraph object.) +Items () +Returns a table of CartesianGraph. (Returns a List of CartesianGraph object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4101 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the CartesianGraph at the given index in the collection. (Read CartesianGraph) +[string] +Returns the CartesianGraph with the given name in the collection. (Read CartesianGraph) +Property Details +Count +The number of CartesianGraph items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Add () +Adds a new Cartesian graph to the collection. +Return +CartesianGraph +The new Cartesian graph. +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the CartesianGraph. +Return +boolean +The success of the check. +Item (index number) +Returns the CartesianGraph at the given index. +Input Parameters +index(number) +The index of the CartesianGraph. +Return +CartesianGraph +The CartesianGraph at the given index. +Item (label string) +Returns the CartesianGraph with the given label. +Input Parameters +label(string) +The label of the CartesianGraph. +Return +CartesianGraph +The CartesianGraph with the given label. +Items () +Returns a table of CartesianGraph. +Return +List of CartesianGraph +A table of CartesianGraph. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for CartesianGraph. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CartesianSurfaceGraphCollection +A collection of Cartesian surface graphs. +Example +p.4103 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Add a Cartesian surface graph and a surface plot +graph = app.CartesianSurfaceGraphs:Add() +farFieldPlot = graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Export all graphs in the 'CartesianSurfaceGraphCollection' +for index, graph in pairs(app.CartesianSurfaceGraphs) do + graph:Maximise() + graph:ExportImage("temp_Graph"..index, "pdf") +end +Usage locations +The CartesianSurfaceGraphCollection object can be accessed from the following locations: +• Collection lists +◦ Application object has collection CartesianSurfaceGraphs. +Property List +Count +Type +The number of CartesianSurfaceGraph items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Add () +Adds a new Cartesian surface graph to the collection. (Returns a CartesianSurfaceGraph object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the CartesianSurfaceGraph at the given index. (Returns a CartesianSurfaceGraph object.) +Item (label string) +Returns the CartesianSurfaceGraph with the given label. (Returns a CartesianSurfaceGraph +object.) +Items () +Returns a table of CartesianSurfaceGraph. (Returns a List of CartesianSurfaceGraph object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4104 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the CartesianSurfaceGraph at the given index in the collection. (Read +CartesianSurfaceGraph) +[string] +Returns the CartesianSurfaceGraph with the given name in the collection. (Read +CartesianSurfaceGraph) +Property Details +Count +The number of CartesianSurfaceGraph items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Add () +Adds a new Cartesian surface graph to the collection. +Return +CartesianSurfaceGraph +The new Cartesian surface graph. +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the CartesianSurfaceGraph. +Return +boolean +The success of the check. +Item (index number) +Returns the CartesianSurfaceGraph at the given index. +Input Parameters +index(number) +The index of the CartesianSurfaceGraph. +Return +CartesianSurfaceGraph +The CartesianSurfaceGraph at the given index. +Item (label string) +Returns the CartesianSurfaceGraph with the given label. +Input Parameters +label(string) +The label of the CartesianSurfaceGraph. +Return +CartesianSurfaceGraph +The CartesianSurfaceGraph with the given label. +Items () +Returns a table of CartesianSurfaceGraph. +Return +List of CartesianSurfaceGraph +A table of CartesianSurfaceGraph. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for CartesianSurfaceGraph. +Altair Feko 2022.3 +2 Application Programming Interface (API) +CharacteristicModeCollection +A collection of characteristic mode results. +Example +p.4106 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CharacteristicModes.fek]]) +characteristicModeCollection = app.Models[1].Configurations[1].CharacteristicModes + -- Add the first characteristic modes to a Cartesian graph +graph = app.CartesianGraphs:Add() + -- Index method +characteristicModeTrace1 = graph.Traces:Add(characteristicModeCollection[1]) + -- Name method +characteristicModeTrace1 = + graph.Traces:Add(characteristicModeCollection["CharacteristicModes1"]) +Usage locations +The CharacteristicModeCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection CharacteristicModes. +Property List +Count +Type +The number of CharacteristicModeData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the CharacteristicModeData at the given index. (Returns a CharacteristicModeData +object.) +Item (label string) +Returns the CharacteristicModeData with the given label. (Returns a CharacteristicModeData +object.) +Items () +Returns a table of CharacteristicModeData. (Returns a List of CharacteristicModeData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4107 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the CharacteristicModeData at the given index in the collection. (Read +CharacteristicModeData) +[string] +Returns the CharacteristicModeData with the given name in the collection. (Read +CharacteristicModeData) +Property Details +Count +The number of CharacteristicModeData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the CharacteristicModeData. +Return +boolean +The success of the check. +Item (index number) +Returns the CharacteristicModeData at the given index. +Input Parameters +index(number) +The index of the CharacteristicModeData. +Return +CharacteristicModeData +The CharacteristicModeData at the given index. +Item (label string) +Returns the CharacteristicModeData with the given label. +Input Parameters +label(string) +The label of the CharacteristicModeData. +Return +CharacteristicModeData +The CharacteristicModeData with the given label. +Items () +Returns a table of CharacteristicModeData. +Return +List of CharacteristicModeData +A table of CharacteristicModeData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for CharacteristicModeData. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ConfigurationCollection +A collection of configurations within a model. +Example +p.4109 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/multiple_configurations.fek]]) + -- Get the first configuration in the configuration collection +standardLoadConfiguration = app.Models[1].Configurations[1] + -- Get the other configuration in the configuration collection by name +largeLoadConfiguration = app.Models[1].Configurations["LargeLoad"] + -- Compare the two configurations' far fields +graph = app.CartesianGraphs:Add() +standardLoadFarFieldTrace = graph.Traces:Add(standardLoadConfiguration.FarFields[1]) +largeLoadFarFieldTrace = graph.Traces:Add(largeLoadConfiguration.FarFields[1]) +Usage locations +The ConfigurationCollection object can be accessed from the following locations: +• Collection lists +◦ Model object has collection Configurations. +Property List +Count +Type +The number of SolutionConfiguration items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the SolutionConfiguration at the given index. (Returns a SolutionConfiguration object.) +Item (label string) +Returns the SolutionConfiguration with the given label. (Returns a SolutionConfiguration object.) +Items () +Returns a table of SolutionConfiguration. (Returns a List of SolutionConfiguration object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4110 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the SolutionConfiguration at the given index in the collection. (Read +SolutionConfiguration) +[string] +Returns the SolutionConfiguration with the given name in the collection. (Read +SolutionConfiguration) +Property Details +Count +The number of SolutionConfiguration items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the SolutionConfiguration. +Return +boolean +The success of the check. +Item (index number) +Returns the SolutionConfiguration at the given index. +Input Parameters +index(number) +The index of the SolutionConfiguration. +Return +SolutionConfiguration +The SolutionConfiguration at the given index. +Item (label string) +Returns the SolutionConfiguration with the given label. +Input Parameters +label(string) +The label of the SolutionConfiguration. +Return +SolutionConfiguration +The SolutionConfiguration with the given label. +Items () +Returns a table of SolutionConfiguration. +Return +List of SolutionConfiguration +A table of SolutionConfiguration. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for SolutionConfiguration. +Altair Feko 2022.3 +2 Application Programming Interface (API) +DataSetAxisCollection +p.4112 +A data set contains a collection of axes. A handle can be obtained on an individual axis, or new axes can +be added to the collection by using the DataSetAxisCollection. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the far field data set +farFieldDataSet = + app.Models[1].Configurations[1].FarFields["FarFields"]:GetDataSet(51) + -- Print a list of the far field axes +printlist( farFieldDataSet.Axes:Items() ) + -- Access the axes +frequencyAxis = farFieldDataSet.Axes[1] -- Index method +frequencyAxis = farFieldDataSet.Axes["Frequency"] -- Name method +numberAxes = #farFieldDataSet.Axes +Usage locations +The DataSetAxisCollection object can be accessed from the following locations: +• Collection lists +◦ DataSet object has collection Axes. +Property List +Count +Type +The number of DataSetAxis items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Add (type DataSetAxisEnum) +Adds an empty axis to the data set. Only the type is known, the other properties (i.e. the unit and +values) must still be provided. (Returns a DataSetAxis object.) +Add (type DataSetAxisEnum, start number, end number, count number) +Adds a standard axis to the data set with a range of values. (Returns a DataSetAxis object.) +Add (type DataSetAxisEnum, values List of Variant) +Adds a standard axis to the data set with a given set of values. (Returns a DataSetAxis object.) +Add (name string, unit Unit) +Adds an empty axis to the data set. The values must still be provided. (Returns a DataSetAxis +object.) +Add (name string, unit Unit, value Variant) +Adds a new axis to the data set with a single value. (Returns a DataSetAxis object.) +Add (name string, unit Unit, start number, end number, count number) +Adds a new axis to the data set with a range of values. (Returns a DataSetAxis object.) +Add (name string, unit Unit, values List of Variant) +Adds a new axis to the data set with a given set of values. (Returns a DataSetAxis object.) +Add (axis DataSetAxis) +Adds a copy of the given axis to the data set. (Returns a DataSetAxis object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the DataSetAxis at the given index. (Returns a DataSetAxis object.) +Item (label string) +Returns the DataSetAxis with the given label. (Returns a DataSetAxis object.) +Items () +Returns a table of DataSetAxis. (Returns a List of DataSetAxis object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the DataSetAxis at the given index in the collection. (Read DataSetAxis) +[string] +Returns the DataSetAxis with the given name in the collection. (Read DataSetAxis) +Property Details +Count +The number of DataSetAxis items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (type DataSetAxisEnum) +Adds an empty axis to the data set. Only the type is known, the other properties (i.e. the unit and +values) must still be provided. +Input Parameters +type(DataSetAxisEnum) +The built-in axis type to add. +Return +DataSetAxis +The new axis. +Add (type DataSetAxisEnum, start number, end number, count number) +Adds a standard axis to the data set with a range of values. +Input Parameters +type(DataSetAxisEnum) +The built-in axis type to add. +start(number) +The first value of the axis. +end(number) +The last value of the axis. +count(number) +The number of points on the axis. +Return +DataSetAxis +An axis defined over a range of values. +Add (type DataSetAxisEnum, values List of Variant) +Adds a standard axis to the data set with a given set of values. +Input Parameters +type(DataSetAxisEnum) +The built-in axis type to add. +values(List of Variant) +The values of the axis in a table. +Return +DataSetAxis +A new axis with no unit. +Add (name string, unit Unit) +Adds an empty axis to the data set. The values must still be provided. +Input Parameters +name(string) +The name of the axis. +unit(Unit) +The unit of the axis. +Return +DataSetAxis +A new axis containing no values. +Add (name string, unit Unit, value Variant) +Adds a new axis to the data set with a single value. +Input Parameters +name(string) +The name of the axis. +unit(Unit) +The unit of the axis. +value(Variant) +The value. +Return +DataSetAxis +A new axis containing a single value. +Add (name string, unit Unit, start number, end number, count number) +Adds a new axis to the data set with a range of values. +Input Parameters +name(string) +The name of the axis. +unit(Unit) +The unit of the axis. +start(number) +The first value of the axis. +end(number) +The last value of the axis. +count(number) +The number of points on the axis. +Return +DataSetAxis +A new axis defined over a range of values. +Add (name string, unit Unit, values List of Variant) +Adds a new axis to the data set with a given set of values. +Input Parameters +name(string) +The name of the axis. +unit(Unit) +The unit of the axis. +values(List of Variant) +The values of the axis in a table. +Return +DataSetAxis +The new axis. +Add (axis DataSetAxis) +Adds a copy of the given axis to the data set. +Input Parameters +axis(DataSetAxis) +The axis to add. +Return +DataSetAxis +The new axis. +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the DataSetAxis. +Return +boolean +The success of the check. +Item (index number) +Returns the DataSetAxis at the given index. +Input Parameters +index(number) +The index of the DataSetAxis. +Return +DataSetAxis +The DataSetAxis at the given index. +Item (label string) +Returns the DataSetAxis with the given label. +Input Parameters +label(string) +The label of the DataSetAxis. +Return +DataSetAxis +The DataSetAxis with the given label. +Items () +Returns a table of DataSetAxis. +Return +List of DataSetAxis +A table of DataSetAxis. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for DataSetAxis. +Altair Feko 2022.3 +2 Application Programming Interface (API) +DataSetQuantityCollection +p.4118 +A data set contains a collection of quantities. A handle can be obtained on an individual quantity, or new +quantity can be added to the collection by using the DataSetQuantityCollection. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the far field data set +farFieldDataSet = + app.Models[1].Configurations[1].FarFields["FarFields"]:GetDataSet(51) + -- Print a list of the far field quantities +printlist( farFieldDataSet.Quantities:Items() ) + -- Access information about the "EFieldTheta" quantity +EFieldThetaQuantity = farFieldDataSet.Quantities["EFieldTheta"] +quantityName = EFieldThetaQuantity.Name +quantityType = EFieldThetaQuantity.QuantityType +quantityUnit = EFieldThetaQuantity.Unit + -- Add a new quantity to the collection +farFieldDataSet.Quantities:Add("Threshold", pf.Enums.DataSetQuantityTypeEnum.Scalar, "") + -- Access the 'EFieldTheta' value at the first frequency, theta and phi point +EFieldThetaValue = farFieldDataSet[1][1][1].EFieldTheta + -- Set the value of the new 'Threshold' quantity at the first frequency, theta + and phi point +farFieldDataSet[1][1][1].Threshold = 2 +Usage locations +The DataSetQuantityCollection object can be accessed from the following locations: +• Collection lists +◦ DataSet object has collection Quantities. +Property List +Count +Type +The number of DataSetQuantity items in the collection. (Read only number) +The object type string. (Read only string) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Method List +p.4119 +Add (name string, type DataSetQuantityTypeEnum, unit Unit) +Adds a new quantity to the data set. (Returns a DataSetQuantity object.) +Add (quantity DataSetQuantity) +Adds a copy of the quantity. (Returns a DataSetQuantity object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the DataSetQuantity at the given index. (Returns a DataSetQuantity object.) +Item (label string) +Returns the DataSetQuantity with the given label. (Returns a DataSetQuantity object.) +Items () +Returns a table of DataSetQuantity. (Returns a List of DataSetQuantity object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the DataSetQuantity at the given index in the collection. (Read DataSetQuantity) +[string] +Returns the DataSetQuantity with the given name in the collection. (Read DataSetQuantity) +Property Details +Count +The number of DataSetQuantity items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (name string, type DataSetQuantityTypeEnum, unit Unit) +Adds a new quantity to the data set. +Input Parameters +name(string) +The name of the quantity. +type(DataSetQuantityTypeEnum) +The type of the quantity (e.g. “Complex” or “Scalar”). +unit(Unit) +The SI unit of the quantity. +Return +DataSetQuantity +The new quantity. +Add (quantity DataSetQuantity) +Adds a copy of the quantity. +Input Parameters +quantity(DataSetQuantity) +The quantity to add a copy of. This is used when copying quantities of existing +DataSets. +Return +DataSetQuantity +A replica of the provided quantity. +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the DataSetQuantity. +Return +boolean +The success of the check. +Item (index number) +Returns the DataSetQuantity at the given index. +Input Parameters +index(number) +The index of the DataSetQuantity. +Return +DataSetQuantity +The DataSetQuantity at the given index. +Item (label string) +Returns the DataSetQuantity with the given label. +Input Parameters +label(string) +The label of the DataSetQuantity. +Return +DataSetQuantity +The DataSetQuantity with the given label. +Items () +Returns a table of DataSetQuantity. +Return +List of DataSetQuantity +A table of DataSetQuantity. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for DataSetQuantity. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ErrorEstimateCollection +A collection of error estimates. +Example +p.4122 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Horn_error_estimates.fek]]) +errorEstimatesCollection = app.Models[1].Configurations[1].ErrorEstimates + -- Access the error estimates +errorEstimate1 = errorEstimatesCollection[1] -- Index method +errorEstimate2 = errorEstimatesCollection["ErrorEstimation1"] -- Name method +Usage locations +The ErrorEstimateCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection ErrorEstimates. +Property List +Count +Type +The number of ErrorEstimateData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the ErrorEstimateData at the given index. (Returns a ErrorEstimateData object.) +Item (label string) +Returns the ErrorEstimateData with the given label. (Returns a ErrorEstimateData object.) +Items () +Returns a table of ErrorEstimateData. (Returns a List of ErrorEstimateData object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the ErrorEstimateData at the given index in the collection. (Read ErrorEstimateData) +Altair Feko 2022.3 +2 Application Programming Interface (API) +[string] +p.4123 +Returns the ErrorEstimateData with the given name in the collection. (Read ErrorEstimateData) +Property Details +Count +The number of ErrorEstimateData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the ErrorEstimateData. +Return +boolean +The success of the check. +Item (index number) +Returns the ErrorEstimateData at the given index. +Input Parameters +index(number) +The index of the ErrorEstimateData. +Return +ErrorEstimateData +The ErrorEstimateData at the given index. +Item (label string) +Returns the ErrorEstimateData with the given label. +Input Parameters +label(string) +The label of the ErrorEstimateData. +Return +ErrorEstimateData +The ErrorEstimateData with the given label. +Items () +Returns a table of ErrorEstimateData. +Return +List of ErrorEstimateData +A table of ErrorEstimateData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for ErrorEstimateData. +ExcitationCollection +A collection of excitation results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +excitationCollection = app.Models[1].Configurations[1].Excitations + -- Add the first excitation to a Cartesian graph +graph = app.CartesianGraphs:Add() +excitationTrace1 = graph.Traces:Add(excitationCollection[1]) -- Index method +excitationTrace2 = graph.Traces:Add(excitationCollection["VoltageSource"]) -- Name + method + -- Add all the excitations in the collection to the graph +for index, excitationData in pairs(excitationCollection) do + excitationTrace = graph.Traces:Add(excitationData) +end +Usage locations +The ExcitationCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection Excitations. +Property List +Count +Type +The number of ExcitationData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the ExcitationData at the given index. (Returns a ExcitationData object.) +Item (label string) +Returns the ExcitationData with the given label. (Returns a ExcitationData object.) +Items () +Returns a table of ExcitationData. (Returns a List of ExcitationData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4126 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the ExcitationData at the given index in the collection. (Read ExcitationData) +[string] +Returns the ExcitationData with the given name in the collection. (Read ExcitationData) +Property Details +Count +The number of ExcitationData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the ExcitationData. +Return +boolean +The success of the check. +Item (index number) +Returns the ExcitationData at the given index. +Input Parameters +index(number) +The index of the ExcitationData. +Return +ExcitationData +The ExcitationData at the given index. +Item (label string) +Returns the ExcitationData with the given label. +Input Parameters +label(string) +The label of the ExcitationData. +Return +ExcitationData +The ExcitationData with the given label. +Items () +Returns a table of ExcitationData. +Return +List of ExcitationData +A table of ExcitationData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for ExcitationData. +FarFieldCollection +A collection of far field results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farFieldCollection = app.Models[1].Configurations[1].FarFields + -- Add the first far field to a Cartesian graph +graph = app.CartesianGraphs:Add() +farFieldTrace1 = graph.Traces:Add(farFieldCollection[1]) -- Index method +farFieldTrace2 = graph.Traces:Add(farFieldCollection["FarFields"]) -- Name method + -- Add all the far fields in the collection to the 3D view +for index, farFieldData in pairs(farFieldCollection) do + farFieldPlot = app.Views[1].Plots:Add(farFieldData) +end +Usage locations +The FarFieldCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection FarFields. +Property List +Count +Type +The number of FarFieldData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the FarFieldData at the given index. (Returns a FarFieldData object.) +Item (label string) +Returns the FarFieldData with the given label. (Returns a FarFieldData object.) +Items () +Returns a table of FarFieldData. (Returns a List of FarFieldData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4129 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the FarFieldData at the given index in the collection. (Read FarFieldData) +[string] +Returns the FarFieldData with the given name in the collection. (Read FarFieldData) +Property Details +Count +The number of FarFieldData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the FarFieldData. +Return +boolean +The success of the check. +Item (index number) +Returns the FarFieldData at the given index. +Input Parameters +index(number) +The index of the FarFieldData. +Return +FarFieldData +The FarFieldData at the given index. +Item (label string) +Returns the FarFieldData with the given label. +Input Parameters +label(string) +The label of the FarFieldData. +Return +FarFieldData +The FarFieldData with the given label. +Items () +Returns a table of FarFieldData. +Return +List of FarFieldData +A table of FarFieldData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for FarFieldData. +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldPowerIntegralCollection +A collection of far field power integral results. +Example +p.4131 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +farFieldPowerCollection = app.Models[1].Configurations[1].FarFieldPowerIntegrals + -- Add the first far field power to a Cartesian graph +graph = app.CartesianGraphs:Add() +farFieldTrace1 = graph.Traces:Add(farFieldPowerCollection[1]) -- Index method +farFieldTrace2 = graph.Traces:Add(farFieldPowerCollection["FarFields"]) -- Name + method + -- Add all the far fields in the collection to the Cartesian graph +for index, farFieldData in pairs(farFieldPowerCollection) do + farFieldTrace = graph.Traces:Add(farFieldData) +end +Usage locations +The FarFieldPowerIntegralCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection FarFieldPowerIntegrals. +Property List +Count +Type +The number of FarFieldPowerIntegralData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the FarFieldPowerIntegralData at the given index. (Returns a FarFieldPowerIntegralData +object.) +Item (label string) +Returns the FarFieldPowerIntegralData with the given label. (Returns a FarFieldPowerIntegralData +object.) +Items () +Returns a table of FarFieldPowerIntegralData. (Returns a List of FarFieldPowerIntegralData +object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4132 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the FarFieldPowerIntegralData at the given index in the collection. (Read +FarFieldPowerIntegralData) +[string] +Returns the FarFieldPowerIntegralData with the given name in the collection. (Read +FarFieldPowerIntegralData) +Property Details +Count +The number of FarFieldPowerIntegralData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the FarFieldPowerIntegralData. +Return +boolean +The success of the check. +Item (index number) +Returns the FarFieldPowerIntegralData at the given index. +Input Parameters +index(number) +The index of the FarFieldPowerIntegralData. +Return +FarFieldPowerIntegralData +The FarFieldPowerIntegralData at the given index. +Item (label string) +Returns the FarFieldPowerIntegralData with the given label. +Input Parameters +label(string) +The label of the FarFieldPowerIntegralData. +Return +FarFieldPowerIntegralData +The FarFieldPowerIntegralData with the given label. +Items () +Returns a table of FarFieldPowerIntegralData. +Return +List of FarFieldPowerIntegralData +A table of FarFieldPowerIntegralData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for FarFieldPowerIntegralData. +FormGroupBoxItemCollection +A collection of all of the items contained in a form group box. +Example +form = pf.Form.New() +group = pf.FormGroupBox.New("Items") +item1 = pf.FormLabel.New("Item 1") +item2 = pf.FormLabel.New("Item 2") + -- Assemble the form objects into a layout +group:Add(item1); +group:Add(item2) +form:Add(group); + -- Modify items using the collection +group.FormItems["Item 1"].Visible = false +form:Run() +Usage locations +The FormGroupBoxItemCollection object can be accessed from the following locations: +• Collection lists +◦ FormGroupBox object has collection FormItems. +Property List +Count +Type +The number of FormItem items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the FormItem at the given index. (Returns a FormItem object.) +Item (label string) +Returns the FormItem with the given label. (Returns a FormItem object.) +Items () +Returns a table of FormItem. (Returns a List of FormItem object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the FormItem at the given index in the collection. (Read FormItem) +[string] +Returns the FormItem with the given name in the collection. (Read FormItem) +Property Details +Count +The number of FormItem items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +boolean +The success of the check. +Item (index number) +Returns the FormItem at the given index. +Input Parameters +index(number) +The index of the FormItem. +Return +FormItem +The FormItem at the given index. +Item (label string) +Returns the FormItem with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +FormItem +The FormItem with the given label. +Items () +Returns a table of FormItem. +Return +List of FormItem +A table of FormItem. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for FormItem. +FormItemCollection +A collection of all of the items contained in a form. +Example +form = pf.Form.New() + -- Create a variety of form items +checkbox = pf.FormCheckBox.New("Export electric near fields.") +label = pf.FormLabel.New("Item 1") +dirBrowser = pf.FormDirectoryBrowser.New("Output directory:") +form:Add(checkbox) +form:Add(label) +form:Add(dirBrowser) + -- All form items share the Enabled and Visible properties +for i = 1,#form.FormItems do + form.FormItems[i].Enabled = false +end +form:Run() +Usage locations +The FormItemCollection object can be accessed from the following locations: +• Collection lists +◦ Form object has collection FormItems. +Property List +Count +Type +The number of FormItem items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the FormItem at the given index. (Returns a FormItem object.) +Item (label string) +Returns the FormItem with the given label. (Returns a FormItem object.) +Items () +Returns a table of FormItem. (Returns a List of FormItem object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4138 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the FormItem at the given index in the collection. (Read FormItem) +[string] +Returns the FormItem with the given name in the collection. (Read FormItem) +Property Details +Count +The number of FormItem items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +boolean +The success of the check. +Item (index number) +Returns the FormItem at the given index. +Input Parameters +index(number) +The index of the FormItem. +Return +FormItem +The FormItem at the given index. +Item (label string) +Returns the FormItem with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +FormItem +The FormItem with the given label. +Items () +Returns a table of FormItem. +Return +List of FormItem +A table of FormItem. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for FormItem. +FormLayoutItemCollection +A collection of all of the items contained in a form layout. +Example +app = pf.GetApplication() +project = app:NewProject() +form = pf.Form.New() + -- Create a few form items +label = pf.FormLabel.New("Specify a frequency:") +lineEdit = pf.FormLineEdit.New("Frequency") + -- Create a layout item +formLayout = pf.FormLayout.New(pf.Enums.FormLayoutEnum.Vertical) + -- Add items to the layout +formLayout:Add(label) +formLayout:Add(lineEdit) + -- Add layout item to the form +form:Add(formLayout) + -- Obtain a handle to the 'FormLayoutItemCollection' +formLayoutItemCollection = form.FormItems[1].FormItems + -- Iterate through the layout collection and disable the items. +for index in ipairs(formLayoutItemCollection) do + formLayoutItemCollection[index].Enabled = false +end +form:Run() +Usage locations +The FormLayoutItemCollection object can be accessed from the following locations: +• Collection lists +◦ FormLayout object has collection FormItems. +Property List +Count +Type +The number of FormItem items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the FormItem at the given index. (Returns a FormItem object.) +Item (label string) +Returns the FormItem with the given label. (Returns a FormItem object.) +Items () +Returns a table of FormItem. (Returns a List of FormItem object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the FormItem at the given index in the collection. (Read FormItem) +[string] +Returns the FormItem with the given name in the collection. (Read FormItem) +Property Details +Count +The number of FormItem items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +boolean +The success of the check. +Item (index number) +Returns the FormItem at the given index. +Input Parameters +index(number) +The index of the FormItem. +Return +FormItem +The FormItem at the given index. +Item (label string) +Returns the FormItem with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +FormItem +The FormItem with the given label. +Items () +Returns a table of FormItem. +Return +List of FormItem +A table of FormItem. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for FormItem. +FormScrollAreaItemCollection +A collection of all of the items contained in a form scroll area. +Example +form = pf.Form.New() + -- Create a scroll area form item +formScrollArea = pf.FormScrollArea.New() + -- Create a few form items +formScrollArea:Add(pf.FormLabel.New("A lot of text.")) +formScrollArea:Add(pf.FormLabel.New("even more text")) +formScrollArea:Add(pf.FormLabel.New("... more text")) +formScrollArea:Add(pf.FormLabel.New("... more text")) +formScrollArea:Add(pf.FormLabel.New("... more text")) +formScrollArea:Add(pf.FormLabel.New("lost more text")) + -- Obtain a handle to the 'FormScrollAreaItemCollection' +formScrollAreaItemCollection = formScrollArea.FormItems + -- Iterate through all the objects in the scroll area and disable them. +for index in ipairs(formScrollAreaItemCollection) do + formScrollAreaItemCollection[index].Enabled = false +end + -- Add the scroll area to the form +form:Add(formScrollArea) + -- Show and run the form +form:Run() +Usage locations +The FormScrollAreaItemCollection object can be accessed from the following locations: +• Collection lists +◦ FormScrollArea object has collection FormItems. +Property List +Count +Type +The number of FormItem items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the FormItem at the given index. (Returns a FormItem object.) +Item (label string) +Returns the FormItem with the given label. (Returns a FormItem object.) +Items () +Returns a table of FormItem. (Returns a List of FormItem object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the FormItem at the given index in the collection. (Read FormItem) +[string] +Returns the FormItem with the given name in the collection. (Read FormItem) +Property Details +Count +The number of FormItem items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +boolean +The success of the check. +Item (index number) +Returns the FormItem at the given index. +Input Parameters +index(number) +The index of the FormItem. +Return +FormItem +The FormItem at the given index. +Item (label string) +Returns the FormItem with the given label. +Input Parameters +label(string) +The label of the FormItem. +Return +FormItem +The FormItem with the given label. +Items () +Returns a table of FormItem. +Return +List of FormItem +A table of FormItem. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for FormItem. +ImportedDataCollection +A collection of imported data. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianGraphs:Add() +app:ImportResults(FEKO_HOME..[[/shared/Resources/Automation/SParameters.s2p]], + pf.Enums.ImportFileTypeEnum.Touchstone) + -- Retrieve the newly imported data collection from the first import set +importedDataCollection = app.ImportedDataSets[1].ImportedData + -- Retrieve the label of the first imported data in the collection +label = importedDataCollection[1].Label + -- Add the first imported data in the collection to the cartesian graph +graph.Traces:Add(importedDataCollection[1]) +Usage locations +The ImportedDataCollection object can be accessed from the following locations: +• Collection lists +◦ +ImportSet object has collection ImportedData. +Property List +Count +Type +The number of ResultData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the ResultData at the given index. (Returns a ResultData object.) +Item (label string) +Returns the ResultData with the given label. (Returns a ResultData object.) +Items () +Returns a table of ResultData. (Returns a List of ResultData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4148 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the ResultData at the given index in the collection. (Read ResultData) +[string] +Returns the ResultData with the given name in the collection. (Read ResultData) +Property Details +Count +The number of ResultData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the ResultData. +Return +boolean +The success of the check. +Item (index number) +Returns the ResultData at the given index. +Input Parameters +index(number) +The index of the ResultData. +Return +ResultData +The ResultData at the given index. +Item (label string) +Returns the ResultData with the given label. +Input Parameters +label(string) +The label of the ResultData. +Return +ResultData +The ResultData with the given label. +Items () +Returns a table of ResultData. +Return +List of ResultData +A table of ResultData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for ResultData. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ImportedDataSetCollection +A collection of imported data sets. +Example +app = pf.GetApplication() +app:NewProject() +graph = app.CartesianGraphs:Add() +p.4150 +app:ImportResults(FEKO_HOME..[[/shared/Resources/Automation/SParameters.s2p]], + pf.Enums.ImportFileTypeEnum.Touchstone) + -- Retrieve the newly imported import set from the import set collection +importSetCollection = app.ImportedDataSets +numberOfImportSets = importSetCollection.Count + -- Retrieve the label and source file of the first import set +label = importSetCollection[1].Label +sourceFile = importSetCollection[1].SourceFile + -- Duplicate the newly imported import set and then delete the original +importSetCopy = importSetCollection[1]:Duplicate() +importSetCollection[1]:Delete() + -- Add the first imported data in the copied import set to the cartesian graph +graph.Traces:Add(importSetCopy.ImportedData[1]) +Usage locations +The ImportedDataSetCollection object can be accessed from the following locations: +• Collection lists +◦ Application object has collection ImportedDataSets. +Property List +Count +Type +The number of ImportSet items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the ImportSet at the given index. (Returns a ImportSet object.) +Item (label string) +Returns the ImportSet with the given label. (Returns a ImportSet object.) +Items () +Returns a table of ImportSet. (Returns a List of ImportSet object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the ImportSet at the given index in the collection. (Read ImportSet) +[string] +Returns the ImportSet with the given name in the collection. (Read ImportSet) +Property Details +Count +The number of ImportSet items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the ImportSet. +Return +boolean +The success of the check. +Item (index number) +Returns the ImportSet at the given index. +Input Parameters +index(number) +The index of the ImportSet. +Return +ImportSet +The ImportSet at the given index. +Item (label string) +Returns the ImportSet with the given label. +Input Parameters +label(string) +The label of the ImportSet. +Return +ImportSet +The ImportSet with the given label. +Items () +Returns a table of ImportSet. +Return +List of ImportSet +A table of ImportSet. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for ImportSet. +LoadCollection +A collection of load results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) +loadCollection = app.Models[1].Configurations[1].Loads + -- Add the first load to a Cartesian graph +graph = app.CartesianGraphs:Add() +loadTrace1 = graph.Traces:Add(loadCollection[1]) -- Index method +loadTrace2 = graph.Traces:Add(loadCollection["ComplexLoad"]) -- Name method + -- Add all the loads in the collection to the graph +for index, loadData in pairs(loadCollection) do + loadTrace = graph.Traces:Add(loadData) +end +Usage locations +The LoadCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection Loads. +Property List +Count +Type +The number of LoadData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the LoadData at the given index. (Returns a LoadData object.) +Item (label string) +Returns the LoadData with the given label. (Returns a LoadData object.) +Items () +Returns a table of LoadData. (Returns a List of LoadData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4154 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the LoadData at the given index in the collection. (Read LoadData) +[string] +Returns the LoadData with the given name in the collection. (Read LoadData) +Property Details +Count +The number of LoadData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the LoadData. +Return +boolean +The success of the check. +Item (index number) +Returns the LoadData at the given index. +Input Parameters +index(number) +The index of the LoadData. +Return +LoadData +The LoadData at the given index. +Item (label string) +Returns the LoadData with the given label. +Input Parameters +label(string) +The label of the LoadData. +Return +LoadData +The LoadData with the given label. +Items () +Returns a table of LoadData. +Return +List of LoadData +A table of LoadData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for LoadData. +MathScriptCollection +A collection of math scripts. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/CustomDataSession.pfs]]) + -- Add the first math script to a Cartesian graph +graph = app.CartesianGraphs:Add() +mathScriptTrace1 = graph.Traces:Add(app.MathScripts[1]) -- Index method +mathScriptTrace2 = graph.Traces:Add(app.MathScripts["CustomMath1"]) -- Name method + -- Add all the far fields in the collection to the 3D view +for index, mathScriptData in pairs(app.MathScripts) do + mathScriptPlot = app.Views[1].Plots:Add(mathScriptData) +end +Usage locations +The MathScriptCollection object can be accessed from the following locations: +• Collection lists +◦ Application object has collection MathScripts. +Property List +Count +Type +The number of MathScript items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Add (type MathScriptTypeEnum) +Adds a new math script to the collection. (Returns a MathScript object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the MathScript at the given index. (Returns a MathScript object.) +Item (label string) +Returns the MathScript with the given label. (Returns a MathScript object.) +Items () +Returns a table of MathScript. (Returns a List of MathScript object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4157 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the MathScript at the given index in the collection. (Read MathScript) +[string] +Returns the MathScript with the given name in the collection. (Read MathScript) +Property Details +Count +The number of MathScript items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (type MathScriptTypeEnum) +Adds a new math script to the collection. +Input Parameters +type(MathScriptTypeEnum) +The type of math script specified by MathScriptTypeEnum, e.g. FarField, NearField, +Custom, etc. +Return +MathScript +The new math script. +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the MathScript. +Return +boolean +The success of the check. +Item (index number) +Returns the MathScript at the given index. +Input Parameters +index(number) +The index of the MathScript. +Return +MathScript +The MathScript at the given index. +Item (label string) +Returns the MathScript with the given label. +Input Parameters +label(string) +The label of the MathScript. +Return +MathScript +The MathScript with the given label. +Items () +Returns a table of MathScript. +Return +List of MathScript +A table of MathScript. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for MathScript. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshCubeRegionCollection +A collection of regions meshed with cubes. +Example +p.4160 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cube_example1.fek]]) +sConf = app.Models["Cube_example1"].Configurations[1] +mesh = sConf.Mesh + -- Get a 'MeshCubeRegionCollection' of a specified mesh entity +meshCubeRegion = mesh.CubeRegions + -- Get the 'Cubes' contained in a 'MeshCubeRegion' and the number of + 'MeshCubeRegion' + -- items contained the 'MeshCubeRegionCollection'. +cubes = meshCubeRegion[1].Cubes +count = meshCubeRegion.Count +Usage locations +The MeshCubeRegionCollection object can be accessed from the following locations: +• Collection lists +◦ Mesh object has collection CubeRegions. +Property List +Count +Type +The number of MeshCubeRegion items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the MeshCubeRegion at the given index. (Returns a MeshCubeRegion object.) +Item (label string) +Returns the MeshCubeRegion with the given label. (Returns a MeshCubeRegion object.) +Items () +Returns a table of MeshCubeRegion. (Returns a List of MeshCubeRegion object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the MeshCubeRegion at the given index in the collection. (Read MeshCubeRegion) +[string] +Returns the MeshCubeRegion with the given name in the collection. (Read MeshCubeRegion) +Property Details +Count +The number of MeshCubeRegion items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the MeshCubeRegion. +Return +boolean +The success of the check. +Item (index number) +Returns the MeshCubeRegion at the given index. +Input Parameters +index(number) +The index of the MeshCubeRegion. +Return +MeshCubeRegion +The MeshCubeRegion at the given index. +Item (label string) +Returns the MeshCubeRegion with the given label. +Input Parameters +label(string) +The label of the MeshCubeRegion. +Return +MeshCubeRegion +The MeshCubeRegion with the given label. +Items () +Returns a table of MeshCubeRegion. +Return +List of MeshCubeRegion +A table of MeshCubeRegion. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for MeshCubeRegion. +MeshCurvilinearSegmentWireCollection +A collection of wires meshed with curvilinear segments. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Helix_dipole.fek]]) +sConf = app.Models["Helix_dipole"].Configurations[1] +mesh = sConf.Mesh + -- Get the collection of 'MeshCurvilinearWire's +meshCurvilinearWireSegments = mesh.CurvilinearSegmentWires + -- Query the number of items in the collection +numberOfWireSegments = #meshCurvilinearWireSegments +Usage locations +The MeshCurvilinearSegmentWireCollection object can be accessed from the following locations: +• Collection lists +◦ Mesh object has collection CurvilinearSegmentWires. +Property List +Count +Type +The number of MeshCurvilinearSegmentWire items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the MeshCurvilinearSegmentWire at the given index. (Returns a +MeshCurvilinearSegmentWire object.) +Item (label string) +Returns the MeshCurvilinearSegmentWire with the given label. (Returns a +MeshCurvilinearSegmentWire object.) +Items () +Returns a table of MeshCurvilinearSegmentWire. (Returns a List of MeshCurvilinearSegmentWire +object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4164 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the MeshCurvilinearSegmentWire at the given index in the collection. (Read +MeshCurvilinearSegmentWire) +[string] +Returns the MeshCurvilinearSegmentWire with the given name in the collection. (Read +MeshCurvilinearSegmentWire) +Property Details +Count +The number of MeshCurvilinearSegmentWire items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the MeshCurvilinearSegmentWire. +Return +boolean +The success of the check. +Item (index number) +Returns the MeshCurvilinearSegmentWire at the given index. +Input Parameters +index(number) +The index of the MeshCurvilinearSegmentWire. +Return +MeshCurvilinearSegmentWire +The MeshCurvilinearSegmentWire at the given index. +Item (label string) +Returns the MeshCurvilinearSegmentWire with the given label. +Input Parameters +label(string) +The label of the MeshCurvilinearSegmentWire. +Return +MeshCurvilinearSegmentWire +The MeshCurvilinearSegmentWire with the given label. +Items () +Returns a table of MeshCurvilinearSegmentWire. +Return +List of MeshCurvilinearSegmentWire +A table of MeshCurvilinearSegmentWire. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for MeshCurvilinearSegmentWire. +MeshCurvilinearTriangleFaceCollection +A collection of faces meshed with curvilinear triangles. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME.."/shared/Resources/Automation/ +RCS_of_a_Curvilinear_Dielectric_Sphere.fek") +sConf = app.Models["RCS_of_a_Curvilinear_Dielectric_Sphere"].Configurations[1] +mesh = sConf.Mesh + -- Get 'MeshCurvilinearTriangleFaceCollection' of the specified mesh entity + -- and the number of curvilinear faces in the collection +curvilinearTriangleFaceCollection = mesh.CurvilinearTriangleFaces +count = #curvilinearTriangleFaceCollection + -- Get the number of curvilinear triangles of the specified mesh entity +count = curvilinearTriangleFaceCollection[1].CurvilinearTriangles.Count +Usage locations +The MeshCurvilinearTriangleFaceCollection object can be accessed from the following locations: +• Collection lists +◦ Mesh object has collection CurvilinearTriangleFaces. +Property List +Count +Type +The number of MeshCurvilinearTriangleFace items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the MeshCurvilinearTriangleFace at the given index. (Returns a +MeshCurvilinearTriangleFace object.) +Item (label string) +Returns the MeshCurvilinearTriangleFace with the given label. (Returns a +MeshCurvilinearTriangleFace object.) +Items () +Returns a table of MeshCurvilinearTriangleFace. (Returns a List of MeshCurvilinearTriangleFace +object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4167 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the MeshCurvilinearTriangleFace at the given index in the collection. (Read +MeshCurvilinearTriangleFace) +[string] +Returns the MeshCurvilinearTriangleFace with the given name in the collection. (Read +MeshCurvilinearTriangleFace) +Property Details +Count +The number of MeshCurvilinearTriangleFace items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the MeshCurvilinearTriangleFace. +Return +boolean +The success of the check. +Item (index number) +Returns the MeshCurvilinearTriangleFace at the given index. +Input Parameters +index(number) +The index of the MeshCurvilinearTriangleFace. +Return +MeshCurvilinearTriangleFace +The MeshCurvilinearTriangleFace at the given index. +Item (label string) +Returns the MeshCurvilinearTriangleFace with the given label. +Input Parameters +label(string) +The label of the MeshCurvilinearTriangleFace. +Return +MeshCurvilinearTriangleFace +The MeshCurvilinearTriangleFace with the given label. +Items () +Returns a table of MeshCurvilinearTriangleFace. +Return +List of MeshCurvilinearTriangleFace +A table of MeshCurvilinearTriangleFace. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for MeshCurvilinearTriangleFace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshSegmentWireCollection +A collection of wires meshed with segments. +Example +p.4169 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) +sConf = app.Models["Dipole_Example"].Configurations[1] +mesh = sConf.Mesh + -- Get the label of the specified mesh entity +label = mesh.SegmentWires[1].Label + -- Get the number of SegmentWires in 'SegmentWires' Collection +MoMWireCount = #mesh.SegmentWires +Usage locations +The MeshSegmentWireCollection object can be accessed from the following locations: +• Collection lists +◦ Mesh object has collection SegmentWires. +Property List +Count +Type +The number of MeshSegmentWire items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the MeshSegmentWire at the given index. (Returns a MeshSegmentWire object.) +Item (label string) +Returns the MeshSegmentWire with the given label. (Returns a MeshSegmentWire object.) +Items () +Returns a table of MeshSegmentWire. (Returns a List of MeshSegmentWire object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the MeshSegmentWire at the given index in the collection. (Read MeshSegmentWire) +[string] +Returns the MeshSegmentWire with the given name in the collection. (Read MeshSegmentWire) +Property Details +Count +The number of MeshSegmentWire items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the MeshSegmentWire. +Return +boolean +The success of the check. +Item (index number) +Returns the MeshSegmentWire at the given index. +Input Parameters +index(number) +The index of the MeshSegmentWire. +Return +MeshSegmentWire +The MeshSegmentWire at the given index. +Item (label string) +Returns the MeshSegmentWire with the given label. +Input Parameters +label(string) +The label of the MeshSegmentWire. +Return +MeshSegmentWire +The MeshSegmentWire with the given label. +Items () +Returns a table of MeshSegmentWire. +Return +List of MeshSegmentWire +A table of MeshSegmentWire. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for MeshSegmentWire. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshTetrahedronRegionCollection +A collection of regions meshed with tetrahedra. +Example +p.4172 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME.. + [[/shared/Resources/Automation/ +Shielding_Factor_of_Thin_Metal_Sphere_FEM.fek]]) +sConf = app.Models["Shielding_Factor_of_Thin_Metal_Sphere_FEM"].Configurations[1] +mesh = sConf.Mesh + -- Get the 'MeshTetrahedronRegionCollection' of the specified mesh entity and + -- the number of items in the collection +meshTetrahedronRegionCollection = mesh.TetrahedronRegions +count = meshTetrahedronRegionCollection.Count + -- Get the label of first tetrahedra region +label = meshTetrahedronRegionCollection[1].Label +Usage locations +The MeshTetrahedronRegionCollection object can be accessed from the following locations: +• Collection lists +◦ Mesh object has collection TetrahedronRegions. +Property List +Count +Type +The number of MeshTetrahedronRegion items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the MeshTetrahedronRegion at the given index. (Returns a MeshTetrahedronRegion +object.) +Item (label string) +Returns the MeshTetrahedronRegion with the given label. (Returns a MeshTetrahedronRegion +object.) +Items () +Returns a table of MeshTetrahedronRegion. (Returns a List of MeshTetrahedronRegion object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4173 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the MeshTetrahedronRegion at the given index in the collection. (Read +MeshTetrahedronRegion) +[string] +Returns the MeshTetrahedronRegion with the given name in the collection. (Read +MeshTetrahedronRegion) +Property Details +Count +The number of MeshTetrahedronRegion items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the MeshTetrahedronRegion. +Return +boolean +The success of the check. +Item (index number) +Returns the MeshTetrahedronRegion at the given index. +Input Parameters +index(number) +The index of the MeshTetrahedronRegion. +Return +MeshTetrahedronRegion +The MeshTetrahedronRegion at the given index. +Item (label string) +Returns the MeshTetrahedronRegion with the given label. +Input Parameters +label(string) +The label of the MeshTetrahedronRegion. +Return +MeshTetrahedronRegion +The MeshTetrahedronRegion with the given label. +Items () +Returns a table of MeshTetrahedronRegion. +Return +List of MeshTetrahedronRegion +A table of MeshTetrahedronRegion. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for MeshTetrahedronRegion. +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshTriangleFaceCollection +A collection of faces meshed with triangles. +Example +p.4175 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +sConf = app.Models["startup"].Configurations[1] +mesh = sConf.Mesh + -- Get the number of triangle faces in 'MeshTriangleFaceCollection' +count = mesh.TriangleFaces.Count + -- Get the label of the specified mesh entity +label = mesh.TriangleFaces[1].Label +Usage locations +The MeshTriangleFaceCollection object can be accessed from the following locations: +• Collection lists +◦ Mesh object has collection TriangleFaces. +Property List +Count +Type +The number of MeshTriangleFace items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the MeshTriangleFace at the given index. (Returns a MeshTriangleFace object.) +Item (label string) +Returns the MeshTriangleFace with the given label. (Returns a MeshTriangleFace object.) +Items () +Returns a table of MeshTriangleFace. (Returns a List of MeshTriangleFace object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the MeshTriangleFace at the given index in the collection. (Read MeshTriangleFace) +[string] +Returns the MeshTriangleFace with the given name in the collection. (Read MeshTriangleFace) +Property Details +Count +The number of MeshTriangleFace items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the MeshTriangleFace. +Return +boolean +The success of the check. +Item (index number) +Returns the MeshTriangleFace at the given index. +Input Parameters +index(number) +The index of the MeshTriangleFace. +Return +MeshTriangleFace +The MeshTriangleFace at the given index. +Item (label string) +Returns the MeshTriangleFace with the given label. +Input Parameters +label(string) +The label of the MeshTriangleFace. +Return +MeshTriangleFace +The MeshTriangleFace with the given label. +Items () +Returns a table of MeshTriangleFace. +Return +List of MeshTriangleFace +A table of MeshTriangleFace. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for MeshTriangleFace. +MeshUnmeshedCylinderRegionCollection +A collection of unmeshed cylinders that are part of a mesh model. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Infinite_Cylinder_a.fek]]) +sConf = app.Models["Infinite_Cylinder_a"].Configurations[1] +mesh = sConf.Mesh + -- Get the 'MeshUnmeshedCylinderRegionCollection' for the specified mesh +MeshUnmeshedCylinderRegionCollection = mesh.UnmeshedCylinderRegions + -- Get the unmeshed cylinder region count of the specified mesh entity and + -- the label of the first unmeshed cylinder region +count = #MeshUnmeshedCylinderRegionCollection +label = MeshUnmeshedCylinderRegionCollection[1].Label +Usage locations +The MeshUnmeshedCylinderRegionCollection object can be accessed from the following locations: +• Collection lists +◦ Mesh object has collection UnmeshedCylinderRegions. +Property List +Count +Type +The number of MeshUnmeshedCylinderRegion items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the MeshUnmeshedCylinderRegion at the given index. (Returns a +MeshUnmeshedCylinderRegion object.) +Item (label string) +Returns the MeshUnmeshedCylinderRegion with the given label. (Returns a +MeshUnmeshedCylinderRegion object.) +Items () +Returns a table of MeshUnmeshedCylinderRegion. (Returns a List of +MeshUnmeshedCylinderRegion object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4179 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the MeshUnmeshedCylinderRegion at the given index in the collection. (Read +MeshUnmeshedCylinderRegion) +[string] +Returns the MeshUnmeshedCylinderRegion with the given name in the collection. (Read +MeshUnmeshedCylinderRegion) +Property Details +Count +The number of MeshUnmeshedCylinderRegion items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the MeshUnmeshedCylinderRegion. +Return +boolean +The success of the check. +Item (index number) +Returns the MeshUnmeshedCylinderRegion at the given index. +Input Parameters +index(number) +The index of the MeshUnmeshedCylinderRegion. +Return +MeshUnmeshedCylinderRegion +The MeshUnmeshedCylinderRegion at the given index. +Item (label string) +Returns the MeshUnmeshedCylinderRegion with the given label. +Input Parameters +label(string) +The label of the MeshUnmeshedCylinderRegion. +Return +MeshUnmeshedCylinderRegion +The MeshUnmeshedCylinderRegion with the given label. +Items () +Returns a table of MeshUnmeshedCylinderRegion. +Return +List of MeshUnmeshedCylinderRegion +A table of MeshUnmeshedCylinderRegion. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for MeshUnmeshedCylinderRegion. +MeshUnmeshedPolygonFaceCollection +A collection of unmeshed faces that are part of a mesh model. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Antenna_and_UTD_Plate.fek]]) +sConf = app.Models["Dipole_Antenna_and_UTD_Plate"].Configurations[1] +mesh = sConf.Mesh + -- Get the 'UnmeshedPolygonFaces' for the specified mesh +unmeshedPolygonFaces = mesh.UnmeshedPolygonFaces + -- Get the unmeshed polygon face count of the specified mesh entity and + -- the label of the first 'MeshUnmeshedPolygonFace' +UTDFaceCount = #unmeshedPolygonFaces +label = unmeshedPolygonFaces[1].Label +Usage locations +The MeshUnmeshedPolygonFaceCollection object can be accessed from the following locations: +• Collection lists +◦ Mesh object has collection UnmeshedPolygonFaces. +Property List +Count +Type +The number of MeshUnmeshedPolygonFace items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the MeshUnmeshedPolygonFace at the given index. (Returns a +MeshUnmeshedPolygonFace object.) +Item (label string) +Returns the MeshUnmeshedPolygonFace with the given label. (Returns a +MeshUnmeshedPolygonFace object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Items () +p.4182 +Returns a table of MeshUnmeshedPolygonFace. (Returns a List of MeshUnmeshedPolygonFace +object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the MeshUnmeshedPolygonFace at the given index in the collection. (Read +MeshUnmeshedPolygonFace) +[string] +Returns the MeshUnmeshedPolygonFace with the given name in the collection. (Read +MeshUnmeshedPolygonFace) +Property Details +Count +The number of MeshUnmeshedPolygonFace items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the MeshUnmeshedPolygonFace. +Return +boolean +The success of the check. +Item (index number) +Returns the MeshUnmeshedPolygonFace at the given index. +Input Parameters +index(number) +The index of the MeshUnmeshedPolygonFace. +Return +MeshUnmeshedPolygonFace +The MeshUnmeshedPolygonFace at the given index. +Item (label string) +Returns the MeshUnmeshedPolygonFace with the given label. +Input Parameters +label(string) +The label of the MeshUnmeshedPolygonFace. +Return +MeshUnmeshedPolygonFace +The MeshUnmeshedPolygonFace with the given label. +Items () +Returns a table of MeshUnmeshedPolygonFace. +Return +List of MeshUnmeshedPolygonFace +A table of MeshUnmeshedPolygonFace. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for MeshUnmeshedPolygonFace. +ModelCollection +A collection of Feko models. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Get the model count and access the 'Model' +modelCount = #app.Models +startupModel = app.Models["startup"] +Usage locations +The ModelCollection object can be accessed from the following locations: +• Collection lists +◦ Application object has collection Models. +Property List +Count +Type +The number of Model items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the Model at the given index. (Returns a Model object.) +Item (label string) +Returns the Model with the given label. (Returns a Model object.) +Items () +Returns a table of Model. (Returns a List of Model object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the Model at the given index in the collection. (Read Model) +[string] +Returns the Model with the given name in the collection. (Read Model) +Property Details +Count +The number of Model items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the Model. +Return +boolean +The success of the check. +Item (index number) +Returns the Model at the given index. +Input Parameters +index(number) +The index of the Model. +Return +Model +The Model at the given index. +Item (label string) +Returns the Model with the given label. +Input Parameters +label(string) +The label of the Model. +Return +Model +The Model with the given label. +Items () +Returns a table of Model. +Return +List of Model +A table of Model. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for Model. +NearFieldCollection +A collection of near field results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +nearFieldCollection = app.Models[1].Configurations[1].NearFields + -- Add the first near field to a Cartesian graph +graph = app.CartesianGraphs:Add() +nearFieldTrace1 = graph.Traces:Add(nearFieldCollection[1]) -- Index method +nearFieldTrace2 = graph.Traces:Add(nearFieldCollection["NearFields"]) -- Name method + -- Add all the near fields in the collection to the 3D view +for index, nearFieldData in pairs(nearFieldCollection) do + nearFieldPlot = app.Views[1].Plots:Add(nearFieldData) +end +Usage locations +The NearFieldCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection NearFields. +Property List +Count +Type +The number of NearFieldData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the NearFieldData at the given index. (Returns a NearFieldData object.) +Item (label string) +Returns the NearFieldData with the given label. (Returns a NearFieldData object.) +Items () +Returns a table of NearFieldData. (Returns a List of NearFieldData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4188 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the NearFieldData at the given index in the collection. (Read NearFieldData) +[string] +Returns the NearFieldData with the given name in the collection. (Read NearFieldData) +Property Details +Count +The number of NearFieldData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the NearFieldData. +Return +boolean +The success of the check. +Item (index number) +Returns the NearFieldData at the given index. +Input Parameters +index(number) +The index of the NearFieldData. +Return +NearFieldData +The NearFieldData at the given index. +Item (label string) +Returns the NearFieldData with the given label. +Input Parameters +label(string) +The label of the NearFieldData. +Return +NearFieldData +The NearFieldData with the given label. +Items () +Returns a table of NearFieldData. +Return +List of NearFieldData +A table of NearFieldData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for NearFieldData. +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldPowerIntegralCollection +A collection of near field power integral results. +Example +p.4190 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) + -- Get the near field power integral collection +nearFieldPowerIntegralCollection = + app.Models[1].Configurations[1].NearFieldPowerIntegrals + -- Add items from the collection to a graph +graph = app.CartesianGraphs:Add() +nearFieldPower1 = graph.Traces:Add(nearFieldPowerIntegralCollection[1]) -- Index + method +nearFieldPower2 = graph.Traces:Add(nearFieldPowerIntegralCollection["NearFields"]) -- + Name method +Usage locations +The NearFieldPowerIntegralCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection NearFieldPowerIntegrals. +Property List +Count +Type +The number of NearFieldPowerIntegralData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the NearFieldPowerIntegralData at the given index. (Returns a +NearFieldPowerIntegralData object.) +Item (label string) +Returns the NearFieldPowerIntegralData with the given label. (Returns a +NearFieldPowerIntegralData object.) +Items () +Returns a table of NearFieldPowerIntegralData. (Returns a List of NearFieldPowerIntegralData +object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4191 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the NearFieldPowerIntegralData at the given index in the collection. (Read +NearFieldPowerIntegralData) +[string] +Returns the NearFieldPowerIntegralData with the given name in the collection. (Read +NearFieldPowerIntegralData) +Property Details +Count +The number of NearFieldPowerIntegralData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the NearFieldPowerIntegralData. +Return +boolean +The success of the check. +Item (index number) +Returns the NearFieldPowerIntegralData at the given index. +Input Parameters +index(number) +The index of the NearFieldPowerIntegralData. +Return +NearFieldPowerIntegralData +The NearFieldPowerIntegralData at the given index. +Item (label string) +Returns the NearFieldPowerIntegralData with the given label. +Input Parameters +label(string) +The label of the NearFieldPowerIntegralData. +Return +NearFieldPowerIntegralData +The NearFieldPowerIntegralData with the given label. +Items () +Returns a table of NearFieldPowerIntegralData. +Return +List of NearFieldPowerIntegralData +A table of NearFieldPowerIntegralData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for NearFieldPowerIntegralData. +NetworkCollection +A collection of network results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Matching_SPICE.fek]]) +networkCollection = app.Models[1].Configurations[1].Networks + -- Add the first network to a Cartesian graph +graph = app.CartesianGraphs:Add() +networkTrace1 = graph.Traces:Add(networkCollection[1]) -- Index method +networkTrace2 = graph.Traces:Add(networkCollection["MatchingNetwork"]) -- Name method + -- Add all the networks in the collection to the graph +for index, networkData in pairs(networkCollection) do + networkTrace = graph.Traces:Add(networkData) +end +Usage locations +The NetworkCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection Networks. +Property List +Count +Type +The number of NetworkData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the NetworkData at the given index. (Returns a NetworkData object.) +Item (label string) +Returns the NetworkData with the given label. (Returns a NetworkData object.) +Items () +Returns a table of NetworkData. (Returns a List of NetworkData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4194 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the NetworkData at the given index in the collection. (Read NetworkData) +[string] +Returns the NetworkData with the given name in the collection. (Read NetworkData) +Property Details +Count +The number of NetworkData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the NetworkData. +Return +boolean +The success of the check. +Item (index number) +Returns the NetworkData at the given index. +Input Parameters +index(number) +The index of the NetworkData. +Return +NetworkData +The NetworkData at the given index. +Item (label string) +Returns the NetworkData with the given label. +Input Parameters +label(string) +The label of the NetworkData. +Return +NetworkData +The NetworkData with the given label. +Items () +Returns a table of NetworkData. +Return +List of NetworkData +A table of NetworkData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for NetworkData. +PolarGraphCollection +A collection of Polar graphs. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create graphs +graph1 = app.PolarGraphs:Add() +graph1.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) +graph2 = graph1:Duplicate() + -- Export all graphs in the 'PolarGraphCollection' +for index, graph in pairs(app.PolarGraphs) do + graph:Maximise() + graph:ExportImage("temp_Graph"..index, "pdf") +end +Usage locations +The PolarGraphCollection object can be accessed from the following locations: +• Collection lists +◦ Application object has collection PolarGraphs. +Property List +Count +Type +The number of PolarGraph items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Add () +Adds a new Polar graph to the collection. (Returns a PolarGraph object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the PolarGraph at the given index. (Returns a PolarGraph object.) +Item (label string) +Returns the PolarGraph with the given label. (Returns a PolarGraph object.) +Items () +Returns a table of PolarGraph. (Returns a List of PolarGraph object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4197 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the PolarGraph at the given index in the collection. (Read PolarGraph) +[string] +Returns the PolarGraph with the given name in the collection. (Read PolarGraph) +Property Details +Count +The number of PolarGraph items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Add () +Adds a new Polar graph to the collection. +Return +PolarGraph +The new Polar graph. +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the PolarGraph. +Return +boolean +The success of the check. +Item (index number) +Returns the PolarGraph at the given index. +Input Parameters +index(number) +The index of the PolarGraph. +Return +PolarGraph +The PolarGraph at the given index. +Item (label string) +Returns the PolarGraph with the given label. +Input Parameters +label(string) +The label of the PolarGraph. +Return +PolarGraph +The PolarGraph with the given label. +Items () +Returns a table of PolarGraph. +Return +List of PolarGraph +A table of PolarGraph. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for PolarGraph. +PowerCollection +A collection of power results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +powerCollection = app.Models[1].Configurations[1].Power + -- Add the first power to a Cartesian graph +graph = app.CartesianGraphs:Add() +powerTrace1 = graph.Traces:Add(powerCollection[1]) -- Index method +powerTrace2 = graph.Traces:Add(powerCollection["Power"]) -- Name method + -- Add all the powers in the collection to the graph +for index, powerData in pairs(powerCollection) do + powerTrace = graph.Traces:Add(powerData) +end +Usage locations +The PowerCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection Power. +Property List +Count +Type +The number of PowerData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the PowerData at the given index. (Returns a PowerData object.) +Item (label string) +Returns the PowerData with the given label. (Returns a PowerData object.) +Items () +Returns a table of PowerData. (Returns a List of PowerData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4200 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the PowerData at the given index in the collection. (Read PowerData) +[string] +Returns the PowerData with the given name in the collection. (Read PowerData) +Property Details +Count +The number of PowerData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the PowerData. +Return +boolean +The success of the check. +Item (index number) +Returns the PowerData at the given index. +Input Parameters +index(number) +The index of the PowerData. +Return +PowerData +The PowerData at the given index. +Item (label string) +Returns the PowerData with the given label. +Input Parameters +label(string) +The label of the PowerData. +Return +PowerData +The PowerData with the given label. +Items () +Returns a table of PowerData. +Return +List of PowerData +A table of PowerData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for PowerData. +RayCollection +A collection of ray results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Antenna_and_UTD_Plate.fek]]) +RayCollection = app.Models[1].Configurations[1].Rays + -- Add the first ray to the 3D view +RayTrace1 = app.Views[1].Plots:Add(RayCollection[1]) -- Index method +RayTrace2 = app.Views[1].Plots:Add(RayCollection["Rays1"]) -- Name method + -- Add all the ray in the collection to the 3D view +for index, RayData in pairs(RayCollection) do + RayPlot = app.Views[1].Plots:Add(RayData) +end +Usage locations +The RayCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection Rays. +Property List +Count +Type +The number of RayData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the RayData at the given index. (Returns a RayData object.) +Item (label string) +Returns the RayData with the given label. (Returns a RayData object.) +Items () +Returns a table of RayData. (Returns a List of RayData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4203 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the RayData at the given index in the collection. (Read RayData) +[string] +Returns the RayData with the given name in the collection. (Read RayData) +Property Details +Count +The number of RayData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the RayData. +Return +boolean +The success of the check. +Item (index number) +Returns the RayData at the given index. +Input Parameters +index(number) +The index of the RayData. +Return +RayData +The RayData at the given index. +Item (label string) +Returns the RayData with the given label. +Input Parameters +label(string) +The label of the RayData. +Return +RayData +The RayData with the given label. +Items () +Returns a table of RayData. +Return +List of RayData +A table of RayData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for RayData. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReceivingAntennaCollection +A collection of receiving antenna results. +Example +p.4205 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) +receivingAntennaCollection = app.Models[1].Configurations[1].ReceivingAntennas + -- Add the first receiving antenna request to a Cartesian graph +graph = app.CartesianGraphs:Add() + -- Index method +receivingAntennaTrace1 = graph.Traces:Add(receivingAntennaCollection[1]) + -- Name method +receivingAntennaTrace2 = + graph.Traces:Add(receivingAntennaCollection["FarFieldReceivingAntenna1"]) +Usage locations +The ReceivingAntennaCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection ReceivingAntennas. +Property List +Count +Type +The number of ReceivingAntennaData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the ReceivingAntennaData at the given index. (Returns a ReceivingAntennaData object.) +Item (label string) +Returns the ReceivingAntennaData with the given label. (Returns a ReceivingAntennaData object.) +Items () +Returns a table of ReceivingAntennaData. (Returns a List of ReceivingAntennaData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4206 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the ReceivingAntennaData at the given index in the collection. (Read +ReceivingAntennaData) +[string] +Returns the ReceivingAntennaData with the given name in the collection. (Read +ReceivingAntennaData) +Property Details +Count +The number of ReceivingAntennaData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the ReceivingAntennaData. +Return +boolean +The success of the check. +Item (index number) +Returns the ReceivingAntennaData at the given index. +Input Parameters +index(number) +The index of the ReceivingAntennaData. +Return +ReceivingAntennaData +The ReceivingAntennaData at the given index. +Item (label string) +Returns the ReceivingAntennaData with the given label. +Input Parameters +label(string) +The label of the ReceivingAntennaData. +Return +ReceivingAntennaData +The ReceivingAntennaData with the given label. +Items () +Returns a table of ReceivingAntennaData. +Return +List of ReceivingAntennaData +A table of ReceivingAntennaData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for ReceivingAntennaData. +ReportTemplateTagCollection +The collection of window names and report tags that will be included in the report. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.pfs]]) + -- Only generate the report if Microsoft Word is installed +if ( app.MSWordInstalled ) then + -- Add a Word 2007 report template to the POSTFEKO session + reportTemplate = app.Reports:Add( + FEKO_HOME..[[/shared/Resources/Automation/StartupModel.dotx]], + pf.Enums.ReportDocumentTypeEnum.MSWord) + -- Extract the tags from the template document and get a list of the open windows + in the + -- current session + reportTemplate.TagSettings[1].Window = "startup1" + reportTemplate.TagSettings[2].Window = "Cartesian graph1" + -- Generate the report + reportTemplate:Generate([[temp_StartupModelReport.docx]]) +end +Usage locations +The ReportTemplateTagCollection object can be accessed from the following locations: +• Collection lists +◦ ReportTemplate object has collection TagSettings. +Property List +Count +The number of ReportTemplateTagSettings items in the collection. (Read only number) +Method List +Item (index number) +Returns the ReportTemplateTagSettings at the given index. (Returns a ReportTemplateTagSettings +object.) +Modify (tagwindownames Map of string:string) +Specifies the window that should be included in the report at the specified tag. The list of window +titles can be retrieved with Windows. +Index List +[number] +Returns the ReportTemplateTagSettings at the given index in the collection. (Read +ReportTemplateTagSettings) +Property Details +Count +The number of ReportTemplateTagSettings items in the collection. +Type +number +Access +Read only +Method Details +Item (index number) +Returns the ReportTemplateTagSettings at the given index. +Input Parameters +index(number) +The index of the ReportTemplateTagSettings. +Return +ReportTemplateTagSettings +The ReportTemplateTagSettings at the given index. +Modify (tagwindownames Map of string:string) +Specifies the window that should be included in the report at the specified tag. The list of window +titles can be retrieved with Windows. +Input Parameters +tagwindownames(Map of string:string) +A map where the keys are tag names extracted from the template file and the values +being the title of the window which will be exported to the specified tag. +ReportsCollection +A collection of report templates. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.pfs]]) + -- Only generate reports if Microsoft Word is installed +if ( app.MSWordInstalled ) then + -- Add three Word 2007 report templates to the POSTFEKO session + templateName = FEKO_HOME..[[/shared/Resources/Automation/StartupModel.dotx]] + app.Reports:Add(templateName, pf.Enums.ReportDocumentTypeEnum.MSWord) + app.Reports:Add(templateName, pf.Enums.ReportDocumentTypeEnum.MSWord) + app.Reports:Add(templateName, pf.Enums.ReportDocumentTypeEnum.MSWord) + -- Now obtain a list of the report templates + reportList = app.Reports + print("Available report templates that can be generated:") + printlist(reportList) +end +Usage locations +The ReportsCollection object can be accessed from the following locations: +• Collection lists +◦ Application object has collection Reports. +Property List +Count +Type +The number of ReportTemplate items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Add (filename string, type ReportDocumentTypeEnum) +Adds a new report template to the collection. (Returns a ReportTemplate object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +ImportReportTemplate (filename string) +Import a report template from a (*.xml) file. +Item (index number) +Returns the ReportTemplate at the given index. (Returns a ReportTemplate object.) +Item (label string) +Returns the ReportTemplate with the given label. (Returns a ReportTemplate object.) +Items () +Returns a table of ReportTemplate. (Returns a List of ReportTemplate object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the ReportTemplate at the given index in the collection. (Read ReportTemplate) +[string] +Returns the ReportTemplate with the given name in the collection. (Read ReportTemplate) +Property Details +Count +The number of ReportTemplate items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (filename string, type ReportDocumentTypeEnum) +Adds a new report template to the collection. +Input Parameters +filename(string) +The name of the template document to generate the report from. +type(ReportDocumentTypeEnum) +The document type specified by the ReportDocumentTypeEnum, e.g. PDF, MSWord or +MSPowerPoint. +Return +ReportTemplate +The report template to generate. +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the ReportTemplate. +Return +boolean +The success of the check. +ImportReportTemplate (filename string) +Import a report template from a (*.xml) file. +Input Parameters +filename(string) +The name of the report template configuration file (*.xml) to be imported. +Item (index number) +Returns the ReportTemplate at the given index. +Input Parameters +index(number) +The index of the ReportTemplate. +Return +ReportTemplate +The ReportTemplate at the given index. +Item (label string) +Returns the ReportTemplate with the given label. +Input Parameters +label(string) +The label of the ReportTemplate. +Return +ReportTemplate +The ReportTemplate with the given label. +Items () +Returns a table of ReportTemplate. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +List of ReportTemplate +A table of ReportTemplate. +UniqueName (label string) +p.4213 +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for ReportTemplate. +Result3DPlotCollection +A collection of results available for the 3D view. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Get the plots collection for the first 3D View +plots = app.Views[1].Plots + -- Add far field, near field and surface current 3D plots +plots:Add(app.Models[1].Configurations[1].FarFields[1]) +plots:Add(app.Models[1].Configurations[1].NearFields[1]) +plots:Add(app.Models[1].Configurations[1].SurfaceCurrents[1]) + -- SetProperties the label of each of the plots in the collection +for plotNum, plot in pairs(plots) do + plot.Label = "3D_Plot_" .. plotNum +end + -- Print the list of all the plots in the collection +printlist(plots) +Usage locations +The Result3DPlotCollection object can be accessed from the following locations: +• Collection lists +◦ View object has collection Plots. +Property List +Count +Type +The number of Result3DPlot items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Add (result ResultData) +Adds a result to a view. (Returns a ResultPlot object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the Result3DPlot at the given index. (Returns a Result3DPlot object.) +Item (label string) +Returns the Result3DPlot with the given label. (Returns a Result3DPlot object.) +Items () +Returns a table of Result3DPlot. (Returns a List of Result3DPlot object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the Result3DPlot at the given index in the collection. (Read Result3DPlot) +[string] +Returns the Result3DPlot with the given name in the collection. (Read Result3DPlot) +Property Details +Count +The number of Result3DPlot items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (result ResultData) +Adds a result to a view. +Input Parameters +result(ResultData) +The result to add to the view. +Return +ResultPlot +The 3D result of the plot on the graph. +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the Result3DPlot. +Return +boolean +The success of the check. +Item (index number) +Returns the Result3DPlot at the given index. +Input Parameters +index(number) +The index of the Result3DPlot. +Return +Result3DPlot +The Result3DPlot at the given index. +Item (label string) +Returns the Result3DPlot with the given label. +Input Parameters +label(string) +The label of the Result3DPlot. +Return +Result3DPlot +The Result3DPlot with the given label. +Items () +Returns a table of Result3DPlot. +Return +List of Result3DPlot +A table of Result3DPlot. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for Result3DPlot. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ResultAnnotationCollection +A collection of 2D graph annotation. +Example +p.4218 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +app.Views[1]:Close() + -- Add a Cartesian graph to the application's collection and obtain + -- the arrow collection +graph = app.CartesianGraphs:Add() +farFieldTrace = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) +graph:ZoomToExtents() +annotations = graph.Annotations +annotation1 = annotations:AddGlobalMaximum(farFieldTrace) +Usage locations +The ResultAnnotationCollection object can be accessed from the following locations: +• Collection lists +◦ SmithChart object has collection Annotations. +◦ PolarGraph object has collection Annotations. +◦ CartesianGraph object has collection Annotations. +◦ Graph object has collection Annotations. +Property List +Count +Type +The number of GraphAnnotation items in the collection. (Read only number) +The object type string. (Read only string) +Method List +AddBandwidth10dBAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum) +Adds a -10dB bandwidth annotation. (Returns a GraphAnnotation object.) +AddBandwidth15dBAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum) +Adds a -15dB bandwidth annotation. (Returns a GraphAnnotation object.) +AddBandwidth3dBAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum) +Adds a -3dB bandwidth annotation. (Returns a GraphAnnotation object.) +AddBandwidthAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum, level +number) +Adds a bandwidth annotation. (Returns a GraphAnnotation object.) +AddBeamwidthAnnotation (trace ResultTrace, beamwidthtype AnnotationBeamwidthTypeEnum, +relativePoint AnnotationRelativeTypeEnum) +Adds a beam width annotation. (Returns a GraphAnnotation object.) +AddDeltaAnnotation (trace ResultTrace) +Adds a delta annotation. (Returns a GraphAnnotation object.) +AddDerivedWidthAnnotation (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum, offsetType +AnnotationWidthDefinitionTypeEnum, offset number) +Adds a derived width annotation. (Returns a GraphAnnotation object.) +AddFirstLocalMaximum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first local maximum. (Returns a GraphAnnotation object.) +AddFirstLocalMaximumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first local maximum searching to the left. (Returns a GraphAnnotation +object.) +AddFirstLocalMaximumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first local maximum searching to the right. (Returns a GraphAnnotation +object.) +AddFirstLocalMinimum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first local minimum. (Returns a GraphAnnotation object.) +AddFirstLocalMinimumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first local minimum searching to the left. (Returns a GraphAnnotation +object.) +AddFirstLocalMinimumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first local minimum searching to the right. (Returns a GraphAnnotation +object.) +AddFirstNullBeamwidthAnnotation (trace ResultTrace) +Adds a beam width annotation. (Returns a GraphAnnotation object.) +AddGlobalMaximum (trace ResultTrace) +Adds a GlobalMax annotation to the trace. (Returns a GraphAnnotation object.) +AddGlobalMinimum (trace ResultTrace) +Adds a GlobalMin annotation to the trace. (Returns a GraphAnnotation object.) +AddGreatestLocalMaximum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the largest local maximum. (Returns a GraphAnnotation object.) +AddGreatestLocalMaximumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first largest local maximum searching to the left. (Returns a +GraphAnnotation object.) +AddGreatestLocalMaximumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first largest local maximum searching to the right. (Returns a +GraphAnnotation object.) +AddGreatestLocalMinimum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the largest local minimum. (Returns a GraphAnnotation object.) +AddGreatestLocalMinimumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first largest local minimum searching to the left. (Returns a +GraphAnnotation object.) +AddGreatestLocalMinimumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first largest local minimum searching to the right. (Returns a +GraphAnnotation object.) +AddHalfPowerBeamwidthAnnotation (trace ResultTrace) +Adds a beam width annotation. (Returns a GraphAnnotation object.) +AddIndependentValue (trace ResultTrace, horizontalposition number, verticalposition number) +Adds an annotation at a position on the graph by defining the horizontal position (independent +axis value) and the vertical position (dependent axis value). (Returns a GraphAnnotation object.) +AddNullToNullBeamwidthAnnotation (trace ResultTrace) +Adds a beam width annotation. (Returns a GraphAnnotation object.) +AddSideLobeLevelAnnotation (trace ResultTrace) +Adds a side lobe level annotation. (Returns a GraphAnnotation object.) +AddValueAtHorizontalPosition (trace ResultTrace, horizontalposition number) +Adds an annotation at a horizontal position (independent axis value). (Returns a GraphAnnotation +object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the GraphAnnotation at the given index. (Returns a GraphAnnotation object.) +Item (label string) +Returns the GraphAnnotation with the given label. (Returns a GraphAnnotation object.) +Items () +Returns a table of GraphAnnotation. (Returns a List of GraphAnnotation object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the GraphAnnotation at the given index in the collection. (Read GraphAnnotation) +[string] +Returns the GraphAnnotation with the given name in the collection. (Read GraphAnnotation) +Property Details +Count +The number of GraphAnnotation items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +AddBandwidth10dBAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum) +Adds a -10dB bandwidth annotation. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +bandwidthtype(AnnotationBandwidthTypeEnum) +The bandwidth type. +Return +GraphAnnotation +The annotation on the graph. +AddBandwidth15dBAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum) +Adds a -15dB bandwidth annotation. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +bandwidthtype(AnnotationBandwidthTypeEnum) +The bandwidth type. +Return +GraphAnnotation +The annotation on the graph. +AddBandwidth3dBAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum) +Adds a -3dB bandwidth annotation. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +bandwidthtype(AnnotationBandwidthTypeEnum) +The bandwidth type. +Return +GraphAnnotation +The annotation on the graph. +AddBandwidthAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum, level +number) +Adds a bandwidth annotation. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +bandwidthtype(AnnotationBandwidthTypeEnum) +The bandwidth type. +level(number) +The bandwidth level (in dB). +Return +GraphAnnotation +The annotation on the graph. +AddBeamwidthAnnotation (trace ResultTrace, beamwidthtype AnnotationBeamwidthTypeEnum, +relativePoint AnnotationRelativeTypeEnum) +Adds a beam width annotation. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +beamwidthtype(AnnotationBeamwidthTypeEnum) +The beam width type. +relativePoint(AnnotationRelativeTypeEnum) +The point where the search starts. +Return +GraphAnnotation +The annotation on the graph. +AddDeltaAnnotation (trace ResultTrace) +Adds a delta annotation. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +GraphAnnotation +The annotation on the graph. +p.4223 +AddDerivedWidthAnnotation (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum, offsetType +AnnotationWidthDefinitionTypeEnum, offset number) +Adds a derived width annotation. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +relativePoint(AnnotationRelativeTypeEnum) +The point with which the annotation is relative. +offsetType(AnnotationWidthDefinitionTypeEnum) +The type of offset. +offset(number) +The offset value. +Return +GraphAnnotation +The annotation on the graph. +AddFirstLocalMaximum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first local maximum. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +relativePoint(AnnotationRelativeTypeEnum) +The point where the search starts. +Return +GraphAnnotation +The annotation on the graph. +AddFirstLocalMaximumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first local maximum searching to the left. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +relativePoint(AnnotationRelativeTypeEnum) +The point where the search starts. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +GraphAnnotation +The annotation on the graph. +p.4224 +AddFirstLocalMaximumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first local maximum searching to the right. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +relativePoint(AnnotationRelativeTypeEnum) +The point where the search starts. +Return +GraphAnnotation +The annotation on the graph. +AddFirstLocalMinimum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first local minimum. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +relativePoint(AnnotationRelativeTypeEnum) +The point where the search starts. +Return +GraphAnnotation +The annotation on the graph. +AddFirstLocalMinimumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first local minimum searching to the left. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +relativePoint(AnnotationRelativeTypeEnum) +The point where the search starts. +Return +GraphAnnotation +The annotation on the graph. +AddFirstLocalMinimumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first local minimum searching to the right. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +relativePoint(AnnotationRelativeTypeEnum) +The point where the search starts. +Return +GraphAnnotation +The annotation on the graph. +AddFirstNullBeamwidthAnnotation (trace ResultTrace) +Adds a beam width annotation. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +Return +GraphAnnotation +The annotation on the graph. +AddGlobalMaximum (trace ResultTrace) +Adds a GlobalMax annotation to the trace. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +Return +GraphAnnotation +The annotation on the graph. +AddGlobalMinimum (trace ResultTrace) +Adds a GlobalMin annotation to the trace. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +Return +GraphAnnotation +The annotation on the graph. +AddGreatestLocalMaximum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the largest local maximum. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +relativePoint(AnnotationRelativeTypeEnum) +The point where the search starts. +Return +GraphAnnotation +The annotation on the graph. +AddGreatestLocalMaximumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first largest local maximum searching to the left. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +relativePoint(AnnotationRelativeTypeEnum) +The point where the search starts. +Return +GraphAnnotation +The annotation on the graph. +AddGreatestLocalMaximumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first largest local maximum searching to the right. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +relativePoint(AnnotationRelativeTypeEnum) +The point where the search starts. +Return +GraphAnnotation +The annotation on the graph. +AddGreatestLocalMinimum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the largest local minimum. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +relativePoint(AnnotationRelativeTypeEnum) +The point where the search starts. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +GraphAnnotation +The annotation on the graph. +p.4227 +AddGreatestLocalMinimumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first largest local minimum searching to the left. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +relativePoint(AnnotationRelativeTypeEnum) +The point where the search starts. +Return +GraphAnnotation +The annotation on the graph. +AddGreatestLocalMinimumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum) +Adds an annotation to the first largest local minimum searching to the right. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +relativePoint(AnnotationRelativeTypeEnum) +The point where the search starts. +Return +GraphAnnotation +The annotation on the graph. +AddHalfPowerBeamwidthAnnotation (trace ResultTrace) +Adds a beam width annotation. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +Return +GraphAnnotation +The annotation on the graph. +AddIndependentValue (trace ResultTrace, horizontalposition number, verticalposition number) +Adds an annotation at a position on the graph by defining the horizontal position (independent +axis value) and the vertical position (dependent axis value). +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +horizontalposition(number) +The horizontal position (independent axis value). +verticalposition(number) +The vertical position (dependent axis value). +Return +GraphAnnotation +The annotation on the graph. +AddNullToNullBeamwidthAnnotation (trace ResultTrace) +Adds a beam width annotation. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +Return +GraphAnnotation +The annotation on the graph. +AddSideLobeLevelAnnotation (trace ResultTrace) +Adds a side lobe level annotation. +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +Return +GraphAnnotation +The annotation on the graph. +AddValueAtHorizontalPosition (trace ResultTrace, horizontalposition number) +Adds an annotation at a horizontal position (independent axis value). +Input Parameters +trace(ResultTrace) +The trace associated with the annotation. +horizontalposition(number) +The horizontal position (independent axis value). +Return +GraphAnnotation +The annotation on the graph. +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the GraphAnnotation. +Return +boolean +The success of the check. +Item (index number) +Returns the GraphAnnotation at the given index. +Input Parameters +index(number) +The index of the GraphAnnotation. +Return +GraphAnnotation +The GraphAnnotation at the given index. +Item (label string) +Returns the GraphAnnotation with the given label. +Input Parameters +label(string) +The label of the GraphAnnotation. +Return +GraphAnnotation +The GraphAnnotation with the given label. +Items () +Returns a table of GraphAnnotation. +Return +List of GraphAnnotation +A table of GraphAnnotation. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for GraphAnnotation. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ResultArrowCollection +A collection of 2D graph text boxes. +Example +p.4231 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +app.Views[1]:Close() + -- Add a Cartesian graph to the application's collection and obtain + -- the arrow collection +graph = app.CartesianGraphs:Add() +arrows = graph.Arrows +arrow1 = arrows:AddLine(20, 40, 40, 50) +arrow2 = arrows:AddArrow(25, 40, 45, 50) +arrow3 = arrows:AddDoubleHeadArrow(30, 40, 50, 50) +Usage locations +The ResultArrowCollection object can be accessed from the following locations: +• Collection lists +◦ SmithChart object has collection Arrows. +◦ PolarGraph object has collection Arrows. +◦ CartesianGraph object has collection Arrows. +◦ Graph object has collection Arrows. +Property List +Count +Type +The number of ResultArrow items in the collection. (Read only number) +The object type string. (Read only string) +Method List +AddArrow (startposX number, startposY number, endposX number, endposY number) +Adds a arrow to a graph. (Returns a ResultArrow object.) +AddDoubleHeadArrow (startposX number, startposY number, endposX number, endposY number) +Adds a arrow to a graph. (Returns a ResultArrow object.) +AddLine (startposX number, startposY number, endposX number, endposY number) +Adds a line to a graph. (Returns a ResultArrow object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the ResultArrow at the given index. (Returns a ResultArrow object.) +Item (label string) +Returns the ResultArrow with the given label. (Returns a ResultArrow object.) +Items () +Returns a table of ResultArrow. (Returns a List of ResultArrow object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the ResultArrow at the given index in the collection. (Read ResultArrow) +[string] +Returns the ResultArrow with the given name in the collection. (Read ResultArrow) +Property Details +Count +The number of ResultArrow items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +AddArrow (startposX number, startposY number, endposX number, endposY number) +Adds a arrow to a graph. +Input Parameters +startposX(number) +The start x-position of the added arrow. +startposY(number) +The start y-position of the added arrow. +endposX(number) +The end x-position of the added arrow. +endposY(number) +The end y-position of the added arrow. +Return +ResultArrow +The arrow on the graph. +AddDoubleHeadArrow (startposX number, startposY number, endposX number, endposY number) +Adds a arrow to a graph. +Input Parameters +startposX(number) +The start x-position of the added arrow. +startposY(number) +The start y-position of the added arrow. +endposX(number) +The end x-position of the added arrow. +endposY(number) +The end y-position of the added arrow. +Return +ResultArrow +The arrow on the graph. +AddLine (startposX number, startposY number, endposX number, endposY number) +Adds a line to a graph. +Input Parameters +startposX(number) +The start x-position of the added line. +startposY(number) +The start y-position of the added line. +endposX(number) +The end x-position of the added line. +endposY(number) +The end y-position of the added line. +Return +ResultArrow +The line on the graph. +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the ResultArrow. +Return +boolean +The success of the check. +Item (index number) +Returns the ResultArrow at the given index. +Input Parameters +index(number) +The index of the ResultArrow. +Return +ResultArrow +The ResultArrow at the given index. +Item (label string) +Returns the ResultArrow with the given label. +Input Parameters +label(string) +The label of the ResultArrow. +Return +ResultArrow +The ResultArrow with the given label. +Items () +Returns a table of ResultArrow. +Return +List of ResultArrow +A table of ResultArrow. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for ResultArrow. +Altair Feko 2022.3 +2 Application Programming Interface (API) +ResultSurfacePlotCollection +A collection of surface plots. +Example +p.4236 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +graph = app.CartesianSurfaceGraphs:Add() + -- Get the plots collection for the first Cartesian surface graph +plots = app.CartesianSurfaceGraphs[1].Plots + -- Add a far field surface plot to the collection +plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- SetProperties the label of each of the plots in the collection +for plotNum, plot in pairs(plots) do + plot.Label = "Surface_Plot_" .. plotNum +end + -- Print the list of all the plots in the collection +printlist(plots) +Usage locations +The ResultSurfacePlotCollection object can be accessed from the following locations: +• Collection lists +◦ CartesianSurfaceGraph object has collection Plots. +◦ SurfaceGraph object has collection Plots. +Property List +Count +Type +The number of ResultSurfacePlot items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Add (result ResultData) +Adds a result to a graph. (Returns a ResultPlot object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the ResultSurfacePlot at the given index. (Returns a ResultSurfacePlot object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +Item (label string) +p.4237 +Returns the ResultSurfacePlot with the given label. (Returns a ResultSurfacePlot object.) +Items () +Returns a table of ResultSurfacePlot. (Returns a List of ResultSurfacePlot object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the ResultSurfacePlot at the given index in the collection. (Read ResultSurfacePlot) +[string] +Returns the ResultSurfacePlot with the given name in the collection. (Read ResultSurfacePlot) +Property Details +Count +The number of ResultSurfacePlot items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (result ResultData) +Adds a result to a graph. +Input Parameters +result(ResultData) +The result to add to the graph. +Return +ResultPlot +The plot on the graph. +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the ResultSurfacePlot. +Return +boolean +The success of the check. +Item (index number) +Returns the ResultSurfacePlot at the given index. +Input Parameters +index(number) +The index of the ResultSurfacePlot. +Return +ResultSurfacePlot +The ResultSurfacePlot at the given index. +Item (label string) +Returns the ResultSurfacePlot with the given label. +Input Parameters +label(string) +The label of the ResultSurfacePlot. +Return +ResultSurfacePlot +The ResultSurfacePlot with the given label. +Items () +Returns a table of ResultSurfacePlot. +Return +List of ResultSurfacePlot +A table of ResultSurfacePlot. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for ResultSurfacePlot. +ResultTextBoxCollection +A collection of 2D graph text boxes. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +app.Views[1]:Close() + -- Add a Cartesian graph to the application's collection and obtain + -- the shapes collection +graph = app.CartesianGraphs:Add() +shapes = graph.Shapes +textBox1 = shapes:AddTextBox("TextBox", 20,30) +textBox1.TextDirection = pf.Enums.TextDirectionEnum.Rotate90 +textBox1.BackColour = pf.Enums.ColourEnum.Yellow +textBox1.Width = 100 +textBox1.Height = 150 +circle1 = shapes:AddCircle(35,30) +circle1.BackColour = pf.Enums.ColourEnum.Cyan +rectangle1 = shapes:AddRectangle(50,30) +rectangle1.BackColour = pf.Enums.ColourEnum.Magenta +Usage locations +The ResultTextBoxCollection object can be accessed from the following locations: +• Collection lists +◦ SmithChart object has collection Shapes. +◦ PolarGraph object has collection Shapes. +◦ CartesianGraph object has collection Shapes. +◦ Graph object has collection Shapes. +Property List +Count +Type +The number of ResultTextBox items in the collection. (Read only number) +The object type string. (Read only string) +Method List +AddCircle (posX number, posY number) +Adds a circle to a graph. (Returns a ResultTextBox object.) +AddRectangle (posX number, posY number) +Adds a rectangle to a graph. (Returns a ResultTextBox object.) +AddTextBox (text string) +Adds a text box to a graph. (Returns a ResultTextBox object.) +AddTextBox (text string, posX number, posY number) +Adds a text box to a graph. (Returns a ResultTextBox object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the ResultTextBox at the given index. (Returns a ResultTextBox object.) +Item (label string) +Returns the ResultTextBox with the given label. (Returns a ResultTextBox object.) +Items () +Returns a table of ResultTextBox. (Returns a List of ResultTextBox object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the ResultTextBox at the given index in the collection. (Read ResultTextBox) +[string] +Returns the ResultTextBox with the given name in the collection. (Read ResultTextBox) +Property Details +Count +The number of ResultTextBox items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +AddCircle (posX number, posY number) +Adds a circle to a graph. +Input Parameters +posX(number) +The x-position of the added circle. +posY(number) +The y-position of the added circle. +Return +ResultTextBox +The circle on the graph. +AddRectangle (posX number, posY number) +Adds a rectangle to a graph. +Input Parameters +posX(number) +The x-position of the added rectangle. +posY(number) +The y-position of the added rectangle. +Return +ResultTextBox +The rectangle on the graph. +AddTextBox (text string) +Adds a text box to a graph. +Input Parameters +text(string) +The text to add to the graph. +Return +ResultTextBox +The text box on the graph. +AddTextBox (text string, posX number, posY number) +Adds a text box to a graph. +Input Parameters +text(string) +The text to add to the graph. +posX(number) +The x-position of the added text box. +posY(number) +The y-position of the added text box. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +ResultTextBox +The text box on the graph. +Contains (label string) +Checks if the collection contains an item with the given label. +p.4243 +Input Parameters +label(string) +The label of the ResultTextBox. +Return +boolean +The success of the check. +Item (index number) +Returns the ResultTextBox at the given index. +Input Parameters +index(number) +The index of the ResultTextBox. +Return +ResultTextBox +The ResultTextBox at the given index. +Item (label string) +Returns the ResultTextBox with the given label. +Input Parameters +label(string) +The label of the ResultTextBox. +Return +ResultTextBox +The ResultTextBox with the given label. +Items () +Returns a table of ResultTextBox. +Return +List of ResultTextBox +A table of ResultTextBox. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for ResultTextBox. +ResultTraceCollection +A collection of 2D graph traces. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) +app.Views[1]:Close() + -- Add a Cartesian graph to the application's collection and obtain + -- the trace collection +graph = app.CartesianGraphs:Add() +traces = graph.Traces + -- Add multiple traces to the graph +traces:Add(app.Models[1].Configurations[1].FarFields[1]) +traces:Add(app.Models[1].Configurations[1].FarFieldPowerIntegrals[1]) +traces:Add(app.Models[1].Configurations[1].Power[1]) +traces:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Print a list of all the traces +print("Traces on the graph:") +printlist(traces) + -- Remove two of the graphs, by name and index +traces["FarFields_1"]:Delete() +traces[1]:Delete() +Usage locations +The ResultTraceCollection object can be accessed from the following locations: +• Collection lists +◦ SmithChart object has collection Traces. +◦ PolarGraph object has collection Traces. +◦ CartesianGraph object has collection Traces. +◦ Graph object has collection Traces. +Property List +Count +Type +The number of ResultTrace items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Add (result ResultData) +Adds a result to a graph. (Returns a ResultPlot object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the ResultTrace at the given index. (Returns a ResultTrace object.) +Item (label string) +Returns the ResultTrace with the given label. (Returns a ResultTrace object.) +Items () +Returns a table of ResultTrace. (Returns a List of ResultTrace object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the ResultTrace at the given index in the collection. (Read ResultTrace) +[string] +Returns the ResultTrace with the given name in the collection. (Read ResultTrace) +Property Details +Count +The number of ResultTrace items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (result ResultData) +Adds a result to a graph. +Input Parameters +result(ResultData) +The result to add to the graph. +Return +ResultPlot +The trace on the graph. +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the ResultTrace. +Return +boolean +The success of the check. +Item (index number) +Returns the ResultTrace at the given index. +Input Parameters +index(number) +The index of the ResultTrace. +Return +ResultTrace +The ResultTrace at the given index. +Item (label string) +Returns the ResultTrace with the given label. +Input Parameters +label(string) +The label of the ResultTrace. +Return +ResultTrace +The ResultTrace with the given label. +Items () +Returns a table of ResultTrace. +Return +List of ResultTrace +A table of ResultTrace. +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4248 +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for ResultTrace. +SARCollection +A collection of SAR results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MoM_PO_Misc_Example.fek]]) +SARCollection = app.Models[1].Configurations[1].SAR + -- Add the first SAR request to a Cartesian graph +graph = app.CartesianGraphs:Add() +SARTrace1 = graph.Traces:Add(SARCollection[1]) -- Index method +SARTrace2 = graph.Traces:Add(SARCollection["SAR1"]) -- Name method + -- Add all other SAR requests in the collection to the 3D view +for index, SARData in pairs(SARCollection) do + if (index > 1) then + SARPlot = app.Views[1].Plots:Add(SARData) + end +end +Usage locations +The SARCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection SAR. +Property List +Count +Type +The number of SARData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the SARData at the given index. (Returns a SARData object.) +Item (label string) +Returns the SARData with the given label. (Returns a SARData object.) +Items () +Returns a table of SARData. (Returns a List of SARData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4250 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the SARData at the given index in the collection. (Read SARData) +[string] +Returns the SARData with the given name in the collection. (Read SARData) +Property Details +Count +The number of SARData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the SARData. +Return +boolean +The success of the check. +Item (index number) +Returns the SARData at the given index. +Input Parameters +index(number) +The index of the SARData. +Return +SARData +The SARData at the given index. +Item (label string) +Returns the SARData with the given label. +Input Parameters +label(string) +The label of the SARData. +Return +SARData +The SARData with the given label. +Items () +Returns a table of SARData. +Return +List of SARData +A table of SARData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for SARData. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SParameterCollection +A collection of S-parameter results. +Example +p.4252 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Waveguide_Divider.fek]]) +sParameterCollection = + app.Models[1].Configurations["SParameterConfiguration1"].SParameters + -- Add the first S-Parameter to a Cartesian graph +graph = app.CartesianGraphs:Add() +sParameterTrace1 = graph.Traces:Add(sParameterCollection[1]) -- Index method +sParameterTrace2 = graph.Traces:Add(sParameterCollection["SParameter1"]) -- Name + method + -- Add all the S-Parameters in the collection to the graph +for index, sParameterData in pairs(sParameterCollection) do + sParameterTrace = graph.Traces:Add(sParameterData) +end +Usage locations +The SParameterCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection SParameters. +Property List +Count +Type +The number of SParameterData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the SParameterData at the given index. (Returns a SParameterData object.) +Item (label string) +Returns the SParameterData with the given label. (Returns a SParameterData object.) +Items () +Returns a table of SParameterData. (Returns a List of SParameterData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4253 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the SParameterData at the given index in the collection. (Read SParameterData) +[string] +Returns the SParameterData with the given name in the collection. (Read SParameterData) +Property Details +Count +The number of SParameterData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the SParameterData. +Return +boolean +The success of the check. +Item (index number) +Returns the SParameterData at the given index. +Input Parameters +index(number) +The index of the SParameterData. +Return +SParameterData +The SParameterData at the given index. +Item (label string) +Returns the SParameterData with the given label. +Input Parameters +label(string) +The label of the SParameterData. +Return +SParameterData +The SParameterData with the given label. +Items () +Returns a table of SParameterData. +Return +List of SParameterData +A table of SParameterData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for SParameterData. +SmithChartCollection +A collection of Smith charts. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create graphs +graph1 = app.SmithCharts:Add() +graph1.Traces:Add(app.Models[1].Configurations[1].Excitations[1]) +graph2 = graph1:Duplicate() + -- Export all graphs in the 'SmithChartCollection' +for index, graph in pairs(app.SmithCharts) do + graph:Maximise() + graph:ExportImage("temp_Graph"..index, "pdf") +end +Usage locations +The SmithChartCollection object can be accessed from the following locations: +• Collection lists +◦ Application object has collection SmithCharts. +Property List +Count +Type +The number of SmithChart items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Add () +Adds a new Smith chart to the collection. (Returns a SmithChart object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the SmithChart at the given index. (Returns a SmithChart object.) +Item (label string) +Returns the SmithChart with the given label. (Returns a SmithChart object.) +Items () +Returns a table of SmithChart. (Returns a List of SmithChart object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4256 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the SmithChart at the given index in the collection. (Read SmithChart) +[string] +Returns the SmithChart with the given name in the collection. (Read SmithChart) +Property Details +Count +The number of SmithChart items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Add () +Adds a new Smith chart to the collection. +Return +SmithChart +The new Smith chart. +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the SmithChart. +Return +boolean +The success of the check. +Item (index number) +Returns the SmithChart at the given index. +Input Parameters +index(number) +The index of the SmithChart. +Return +SmithChart +The SmithChart at the given index. +Item (label string) +Returns the SmithChart with the given label. +Input Parameters +label(string) +The label of the SmithChart. +Return +SmithChart +The SmithChart with the given label. +Items () +Returns a table of SmithChart. +Return +List of SmithChart +A table of SmithChart. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for SmithChart. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SpiceProbeCollection +A collection of SPICE probe results. +Example +p.4258 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/SpiceProbeTest.fek]]) + -- Obtain the collection of SPICE probes in the model +spiceProbes = app.Models[1].Configurations[1].SpiceProbes + -- Display the list of SPICE probe requests +print("The following SPICE probe requests are available:") +printlist(spiceProbes) + -- Retrieve the label of each SPICE probe request +for i, spiceProbeData in pairs(spiceProbes) do + label = spiceProbeData.Label +end +Usage locations +The SpiceProbeCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection SpiceProbes. +Property List +Count +Type +The number of SpiceProbeData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the SpiceProbeData at the given index. (Returns a SpiceProbeData object.) +Item (label string) +Returns the SpiceProbeData with the given label. (Returns a SpiceProbeData object.) +Items () +Returns a table of SpiceProbeData. (Returns a List of SpiceProbeData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4259 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the SpiceProbeData at the given index in the collection. (Read SpiceProbeData) +[string] +Returns the SpiceProbeData with the given name in the collection. (Read SpiceProbeData) +Property Details +Count +The number of SpiceProbeData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the SpiceProbeData. +Return +boolean +The success of the check. +Item (index number) +Returns the SpiceProbeData at the given index. +Input Parameters +index(number) +The index of the SpiceProbeData. +Return +SpiceProbeData +The SpiceProbeData at the given index. +Item (label string) +Returns the SpiceProbeData with the given label. +Input Parameters +label(string) +The label of the SpiceProbeData. +Return +SpiceProbeData +The SpiceProbeData with the given label. +Items () +Returns a table of SpiceProbeData. +Return +List of SpiceProbeData +A table of SpiceProbeData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for SpiceProbeData. +Altair Feko 2022.3 +2 Application Programming Interface (API) +StoredDataCollection +A collection of stored data results. +Example +p.4261 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Stored_Data.pfs]]) + -- Display the list of stored data entities +print("The following stored data entities are available:") +printlist(app.StoredData) + -- Obtain the collection of stored data in the model +storedData = app.StoredData + -- Retrieve the label of each stored data entity +for i, data in pairs(storedData) do + label = data.Label +end +Usage locations +The StoredDataCollection object can be accessed from the following locations: +• Collection lists +◦ Application object has collection StoredData. +Property List +Count +Type +The number of ResultData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the ResultData at the given index. (Returns a ResultData object.) +Item (label string) +Returns the ResultData with the given label. (Returns a ResultData object.) +Items () +Returns a table of ResultData. (Returns a List of ResultData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4262 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the ResultData at the given index in the collection. (Read ResultData) +[string] +Returns the ResultData with the given name in the collection. (Read ResultData) +Property Details +Count +The number of ResultData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the ResultData. +Return +boolean +The success of the check. +Item (index number) +Returns the ResultData at the given index. +Input Parameters +index(number) +The index of the ResultData. +Return +ResultData +The ResultData at the given index. +Item (label string) +Returns the ResultData with the given label. +Input Parameters +label(string) +The label of the ResultData. +Return +ResultData +The ResultData with the given label. +Items () +Returns a table of ResultData. +Return +List of ResultData +A table of ResultData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for ResultData. +Altair Feko 2022.3 +2 Application Programming Interface (API) +SurfaceCurrentsCollection +A collection of surface currents results. +Example +p.4264 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Obtain the collection of surface currents in the model +surfaceCurrents = app.Models[1].Configurations[1].SurfaceCurrents + -- Display the list of current requests +print("The following current requests are available:") +printlist(surfaceCurrents) + -- Export each of the currents to a file +for i, currentData in pairs(surfaceCurrents) do + print("Exporting " .. currentData.Label) + filename = "temp_CurrentsFor" .. currentData.Label + currentData:ExportData(filename, pf.Enums.CurrentsExportTypeEnum.Currents, 2) +end +Usage locations +The SurfaceCurrentsCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection SurfaceCurrents. +Property List +Count +Type +The number of SurfaceCurrentsData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the SurfaceCurrentsData at the given index. (Returns a SurfaceCurrentsData object.) +Item (label string) +Returns the SurfaceCurrentsData with the given label. (Returns a SurfaceCurrentsData object.) +Items () +Returns a table of SurfaceCurrentsData. (Returns a List of SurfaceCurrentsData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4265 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the SurfaceCurrentsData at the given index in the collection. (Read SurfaceCurrentsData) +[string] +Returns the SurfaceCurrentsData with the given name in the collection. (Read +SurfaceCurrentsData) +Property Details +Count +The number of SurfaceCurrentsData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the SurfaceCurrentsData. +Return +boolean +The success of the check. +Item (index number) +Returns the SurfaceCurrentsData at the given index. +Input Parameters +index(number) +The index of the SurfaceCurrentsData. +Return +SurfaceCurrentsData +The SurfaceCurrentsData at the given index. +Item (label string) +Returns the SurfaceCurrentsData with the given label. +Input Parameters +label(string) +The label of the SurfaceCurrentsData. +Return +SurfaceCurrentsData +The SurfaceCurrentsData with the given label. +Items () +Returns a table of SurfaceCurrentsData. +Return +List of SurfaceCurrentsData +A table of SurfaceCurrentsData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for SurfaceCurrentsData. +TRCoefficientCollection +A collection of transmission reflection coefficient results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Wire_Cross_tht45_eta0.fek]]) +transmissionReflectionCollection = app.Models[1].Configurations[1].TRCoefficients + -- Add the first transmission reflection request to a Cartesian graph +graph = app.CartesianGraphs:Add() + -- Index method +txReflectionTrace1 = graph.Traces:Add(transmissionReflectionCollection[1]) + -- Name method +txReflectionTrace2 = + graph.Traces:Add(transmissionReflectionCollection["TRCoefficients1"]) +Usage locations +The TRCoefficientCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection TRCoefficients. +Property List +Count +Type +The number of TRCoefficientData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the TRCoefficientData at the given index. (Returns a TRCoefficientData object.) +Item (label string) +Returns the TRCoefficientData with the given label. (Returns a TRCoefficientData object.) +Items () +Returns a table of TRCoefficientData. (Returns a List of TRCoefficientData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4268 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the TRCoefficientData at the given index in the collection. (Read TRCoefficientData) +[string] +Returns the TRCoefficientData with the given name in the collection. (Read TRCoefficientData) +Property Details +Count +The number of TRCoefficientData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the TRCoefficientData. +Return +boolean +The success of the check. +Item (index number) +Returns the TRCoefficientData at the given index. +Input Parameters +index(number) +The index of the TRCoefficientData. +Return +TRCoefficientData +The TRCoefficientData at the given index. +Item (label string) +Returns the TRCoefficientData with the given label. +Input Parameters +label(string) +The label of the TRCoefficientData. +Return +TRCoefficientData +The TRCoefficientData with the given label. +Items () +Returns a table of TRCoefficientData. +Return +List of TRCoefficientData +A table of TRCoefficientData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for TRCoefficientData. +Altair Feko 2022.3 +2 Application Programming Interface (API) +TransmissionLineCollection +A collection of transmission line results. +Example +p.4270 +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Log_Periodic_Network_Load.fek]]) +transmissionLineCollection = app.Models[1].Configurations[1].TransmissionLines + -- Add traces for all transmission lines in the 'TransmissionLineCollection' +graph = app.CartesianGraphs:Add() +for index, data in pairs(transmissionLineCollection) do + graph.Traces:Add(data) +end +Usage locations +The TransmissionLineCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection TransmissionLines. +Property List +Count +Type +The number of TransmissionLineData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the TransmissionLineData at the given index. (Returns a TransmissionLineData object.) +Item (label string) +Returns the TransmissionLineData with the given label. (Returns a TransmissionLineData object.) +Items () +Returns a table of TransmissionLineData. (Returns a List of TransmissionLineData object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the TransmissionLineData at the given index in the collection. (Read +TransmissionLineData) +[string] +Returns the TransmissionLineData with the given name in the collection. (Read +TransmissionLineData) +Property Details +Count +The number of TransmissionLineData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the TransmissionLineData. +Return +boolean +The success of the check. +Item (index number) +Returns the TransmissionLineData at the given index. +Input Parameters +index(number) +The index of the TransmissionLineData. +Return +TransmissionLineData +The TransmissionLineData at the given index. +Item (label string) +Returns the TransmissionLineData with the given label. +Input Parameters +label(string) +The label of the TransmissionLineData. +Return +TransmissionLineData +The TransmissionLineData with the given label. +Items () +Returns a table of TransmissionLineData. +Return +List of TransmissionLineData +A table of TransmissionLineData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for TransmissionLineData. +ViewCollection +A collection of 3D model views. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/multiple_configurations.fek]]) + -- Add a far field to the first 3D view (which gets created from the first + configuration + -- by default) +defaultView = app.Views[1] +defaultView.Plots:Add(app.Models[1].Configurations[1].FarFields[1]) + -- Add a new view for the second configuration to the 'ViewCollection'. Add its + far field. +secondConfigurationView = app.Views:Add(app.Models[1].Configurations[2]) +secondConfigurationView.Plots:Add(app.Models[1].Configurations[2].FarFields[1]) +Usage locations +The ViewCollection object can be accessed from the following locations: +• Collection lists +◦ Application object has collection Views. +Property List +Count +Type +The number of View items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Add (configuration SolutionConfiguration) +Adds a new 3D model view to the collection. (Returns a View object.) +Add () +Adds a new empty 3D view to the collection. (Returns a View object.) +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the View at the given index. (Returns a View object.) +Item (label string) +Returns the View with the given label. (Returns a View object.) +Items () +Returns a table of View. (Returns a List of View object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the View at the given index in the collection. (Read View) +[string] +Returns the View with the given name in the collection. (Read View) +Property Details +Count +The number of View items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Add (configuration SolutionConfiguration) +Adds a new 3D model view to the collection. +Input Parameters +configuration(SolutionConfiguration) +The Configuration that must be displayed. +Return +View +The new 3D model view. +Add () +Adds a new empty 3D view to the collection. +Return +View +The new 3D view. +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the View. +Return +boolean +The success of the check. +Item (index number) +Returns the View at the given index. +Input Parameters +index(number) +The index of the View. +Return +View +The View at the given index. +Item (label string) +Returns the View with the given label. +Input Parameters +label(string) +The label of the View. +Return +View +The View with the given label. +Items () +Returns a table of View. +Return +List of View +A table of View. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for View. +WindowCollection +A collection of all the 3D model views and 2D graphs. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Create graphs +farFieldGraph = app.CartesianGraphs:Add() +farFieldGraph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) +nearFieldGraph = app.CartesianGraphs:Add() +nearFieldGraph.Traces:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Create 3D Views +view1 = app.Views:Add(app.Models[1].Configurations[1]) +view1.Plots:Add(app.Models[1].Configurations[1].FarFields[1]) +view2 = app.Views:Add(app.Models[1].Configurations[1]) +view2.Plots:Add(app.Models[1].Configurations[1].NearFields[1]) + -- Export all graphs in the 'CartesianGraphCollection' +for index, graph in pairs(app.Windows) do + graph:Maximise() + graph:ExportImage("temp_Graph"..index, "pdf") +end +Usage locations +The WindowCollection object can be accessed from the following locations: +• Collection lists +◦ Application object has collection Windows. +Property List +Count +Type +The number of Window items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +GetActiveWindow () +Returns the window which is currently active. (Returns a Window object.) +Item (index number) +Returns the Window at the given index. (Returns a Window object.) +Item (label string) +Returns the Window with the given label. (Returns a Window object.) +Items () +Returns a table of Window. (Returns a List of Window object.) +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the Window at the given index in the collection. (Read Window) +[string] +Returns the Window with the given name in the collection. (Read Window) +Property Details +Count +The number of Window items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the Window. +Return +boolean +The success of the check. +GetActiveWindow () +Returns the window which is currently active. +Return +Window +The active window. +Item (index number) +Returns the Window at the given index. +Input Parameters +index(number) +The index of the Window. +Return +Window +The Window at the given index. +Item (label string) +Returns the Window with the given label. +Input Parameters +label(string) +The label of the Window. +Return +Window +The Window with the given label. +Items () +Returns a table of Window. +Return +List of Window +A table of Window. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for Window. +WireCurrentsCollection +A collection of wire currents results. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/ +Dipole_Example_MultipleCurrents.fek]]) + -- Obtain the collection of wire currents in the model +currents = app.Models[1].Configurations[1].WireCurrents + -- Display the list of current requests +print("The following current requests are available:") +printlist(currents) + -- Export each of the currents to a file +for i, currentData in pairs(currents) do + print("Exporting " .. currentData.Label) + filename = "temp_CurrentsFor" .. currentData.Label + currentData:ExportData(filename, pf.Enums.CurrentsExportTypeEnum.Currents, 2) +end +Usage locations +The WireCurrentsCollection object can be accessed from the following locations: +• Collection lists +◦ SolutionConfiguration object has collection WireCurrents. +Property List +Count +Type +The number of WireCurrentsData items in the collection. (Read only number) +The object type string. (Read only string) +Method List +Contains (label string) +Checks if the collection contains an item with the given label. (Returns a boolean object.) +Item (index number) +Returns the WireCurrentsData at the given index. (Returns a WireCurrentsData object.) +Item (label string) +Returns the WireCurrentsData with the given label. (Returns a WireCurrentsData object.) +Items () +Returns a table of WireCurrentsData. (Returns a List of WireCurrentsData object.) +Altair Feko 2022.3 +2 Application Programming Interface (API) +UniqueName (label string) +p.4281 +Generates a unique name base of of the provided base name.If the base name already exists +in the collection, a digit will be appended until a valid name is generated. (Returns a boolean +object.) +Index List +[number] +Returns the WireCurrentsData at the given index in the collection. (Read WireCurrentsData) +[string] +Returns the WireCurrentsData with the given name in the collection. (Read WireCurrentsData) +Property Details +Count +The number of WireCurrentsData items in the collection. +Type +number +Access +Read only +Type +The object type string. +Type +string +Access +Read only +Method Details +Contains (label string) +Checks if the collection contains an item with the given label. +Input Parameters +label(string) +The label of the WireCurrentsData. +Return +boolean +The success of the check. +Item (index number) +Returns the WireCurrentsData at the given index. +Input Parameters +index(number) +The index of the WireCurrentsData. +Return +WireCurrentsData +The WireCurrentsData at the given index. +Item (label string) +Returns the WireCurrentsData with the given label. +Input Parameters +label(string) +The label of the WireCurrentsData. +Return +WireCurrentsData +The WireCurrentsData with the given label. +Items () +Returns a table of WireCurrentsData. +Return +List of WireCurrentsData +A table of WireCurrentsData. +UniqueName (label string) +Generates a unique name base of of the provided base name.If the base name already exists in +the collection, a digit will be appended until a valid name is generated. +Input Parameters +label(string) +The base name. +Return +boolean +The generated unique name label for WireCurrentsData. +2.2.3 Namespaces and Static Functions +Many objects have static functions, but only a limited number of functions are available directly in the +application namespace (pf) or sub-namespace. +Namespace List +pf +The namespace that contains all of the application namespaces, objects, functions, collections, +enumerations and constants. +Archive +Create and extract archived files and folders. +CharacteristicModes +Characteristic mode data set functions. +CustomData +Custom data data set functions. +DRE +Import and export datasets in the DRE (Daimler Result Exchange) format. +Excitation +Excitation data set functions. +FarField +Far field data set functions. +Load +Load data set functions. +MatIO +Read and write mat files. +NearField +Near field data set functions. +Network +Network data set functions. +Power +Power data set functions. +SAR +SAR data set functions. +SParameter +S-parameter data set functions. +SurfaceCurrentsAndCharges +Surface currents and charges data set functions. +TRCoefficients +Transmission/reflection coefficient data set functions. +Altair Feko 2022.3 +2 Application Programming Interface (API) +WireCurrentsAndCharges +Wire currents and charges data set functions. +p.4284 +Altair Feko 2022.3 +2 Application Programming Interface (API) +The pf namespace +p.4285 +Many objects have static functions, but only a limited number of functions are available directly in the pf +namespace. Numerous namespaces exist under the pf namespace that also contain static functions. +Namespace List +Archive +Create and extract archived files and folders. +CharacteristicModes +Characteristic mode data set functions. +CustomData +Custom data data set functions. +DRE +Import and export datasets in the DRE (Daimler Result Exchange) format. +Excitation +Excitation data set functions. +FarField +Far field data set functions. +Load +Load data set functions. +MatIO +Read and write mat files. +NearField +Near field data set functions. +Network +Network data set functions. +Power +Power data set functions. +SAR +SAR data set functions. +SParameter +S-parameter data set functions. +SurfaceCurrentsAndCharges +Surface currents and charges data set functions. +TRCoefficients +Transmission/reflection coefficient data set functions. +WireCurrentsAndCharges +Wire currents and charges data set functions. +Function List +GetApplication () +Returns an instance of the POSTFEKO application object. (Returns a Application object.) +Function Details +GetApplication () +Returns an instance of the POSTFEKO application object. +Return +Application +An instance of the POSTFEKO application object. +Example + -- The "GetApplication" function lives in the "pf" namespace and + -- returns the current POSTFEKO application object. +app = pf.GetApplication() + -- Start a new project and save it as "ExampleProject" +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]]) + -- Save the project in the same directory as this script +app:SaveAs([[temp_ExampleProject.pfs]]) +Altair Feko 2022.3 +2 Application Programming Interface (API) +The Archive namespace +Create and extract archived files and folders. +Function List +InspectZip (filename string) +p.4287 +Returns a list of contained file names without extracting the archive file. (Returns a List of string +object.) +UnZip (filename string, destination string) +Extract a zip archive to the specified destination path. +UnZip (filename string, files List of string, destination string) +Extract only the specified files from the zip archive to the destination path. +Zip (filename string, sourcefiles List of string) +Creates a zip archive that contains the specified files and/or directories. If the destination zip file +exists, the specified files and/or directories will be added to the existing zip archive.Files and/or +directories specified that exist in the archive will be replaced. +Function Details +InspectZip (filename string) +Returns a list of contained file names without extracting the archive file. +Input Parameters +filename(string) +Source zip file. +Return +List of string +The list of archived files. +UnZip (filename string, destination string) +Extract a zip archive to the specified destination path. +Input Parameters +filename(string) +Source zip file. +destination(string) +The extraction destination. +UnZip (filename string, files List of string, destination string) +Extract only the specified files from the zip archive to the destination path. +Input Parameters +filename(string) +Source zip file. +files(List of string) +The list of files to extract. +destination(string) +The extraction destination. +Zip (filename string, sourcefiles List of string) +Creates a zip archive that contains the specified files and/or directories. If the destination zip file +exists, the specified files and/or directories will be added to the existing zip archive.Files and/or +directories specified that exist in the archive will be replaced. +Input Parameters +filename(string) +Destination zip file. +sourcefiles(List of string) +List of source files and/or directories. +The CharacteristicModes namespace +Characteristic mode data set functions. +Function List +GetDataSet (name string) +Returns the data set for the given characteristic mode. (Returns a DataSet object.) +GetDataSet (name string, sample number) +Returns the data set for the given characteristic mode. (Returns a DataSet object.) +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given characteristic mode. (Returns a DataSet object.) +GetNames () +Returns a list containing the names of the characteristic modes. (Returns a List of string object.) +Function Details +GetDataSet (name string) +Returns the data set for the given characteristic mode. +Input Parameters +name(string) +The full name of the characteristic mode. +Return +DataSet +A characteristic mode data set. +GetDataSet (name string, sample number) +Returns the data set for the given characteristic mode. +Input Parameters +name(string) +The full name of the characteristic mode. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A characteristic mode data set. +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given characteristic mode. +Input Parameters +name(string) +The full name of the characteristic mode. +startFreq(number) +The start frequency to use when sampling the continuous frequency axis. +endFreq(number) +The end frequency to use when sampling the continuous frequency axis. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A characteristic mode data set. +GetNames () +Returns a list containing the names of the characteristic modes. +Return +List of string +A list of characteristic mode names. +Altair Feko 2022.3 +2 Application Programming Interface (API) +The CustomData namespace +Custom data data set functions. +Function List +GetDataSet (name string) +p.4291 +Returns the data set for the given custom data. (Returns a DataSet object.) +GetDataSet (name string, sample number) +Returns the data set for the given custom data. (Returns a DataSet object.) +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given custom data. (Returns a DataSet object.) +GetNames () +Returns a list containing the names of the custom data entities. (Returns a List of string object.) +Function Details +GetDataSet (name string) +Returns the data set for the given custom data. +Input Parameters +name(string) +The full name of the custom data. +Return +DataSet +A custom data data set. +GetDataSet (name string, sample number) +Returns the data set for the given custom data. +Input Parameters +name(string) +The full name of the custom data. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A custom data data set. +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given custom data. +Input Parameters +name(string) +The full name of the custom data. +startFreq(number) +The start frequency to use when sampling the continuous frequency axis. +endFreq(number) +The end frequency to use when sampling the continuous frequency axis. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A custom data data set. +GetNames () +Returns a list containing the names of the custom data entities. +Return +List of string +A list of custom data names. +Altair Feko 2022.3 +2 Application Programming Interface (API) +The DRE namespace +Import and export datasets in the DRE (Daimler Result Exchange) format. +p.4293 +Namespace List +ImportSettings +Settings used for the import of DRE datasets. ImportSettings is part of the DRE namespace. +Function List +DiscoverHierarchy (filename string, startPoint string) +Discovers the layout and contents of the specified DRE file starting at startPoint and returns it as +a Lua table. No DataSet data is read. (Returns a table object.) +DiscoverHierarchy (filename string) +Discovers the layout and contents of the specified DRE file starting at the root and returns it as a +Lua table. No DataSet data is read. (Returns a table object.) +ExportDataSet (dataset DataSet, filename string, dataSetPath string) +Writes the given DataSet object to a DRE file, using the label dataSetPath to determine the full +path in the file. (Returns a boolean object.) +ImportDataSet (filename string, dataSetPath string) +Reads the specified DataSet from the specified DRE file and returns it as a Feko DataSet. (Returns +a DataSet object.) +ImportDataSet (filename string, dataSetPath string, importSettings table) +Reads the specified DataSet from the specified DRE file and returns it as a Feko DataSet. (Returns +a DataSet object.) +StoreData (filename string, dataSetPath string, type StoredDataTypeEnum) +Reads the specified DataSet from the specified DRE file and creates a stored copy of the DataSet. +(Returns a ResultData object.) +StoreData (filename string, dataSetPath string, type StoredDataTypeEnum, importSettings table) +Reads the specified DataSet from the specified DRE file and creates a stored copy of the DataSet. +(Returns a ResultData object.) +Function Details +DiscoverHierarchy (filename string, startPoint string) +Discovers the layout and contents of the specified DRE file starting at startPoint and returns it as +a Lua table. No DataSet data is read. +Input Parameters +filename(string) +The name of the file to read. +startPoint(string) +A location in the file where reading will be started from. +Return +table +Table. +DiscoverHierarchy (filename string) +Discovers the layout and contents of the specified DRE file starting at the root and returns it as a +Lua table. No DataSet data is read. +Input Parameters +filename(string) +The name of the file to read. +Return +table +Table. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the far field data set +local farFieldDataSet = pf.FarField.GetDataSet("startup.StandardConfiguration1.FarFields") + -- Export the data set to a new DRE file +local fileName = [[temp_startup.dre]] +pf.DRE.ExportDataSet(farFieldDataSet, fileName, "/") + -- Inspect the DRE file hierarchy to determine the location of the data to import +local dreFileHierarchy = pf.DRE.DiscoverHierarchy(fileName) +inspect(dreFileHierarchy) + -- The hierarchy is returned in a table containing the following notation: + -- Attribute = { Name, Class, Data } + -- Compound = { Name, Class, {Members} } + -- Data = { {Dimensions}, Type, Class } + -- DataSet = { Name, Class, {Attributes}, Data } + -- Target = { Path , {Filename} } + -- Error = { Message } + -- Link = { Name, Class, LinkType, Target, {Error} } + -- Group = { Name, Class, {Group|Link}, {Attributes}, {DataSet|Link} } +local drePath = "/"..dreFileHierarchy["Groups"][1].Name +local importedFarFieldDataSet = pf.DRE.ImportDataSet(fileName, drePath) +importedFarFieldDataSet:StoreData(pf.Enums.StoredDataTypeEnum.FarField) +ExportDataSet (dataset DataSet, filename string, dataSetPath string) +Writes the given DataSet object to a DRE file, using the label dataSetPath to determine the full +path in the file. +Input Parameters +dataset(DataSet) +The dataset to export. +filename(string) +The name of the file to export the DataSet to. +dataSetPath(string) +The path that the DataSet will be exported to in the file. +Return +boolean +Boolean indicating success. +ImportDataSet (filename string, dataSetPath string) +Reads the specified DataSet from the specified DRE file and returns it as a Feko DataSet. +Input Parameters +filename(string) +The name of the file to import the DataSet from. +dataSetPath(string) +The path to the DRE data set to import. +Return +DataSet +DataSet. +ImportDataSet (filename string, dataSetPath string, importSettings table) +Reads the specified DataSet from the specified DRE file and returns it as a Feko DataSet. +Input Parameters +filename(string) +The name of the file to import the DataSet from. +dataSetPath(string) +The path to the DRE data set to import. +importSettings(table) +The settings used for DRE data import. +Return +DataSet +DataSet. +StoreData (filename string, dataSetPath string, type StoredDataTypeEnum) +Reads the specified DataSet from the specified DRE file and creates a stored copy of the DataSet. +Input Parameters +filename(string) +The name of the file to import the DataSet from. +dataSetPath(string) +The path to the DRE data set to import. +type(StoredDataTypeEnum) +The type of stored data entity specified by StoredDataTypeEnum, e.g. FarField, +NearField, Custom, etc. +Return +ResultData +The new stored data. +StoreData (filename string, dataSetPath string, type StoredDataTypeEnum, importSettings table) +Reads the specified DataSet from the specified DRE file and creates a stored copy of the DataSet. +Input Parameters +filename(string) +The name of the file to import the DataSet from. +dataSetPath(string) +The path to the DRE data set to import. +type(StoredDataTypeEnum) +The type of stored data entity specified by StoredDataTypeEnum, e.g. FarField, +NearField, Custom, etc. +importSettings(table) +The settings used for DRE data import. +Return +ResultData +The new stored data. +Altair Feko 2022.3 +2 Application Programming Interface (API) +The ImportSettings namespace +p.4297 +Settings used for the import of DRE datasets. ImportSettings is part of the DRE namespace. +Function List +Get () +The settings used during the import. (Returns a table object.) +Function Details +Get () +The settings used during the import. +Return +table +Table. +Example +app = pf.GetApplication() +app:NewProject() +app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) + -- Retrieve the far field data set +local farFieldDataSet = pf.FarField.GetDataSet("startup.StandardConfiguration1.FarFields") + -- Export the data set to a new DRE file +local fileName = [[temp_startup.dre]] +pf.DRE.ExportDataSet(farFieldDataSet, fileName, "/") + -- Inspect the DRE file hierarchy to determine the location of the data to import +local dreFileHierarchy = pf.DRE.DiscoverHierarchy(fileName) +local drePath = "/"..dreFileHierarchy["Groups"][1].Name + -- Modify scale values used during DRE import +local dbFactor = 10.0 +local dbScale = 2.0 +local settings = pf.DRE.ImportSettings.Get() +for ii=1,#settings.dBScales do + if (settings.dBScales[ii].Name == "dBRef") then + settings.dBScales[ii].dBScale = tostring(dbScale) + end +end + -- Import data set from DRE file + -- Note: The modified scales will not have an effect in this example + -- (dBRef is not used in the DRE file) +local importedFarFieldDataSet = pf.DRE.ImportDataSet(fileName, drePath, settings) +importedFarFieldDataSet:StoreData(pf.Enums.StoredDataTypeEnum.FarField) +The Excitation namespace +Excitation data set functions. +Function List +GetDataSet (name string) +Returns the data set for the given excitation. (Returns a DataSet object.) +GetDataSet (name string, sample number) +Returns the data set for the given excitation. (Returns a DataSet object.) +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given excitation. (Returns a DataSet object.) +GetNames () +Returns a list containing the names of the excitations. (Returns a List of string object.) +Function Details +GetDataSet (name string) +Returns the data set for the given excitation. +Input Parameters +name(string) +The full name of the excitation. +Return +DataSet +A excitation data set. +GetDataSet (name string, sample number) +Returns the data set for the given excitation. +Input Parameters +name(string) +The full name of the excitation. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A excitation data set. +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given excitation. +Input Parameters +name(string) +The full name of the excitation. +startFreq(number) +The start frequency to use when sampling the continuous frequency axis. +endFreq(number) +The end frequency to use when sampling the continuous frequency axis. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A excitation data set. +GetNames () +Returns a list containing the names of the excitations. +Return +List of string +A list of excitation names. +Altair Feko 2022.3 +2 Application Programming Interface (API) +The FarField namespace +Far field data set functions. +Function List +GetDataSet (name string) +p.4300 +Returns the data set for the given far field. (Returns a DataSet object.) +GetDataSet (name string, sample number) +Returns the data set for the given far field. (Returns a DataSet object.) +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given far field. (Returns a DataSet object.) +GetNames () +Returns a list containing the names of the far fields. (Returns a List of string object.) +GetSampledDataSet (name string, theta number, phi number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. (Returns a DataSet object.) +GetSampledDataSet (name string, thetaStart number, thetaEnd number, thetaCount number, phiStart +number, phiEnd number, phiCount number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. (Returns a DataSet object.) +GetSampledDataSet (name string, freq number, theta number, phi number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. (Returns a DataSet object.) +GetSampledDataSet (name string, freqStart number, freqEnd number, freqCount number, thetaStart +number, thetaEnd number, thetaCount number, phiStart number, phiEnd number, phiCount number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. (Returns a DataSet object.) +Function Details +GetDataSet (name string) +Returns the data set for the given far field. +Input Parameters +name(string) +The full name of the far field. +Return +DataSet +A far field data set. +GetDataSet (name string, sample number) +Returns the data set for the given far field. +Input Parameters +name(string) +The full name of the far field. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A far field data set. +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given far field. +Input Parameters +name(string) +The full name of the far field. +startFreq(number) +The start frequency to use when sampling the continuous frequency axis. +endFreq(number) +The end frequency to use when sampling the continuous frequency axis. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A far field data set. +GetNames () +Returns a list containing the names of the far fields. +Return +List of string +A list of far field names. +GetSampledDataSet (name string, theta number, phi number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. +Input Parameters +name(string) +The full name of the far field. +theta(number) +The theta sample density. +phi(number) +The phi sample density. +Return +DataSet +A far field data set. +GetSampledDataSet (name string, thetaStart number, thetaEnd number, thetaCount number, phiStart +number, phiEnd number, phiCount number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. +Input Parameters +name(string) +The full name of the far field. +thetaStart(number) +The start of the theta range to sample. +thetaEnd(number) +The end of the theta range to sample. +thetaCount(number) +The theta sample density. +phiStart(number) +The start of the phi range to sample. +phiEnd(number) +The end of the phi range to sample. +phiCount(number) +The phi sample density. +Return +DataSet +A far field data set. +GetSampledDataSet (name string, freq number, theta number, phi number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. +Input Parameters +name(string) +The full name of the far field. +freq(number) +The frequency sample density. +theta(number) +The theta sample density. +phi(number) +The phi sample density. +Return +DataSet +A far field data set. +GetSampledDataSet (name string, freqStart number, freqEnd number, freqCount number, thetaStart +number, thetaEnd number, thetaCount number, phiStart number, phiEnd number, phiCount number) +Returns the data set for the continuous far field sampled using the given theta and phi sample +densities. +Input Parameters +name(string) +The full name of the far field. +freqStart(number) +The start of the frequency range to sample. +freqEnd(number) +The end of the frequency range to sample. +freqCount(number) +The frequency sample density. +thetaStart(number) +The start of the theta range to sample. +thetaEnd(number) +The end of the theta range to sample. +thetaCount(number) +The theta sample density. +phiStart(number) +The start of the phi range to sample. +phiEnd(number) +The end of the phi range to sample. +phiCount(number) +The phi sample density. +Return +DataSet +A far field data set. +The Load namespace +Load data set functions. +Function List +GetDataSet (name string) +Returns the data set for the given load. (Returns a DataSet object.) +GetDataSet (name string, sample number) +Returns the data set for the given load. (Returns a DataSet object.) +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given load. (Returns a DataSet object.) +GetNames () +Returns a list containing the names of the loads. (Returns a List of string object.) +Function Details +GetDataSet (name string) +Returns the data set for the given load. +Input Parameters +name(string) +The full name of the load. +Return +DataSet +A load data set. +GetDataSet (name string, sample number) +Returns the data set for the given load. +Input Parameters +name(string) +The full name of the load. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A load data set. +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given load. +Input Parameters +name(string) +The full name of the load. +startFreq(number) +The start frequency to use when sampling the continuous frequency axis. +endFreq(number) +The end frequency to use when sampling the continuous frequency axis. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A load data set. +GetNames () +Returns a list containing the names of the loads. +Return +List of string +A list of load names. +Altair Feko 2022.3 +2 Application Programming Interface (API) +The MatIO namespace +Read and write mat files. +Function List +p.4306 +ExportMatFile (matrix Matrix, filename string, varname string) +Writes the given Matrix object to a *.mat file. (Returns a boolean object.) +ExportMatFile (matrix ComplexMatrix, filename string, varname string) +Writes the given ComplexMatrix object to a *.mat file. (Returns a boolean object.) +ExportMatFile (table table, filename string, varname string) +Writes the given table structure to a *.mat file. (Returns a boolean object.) +ExportMatFile (dataset DataSet, filename string, varname string) +Writes the given DataSet object to a *.mat file. (Returns a boolean object.) +GetNames (filename string) +Lists the variables in a *.mat file that can be read into a DataSet object. (Returns a List of string +object.) +ReadMatFile (filename string) +Reads all data from a *.mat file in its original structure. (Returns a table object.) +ReadMatFile (filename string, name string) +Reads a specific variable from *.mat file. (Returns a DataSet object.) +ReadMatFileStructure (filename string) +Reads the structure of a *.mat file without importing DataSet information. (Returns a table +object.) +ReadMatFileToTable (filename string, name string) +Reads a specific variable from *.mat file. (Returns a table object.) +Function Details +ExportMatFile (matrix Matrix, filename string, varname string) +Writes the given Matrix object to a *.mat file. +Input Parameters +matrix(Matrix) +The Matrix. +filename(string) +Filename of the *.mat file. +varname(string) +The name of the variable to export. +Return +boolean +Boolean to indicate if it was successful. +ExportMatFile (matrix ComplexMatrix, filename string, varname string) +Writes the given ComplexMatrix object to a *.mat file. +Input Parameters +matrix(ComplexMatrix) +The ComplexMatrix. +filename(string) +Filename of the *.mat file. +varname(string) +The name of the variable to export. +Return +boolean +Boolean to indicate if it was successful. +ExportMatFile (table table, filename string, varname string) +Writes the given table structure to a *.mat file. +Input Parameters +table(table) +The Lua table. +filename(string) +Filename of the *.mat file. +varname(string) +The name of the variable to export. +Return +boolean +Boolean to indicate if it was successful. +ExportMatFile (dataset DataSet, filename string, varname string) +Writes the given DataSet object to a *.mat file. +Input Parameters +dataset(DataSet) +The DataSet. +filename(string) +Filename of the *.mat file. +varname(string) +The name of the variable to export. +Return +boolean +Boolean to indicate if it was successful. +GetNames (filename string) +Lists the variables in a *.mat file that can be read into a DataSet object. +Input Parameters +filename(string) +Filename of the *.mat file. +Return +List of string +Returns a List of string. +ReadMatFile (filename string) +Reads all data from a *.mat file in its original structure. +Input Parameters +filename(string) +Filename of the *.mat file. +Return +table +Returns a table object. +ReadMatFile (filename string, name string) +Reads a specific variable from *.mat file. +Input Parameters +filename(string) +Filename of the *.mat file. +name(string) +The name of the variable. +Return +DataSet +Returns a DataSet object. +ReadMatFileStructure (filename string) +Reads the structure of a *.mat file without importing DataSet information. +Input Parameters +filename(string) +Filename of the *.mat file. +Return +table +Returns a table object. +ReadMatFileToTable (filename string, name string) +Reads a specific variable from *.mat file. +Input Parameters +filename(string) +Filename of the *.mat file. +name(string) +The name of the variable. +Return +table +Returns a Lua table. +Altair Feko 2022.3 +2 Application Programming Interface (API) +The NearField namespace +Near field data set functions. +Function List +GetDataSet (name string) +p.4310 +Returns the data set for the given near field. (Returns a DataSet object.) +GetDataSet (name string, sample number) +Returns the data set for the given near field. (Returns a DataSet object.) +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given near field. (Returns a DataSet object.) +GetMediaDataSet (name string) +Returns the data set containing the media information for the given near field. (Returns a DataSet +object.) +GetMediaDataSet (name string, sample number) +Returns the data set containing the media information for the given near field. (Returns a DataSet +object.) +GetMediaDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set containing the media information for the given near field. (Returns a DataSet +object.) +GetNames () +Returns a list containing the names of the near fields. (Returns a List of string object.) +Function Details +GetDataSet (name string) +Returns the data set for the given near field. +Input Parameters +name(string) +The full name of the near field. +Return +DataSet +A near field data set. +GetDataSet (name string, sample number) +Returns the data set for the given near field. +Input Parameters +name(string) +The full name of the near field. +sample(number) +The sample density for the continuous frequency axis. +Altair Feko 2022.3 +2 Application Programming Interface (API) +Return +DataSet +A near field data set. +p.4311 +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given near field. +Input Parameters +name(string) +The full name of the near field. +startFreq(number) +The start frequency to use when sampling the continuous frequency axis. +endFreq(number) +The end frequency to use when sampling the continuous frequency axis. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A near field data set. +GetMediaDataSet (name string) +Returns the data set containing the media information for the given near field. +Input Parameters +name(string) +The full name of the near field. +Return +DataSet +A near field media data set. +GetMediaDataSet (name string, sample number) +Returns the data set containing the media information for the given near field. +Input Parameters +name(string) +The full name of the near field. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A near field media data set. +GetMediaDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set containing the media information for the given near field. +Input Parameters +name(string) +The full name of the near field. +startFreq(number) +The start frequency to use when sampling the continuous frequency axis. +endFreq(number) +The end frequency to use when sampling the continuous frequency axis. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A near field media data set. +GetNames () +Returns a list containing the names of the near fields. +Return +List of string +A list of near field names. +The Network namespace +Network data set functions. +Function List +GetDataSet (name string) +Returns the data set for the given network. (Returns a DataSet object.) +GetDataSet (name string, sample number) +Returns the data set for the given network. (Returns a DataSet object.) +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given network. (Returns a DataSet object.) +GetNames () +Returns a list containing the names of the networks. (Returns a List of string object.) +Function Details +GetDataSet (name string) +Returns the data set for the given network. +Input Parameters +name(string) +The full name of the network. +Return +DataSet +A network data set. +GetDataSet (name string, sample number) +Returns the data set for the given network. +Input Parameters +name(string) +The full name of the network. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A network data set. +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given network. +Input Parameters +name(string) +The full name of the network. +startFreq(number) +The start frequency to use when sampling the continuous frequency axis. +endFreq(number) +The end frequency to use when sampling the continuous frequency axis. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A network data set. +GetNames () +Returns a list containing the names of the networks. +Return +List of string +A list of network names. +The Power namespace +Power data set functions. +Function List +GetDataSet (name string) +Returns the data set for the given power. (Returns a DataSet object.) +GetDataSet (name string, sample number) +Returns the data set for the given power. (Returns a DataSet object.) +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given power. (Returns a DataSet object.) +GetNames () +Returns a list containing the names of the power entities. (Returns a List of string object.) +Function Details +GetDataSet (name string) +Returns the data set for the given power. +Input Parameters +name(string) +The full name of the power. +Return +DataSet +A power data set. +GetDataSet (name string, sample number) +Returns the data set for the given power. +Input Parameters +name(string) +The full name of the power. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A power data set. +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given power. +Input Parameters +name(string) +The full name of the power. +startFreq(number) +The start frequency to use when sampling the continuous frequency axis. +endFreq(number) +The end frequency to use when sampling the continuous frequency axis. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A power data set. +GetNames () +Returns a list containing the names of the power entities. +Return +List of string +A list of power names. +The SAR namespace +SAR data set functions. +Function List +GetDataSet (name string) +Returns the data set for the given SAR. (Returns a DataSet object.) +GetDataSet (name string, sample number) +Returns the data set for the given SAR. (Returns a DataSet object.) +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given SAR. (Returns a DataSet object.) +GetNames () +Returns a list containing the names of the SAR entities. (Returns a List of string object.) +Function Details +GetDataSet (name string) +Returns the data set for the given SAR. +Input Parameters +name(string) +The full name of the SAR. +Return +DataSet +A SAR data set. +GetDataSet (name string, sample number) +Returns the data set for the given SAR. +Input Parameters +name(string) +The full name of the SAR. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A SAR data set. +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given SAR. +Input Parameters +name(string) +The full name of the SAR. +startFreq(number) +The start frequency to use when sampling the continuous frequency axis. +endFreq(number) +The end frequency to use when sampling the continuous frequency axis. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A SAR data set. +GetNames () +Returns a list containing the names of the SAR entities. +Return +List of string +A list of SAR names. +The SParameter namespace +S-parameter data set functions. +Function List +GetDataSet (name string) +Returns the data set for the given S-parameter. (Returns a DataSet object.) +GetDataSet (name string, sample number) +Returns the data set for the given S-parameter. (Returns a DataSet object.) +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given S-parameter. (Returns a DataSet object.) +GetNames () +Returns a list containing the names of the S-parameters. (Returns a List of string object.) +Function Details +GetDataSet (name string) +Returns the data set for the given S-parameter. +Input Parameters +name(string) +The full name of the S-parameter. +Return +DataSet +A S-parameter data set. +GetDataSet (name string, sample number) +Returns the data set for the given S-parameter. +Input Parameters +name(string) +The full name of the S-parameter. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A S-parameter data set. +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given S-parameter. +Input Parameters +name(string) +The full name of the S-parameter. +startFreq(number) +The start frequency to use when sampling the continuous frequency axis. +endFreq(number) +The end frequency to use when sampling the continuous frequency axis. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A S-parameter data set. +GetNames () +Returns a list containing the names of the S-parameters. +Return +List of string +A list of S-parameter names. +The SurfaceCurrentsAndCharges namespace +Surface currents and charges data set functions. +Function List +GetDataSet (name string) +Returns the currents and charges data set for the given currents and charges . (Returns a +DataSet object.) +GetDataSet (name string, sample number) +Returns the currents and charges data set for the given currents and charges. (Returns a DataSet +object.) +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the currents data set for the given currents. (Returns a DataSet object.) +GetNames () +Returns a list containing the names of the surface currents and charges. (Returns a List of string +object.) +Function Details +GetDataSet (name string) +Returns the currents and charges data set for the given currents and charges . +Input Parameters +name(string) +The full name of the currents and charges. +Return +DataSet +A currents and charges data set. +GetDataSet (name string, sample number) +Returns the currents and charges data set for the given currents and charges. +Input Parameters +name(string) +The full name of the currents and charges. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A currents and charges data set. +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the currents data set for the given currents. +Input Parameters +name(string) +The full name of the currents. +startFreq(number) +The start frequency to use when sampling the continuous frequency axis. +endFreq(number) +The end frequency to use when sampling the continuous frequency axis. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A currents and charges data set. +GetNames () +Returns a list containing the names of the surface currents and charges. +Return +List of string +A list of current and charges names. +Altair Feko 2022.3 +2 Application Programming Interface (API) +The TRCoefficients namespace +Transmission/reflection coefficient data set functions. +Function List +GetDataSet (name string) +p.4323 +Returns the data set for the given transmission/reflection coefficient. (Returns a DataSet object.) +GetDataSet (name string, sample number) +Returns the data set for the given transmission/reflection coefficient. (Returns a DataSet object.) +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given transmission/reflection coefficient. (Returns a DataSet object.) +GetNames () +Returns a list containing the names of the transmission/reflection coefficient entities. (Returns a +List of string object.) +Function Details +GetDataSet (name string) +Returns the data set for the given transmission/reflection coefficient. +Input Parameters +name(string) +The full name of the transmission/reflection coefficient. +Return +DataSet +A transmission/reflection coefficient data set. +GetDataSet (name string, sample number) +Returns the data set for the given transmission/reflection coefficient. +Input Parameters +name(string) +The full name of the transmission/reflection coefficient. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A transmission/reflection coefficient data set. +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the data set for the given transmission/reflection coefficient. +Input Parameters +name(string) +The full name of the transmission/reflection coefficient. +startFreq(number) +The start frequency to use when sampling the continuous frequency axis. +endFreq(number) +The end frequency to use when sampling the continuous frequency axis. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A transmission/reflection coefficient data set. +GetNames () +Returns a list containing the names of the transmission/reflection coefficient entities. +Return +List of string +A list of transmission/reflection coefficient names. +The WireCurrentsAndCharges namespace +Wire currents and charges data set functions. +Function List +GetDataSet (name string) +Returns the currents and charges data set for the given currents and charges . (Returns a +DataSet object.) +GetDataSet (name string, sample number) +Returns the currents and charges data set for the given currents and charges. (Returns a DataSet +object.) +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the currents data set for the given currents. (Returns a DataSet object.) +GetNames () +Returns a list containing the names of the wire currents and charges. (Returns a List of string +object.) +Function Details +GetDataSet (name string) +Returns the currents and charges data set for the given currents and charges . +Input Parameters +name(string) +The full name of the currents and charges. +Return +DataSet +A currents and charges data set. +GetDataSet (name string, sample number) +Returns the currents and charges data set for the given currents and charges. +Input Parameters +name(string) +The full name of the currents and charges. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A currents and charges data set. +GetDataSet (name string, startFreq number, endFreq number, sample number) +Returns the currents data set for the given currents. +Input Parameters +name(string) +The full name of the currents. +startFreq(number) +The start frequency to use when sampling the continuous frequency axis. +endFreq(number) +The end frequency to use when sampling the continuous frequency axis. +sample(number) +The sample density for the continuous frequency axis. +Return +DataSet +A currents and charges data set. +GetNames () +Returns a list containing the names of the wire currents and charges. +Return +List of string +A list of current and charges names. +2.2.4 Enumeration Types (API) +Enumerations are lists of values that can be used. The enumerations POSTFEKO are available under the +pf namespace and grouped together under enums. +• AngularRangeEnum +• AnimationFormatEnum +• AnimationQualityEnum +• AnimationTypeEnum +• AnnotationBandwidthTypeEnum +• AnnotationBeamwidthTypeEnum +• AnnotationRelativeTypeEnum +• AnnotationWidthDefinitionTypeEnum +• AnnotationWidthTypeEnum +• AxesScaleEnum +• AxesTickMarkSpacingEnum +• CharacteristicModeQuantityTypeEnum +• ColourEnum +• ComplexComponentEnum +• ContourTypeEnum +• ContourValueTypeEnum +• CurrentsExportTypeEnum +• DataSetAxisEnum +• DataSetQuantityTypeEnum +• ErrorEstimateQuantityTypeEnum +• FarFieldQuantityComponentEnum +• FarFieldQuantityTypeEnum +• FarFieldsExportTypeEnum +• FormDataSelectorType +• FormLayoutEnum +• FormSeparatorEnum +• FrequencyUnitEnum +• GraphLegendPositionEnum +• GridTypeEnum +• ImpedanceQuantityTypeEnum +• ImportFileTypeEnum +• LineStyleEnum +• LinearScaleRangeTypeEnum +• LoadingTypeEnum +• LockedAspectRatioEnum +• LogScaleRangeTypeEnum +• MarkerPlacementEnum +• MarkerSymbolEnum +• MathScriptTypeEnum +• MeshColouringOptionsEnum +• MeshHighlightingOptionsEnum +• NearFieldQuantityTypeEnum +• NearFieldsExportTypeEnum +• NetworkParameterFormatEnum +• NetworkParameterTypeEnum +• NetworkQuantityTypeEnum +• NormalisationMethodEnum +• NumberFormatEnum +• ParallelAuthenticationMethodEnum +• PlotSamplingMethodEnum +• PolarGraphDirectionEnum +• PolarGraphOrientationEnum +• PolarisationTypeEnum +• PowerQuantityTypeEnum +• PowerScaleSettingsEnum +• ProcessPriorityTypeEnum +• RayFieldTypeEnum +• RayTypeEnum +• ReceivingAntennaQuantityTypeEnum +• RemoteExecutionMethodEnum +• ReportDocumentTypeEnum +• ReportImageSizeEnum +• ReportOrientationEnum +• RequestPointsDisplayTypeEnum +• RequestsVisualisationTypeEnum +• SARQuantityTypeEnum +• SamplingMethodEnum +• SinglePointAnnotationTypeEnum +• SourcesScaleTypeEnum +• SpiceProbeValueTypeEnum +• StoredDataTypeEnum +• SurfaceCurrentsQuantityTypeEnum +• TRCoefficientQuantityTypeEnum +• TextDirectionEnum +Altair Feko 2022.3 +2 Application Programming Interface (API) +• ViewDirectionEnum +• ViewLegendPositionEnum +• WireCurrentsQuantityTypeEnum +• WireCurrentsSortEnum +p.4329 +Altair Feko 2022.3 +2 Application Programming Interface (API) +AngularRangeEnum +Enumeration Option List +The AngularRangeEnum enumeration is accessed as illustrated below. +pf.Enums.AngularRangeEnum. +p.4330 +Auto +Auto +From0to180 +From0to180 +From0to360 +From0to360 +From0to90and270to360 +From0to90and270to360 +From180to360 +From180to360 +From90to270 +From90to270 +Altair Feko 2022.3 +2 Application Programming Interface (API) +AnimationFormatEnum +Enumeration Option List +The AnimationFormatEnum enumeration is accessed as illustrated below. +pf.Enums.AnimationFormatEnum. +p.4331 +AVI +GIF +MKV +MOV +AVI +GIF +MKV +MOV +Altair Feko 2022.3 +2 Application Programming Interface (API) +AnimationQualityEnum +Enumeration Option List +The AnimationQualityEnum enumeration is accessed as illustrated below. +pf.Enums.AnimationQualityEnum. +p.4332 +High +Low +High +Low +Normal +Normal +Altair Feko 2022.3 +2 Application Programming Interface (API) +AnimationTypeEnum +Enumeration Option List +The AnimationTypeEnum enumeration is accessed as illustrated below. +pf.Enums.AnimationTypeEnum. +p.4333 +Frequency +Frequency +Phase +Phase +PhiRotate +PhiRotate +ThetaAndPhiRotate +ThetaAndPhiRotate +ThetaRotate +ThetaRotate +TimeStep +TimeStep +Altair Feko 2022.3 +2 Application Programming Interface (API) +AnnotationBandwidthTypeEnum +Enumeration Option List +The AnnotationBandwidthTypeEnum enumeration is accessed as illustrated below. +pf.Enums.AnnotationBandwidthTypeEnum. +p.4334 +PassiveReflection +PassiveReflection +PassiveTransmission +PassiveTransmission +Altair Feko 2022.3 +2 Application Programming Interface (API) +AnnotationBeamwidthTypeEnum +Enumeration Option List +The AnnotationBeamwidthTypeEnum enumeration is accessed as illustrated below. +pf.Enums.AnnotationBeamwidthTypeEnum. +p.4335 +FirstNullBeamwidth +FirstNullBeamwidth +HalfPowerBeamwidth +HalfPowerBeamwidth +NullToNullBeamwidth +NullToNullBeamwidth +Altair Feko 2022.3 +2 Application Programming Interface (API) +AnnotationRelativeTypeEnum +Enumeration Option List +The AnnotationRelativeTypeEnum enumeration is accessed as illustrated below. +pf.Enums.AnnotationRelativeTypeEnum. +p.4336 +RelativeToGlobalMax +RelativeToGlobalMax +RelativeToGlobalMin +RelativeToGlobalMin +AnnotationWidthDefinitionTypeEnum +Enumeration Option List +The AnnotationWidthDefinitionTypeEnum enumeration is accessed as illustrated below. +pf.Enums.AnnotationWidthDefinitionTypeEnum. +Conditional +Conditional +Offset +Scale +Offset +Scale +Altair Feko 2022.3 +2 Application Programming Interface (API) +AnnotationWidthTypeEnum +Enumeration Option List +The AnnotationWidthTypeEnum enumeration is accessed as illustrated below. +pf.Enums.AnnotationWidthTypeEnum. +p.4338 +Delta +SLL +Delta +SLL +AxesScaleEnum +Enumeration Option List +The AxesScaleEnum enumeration is accessed as illustrated below. +pf.Enums.AxesScaleEnum. +ScaleWithModel +ScaleWithModel +ScaleWithWindow +ScaleWithWindow +SpecifyLength +SpecifyLength +Altair Feko 2022.3 +2 Application Programming Interface (API) +AxesTickMarkSpacingEnum +Enumeration Option List +The AxesTickMarkSpacingEnum enumeration is accessed as illustrated below. +pf.Enums.AxesTickMarkSpacingEnum. +p.4340 +Auto +Count +Auto +Count +Spacing +Spacing +CharacteristicModeQuantityTypeEnum +Enumeration Option List +The CharacteristicModeQuantityTypeEnum enumeration is accessed as illustrated below. +pf.Enums.CharacteristicModeQuantityTypeEnum. +CharacteristicAngle +CharacteristicAngle +EigenValue +EigenValue +ModalExcitationCoefficient +ModalExcitationCoefficient +ModalSignificance +ModalSignificance +ModalWeightingCoefficient +ModalWeightingCoefficient +Altair Feko 2022.3 +2 Application Programming Interface (API) +ColourEnum +Enumeration Option List +The ColourEnum enumeration is accessed as illustrated below. +pf.Enums.ColourEnum. +p.4342 +Black +Blue +Cyan +Black +Blue +Cyan +DarkBlue +DarkBlue +DarkCyan +DarkCyan +DarkGreen +DarkGreen +DarkGrey +DarkGrey +DarkMagenta +DarkMagenta +DarkRed +DarkRed +DarkYellow +DarkYellow +Green +Grey +Green +Grey +LightGrey +LightGrey +Magenta +Magenta +Red +Red +Transparent +Transparent +White +White +Yellow +Yellow +Altair Feko 2022.3 +2 Application Programming Interface (API) +ComplexComponentEnum +Enumeration Option List +The ComplexComponentEnum enumeration is accessed as illustrated below. +pf.Enums.ComplexComponentEnum. +p.4344 +Imaginary +Imaginary +Instantaneous +Instantaneous +Magnitude +Magnitude +Phase +Real +Phase +Real +Altair Feko 2022.3 +2 Application Programming Interface (API) +ContourTypeEnum +Enumeration Option List +The ContourTypeEnum enumeration is accessed as illustrated below. +pf.Enums.ContourTypeEnum. +SpecifyByCount +SpecifyByCount +SpecifyByValue +SpecifyByValue +p.4345 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ContourValueTypeEnum +Enumeration Option List +The ContourValueTypeEnum enumeration is accessed as illustrated below. +pf.Enums.ContourValueTypeEnum. +p.4346 +ByPercentage +ByPercentage +ByValue +ByValue +Altair Feko 2022.3 +2 Application Programming Interface (API) +CurrentsExportTypeEnum +Enumeration Option List +The CurrentsExportTypeEnum enumeration is accessed as illustrated below. +pf.Enums.CurrentsExportTypeEnum. +p.4347 +Both +Both +Charges +Charges +Currents +Currents +Altair Feko 2022.3 +2 Application Programming Interface (API) +DataSetAxisEnum +Enumeration Option List +The DataSetAxisEnum enumeration is accessed as illustrated below. +pf.Enums.DataSetAxisEnum. +p.4348 +Frequency +Frequency +IncidentPhi +IncidentPhi +IncidentTheta +IncidentTheta +Index +Index +MeshIndex +MeshIndex +Mode +Phi +Mode +Phi +PolarisationAngle +PolarisationAngle +Rho +Rho +Solution +Solution +Theta +Time +Theta +Time +Altair Feko 2022.3 +2 Application Programming Interface (API) +DataSetQuantityTypeEnum +Enumeration Option List +The DataSetQuantityTypeEnum enumeration is accessed as illustrated below. +pf.Enums.DataSetQuantityTypeEnum. +p.4349 +Boolean +Boolean +Complex +Complex +Enum +Enum +Scalar +Scalar +String +String +Altair Feko 2022.3 +2 Application Programming Interface (API) +ErrorEstimateQuantityTypeEnum +Enumeration Option List +The ErrorEstimateQuantityTypeEnum enumeration is accessed as illustrated below. +pf.Enums.ErrorEstimateQuantityTypeEnum. +p.4350 +AllElements +AllElements +Segments +Segments +Tetrahedra +Tetrahedra +Triangles +Triangles +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldQuantityComponentEnum +Enumeration Option List +The FarFieldQuantityComponentEnum enumeration is accessed as illustrated below. +pf.Enums.FarFieldQuantityComponentEnum. +p.4351 +LHC +LHC +Ludwig3Co +Ludwig3Co +Ludwig3Cross +Ludwig3Cross +MajorMinor +MajorMinor +MinorMajor +MinorMajor +Phi +RHC +Phi +RHC +SComp +SComp +Theta +Total +Theta +Total +ZComp +ZComp +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldQuantityTypeEnum +Enumeration Option List +The FarFieldQuantityTypeEnum enumeration is accessed as illustrated below. +pf.Enums.FarFieldQuantityTypeEnum. +p.4352 +AxialRatio +AxialRatio +AxialRatioHanded +AxialRatioHanded +Directivity +Directivity +EField +Gain +EField +Gain +Handedness +Handedness +RCS +RCS +RealisedGain +RealisedGain +TotalRadiatedPower +TotalRadiatedPower +Altair Feko 2022.3 +2 Application Programming Interface (API) +FarFieldsExportTypeEnum +Enumeration Option List +The FarFieldsExportTypeEnum enumeration is accessed as illustrated below. +pf.Enums.FarFieldsExportTypeEnum. +p.4353 +Directivity +Directivity +Gain +RCS +Gain +RCS +RealisedGain +RealisedGain +Unknown +Unknown +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormDataSelectorType +Enumeration Option List +The FormDataSelectorType enumeration is accessed as illustrated below. +pf.Enums.FormDataSelectorType. +p.4354 +CharacteristicMode +CharacteristicMode +CustomData +CustomData +Excitation +Excitation +FarField +FarField +Load +Load +NearField +NearField +Network +Network +Power +Power +SAR +SAR +SParameter +SParameter +TRCoefficient +TRCoefficient +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormLayoutEnum +Enumeration Option List +The FormLayoutEnum enumeration is accessed as illustrated below. +pf.Enums.FormLayoutEnum. +p.4355 +Grid +Grid +Horizontal +Horizontal +Vertical +Vertical +Altair Feko 2022.3 +2 Application Programming Interface (API) +FormSeparatorEnum +Enumeration Option List +The FormSeparatorEnum enumeration is accessed as illustrated below. +pf.Enums.FormSeparatorEnum. +Horizontal +Horizontal +Vertical +Vertical +p.4356 +Altair Feko 2022.3 +2 Application Programming Interface (API) +FrequencyUnitEnum +Enumeration Option List +The FrequencyUnitEnum enumeration is accessed as illustrated below. +pf.Enums.FrequencyUnitEnum. +p.4357 +GHz +Hz +MHz +kHz +GHz +Hz +MHz +kHz +Altair Feko 2022.3 +2 Application Programming Interface (API) +GraphLegendPositionEnum +Enumeration Option List +The GraphLegendPositionEnum enumeration is accessed as illustrated below. +pf.Enums.GraphLegendPositionEnum. +p.4358 +Bottom +Bottom +CustomPosition +CustomPosition +Left +None +Left +None +OverlayBottomLeft +OverlayBottomLeft +OverlayBottomRight +OverlayBottomRight +OverlayTopLeft +OverlayTopLeft +OverlayTopRight +OverlayTopRight +Right +Top +Right +Top +Altair Feko 2022.3 +2 Application Programming Interface (API) +GridTypeEnum +Enumeration Option List +The GridTypeEnum enumeration is accessed as illustrated below. +pf.Enums.GridTypeEnum. +Admittance +Admittance +Impedance +Impedance +p.4359 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ImpedanceQuantityTypeEnum +Enumeration Option List +The ImpedanceQuantityTypeEnum enumeration is accessed as illustrated below. +pf.Enums.ImpedanceQuantityTypeEnum. +p.4360 +Admittance +Admittance +Current +Current +Impedance +Impedance +MismatchLoss +MismatchLoss +MismatchPowerLoss +MismatchPowerLoss +ReflectionCoefficient +ReflectionCoefficient +SourcePower +SourcePower +VSWR +VSWR +Voltage +Voltage +Altair Feko 2022.3 +2 Application Programming Interface (API) +ImportFileTypeEnum +Enumeration Option List +The ImportFileTypeEnum enumeration is accessed as illustrated below. +pf.Enums.ImportFileTypeEnum. +p.4361 +FEKOElectricNearField +FEKOElectricNearField +FEKOFarField +FEKOFarField +FEKOMagneticNearField +FEKOMagneticNearField +FEKONearField +FEKONearField +Touchstone +Touchstone +Altair Feko 2022.3 +2 Application Programming Interface (API) +LineStyleEnum +Enumeration Option List +The LineStyleEnum enumeration is accessed as illustrated below. +pf.Enums.LineStyleEnum. +p.4362 +DashDotDotLine +DashDotDotLine +DashDotLine +DashDotLine +DashLine +DashLine +DotLine +DotLine +NoPen +NoPen +SolidLine +SolidLine +Altair Feko 2022.3 +2 Application Programming Interface (API) +LinearScaleRangeTypeEnum +Enumeration Option List +The LinearScaleRangeTypeEnum enumeration is accessed as illustrated below. +pf.Enums.LinearScaleRangeTypeEnum. +p.4363 +Auto +Fixed +Auto +Fixed +Altair Feko 2022.3 +2 Application Programming Interface (API) +LoadingTypeEnum +Enumeration Option List +The LoadingTypeEnum enumeration is accessed as illustrated below. +pf.Enums.LoadingTypeEnum. +Admittance +Admittance +Impedance +Impedance +p.4364 +Altair Feko 2022.3 +2 Application Programming Interface (API) +LockedAspectRatioEnum +Enumeration Option List +The LockedAspectRatioEnum enumeration is accessed as illustrated below. +pf.Enums.LockedAspectRatioEnum. +p.4365 +Auto +Auto +Off +On +Off +On +Altair Feko 2022.3 +2 Application Programming Interface (API) +LogScaleRangeTypeEnum +Enumeration Option List +The LogScaleRangeTypeEnum enumeration is accessed as illustrated below. +pf.Enums.LogScaleRangeTypeEnum. +p.4366 +Auto +Fixed +Max +Auto +Fixed +Max +Altair Feko 2022.3 +2 Application Programming Interface (API) +MarkerPlacementEnum +Enumeration Option List +The MarkerPlacementEnum enumeration is accessed as illustrated below. +pf.Enums.MarkerPlacementEnum. +p.4367 +CalculatedPoints +CalculatedPoints +DenselySpaced +DenselySpaced +SparselySpaced +SparselySpaced +Altair Feko 2022.3 +2 Application Programming Interface (API) +MarkerSymbolEnum +Enumeration Option List +The MarkerSymbolEnum enumeration is accessed as illustrated below. +pf.Enums.MarkerSymbolEnum. +p.4368 +Circle +Cross +Circle +Cross +Diamond +Diamond +FilledCircle +FilledCircle +FilledDiamond +FilledDiamond +FilledSquare +FilledSquare +FilledTriangle +FilledTriangle +None +None +Square +Square +Triangle +Triangle +Altair Feko 2022.3 +2 Application Programming Interface (API) +MathScriptTypeEnum +Enumeration Option List +The MathScriptTypeEnum enumeration is accessed as illustrated below. +pf.Enums.MathScriptTypeEnum. +p.4369 +Custom +Custom +FarField +FarField +Load +Load +NearField +NearField +Network +Network +Power +Power +SParameter +SParameter +Source +Source +SurfaceCurrentsAndCharges +SurfaceCurrentsAndCharges +TRCoefficient +TRCoefficient +TimeFarField +TimeFarField +TimeLoad +TimeLoad +TimeNearField +TimeNearField +TimeSource +TimeSource +WireCurrentsAndCharges +WireCurrentsAndCharges +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshColouringOptionsEnum +Enumeration Option List +The MeshColouringOptionsEnum enumeration is accessed as illustrated below. +pf.Enums.MeshColouringOptionsEnum. +p.4370 +ElementNormal +ElementNormal +ElementType +ElementType +FaceMedia +FaceMedia +Label +Label +RegionMedia +RegionMedia +Altair Feko 2022.3 +2 Application Programming Interface (API) +MeshHighlightingOptionsEnum +Enumeration Option List +The MeshHighlightingOptionsEnum enumeration is accessed as illustrated below. +pf.Enums.MeshHighlightingOptionsEnum. +p.4371 +Aperture +Aperture +CFIE_MFIE +CFIE_MFIE +Coating +Coating +DielectricSurfaceImpedanceApproximation +DielectricSurfaceImpedanceApproximation +EFIE +FEM +EFIE +FEM +FacetedUTD +FacetedUTD +GeometricalOptics +GeometricalOptics +ImpedanceSheet +ImpedanceSheet +LossyMetal +LossyMetal +None +None +NumericalGreensFunction +NumericalGreensFunction +PhysicalOptics +PhysicalOptics +PhysicalOpticsFockRegions +PhysicalOpticsFockRegions +UTD +VEP +UTD +VEP +Altair Feko 2022.3 +2 Application Programming Interface (API) +WindscreenActiveElements +WindscreenActiveElements +p.4372 +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldQuantityTypeEnum +Enumeration Option List +The NearFieldQuantityTypeEnum enumeration is accessed as illustrated below. +pf.Enums.NearFieldQuantityTypeEnum. +p.4373 +EField +EField +EVectorPotential +EVectorPotential +ElectricFluxDensity +ElectricFluxDensity +HField +HField +HVectorPotential +HVectorPotential +MagneticFluxDensity +MagneticFluxDensity +Poynting +Poynting +SAR +SAR +ScalarEPotential +ScalarEPotential +ScalarEPotentialGradient +ScalarEPotentialGradient +ScalarHPotential +ScalarHPotential +ScalarHPotentialGradient +ScalarHPotentialGradient +Altair Feko 2022.3 +2 Application Programming Interface (API) +NearFieldsExportTypeEnum +Enumeration Option List +The NearFieldsExportTypeEnum enumeration is accessed as illustrated below. +pf.Enums.NearFieldsExportTypeEnum. +p.4374 +Both +Both +Electric +Electric +Magnetic +Magnetic +Altair Feko 2022.3 +2 Application Programming Interface (API) +NetworkParameterFormatEnum +Enumeration Option List +The NetworkParameterFormatEnum enumeration is accessed as illustrated below. +pf.Enums.NetworkParameterFormatEnum. +p.4375 +DB +MA +RI +DB +MA +RI +Altair Feko 2022.3 +2 Application Programming Interface (API) +NetworkParameterTypeEnum +Enumeration Option List +The NetworkParameterTypeEnum enumeration is accessed as illustrated below. +pf.Enums.NetworkParameterTypeEnum. +p.4376 +Admittance +Admittance +Impedance +Impedance +Scattering +Scattering +Altair Feko 2022.3 +2 Application Programming Interface (API) +NetworkQuantityTypeEnum +Enumeration Option List +The NetworkQuantityTypeEnum enumeration is accessed as illustrated below. +pf.Enums.NetworkQuantityTypeEnum. +p.4377 +Current +Current +Impedance +Impedance +InPower +InPower +Power +Power +Voltage +Voltage +Altair Feko 2022.3 +2 Application Programming Interface (API) +NormalisationMethodEnum +Enumeration Option List +The NormalisationMethodEnum enumeration is accessed as illustrated below. +pf.Enums.NormalisationMethodEnum. +p.4378 +AllTraces +AllTraces +IndividualTraces +IndividualTraces +Altair Feko 2022.3 +2 Application Programming Interface (API) +NumberFormatEnum +Enumeration Option List +The NumberFormatEnum enumeration is accessed as illustrated below. +pf.Enums.NumberFormatEnum. +Decimal +Decimal +Scientific +Scientific +p.4379 +ParallelAuthenticationMethodEnum +Enumeration Option List +The ParallelAuthenticationMethodEnum enumeration is accessed as illustrated below. +pf.Enums.ParallelAuthenticationMethodEnum. +Default +Default +None +None +RegistryCredentials +RegistryCredentials +SSPI +SSPI +Altair Feko 2022.3 +2 Application Programming Interface (API) +PlotSamplingMethodEnum +Enumeration Option List +The PlotSamplingMethodEnum enumeration is accessed as illustrated below. +pf.Enums.PlotSamplingMethodEnum. +p.4381 +Auto +Auto +RequestPoints +RequestPoints +SpecifiedResolution +SpecifiedResolution +Altair Feko 2022.3 +2 Application Programming Interface (API) +PolarGraphDirectionEnum +Enumeration Option List +The PolarGraphDirectionEnum enumeration is accessed as illustrated below. +pf.Enums.PolarGraphDirectionEnum. +p.4382 +Anticlockwise +Anticlockwise +Clockwise +Clockwise +Altair Feko 2022.3 +2 Application Programming Interface (API) +PolarGraphOrientationEnum +Enumeration Option List +The PolarGraphOrientationEnum enumeration is accessed as illustrated below. +pf.Enums.PolarGraphOrientationEnum. +p.4383 +Auto +Auto +ZeroAtBottom +ZeroAtBottom +ZeroAtLeft +ZeroAtLeft +ZeroAtRight +ZeroAtRight +ZeroAtTop +ZeroAtTop +Altair Feko 2022.3 +2 Application Programming Interface (API) +PolarisationTypeEnum +Enumeration Option List +The PolarisationTypeEnum enumeration is accessed as illustrated below. +pf.Enums.PolarisationTypeEnum. +p.4384 +CoPolarisation +CoPolarisation +CrossPolarisation +CrossPolarisation +Total +Total +Altair Feko 2022.3 +2 Application Programming Interface (API) +PowerQuantityTypeEnum +Enumeration Option List +The PowerQuantityTypeEnum enumeration is accessed as illustrated below. +pf.Enums.PowerQuantityTypeEnum. +p.4385 +ActivePower +ActivePower +Efficiency +Efficiency +LossPower +LossPower +Altair Feko 2022.3 +2 Application Programming Interface (API) +PowerScaleSettingsEnum +Enumeration Option List +The PowerScaleSettingsEnum enumeration is accessed as illustrated below. +pf.Enums.PowerScaleSettingsEnum. +p.4386 +IncidentPower +IncidentPower +NoPowerScaling +NoPowerScaling +TotalSourcePower +TotalSourcePower +Altair Feko 2022.3 +2 Application Programming Interface (API) +ProcessPriorityTypeEnum +Enumeration Option List +The ProcessPriorityTypeEnum enumeration is accessed as illustrated below. +pf.Enums.ProcessPriorityTypeEnum. +p.4387 +High +High +Highest +Highest +Idle +Low +Idle +Low +Normal +Normal +Altair Feko 2022.3 +2 Application Programming Interface (API) +RayFieldTypeEnum +Enumeration Option List +The RayFieldTypeEnum enumeration is accessed as illustrated below. +pf.Enums.RayFieldTypeEnum. +p.4388 +AllFields +AllFields +FarFieldRequest +FarFieldRequest +NearElectricCoupling +NearElectricCoupling +NearElectricMoM +NearElectricMoM +NearElectricRequest +NearElectricRequest +NearMagneticCoupling +NearMagneticCoupling +NearMagneticMoM +NearMagneticMoM +NearMagneticRequest +NearMagneticRequest +Altair Feko 2022.3 +2 Application Programming Interface (API) +RayTypeEnum +Enumeration Option List +The RayTypeEnum enumeration is accessed as illustrated below. +pf.Enums.RayTypeEnum. +p.4389 +AllRays +AllRays +CornerDiffractionRay +CornerDiffractionRay +CreepingWaveRay +CreepingWaveRay +DirectRay +DirectRay +EdgeWedgeDiffractionRay +EdgeWedgeDiffractionRay +ReflectionRay +ReflectionRay +TransmissionRay +TransmissionRay +ReceivingAntennaQuantityTypeEnum +Enumeration Option List +The ReceivingAntennaQuantityTypeEnum enumeration is accessed as illustrated below. +pf.Enums.ReceivingAntennaQuantityTypeEnum. +ActivePower +ActivePower +Efficiency +Efficiency +LossPower +LossPower +RelativeSignalPhase +RelativeSignalPhase +Altair Feko 2022.3 +2 Application Programming Interface (API) +RemoteExecutionMethodEnum +Enumeration Option List +The RemoteExecutionMethodEnum enumeration is accessed as illustrated below. +pf.Enums.RemoteExecutionMethodEnum. +p.4391 +MPI +MPI +SSH_RSH +SSH_RSH +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReportDocumentTypeEnum +Enumeration Option List +The ReportDocumentTypeEnum enumeration is accessed as illustrated below. +pf.Enums.ReportDocumentTypeEnum. +p.4392 +MSPowerPoint +MSPowerPoint +MSWord +MSWord +PDF +PDF +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReportImageSizeEnum +Enumeration Option List +The ReportImageSizeEnum enumeration is accessed as illustrated below. +pf.Enums.ReportImageSizeEnum. +p.4393 +Custom +Custom +QQVGA +QQVGA +QVGA +SVGA +SXGA +QVGA +SVGA +SXGA +SameAsSource +SameAsSource +VGA +XGA +VGA +XGA +Altair Feko 2022.3 +2 Application Programming Interface (API) +ReportOrientationEnum +Enumeration Option List +The ReportOrientationEnum enumeration is accessed as illustrated below. +pf.Enums.ReportOrientationEnum. +p.4394 +Landscape +Landscape +Portrait +Portrait +Altair Feko 2022.3 +2 Application Programming Interface (API) +RequestPointsDisplayTypeEnum +Enumeration Option List +The RequestPointsDisplayTypeEnum enumeration is accessed as illustrated below. +pf.Enums.RequestPointsDisplayTypeEnum. +p.4395 +Auto +Auto +Off +On +Off +On +Altair Feko 2022.3 +2 Application Programming Interface (API) +RequestsVisualisationTypeEnum +Enumeration Option List +The RequestsVisualisationTypeEnum enumeration is accessed as illustrated below. +pf.Enums.RequestsVisualisationTypeEnum. +p.4396 +Lines +Lines +Points +Points +Surface +Surface +Altair Feko 2022.3 +2 Application Programming Interface (API) +SARQuantityTypeEnum +Enumeration Option List +The SARQuantityTypeEnum enumeration is accessed as illustrated below. +pf.Enums.SARQuantityTypeEnum. +p.4397 +AverageOverRequestedDomain +AverageOverRequestedDomain +AverageOverTotalDomain +AverageOverTotalDomain +PeakSAR +PeakSAR +Altair Feko 2022.3 +2 Application Programming Interface (API) +SamplingMethodEnum +Enumeration Option List +The SamplingMethodEnum enumeration is accessed as illustrated below. +pf.Enums.SamplingMethodEnum. +p.4398 +AutoSample +AutoSample +DiscreteSamples +DiscreteSamples +SpecifiedSamples +SpecifiedSamples +Altair Feko 2022.3 +2 Application Programming Interface (API) +SinglePointAnnotationTypeEnum +Enumeration Option List +The SinglePointAnnotationTypeEnum enumeration is accessed as illustrated below. +pf.Enums.SinglePointAnnotationTypeEnum. +p.4399 +FirstLocalMax +FirstLocalMax +FirstLocalMaxToLeft +FirstLocalMaxToLeft +FirstLocalMaxToRight +FirstLocalMaxToRight +FirstLocalMin +FirstLocalMin +FirstLocalMinToLeft +FirstLocalMinToLeft +FirstLocalMinToRight +FirstLocalMinToRight +GlobalMax +GlobalMax +GlobalMin +GlobalMin +GreatestLocalMax +GreatestLocalMax +GreatestLocalMaxToLeft +GreatestLocalMaxToLeft +GreatestLocalMaxToRight +GreatestLocalMaxToRight +GreatestLocalMin +GreatestLocalMin +GreatestLocalMinToLeft +GreatestLocalMinToLeft +GreatestLocalMinToRight +GreatestLocalMinToRight +IndependentValue +IndependentValue +ValueAtHorizontalPos +ValueAtHorizontalPos +Altair Feko 2022.3 +2 Application Programming Interface (API) +SourcesScaleTypeEnum +Enumeration Option List +The SourcesScaleTypeEnum enumeration is accessed as illustrated below. +pf.Enums.SourcesScaleTypeEnum. +p.4400 +Decibel +Decibel +Linear +Linear +Altair Feko 2022.3 +2 Application Programming Interface (API) +SpiceProbeValueTypeEnum +Enumeration Option List +The SpiceProbeValueTypeEnum enumeration is accessed as illustrated below. +pf.Enums.SpiceProbeValueTypeEnum. +p.4401 +Current +Current +Voltage +Voltage +Altair Feko 2022.3 +2 Application Programming Interface (API) +StoredDataTypeEnum +Enumeration Option List +The StoredDataTypeEnum enumeration is accessed as illustrated below. +pf.Enums.StoredDataTypeEnum. +CharacteristicMode +CharacteristicMode +p.4402 +Custom +Custom +FarField +FarField +Load +Load +NearField +NearField +Network +Network +Power +Power +SParameter +SParameter +Source +Source +SurfaceCurrentsAndCharges +SurfaceCurrentsAndCharges +TRCoefficient +TRCoefficient +TimeFarField +TimeFarField +TimeLoad +TimeLoad +TimeNearField +TimeNearField +TimeSource +TimeSource +WireCurrentsAndCharges +WireCurrentsAndCharges +SurfaceCurrentsQuantityTypeEnum +Enumeration Option List +The SurfaceCurrentsQuantityTypeEnum enumeration is accessed as illustrated below. +pf.Enums.SurfaceCurrentsQuantityTypeEnum. +Charges +Charges +ElectricCurrents +ElectricCurrents +MagneticCurrents +MagneticCurrents +Altair Feko 2022.3 +2 Application Programming Interface (API) +TRCoefficientQuantityTypeEnum +Enumeration Option List +The TRCoefficientQuantityTypeEnum enumeration is accessed as illustrated below. +pf.Enums.TRCoefficientQuantityTypeEnum. +p.4404 +Reflection +Reflection +Transmission +Transmission +Altair Feko 2022.3 +2 Application Programming Interface (API) +TextDirectionEnum +Enumeration Option List +The TextDirectionEnum enumeration is accessed as illustrated below. +pf.Enums.TextDirectionEnum. +p.4405 +Horizontal +Horizontal +Rotate270 +Rotate270 +Rotate90 +Rotate90 +Altair Feko 2022.3 +2 Application Programming Interface (API) +ViewDirectionEnum +Enumeration Option List +The ViewDirectionEnum enumeration is accessed as illustrated below. +pf.Enums.ViewDirectionEnum. +p.4406 +Back +Back +Bottom +Bottom +Front +Front +Isometric +Isometric +Left +Right +Top +Left +Right +Top +Altair Feko 2022.3 +2 Application Programming Interface (API) +ViewLegendPositionEnum +Enumeration Option List +The ViewLegendPositionEnum enumeration is accessed as illustrated below. +pf.Enums.ViewLegendPositionEnum. +p.4407 +BottomLeft +BottomLeft +BottomRight +BottomRight +None +None +TopLeft +TopLeft +TopRight +TopRight +Altair Feko 2022.3 +2 Application Programming Interface (API) +WireCurrentsQuantityTypeEnum +Enumeration Option List +The WireCurrentsQuantityTypeEnum enumeration is accessed as illustrated below. +pf.Enums.WireCurrentsQuantityTypeEnum. +p.4408 +Charges +Charges +Currents +Currents +Altair Feko 2022.3 +2 Application Programming Interface (API) +WireCurrentsSortEnum +Enumeration Option List +The WireCurrentsSortEnum enumeration is accessed as illustrated below. +pf.Enums.WireCurrentsSortEnum. +p.4409 +ByIndex +ByIndex +ByX +ByY +ByZ +ByX +ByY +ByZ +Altair Feko 2022.3 +2 Application Programming Interface (API) +2.2.5 Data Types (API) +Colour +A colour specified in string format. +Expression +An expression is a Lua string containing variables and numbers. Eg: “(1+5)*10”. +p.4410 +List +A Lua table containing a list (or array) of items of the given type. +MagnitudeColour +A colour with an additional option of being specified “ByMagnitude”. +Map +A Lua table mapping a key type to a value type. +Unit +A string containing a unit. Eg: “m/s^2”. +Variant +A value which can be a number, string, boolean, Complex or Point. +boolean +A standard Lua boolean. See Lua documentation for more details. +function +A standard Lua function. See Lua documentation for more details. +number +A standard Lua number. See Lua documentation for more details. +string +A standard Lua string. See Lua documentation for more details. +table +A standard Lua table. See Lua documentation for more details. +2.2.6 Constants (API) +Constants have been defined for use in expressions and calculations. +Constants +The constants are accessed as illustrated below. +pf.Const. +c0 +eps0 +mu0 +pi +zf0 +Speed of light in free space in m/sec. The value of c0 is 299792458.00017601. +Permittivity of free space in F/m. The value of eps0 is 8.8541878176099993e-12. +Permeability of free space in H/m. The value of mu0 is 1.25663706143592e-06. +Mathematical constant pi (Ludolph's number). The value of pi is 3.1415926535897931. +Characteristic impedance of free space in Ohm. The value of zf0 is 376.73031346199201. +Index +Abs (API Method) +Complex (API Object) 317, 2998 +ComplexMatrix (API Object) 3017 +Matrix (API Object) 3495 +Abs (API StaticFunction) +Complex (API Object) 319, 319, 2999, 2999 +ComplexMatrix (API Object) 3020 +Matrix (API Object) 3498 +AbsoluteFilePath (API Property) +Model (API Object) 1278 +ProtectedModel (API Object) 1689 +AbsolutePath (API Property) +Model (API Object) 1278 +ProtectedModel (API Object) 1690 +AbstractAntennaArray (API Object) 62 +AbstractFEMLinePort (API Object) 67 +AbstractIdealSource (API Object) 73 +AbstractMeshEdge (API Object) 78 +AbstractMeshPort (API Object) 81 +AbstractMeshTriangleFace (API Object) 84 +AbstractMeshWire (API Object) 87 +AbstractPointSource (API Object) 90 +AbstractSurfaceCurve (API Object) 96 +AcceleratedSPAIEnabled (API Property) +IterativeSolverSettings (API Object) 1012 +Accept (API Method) +Form (API Object) 699, 3221 +ACISVersion (API Property) +GeometryExporter (API Object) 875 +Acos (API StaticFunction) +Complex (API Object) 319, 3000 +ComplexMatrix (API Object) 3021 +Matrix (API Object) 3498 +Active (API Property) +PortProperties (API Object) 1656 +ADAPTFEKO (API Property) +ComponentLaunchOptions (API Object) 340, 3041 +ADAPTFEKOLaunchOptions (API Object) 58, 2924 +ADAPTFEKOLaunchOptionsList (API Object) 60 +AdaptiveRayLaunchingAccuracy (API Property) +HighFrequencySettings (API Object) 946 +AdaptiveRefinement (API Object) 104 +AdaptiveSamplingEnabled (API Property) +FarFieldAdvancedSettings (API Object) 624 +Add (API Method) +CableConnectorCollection (API Collection) 2296, 2296, 2297, 2297 +CableHarnessCollection (API Collection) 2317, 2317 +CableInstanceCollection (API Collection) 2321, 2321 +CablePathCollection (API Collection) 2326, 2326 +CableProbeCollection (API Collection) 2330, 2330 +CartesianGraphCollection (API Collection) 4101 +CartesianSurfaceGraphCollection (API Collection) 4104 +CurrentsCollection (API Collection) 2368, 2368 +CutplaneCollection (API Collection) 2371 +DataSetAxisCollection (API Collection) 4114, 4114, 4114, 4115, 4115, 4115, 4116, 4116 +DataSetQuantityCollection (API Collection) 4120, 4120 +ErrorEstimationCollection (API Collection) 2385, 2385 +FarFieldCollection (API Collection) 2394, 2394 +FarFieldReceivingAntennaCollection (API Collection) 2400, 2400 +Form (API Object) 699, 700, 3221, 3222 +FormGroupBox (API Object) 742, 742, 3275, 3275 +FormLayout (API Object) 771, 771, 3304, 3304 +FormScrollArea (API Object) 798, 798, 3336, 3336 +MathScriptCollection (API Collection) 4157 +MeshSettingsCollection (API Collection) 2531, 2531 +ModelDecompositionCollection (API Collection) 2547, 2547 +NamedPointCollection (API Collection) 2551 +NearFieldCollection (API Collection) 2555 +NearFieldReceivingAntennaCollection (API Collection) 2565 +OptimisationMaskCollection (API Collection) 2591, 2591 +OptimisationSearchCollection (API Collection) 2595, 2595 +PolarGraphCollection (API Collection) 4197 +ReportsCollection (API Collection) 4211 +Result3DPlotCollection (API Collection) 4215 +ResultSurfacePlotCollection (API Collection) 4237 +ResultTraceCollection (API Collection) 4246 +SARCollection (API Collection) 2623, 2623 +SmithChartCollection (API Collection) 4256 +SphericalModeReceivingAntennaCollection (API Collection) 2659, 2659 +TransmissionReflectionCollection (API Collection) 2679, 2679 +VariableCollection (API Collection) 2687, 2687, 2687, 2687 +ViewCollection (API Collection) 4274, 4274 +WorkplaneCollection (API Collection) 2706, 2706 +WorkSurfaceCollection (API Collection) 2701, 2701, 2701 +Add3DPattern (API Method) +FarFieldCollection (API Collection) 2395 +AddAdaptiveRefinement (API Method) +MeshRefinementRuleCollection (API Collection) 2519, 2519 +AddAlign (API Method) +TransformCollection (API Collection) 2672, 2673 +AddAnalyticalCurve (API Method) +GeometryCollection (API Collection) 2432, 2432 +AddAnalyticalCurveCylindrical (API Method) +GeometryCollection (API Collection) 2433 +AddAnalyticalCurveSpherical (API Method) +GeometryCollection (API Collection) 2433 +AddAnisotropicDielectric (API Method) +AnisotropicDielectricCollection (API Collection) 2284, 2284 +AddArrayElement (API Method) +AntennaArrayCollection (API Collection) 2289, 2289 +AddArrow (API Method) +ResultArrowCollection (API Collection) 4232 +AddBandwidth10dBAnnotation (API Method) +ResultAnnotationCollection (API Collection) 4221 +AddBandwidth15dBAnnotation (API Method) +ResultAnnotationCollection (API Collection) 4221 +AddBandwidth3dBAnnotation (API Method) +ResultAnnotationCollection (API Collection) 4221 +AddBandwidthAnnotation (API Method) +ResultAnnotationCollection (API Collection) 4222 +AddBeamwidthAnnotation (API Method) +ResultAnnotationCollection (API Collection) 4222 +AddBezierCurve (API Method) +GeometryCollection (API Collection) 2434, 2434 +AddBundle (API Method) +CableCrossSectionCollection (API Collection) 2306, 2306 +AddCablePort (API Method) +PortCollection (API Collection) 2600, 2601, 2601 +AddCapacitor (API Method) +CableSchematicComponentCollection (API Collection) 2335, 2336, 2336 +AddCartesian (API Method) +NearFieldCollection (API Collection) 2555 +AddCartesianBoundary (API Method) +NearFieldCollection (API Collection) 2556 +AddCharacterisedSurface (API Method) +CharacterisedSurfaceCollection (API Collection) 2358, 2358 +AddCharacteristicModes (API Method) +SolutionConfigurationCollection (API Collection) 2641 +AddChartImage (API Method) +CartesianGraph (API Object) 2958 +Graph (API Object) 3357 +PolarGraph (API Object) 3677 +SmithChart (API Object) 3835 +AddChartImageForTrace (API Method) +PolarGraph (API Object) 3678 +AddChartImageFromFile (API Method) +CartesianGraph (API Object) 2958 +Graph (API Object) 3358 +PolarGraph (API Object) 3678 +SmithChart (API Object) 3835 +AddChild (API Method) +FormTree (API Object) 808, 3346 +FormTreeItem (API Object) 812, 3350 +AddCircle (API Method) +ResultTextBoxCollection (API Collection) 4241 +AddCoaxial (API Method) +CableCrossSectionCollection (API Collection) 2306 +AddCoaxialUsingDimensions (API Method) +CableCrossSectionCollection (API Collection) 2307 +AddCoaxialUsingDimensionsWithCoating (API Method) +CableCrossSectionCollection (API Collection) 2307 +AddCoaxialUsingPropagationCharacteristics (API Method) +CableCrossSectionCollection (API Collection) 2308 +AddCoaxialUsingPropagationCharacteristicsWithCoating (API Method) +CableCrossSectionCollection (API Collection) 2308 +AddColumn (API Method) +ExpressionTable (API Object) 540 +NurbsControlPointTable (API Object) 1384 +ObjectReferenceTable (API Object) 1431 +ParametricComplexExpressionTable (API Object) 1543 +PointExpressionTable (API Object) 1610 +AddCombinedGoal (API Method) +OptimisationGoalCollection (API Collection) 2584, 2584 +AddComplex (API Method) +LoadCollection (API Collection) 2496 +AddComplexLoad (API Method) +CableSchematicComponentCollection (API Collection) 2336, 2336, 2337 +AddComponent (API Method) +ProtectedModels (API Collection) 2614 +AddComponentFromFile (API Method) +ProtectedModels (API Collection) 2614 +AddCone (API Method) +GeometryCollection (API Collection) 2434, 2435 +AddConeWithAngleAndHeight (API Method) +GeometryCollection (API Collection) 2435 +AddConeWithAngleAndTopCentre (API Method) +GeometryCollection (API Collection) 2436 +AddConeWithTopRadiusAndTopCentre (API Method) +GeometryCollection (API Collection) 2436 +AddConical (API Method) +NearFieldCollection (API Collection) 2557 +AddConstrainedSurface (API Method) +GeometryCollection (API Collection) 2436, 2437 +AddCross (API Method) +GeometryCollection (API Collection) 2437, 2437 +ShapeCollection (API Collection) 2628, 2628 +AddCuboid (API Method) +GeometryCollection (API Collection) 2438, 2438 +AddCuboidAtCentre (API Method) +GeometryCollection (API Collection) 2438 +AddCurrentProbe (API Method) +CableSchematicComponentCollection (API Collection) 2337, 2337 +AddCurrentSource (API Method) +SourceCollection (API Collection) 2648, 2648 +AddCylinder (API Method) +GeometryCollection (API Collection) 2439, 2439 +AddCylinderWithTopCentre (API Method) +GeometryCollection (API Collection) 2439 +AddCylindrical (API Method) +NearFieldCollection (API Collection) 2557 +AddCylindricalArray (API Method) +AntennaArrayCollection (API Collection) 2290, 2290, 2290 +AddCylindricalX (API Method) +NearFieldCollection (API Collection) 2558 +AddCylindricalY (API Method) +NearFieldCollection (API Collection) 2559 +AddDeltaAnnotation (API Method) +ResultAnnotationCollection (API Collection) 4222 +AddDerivedWidthAnnotation (API Method) +ResultAnnotationCollection (API Collection) 4223 +AddDielectric (API Method) +DielectricCollection (API Collection) 2375, 2376, 2376 +AddDoubleHeadArrow (API Method) +ResultArrowCollection (API Collection) 4233 +AddEdgeMeshPort (API Method) +PortCollection (API Collection) 2601, 2601 +AddEdgeMeshPortConnectedToGround (API Method) +PortCollection (API Collection) 2602 +AddEdgePort (API Method) +PortCollection (API Collection) 2602, 2602 +AddEdgePortConnectedToGround (API Method) +PortCollection (API Collection) 2603 +AddElectricDipole (API Method) +SourceCollection (API Collection) 2649, 2649 +AddEllipse (API Method) +GeometryCollection (API Collection) 2440, 2440 +ShapeCollection (API Collection) 2628, 2629 +AddEllipticArc (API Method) +GeometryCollection (API Collection) 2440, 2440 +AddEllipticArcWithAperture (API Method) +GeometryCollection (API Collection) 2441 +AddFarFieldData (API Method) +FieldDataCollection (API Collection) 2404 +AddFarFieldDataUsingKnownFileFormat (API Method) +FieldDataCollection (API Collection) 2405 +AddFarFieldDataUsingStructure (API Method) +FieldDataCollection (API Collection) 2405 +AddFarFieldGoal (API Method) +OptimisationGoalCollection (API Collection) 2585 +AddFarFieldSource (API Method) +SourceCollection (API Collection) 2650, 2650 +AddFEMLineMeshPort (API Method) +PortCollection (API Collection) 2603, 2603 +AddFEMLineMeshPortBetweenPoints (API Method) +PortCollection (API Collection) 2603 +AddFEMLinePort (API Method) +PortCollection (API Collection) 2604, 2604 +AddFEMLinePortBetweenPoints (API Method) +PortCollection (API Collection) 2604 +AddFEMModalMeshPort (API Method) +PortCollection (API Collection) 2604, 2605 +AddFEMModalMeshPortFromPoints (API Method) +PortCollection (API Collection) 2605 +AddFEMModalPort (API Method) +PortCollection (API Collection) 2605, 2606 +AddFEMModalPortFromPoints (API Method) +PortCollection (API Collection) 2606 +AddFEMModalSource (API Method) +SourceCollection (API Collection) 2649, 2649 +AddFirstLocalMaximum (API Method) +ResultAnnotationCollection (API Collection) 4223 +AddFirstLocalMaximumToLeft (API Method) +ResultAnnotationCollection (API Collection) 4223 +AddFirstLocalMaximumToRight (API Method) +ResultAnnotationCollection (API Collection) 4224 +AddFirstLocalMinimum (API Method) +ResultAnnotationCollection (API Collection) 4224 +AddFirstLocalMinimumToLeft (API Method) +ResultAnnotationCollection (API Collection) 4224 +AddFirstLocalMinimumToRight (API Method) +ResultAnnotationCollection (API Collection) 4224 +AddFirstNullBeamwidthAnnotation (API Method) +ResultAnnotationCollection (API Collection) 4225 +AddFittedSpline (API Method) +GeometryCollection (API Collection) 2441, 2441 +AddFlare (API Method) +GeometryCollection (API Collection) 2442, 2442 +AddFlareWithBaseCentreAndFlareAngles (API Method) +GeometryCollection (API Collection) 2443 +AddFlareWithBaseCorner (API Method) +GeometryCollection (API Collection) 2443 +AddFlareWithBaseCornerAndTopCorner (API Method) +GeometryCollection (API Collection) 2444 +AddGeneralNetwork (API Method) +CableSchematicComponentCollection (API Collection) 2337, 2338 +NetworkCollection (API Collection) 2574, 2574 +AddGlobalMaximum (API Method) +ResultAnnotationCollection (API Collection) 4225 +AddGlobalMinimum (API Method) +ResultAnnotationCollection (API Collection) 4225 +AddGreatestLocalMaximum (API Method) +ResultAnnotationCollection (API Collection) 4225 +AddGreatestLocalMaximumToLeft (API Method) +ResultAnnotationCollection (API Collection) 4226 +AddGreatestLocalMaximumToRight (API Method) +ResultAnnotationCollection (API Collection) 4226 +AddGreatestLocalMinimum (API Method) +ResultAnnotationCollection (API Collection) 4226 +AddGreatestLocalMinimumToLeft (API Method) +ResultAnnotationCollection (API Collection) 4227 +AddGreatestLocalMinimumToRight (API Method) +ResultAnnotationCollection (API Collection) 4227 +AddGround (API Method) +CableSchematicComponentCollection (API Collection) 2338, 2338, 2338 +AddHalfPowerBeamwidthAnnotation (API Method) +ResultAnnotationCollection (API Collection) 4227 +AddHelix (API Method) +GeometryCollection (API Collection) 2444, 2444 +AddHelixWithHeight (API Method) +GeometryCollection (API Collection) 2445 +AddHelixWithTurns (API Method) +GeometryCollection (API Collection) 2445 +AddHexagon (API Method) +GeometryCollection (API Collection) 2446, 2446 +ShapeCollection (API Collection) 2629 +AddHorizontalCutUVPlane (API Method) +FarFieldCollection (API Collection) 2395 +AddHyperbolicArc (API Method) +GeometryCollection (API Collection) 2446, 2446 +AddHyperbolicArcAtApertureCentre (API Method) +GeometryCollection (API Collection) 2447 +AddImpedanceGoal (API Method) +OptimisationGoalCollection (API Collection) 2585 +AddImpedanceSheet (API Method) +ImpedanceSheetCollection (API Collection) 2486, 2486, 2486 +AddImpressedCurrent (API Method) +SourceCollection (API Collection) 2650, 2650 +AddIndependentValue (API Method) +ResultAnnotationCollection (API Collection) 4227 +AddInductor (API Method) +CableSchematicComponentCollection (API Collection) 2339, 2339, 2339 +AddLayeredAnisotropicDielectric (API Method) +LayeredDielectricCollection (API Collection) 2491, 2491 +AddLayeredDielectric (API Method) +LayeredDielectricCollection (API Collection) 2491, 2492 +AddLine (API Method) +GeometryCollection (API Collection) 2447, 2448 +ResultArrowCollection (API Collection) 4233 +AddLoad (API Method) +LoadCollection (API Collection) 2496 +AddMagneticDipole (API Method) +SourceCollection (API Collection) 2651, 2651 +AddMathTrace (API Method) +CartesianGraph (API Object) 2958 +PolarGraph (API Object) 3678 +AddMetal (API Method) +MetalCollection (API Collection) 2542, 2543, 2543 +AddMicrostripMeshPort (API Method) +PortCollection (API Collection) 2606, 2606 +AddMicrostripPort (API Method) +PortCollection (API Collection) 2607, 2607 +AddMultiportSParameter (API Method) +SolutionConfigurationCollection (API Collection) 2642 +AddNearFieldDataFileStructure (API Method) +FieldDataCollection (API Collection) 2405 +AddNearFieldDataFullImport (API Method) +FieldDataCollection (API Collection) 2405 +AddNearFieldDataFullImportUsingKnownFileFormat (API Method) +FieldDataCollection (API Collection) 2406 +AddNearFieldGoal (API Method) +OptimisationGoalCollection (API Collection) 2585 +AddNearFieldSource (API Method) +SourceCollection (API Collection) 2651, 2652 +AddNet (API Method) +NetCollection (API Collection) 2569, 2569, 2569 +AddNonConductingElement (API Method) +CableCrossSectionCollection (API Collection) 2309 +AddNonConductingElementFromParameters (API Method) +CableCrossSectionCollection (API Collection) 2309 +AddNullToNullBeamwidthAnnotation (API Method) +ResultAnnotationCollection (API Collection) 4228 +AddNurbsSurface (API Method) +GeometryCollection (API Collection) 2448, 2448 +AddOpenRing (API Method) +GeometryCollection (API Collection) 2448, 2449 +ShapeCollection (API Collection) 2629, 2629 +AddParabolicArc (API Method) +GeometryCollection (API Collection) 2449, 2449 +AddParabolicArcAtApertureCentre (API Method) +GeometryCollection (API Collection) 2450 +AddParabolicArcAtBaseCentre (API Method) +GeometryCollection (API Collection) 2450 +AddParaboloid (API Method) +GeometryCollection (API Collection) 2450, 2451 +AddParallel (API Method) +LoadCollection (API Collection) 2497 +AddPCBCurrentData (API Method) +FieldDataCollection (API Collection) 2406, 2406 +AddPCBSource (API Method) +SourceCollection (API Collection) 2652, 2652 +AddPlanarArray (API Method) +AntennaArrayCollection (API Collection) 2291, 2291 +AddPlane (API Method) +ShapeCollection (API Collection) 2630, 2630 +AddPlaneWave (API Method) +SourceCollection (API Collection) 2652, 2652 +AddPolygon (API Method) +GeometryCollection (API Collection) 2451 +AddPolyline (API Method) +GeometryCollection (API Collection) 2451, 2451 +AddPowerGoal (API Method) +OptimisationGoalCollection (API Collection) 2585 +AddPredefinedCoaxial (API Method) +CableCrossSectionCollection (API Collection) 2309 +AddReceivingAntennaGoal (API Method) +OptimisationGoalCollection (API Collection) 2585 +AddRectangle (API Method) +GeometryCollection (API Collection) 2452, 2452 +ResultTextBoxCollection (API Collection) 4242 +AddRectangleAtCentre (API Method) +GeometryCollection (API Collection) 2452 +AddRequestInPlaneWaveIncidentDirection (API Method) +FarFieldCollection (API Collection) 2395 +AddResistor (API Method) +CableSchematicComponentCollection (API Collection) 2339, 2339, 2340 +AddRibbon (API Method) +CableCrossSectionCollection (API Collection) 2310, 2310 +AddRibbonWithInsulation (API Method) +CableCrossSectionCollection (API Collection) 2310 +AddRing (API Method) +GeometryCollection (API Collection) 2453, 2453 +ShapeCollection (API Collection) 2630, 2631 +AddRotate (API Method) +TransformCollection (API Collection) 2673, 2674 +AddRow (API Method) +ExpressionTable (API Object) 540 +NurbsControlPointTable (API Object) 1384 +ObjectReferenceTable (API Object) 1431 +ParametricComplexExpressionTable (API Object) 1543 +PointExpressionTable (API Object) 1610 +AddSARGoal (API Method) +OptimisationGoalCollection (API Collection) 2586 +AddScale (API Method) +TransformCollection (API Collection) 2674, 2674 +AddSeries (API Method) +LoadCollection (API Collection) 2497 +AddShield (API Method) +CableShieldCollection (API Collection) 2348 +AddSideLobeLevelAnnotation (API Method) +ResultAnnotationCollection (API Collection) 4228 +AddSingleConductor (API Method) +CableCrossSectionCollection (API Collection) 2311, 2311 +AddSingleConductorWithInsulation (API Method) +CableCrossSectionCollection (API Collection) 2311 +AddSingleLayerBraidedDemoulinShield (API Method) +CableShieldCollection (API Collection) 2348 +AddSingleLayerBraidedKleyShield (API Method) +CableShieldCollection (API Collection) 2348 +AddSingleLayerBraidedTyniShield (API Method) +CableShieldCollection (API Collection) 2349 +AddSingleLayerBraidedVanceShield (API Method) +CableShieldCollection (API Collection) 2349 +AddSingleLayerSolidShield (API Method) +CableShieldCollection (API Collection) 2350 +AddSinglePortTouchstone (API Method) +LoadCollection (API Collection) 2497 +AddSolutionCoefficientData (API Method) +FieldDataCollection (API Collection) 2406, 2407 +AddSolutionCoefficientSource (API Method) +SourceCollection (API Collection) 2653, 2653 +AddSParameterGoal (API Method) +OptimisationGoalCollection (API Collection) 2586 +AddSpecifiedPoints (API Method) +NearFieldCollection (API Collection) 2559 +AddSphere (API Method) +GeometryCollection (API Collection) 2453 +AddSpherical (API Method) +NearFieldCollection (API Collection) 2560 +AddSphericalModeDataFromFile (API Method) +FieldDataCollection (API Collection) 2407 +AddSphericalModeDataFullImport (API Method) +FieldDataCollection (API Collection) 2407 +AddSphericalModeDataManuallySpecified (API Method) +FieldDataCollection (API Collection) 2407 +AddSphericalModeSource (API Method) +SourceCollection (API Collection) 2653, 2653 +AddSpheroid (API Method) +GeometryCollection (API Collection) 2453, 2454 +AddSpiceCircuit (API Method) +LoadCollection (API Collection) 2498 +AddSpiceNetwork (API Method) +CableSchematicComponentCollection (API Collection) 2340, 2340 +AddSpiceNetworkFromFile (API Method) +CableSchematicComponentCollection (API Collection) 2341 +AddSpiralCross (API Method) +GeometryCollection (API Collection) 2454, 2454 +ShapeCollection (API Collection) 2631, 2631 +AddSplitRing (API Method) +GeometryCollection (API Collection) 2455, 2455 +ShapeCollection (API Collection) 2631, 2632 +AddSquareGrid (API Method) +FarFieldCollection (API Collection) 2395 +AddStandardConfiguration (API Method) +SolutionConfigurationCollection (API Collection) 2642 +AddStripCross (API Method) +GeometryCollection (API Collection) 2455, 2456 +ShapeCollection (API Collection) 2632, 2632 +AddStripHexagon (API Method) +GeometryCollection (API Collection) 2456, 2456 +ShapeCollection (API Collection) 2633, 2633 +AddSurfaceBezierCurve (API Method) +GeometryCollection (API Collection) 2457, 2457 +AddSurfaceLine (API Method) +GeometryCollection (API Collection) 2458, 2458 +AddSurfaceRegularLines (API Method) +GeometryCollection (API Collection) 2458, 2459 +AddTCross (API Method) +GeometryCollection (API Collection) 2459, 2459 +ShapeCollection (API Collection) 2633, 2633 +AddTextBox (API Method) +ResultTextBoxCollection (API Collection) 4242, 4242 +AddToModel (API Method) +MediaLibrary (API Collection) 2502 +AddToModelWithLabel (API Method) +MediaLibrary (API Collection) 2502 +AddTransformer (API Method) +CableSchematicComponentCollection (API Collection) 2341, 2341 +AddTranslate (API Method) +TransformCollection (API Collection) 2674, 2675 +AddTransmissionLine (API Method) +NetworkCollection (API Collection) 2574, 2575, 2575, 2576 +AddTransmissionReflectionGoal (API Method) +OptimisationGoalCollection (API Collection) 2586 +AddTriangle (API Method) +Mesh (API Object) 1140 +AddTrifilar (API Method) +GeometryCollection (API Collection) 2460, 2460 +ShapeCollection (API Collection) 2634, 2634 +AddTwistedPair (API Method) +CableCrossSectionCollection (API Collection) 2312, 2312 +AddTwistedPairWithInsulation (API Method) +CableCrossSectionCollection (API Collection) 2312 +AddUnitCell (API Method) +UnitCellCollection (API Collection) 2682 +AddValueAtHorizontalPosition (API Method) +ResultAnnotationCollection (API Collection) 4228 +AddVerticalCutUNPlane (API Method) +FarFieldCollection (API Collection) 2395 +AddVerticalCutVNPlane (API Method) +FarFieldCollection (API Collection) 2395 +AddVoltageControlledVoltageSource (API Method) +CableSchematicComponentCollection (API Collection) 2342, 2342, 2342 +AddVoltageProbe (API Method) +CableSchematicComponentCollection (API Collection) 2343, 2343 +AddVoltageSource (API Method) +SourceCollection (API Collection) 2654, 2654 +AddWaveguideMeshPort (API Method) +PortCollection (API Collection) 2607, 2607 +AddWaveguidePort (API Method) +PortCollection (API Collection) 2608, 2608 +AddWaveguideSource (API Method) +SourceCollection (API Collection) 2654, 2654 +AddWindscreen (API Method) +WindscreenCollection (API Collection) 2692, 2692 +AddWireMeshPort (API Method) +PortCollection (API Collection) 2608, 2608 +AddWireMeshPortOnVertex (API Method) +PortCollection (API Collection) 2609 +AddWirePort (API Method) +PortCollection (API Collection) 2609, 2609 +AdmittanceDefinitionMethod (API Property) +ShieldLayerSettings (API Object) 1832 +Advanced (API Property) +FarField (API Object) 618 +FEKOLaunchOptions (API Object) 558, 3154 +Frequency (API Object) 818 +GlobalMeshSettings (API Object) 896 +LocalMeshSettings (API Object) 1072 +MeshSettings (API Object) 1224 +NearField (API Object) 1314 +OptimisationSearch (API Object) 1482 +PREFEKOLaunchOptions (API Object) 1515, 3657 +VoxelSettings (API Object) 2227 +AdvancedSelfIntersectionRemovalEnabled (API Property) +RepairPartsSettings (API Object) 1763 +AdvancedSettings (API Property) +SolverSettings (API Object) 1898 +AdvancedSolverSettings (API Object) 109 +AdvancedSolverSettingsList (API Object) 110 +AdvancedSolverType (API Property) +PreconditionerSettings (API Object) 1668 +Align (API Object) 112 +Alignment (API Property) +PathSweep (API Object) 1560 +AlignmentIndex (API Property) +Loft (API Object) 1084 +AllowDifferentSegmentRadii (API Property) +AbstractMeshWire (API Object) 88 +MeshCurvilinearSegmentWire (API Object) 1153 +MeshCurvilinearWire (API Object) 1166 +MeshSegmentWire (API Object) 1216 +MeshWire (API Object) 1242 +AllRaysSelected (API Property) +RaysQuantity (API Object) 3722 +AmplitudesEnabled (API Property) +Rays3DFormat (API Object) 3719 +AnalysisRestartNumber (API Property) +ADAPTFEKOLaunchOptions (API Object) 58, 2924 +AnalyticalCurve (API Object) 118 +Angle (API Method) +Complex (API Object) 317, 2998 +ComplexMatrix (API Object) 3017 +Matrix (API Object) 3495 +Angle (API Property) +Cone (API Object) 351 +Rotate (API Object) 1785 +Spin (API Object) 1959 +Angle (API StaticFunction) +Complex (API Object) 319, 320, 3000, 3000 +ComplexMatrix (API Object) 3021 +AngleU (API Property) +Flare (API Object) 690 +AngleV (API Property) +Flare (API Object) 690 +AngularAxis (API Property) +PolarGraph (API Object) 3674 +AngularDimension (API Object) 127 +AngularDimensionList (API Object) 128 +AngularFrequencyLowerLimit (API Property) +DielectricModelling (API Object) 473 +AngularFrequencyUpperLimit (API Property) +DielectricModelling (API Object) 474 +AngularGraphAxis (API Object) 2926 +AngularLabelsVisible (API Property) +PolarGridLines (API Object) 3683 +AngularLine (API Property) +PolarGridLines (API Object) 3684 +AngularResolution (API Property) +PlotSamplingFormat (API Object) 3663 +AngularTolerance (API Property) +RepairAndSewFacesSettings (API Object) 1748 +Animation (API Property) +View (API Object) 4039 +AnisotropicDielectric (API Collection) +Media (API Object) 1128 +AnisotropicDielectric (API Object) 130 +AnisotropicDielectricCollection (API Collection) 2282 +AnisotropicDielectricLayers (API Object) 135 +AnisotropicDielectricLayersList (API Object) 137 +AnnotationRelativeType (API Property) +BandwidthAnnotation (API Object) 2944 +BeamwidthAnnotation (API Object) 2949 +GraphAnnotation (API Object) 3363 +ImplicitPointsAnnotation (API Object) 3380 +SimpleAnnotation (API Object) 3825 +WidthAnnotation (API Object) 4067 +Annotations (API Collection) +CartesianGraph (API Object) 2957 +Graph (API Object) 3357 +PolarGraph (API Object) 3677 +SmithChart (API Object) 3834 +AntennaArrayCollection (API Collection) 2287 +AntennaArraySource (API Object) 139 +AntennaArraySourceList (API Object) 141 +ApertureOpacity (API Property) +MeshRendering (API Object) 3546 +ApertureRadius (API Property) +EllipticArc (API Object) 525 +ApertureVisible (API Property) +MeshEdgesFormat (API Object) 3534 +MeshFacesFormat (API Object) 3539 +MeshVerticesFormat (API Object) 3570 +API 9 +Append (API Method) +ADAPTFEKOLaunchOptionsList (API Object) 60 +AdvancedSolverSettingsList (API Object) 110 +AngularDimensionList (API Object) 128 +AnisotropicDielectricLayersList (API Object) 137 +AntennaArraySourceList (API Object) 141 +BasisFunctionGlobalSolverSettingsList (API Object) 155 +BasisFunctionLocalSolverSettingsList (API Object) 159 +CableBundleCableSpecificationList (API Object) 185 +CartesianDescriptionList (API Object) 289 +CartesianRequestPointsList (API Object) 293 +CartesianStructureList (API Object) 297 +CoaxialInsulationLayerList (API Object) 311 +ComplexTensorList (API Object) 337 +CompositeValueHierarchyList (API Object) 347 +ConicalRequestPointsList (API Object) 361 +ConstrainedSurfacePointList (API Object) 375 +CurrentsExportSettingsList (API Object) 407 +CylindricalDescriptionList (API Object) 440 +CylindricalRequestPointsList (API Object) 444 +CylindricalStructureList (API Object) 448 +CylindricalXRequestPointsList (API Object) 452 +CylindricalYRequestPointsList (API Object) 456 +DielectricFrequencyPointList (API Object) 470 +DielectricModellingList (API Object) 477 +DimensionList (API Object) 482 +DomainDecompositionSettingsList (API Object) 486 +ExpressionList (API Object) 538 +FarFieldAdvancedSettingsList (API Object) 626 +FarFieldExportSettingsList (API Object) 636 +FarFieldPBCSettingsList (API Object) 645 +FarFieldSphericalModeSettingsList (API Object) 662 +FDTDBoundarySettingsList (API Object) 548 +FDTDSettingsList (API Object) 551 +FEKOGPUOptionsList (API Object) 555 +FEKOLaunchOptionsList (API Object) 560 +FEKOParallelDiagnosticTestsList (API Object) 564 +FEKOParallelExecutionOptionsList (API Object) 568 +FEKORemoteExecutionOptionsList (API Object) 572 +FEMSettingsList (API Object) 607 +FileReferenceList (API Object) 671 +FrequencyAdvancedSettingsList (API Object) 823 +FrequencyContinuousQuantitiesList (API Object) 828 +FrequencyContinuousSettingsList (API Object) 833 +FrequencyExportSettingsList (API Object) 837 +FrequencyFDTDSettingsList (API Object) 842 +FundamentalModeOptionsList (API Object) 846 +GeneralSolverSettingsList (API Object) 858 +GlobalCoordinatesList (API Object) 893 +GlobalOriginList (API Object) 901 +GlobalPlaneList (API Object) 905 +GlobalVectorList (API Object) 909 +HighFrequencySettingsList (API Object) 951 +IntegralEquationList (API Object) 997 +IsotropicDielectricLayersList (API Object) 1009 +IterativeSolverSettingsList (API Object) 1014 +LocalCoordinateList (API Object) 1065 +LocalInternalCoordinateList (API Object) 1069 +LocalWorkplaneList (API Object) 1080 +MagneticFrequencyPointList (API Object) 1107 +MagneticModellingList (API Object) 1111 +ManuallySpecifiedOrDerivedValueList (API Object) 1118 +MeshAdvancedSettingsList (API Object) 1149 +MetallicFrequencyPointList (API Object) 1259 +MLFMMACASettingsList (API Object) 1093 +MLFMMSolverSettingsList (API Object) 1097 +NearFieldAdvancedSettingsList (API Object) 1323 +NearFieldBoundarySurfaceList (API Object) 1328 +NearFieldExportSettingsList (API Object) 1347 +NormalDimensionList (API Object) 1375 +NurbsControlPointList (API Object) 1382 +ObjectReferenceList (API Object) 1430 +OPTFEKOLaunchOptionsList (API Object) 1397 +OptimisationConstraintList (API Object) 1454 +OptimisationGoalProcessingStepsList (API Object) 1466 +OptimisationMaskValuesList (API Object) 1473 +OptimisationVariableList (API Object) 1491 +OutputFileSolverSettingsList (API Object) 1496 +ParametricComplexExpressionList (API Object) 1541 +ParametricExpressionList (API Object) 1556 +PeriodicBoundaryBeamSquintAngleList (API Object) 1583 +PeriodicBoundaryPhaseShiftList (API Object) 1587 +PlanarSubstrateList (API Object) 1591 +PointAngleRangeList (API Object) 1608 +PointRangeExpressionList (API Object) 1615 +PointRangeList (API Object) 1617 +PolderTensorList (API Object) 1628 +PortPropertiesList (API Object) 1658 +PreconditionerSettingsList (API Object) 1670 +PREFEKOLaunchOptionsList (API Object) 1517 +PREFEKOVariableExportOptionsList (API Object) 1521 +RayContributionsFacetedUTDList (API Object) 1701 +RayContributionsRLGOList (API Object) 1704 +RayContributionsUTDList (API Object) 1709 +ReferenceDirectionList (API Object) 1726 +RLGOFaceAbsorbingSettingsList (API Object) 1696 +ScopeSettingsList (API Object) 1825 +ShieldLayerSettingsList (API Object) 1838 +SimplifyEdgeSettingsList (API Object) 1851 +SimplifyFaceSettingsList (API Object) 1855 +SimplifyPointSettingsList (API Object) 1864 +SimplifyRegionSettingsList (API Object) 1867 +SpecifiedRequestPointsList (API Object) 1905 +SphericalDescriptionList (API Object) 1918 +SphericalModeOptionsList (API Object) 1933 +SphericalRequestPointsList (API Object) 1951 +SphericalStructureList (API Object) 1955 +SurfaceCoordinateList (API Object) 2058 +SurfaceImpedanceFrequencyPointList (API Object) 2062 +UnitCellLayerList (API Object) 2173 +UTDCylinderTerminationTypeList (API Object) 2153 +View3DAxesFormatList (API Object) 2190 +ViewDisplayModeList (API Object) 2194 +ViewRenderingOptionsList (API Object) 2198 +VoxelAdvancedSettingsList (API Object) 2219 +VoxelGridSummaryList (API Object) 2224 +WaveguideModeOptionsList (API Object) 2238 +WindscreenSolutionMethodList (API Object) 2255 +Application (API Object) 143, 2928 +application macro 52 +application macro library +add script 53 +run script 53 +ArmLength (API Property) +SpiralCross (API Object) 1968 +SpiralCrossShape (API Object) 1976 +TCross (API Object) 2094 +TCrossShape (API Object) 2102 +ArmLengthU (API Property) +Cross (API Object) 379 +CrossShape (API Object) 387 +StripCross (API Object) 2017 +StripCrossShape (API Object) 2025 +ArmLengthV (API Property) +Cross (API Object) 379 +CrossShape (API Object) 387 +StripCross (API Object) 2017 +StripCrossShape (API Object) 2025 +ArrayElementsVectorOne (API Property) +FarFieldPBCSettings (API Object) 643 +ArrayElementsVectorTwo (API Property) +FarFieldPBCSettings (API Object) 644 +ArraysVisible (API Property) +ViewDisplayMode (API Object) 2192 +Arrows (API Collection) +CartesianGraph (API Object) 2957 +Graph (API Object) 3357 +PolarGraph (API Object) 3677 +SmithChart (API Object) 3834 +Arrows (API Property) +NearField3DPlot (API Object) 3585 +SurfaceCurrents3DPlot (API Object) 3944 +WireCurrents3DPlot (API Object) 4076 +Arrows3DFormat (API Object) 2936 +ASCIIEnabled (API Property) +CurrentsExportSettings (API Object) 405 +FarFieldExportSettings (API Object) 634 +NearFieldExportSettings (API Object) 1345 +Asin (API StaticFunction) +Complex (API Object) 320, 3000 +ComplexMatrix (API Object) 3021 +Matrix (API Object) 3499 +AspectRatioLimiting (API Property) +VoxelAdvancedSettings (API Object) 2217 +AspectRatioThreshold (API Property) +VoxelAdvancedSettings (API Object) 2217 +Atan (API StaticFunction) +Complex (API Object) 320, 3001 +ComplexMatrix (API Object) 3021 +Matrix (API Object) 3499 +Atan2 (API StaticFunction) +Matrix (API Object) 3499 +Attenuation (API Property) +CableCoaxialCrossSection (API Object) 196 +TransmissionLine (API Object) 2128 +AttenuationFactor (API Property) +DielectricModelling (API Object) 474 +AuthenticationMethod (API Property) +FEKOParallelExecutionOptions (API Object) 566, 3159 +AutoBundleEnabled (API Property) +CableBundleCrossSection (API Object) 189 +AutoCalculateOuterRadius (API Property) +CableBundleCrossSection (API Object) 189 +AutoCaptionEnabled (API Property) +GraphAxisTitle (API Object) 3368 +SurfaceGraphAxisTitle (API Object) 3972 +AutoExtruded (API Property) +CustomData3DFormat (API Object) 3047 +FarField3DFormat (API Object) 3164 +NearField3DFormat (API Object) 3580 +automate process 13 +automation +CADFEKO 10 +POSTFEKO 10 +AutoMergeWires (API Property) +GeometryImporter (API Object) 880 +AutoNumberOfColumns (API Property) +GraphLegend (API Object) 3371 +AutoRangeEnabled (API Property) +AxisRange (API Object) 2941 +SurfaceGraphAxisRange (API Object) 3970 +AutoSignificantDigitsEnabled (API Property) +GraphAxisLabels (API Object) 3366 +SurfaceGraphAxisLabels (API Object) 3968 +AutoSizingEnabled (API Property) +CustomData3DFormat (API Object) 3047 +FarField3DFormat (API Object) 3164 +AutoSpacingEnabled (API Property) +AxisGridSpacing (API Object) 2939 +SurfaceGraphAxisGridSpacing (API Object) 3966 +AutoStitchFaces (API Property) +GeometryImporter (API Object) 880 +AutoTextEnabled (API Property) +BandwidthAnnotation (API Object) 2944 +BeamwidthAnnotation (API Object) 2949 +GraphAnnotation (API Object) 3364 +ImplicitPointsAnnotation (API Object) 3380 +MeshLegendFormat (API Object) 3541 +Plot3DLegendFormat (API Object) 3661 +SimpleAnnotation (API Object) 3825 +SurfaceGraphTextBox (API Object) 3983 +TextBox (API Object) 4013 +TraceLegendFormat (API Object) 4017 +WidthAnnotation (API Object) 4067 +AvailableRoutes (API Property) +CableInstance (API Object) 220 +AverageCurvilinearEdgeLength (API Property) +MeshInfo (API Object) 1189 +ModelMeshInfo (API Object) 1295 +SimulationMeshInfo (API Object) 1871 +AverageCurvilinearSegmentLength (API Property) +MeshInfo (API Object) 1190 +ModelMeshInfo (API Object) 1296 +SimulationMeshInfo (API Object) 1872 +AverageEdgeLength (API Property) +MeshInfo (API Object) 1190 +ModelMeshInfo (API Object) 1296 +SimulationMeshInfo (API Object) 1872 +AverageSegmentLength (API Property) +MeshInfo (API Object) 1190 +ModelMeshInfo (API Object) 1296 +SimulationMeshInfo (API Object) 1872 +AverageTetrahedronEdgeLength (API Property) +MeshInfo (API Object) 1190 +ModelMeshInfo (API Object) 1296 +SimulationMeshInfo (API Object) 1872 +AverageVoxelLength (API Property) +MeshInfo (API Object) 1190 +ModelMeshInfo (API Object) 1296 +SimulationMeshInfo (API Object) 1872 +Axes (API Collection) +DataSet (API Object) 3091 +Axes (API Property) +CharacteristicModeTrace (API Object) 2988 +CustomDataSmithTrace (API Object) 3059 +CustomDataTrace (API Object) 3072 +ExcitationSmithTrace (API Object) 3138 +ExcitationTrace (API Object) 3147 +FarFieldPowerIntegralTrace (API Object) 3190 +FarFieldTrace (API Object) 3212 +LoadSmithTrace (API Object) 3455 +LoadTrace (API Object) 3465 +MathTrace (API Object) 3481 +NearFieldPowerIntegralTrace (API Object) 3605 +NearFieldTrace (API Object) 3630 +NetworkTrace (API Object) 3648 +PowerTrace (API Object) 3701 +ReceivingAntennaTrace (API Object) 3730 +ResultTrace (API Object) 3775 +SARTrace (API Object) 3791 +SParameterTrace (API Object) 3818 +SpiceProbeTrace (API Object) 3938 +TRCoefficientTrace (API Object) 4004 +View (API Object) 4039 +WireCurrentsTrace (API Object) 4094 +Axes3DFormat (API Object) 2938 +Axis (API Property) +Rotate (API Object) 1786 +AxisDirection (API Property) +Spin (API Object) 1959 +AxisGridSpacing (API Object) 2939 +AxisIndex (API Method) +DataSetIndexer (API Object) 3103, 3103 +AxisName (API Method) +DataSetIndexer (API Object) 3103 +AxisNames (API Property) +CharacteristicModeTrace (API Object) 2988 +CustomData3DPlot (API Object) 3050 +CustomDataSmithTrace (API Object) 3059 +CustomDataSurfacePlot (API Object) 3065 +CustomDataTrace (API Object) 3072 +ErrorEstimate3DPlot (API Object) 3114 +ExcitationSmithTrace (API Object) 3138 +ExcitationTrace (API Object) 3148 +FarField3DPlot (API Object) 3168 +FarFieldPowerIntegralTrace (API Object) 3190 +FarFieldSurfacePlot (API Object) 3206 +FarFieldTrace (API Object) 3212 +LoadSmithTrace (API Object) 3455 +LoadTrace (API Object) 3465 +MathTrace (API Object) 3482 +NearField3DPlot (API Object) 3585 +NearFieldPowerIntegralTrace (API Object) 3605 +NearFieldSurfacePlot (API Object) 3623 +NearFieldTrace (API Object) 3630 +NetworkTrace (API Object) 3648 +PowerTrace (API Object) 3701 +Ray3DPlot (API Object) 3713 +ReceivingAntennaTrace (API Object) 3731 +Result3DPlot (API Object) 3747 +ResultPlot (API Object) 3759 +ResultSurfacePlot (API Object) 3763 +ResultTrace (API Object) 3776 +SAR3DPlot (API Object) 3780 +SARTrace (API Object) 3791 +SParameterSurfacePlot (API Object) 3811 +SParameterTrace (API Object) 3818 +SpiceProbeTrace (API Object) 3939 +SurfaceCurrents3DPlot (API Object) 3945 +TRCoefficientTrace (API Object) 4004 +WireCurrents3DPlot (API Object) 4077 +WireCurrentsTrace (API Object) 4094 +AxisRange (API Object) 2941 +AxisUnit (API Method) +DataSetIndexer (API Object) 3103, 3104 +AxisValue (API Method) +DataSetIndexer (API Object) 3104, 3104 +BackColour (API Property) +CartesianGraph (API Object) 2955 +CartesianGraphGrid (API Object) 2962 +FrameFormat (API Object) 3351 +Graph (API Object) 3355 +PolarGraph (API Object) 3674 +PolarGraphGrid (API Object) 3681 +ResultTextBox (API Object) 3768 +SmithChart (API Object) 3832 +SmithChartGrid (API Object) 3838 +SurfaceGraphFrameFormat (API Object) 3976 +BandwidthAnnotation (API Object) 2943 +BandwidthLevel (API Property) +BandwidthAnnotation (API Object) 2945 +BandwidthType (API Property) +BandwidthAnnotation (API Object) 2945 +Base (API Property) +Cylinder (API Object) 423 +Flare (API Object) 690 +Paraboloid (API Object) 1534 +BaseCentre (API Property) +Cone (API Object) 352 +BaseFieldReceivingAntenna (API Object) 148 +BaseRadius (API Property) +Cone (API Object) 352 +Helix (API Object) 926 +BasisFunctionGlobalSolverSettings (API Object) 153 +BasisFunctionGlobalSolverSettingsList (API Object) 155 +BasisFunctionLocalSolverSettings (API Object) 157 +BasisFunctionLocalSolverSettingsList (API Object) 159 +BasisFunctionSettings (API Property) +Face (API Object) 611 +GeneralSolverSettings (API Object) 855 +MeshCurvilinearTriangleFace (API Object) 1160 +MeshPlate (API Object) 1199 +MeshTetrahedronRegion (API Object) 1228 +MeshTriangleFace (API Object) 1234 +Region (API Object) 1729 +batch modification 17 +BeamSquintAngle (API Property) +PeriodicBoundary (API Object) 1575 +BeamwidthAnnotation (API Object) 2948 +BeamwidthType (API Property) +BeamwidthAnnotation (API Object) 2949 +BezierCurve (API Object) 161 +BlockGraphRedraws (API Method) +CartesianGraph (API Object) 2958 +CartesianSurfaceGraph (API Object) 2971 +Graph (API Object) 3358 +PolarGraph (API Object) 3678 +SmithChart (API Object) 3835 +SurfaceGraph (API Object) 3963 +BlockSize (API Property) +IterativeSolverSettings (API Object) 1012 +Boldfaced (API Property) +FontFormat (API Object) 3218 +SurfaceGraphFontFormat (API Object) 3974 +boolean +Lua 15 +Border (API Property) +CartesianGraphGrid (API Object) 2962 +PolarGraphGrid (API Object) 3681 +SmithChartGrid (API Object) 3838 +BottomDepth (API Property) +Flare (API Object) 690 +BottomWidth (API Property) +Flare (API Object) 690 +BoundarySurface (API Property) +NearField (API Object) 1314 +BoundaryType (API Property) +FDTDBoundarySettings (API Object) 547 +BoundingBox (API Property) +AbstractAntennaArray (API Object) 63 +AbstractFEMLinePort (API Object) 68 +AbstractIdealSource (API Object) 74 +AbstractMeshEdge (API Object) 78 +AbstractMeshPort (API Object) 81 +AbstractMeshTriangleFace (API Object) 84 +AbstractPointSource (API Object) 91 +AbstractSurfaceCurve (API Object) 98 +AdaptiveRefinement (API Object) 105 +AnalyticalCurve (API Object) 120 +AntennaArrayCollection (API Collection) 2288 +BaseFieldReceivingAntenna (API Object) 149 +BezierCurve (API Object) 163 +CableConnector (API Object) 202 +CableConnectorCollection (API Collection) 2295 +CableHarness (API Object) 216 +CableInstance (API Object) 220 +CableInstanceCollection (API Collection) 2320 +CablePath (API Object) 228 +CablePathCollection (API Collection) 2325 +CablePathTerminal (API Object) 234 +CablePort (API Object) 237 +Cables (API Object) 280 +Cone (API Object) 352 +ConstrainedSurface (API Object) 366 +Cross (API Object) 379 +Cuboid (API Object) 391 +CurrentSource (API Object) 399 +CustomAntennaArray (API Object) 410 +Cylinder (API Object) 423 +CylindricalAntennaArray (API Object) 432 +Edge (API Object) 490 +EdgeMeshPort (API Object) 496 +EdgePort (API Object) 501 +ElectricDipole (API Object) 506 +Ellipse (API Object) 513 +EllipticArc (API Object) 525 +Face (API Object) 611 +FarField (API Object) 618 +FarFieldReceivingAntenna (API Object) 649 +FarFieldSource (API Object) 655 +FDTDBoundaryConditions (API Object) 543 +FEMLineMeshPort (API Object) 576 +FEMLinePort (API Object) 584 +FEMModalMeshPort (API Object) 591 +FEMModalPort (API Object) 597 +FEMModalSource (API Object) 603 +FittedSpline (API Object) 681 +Flare (API Object) 691 +Geometry (API Object) 868 +GeometryCollection (API Collection) 2431 +GeometryGroup (API Collection) 2475 +Helix (API Object) 926 +Hexagon (API Object) 935 +HyperbolicArc (API Object) 955 +ImpressedCurrent (API Object) 976 +ImprintPoints (API Object) 983 +Intersect (API Object) 1001 +Line (API Object) 1043 +LinearPlanarArray (API Object) 1051 +Load (API Object) 1058 +Loft (API Object) 1084 +MagneticDipole (API Object) 1100 +Mesh (API Object) 1138 +MeshCurvilinearSegmentWire (API Object) 1153 +MeshCurvilinearTriangleFace (API Object) 1160 +MeshCurvilinearWire (API Object) 1166 +MeshCylinder (API Object) 1169 +MeshPlate (API Object) 1199 +MeshRefinementRule (API Object) 1205 +MeshRegion (API Object) 1210 +MeshSegmentWire (API Object) 1216 +MeshTetrahedronRegion (API Object) 1229 +MeshTriangleFace (API Object) 1234 +MeshWire (API Object) 1242 +MicrostripMeshPort (API Object) 1262 +MicrostripPort (API Object) 1267 +Model (API Object) 1279 +ModelContents (API Object) 1286 +ModelDefinitions (API Object) 1290 +NearField (API Object) 1315 +NearFieldReceivingAntenna (API Object) 1356 +NearFieldSource (API Object) 1362 +NurbsSurface (API Object) 1388 +OpenRing (API Object) 1435 +ParabolicArc (API Object) 1525 +Paraboloid (API Object) 1534 +PathSweep (API Object) 1561 +PCBSource (API Object) 1510 +PlaneWave (API Object) 1598 +PointRefinement (API Object) 1620 +Polygon (API Object) 1632 +Polyline (API Object) 1640 +PolylineRefinement (API Object) 1647 +Port (API Object) 1653 +Primitive (API Object) 1674 +ProjectGeometry (API Object) 1682 +ProtectedModel (API Object) 1690 +ProtectedModels (API Collection) 2613 +Rectangle (API Object) 1717 +Region (API Object) 1730 +RepairAndSewFaces (API Object) 1741 +RepairPart (API Object) 1755 +Ring (API Object) 1774 +Simplify (API Object) 1842 +SolutionCoefficientSource (API Object) 1885 +SolutionConfigurationCollection (API Collection) 2639 +SolutionSettings (API Object) 1894 +SourceCollection (API Collection) 2647 +Sphere (API Object) 1909 +SphericalModeReceivingAntenna (API Object) 1937 +SphericalModeSource (API Object) 1944 +Spin (API Object) 1959 +SpiralCross (API Object) 1968 +Split (API Object) 1981 +SplitRing (API Object) 1990 +StandardConfiguration (API Object) 2003 +Stitch (API Object) 2008 +StripCross (API Object) 2017 +StripHexagon (API Object) 2030 +Subtract (API Object) 2041 +SurfaceBezierCurve (API Object) 2049 +SurfaceLine (API Object) 2066 +SurfaceRegularLines (API Object) 2075 +Sweep (API Object) 2085 +TCross (API Object) 2094 +Trifilar (API Object) 2142 +Union (API Object) 2160 +VoltageSource (API Object) 2213 +WaveguideMeshPort (API Object) 2231 +WaveguidePort (API Object) 2241 +WaveguideSource (API Object) 2246 +WireMeshPort (API Object) 2258 +WirePort (API Object) 2263 +WorkSurface (API Object) 2268 +BoundingBoxVisible (API Property) +MeshRendering (API Object) 3546 +NearField3DFormat (API Object) 3581 +Box (API Object) 169 +BoxReferencePoint (API Property) +NearFieldReceivingAntenna (API Object) 1356 +NearFieldSource (API Object) 1363 +BoxSizeSpecificationType (API Property) +MLFMMSolverSettings (API Object) 1096 +BraidFixingMaterialApplied (API Property) +ShieldLayerSettings (API Object) 1833 +BufferOption (API Property) +FDTDBoundarySettings (API Object) 547 +BufferPosition (API Property) +FDTDBoundarySettings (API Object) 547 +BufferSize (API Property) +FDTDBoundarySettings (API Object) 547 +Build (API Property) +Version (API Object) 2186, 4030 +BuildGeometry (API Method) +CrossShape (API Object) 388 +EllipseShape (API Object) 520 +HexagonShape (API Object) 942 +OpenRingShape (API Object) 1444 +PlaneShape (API Object) 1594 +RingShape (API Object) 1783 +Shape (API Object) 1828 +SpiralCrossShape (API Object) 1977 +SplitRingShape (API Object) 1999 +StripCrossShape (API Object) 2026 +StripHexagonShape (API Object) 2037 +TCrossShape (API Object) 2103 +TrifilarShape (API Object) 2149 +UnitCell (API Object) 2169 +BundledCables (API Property) +CableBundleCrossSection (API Object) 189 +Buttons (API Property) +Form (API Object) 698, 3220 +Cable (API Property) +CableBundleCableSpecification (API Object) 183 +CableBundleCableSpecification (API Object) 183 +CableBundleCableSpecificationList (API Object) 185 +CableBundleCrossSection (API Object) 187 +CableCoaxialCrossSection (API Object) 194 +CableConnector (API Object) 200 +CableConnectorCollection (API Collection) 2294 +CableConnectorPin (API Object) 205 +CableConnectorPinCollection (API Collection) 2299 +CableCoupling (API Property) +CableHarness (API Object) 217 +CableCrossSection (API Object) 208 +CableCrossSectionCollection (API Collection) 2303 +CableGeneralNetwork (API Object) 211 +CableHarness (API Object) 215 +CableHarnessCollection (API Collection) 2315 +CableHarnesses (API Collection) +ModelContents (API Object) 1287 +CableInstance (API Object) 219 +CableInstanceCollection (API Collection) 2319 +CableInstances (API Collection) +CableHarness (API Object) 217 +CableNonConductingElementCrossSection (API Object) 223 +CablePath (API Object) 226 +CablePathCollection (API Collection) 2324 +CablePathTerminal (API Object) 233 +CablePerUnitLength (API Property) +OutputFileSolverSettings (API Object) 1494 +CablePerUnitLengthAccuracy (API Property) +CableBundleCrossSection (API Object) 189 +CableCoaxialCrossSection (API Object) 196 +CableCrossSection (API Object) 209 +CableNonConductingElementCrossSection (API Object) 224 +CableRibbonCrossSection (API Object) 246 +CableSingleConductorCrossSection (API Object) 266 +CableTwistedPairCrossSection (API Object) 275 +CablePort (API Object) 236 +CableProbe (API Object) 241 +CableProbeCollection (API Collection) 2328 +CableRibbonCrossSection (API Object) 245 +Cables (API Object) 279 +Cables (API Property) +ModelDefinitions (API Object) 1290 +CableSchematicComponentCollection (API Collection) 2332 +CableSchematicCurrentProbe (API Object) 250 +CableSchematicVoltageProbe (API Object) 254 +CableSegmentCount (API Property) +MeshInfo (API Object) 1190 +ModelMeshInfo (API Object) 1296 +SimulationMeshInfo (API Object) 1872 +CableShield (API Object) 258 +CableShieldCollection (API Collection) 2346 +CableSignal (API Object) 262 +CableSignalCollection (API Collection) 2352 +CableSingleConductorCrossSection (API Object) 265 +CableSpiceNetwork (API Object) 269 +CablesVisible (API Property) +View3DSolutionEntityFormat (API Object) 4057 +CableTwistedPairCrossSection (API Object) 274 +CADFEKO +automation 9 +custom dialog 50 +CalculateArrayElementsEnabled (API Property) +FarFieldPBCSettings (API Object) 644 +CalculatedToleranceUsed (API Property) +Stitch (API Object) 2008 +CalculateElectricFields (API Property) +NearFieldAdvancedSettings (API Object) 1321 +CalculateMagneticFields (API Property) +NearFieldAdvancedSettings (API Object) 1321 +CalculateOrthogonalPolarisationsEnabled (API Property) +PlaneWave (API Object) 1598 +CalculationDirection (API Property) +FarField (API Object) 618 +CalculationEnabled (API Property) +FarFieldSphericalModeSettings (API Object) 660 +CalculationScope (API Property) +Currents (API Object) 403 +ErrorEstimation (API Object) 533 +ScopeSettings (API Object) 1823 +CalculationType (API Property) +NearFieldAdvancedSettings (API Object) 1321 +SAR (API Object) 1791 +Cancel (API Property) +FormButtons (API Object) 703, 3225 +Cancelled (API Property) +FormProgressDialog (API Object) 779, 3317 +Capacitance (API Property) +Capacitor (API Object) 283 +Load (API Object) 1058 +CapacitanceEnabled (API Property) +Load (API Object) 1058 +Capacitor (API Object) 282 +Caption (API Property) +GraphAxisTitle (API Object) 3369 +SurfaceGraphAxisTitle (API Object) 3973 +CaptionIncludesUnit (API Property) +GraphAxisTitle (API Object) 3369 +SurfaceGraphAxisTitle (API Object) 3973 +CartesianDescription (API Object) 287 +CartesianDescription (API Property) +AnalyticalCurve (API Object) 121 +CartesianDescriptionList (API Object) 289 +CartesianGraph (API Object) 2952 +CartesianGraphCollection (API Collection) 4100 +CartesianGraphGrid (API Object) 2962 +CartesianGraphs (API Collection) +Application (API Object) 2931 +CartesianGridLines (API Object) 2964 +CartesianRequestPoints (API Object) 291 +CartesianRequestPoints (API Property) +NearField (API Object) 1315 +CartesianRequestPointsList (API Object) 293 +CartesianStructure (API Object) 295 +CartesianStructure (API Property) +NearFieldDataFileStructure (API Object) 1332 +CartesianStructureList (API Object) 297 +CartesianSurfaceGraph (API Object) 2966 +CartesianSurfaceGraphCollection (API Collection) 4103 +CartesianSurfaceGraphGrid (API Object) 2974 +CartesianSurfaceGraphGridLines (API Object) 2975 +CartesianSurfaceGraphs (API Collection) +Application (API Object) 2931 +CascadeWindows (API Method) +Application (API Object) 2932 +CATIAV5Version (API Property) +GeometryExporter (API Object) 875 +Ceil (API StaticFunction) +Complex (API Object) 320, 3001 +ComplexMatrix (API Object) 3022 +Matrix (API Object) 3499 +Centre (API Property) +Box (API Object) 173 +Cross (API Object) 380 +Ellipse (API Object) 513 +EllipticArc (API Object) 525 +Helix (API Object) 926 +Hexagon (API Object) 935 +HyperbolicArc (API Object) 955 +OpenRing (API Object) 1435 +ParabolicArc (API Object) 1526 +Ring (API Object) 1774 +Sphere (API Object) 1910 +SpiralCross (API Object) 1968 +SplitRing (API Object) 1990 +StripCross (API Object) 2018 +StripHexagon (API Object) 2030 +TCross (API Object) 2094 +Trifilar (API Object) 2142 +CentreOfGravity (API Property) +Edge (API Object) 490 +Face (API Object) 611 +Region (API Object) 1730 +cf 20, 21 +CFIEFactor (API Property) +IntegralEquation (API Object) 995 +CFIEFactorEnabled (API Property) +IntegralEquation (API Object) 995 +CFXModelImporter (API Object) 180 +CFXModelImportSettings (API Object) 175 +CharacterisedSurface (API Collection) +Media (API Object) 1128 +CharacterisedSurface (API Object) 299 +CharacterisedSurfaceCollection (API Collection) 2356 +CharacterisedSurfaceReferenceDirection (API Property) +Face (API Object) 611 +MeshCurvilinearTriangleFace (API Object) 1160 +MeshPlate (API Object) 1199 +MeshTriangleFace (API Object) 1234 +CharacteristicBasisFunctionMethodEnabled (API Property) +GeneralSolverSettings (API Object) 855 +CharacteristicBasisFunctionMethodType (API Property) +GeneralSolverSettings (API Object) 855 +CharacteristicModeCollection (API Collection) 4106 +CharacteristicModeData (API Object) 2977 +CharacteristicModeQuantity (API Object) 2981 +CharacteristicModes (API Collection) +SolutionConfiguration (API Object) 3845 +CharacteristicModes (API Object) 302 +CharacteristicModes (API Property) +CharacteristicModesConfiguration (API Object) 306 +CharacteristicModesConfiguration (API Object) 305 +CharacteristicModeStoredData (API Object) 2983 +CharacteristicModeTrace (API Object) 2986 +Checked (API Property) +FormCheckBox (API Object) 706, 3228 +ChildReferences (API Property) +ImprintPoints (API Object) 983 +Intersect (API Object) 1001 +Loft (API Object) 1085 +PathSweep (API Object) 1561 +ProjectGeometry (API Object) 1682 +RepairAndSewFaces (API Object) 1741 +RepairPart (API Object) 1755 +Simplify (API Object) 1842 +Spin (API Object) 1960 +Split (API Object) 1982 +Stitch (API Object) 2008 +Subtract (API Object) 2041 +Sweep (API Object) 2085 +Union (API Object) 2160 +Children (API Collection) +ImprintPoints (API Object) 985 +Intersect (API Object) 1003 +Loft (API Object) 1086 +PathSweep (API Object) 1563 +ProjectGeometry (API Object) 1684 +RepairAndSewFaces (API Object) 1743 +RepairPart (API Object) 1757 +Simplify (API Object) 1844 +Spin (API Object) 1961 +Split (API Object) 1984 +Stitch (API Object) 2010 +Subtract (API Object) 2043 +Sweep (API Object) 2087 +Union (API Object) 2162 +CircuitName (API Property) +GeneralNetwork (API Object) 850 +Load (API Object) 1058 +Clear (API Method) +ADAPTFEKOLaunchOptionsList (API Object) 60 +AdvancedSolverSettingsList (API Object) 110 +AngularDimensionList (API Object) 128 +AnisotropicDielectricLayersList (API Object) 137 +AntennaArraySourceList (API Object) 141 +BasisFunctionGlobalSolverSettingsList (API Object) 155 +BasisFunctionLocalSolverSettingsList (API Object) 159 +CableBundleCableSpecificationList (API Object) 185 +CartesianDescriptionList (API Object) 289 +CartesianRequestPointsList (API Object) 293 +CartesianStructureList (API Object) 297 +CoaxialInsulationLayerList (API Object) 311 +ComplexTensorList (API Object) 337 +CompositeValueHierarchyList (API Object) 347 +ConicalRequestPointsList (API Object) 361 +ConstrainedSurfacePointList (API Object) 375 +CurrentsExportSettingsList (API Object) 407 +CylindricalDescriptionList (API Object) 440 +CylindricalRequestPointsList (API Object) 444 +CylindricalStructureList (API Object) 448 +CylindricalXRequestPointsList (API Object) 452 +CylindricalYRequestPointsList (API Object) 456 +DielectricFrequencyPointList (API Object) 470 +DielectricModellingList (API Object) 477 +DimensionList (API Object) 482 +DomainDecompositionSettingsList (API Object) 486 +ExpressionList (API Object) 538 +FarFieldAdvancedSettingsList (API Object) 626 +FarFieldExportSettingsList (API Object) 636 +FarFieldPBCSettingsList (API Object) 645 +FarFieldSphericalModeSettingsList (API Object) 662 +FDTDBoundarySettingsList (API Object) 548 +FDTDSettingsList (API Object) 551 +FEKOGPUOptionsList (API Object) 555 +FEKOLaunchOptionsList (API Object) 560 +FEKOParallelDiagnosticTestsList (API Object) 564 +FEKOParallelExecutionOptionsList (API Object) 568 +FEKORemoteExecutionOptionsList (API Object) 572 +FEMSettingsList (API Object) 607 +FileReferenceList (API Object) 671 +FrequencyAdvancedSettingsList (API Object) 823 +FrequencyContinuousQuantitiesList (API Object) 828 +FrequencyContinuousSettingsList (API Object) 833 +FrequencyExportSettingsList (API Object) 837 +FrequencyFDTDSettingsList (API Object) 842 +FundamentalModeOptionsList (API Object) 846 +GeneralSolverSettingsList (API Object) 858 +GlobalCoordinatesList (API Object) 893 +GlobalOriginList (API Object) 901 +GlobalPlaneList (API Object) 905 +GlobalVectorList (API Object) 909 +HighFrequencySettingsList (API Object) 951 +IntegralEquationList (API Object) 997 +IsotropicDielectricLayersList (API Object) 1009 +IterativeSolverSettingsList (API Object) 1014 +LocalCoordinateList (API Object) 1065 +LocalInternalCoordinateList (API Object) 1069 +LocalWorkplaneList (API Object) 1080 +MagneticFrequencyPointList (API Object) 1107 +MagneticModellingList (API Object) 1111 +ManuallySpecifiedOrDerivedValueList (API Object) 1118 +MeshAdvancedSettingsList (API Object) 1149 +MetallicFrequencyPointList (API Object) 1259 +MLFMMACASettingsList (API Object) 1093 +MLFMMSolverSettingsList (API Object) 1097 +NearFieldAdvancedSettingsList (API Object) 1323 +NearFieldBoundarySurfaceList (API Object) 1328 +NearFieldExportSettingsList (API Object) 1347 +NormalDimensionList (API Object) 1375 +NurbsControlPointList (API Object) 1382 +ObjectReferenceList (API Object) 1430 +OPTFEKOLaunchOptionsList (API Object) 1397 +OptimisationConstraintList (API Object) 1454 +OptimisationGoalProcessingStepsList (API Object) 1466 +OptimisationMaskValuesList (API Object) 1473 +OptimisationVariableList (API Object) 1491 +OutputFileSolverSettingsList (API Object) 1496 +ParametricComplexExpressionList (API Object) 1541 +ParametricExpressionList (API Object) 1556 +PeriodicBoundaryBeamSquintAngleList (API Object) 1583 +PeriodicBoundaryPhaseShiftList (API Object) 1587 +PlanarSubstrateList (API Object) 1591 +PointAngleRangeList (API Object) 1608 +PointRangeExpressionList (API Object) 1615 +PointRangeList (API Object) 1617 +PolderTensorList (API Object) 1628 +PortPropertiesList (API Object) 1658 +PreconditionerSettingsList (API Object) 1670 +PREFEKOLaunchOptionsList (API Object) 1517 +PREFEKOVariableExportOptionsList (API Object) 1521 +RayContributionsFacetedUTDList (API Object) 1701 +RayContributionsRLGOList (API Object) 1704 +RayContributionsUTDList (API Object) 1709 +ReferenceDirectionList (API Object) 1726 +RLGOFaceAbsorbingSettingsList (API Object) 1696 +ScopeSettingsList (API Object) 1825 +ShieldLayerSettingsList (API Object) 1838 +SimplifyEdgeSettingsList (API Object) 1851 +SimplifyFaceSettingsList (API Object) 1855 +SimplifyPointSettingsList (API Object) 1864 +SimplifyRegionSettingsList (API Object) 1867 +SpecifiedRequestPointsList (API Object) 1905 +SphericalDescriptionList (API Object) 1918 +SphericalModeOptionsList (API Object) 1933 +SphericalRequestPointsList (API Object) 1951 +SphericalStructureList (API Object) 1955 +SurfaceCoordinateList (API Object) 2058 +SurfaceImpedanceFrequencyPointList (API Object) 2062 +UnitCellLayerList (API Object) 2173 +UTDCylinderTerminationTypeList (API Object) 2153 +View3DAxesFormatList (API Object) 2190 +ViewDisplayModeList (API Object) 2194 +ViewRenderingOptionsList (API Object) 2198 +VoxelAdvancedSettingsList (API Object) 2219 +VoxelGridSummaryList (API Object) 2224 +WaveguideModeOptionsList (API Object) 2238 +WindscreenSolutionMethodList (API Object) 2255 +ClearCallBack (API Method) +FormCheckBox (API Object) 708, 3230 +FormComboBox (API Object) 713, 3235 +FormDataSelector (API Object) 3246 +FormDirectoryBrowser (API Object) 718, 3251 +FormDoubleSpinBox (API Object) 724, 3257 +FormFileBrowser (API Object) 730, 3263 +FormFileSaveAsBrowser (API Object) 736, 3269 +FormIntegerSpinBox (API Object) 753, 3286 +FormLabelledItem (API Object) 766, 3299 +FormLineEdit (API Object) 777, 3310 +FormPushButton (API Object) 786, 3324 +FormRadioButtonGroup (API Object) 792, 3330 +FormTree (API Object) 808, 3346 +Clone (API Method) +DataSet (API Object) 3092 +CloneStructure (API Method) +DataSet (API Object) 3092 +Close (API Method) +Application (API Object) 2932 +CartesianGraph (API Object) 2958 +CartesianSurfaceGraph (API Object) 2971 +Graph (API Object) 3358 +PolarGraph (API Object) 3678 +SmithChart (API Object) 3835 +SurfaceGraph (API Object) 3963 +View (API Object) 4041 +Window (API Object) 4073 +CloseAllWindows (API Method) +Application (API Object) 2932 +CloseProject (API Method) +Application (API Object) 146 +Coated (API Property) +CableBundleCrossSection (API Object) 190 +CableCoaxialCrossSection (API Object) 196 +Coating (API Property) +Edge (API Object) 490 +Face (API Object) 612 +MeshCurvilinearSegmentWire (API Object) 1153 +MeshCurvilinearTriangleFace (API Object) 1161 +MeshPlate (API Object) 1200 +MeshSegmentWire (API Object) 1216 +MeshTriangleFace (API Object) 1234 +CoatingEnabled (API Property) +Edge (API Object) 490 +Face (API Object) 612 +MeshCurvilinearSegmentWire (API Object) 1153 +MeshCurvilinearTriangleFace (API Object) 1161 +MeshPlate (API Object) 1200 +MeshSegmentWire (API Object) 1216 +MeshTriangleFace (API Object) 1235 +CoatingMedium (API Property) +CableBundleCrossSection (API Object) 190 +CableCoaxialCrossSection (API Object) 196 +CoatingsVisible (API Property) +MeshRendering (API Object) 3546 +ViewRenderingOptions (API Object) 2196 +CoatingThickness (API Property) +CableBundleCrossSection (API Object) 190 +CableCoaxialCrossSection (API Object) 197 +Face (API Object) 612 +MeshCurvilinearTriangleFace (API Object) 1161 +MeshPlate (API Object) 1200 +MeshTriangleFace (API Object) 1235 +CoaxialInsulationLayer (API Object) 309 +CoaxialInsulationLayerList (API Object) 311 +CoefficientsComputed (API Property) +CharacteristicModes (API Object) 303 +CollectionOf_DomainEntity (API Collection) 2360 +CollectionOf_Mesh (API Collection) 2363 +Colour (API Property) +AnisotropicDielectric (API Object) 131 +Arrows3DFormat (API Object) 2936 +CharacterisedSurface (API Object) 300 +Contours3DFormat (API Object) 3044 +DefaultMedium (API Object) 459 +Dielectric (API Object) 462 +DielectricBoundaryMedium (API Object) 466 +FontFormat (API Object) 3218 +FreeSpace (API Object) 814 +GraphLineFormat (API Object) 3373 +GroundPlaneMedium (API Object) 920 +ImpedanceSheet (API Object) 968 +IsoSurface3DFormat (API Object) 3395 +LayeredAnisotropicDielectric (API Object) 1030 +LayeredDielectric (API Object) 1033 +LayeredIsotropicDielectric (API Object) 1036 +Medium (API Object) 1132 +Metal (API Object) 1253 +PerfectElectricConductor (API Object) 1568 +PerfectMagneticConductor (API Object) 1571 +RequestPoints3DFormat (API Object) 3744 +SurfaceGraphFontFormat (API Object) 3975 +SurfaceGraphLineFormat (API Object) 3979 +TraceLineFormat (API Object) 4019 +TraceMarkersFormat (API Object) 4021 +Windscreen (API Object) 2250 +Zero (API Object) 2278 +ColouredByMagnitude (API Property) +View3DSourceFormat (API Object) 4060 +ColourOption (API Property) +MeshRendering (API Object) 3547 +ColourStyle (API Property) +ViewRenderingOptions (API Object) 2197 +ColumnCount (API Method) +ExpressionTable (API Object) 540 +NurbsControlPointTable (API Object) 1384 +ObjectReferenceTable (API Object) 1431 +ParametricComplexExpressionTable (API Object) 1543 +PointExpressionTable (API Object) 1610 +ColumnCount (API Property) +ComplexMatrix (API Object) 3016 +Matrix (API Object) 3494 +COM 10 +CombineDataSets (API StaticFunction) +DataSet (API Object) 3095 +CombinedFacesFieldData (API Property) +NearFieldReceivingAntenna (API Object) 1356 +CombineType (API Property) +OptimisationCombination (API Object) 1450 +comma separated values (CSV) 10 +CommandStringCADFEKO (API Property) +Launcher (API Object) 1025 +CommandStringEDITFEKO (API Property) +Launcher (API Object) 1025 +CommandStringFEKO (API Property) +Launcher (API Object) 1025 +CommandStringOPTFEKO (API Property) +Launcher (API Object) 1025 +CommandStringPOSTFEKO (API Property) +Launcher (API Object) 1025 +CommandStringPREFEKO (API Property) +Launcher (API Object) 1025 +comment 14 +CommonRangeEnabled (API Property) +MathTrace (API Object) 3482 +TraceMathExpression (API Object) 4023 +Complex 20 +Complex (API Object) 313, 2993 +ComplexComponent (API Property) +CharacteristicModeQuantity (API Object) 2981 +CustomDataQuantity (API Object) 3056 +ExcitationQuantity (API Object) 3130 +FarFieldQuantity (API Object) 3196 +LoadQuantity (API Object) 3446 +NearFieldQuantity (API Object) 3611 +SParameterQuantity (API Object) 3805 +SpiceProbeQuantity (API Object) 3934 +SurfaceCurrentsQuantity (API Object) 3958 +TRQuantity (API Object) 4010 +WireCurrentsQuantity (API Object) 4090 +ComplexLoad (API Object) 329 +ComplexLoadType (API Property) +ComplexLoad (API Object) 331 +ComplexMatrix 20 +ComplexMatrix (API Object) 3009 +ComplexMatrixIndexer (API Object) 3039 +ComplexTensor (API Object) 335 +ComplexTensor (API Property) +AnisotropicDielectric (API Object) 132 +ComplexTensorList (API Object) 337 +Component (API Property) +FarFieldQuantity (API Object) 3196 +ComponentLaunchOptions (API Object) 339, 3040 +CompositeValue (API Object) 343 +CompositeValueHierarchyList (API Object) 347 +concatenate +Lua 15 +ConcealModel (API Method) +ProtectedModel (API Object) 1691 +Conductivity (API Property) +DielectricFrequencyPoint (API Object) 468 +DielectricModelling (API Object) 474 +Metal (API Object) 1254 +MetallicFrequencyPoint (API Object) 1257 +ConductivityType (API Property) +DielectricModelling (API Object) 474 +Cone (API Object) 349 +ConeTipDiffractions (API Property) +RayContributionsUTD (API Object) 1707 +Configuration (API Property) +CharacteristicModeData (API Object) 2978 +ErrorEstimateData (API Object) 3118 +ExcitationData (API Object) 3124 +FarFieldData (API Object) 3175 +FarFieldPowerIntegralData (API Object) 3184 +FarFieldReceivingAntennaData (API Object) 3199 +LoadCable (API Object) 3410 +LoadCoaxial (API Object) 3414 +LoadComplex (API Object) 3418 +LoadData (API Object) 3422 +LoadDistributed (API Object) 3424 +LoadEdge (API Object) 3427 +LoadFEM (API Object) 3431 +LoadNetwork (API Object) 3438 +LoadParallel (API Object) 3442 +LoadSeries (API Object) 3448 +LoadVertex (API Object) 3471 +LoadVoxel (API Object) 3474 +NearFieldData (API Object) 3591 +NearFieldPowerIntegralData (API Object) 3599 +NearFieldReceivingAntennaData (API Object) 3615 +NetworkData (API Object) 3637 +PowerData (API Object) 3686 +RayData (API Object) 3716 +ReceivingAntennaData (API Object) 3725 +SARData (API Object) 3783 +SourceAperture (API Object) 3848 +SourceCoaxial (API Object) 3852 +SourceCurrentRegion (API Object) 3857 +SourceCurrentSpace (API Object) 3861 +SourceCurrentTriangle (API Object) 3864 +SourceElectricDipole (API Object) 3867 +SourceMagneticDipole (API Object) 3870 +SourceMagneticFrill (API Object) 3874 +SourceModal (API Object) 3879 +SourcePCB (API Object) 3883 +SourcePlaneWave (API Object) 3886 +SourceRadiationPattern (API Object) 3889 +SourceSolutionCoefficient (API Object) 3892 +SourceSphericalModes (API Object) 3895 +SourceVoltageCable (API Object) 3899 +SourceVoltageEdge (API Object) 3904 +SourceVoltageNetwork (API Object) 3909 +SourceVoltageSegment (API Object) 3914 +SourceVoltageVertex (API Object) 3919 +SourceWaveguide (API Object) 3924 +SParameterData (API Object) 3797 +SphericalModesReceivingAntennaData (API Object) 3928 +SpiceProbeData (API Object) 3931 +SurfaceCurrentsData (API Object) 3952 +TransmissionLineData (API Object) 4027 +TRCoefficientData (API Object) 3993 +WireCurrentsData (API Object) 4084 +ConfigurationCollection (API Collection) 4109 +Configurations (API Collection) +Model (API Object) 3578 +Conical (API Property) +DataSetMetaData (API Object) 3107 +ConicalRequestPoints (API Object) 359 +ConicalRequestPoints (API Property) +NearField (API Object) 1315 +ConicalRequestPointsList (API Object) 361 +Conj (API Method) +Complex (API Object) 318, 2998 +ComplexMatrix (API Object) 3017 +Matrix (API Object) 3495 +Conj (API StaticFunction) +Complex (API Object) 321, 321, 3001, 3001 +ComplexMatrix (API Object) 3022 +Conjugate (API Method) +Complex (API Object) 318, 2998 +Conjugate (API StaticFunction) +Complex (API Object) 321, 321, 3001, 3002 +ConnectEndToClosestVertex (API Property) +ImpressedCurrent (API Object) 976 +ConnectivityEnsured (API Property) +VoxelAdvancedSettings (API Object) 2217 +ConnectivityVisible (API Property) +MeshRendering (API Object) 3547 +ViewRenderingOptions (API Object) 2197 +Connectors (API Collection) +CableHarness (API Object) 217 +ConnectorsVisible (API Property) +CableHarness (API Object) 217 +ConstantParameter (API Property) +SurfaceRegularLines (API Object) 2076 +ConstrainedSurface (API Object) 363 +ConstrainedSurfacePoint (API Object) 373 +ConstrainedSurfacePointList (API Object) 375 +ConstrainSurfaceNormalsEnabled (API Property) +SimplifyPartRepresentationSettings (API Object) 1859 +Constraints (API Property) +OptimisationParameters (API Object) 1479 +Contains (API Method) +CartesianGraphCollection (API Collection) 4101 +CartesianSurfaceGraphCollection (API Collection) 4104 +CharacteristicModeCollection (API Collection) 4107 +ConfigurationCollection (API Collection) 4110 +DataSetAxisCollection (API Collection) 4116 +DataSetQuantityCollection (API Collection) 4120 +ErrorEstimateCollection (API Collection) 4123 +ExcitationCollection (API Collection) 4126 +FarFieldCollection (API Collection) 4129 +FarFieldPowerIntegralCollection (API Collection) 4132 +FormGroupBoxItemCollection (API Collection) 2411, 4135 +FormItemCollection (API Collection) 2414, 4138 +FormLayoutItemCollection (API Collection) 2417, 4141 +FormScrollAreaItemCollection (API Collection) 2420, 4145 +ImportedDataCollection (API Collection) 4148 +ImportedDataSetCollection (API Collection) 4151 +LoadCollection (API Collection) 4154 +MathScriptCollection (API Collection) 4157 +MeshCubeRegionCollection (API Collection) 4161 +MeshCurvilinearSegmentWireCollection (API Collection) 4164 +MeshCurvilinearTriangleFaceCollection (API Collection) 4167 +MeshSegmentWireCollection (API Collection) 4170 +MeshTetrahedronRegionCollection (API Collection) 4173 +MeshTriangleFaceCollection (API Collection) 4176 +MeshUnmeshedCylinderRegionCollection (API Collection) 4179 +MeshUnmeshedPolygonFaceCollection (API Collection) 4182 +ModelCollection (API Collection) 4185 +NearFieldCollection (API Collection) 4188 +NearFieldPowerIntegralCollection (API Collection) 4191 +NetworkCollection (API Collection) 4194 +PolarGraphCollection (API Collection) 4197 +PowerCollection (API Collection) 4200 +RayCollection (API Collection) 4203 +ReceivingAntennaCollection (API Collection) 4206 +ReportsCollection (API Collection) 4212 +Result3DPlotCollection (API Collection) 4216 +ResultAnnotationCollection (API Collection) 4229 +ResultArrowCollection (API Collection) 4233 +ResultSurfacePlotCollection (API Collection) 4238 +ResultTextBoxCollection (API Collection) 4243 +ResultTraceCollection (API Collection) 4247 +SARCollection (API Collection) 4250 +SmithChartCollection (API Collection) 4256 +SParameterCollection (API Collection) 4253 +SpiceProbeCollection (API Collection) 4259 +StoredDataCollection (API Collection) 4262 +SurfaceCurrentsCollection (API Collection) 4265 +TransmissionLineCollection (API Collection) 4271 +TRCoefficientCollection (API Collection) 4268 +ViewCollection (API Collection) 4275 +WindowCollection (API Collection) 4278 +WireCurrentsCollection (API Collection) 4281 +Contents (API Property) +Model (API Object) 1279 +Continuous (API Property) +FrequencyAdvancedSettings (API Object) 821 +ContinuousFrequencyAxis (API Property) +CharacteristicModeData (API Object) 2978 +CharacteristicModeStoredData (API Object) 2983 +CustomStoredData (API Object) 3082 +ExcitationMathScript (API Object) 3127 +ExcitationStoredData (API Object) 3144 +FarFieldData (API Object) 3175 +FarFieldMathScript (API Object) 3181 +FarFieldPowerIntegralData (API Object) 3184 +FarFieldPowerIntegralStoredData (API Object) 3186 +FarFieldReceivingAntennaData (API Object) 3199 +FarFieldStoredData (API Object) 3201 +LoadCable (API Object) 3410 +LoadCoaxial (API Object) 3414 +LoadComplex (API Object) 3418 +LoadEdge (API Object) 3427 +LoadFEM (API Object) 3431 +LoadMathScript (API Object) 3435 +LoadNetwork (API Object) 3438 +LoadParallel (API Object) 3442 +LoadSeries (API Object) 3448 +LoadStoredData (API Object) 3460 +LoadVertex (API Object) 3471 +LoadVoxel (API Object) 3475 +ModalExcitationStoredData (API Object) 3574 +NearFieldData (API Object) 3592 +NearFieldMathScript (API Object) 3597 +NearFieldReceivingAntennaData (API Object) 3616 +NearFieldStoredData (API Object) 3618 +NetworkData (API Object) 3637 +NetworkMathScript (API Object) 3641 +NetworkStoredData (API Object) 3643 +PowerData (API Object) 3686 +PowerMathScript (API Object) 3692 +PowerStoredData (API Object) 3696 +ReceivingAntennaData (API Object) 3725 +SARData (API Object) 3783 +SARStoredData (API Object) 3786 +SourceCoaxial (API Object) 3852 +SourceCurrentRegion (API Object) 3857 +SourceMagneticFrill (API Object) 3874 +SourceModal (API Object) 3879 +SourceVoltageCable (API Object) 3899 +SourceVoltageEdge (API Object) 3904 +SourceVoltageNetwork (API Object) 3909 +SourceVoltageSegment (API Object) 3914 +SourceVoltageVertex (API Object) 3919 +SourceWaveguide (API Object) 3924 +SParameterData (API Object) 3798 +SParameterMathScript (API Object) 3802 +SParameterStoredData (API Object) 3807 +SphericalModesReceivingAntennaData (API Object) 3929 +TransmissionLineData (API Object) 4027 +TRCoefficientData (API Object) 3993 +TRCoefficientMathScript (API Object) 3997 +TRCoefficientStoredData (API Object) 4000 +WaveguideExcitationStoredData (API Object) 4062 +ContinuousFrequencySamples (API Property) +View3DAnimationFormat (API Object) 4045 +ContinuousPhiAxis (API Property) +FarFieldData (API Object) 3175 +ContinuousThetaAxis (API Property) +FarFieldData (API Object) 3175 +Contours (API Property) +CustomData3DPlot (API Object) 3050 +FarField3DPlot (API Object) 3168 +NearField3DPlot (API Object) 3585 +SurfaceCurrents3DPlot (API Object) 3945 +Contours3DFormat (API Object) 3043 +ControlPoints (API Property) +NurbsSurface (API Object) 1388 +ConvergenceAccuracy (API Property) +FrequencyContinuousSettings (API Object) 831 +OptimisationSearch (API Object) 1482 +ConvergenceThreshold (API Property) +FrequencyFDTDSettings (API Object) 840 +ConvergenceThresholdEnabled (API Property) +FrequencyFDTDSettings (API Object) 840 +ConversionType (API Property) +MeshImporter (API Object) 1182 +ConvertSurfacesToBlends (API Property) +SimplifyPartRepresentationSettings (API Object) 1859 +ConvertToCustomArray (API Method) +CylindricalAntennaArray (API Object) 434 +LinearPlanarArray (API Object) 1053 +ConvertToPrimitive (API Method) +AbstractSurfaceCurve (API Object) 100 +AnalyticalCurve (API Object) 123 +BezierCurve (API Object) 165 +Cone (API Object) 355 +ConstrainedSurface (API Object) 369 +Cross (API Object) 382 +Cuboid (API Object) 394 +Cylinder (API Object) 426 +Ellipse (API Object) 515 +EllipticArc (API Object) 528 +FittedSpline (API Object) 683 +Flare (API Object) 693 +Geometry (API Object) 870 +Helix (API Object) 929 +Hexagon (API Object) 937 +HyperbolicArc (API Object) 958 +ImprintPoints (API Object) 986 +Intersect (API Object) 1003 +Line (API Object) 1045 +Loft (API Object) 1087 +NurbsSurface (API Object) 1390 +OpenRing (API Object) 1438 +ParabolicArc (API Object) 1528 +Paraboloid (API Object) 1536 +PathSweep (API Object) 1563 +Polygon (API Object) 1634 +Polyline (API Object) 1642 +Primitive (API Object) 1676 +ProjectGeometry (API Object) 1684 +Rectangle (API Object) 1720 +RepairAndSewFaces (API Object) 1743 +RepairPart (API Object) 1757 +Ring (API Object) 1777 +Simplify (API Object) 1845 +Sphere (API Object) 1912 +Spin (API Object) 1962 +SpiralCross (API Object) 1971 +Split (API Object) 1984 +SplitRing (API Object) 1993 +Stitch (API Object) 2011 +StripCross (API Object) 2020 +StripHexagon (API Object) 2032 +Subtract (API Object) 2043 +SurfaceBezierCurve (API Object) 2052 +SurfaceLine (API Object) 2069 +SurfaceRegularLines (API Object) 2079 +Sweep (API Object) 2088 +TCross (API Object) 2097 +Trifilar (API Object) 2144 +Union (API Object) 2162 +CoordinateSystem (API Property) +FarField (API Object) 618 +NearFieldOptimisationGoal (API Object) 1350 +CoordinateType (API Property) +NearFieldDataFileStructure (API Object) 1332 +CopyAndMirror (API Method) +AbstractAntennaArray (API Object) 64 +AbstractFEMLinePort (API Object) 70 +AbstractIdealSource (API Object) 75 +AbstractPointSource (API Object) 93 +AbstractSurfaceCurve (API Object) 100 +AdaptiveRefinement (API Object) 106 +Align (API Object) 114 +AnalyticalCurve (API Object) 123 +BaseFieldReceivingAntenna (API Object) 150 +BezierCurve (API Object) 165 +CablePath (API Object) 230 +Cone (API Object) 355 +ConstrainedSurface (API Object) 369 +Cross (API Object) 382 +Cuboid (API Object) 394 +CustomAntennaArray (API Object) 412 +Cutplane (API Object) 418 +Cylinder (API Object) 426 +CylindricalAntennaArray (API Object) 434 +ElectricDipole (API Object) 508 +Ellipse (API Object) 516 +EllipticArc (API Object) 529 +FarField (API Object) 620 +FarFieldData (API Object) 631 +FarFieldReceivingAntenna (API Object) 650 +FarFieldSource (API Object) 656 +FEMLineMeshPort (API Object) 578 +FEMLinePort (API Object) 586 +FEMModalMeshPort (API Object) 593 +FEMModalPort (API Object) 599 +FieldData (API Object) 666 +FittedSpline (API Object) 683 +Flare (API Object) 694 +Geometry (API Object) 870 +GeometryGroup (API Collection) 2476 +Helix (API Object) 929 +Hexagon (API Object) 938 +HyperbolicArc (API Object) 958 +ImpressedCurrent (API Object) 978 +ImprintPoints (API Object) 986 +Intersect (API Object) 1003 +Line (API Object) 1046 +LinearPlanarArray (API Object) 1053 +Loft (API Object) 1087 +MagneticDipole (API Object) 1102 +Mesh (API Object) 1140 +MeshRefinementRule (API Object) 1206 +Mirror (API Object) 1274 +NamedPoint (API Object) 1308 +NearField (API Object) 1317 +NearFieldDataFileStructure (API Object) 1334 +NearFieldDataFullImport (API Object) 1341 +NearFieldReceivingAntenna (API Object) 1358 +NearFieldSource (API Object) 1364 +NurbsSurface (API Object) 1390 +OpenRing (API Object) 1438 +ParabolicArc (API Object) 1528 +Paraboloid (API Object) 1537 +PathSweep (API Object) 1563 +PCBCurrentData (API Object) 1506 +PCBSource (API Object) 1512 +PeriodicBoundary (API Object) 1577 +PlaneWave (API Object) 1600 +PointRefinement (API Object) 1622 +Polygon (API Object) 1634 +Polyline (API Object) 1642 +PolylineRefinement (API Object) 1649 +Primitive (API Object) 1676 +ProjectGeometry (API Object) 1684 +ProtectedModel (API Object) 1691 +Rectangle (API Object) 1720 +RepairAndSewFaces (API Object) 1743 +RepairPart (API Object) 1757 +Ring (API Object) 1777 +Rotate (API Object) 1787 +Scale (API Object) 1812 +Simplify (API Object) 1845 +SolutionCoefficientData (API Object) 1881 +SolutionCoefficientSource (API Object) 1887 +Sphere (API Object) 1913 +SphericalModeDataFromFile (API Object) 1922 +SphericalModeDataManuallySpecified (API Object) 1927 +SphericalModeReceivingAntenna (API Object) 1939 +SphericalModeSource (API Object) 1945 +Spin (API Object) 1962 +SpiralCross (API Object) 1971 +Split (API Object) 1985 +SplitRing (API Object) 1993 +Stitch (API Object) 2011 +StripCross (API Object) 2020 +StripHexagon (API Object) 2033 +Subtract (API Object) 2043 +SurfaceBezierCurve (API Object) 2052 +SurfaceLine (API Object) 2069 +SurfaceRegularLines (API Object) 2079 +Sweep (API Object) 2088 +TCross (API Object) 2097 +Transform (API Object) 2113 +Translate (API Object) 2123 +Trifilar (API Object) 2145 +Union (API Object) 2162 +Workplane (API Object) 2274 +CopyAndRotate (API Method) +AbstractAntennaArray (API Object) 64, 64 +AbstractFEMLinePort (API Object) 70, 70 +AbstractIdealSource (API Object) 75, 75 +AbstractPointSource (API Object) 93, 93 +AbstractSurfaceCurve (API Object) 100, 101 +AdaptiveRefinement (API Object) 106, 106 +Align (API Object) 115, 115 +AnalyticalCurve (API Object) 124, 124 +BaseFieldReceivingAntenna (API Object) 150, 151 +BezierCurve (API Object) 165, 166 +CablePath (API Object) 231, 231 +Cone (API Object) 355, 355 +ConstrainedSurface (API Object) 369, 369 +Cross (API Object) 382, 382 +Cuboid (API Object) 394, 395 +CustomAntennaArray (API Object) 412, 412 +Cutplane (API Object) 418, 418 +Cylinder (API Object) 426, 427 +CylindricalAntennaArray (API Object) 435, 435 +ElectricDipole (API Object) 508, 508 +Ellipse (API Object) 516, 516 +EllipticArc (API Object) 529, 529 +FarField (API Object) 620, 620 +FarFieldData (API Object) 631, 632 +FarFieldReceivingAntenna (API Object) 651, 651 +FarFieldSource (API Object) 657, 657 +FEMLineMeshPort (API Object) 578, 579 +FEMLinePort (API Object) 586, 587 +FEMModalMeshPort (API Object) 593, 593 +FEMModalPort (API Object) 599, 600 +FieldData (API Object) 666, 667 +FittedSpline (API Object) 683, 684 +Flare (API Object) 694, 694 +Geometry (API Object) 870, 870 +GeometryGroup (API Collection) 2476, 2476 +Helix (API Object) 929, 930 +Hexagon (API Object) 938, 938 +HyperbolicArc (API Object) 959, 959 +ImpressedCurrent (API Object) 978, 978 +ImprintPoints (API Object) 986, 986 +Intersect (API Object) 1004, 1004 +Line (API Object) 1046, 1046 +LinearPlanarArray (API Object) 1053, 1053 +Loft (API Object) 1087, 1088 +MagneticDipole (API Object) 1102, 1103 +Mesh (API Object) 1140, 1140 +MeshRefinementRule (API Object) 1206, 1207 +Mirror (API Object) 1274, 1274 +NamedPoint (API Object) 1308, 1309 +NearField (API Object) 1317, 1318 +NearFieldDataFileStructure (API Object) 1335, 1335 +NearFieldDataFullImport (API Object) 1342, 1342 +NearFieldReceivingAntenna (API Object) 1358, 1358 +NearFieldSource (API Object) 1364, 1365 +NurbsSurface (API Object) 1391, 1391 +OpenRing (API Object) 1438, 1439 +ParabolicArc (API Object) 1529, 1529 +Paraboloid (API Object) 1537, 1537 +PathSweep (API Object) 1564, 1564 +PCBCurrentData (API Object) 1506, 1506 +PCBSource (API Object) 1512, 1512 +PeriodicBoundary (API Object) 1577, 1578 +PlaneWave (API Object) 1600, 1600 +PointRefinement (API Object) 1622, 1622 +Polygon (API Object) 1634, 1635 +Polyline (API Object) 1642, 1643 +PolylineRefinement (API Object) 1649, 1649 +Primitive (API Object) 1676, 1676 +ProjectGeometry (API Object) 1685, 1685 +ProtectedModel (API Object) 1691, 1691 +Rectangle (API Object) 1720, 1720 +RepairAndSewFaces (API Object) 1744, 1744 +RepairPart (API Object) 1758, 1758 +Ring (API Object) 1777, 1777 +Rotate (API Object) 1787, 1787 +Scale (API Object) 1812, 1813 +Simplify (API Object) 1846, 1846 +SolutionCoefficientData (API Object) 1882, 1882 +SolutionCoefficientSource (API Object) 1887, 1887 +Sphere (API Object) 1913, 1913 +SphericalModeDataFromFile (API Object) 1923, 1923 +SphericalModeDataManuallySpecified (API Object) 1927, 1928 +SphericalModeReceivingAntenna (API Object) 1939, 1939 +SphericalModeSource (API Object) 1946, 1946 +Spin (API Object) 1962, 1963 +SpiralCross (API Object) 1971, 1972 +Split (API Object) 1985, 1985 +SplitRing (API Object) 1993, 1994 +Stitch (API Object) 2011, 2011 +StripCross (API Object) 2020, 2021 +StripHexagon (API Object) 2033, 2033 +Subtract (API Object) 2044, 2044 +SurfaceBezierCurve (API Object) 2052, 2053 +SurfaceLine (API Object) 2069, 2069 +SurfaceRegularLines (API Object) 2079, 2079 +Sweep (API Object) 2088, 2088 +TCross (API Object) 2097, 2097 +Transform (API Object) 2113, 2113 +Translate (API Object) 2123, 2124 +Trifilar (API Object) 2145, 2145 +Union (API Object) 2163, 2163 +Workplane (API Object) 2274, 2274 +CopyAndTranslate (API Method) +AbstractAntennaArray (API Object) 65, 65 +AbstractFEMLinePort (API Object) 71, 71 +AbstractIdealSource (API Object) 76, 76 +AbstractPointSource (API Object) 94, 94 +AbstractSurfaceCurve (API Object) 101, 101 +AdaptiveRefinement (API Object) 107, 107 +Align (API Object) 115, 116 +AnalyticalCurve (API Object) 124, 125 +BaseFieldReceivingAntenna (API Object) 151, 151 +BezierCurve (API Object) 166, 166 +CablePath (API Object) 231, 231 +Cone (API Object) 356, 356 +ConstrainedSurface (API Object) 370, 370 +Cross (API Object) 383, 383 +Cuboid (API Object) 395, 395 +CustomAntennaArray (API Object) 413, 413 +Cutplane (API Object) 419, 419 +Cylinder (API Object) 427, 427 +CylindricalAntennaArray (API Object) 435, 436 +ElectricDipole (API Object) 509, 509 +Ellipse (API Object) 517, 517 +EllipticArc (API Object) 529, 530 +FarField (API Object) 621, 621 +FarFieldData (API Object) 632, 632 +FarFieldReceivingAntenna (API Object) 651, 651 +FarFieldSource (API Object) 657, 658 +FEMLineMeshPort (API Object) 579, 579 +FEMLinePort (API Object) 587, 587 +FEMModalMeshPort (API Object) 594, 594 +FEMModalPort (API Object) 600, 600 +FieldData (API Object) 667, 667 +FittedSpline (API Object) 684, 684 +Flare (API Object) 695, 695 +Geometry (API Object) 871, 871 +GeometryGroup (API Collection) 2476, 2477 +Helix (API Object) 930, 930 +Hexagon (API Object) 938, 939 +HyperbolicArc (API Object) 959, 959 +ImpressedCurrent (API Object) 979, 979 +ImprintPoints (API Object) 987, 987 +Intersect (API Object) 1004, 1005 +Line (API Object) 1046, 1047 +LinearPlanarArray (API Object) 1054, 1054 +Loft (API Object) 1088, 1088 +MagneticDipole (API Object) 1103, 1103 +Mesh (API Object) 1141, 1141 +MeshRefinementRule (API Object) 1207, 1207 +Mirror (API Object) 1275, 1275 +NamedPoint (API Object) 1309, 1309 +NearField (API Object) 1318, 1318 +NearFieldDataFileStructure (API Object) 1335, 1336 +NearFieldDataFullImport (API Object) 1342, 1343 +NearFieldReceivingAntenna (API Object) 1358, 1359 +NearFieldSource (API Object) 1365, 1365 +NurbsSurface (API Object) 1391, 1391 +OpenRing (API Object) 1439, 1439 +ParabolicArc (API Object) 1529, 1530 +Paraboloid (API Object) 1538, 1538 +PathSweep (API Object) 1564, 1565 +PCBCurrentData (API Object) 1507, 1507 +PCBSource (API Object) 1513, 1513 +PeriodicBoundary (API Object) 1578, 1578 +PlaneWave (API Object) 1601, 1601 +PointRefinement (API Object) 1622, 1623 +Polygon (API Object) 1635, 1635 +Polyline (API Object) 1643, 1643 +PolylineRefinement (API Object) 1650, 1650 +Primitive (API Object) 1677, 1677 +ProjectGeometry (API Object) 1685, 1686 +ProtectedModel (API Object) 1692, 1692 +Rectangle (API Object) 1721, 1721 +RepairAndSewFaces (API Object) 1744, 1745 +RepairPart (API Object) 1758, 1759 +Ring (API Object) 1778, 1778 +Rotate (API Object) 1787, 1788 +Scale (API Object) 1813, 1813 +Simplify (API Object) 1846, 1847 +SolutionCoefficientData (API Object) 1882, 1882 +SolutionCoefficientSource (API Object) 1888, 1888 +Sphere (API Object) 1913, 1914 +SphericalModeDataFromFile (API Object) 1923, 1923 +SphericalModeDataManuallySpecified (API Object) 1928, 1928 +SphericalModeReceivingAntenna (API Object) 1939, 1940 +SphericalModeSource (API Object) 1946, 1947 +Spin (API Object) 1963, 1963 +SpiralCross (API Object) 1972, 1972 +Split (API Object) 1986, 1986 +SplitRing (API Object) 1994, 1994 +Stitch (API Object) 2012, 2012 +StripCross (API Object) 2021, 2021 +StripHexagon (API Object) 2034, 2034 +Subtract (API Object) 2044, 2045 +SurfaceBezierCurve (API Object) 2053, 2053 +SurfaceLine (API Object) 2070, 2070 +SurfaceRegularLines (API Object) 2080, 2080 +Sweep (API Object) 2089, 2089 +TCross (API Object) 2098, 2098 +Transform (API Object) 2114, 2114 +Translate (API Object) 2124, 2124 +Trifilar (API Object) 2146, 2146 +Union (API Object) 2163, 2164 +Workplane (API Object) 2274, 2275 +CoreCount (API Property) +CableRibbonCrossSection (API Object) 246 +CoreInsulatingLayers (API Property) +CableCoaxialCrossSection (API Object) 197 +CoreMedium (API Property) +CableCoaxialCrossSection (API Object) 197 +CableRibbonCrossSection (API Object) 247 +CableSingleConductorCrossSection (API Object) 266 +CableTwistedPairCrossSection (API Object) 275 +Edge (API Object) 491 +MeshCurvilinearSegmentWire (API Object) 1154 +MeshSegmentWire (API Object) 1216 +CoreRadius (API Property) +CableCoaxialCrossSection (API Object) 197 +CableRibbonCrossSection (API Object) 247 +CableSingleConductorCrossSection (API Object) 266 +CableTwistedPairCrossSection (API Object) 276 +CoreSpacing (API Property) +CableRibbonCrossSection (API Object) 247 +Corner1 (API Property) +Box (API Object) 173 +FEMModalMeshPort (API Object) 592 +FEMModalPort (API Object) 598 +Corner2 (API Property) +Box (API Object) 173 +FEMModalMeshPort (API Object) 592 +FEMModalPort (API Object) 598 +Corner3 (API Property) +FEMModalMeshPort (API Object) 592 +FEMModalPort (API Object) 598 +CornerDiffractions (API Property) +RayContributionsUTD (API Object) 1707 +Corners (API Property) +CablePath (API Object) 228 +Polygon (API Object) 1632 +Polyline (API Object) 1640 +PolylineRefinement (API Object) 1647 +CornerTipDiffraction (API Property) +RayContributionsFacetedUTD (API Object) 1699 +Cos (API StaticFunction) +Complex (API Object) 322, 3002 +ComplexMatrix (API Object) 3022 +Matrix (API Object) 3499 +Count (API Method) +ADAPTFEKOLaunchOptionsList (API Object) 60 +AdvancedSolverSettingsList (API Object) 110 +AngularDimensionList (API Object) 128 +AnisotropicDielectricLayersList (API Object) 137 +AntennaArraySourceList (API Object) 141 +BasisFunctionGlobalSolverSettingsList (API Object) 155 +BasisFunctionLocalSolverSettingsList (API Object) 159 +CableBundleCableSpecificationList (API Object) 185 +CartesianDescriptionList (API Object) 289 +CartesianRequestPointsList (API Object) 293 +CartesianStructureList (API Object) 297 +CoaxialInsulationLayerList (API Object) 311 +ComplexTensorList (API Object) 337 +CompositeValueHierarchyList (API Object) 347 +ConicalRequestPointsList (API Object) 361 +ConstrainedSurfacePointList (API Object) 375 +CurrentsExportSettingsList (API Object) 407 +CylindricalDescriptionList (API Object) 440 +CylindricalRequestPointsList (API Object) 444 +CylindricalStructureList (API Object) 448 +CylindricalXRequestPointsList (API Object) 452 +CylindricalYRequestPointsList (API Object) 456 +DielectricFrequencyPointList (API Object) 470 +DielectricModellingList (API Object) 477 +DimensionList (API Object) 482 +DomainDecompositionSettingsList (API Object) 486 +ExpressionList (API Object) 538 +FarFieldAdvancedSettingsList (API Object) 626 +FarFieldExportSettingsList (API Object) 636 +FarFieldPBCSettingsList (API Object) 645 +FarFieldSphericalModeSettingsList (API Object) 662 +FDTDBoundarySettingsList (API Object) 548 +FDTDSettingsList (API Object) 551 +FEKOGPUOptionsList (API Object) 555 +FEKOLaunchOptionsList (API Object) 560 +FEKOParallelDiagnosticTestsList (API Object) 564 +FEKOParallelExecutionOptionsList (API Object) 568 +FEKORemoteExecutionOptionsList (API Object) 572 +FEMSettingsList (API Object) 607 +FileReferenceList (API Object) 671 +FrequencyAdvancedSettingsList (API Object) 823 +FrequencyContinuousQuantitiesList (API Object) 828 +FrequencyContinuousSettingsList (API Object) 833 +FrequencyExportSettingsList (API Object) 837 +FrequencyFDTDSettingsList (API Object) 842 +FundamentalModeOptionsList (API Object) 846 +GeneralSolverSettingsList (API Object) 858 +GlobalCoordinatesList (API Object) 893 +GlobalOriginList (API Object) 901 +GlobalPlaneList (API Object) 905 +GlobalVectorList (API Object) 909 +HighFrequencySettingsList (API Object) 951 +IntegralEquationList (API Object) 997 +IsotropicDielectricLayersList (API Object) 1009 +IterativeSolverSettingsList (API Object) 1014 +LocalCoordinateList (API Object) 1065 +LocalInternalCoordinateList (API Object) 1069 +LocalWorkplaneList (API Object) 1080 +MagneticFrequencyPointList (API Object) 1107 +MagneticModellingList (API Object) 1111 +ManuallySpecifiedOrDerivedValueList (API Object) 1118 +MeshAdvancedSettingsList (API Object) 1149 +MetallicFrequencyPointList (API Object) 1259 +MLFMMACASettingsList (API Object) 1093 +MLFMMSolverSettingsList (API Object) 1097 +NearFieldAdvancedSettingsList (API Object) 1323 +NearFieldBoundarySurfaceList (API Object) 1328 +NearFieldExportSettingsList (API Object) 1347 +NormalDimensionList (API Object) 1375 +NurbsControlPointList (API Object) 1382 +ObjectReferenceList (API Object) 1430 +OPTFEKOLaunchOptionsList (API Object) 1397 +OptimisationConstraintList (API Object) 1454 +OptimisationGoalProcessingStepsList (API Object) 1466 +OptimisationMaskValuesList (API Object) 1473 +OptimisationVariableList (API Object) 1491 +OutputFileSolverSettingsList (API Object) 1496 +ParametricComplexExpressionList (API Object) 1541 +ParametricExpressionList (API Object) 1556 +PeriodicBoundaryBeamSquintAngleList (API Object) 1583 +PeriodicBoundaryPhaseShiftList (API Object) 1587 +PlanarSubstrateList (API Object) 1591 +PointAngleRangeList (API Object) 1608 +PointRangeExpressionList (API Object) 1615 +PointRangeList (API Object) 1617 +PolderTensorList (API Object) 1628 +PortPropertiesList (API Object) 1658 +PreconditionerSettingsList (API Object) 1670 +PREFEKOLaunchOptionsList (API Object) 1517 +PREFEKOVariableExportOptionsList (API Object) 1521 +RayContributionsFacetedUTDList (API Object) 1701 +RayContributionsRLGOList (API Object) 1704 +RayContributionsUTDList (API Object) 1709 +ReferenceDirectionList (API Object) 1726 +RLGOFaceAbsorbingSettingsList (API Object) 1696 +ScopeSettingsList (API Object) 1825 +ShieldLayerSettingsList (API Object) 1838 +SimplifyEdgeSettingsList (API Object) 1851 +SimplifyFaceSettingsList (API Object) 1855 +SimplifyPointSettingsList (API Object) 1864 +SimplifyRegionSettingsList (API Object) 1867 +SpecifiedRequestPointsList (API Object) 1905 +SphericalDescriptionList (API Object) 1918 +SphericalModeOptionsList (API Object) 1933 +SphericalRequestPointsList (API Object) 1951 +SphericalStructureList (API Object) 1955 +SurfaceCoordinateList (API Object) 2058 +SurfaceImpedanceFrequencyPointList (API Object) 2062 +UnitCellLayerList (API Object) 2173 +UTDCylinderTerminationTypeList (API Object) 2153 +View3DAxesFormatList (API Object) 2190 +ViewDisplayModeList (API Object) 2194 +ViewRenderingOptionsList (API Object) 2198 +VoxelAdvancedSettingsList (API Object) 2219 +VoxelGridSummaryList (API Object) 2224 +WaveguideModeOptionsList (API Object) 2238 +WindscreenSolutionMethodList (API Object) 2255 +Count (API Property) +AnisotropicDielectricCollection (API Collection) 2283 +AntennaArrayCollection (API Collection) 2289 +CableConnectorCollection (API Collection) 2296 +CableConnectorPinCollection (API Collection) 2300 +CableCrossSectionCollection (API Collection) 2305 +CableHarnessCollection (API Collection) 2316 +CableInstanceCollection (API Collection) 2320 +CablePathCollection (API Collection) 2325 +CableProbeCollection (API Collection) 2329 +CableSchematicComponentCollection (API Collection) 2335 +CableShieldCollection (API Collection) 2347 +CableSignalCollection (API Collection) 2353 +CartesianGraphCollection (API Collection) 4101 +CartesianSurfaceGraphCollection (API Collection) 4104 +CharacterisedSurfaceCollection (API Collection) 2357 +CharacteristicModeCollection (API Collection) 4107 +CollectionOf_DomainEntity (API Collection) 2361 +CollectionOf_Mesh (API Collection) 2364 +ConfigurationCollection (API Collection) 4110 +Contours3DFormat (API Object) 3044 +CurrentsCollection (API Collection) 2367 +CutplaneCollection (API Collection) 2371 +DataSetAxis (API Object) 3098 +DataSetAxisCollection (API Collection) 4113 +DataSetQuantityCollection (API Collection) 4119 +DielectricCollection (API Collection) 2375 +EdgeCollection (API Collection) 2380 +ErrorEstimateCollection (API Collection) 4123 +ErrorEstimationCollection (API Collection) 2384 +ExcitationCollection (API Collection) 4126 +FaceCollection (API Collection) 2389 +FarFieldCollection (API Collection) 2393, 4129 +FarFieldPowerIntegralCollection (API Collection) 4132 +FarFieldReceivingAntennaCollection (API Collection) 2399 +FEKOGPUOptions (API Object) 553, 3152 +FieldDataCollection (API Collection) 2404 +FormComboBox (API Object) 711, 3233 +FormDataSelector (API Object) 3244 +FormGroupBoxItemCollection (API Collection) 2411, 4135 +FormItemCollection (API Collection) 2414, 4138 +FormLayoutItemCollection (API Collection) 2417, 4141 +FormRadioButtonGroup (API Object) 790, 3328 +FormScrollAreaItemCollection (API Collection) 2420, 4145 +GeometryCollection (API Collection) 2431 +GeometryGroup (API Collection) 2475 +GeometryGroupCollection (API Collection) 2481 +ImpedanceSheetCollection (API Collection) 2485 +ImportedDataCollection (API Collection) 4148 +ImportedDataSetCollection (API Collection) 4151 +LayeredDielectricCollection (API Collection) 2490 +LoadCollection (API Collection) 2495, 4154 +MathScriptCollection (API Collection) 4157 +MediaLibrary (API Collection) 2501 +MeshCubeRegionCollection (API Collection) 4161 +MeshCubes (API Object) 3520 +MeshCurvilinearSegments (API Object) 3525 +MeshCurvilinearSegmentWireCollection (API Collection) 4164 +MeshCurvilinearTriangleFaceCollection (API Collection) 2506, 4167 +MeshCurvilinearTriangles (API Object) 3530 +MeshCylinderCollection (API Collection) 2510 +MeshCylinders (API Object) 3533 +MeshPlateCollection (API Collection) 2514 +MeshPolygons (API Object) 3544 +MeshRefinementRuleCollection (API Collection) 2518 +MeshSegmentCurvilinearWireCollection (API Collection) 2522 +MeshSegments (API Object) 3553 +MeshSegmentWireCollection (API Collection) 2526, 4170 +MeshSettingsCollection (API Collection) 2530 +MeshTetrahedra (API Object) 3556 +MeshTetrahedronRegionCollection (API Collection) 2534, 4173 +MeshTriangleFaceCollection (API Collection) 2538, 4176 +MeshTriangles (API Object) 3564 +MeshUnmeshedCylinderRegionCollection (API Collection) 4179 +MeshUnmeshedPolygonFaceCollection (API Collection) 4182 +MetalCollection (API Collection) 2542 +ModelCollection (API Collection) 4185 +ModelDecompositionCollection (API Collection) 2546 +NamedPointCollection (API Collection) 2550 +NearFieldCollection (API Collection) 2555, 4188 +NearFieldPowerIntegralCollection (API Collection) 4191 +NearFieldReceivingAntennaCollection (API Collection) 2564 +NetCollection (API Collection) 2568 +NetworkCollection (API Collection) 2573, 4194 +OperatorCollection (API Collection) 2579 +OptimisationGoalCollection (API Collection) 2583 +OptimisationMaskCollection (API Collection) 2590 +OptimisationSearchCollection (API Collection) 2594 +Points (API Object) 3669 +PolarGraphCollection (API Collection) 4197 +PortCollection (API Collection) 2600 +PowerCollection (API Collection) 4200 +ProtectedModels (API Collection) 2613 +RayCollection (API Collection) 4203 +ReceivingAntennaCollection (API Collection) 4206 +RegionCollection (API Collection) 2618 +ReportsCollection (API Collection) 4211 +ReportTemplateTagCollection (API Collection) 4209 +Result3DPlotCollection (API Collection) 4215 +ResultAnnotationCollection (API Collection) 4220 +ResultArrowCollection (API Collection) 4232 +ResultSurfacePlotCollection (API Collection) 4237 +ResultTextBoxCollection (API Collection) 4241 +ResultTraceCollection (API Collection) 4246 +SARCollection (API Collection) 2622, 4250 +ShapeCollection (API Collection) 2627 +SmithChartCollection (API Collection) 4256 +SolutionConfigurationCollection (API Collection) 2639 +SourceCollection (API Collection) 2648 +SParameterCollection (API Collection) 4253 +SphericalModeReceivingAntennaCollection (API Collection) 2658 +SpiceProbeCollection (API Collection) 4259 +StoredDataCollection (API Collection) 4262 +SurfaceCurrentsCollection (API Collection) 4265 +TerminalCollection (API Collection) 2662 +TopologyEntityCollectionOf_Edge (API Collection) 2666 +TransformCollection (API Collection) 2672 +TransmissionLineCollection (API Collection) 4271 +TransmissionReflectionCollection (API Collection) 2678 +TRCoefficientCollection (API Collection) 4268 +UnitCellCollection (API Collection) 2682 +VariableCollection (API Collection) 2686 +ViewCollection (API Collection) 4274 +WindowCollection (API Collection) 4278 +WindscreenCollection (API Collection) 2691 +WireCollection (API Collection) 2696 +WireCurrentsCollection (API Collection) 4281 +WorkplaneCollection (API Collection) 2705 +WorkSurfaceCollection (API Collection) 2700 +CountN (API Property) +CylindricalAntennaArray (API Object) 432 +CountPhi (API Property) +CylindricalAntennaArray (API Object) 432 +CountU (API Property) +LinearPlanarArray (API Object) 1051 +CountV (API Property) +LinearPlanarArray (API Object) 1051 +CoupledInductor1 (API Property) +Transformer (API Object) 2118 +CoupledInductor2 (API Property) +Transformer (API Object) 2118 +CouplingCoefficient (API Property) +Transformer (API Object) 2118 +CouplingDisabled (API Property) +DomainDecompositionSettings (API Object) 484 +CouplingParameters (API Property) +GeneralNetwork (API Object) 850 +CPURunTimesEnabled (API Property) +FEKOParallelDiagnosticTests (API Object) 562, 3157 +CreateQuickReport (API Method) +Application (API Object) 2932 +CreateTriangle (API Method) +Mesh (API Object) 1141 +CreepingWaves (API Property) +RayContributionsFacetedUTD (API Object) 1699 +RayContributionsUTD (API Object) 1707 +Critical (API StaticFunction) +Form (API Object) 701, 3223 +Cross (API Object) 377 +CrossSection (API Property) +CableInstance (API Object) 220 +CrossSections (API Collection) +Cables (API Object) 280 +CrossShape (API Object) 386 +CubeRegions (API Collection) +Mesh (API Object) 3515 +Cubes (API Property) +MeshCubeRegion (API Object) 3518 +Cuboid (API Object) 389 +CuboidVisible (API Property) +MeshEdgesFormat (API Object) 3535 +MeshFacesFormat (API Object) 3539 +MeshVerticesFormat (API Object) 3571 +CurrentProbeEnabled (API Property) +Capacitor (API Object) 284 +ComplexLoad (API Object) 331 +Inductor (API Object) 991 +Resistor (API Object) 1768 +Transformer (API Object) 2118 +VoltageControlledVoltageSource (API Object) 2208 +Currents (API Collection) +CharacteristicModesConfiguration (API Object) 307 +StandardConfiguration (API Object) 2003 +Currents (API Object) 402 +Currents (API Property) +OutputFileSolverSettings (API Object) 1494 +Currents3DFormat (API Object) 3045 +CurrentsCollection (API Collection) 2366 +CurrentSelectedItem (API Property) +FormTree (API Object) 806, 3344 +CurrentsExportSettings (API Object) 405 +CurrentsExportSettingsList (API Object) 407 +CurrentsIncluded (API Property) +FrequencyContinuousQuantities (API Object) 826 +CurrentSource (API Object) 398 +CurvilinearEdgeStandardDeviation (API Property) +MeshInfo (API Object) 1191 +ModelMeshInfo (API Object) 1297 +SimulationMeshInfo (API Object) 1873 +CurvilinearFaces (API Collection) +Mesh (API Object) 1139 +CurvilinearSegmentCount (API Property) +MeshInfo (API Object) 1191 +ModelMeshInfo (API Object) 1297 +SimulationMeshInfo (API Object) 1873 +CurvilinearSegments (API Property) +MeshAdvancedSettings (API Object) 1146 +MeshCurvilinearSegmentWire (API Object) 3523 +CurvilinearSegmentStandardDeviation (API Property) +MeshInfo (API Object) 1191 +ModelMeshInfo (API Object) 1297 +SimulationMeshInfo (API Object) 1873 +CurvilinearSegmentWires (API Collection) +Mesh (API Object) 3515 +CurvilinearTriangleCount (API Property) +MeshInfo (API Object) 1191 +ModelMeshInfo (API Object) 1297 +SimulationMeshInfo (API Object) 1873 +CurvilinearTriangleFaces (API Collection) +Mesh (API Object) 3515 +CurvilinearTriangles (API Property) +MeshAdvancedSettings (API Object) 1146 +MeshCurvilinearTriangleFace (API Object) 3528 +CurvilinearWires (API Collection) +Mesh (API Object) 1139 +custom dialog +example 51 +CustomAntennaArray (API Object) 409 +CustomData3DFormat (API Object) 3046 +CustomData3DPlot (API Object) 3049 +CustomDataQuantity (API Object) 3055 +CustomDataSmithTrace (API Object) 3057 +CustomDataSurfacePlot (API Object) 3064 +CustomDataTrace (API Object) 3070 +CustomMathScript (API Object) 3077 +CustomPositionX (API Property) +GraphLegend (API Object) 3371 +CustomPositionY (API Property) +GraphLegend (API Object) 3371 +CustomSmithTraceQuantity (API Object) 3080 +CustomStoredData (API Object) 3082 +Cutplane (API Object) 415 +CutplaneCollection (API Collection) 2370 +Cutplanes (API Collection) +ModelContents (API Object) 1287 +Cylinder (API Object) 421 +CylinderImportingEnabled (API Property) +MeshImporter (API Object) 1182 +Cylinders (API Collection) +Mesh (API Object) 1139 +Cylinders (API Property) +MeshUnmeshedCylinderRegion (API Object) 3566 +CylindricalAntennaArray (API Object) 430 +CylindricalDescription (API Object) 438 +CylindricalDescription (API Property) +AnalyticalCurve (API Object) 121 +CylindricalDescriptionList (API Object) 440 +CylindricalRequestPoints (API Object) 442 +CylindricalRequestPoints (API Property) +NearField (API Object) 1315 +CylindricalRequestPointsList (API Object) 444 +CylindricalStructure (API Object) 446 +CylindricalStructure (API Property) +NearFieldDataFileStructure (API Object) 1332 +CylindricalStructureList (API Object) 448 +CylindricalXRequestPoints (API Object) 450 +CylindricalXRequestPoints (API Property) +NearField (API Object) 1315 +CylindricalXRequestPointsList (API Object) 452 +CylindricalYRequestPoints (API Object) 454 +CylindricalYRequestPoints (API Property) +NearField (API Object) 1315 +CylindricalYRequestPointsList (API Object) 456 +DataBlockNumber (API Property) +FarFieldData (API Object) 629 +NearFieldDataFileStructure (API Object) 1332 +NearFieldDataFullImport (API Object) 1340 +SolutionCoefficientData (API Object) 1880 +SphericalModeDataFromFile (API Object) 1921 +dataset +ForAllValues 33 +DataSet +charges 46, 47 +directivity 38 +far field 36 +gain 38 +load 42 +near field 39 +network 43 +power 45 +realised gain 38 +S-parameter 44 +SAR 49 +source 41 +surface currents 46 +transmission / reflection coefficients 48 +wire currents 47 +DataSet (API Object) 3084 +DataSetAvailable (API Property) +CharacteristicModeData (API Object) 2979 +CustomMathScript (API Object) 3078 +ExcitationMathScript (API Object) 3127 +FarFieldData (API Object) 3175 +FarFieldMathScript (API Object) 3181 +FarFieldPowerIntegralData (API Object) 3184 +FarFieldPowerIntegralStoredData (API Object) 3187 +FarFieldReceivingAntennaData (API Object) 3199 +LoadCable (API Object) 3410 +LoadCoaxial (API Object) 3414 +LoadComplex (API Object) 3418 +LoadEdge (API Object) 3427 +LoadFEM (API Object) 3431 +LoadMathScript (API Object) 3435 +LoadNetwork (API Object) 3438 +LoadParallel (API Object) 3442 +LoadSeries (API Object) 3448 +LoadVertex (API Object) 3471 +LoadVoxel (API Object) 3475 +NearFieldData (API Object) 3592 +NearFieldMathScript (API Object) 3597 +NearFieldReceivingAntennaData (API Object) 3616 +NetworkData (API Object) 3638 +NetworkMathScript (API Object) 3641 +PowerData (API Object) 3686 +PowerMathScript (API Object) 3692 +ReceivingAntennaData (API Object) 3725 +SARData (API Object) 3783 +SourceCoaxial (API Object) 3852 +SourceCurrentRegion (API Object) 3857 +SourceMagneticFrill (API Object) 3874 +SourceModal (API Object) 3879 +SourceVoltageCable (API Object) 3899 +SourceVoltageEdge (API Object) 3904 +SourceVoltageNetwork (API Object) 3909 +SourceVoltageSegment (API Object) 3914 +SourceVoltageVertex (API Object) 3919 +SourceWaveguide (API Object) 3924 +SParameterData (API Object) 3798 +SParameterMathScript (API Object) 3802 +SphericalModesReceivingAntennaData (API Object) 3929 +SurfaceCurrentsData (API Object) 3952 +SurfaceCurrentsMathScript (API Object) 3956 +TransmissionLineData (API Object) 4027 +TRCoefficientData (API Object) 3993 +TRCoefficientMathScript (API Object) 3997 +WireCurrentsData (API Object) 4084 +WireCurrentsMathScript (API Object) 4087 +DataSetAxis (API Object) 3097 +DataSetAxisCollection (API Collection) 4112 +DataSetIndexer (API Object) 3101 +DataSetMetaData (API Object) 3106 +DataSetQuantity (API Object) 3110 +DataSetQuantityCollection (API Collection) 4118 +DataSource (API Property) +CharacteristicModeTrace (API Object) 2988 +CustomData3DPlot (API Object) 3051 +CustomDataSmithTrace (API Object) 3059 +CustomDataSurfacePlot (API Object) 3066 +CustomDataTrace (API Object) 3072 +ErrorEstimate3DPlot (API Object) 3114 +ExcitationSmithTrace (API Object) 3138 +ExcitationTrace (API Object) 3148 +FarField3DPlot (API Object) 3168 +FarFieldPowerIntegralTrace (API Object) 3190 +FarFieldSurfacePlot (API Object) 3206 +FarFieldTrace (API Object) 3212 +LoadSmithTrace (API Object) 3455 +LoadTrace (API Object) 3465 +MathTrace (API Object) 3482 +NearField3DPlot (API Object) 3585 +NearFieldPowerIntegralTrace (API Object) 3605 +NearFieldSurfacePlot (API Object) 3623 +NearFieldTrace (API Object) 3630 +NetworkTrace (API Object) 3648 +PowerTrace (API Object) 3701 +Ray3DPlot (API Object) 3713 +ReceivingAntennaTrace (API Object) 3731 +Result3DPlot (API Object) 3748 +ResultSurfacePlot (API Object) 3763 +ResultTrace (API Object) 3776 +SAR3DPlot (API Object) 3780 +SARTrace (API Object) 3791 +SParameterSurfacePlot (API Object) 3812 +SParameterTrace (API Object) 3818 +SpiceProbeTrace (API Object) 3939 +SurfaceCurrents3DPlot (API Object) 3945 +TRCoefficientTrace (API Object) 4004 +WireCurrents3DPlot (API Object) 4077 +WireCurrentsTrace (API Object) 4094 +DataStoragePrecision (API Property) +GeneralSolverSettings (API Object) 855 +DataType (API Property) +GeneralNetwork (API Object) 850 +NearFieldDataFileStructure (API Object) 1332 +NearFieldDataFullImport (API Object) 1340 +DCBiasField (API Property) +PolderTensor (API Object) 1626 +DebugEnabled (API Property) +ADAPTFEKOLaunchOptions (API Object) 59 +FEKOLaunchOptions (API Object) 558 +OPTFEKOLaunchOptions (API Object) 1395 +DecoupleFEMFromMoM (API Property) +FEMSettings (API Object) 605 +DecoupleRLGOFromMoM (API Property) +HighFrequencySettings (API Object) 946 +DecoupleSourcesEnabled (API Property) +Power (API Object) 1661 +DecoupleUTDFromMoM (API Property) +HighFrequencySettings (API Object) 946 +DefaultMedium (API Object) 458 +DefaultMedium (API Property) +Media (API Object) 1126 +DefinitionMethod (API Property) +AnalyticalCurve (API Object) 121 +CableCoaxialCrossSection (API Object) 197 +Cone (API Object) 352 +Cuboid (API Object) 391 +Cylinder (API Object) 424 +DielectricModelling (API Object) 474 +EllipticArc (API Object) 525 +FEMLineMeshPort (API Object) 576 +FEMLinePort (API Object) 584 +FEMModalMeshPort (API Object) 592 +FEMModalPort (API Object) 598 +Flare (API Object) 691 +GroundPlane (API Object) 916 +Helix (API Object) 926 +HyperbolicArc (API Object) 956 +ImpedanceSheet (API Object) 968 +MagneticModelling (API Object) 1110 +MeshTetrahedronRegion (API Object) 1229 +Metal (API Object) 1254 +NearField (API Object) 1316 +ParabolicArc (API Object) 1526 +PlaneWave (API Object) 1598 +Rectangle (API Object) 1717 +Region (API Object) 1730 +Sphere (API Object) 1910 +TransmissionLine (API Object) 2128 +WireMeshPort (API Object) 2258 +WirePort (API Object) 2264 +Definitions (API Property) +Model (API Object) 1279 +DefinitionType (API Property) +NearFieldReceivingAntenna (API Object) 1356 +Delete (API Method) +AbstractAntennaArray (API Object) 65 +AbstractFEMLinePort (API Object) 71 +AbstractIdealSource (API Object) 76 +AbstractMeshEdge (API Object) 79 +AbstractMeshPort (API Object) 82 +AbstractMeshTriangleFace (API Object) 85 +AbstractMeshWire (API Object) 88 +AbstractPointSource (API Object) 94 +AbstractSurfaceCurve (API Object) 102 +AdaptiveRefinement (API Object) 107 +Align (API Object) 116 +AnalyticalCurve (API Object) 125 +AnisotropicDielectric (API Object) 133 +AnisotropicDielectricCollection (API Collection) 2284 +AntennaArrayCollection (API Collection) 2292 +Application (API Object) 146 +BandwidthAnnotation (API Object) 2946 +BaseFieldReceivingAntenna (API Object) 152 +BeamwidthAnnotation (API Object) 2951 +BezierCurve (API Object) 167 +CableBundleCrossSection (API Object) 192 +CableCoaxialCrossSection (API Object) 199 +CableConnector (API Object) 203 +CableConnectorCollection (API Collection) 2297 +CableConnectorPin (API Object) 206 +CableConnectorPinCollection (API Collection) 2301 +CableCrossSection (API Object) 209 +CableCrossSectionCollection (API Collection) 2313 +CableGeneralNetwork (API Object) 213 +CableHarness (API Object) 218 +CableHarnessCollection (API Collection) 2317 +CableInstance (API Object) 222 +CableInstanceCollection (API Collection) 2321 +CableNonConductingElementCrossSection (API Object) 225 +CablePath (API Object) 232 +CablePathCollection (API Collection) 2326 +CablePathTerminal (API Object) 234 +CablePort (API Object) 239 +CableProbe (API Object) 243 +CableProbeCollection (API Collection) 2330 +CableRibbonCrossSection (API Object) 248 +Cables (API Object) 281 +CableSchematicComponentCollection (API Collection) 2343 +CableSchematicCurrentProbe (API Object) 252 +CableSchematicVoltageProbe (API Object) 256 +CableShield (API Object) 260 +CableShieldCollection (API Collection) 2350 +CableSignal (API Object) 264 +CableSignalCollection (API Collection) 2353 +CableSingleConductorCrossSection (API Object) 267 +CableSpiceNetwork (API Object) 272 +CableTwistedPairCrossSection (API Object) 277 +Capacitor (API Object) 285 +CFXModelImporter (API Object) 181 +CFXModelImportSettings (API Object) 178 +CharacterisedSurface (API Object) 300 +CharacterisedSurfaceCollection (API Collection) 2358 +CharacteristicModes (API Object) 303 +CharacteristicModesConfiguration (API Object) 307 +CharacteristicModeStoredData (API Object) 2984 +CharacteristicModeTrace (API Object) 2990 +CollectionOf_DomainEntity (API Collection) 2361 +CollectionOf_Mesh (API Collection) 2364 +ComplexLoad (API Object) 333 +ComponentLaunchOptions (API Object) 341 +Cone (API Object) 356 +ConstrainedSurface (API Object) 370 +Cross (API Object) 383 +CrossShape (API Object) 388 +Cuboid (API Object) 396 +Currents (API Object) 404 +CurrentsCollection (API Collection) 2368 +CurrentSource (API Object) 400 +CustomAntennaArray (API Object) 413 +CustomData3DPlot (API Object) 3052 +CustomDataSmithTrace (API Object) 3061 +CustomDataSurfacePlot (API Object) 3068 +CustomDataTrace (API Object) 3074 +CustomMathScript (API Object) 3079 +CustomStoredData (API Object) 3083 +Cutplane (API Object) 419 +CutplaneCollection (API Collection) 2372 +Cylinder (API Object) 428 +CylindricalAntennaArray (API Object) 436 +DataSetAxis (API Object) 3099 +DataSetQuantity (API Object) 3111 +DefaultMedium (API Object) 459 +Dielectric (API Object) 464 +DielectricBoundaryMedium (API Object) 467 +DielectricCollection (API Collection) 2376 +Edge (API Object) 493 +EdgeCollection (API Collection) 2381 +EdgeMeshPort (API Object) 498 +EdgePort (API Object) 503 +ElectricDipole (API Object) 509 +Ellipse (API Object) 517 +EllipseShape (API Object) 521 +EllipticArc (API Object) 530 +ErrorEstimate3DPlot (API Object) 3115 +ErrorEstimation (API Object) 534 +ErrorEstimationCollection (API Collection) 2385 +ExcitationMathScript (API Object) 3128 +ExcitationSmithTrace (API Object) 3140 +ExcitationStoredData (API Object) 3144 +ExcitationTrace (API Object) 3150 +Exporter (API Object) 537 +Face (API Object) 614 +FaceCollection (API Collection) 2390 +FarField (API Object) 621 +FarField3DPlot (API Object) 3170 +FarFieldCollection (API Collection) 2395 +FarFieldData (API Object) 633 +FarFieldMathScript (API Object) 3182 +FarFieldOptimisationGoal (API Object) 641 +FarFieldPowerIntegralStoredData (API Object) 3187 +FarFieldPowerIntegralTrace (API Object) 3192 +FarFieldReceivingAntenna (API Object) 652 +FarFieldReceivingAntennaCollection (API Collection) 2400 +FarFieldSource (API Object) 658 +FarFieldStoredData (API Object) 3202 +FarFieldSurfacePlot (API Object) 3208 +FarFieldTrace (API Object) 3214 +FDTDBoundaryConditions (API Object) 545 +FEMLineMeshPort (API Object) 580 +FEMLinePort (API Object) 588 +FEMModalMeshPort (API Object) 594 +FEMModalPort (API Object) 601 +FEMModalSource (API Object) 604 +FieldData (API Object) 668 +FieldDataCollection (API Collection) 2408 +FillHoleSettings (API Object) 675 +Find (API Object) 677 +FittedSpline (API Object) 685 +Flare (API Object) 695 +FreeSpace (API Object) 815 +Frequency (API Object) 820 +GeneralNetwork (API Object) 852 +Geometry (API Object) 871 +GeometryCollection (API Collection) 2460 +GeometryExporter (API Object) 877 +GeometryGroup (API Collection) 2477 +GeometryGroupCollection (API Collection) 2482 +GeometryImporter (API Object) 882 +GeometryRebuild (API Object) 884 +GeometryRepair (API Object) 888 +GlobalMeshSettings (API Object) 898 +GraphAnnotation (API Object) 3365 +Ground (API Object) 913 +GroundPlane (API Object) 917 +GroundPlaneMedium (API Object) 921 +Helix (API Object) 931 +Hexagon (API Object) 939 +HexagonShape (API Object) 942 +HyperbolicArc (API Object) 960 +ImpedanceOptimisationGoal (API Object) 965 +ImpedanceSheet (API Object) 970 +ImpedanceSheetCollection (API Collection) 2486 +ImplicitPointsAnnotation (API Object) 3382 +Importer (API Object) 973 +ImportSet (API Object) 3386 +ImpressedCurrent (API Object) 979 +ImprintPoints (API Object) 987 +Inductor (API Object) 993 +Intersect (API Object) 1005 +KBL (API Object) 1017 +Launcher (API Object) 1026 +LaunchResult (API Object) 1021 +LayeredAnisotropicDielectric (API Object) 1031 +LayeredDielectric (API Object) 1033 +LayeredDielectricCollection (API Collection) 2492 +LayeredIsotropicDielectric (API Object) 1037 +LibraryMedium (API Object) 1040 +Line (API Object) 1047 +LinearPlanarArray (API Object) 1054 +Load (API Object) 1060 +LoadCollection (API Collection) 2498 +LoadMathScript (API Object) 3436 +LoadSmithTrace (API Object) 3457 +LoadStoredData (API Object) 3461 +LoadTrace (API Object) 3467 +LocalMeshSettings (API Object) 1073 +Loft (API Object) 1089 +MagneticDipole (API Object) 1104 +MainWindow (API Object) 1114 +MathScript (API Object) 3479 +MathTrace (API Object) 3484 +MdiSubWindow (API Object) 1122 +Media (API Object) 1129 +MediaLibrary (API Collection) 2502 +Medium (API Object) 1133 +Mesh (API Object) 1142 +MeshCurvilinearSegmentWire (API Object) 1156 +MeshCurvilinearTriangleFace (API Object) 1163 +MeshCurvilinearTriangleFaceCollection (API Collection) 2507 +MeshCurvilinearWire (API Object) 1166 +MeshCylinder (API Object) 1169 +MeshCylinderCollection (API Collection) 2511 +Mesher (API Object) 1246 +MeshExporter (API Object) 1174 +MeshFind (API Object) 1178 +MeshImporter (API Object) 1185 +MeshInfo (API Object) 1196 +MeshPlate (API Object) 1202 +MeshPlateCollection (API Collection) 2515 +MeshRefinementRule (API Object) 1208 +MeshRefinementRuleCollection (API Collection) 2519 +MeshRegion (API Object) 1210 +MeshSegmentCurvilinearWireCollection (API Collection) 2523 +MeshSegmentWire (API Object) 1219 +MeshSegmentWireCollection (API Collection) 2527 +MeshSettings (API Object) 1225 +MeshSettingsCollection (API Collection) 2531 +MeshTetrahedronRegion (API Object) 1230 +MeshTetrahedronRegionCollection (API Collection) 2535 +MeshTriangleFace (API Object) 1237 +MeshTriangleFaceCollection (API Collection) 2539 +MeshWire (API Object) 1242 +MessageWindow (API Object) 1249 +Metal (API Object) 1255 +MetalCollection (API Collection) 2543 +MicrostripMeshPort (API Object) 1264 +MicrostripPort (API Object) 1269 +Mirror (API Object) 1275 +ModalExcitationStoredData (API Object) 3575 +Model (API Object) 1280, 3578 +ModelAttributes (API Object) 1283 +ModelContents (API Object) 1288 +ModelDecompositionCollection (API Collection) 2547 +ModelDefinitions (API Object) 1291 +ModelMeshInfo (API Object) 1302 +ModelSymmetry (API Object) 1305 +NamedPoint (API Object) 1310 +NamedPointCollection (API Collection) 2551 +NearField (API Object) 1319 +NearField3DPlot (API Object) 3587 +NearFieldCollection (API Collection) 2560 +NearFieldDataFileStructure (API Object) 1336 +NearFieldDataFullImport (API Object) 1343 +NearFieldMathScript (API Object) 3598 +NearFieldOptimisationGoal (API Object) 1352 +NearFieldPowerIntegralStoredData (API Object) 3602 +NearFieldPowerIntegralTrace (API Object) 3608 +NearFieldReceivingAntenna (API Object) 1359 +NearFieldReceivingAntennaCollection (API Collection) 2565 +NearFieldSource (API Object) 1366 +NearFieldStoredData (API Object) 3619 +NearFieldSurfacePlot (API Object) 3625 +NearFieldTrace (API Object) 3633 +Net (API Object) 1369 +NetCollection (API Collection) 2569 +Network (API Object) 1372 +NetworkCollection (API Collection) 2576 +NetworkMathScript (API Object) 3642 +NetworkStoredData (API Object) 3644 +NetworkTrace (API Object) 3650 +NumericalGreensFunction (API Object) 1379 +NurbsSurface (API Object) 1392 +Object (API Object) 1427 +OpenRing (API Object) 1440 +OpenRingShape (API Object) 1444 +OperatorCollection (API Collection) 2580 +Optimisation (API Object) 1447 +OptimisationCombination (API Object) 1451 +OptimisationGoal (API Object) 1458 +OptimisationGoalCollection (API Collection) 2586 +OptimisationGoalObjective (API Object) 1462 +OptimisationMask (API Object) 1469 +OptimisationMaskCollection (API Collection) 2591 +OptimisationOperator (API Object) 1476 +OptimisationParameters (API Object) 1479 +OptimisationSearch (API Object) 1484 +OptimisationSearchAdvancedSettings (API Object) 1487 +OptimisationSearchCollection (API Collection) 2595 +ParabolicArc (API Object) 1530 +Paraboloid (API Object) 1538 +PathSweep (API Object) 1565 +PCB (API Object) 1502 +PCBCurrentData (API Object) 1507 +PCBSource (API Object) 1513 +PerfectElectricConductor (API Object) 1568 +PerfectMagneticConductor (API Object) 1571 +PeriodicBoundary (API Object) 1579 +PlaneShape (API Object) 1595 +PlaneWave (API Object) 1601 +PointRefinement (API Object) 1623 +Polygon (API Object) 1636 +Polyline (API Object) 1644 +PolylineRefinement (API Object) 1650 +Port (API Object) 1654 +PortCollection (API Collection) 2609 +Power (API Object) 1662 +PowerMathScript (API Object) 3693 +PowerOptimisationGoal (API Object) 1666 +PowerStoredData (API Object) 3697 +PowerTrace (API Object) 3703 +Primitive (API Object) 1677 +ProjectGeometry (API Object) 1686 +ProtectedModel (API Object) 1692 +ProtectedModels (API Collection) 2614 +Ray3DPlot (API Object) 3714 +ReceivingAntennaOptimisationGoal (API Object) 1714 +ReceivingAntennaTrace (API Object) 3733 +Rectangle (API Object) 1721 +Region (API Object) 1732 +RegionCollection (API Collection) 2619 +RemoveSmallFeaturesSettings (API Object) 1737 +RepairAndSewFaces (API Object) 1745 +RepairAndSewFacesSettings (API Object) 1749 +RepairEdgesSettings (API Object) 1751 +RepairPart (API Object) 1759 +RepairPartsSettings (API Object) 1765 +ReportTemplate (API Object) 3740 +Resistor (API Object) 1770 +Result3DPlot (API Object) 3748 +ResultArrow (API Object) 3751 +ResultSurfacePlot (API Object) 3764 +ResultTextBox (API Object) 3771 +ResultTrace (API Object) 3777 +Ring (API Object) 1778 +RingShape (API Object) 1783 +Rotate (API Object) 1788 +SAR (API Object) 1793 +SAR3DPlot (API Object) 3781 +SARCollection (API Collection) 2623 +SAROptimisationGoal (API Object) 1797 +SARStoredData (API Object) 3787 +SARTrace (API Object) 3793 +Scale (API Object) 1814 +Schematic (API Object) 1817 +SchematicViewWindow (API Object) 1821 +Shape (API Object) 1829 +ShapeCollection (API Collection) 2634 +SimpleAnnotation (API Object) 3827 +Simplify (API Object) 1847 +SimplifyPartRepresentationSettings (API Object) 1861 +SimulationMeshInfo (API Object) 1878 +SolutionCoefficientData (API Object) 1883 +SolutionCoefficientSource (API Object) 1888 +SolutionConfiguration (API Object) 1892 +SolutionConfigurationCollection (API Collection) 2642 +SolutionSettings (API Object) 1895 +SolverSettings (API Object) 1900 +Source (API Object) 1902 +SourceCollection (API Collection) 2655 +SParameter (API Object) 1800 +SParameterConfiguration (API Object) 1804 +SParameterMathScript (API Object) 3803 +SParameterOptimisationGoal (API Object) 1809 +SParameterStoredData (API Object) 3807 +SParameterSurfacePlot (API Object) 3813 +SParameterTrace (API Object) 3820 +Sphere (API Object) 1914 +SphericalModeDataFromFile (API Object) 1924 +SphericalModeDataManuallySpecified (API Object) 1929 +SphericalModeReceivingAntenna (API Object) 1940 +SphericalModeReceivingAntennaCollection (API Collection) 2659 +SphericalModeSource (API Object) 1947 +SpiceProbeStoredData (API Object) 3936 +SpiceProbeTrace (API Object) 3941 +Spin (API Object) 1964 +SpiralCross (API Object) 1973 +SpiralCrossShape (API Object) 1977 +Split (API Object) 1986 +SplitRing (API Object) 1995 +SplitRingShape (API Object) 1999 +StandardConfiguration (API Object) 2005 +Stitch (API Object) 2012 +StripCross (API Object) 2022 +StripCrossShape (API Object) 2026 +StripHexagon (API Object) 2034 +StripHexagonShape (API Object) 2038 +Subtract (API Object) 2045 +SurfaceBezierCurve (API Object) 2054 +SurfaceCurrents3DPlot (API Object) 3946 +SurfaceCurrentsAndChargesStoredData (API Object) 3950 +SurfaceCurrentsMathScript (API Object) 3956 +SurfaceLine (API Object) 2070 +SurfaceRegularLines (API Object) 2080 +Sweep (API Object) 2089 +TCross (API Object) 2098 +TCrossShape (API Object) 2103 +Terminal (API Object) 2106 +TerminalCollection (API Collection) 2663 +TopologyEntity (API Object) 2109 +TopologyEntityCollectionOf_Edge (API Collection) 2666 +Transform (API Object) 2114 +TransformCollection (API Collection) 2675 +Transformer (API Object) 2119 +Translate (API Object) 2125 +TransmissionLine (API Object) 2130 +TransmissionReflection (API Object) 2134 +TransmissionReflectionCollection (API Collection) 2679 +TransmissionReflectionOptimisationGoal (API Object) 2138 +TRCoefficientMathScript (API Object) 3998 +TRCoefficientStoredData (API Object) 4000 +TRCoefficientTrace (API Object) 4006 +Trifilar (API Object) 2146 +TrifilarShape (API Object) 2150 +Union (API Object) 2164 +UnitCell (API Object) 2169 +UnitCellCollection (API Collection) 2683 +UnprotectedInformation (API Object) 2176 +Variable (API Object) 2181 +VariableCollection (API Collection) 2688 +Version (API Object) 2187 +ViewXt (API Object) 2201 +ViewXtWindow (API Object) 2205 +VoltageControlledVoltageSource (API Object) 2210 +VoltageSource (API Object) 2214 +VoxelSettings (API Object) 2228 +WaveguideExcitationStoredData (API Object) 4063 +WaveguideMeshPort (API Object) 2233 +WaveguidePort (API Object) 2243 +WaveguideSource (API Object) 2247 +WidthAnnotation (API Object) 4070 +Windscreen (API Object) 2251 +WindscreenCollection (API Collection) 2692 +WireCollection (API Collection) 2697 +WireCurrents3DPlot (API Object) 4078 +WireCurrentsAndChargesStoredData (API Object) 4082 +WireCurrentsMathScript (API Object) 4087 +WireCurrentsTrace (API Object) 4097 +WireMeshPort (API Object) 2260 +WirePort (API Object) 2265 +Workplane (API Object) 2275 +WorkplaneCollection (API Collection) 2706 +WorkSurface (API Object) 2270 +WorkSurfaceCollection (API Collection) 2701 +Zero (API Object) 2280 +DeleteEntities (API Method) +Model (API Object) 1280 +DeleteSegments (API Method) +Mesh (API Object) 1142 +DeleteTemporaryFilesEnabled (API Property) +ADAPTFEKOLaunchOptions (API Object) 59, 2924 +DeleteTriangles (API Method) +Mesh (API Object) 1142 +DeleteVertices (API Method) +Mesh (API Object) 1142 +DensityOption (API Property) +TraceMarkersFormat (API Object) 4021 +Dependent (API Property) +TraceAxes (API Object) 4015 +DependentAxisFormat (API Object) 3112 +DependentAxisValues (API Property) +InterpolatorSettings (API Object) 3394 +Depth (API Property) +Box (API Object) 173 +Cuboid (API Object) 392 +EllipticArc (API Object) 525 +HyperbolicArc (API Object) 956 +ParabolicArc (API Object) 1526 +PlaneShape (API Object) 1594 +Rectangle (API Object) 1717 +DepthLightingEnabled (API Property) +View3DFormat (API Object) 4050 +DerivedDoubleValue (API Property) +ManuallySpecifiedOrDerivedValue (API Object) 1116 +Description (API Property) +DataSetAxis (API Object) 3098 +Variable (API Object) 2179 +Destination (API Property) +CableSignal (API Object) 263 +DestinationConnector (API Property) +CableInstance (API Object) 221 +DestinationWorkplane (API Property) +Align (API Object) 113 +Determinant (API Method) +ComplexMatrix (API Object) 3017 +Matrix (API Object) 3495 +DeviationUpperBound (API Property) +RepairPartsSettings (API Object) 1763 +DGFMEnabled (API Property) +DomainDecompositionSettings (API Object) 484 +DiagnosticTests (API Property) +FEKOParallelExecutionOptions (API Object) 567, 3160 +Diagonal (API StaticFunction) +ComplexMatrix (API Object) 3022 +Matrix (API Object) 3500 +DiagonalTensor (API Property) +AnisotropicDielectric (API Object) 132 +dictionary +Lua 15 +Dielectric (API Collection) +Media (API Object) 1128 +Dielectric (API Object) 461 +DielectricBoundaryMedium (API Object) 465 +DielectricBoundaryMedium (API Property) +Media (API Object) 1127 +DielectricCollection (API Collection) 2374 +DielectricFrequencyPoint (API Object) 468 +DielectricFrequencyPointList (API Object) 470 +DielectricModelling (API Object) 472 +DielectricModelling (API Property) +Dielectric (API Object) 463 +DielectricBoundaryMedium (API Object) 466 +FreeSpace (API Object) 814 +GroundPlaneMedium (API Object) 920 +Zero (API Object) 2278 +DielectricModellingList (API Object) 477 +DielectricVisible (API Property) +MeshEdgesFormat (API Object) 3535 +MeshFacesFormat (API Object) 3539 +MeshVerticesFormat (API Object) 3571 +Dimension (API Object) 479 +Dimension (API Property) +PeriodicBoundary (API Object) 1575 +DimensionList (API Object) 482 +DirectAndReflected (API Property) +RayContributionsUTD (API Object) 1707 +DirectField (API Property) +RayContributionsFacetedUTD (API Object) 1699 +Direction (API Property) +PolarGraph (API Object) 3674 +DirectionalComponent (API Property) +NearFieldOptimisationGoal (API Object) 1351 +DirectionReversed (API Property) +WaveguideMeshPort (API Object) 2231 +WaveguidePort (API Object) 2241 +Directory (API Property) +NearFieldDataFullImport (API Object) 1340 +Disassemble (API Method) +GeometryGroup (API Collection) 2477 +DiscoverHierarchy (API Function) +DRE (API Object) 4293, 4294 +DiscreteFrequencies (API Property) +Frequency (API Object) 818 +DiscretePlotEnabled (API Property) +CustomDataSurfacePlot (API Object) 3066 +FarFieldSurfacePlot (API Object) 3206 +NearFieldSurfacePlot (API Object) 3623 +SParameterSurfacePlot (API Object) 3812 +DisplayType (API Property) +RequestPoints3DFormat (API Object) 3745 +DistanceTo (API Method) +Point (API Object) 1605, 3667 +UVPoint (API Object) 2157 +DistanceU (API Property) +UnitCell (API Object) 2167 +DistanceV (API Property) +UnitCell (API Object) 2167 +Distribution (API Property) +CylindricalAntennaArray (API Object) 432 +LinearPlanarArray (API Object) 1051 +DocumentHeading (API Property) +QuickReport (API Object) 3707 +DocumentType (API Property) +ReportTemplate (API Object) 3739 +DomainDecompositionSettings (API Object) 484 +DomainDecompositionSettings (API Property) +SolverSettings (API Object) 1898 +DomainDecompositionSettingsList (API Object) 486 +DoubleDiffractions (API Property) +RayContributionsUTD (API Object) 1707 +Duplicate (API Method) +AbstractAntennaArray (API Object) 66 +AbstractFEMLinePort (API Object) 71 +AbstractIdealSource (API Object) 76 +AbstractMeshEdge (API Object) 79 +AbstractMeshPort (API Object) 82 +AbstractMeshTriangleFace (API Object) 85 +AbstractMeshWire (API Object) 88 +AbstractPointSource (API Object) 94 +AbstractSurfaceCurve (API Object) 102 +AdaptiveRefinement (API Object) 108 +Align (API Object) 116 +AnalyticalCurve (API Object) 125 +AnisotropicDielectric (API Object) 133 +AnisotropicDielectricCollection (API Collection) 2285 +AntennaArrayCollection (API Collection) 2292 +Application (API Object) 146 +BandwidthAnnotation (API Object) 2946 +BaseFieldReceivingAntenna (API Object) 152 +BeamwidthAnnotation (API Object) 2951 +BezierCurve (API Object) 167 +CableBundleCrossSection (API Object) 192 +CableCoaxialCrossSection (API Object) 199 +CableConnector (API Object) 204 +CableConnectorCollection (API Collection) 2297 +CableConnectorPin (API Object) 206 +CableConnectorPinCollection (API Collection) 2301 +CableCrossSection (API Object) 210 +CableCrossSectionCollection (API Collection) 2313 +CableGeneralNetwork (API Object) 214 +CableHarness (API Object) 218 +CableHarnessCollection (API Collection) 2317 +CableInstance (API Object) 222 +CableInstanceCollection (API Collection) 2321 +CableNonConductingElementCrossSection (API Object) 225 +CablePath (API Object) 232 +CablePathCollection (API Collection) 2326 +CablePathTerminal (API Object) 234 +CablePort (API Object) 239 +CableProbe (API Object) 243 +CableProbeCollection (API Collection) 2330 +CableRibbonCrossSection (API Object) 248 +Cables (API Object) 281 +CableSchematicComponentCollection (API Collection) 2343 +CableSchematicCurrentProbe (API Object) 252 +CableSchematicVoltageProbe (API Object) 256 +CableShield (API Object) 260 +CableShieldCollection (API Collection) 2350 +CableSignal (API Object) 264 +CableSignalCollection (API Collection) 2353 +CableSingleConductorCrossSection (API Object) 268 +CableSpiceNetwork (API Object) 272 +CableTwistedPairCrossSection (API Object) 277 +Capacitor (API Object) 285 +CartesianGraph (API Object) 2958 +CartesianSurfaceGraph (API Object) 2971 +CFXModelImporter (API Object) 181 +CFXModelImportSettings (API Object) 178 +CharacterisedSurface (API Object) 300 +CharacterisedSurfaceCollection (API Collection) 2358 +CharacteristicModes (API Object) 303 +CharacteristicModesConfiguration (API Object) 307 +CharacteristicModeTrace (API Object) 2991 +CollectionOf_DomainEntity (API Collection) 2361 +CollectionOf_Mesh (API Collection) 2364 +ComplexLoad (API Object) 333 +ComplexMatrix (API Object) 3018 +ComponentLaunchOptions (API Object) 341 +Cone (API Object) 356 +ConstrainedSurface (API Object) 370 +Cross (API Object) 383 +CrossShape (API Object) 388 +Cuboid (API Object) 396 +Currents (API Object) 404 +CurrentsCollection (API Collection) 2368 +CurrentSource (API Object) 400 +CustomAntennaArray (API Object) 413 +CustomData3DPlot (API Object) 3052 +CustomDataSmithTrace (API Object) 3061 +CustomDataTrace (API Object) 3074 +CustomMathScript (API Object) 3079 +Cutplane (API Object) 419 +CutplaneCollection (API Collection) 2372 +Cylinder (API Object) 428 +CylindricalAntennaArray (API Object) 436 +DefaultMedium (API Object) 459 +Dielectric (API Object) 464 +DielectricBoundaryMedium (API Object) 467 +DielectricCollection (API Collection) 2376 +Edge (API Object) 493 +EdgeCollection (API Collection) 2381 +EdgeMeshPort (API Object) 498 +EdgePort (API Object) 503 +ElectricDipole (API Object) 510 +Ellipse (API Object) 517 +EllipseShape (API Object) 521 +EllipticArc (API Object) 530 +ErrorEstimation (API Object) 534 +ErrorEstimationCollection (API Collection) 2385 +ExcitationMathScript (API Object) 3128 +ExcitationSmithTrace (API Object) 3140 +ExcitationTrace (API Object) 3150 +Exporter (API Object) 537 +Face (API Object) 614 +FaceCollection (API Collection) 2390 +FarField (API Object) 622 +FarField3DPlot (API Object) 3170 +FarFieldCollection (API Collection) 2396 +FarFieldData (API Object) 633 +FarFieldMathScript (API Object) 3182 +FarFieldOptimisationGoal (API Object) 641 +FarFieldPowerIntegralTrace (API Object) 3192 +FarFieldReceivingAntenna (API Object) 652 +FarFieldReceivingAntennaCollection (API Collection) 2400 +FarFieldSource (API Object) 658 +FarFieldTrace (API Object) 3214 +FDTDBoundaryConditions (API Object) 545 +FEMLineMeshPort (API Object) 580 +FEMLinePort (API Object) 588 +FEMModalMeshPort (API Object) 594 +FEMModalPort (API Object) 601 +FEMModalSource (API Object) 604 +FieldData (API Object) 668 +FieldDataCollection (API Collection) 2408 +FillHoleSettings (API Object) 675 +Find (API Object) 677 +FittedSpline (API Object) 685 +Flare (API Object) 695 +FreeSpace (API Object) 815 +Frequency (API Object) 820 +GeneralNetwork (API Object) 852 +Geometry (API Object) 871 +GeometryCollection (API Collection) 2460 +GeometryExporter (API Object) 877 +GeometryGroup (API Collection) 2477 +GeometryGroupCollection (API Collection) 2482 +GeometryImporter (API Object) 882 +GeometryRebuild (API Object) 884 +GeometryRepair (API Object) 889 +GlobalMeshSettings (API Object) 898 +Graph (API Object) 3358 +GraphAnnotation (API Object) 3365 +Ground (API Object) 913 +GroundPlane (API Object) 917 +GroundPlaneMedium (API Object) 921 +Helix (API Object) 931 +Hexagon (API Object) 939 +HexagonShape (API Object) 943 +HyperbolicArc (API Object) 960 +ImpedanceOptimisationGoal (API Object) 965 +ImpedanceSheet (API Object) 970 +ImpedanceSheetCollection (API Collection) 2486 +ImplicitPointsAnnotation (API Object) 3382 +Importer (API Object) 973 +ImportSet (API Object) 3386 +ImpressedCurrent (API Object) 979 +ImprintPoints (API Object) 987 +Inductor (API Object) 993 +Intersect (API Object) 1005 +KBL (API Object) 1017 +Launcher (API Object) 1026 +LaunchResult (API Object) 1021 +LayeredAnisotropicDielectric (API Object) 1031 +LayeredDielectric (API Object) 1033 +LayeredDielectricCollection (API Collection) 2492 +LayeredIsotropicDielectric (API Object) 1037 +LibraryMedium (API Object) 1040 +Line (API Object) 1047 +LinearPlanarArray (API Object) 1054 +Load (API Object) 1060 +LoadCollection (API Collection) 2498 +LoadMathScript (API Object) 3436 +LoadSmithTrace (API Object) 3457 +LoadTrace (API Object) 3467 +LocalMeshSettings (API Object) 1074 +Loft (API Object) 1089 +MagneticDipole (API Object) 1104 +MainWindow (API Object) 1114 +MathScript (API Object) 3479 +MathTrace (API Object) 3484 +Matrix (API Object) 3495 +MdiSubWindow (API Object) 1122 +Media (API Object) 1129 +MediaLibrary (API Collection) 2502 +Medium (API Object) 1133 +Mesh (API Object) 1142 +MeshCurvilinearSegmentWire (API Object) 1156 +MeshCurvilinearTriangleFace (API Object) 1163 +MeshCurvilinearTriangleFaceCollection (API Collection) 2507 +MeshCurvilinearWire (API Object) 1166 +MeshCylinder (API Object) 1169 +MeshCylinderCollection (API Collection) 2511 +Mesher (API Object) 1246 +MeshExporter (API Object) 1174 +MeshFind (API Object) 1178 +MeshImporter (API Object) 1185 +MeshInfo (API Object) 1196 +MeshPlate (API Object) 1202 +MeshPlateCollection (API Collection) 2515 +MeshRefinementRule (API Object) 1208 +MeshRefinementRuleCollection (API Collection) 2519 +MeshRegion (API Object) 1210 +MeshSegmentCurvilinearWireCollection (API Collection) 2523 +MeshSegmentWire (API Object) 1219 +MeshSegmentWireCollection (API Collection) 2527 +MeshSettings (API Object) 1225 +MeshSettingsCollection (API Collection) 2531 +MeshTetrahedronRegion (API Object) 1231 +MeshTetrahedronRegionCollection (API Collection) 2535 +MeshTriangleFace (API Object) 1237 +MeshTriangleFaceCollection (API Collection) 2539 +MeshWire (API Object) 1242 +MessageWindow (API Object) 1249 +Metal (API Object) 1256 +MetalCollection (API Collection) 2543 +MicrostripMeshPort (API Object) 1264 +MicrostripPort (API Object) 1269 +Mirror (API Object) 1276 +Model (API Object) 1281 +ModelAttributes (API Object) 1284 +ModelContents (API Object) 1288 +ModelDecompositionCollection (API Collection) 2547 +ModelDefinitions (API Object) 1292 +ModelMeshInfo (API Object) 1302 +ModelSymmetry (API Object) 1305 +NamedPoint (API Object) 1310 +NamedPointCollection (API Collection) 2551 +NearField (API Object) 1319 +NearField3DPlot (API Object) 3587 +NearFieldCollection (API Collection) 2560 +NearFieldDataFileStructure (API Object) 1336 +NearFieldDataFullImport (API Object) 1343 +NearFieldMathScript (API Object) 3598 +NearFieldOptimisationGoal (API Object) 1352 +NearFieldPowerIntegralTrace (API Object) 3608 +NearFieldReceivingAntenna (API Object) 1359 +NearFieldReceivingAntennaCollection (API Collection) 2565 +NearFieldSource (API Object) 1366 +NearFieldTrace (API Object) 3633 +Net (API Object) 1369 +NetCollection (API Collection) 2569 +Network (API Object) 1372 +NetworkCollection (API Collection) 2576 +NetworkMathScript (API Object) 3642 +NetworkTrace (API Object) 3650 +NumericalGreensFunction (API Object) 1379 +NurbsSurface (API Object) 1392 +Object (API Object) 1427 +OpenRing (API Object) 1440 +OpenRingShape (API Object) 1444 +OperatorCollection (API Collection) 2580 +Optimisation (API Object) 1447 +OptimisationCombination (API Object) 1451 +OptimisationGoal (API Object) 1458 +OptimisationGoalCollection (API Collection) 2586 +OptimisationGoalObjective (API Object) 1462 +OptimisationMask (API Object) 1469 +OptimisationMaskCollection (API Collection) 2591 +OptimisationOperator (API Object) 1476 +OptimisationParameters (API Object) 1479 +OptimisationSearch (API Object) 1484 +OptimisationSearchAdvancedSettings (API Object) 1487 +OptimisationSearchCollection (API Collection) 2595 +ParabolicArc (API Object) 1530 +Paraboloid (API Object) 1538 +PathSweep (API Object) 1565 +PCB (API Object) 1502 +PCBCurrentData (API Object) 1507 +PCBSource (API Object) 1513 +PerfectElectricConductor (API Object) 1568 +PerfectMagneticConductor (API Object) 1571 +PeriodicBoundary (API Object) 1579 +PlaneShape (API Object) 1595 +PlaneWave (API Object) 1601 +PointRefinement (API Object) 1623 +PolarGraph (API Object) 3678 +Polygon (API Object) 1636 +Polyline (API Object) 1644 +PolylineRefinement (API Object) 1650 +Port (API Object) 1654 +PortCollection (API Collection) 2609 +Power (API Object) 1662 +PowerMathScript (API Object) 3693 +PowerOptimisationGoal (API Object) 1667 +PowerTrace (API Object) 3703 +Primitive (API Object) 1677 +ProjectGeometry (API Object) 1686 +ProtectedModel (API Object) 1692 +ProtectedModels (API Collection) 2614 +Ray3DPlot (API Object) 3714 +ReceivingAntennaOptimisationGoal (API Object) 1714 +ReceivingAntennaTrace (API Object) 3733 +Rectangle (API Object) 1721 +Region (API Object) 1732 +RegionCollection (API Collection) 2619 +RemoveSmallFeaturesSettings (API Object) 1737 +RepairAndSewFaces (API Object) 1745 +RepairAndSewFacesSettings (API Object) 1749 +RepairEdgesSettings (API Object) 1752 +RepairPart (API Object) 1759 +RepairPartsSettings (API Object) 1765 +ReportTemplate (API Object) 3740 +Resistor (API Object) 1770 +ResultArrow (API Object) 3751 +ResultTextBox (API Object) 3771 +ResultTrace (API Object) 3777 +Ring (API Object) 1778 +RingShape (API Object) 1783 +Rotate (API Object) 1788 +SAR (API Object) 1793 +SAR3DPlot (API Object) 3781 +SARCollection (API Collection) 2623 +SAROptimisationGoal (API Object) 1797 +SARTrace (API Object) 3793 +Scale (API Object) 1814 +Schematic (API Object) 1817 +SchematicViewWindow (API Object) 1821 +Shape (API Object) 1829 +ShapeCollection (API Collection) 2634 +SimpleAnnotation (API Object) 3827 +Simplify (API Object) 1847 +SimplifyPartRepresentationSettings (API Object) 1861 +SimulationMeshInfo (API Object) 1878 +SmithChart (API Object) 3835 +SolutionCoefficientData (API Object) 1883 +SolutionCoefficientSource (API Object) 1888 +SolutionConfiguration (API Object) 1892 +SolutionConfigurationCollection (API Collection) 2642 +SolutionSettings (API Object) 1895 +SolverSettings (API Object) 1900 +Source (API Object) 1902 +SourceCollection (API Collection) 2655 +SParameter (API Object) 1800 +SParameterConfiguration (API Object) 1804 +SParameterMathScript (API Object) 3803 +SParameterOptimisationGoal (API Object) 1809 +SParameterTrace (API Object) 3820 +Sphere (API Object) 1914 +SphericalModeDataFromFile (API Object) 1924 +SphericalModeDataManuallySpecified (API Object) 1929 +SphericalModeReceivingAntenna (API Object) 1940 +SphericalModeReceivingAntennaCollection (API Collection) 2659 +SphericalModeSource (API Object) 1947 +SpiceProbeTrace (API Object) 3941 +Spin (API Object) 1964 +SpiralCross (API Object) 1973 +SpiralCrossShape (API Object) 1977 +Split (API Object) 1986 +SplitRing (API Object) 1995 +SplitRingShape (API Object) 1999 +StandardConfiguration (API Object) 2005 +Stitch (API Object) 2012 +StripCross (API Object) 2022 +StripCrossShape (API Object) 2026 +StripHexagon (API Object) 2034 +StripHexagonShape (API Object) 2038 +Subtract (API Object) 2045 +SurfaceBezierCurve (API Object) 2054 +SurfaceCurrentsMathScript (API Object) 3956 +SurfaceGraph (API Object) 3963 +SurfaceLine (API Object) 2070 +SurfaceRegularLines (API Object) 2080 +Sweep (API Object) 2089 +TCross (API Object) 2098 +TCrossShape (API Object) 2103 +Terminal (API Object) 2106 +TerminalCollection (API Collection) 2663 +TopologyEntity (API Object) 2109 +TopologyEntityCollectionOf_Edge (API Collection) 2666 +Transform (API Object) 2115 +TransformCollection (API Collection) 2675 +Transformer (API Object) 2120 +Translate (API Object) 2125 +TransmissionLine (API Object) 2130 +TransmissionReflection (API Object) 2134 +TransmissionReflectionCollection (API Collection) 2679 +TransmissionReflectionOptimisationGoal (API Object) 2138 +TRCoefficientMathScript (API Object) 3998 +TRCoefficientTrace (API Object) 4006 +Trifilar (API Object) 2146 +TrifilarShape (API Object) 2150 +Union (API Object) 2164 +UnitCell (API Object) 2169 +UnitCellCollection (API Collection) 2683 +UnprotectedInformation (API Object) 2176 +Variable (API Object) 2181 +VariableCollection (API Collection) 2688 +Version (API Object) 2187 +View (API Object) 4041 +ViewXt (API Object) 2201 +ViewXtWindow (API Object) 2205 +VoltageControlledVoltageSource (API Object) 2210 +VoltageSource (API Object) 2214 +VoxelSettings (API Object) 2228 +WaveguideMeshPort (API Object) 2233 +WaveguidePort (API Object) 2243 +WaveguideSource (API Object) 2248 +WidthAnnotation (API Object) 4070 +Windscreen (API Object) 2251 +WindscreenCollection (API Collection) 2692 +WireCollection (API Collection) 2697 +WireCurrentsMathScript (API Object) 4087 +WireCurrentsTrace (API Object) 4097 +WireMeshPort (API Object) 2260 +WirePort (API Object) 2265 +Workplane (API Object) 2275 +WorkplaneCollection (API Collection) 2706 +WorkSurface (API Object) 2270 +WorkSurfaceCollection (API Collection) 2701 +Zero (API Object) 2280 +DuplicateAsCartesian (API Method) +PolarGraph (API Object) 3678 +SmithChart (API Object) 3835 +DuplicateAsPolar (API Method) +CartesianGraph (API Object) 2959 +DuplicateAsSmith (API Method) +CartesianGraph (API Object) 2959 +DynamicRange (API Property) +RadialGraphAxis (API Object) 3710 +VerticalGraphAxis (API Object) 4032 +DynamicRangeMax (API Property) +Legend3DLogarithmicRangeFormat (API Object) 3407 +SurfacePlotLegendLogarithmicRangeFormat (API Object) 3988 +Eccentricity (API Property) +EllipticArc (API Object) 526 +HyperbolicArc (API Object) 956 +Edge (API Object) 488 +EdgeAndWedgeDiffractions (API Property) +RayContributionsFacetedUTD (API Object) 1699 +RayContributionsRLGO (API Object) 1703 +RayContributionsUTD (API Object) 1708 +EdgeCollection (API Collection) 2378 +EdgeLength (API Property) +SpiralCross (API Object) 1969 +SpiralCrossShape (API Object) 1976 +TCross (API Object) 2095 +TCrossShape (API Object) 2102 +EdgeLoop (API Method) +Find (API Object) 677 +EdgeMeshPort (API Object) 495 +EdgePort (API Object) 500 +Edges (API Collection) +AbstractSurfaceCurve (API Object) 99 +AnalyticalCurve (API Object) 123 +BezierCurve (API Object) 164 +Cone (API Object) 354 +ConstrainedSurface (API Object) 368 +Cross (API Object) 381 +Cuboid (API Object) 393 +Cylinder (API Object) 425 +Ellipse (API Object) 515 +EllipticArc (API Object) 528 +FittedSpline (API Object) 682 +Flare (API Object) 693 +Geometry (API Object) 869 +Helix (API Object) 928 +Hexagon (API Object) 937 +HyperbolicArc (API Object) 958 +ImprintPoints (API Object) 985 +Intersect (API Object) 1003 +Line (API Object) 1045 +Loft (API Object) 1086 +NurbsSurface (API Object) 1390 +OpenRing (API Object) 1437 +ParabolicArc (API Object) 1528 +Paraboloid (API Object) 1536 +PathSweep (API Object) 1563 +Polygon (API Object) 1633 +Polyline (API Object) 1641 +Primitive (API Object) 1675 +ProjectGeometry (API Object) 1684 +Rectangle (API Object) 1719 +RepairAndSewFaces (API Object) 1743 +RepairPart (API Object) 1757 +Ring (API Object) 1776 +Simplify (API Object) 1845 +Sphere (API Object) 1912 +Spin (API Object) 1961 +SpiralCross (API Object) 1970 +Split (API Object) 1984 +SplitRing (API Object) 1992 +Stitch (API Object) 2010 +StripCross (API Object) 2019 +StripHexagon (API Object) 2032 +Subtract (API Object) 2043 +SurfaceBezierCurve (API Object) 2051 +SurfaceLine (API Object) 2068 +SurfaceRegularLines (API Object) 2078 +Sweep (API Object) 2087 +TCross (API Object) 2096 +Trifilar (API Object) 2144 +Union (API Object) 2162 +Edges (API Property) +FEMLinePort (API Object) 584 +MeshRendering (API Object) 3547 +MicrostripPort (API Object) 1267 +EdgeSettings (API Property) +Simplify (API Object) 1843 +EdgeStandardDeviation (API Property) +MeshInfo (API Object) 1191 +ModelMeshInfo (API Object) 1297 +SimulationMeshInfo (API Object) 1873 +EdgeTolerance (API Property) +SimplifyPartRepresentationSettings (API Object) 1859 +EdgeType (API Property) +Edge (API Object) 491 +MeshCurvilinearSegmentWire (API Object) 1154 +MeshSegmentWire (API Object) 1217 +editor 11 +EFieldFilename (API Property) +NearFieldDataFileStructure (API Object) 1333 +NearFieldDataFullImport (API Object) 1340 +ElectricDipole (API Object) 505 +ElementOrder (API Property) +BasisFunctionGlobalSolverSettings (API Object) 153 +BasisFunctionLocalSolverSettings (API Object) 158 +FEMSettings (API Object) 605 +ElementsRotated (API Property) +CylindricalAntennaArray (API Object) 433 +ElementType (API Property) +WindscreenSolutionMethod (API Object) 2254 +Ellipse (API Object) 511 +EllipseShape (API Object) 519 +EllipticArc (API Object) 522 +Ellipticity (API Property) +PlaneWave (API Object) 1598 +ElongatedTrianglesAllowed (API Property) +MeshAdvancedSettings (API Object) 1146 +Enabled (API Property) +FEKOParallelExecutionOptions (API Object) 567, 3160 +FEKORemoteExecutionOptions (API Object) 570, 3161 +FormCheckBox (API Object) 706, 3228 +FormComboBox (API Object) 711, 3233 +FormConfigurationSelector (API Object) 3238 +FormDataSelector (API Object) 3244 +FormDirectoryBrowser (API Object) 716, 3249 +FormDoubleSpinBox (API Object) 722, 3255 +FormFileBrowser (API Object) 728, 3261 +FormFileSaveAsBrowser (API Object) 734, 3267 +FormGroupBox (API Object) 740, 3273 +FormImage (API Object) 745, 3278 +FormIntegerSpinBox (API Object) 751, 3284 +FormItem (API Object) 757, 3290 +FormLabel (API Object) 760, 3293 +FormLabelledItem (API Object) 764, 3297 +FormLayout (API Object) 769, 3302 +FormLineEdit (API Object) 775, 3308 +FormModelSelector (API Object) 3312 +FormPushButton (API Object) 784, 3322 +FormRadioButtonGroup (API Object) 790, 3328 +FormScrollArea (API Object) 796, 3334 +FormSeparator (API Object) 801, 3339 +FormTree (API Object) 806, 3344 +Normalisation (API Object) 3653 +NumericalGreensFunction (API Object) 1378 +OptimisationConstraint (API Object) 1453 +OptimisationVariable (API Object) 1490 +RLGOFaceAbsorbingSettings (API Object) 1695 +TraceMathExpression (API Object) 4023 +EnableFacetedUTDAcceleration (API Property) +HighFrequencySettings (API Object) 946 +End (API Property) +FEMLineMeshPort (API Object) 576 +FEMLinePort (API Object) 584 +Frequency (API Object) 818 +PointRange (API Object) 1613 +ReferenceDirection (API Object) 1725 +EndAngle (API Property) +EllipticArc (API Object) 526 +EndCapTerminated (API Property) +UTDCylinderTerminationType (API Object) 2151 +EndCornerPoint (API Property) +SurfaceRegularLines (API Object) 2076 +EndFrequency (API Property) +SolutionConfiguration (API Object) 3843 +EndMagnitude (API Property) +ImpressedCurrent (API Object) 976 +EndPhase (API Property) +ImpressedCurrent (API Object) 976 +EndPoint (API Property) +Line (API Object) 1043 +SurfaceBezierCurve (API Object) 2049 +SurfaceLine (API Object) 2066 +EndPointVectorOne (API Property) +PeriodicBoundary (API Object) 1575 +EndPointVectorTwo (API Property) +PeriodicBoundary (API Object) 1576 +EndPosition (API Property) +ImpressedCurrent (API Object) 976 +EndPositionX (API Property) +ResultArrow (API Object) 3750 +EndPositionY (API Property) +ResultArrow (API Object) 3750 +EndRadius (API Property) +Helix (API Object) 926 +EndTangentPoint (API Property) +SurfaceBezierCurve (API Object) 2050 +EndTerminal (API Property) +CablePath (API Object) 228 +Net (API Object) 1368 +EndVertex (API Property) +FEMLineMeshPort (API Object) 576 +MicrostripMeshPort (API Object) 1263 +Environment (API Property) +ComponentLaunchOptions (API Object) 340, 3041 +ErrorEstimate3DPlot (API Object) 3113 +ErrorEstimateCollection (API Collection) 4122 +ErrorEstimateData (API Object) 3118 +ErrorEstimates (API Collection) +SolutionConfiguration (API Object) 3845 +ErrorEstimatesQuantity (API Object) 3120 +ErrorEstimation (API Object) 532 +ErrorEstimationCollection (API Collection) 2383 +ErrorEstimations (API Collection) +StandardConfiguration (API Object) 2004 +Errors (API Property) +Interpolator (API Object) 3390 +LaunchResult (API Object) 1020, 3398 +ErrorsIgnored (API Property) +PREFEKOLaunchOptions (API Object) 1515, 3657 +EvaluatedValue (API Property) +Variable (API Object) 2179 +example +Lua 24 +ExcitationCollection (API Collection) 4125 +ExcitationData (API Object) 3122 +ExcitationMathScript (API Object) 3126 +ExcitationQuantity (API Object) 3129 +Excitations (API Collection) +SolutionConfiguration (API Object) 3845 +ExcitationSmithQuantity (API Object) 3133 +ExcitationSmithTrace (API Object) 3136 +ExcitationStoredData (API Object) 3143 +ExcitationTrace (API Object) 3146 +ExecutionMethod (API Property) +FEKORemoteExecutionOptions (API Object) 570, 3161 +Exit (API Method) +Application (API Object) 146 +ExitCode (API Property) +LaunchResult (API Object) 1020, 3398 +Expanded (API Property) +FormTreeItem (API Object) 811, 3349 +Explode (API Method) +AbstractSurfaceCurve (API Object) 102 +AnalyticalCurve (API Object) 125 +BezierCurve (API Object) 167 +Cone (API Object) 356 +ConstrainedSurface (API Object) 370 +Cross (API Object) 384 +Cuboid (API Object) 396 +Cylinder (API Object) 428 +Ellipse (API Object) 517 +EllipticArc (API Object) 530 +FittedSpline (API Object) 685 +Flare (API Object) 695 +Geometry (API Object) 872 +Helix (API Object) 931 +Hexagon (API Object) 939 +HyperbolicArc (API Object) 960 +ImprintPoints (API Object) 987 +Intersect (API Object) 1005 +Line (API Object) 1047 +Loft (API Object) 1089 +NurbsSurface (API Object) 1392 +OpenRing (API Object) 1440 +ParabolicArc (API Object) 1530 +Paraboloid (API Object) 1538 +PathSweep (API Object) 1565 +Polygon (API Object) 1636 +Polyline (API Object) 1644 +Primitive (API Object) 1678 +ProjectGeometry (API Object) 1686 +Rectangle (API Object) 1722 +RepairAndSewFaces (API Object) 1745 +RepairPart (API Object) 1759 +Ring (API Object) 1778 +Simplify (API Object) 1847 +Sphere (API Object) 1914 +Spin (API Object) 1964 +SpiralCross (API Object) 1973 +Split (API Object) 1986 +SplitRing (API Object) 1995 +Stitch (API Object) 2013 +StripCross (API Object) 2022 +StripHexagon (API Object) 2034 +Subtract (API Object) 2045 +SurfaceBezierCurve (API Object) 2054 +SurfaceLine (API Object) 2071 +SurfaceRegularLines (API Object) 2080 +Sweep (API Object) 2090 +TCross (API Object) 2099 +Trifilar (API Object) 2146 +Union (API Object) 2164 +Exponent (API StaticFunction) +Complex (API Object) 322, 3002 +ComplexMatrix (API Object) 3023 +Matrix (API Object) 3500 +Export (API Method) +GeometryExporter (API Object) 877 +MeshExporter (API Object) 1174 +Export (API Property) +Frequency (API Object) 819 +ExportAllWindowsAsImages (API Method) +Application (API Object) 2933, 2933 +ExportAnimation (API Method) +View (API Object) 4041 +ExportCableParametersEnabled (API Property) +CablePath (API Object) 228 +ExportData (API Method) +CustomStoredData (API Object) 3083 +ExcitationData (API Object) 3124, 3125 +ExcitationStoredData (API Object) 3144 +FarFieldData (API Object) 3176 +FarFieldStoredData (API Object) 3202 +NearFieldData (API Object) 3592 +NearFieldStoredData (API Object) 3619 +SourceAperture (API Object) 3849, 3850 +SourceCoaxial (API Object) 3853, 3854 +SourceCurrentRegion (API Object) 3858, 3859 +SourceCurrentSpace (API Object) 3862, 3863 +SourceCurrentTriangle (API Object) 3865, 3866 +SourceElectricDipole (API Object) 3868, 3869 +SourceMagneticDipole (API Object) 3871, 3872 +SourceMagneticFrill (API Object) 3875, 3876 +SourceModal (API Object) 3880, 3881 +SourcePCB (API Object) 3884, 3885 +SourcePlaneWave (API Object) 3887, 3888 +SourceRadiationPattern (API Object) 3890, 3891 +SourceSolutionCoefficient (API Object) 3893, 3894 +SourceSphericalModes (API Object) 3896, 3897 +SourceVoltageCable (API Object) 3900, 3901 +SourceVoltageEdge (API Object) 3905, 3906 +SourceVoltageNetwork (API Object) 3910, 3911 +SourceVoltageSegment (API Object) 3915, 3916 +SourceVoltageVertex (API Object) 3920, 3921 +SourceWaveguide (API Object) 3925, 3926 +SParameterData (API Object) 3798, 3799 +SParameterStoredData (API Object) 3807, 3808 +SurfaceCurrentsData (API Object) 3952 +TRCoefficientData (API Object) 3994 +TRCoefficientStoredData (API Object) 4000, 4000 +WireCurrentsData (API Object) 4084 +ExportDataSet (API Function) +DRE (API Object) 4294 +ExportEnabled (API Property) +ErrorEstimation (API Object) 533 +TransmissionReflection (API Object) 2133 +Exporter (API Object) 535 +Exporter (API Property) +Model (API Object) 1279 +ExportFarFields (API Method) +SolutionConfiguration (API Object) 3847 +ExportFileFormat (API Property) +GeometryExporter (API Object) 875 +MeshExporter (API Object) 1172 +ExportGeometryToOutFile (API Property) +GeneralSolverSettings (API Object) 855 +ExportImage (API Method) +CartesianGraph (API Object) 2959, 2959 +CartesianSurfaceGraph (API Object) 2971, 2971 +Graph (API Object) 3358, 3358 +PolarGraph (API Object) 3679, 3679 +SmithChart (API Object) 3836, 3836 +SurfaceGraph (API Object) 3964, 3964 +View (API Object) 4042, 4042 +ViewXtWindow (API Object) 2205, 2205, 2205 +Window (API Object) 4073, 4074 +ExportIsoSurfaceToSTL (API Method) +NearField3DPlot (API Object) 3587 +ExportMatFile (API Function) +MatIO (API Object) 4306, 4307, 4307, 4307 +ExportMatFile (API Method) +ComplexMatrix (API Object) 3018 +DataSet (API Object) 3092 +Matrix (API Object) 3495 +ExportMeshType (API Property) +MeshExporter (API Object) 1172 +ExportNearFields (API Method) +SolutionConfiguration (API Object) 3847 +ExportOnlyBoundingFacesEnabled (API Property) +MeshExporter (API Object) 1173 +ExportParts (API Method) +GeometryExporter (API Object) 877 +MeshExporter (API Object) 1174 +ExportReportTemplate (API Method) +ReportTemplate (API Object) 3740 +ExportSettings (API Property) +Currents (API Object) 403 +FarFieldAdvancedSettings (API Object) 624 +NearFieldAdvancedSettings (API Object) 1321 +ExportSPICEMTLCircuitFilesEnabled (API Property) +FEKOLaunchOptions (API Object) 558, 3155 +ExportToASCIIEnabled (API Property) +FarFieldSphericalModeSettings (API Object) 661 +ExportTraces (API Method) +CartesianGraph (API Object) 2959 +Graph (API Object) 3359 +PolarGraph (API Object) 3679 +SmithChart (API Object) 3836 +ExportVariables (API Property) +PREFEKOLaunchOptions (API Object) 1516, 3658 +Expression (API Property) +MathTrace (API Object) 3482 +TraceMathExpression (API Object) 4023 +Variable (API Object) 2180 +ExpressionList (API Object) 538 +ExpressionTable (API Object) 540 +ExtrudeEnabled (API Property) +GeometryImporter (API Object) 880 +Extrusion (API Property) +CustomData3DFormat (API Object) 3047 +FarField3DFormat (API Object) 3164 +NearField3DFormat (API Object) 3581 +Face (API Object) 609 +Face (API Property) +WaveguideMeshPort (API Object) 2232 +WaveguidePort (API Object) 2242 +FaceAbsorbingSettings (API Property) +Face (API Object) 612 +MeshCurvilinearTriangleFace (API Object) 1161 +MeshPlate (API Object) 1200 +MeshTriangleFace (API Object) 1235 +FaceCollection (API Collection) 2387 +Faces (API Collection) +AbstractSurfaceCurve (API Object) 99 +AnalyticalCurve (API Object) 123 +BezierCurve (API Object) 164 +Cone (API Object) 354 +ConstrainedSurface (API Object) 368 +Cross (API Object) 381 +Cuboid (API Object) 394 +Cylinder (API Object) 426 +Ellipse (API Object) 515 +EllipticArc (API Object) 528 +FittedSpline (API Object) 683 +Flare (API Object) 693 +Geometry (API Object) 869 +Helix (API Object) 928 +Hexagon (API Object) 937 +HyperbolicArc (API Object) 958 +ImprintPoints (API Object) 985 +Intersect (API Object) 1003 +Line (API Object) 1045 +Loft (API Object) 1086 +Mesh (API Object) 1139 +NurbsSurface (API Object) 1390 +OpenRing (API Object) 1437 +ParabolicArc (API Object) 1528 +Paraboloid (API Object) 1536 +PathSweep (API Object) 1563 +Polygon (API Object) 1634 +Polyline (API Object) 1642 +Primitive (API Object) 1675 +ProjectGeometry (API Object) 1684 +Rectangle (API Object) 1719 +RepairAndSewFaces (API Object) 1743 +RepairPart (API Object) 1757 +Ring (API Object) 1776 +Simplify (API Object) 1845 +Sphere (API Object) 1912 +Spin (API Object) 1961 +SpiralCross (API Object) 1970 +Split (API Object) 1984 +SplitRing (API Object) 1992 +Stitch (API Object) 2010 +StripCross (API Object) 2019 +StripHexagon (API Object) 2032 +Subtract (API Object) 2043 +SurfaceBezierCurve (API Object) 2052 +SurfaceLine (API Object) 2068 +SurfaceRegularLines (API Object) 2078 +Sweep (API Object) 2087 +TCross (API Object) 2096 +Trifilar (API Object) 2144 +Union (API Object) 2162 +Faces (API Property) +FEMModalPort (API Object) 598 +MeshRendering (API Object) 3547 +FaceSettings (API Property) +Simplify (API Object) 1843 +Factor (API Property) +Scale (API Object) 1811 +FactorisationType (API Property) +PreconditionerSettings (API Object) 1669 +Family (API Property) +FontFormat (API Object) 3218 +SurfaceGraphFontFormat (API Object) 3975 +FarField (API Object) 616 +FarField3DFormat (API Object) 3163 +FarField3DPlot (API Object) 3166 +FarFieldAdvancedSettings (API Object) 623 +FarFieldAdvancedSettingsList (API Object) 626 +FarFieldCalculationMethod (API Property) +MLFMMSolverSettings (API Object) 1096 +FarFieldCollection (API Collection) 2392, 4128 +FarFieldData (API Object) 628, 3173 +FarFieldExportSettings (API Object) 634 +FarFieldExportSettingsList (API Object) 636 +FarFieldIncluded (API Property) +FrequencyContinuousQuantities (API Object) 826 +FarFieldMathScript (API Object) 3180 +FarFieldOptimisationGoal (API Object) 638 +FarFieldPBCSettings (API Object) 643 +FarFieldPBCSettingsList (API Object) 645 +FarFieldPowerIntegralCollection (API Collection) 4131 +FarFieldPowerIntegralData (API Object) 3183 +FarFieldPowerIntegrals (API Collection) +SolutionConfiguration (API Object) 3845 +FarFieldPowerIntegralStoredData (API Object) 3186 +FarFieldPowerIntegralTrace (API Object) 3188 +FarFieldQuantity (API Object) 3195 +FarFieldReceivingAntenna (API Object) 647 +FarFieldReceivingAntennaCollection (API Collection) 2398 +FarFieldReceivingAntennaData (API Object) 3198 +FarFieldReceivingAntennas (API Collection) +StandardConfiguration (API Object) 2004 +FarFields (API Collection) +CharacteristicModesConfiguration (API Object) 307 +SolutionConfiguration (API Object) 3845 +StandardConfiguration (API Object) 2004 +FarFieldSource (API Object) 653 +FarFieldSphericalModeSettings (API Object) 660 +FarFieldSphericalModeSettingsList (API Object) 662 +FarFieldStoredData (API Object) 3201 +FarFieldSurfacePlot (API Object) 3204 +FarFieldTrace (API Object) 3210 +FarmOutEnabled (API Property) +OPTFEKOLaunchOptions (API Object) 1395, 3655 +Faulty (API Property) +AbstractSurfaceCurve (API Object) 98 +AnalyticalCurve (API Object) 121 +BezierCurve (API Object) 163 +Cone (API Object) 352 +ConstrainedSurface (API Object) 366 +Cross (API Object) 380 +Cuboid (API Object) 392 +Cylinder (API Object) 424 +Edge (API Object) 491 +Ellipse (API Object) 513 +EllipticArc (API Object) 526 +Face (API Object) 612 +FittedSpline (API Object) 681 +Flare (API Object) 691 +Geometry (API Object) 868 +Helix (API Object) 926 +Hexagon (API Object) 935 +HyperbolicArc (API Object) 956 +ImprintPoints (API Object) 983 +Intersect (API Object) 1001 +Line (API Object) 1043 +Loft (API Object) 1085 +NurbsSurface (API Object) 1388 +OpenRing (API Object) 1435 +ParabolicArc (API Object) 1526 +Paraboloid (API Object) 1534 +PathSweep (API Object) 1561 +Polygon (API Object) 1632 +Polyline (API Object) 1640 +Primitive (API Object) 1674 +ProjectGeometry (API Object) 1682 +Rectangle (API Object) 1718 +Region (API Object) 1730 +RepairAndSewFaces (API Object) 1741 +RepairPart (API Object) 1755 +Ring (API Object) 1774 +Simplify (API Object) 1843 +Sphere (API Object) 1910 +Spin (API Object) 1960 +SpiralCross (API Object) 1969 +Split (API Object) 1982 +SplitRing (API Object) 1990 +Stitch (API Object) 2009 +StripCross (API Object) 2018 +StripHexagon (API Object) 2030 +Subtract (API Object) 2041 +SurfaceBezierCurve (API Object) 2050 +SurfaceLine (API Object) 2066 +SurfaceRegularLines (API Object) 2076 +Sweep (API Object) 2085 +TCross (API Object) 2095 +TopologyEntity (API Object) 2109 +Trifilar (API Object) 2142 +Union (API Object) 2160 +FaultyParts (API Property) +GeometryCollection (API Collection) 2431 +FDTD (API Property) +FrequencyAdvancedSettings (API Object) 822 +FDTDBoundary (API Property) +SolutionSettings (API Object) 1894 +FDTDBoundaryConditions (API Object) 542 +FDTDBoundarySettings (API Object) 546 +FDTDBoundarySettingsList (API Object) 548 +FDTDEnabled (API Property) +FDTDSettings (API Object) 550 +FDTDSettings (API Object) 550 +FDTDSettings (API Property) +SolverSettings (API Object) 1898 +FDTDSettingsList (API Object) 551 +FEKO (API Property) +ComponentLaunchOptions (API Object) 340, 3041 +FEKO_HOME 20 +FEKO_USER_HOME 20 +FEKOGPUOptions (API Object) 553, 3152 +FEKOGPUOptionsList (API Object) 555 +FEKOLaunchOptions (API Object) 557, 3154 +FEKOLaunchOptionsList (API Object) 560 +FEKOParallelDiagnosticTests (API Object) 562, 3157 +FEKOParallelDiagnosticTestsList (API Object) 564 +FEKOParallelExecutionOptions (API Object) 566, 3159 +FEKOParallelExecutionOptionsList (API Object) 568 +FEKORemoteExecutionOptions (API Object) 570, 3161 +FEKORemoteExecutionOptionsList (API Object) 572 +FEMLineMeshPort (API Object) 574 +FEMLinePort (API Object) 582 +FEMModalMeshPort (API Object) 590 +FEMModalPort (API Object) 596 +FEMModalSource (API Object) 602 +FEMSettings (API Object) 605 +FEMSettings (API Property) +SolverSettings (API Object) 1899 +FEMSettingsList (API Object) 607 +FFT (API Method) +ComplexMatrix (API Object) 3018 +Matrix (API Object) 3496 +FibreMedium (API Property) +CableNonConductingElementCrossSection (API Object) 224 +FibreRadius (API Property) +CableNonConductingElementCrossSection (API Object) 224 +FieldData (API Object) 664 +FieldData (API Property) +FarFieldReceivingAntenna (API Object) 649 +FarFieldSource (API Object) 655 +NearFieldReceivingAntenna (API Object) 1356 +NearFieldSource (API Object) 1363 +PCBSource (API Object) 1510 +SolutionCoefficientSource (API Object) 1886 +SphericalModeReceivingAntenna (API Object) 1937 +SphericalModeSource (API Object) 1944 +FieldDataCollection (API Collection) 2402 +FieldDataFileImportDefinitionTypeEnum (API Property) +FarFieldData (API Object) 630 +FieldDataList (API Collection) +ModelDefinitions (API Object) 1291 +FieldDirection (API Property) +PolderTensor (API Object) 1626 +FieldOnlyIntegrated (API Property) +FarFieldAdvancedSettings (API Object) 624 +FilamentDiameter (API Property) +ShieldLayerSettings (API Object) 1833 +FilamentMedium (API Property) +ShieldLayerSettings (API Object) 1833 +Filename (API Property) +CableGeneralNetwork (API Object) 212 +CableSpiceNetwork (API Object) 270 +CharacterisedSurface (API Object) 300 +ComplexLoad (API Object) 331 +Dielectric (API Object) 463 +FarFieldData (API Object) 630 +FreeSpace (API Object) 814 +GeneralNetwork (API Object) 850 +GroundPlaneMedium (API Object) 920 +ImpedanceSheet (API Object) 968 +ImportSet (API Object) 3385 +Load (API Object) 1058 +Metal (API Object) 1254 +NearFieldDataFullImport (API Object) 1340 +PCBCurrentData (API Object) 1505 +ProtectedModel (API Object) 1690 +SolutionCoefficientData (API Object) 1880 +SphericalModeDataFromFile (API Object) 1921 +Zero (API Object) 2279 +FileReference (API Object) 669 +FileReferenceList (API Object) 671 +FilesDeleted (API Property) +OPTFEKOLaunchOptions (API Object) 1395, 3656 +FileType (API Property) +FarFieldData (API Object) 630 +FillHole (API Method) +GeometryRebuild (API Object) 885 +FillHoleSettings (API Object) 673 +FillHoleSettings (API Property) +GeometryRebuild (API Object) 884 +FillInPerRow (API Property) +IterativeSolverSettings (API Object) 1012 +FilteredEntities (API Property) +Cutplane (API Object) 416 +Find (API Object) 676 +Find (API Property) +GeometryCollection (API Collection) 2431 +Find (API StaticFunction) +ComplexMatrix (API Object) 3023 +Matrix (API Object) 3500 +FiniteAntennaArraysVisible (API Property) +View3DSolutionEntityFormat (API Object) 4057 +FiniteThickness (API Property) +UnitCellLayer (API Object) 2171 +FirstVector (API Property) +PeriodicBoundaryPhaseShift (API Object) 1586 +FittedSpline (API Object) 679 +FixedAxes (API Property) +CharacteristicModeTrace (API Object) 2988 +CustomData3DPlot (API Object) 3051 +CustomDataSmithTrace (API Object) 3059 +CustomDataSurfacePlot (API Object) 3066 +CustomDataTrace (API Object) 3072 +ErrorEstimate3DPlot (API Object) 3114 +ExcitationSmithTrace (API Object) 3138 +FarField3DPlot (API Object) 3168 +FarFieldPowerIntegralTrace (API Object) 3190 +FarFieldSurfacePlot (API Object) 3206 +FarFieldTrace (API Object) 3212 +LoadSmithTrace (API Object) 3455 +LoadTrace (API Object) 3465 +NearField3DPlot (API Object) 3585 +NearFieldPowerIntegralTrace (API Object) 3605 +NearFieldSurfacePlot (API Object) 3623 +NearFieldTrace (API Object) 3631 +NetworkTrace (API Object) 3648 +PowerTrace (API Object) 3701 +SARTrace (API Object) 3791 +SParameterSurfacePlot (API Object) 3812 +SParameterTrace (API Object) 3818 +SurfaceCurrents3DPlot (API Object) 3945 +TRCoefficientTrace (API Object) 4004 +WireCurrents3DPlot (API Object) 4077 +WireCurrentsTrace (API Object) 4094 +FixedHeight (API Property) +FormCheckBox (API Object) 706, 3228 +FormComboBox (API Object) 711, 3233 +FormConfigurationSelector (API Object) 3239 +FormDataSelector (API Object) 3244 +FormDirectoryBrowser (API Object) 717, 3250 +FormDoubleSpinBox (API Object) 722, 3255 +FormFileBrowser (API Object) 728, 3261 +FormFileSaveAsBrowser (API Object) 734, 3267 +FormGroupBox (API Object) 740, 3273 +FormImage (API Object) 746, 3279 +FormIntegerSpinBox (API Object) 751, 3284 +FormItem (API Object) 757, 3290 +FormLabel (API Object) 761, 3293 +FormLabelledItem (API Object) 765, 3298 +FormLayout (API Object) 769, 3302 +FormLineEdit (API Object) 775, 3308 +FormModelSelector (API Object) 3313 +FormPushButton (API Object) 784, 3322 +FormRadioButtonGroup (API Object) 790, 3328 +FormScrollArea (API Object) 796, 3334 +FormSeparator (API Object) 802, 3340 +FormTree (API Object) 806, 3344 +FixedRangeMax (API Property) +Legend3DLinearRangeFormat (API Object) 3405 +Legend3DLogarithmicRangeFormat (API Object) 3407 +SurfacePlotLegendLinearRangeFormat (API Object) 3986 +SurfacePlotLegendLogarithmicRangeFormat (API Object) 3988 +FixedRangeMin (API Property) +Legend3DLinearRangeFormat (API Object) 3405 +Legend3DLogarithmicRangeFormat (API Object) 3408 +SurfacePlotLegendLinearRangeFormat (API Object) 3986 +SurfacePlotLegendLogarithmicRangeFormat (API Object) 3989 +FixedSize (API Property) +Arrows3DFormat (API Object) 2937 +FixedWidth (API Property) +FormCheckBox (API Object) 706, 3228 +FormComboBox (API Object) 711, 3233 +FormConfigurationSelector (API Object) 3239 +FormDataSelector (API Object) 3244 +FormDirectoryBrowser (API Object) 717, 3250 +FormDoubleSpinBox (API Object) 722, 3255 +FormFileBrowser (API Object) 728, 3261 +FormFileSaveAsBrowser (API Object) 734, 3267 +FormGroupBox (API Object) 740, 3273 +FormImage (API Object) 746, 3279 +FormIntegerSpinBox (API Object) 751, 3284 +FormItem (API Object) 757, 3290 +FormLabel (API Object) 761, 3294 +FormLabelledItem (API Object) 765, 3298 +FormLayout (API Object) 769, 3302 +FormLineEdit (API Object) 775, 3308 +FormModelSelector (API Object) 3313 +FormPushButton (API Object) 784, 3322 +FormRadioButtonGroup (API Object) 790, 3328 +FormScrollArea (API Object) 796, 3334 +FormSeparator (API Object) 802, 3340 +FormTree (API Object) 806, 3344 +Flare (API Object) 687 +FlatShaded (API Property) +Currents3DFormat (API Object) 3045 +CustomData3DFormat (API Object) 3047 +FarField3DFormat (API Object) 3164 +NearField3DFormat (API Object) 3581 +FlipPathEnds (API Property) +PathSweep (API Object) 1561 +Flipped (API Property) +Cutplane (API Object) 416 +Floor (API StaticFunction) +Complex (API Object) 322, 3002 +ComplexMatrix (API Object) 3023 +Matrix (API Object) 3500 +FocalDepth (API Property) +ParabolicArc (API Object) 1526 +Paraboloid (API Object) 1534 +FocusSource (API Property) +FarFieldOptimisationGoal (API Object) 639 +ImpedanceOptimisationGoal (API Object) 963 +NearFieldOptimisationGoal (API Object) 1351 +ReceivingAntennaOptimisationGoal (API Object) 1712 +SAROptimisationGoal (API Object) 1795 +SParameterOptimisationGoal (API Object) 1807 +TransmissionReflectionOptimisationGoal (API Object) 2136 +FocusSourceLabel (API Property) +FarFieldOptimisationGoal (API Object) 640 +ImpedanceOptimisationGoal (API Object) 964 +NearFieldOptimisationGoal (API Object) 1351 +OptimisationGoal (API Object) 1457 +PowerOptimisationGoal (API Object) 1665 +ReceivingAntennaOptimisationGoal (API Object) 1712 +SAROptimisationGoal (API Object) 1795 +SParameterOptimisationGoal (API Object) 1807 +TransmissionReflectionOptimisationGoal (API Object) 2137 +FocusType (API Property) +FarFieldOptimisationGoal (API Object) 640 +ImpedanceOptimisationGoal (API Object) 964 +NearFieldOptimisationGoal (API Object) 1351 +PowerOptimisationGoal (API Object) 1665 +ReceivingAntennaOptimisationGoal (API Object) 1713 +SAROptimisationGoal (API Object) 1796 +SParameterOptimisationGoal (API Object) 1807 +TransmissionReflectionOptimisationGoal (API Object) 2137 +Font (API Property) +GraphAxisLabels (API Object) 3366 +GraphAxisTitle (API Object) 3369 +GraphLegend (API Object) 3371 +SurfaceGraphAxisLabels (API Object) 3968 +SurfaceGraphAxisTitle (API Object) 3973 +SurfaceGraphLegend (API Object) 3978 +SurfaceGraphTextBox (API Object) 3983 +TextBox (API Object) 4013 +FontBoldfaced (API Property) +ResultTextBox (API Object) 3768 +FontColour (API Property) +ResultTextBox (API Object) 3768 +FontFamily (API Property) +ResultTextBox (API Object) 3768 +FontFormat (API Object) 3217 +FontItalicised (API Property) +ResultTextBox (API Object) 3768 +FontSize (API Property) +ResultTextBox (API Object) 3768 +FontUnderlined (API Property) +ResultTextBox (API Object) 3769 +Footer (API Property) +CartesianGraph (API Object) 2955 +CartesianSurfaceGraph (API Object) 2968 +Graph (API Object) 3355 +PolarGraph (API Object) 3674 +SmithChart (API Object) 3832 +SurfaceGraph (API Object) 3961 +FOR loop +Lua 17 +ForAllValues +dataset 33 +ForAllValues (API StaticFunction) +DataSet (API Object) 3095 +form +example 51 +Form (API Object) 697, 3219 +Format (API Property) +View (API Object) 4039 +FormButtons (API Object) 703, 3225 +FormCheckBox (API Object) 704, 3226 +FormComboBox (API Object) 709, 3231 +FormConfigurationSelector (API Object) 3237 +FormDataSelector (API Object) 3242 +FormDirectoryBrowser (API Object) 715, 3248 +FormDoubleSpinBox (API Object) 720, 3253 +FormFileBrowser (API Object) 726, 3259 +FormFileSaveAsBrowser (API Object) 732, 3265 +FormGroupBox (API Object) 738, 3271 +FormGroupBoxItemCollection (API Collection) 2410, 4134 +FormImage (API Object) 744, 3277 +FormIntegerSpinBox (API Object) 749, 3282 +FormItem (API Object) 755, 3288 +FormItemCollection (API Collection) 2413, 4137 +FormItems (API Collection) +Form (API Object) 699, 3221 +FormGroupBox (API Object) 742, 3275 +FormLayout (API Object) 770, 3304 +FormScrollArea (API Object) 798, 3336 +FormLabel (API Object) 759, 3292 +FormLabelledItem (API Object) 763, 3296 +FormLayout (API Object) 767, 3300 +FormLayoutItemCollection (API Collection) 2416, 4140 +FormLineEdit (API Object) 773, 3306 +FormModelSelector (API Object) 3311 +FormProgressDialog (API Object) 778, 3316 +FormPushButton (API Object) 782, 3320 +FormRadioButtonGroup (API Object) 788, 3326 +FormScrollArea (API Object) 794, 3332 +FormScrollAreaItemCollection (API Collection) 2419, 4144 +FormSeparator (API Object) 800, 3338 +FormTree (API Object) 804, 3342 +FormTreeItem (API Object) 810, 3348 +Frame (API Property) +GraphAxisTitle (API Object) 3369 +GraphLegend (API Object) 3371 +SurfaceGraphAxisTitle (API Object) 3973 +SurfaceGraphTextBox (API Object) 3983 +TextBox (API Object) 4013 +FrameFormat (API Object) 3351 +FreeSpace (API Object) 813 +FreeSpace (API Property) +Media (API Object) 1127 +Frequency (API Object) 817 +Frequency (API Property) +CharacteristicModesConfiguration (API Object) 306 +DielectricFrequencyPoint (API Object) 468 +MagneticFrequencyPoint (API Object) 1105 +MetallicFrequencyPoint (API Object) 1258 +SolutionConfiguration (API Object) 1891 +SParameterConfiguration (API Object) 1803 +StandardConfiguration (API Object) 2003 +SurfaceImpedanceFrequencyPoint (API Object) 2060 +FrequencyAdvancedSettings (API Object) 821 +FrequencyAdvancedSettingsList (API Object) 823 +FrequencyConfiguration (API Property) +SolutionConfiguration (API Object) 3844 +FrequencyContinuousQuantities (API Object) 825 +FrequencyContinuousQuantitiesList (API Object) 828 +FrequencyContinuousSettings (API Object) 830 +FrequencyContinuousSettingsList (API Object) 833 +FrequencyExportSettings (API Object) 835 +FrequencyExportSettingsList (API Object) 837 +FrequencyFDTDSettings (API Object) 839 +FrequencyFDTDSettingsList (API Object) 842 +FrequencyPoints (API Property) +ImpedanceSheet (API Object) 969 +MagneticModelling (API Object) 1110 +Metal (API Object) 1254 +FrequencyRate (API Property) +View3DAnimationFormat (API Object) 4045 +From (API Property) +Sweep (API Object) 2086 +Translate (API Object) 2122 +FromComplexMatrix (API Method) +DataSet (API Object) 3092, 3092 +DataSetIndexer (API Object) 3104 +FromMatrix (API Method) +DataSet (API Object) 3093, 3093 +DataSetIndexer (API Object) 3105 +FullTensor (API Property) +AnisotropicDielectric (API Object) 132 +function +Lua 17, 24 +FundamentalModeOptions (API Object) 844 +FundamentalModeOptions (API Property) +WaveguideSource (API Object) 2246 +FundamentalModeOptionsList (API Object) 846 +GapAngle (API Property) +OpenRing (API Object) 1436 +OpenRingShape (API Object) 1443 +SplitRing (API Object) 1991 +SplitRingShape (API Object) 1998 +GapBetweenLayers (API Property) +CableShield (API Object) 259 +GashAspectBound (API Property) +RemoveSmallFeaturesSettings (API Object) 1735 +general script 24 +GeneralNetwork (API Object) 848 +GeneralSettings (API Property) +SolverSettings (API Object) 1899 +GeneralSolverSettings (API Object) 854 +GeneralSolverSettingsList (API Object) 858 +Generate (API Method) +QuickReport (API Object) 3708 +ReportTemplate (API Object) 3740 +GenerateAndOpen (API Method) +QuickReport (API Object) 3708 +ReportTemplate (API Object) 3741 +Geometry (API Collection) +ModelContents (API Object) 1287 +Geometry (API Object) 860 +Geometry (API Property) +Edge (API Object) 491 +Exporter (API Object) 536 +Face (API Object) 612 +Importer (API Object) 972 +Region (API Object) 1730 +TopologyEntity (API Object) 2109 +GeometryCheckingEnabled (API Property) +GeneralSolverSettings (API Object) 856 +GeometryCollection (API Collection) 2422 +GeometryExporter (API Object) 874 +GeometryGroup (API Collection) 2473 +GeometryGroupCollection (API Collection) 2480 +GeometryImporter (API Object) 879 +GeometryRebuild (API Object) 883 +GeometryRepair (API Object) 886 +Get (API Function) +ImportSettings (API Object) 4297 +Get (API Method) +ADAPTFEKOLaunchOptionsList (API Object) 60 +AdvancedSolverSettingsList (API Object) 110 +AngularDimensionList (API Object) 128 +AnisotropicDielectricLayersList (API Object) 137 +AntennaArraySourceList (API Object) 141 +BasisFunctionGlobalSolverSettingsList (API Object) 155 +BasisFunctionLocalSolverSettingsList (API Object) 159 +CableBundleCableSpecificationList (API Object) 185 +CartesianDescriptionList (API Object) 289 +CartesianRequestPointsList (API Object) 293 +CartesianStructureList (API Object) 297 +CoaxialInsulationLayerList (API Object) 311 +ComplexTensorList (API Object) 337 +CompositeValueHierarchyList (API Object) 347 +ConicalRequestPointsList (API Object) 361 +ConstrainedSurfacePointList (API Object) 375 +CurrentsExportSettingsList (API Object) 407 +CylindricalDescriptionList (API Object) 440 +CylindricalRequestPointsList (API Object) 444 +CylindricalStructureList (API Object) 448 +CylindricalXRequestPointsList (API Object) 452 +CylindricalYRequestPointsList (API Object) 456 +DielectricFrequencyPointList (API Object) 470 +DielectricModellingList (API Object) 477 +DimensionList (API Object) 482 +DomainDecompositionSettingsList (API Object) 486 +ExpressionList (API Object) 538 +ExpressionTable (API Object) 540 +FarFieldAdvancedSettingsList (API Object) 626 +FarFieldExportSettingsList (API Object) 636 +FarFieldPBCSettingsList (API Object) 645 +FarFieldSphericalModeSettingsList (API Object) 662 +FDTDBoundarySettingsList (API Object) 548 +FDTDSettingsList (API Object) 551 +FEKOGPUOptionsList (API Object) 555 +FEKOLaunchOptionsList (API Object) 560 +FEKOParallelDiagnosticTestsList (API Object) 564 +FEKOParallelExecutionOptionsList (API Object) 568 +FEKORemoteExecutionOptionsList (API Object) 572 +FEMSettingsList (API Object) 607 +FileReferenceList (API Object) 671 +FrequencyAdvancedSettingsList (API Object) 823 +FrequencyContinuousQuantitiesList (API Object) 828 +FrequencyContinuousSettingsList (API Object) 833 +FrequencyExportSettingsList (API Object) 837 +FrequencyFDTDSettingsList (API Object) 842 +FundamentalModeOptionsList (API Object) 846 +GeneralSolverSettingsList (API Object) 858 +GlobalCoordinatesList (API Object) 893 +GlobalOriginList (API Object) 901 +GlobalPlaneList (API Object) 905 +GlobalVectorList (API Object) 909 +HighFrequencySettingsList (API Object) 951 +IntegralEquationList (API Object) 997 +IsotropicDielectricLayersList (API Object) 1009 +IterativeSolverSettingsList (API Object) 1014 +LocalCoordinateList (API Object) 1065 +LocalInternalCoordinateList (API Object) 1070 +LocalWorkplaneList (API Object) 1080 +MagneticFrequencyPointList (API Object) 1107 +MagneticModellingList (API Object) 1111 +ManuallySpecifiedOrDerivedValueList (API Object) 1118 +MeshAdvancedSettingsList (API Object) 1149 +MetallicFrequencyPointList (API Object) 1259 +MLFMMACASettingsList (API Object) 1093 +MLFMMSolverSettingsList (API Object) 1097 +NearFieldAdvancedSettingsList (API Object) 1323 +NearFieldBoundarySurfaceList (API Object) 1328 +NearFieldExportSettingsList (API Object) 1347 +NormalDimensionList (API Object) 1375 +NurbsControlPointList (API Object) 1382 +NurbsControlPointTable (API Object) 1384 +ObjectReferenceList (API Object) 1430 +ObjectReferenceTable (API Object) 1431 +OPTFEKOLaunchOptionsList (API Object) 1397 +OptimisationConstraintList (API Object) 1454 +OptimisationGoalProcessingStepsList (API Object) 1467 +OptimisationMaskValuesList (API Object) 1473 +OptimisationVariableList (API Object) 1491 +OutputFileSolverSettingsList (API Object) 1496 +ParametricComplexExpressionList (API Object) 1541 +ParametricComplexExpressionTable (API Object) 1543 +ParametricExpressionList (API Object) 1556 +PeriodicBoundaryBeamSquintAngleList (API Object) 1583 +PeriodicBoundaryPhaseShiftList (API Object) 1587 +PlanarSubstrateList (API Object) 1591 +PointAngleRangeList (API Object) 1608 +PointExpressionTable (API Object) 1610 +PointRangeExpressionList (API Object) 1615 +PointRangeList (API Object) 1617 +PolderTensorList (API Object) 1628 +PortPropertiesList (API Object) 1658 +PreconditionerSettingsList (API Object) 1670 +PREFEKOLaunchOptionsList (API Object) 1517 +PREFEKOVariableExportOptionsList (API Object) 1521 +RayContributionsFacetedUTDList (API Object) 1701 +RayContributionsRLGOList (API Object) 1704 +RayContributionsUTDList (API Object) 1709 +ReferenceDirectionList (API Object) 1726 +RLGOFaceAbsorbingSettingsList (API Object) 1696 +ScopeSettingsList (API Object) 1825 +ShieldLayerSettingsList (API Object) 1838 +SimplifyEdgeSettingsList (API Object) 1851 +SimplifyFaceSettingsList (API Object) 1855 +SimplifyPointSettingsList (API Object) 1864 +SimplifyRegionSettingsList (API Object) 1867 +SpecifiedRequestPointsList (API Object) 1905 +SphericalDescriptionList (API Object) 1918 +SphericalModeOptionsList (API Object) 1933 +SphericalRequestPointsList (API Object) 1951 +SphericalStructureList (API Object) 1955 +SurfaceCoordinateList (API Object) 2058 +SurfaceImpedanceFrequencyPointList (API Object) 2062 +UnitCellLayerList (API Object) 2173 +UTDCylinderTerminationTypeList (API Object) 2153 +View3DAxesFormatList (API Object) 2190 +ViewDisplayModeList (API Object) 2194 +ViewRenderingOptionsList (API Object) 2198 +VoxelAdvancedSettingsList (API Object) 2219 +VoxelGridSummaryList (API Object) 2224 +WaveguideModeOptionsList (API Object) 2238 +WindscreenSolutionMethodList (API Object) 2255 +GetActiveWindow (API Method) +WindowCollection (API Collection) 4279 +GetApplication (API Function) +(API Object) 4286 +GetAxisUnit (API Method) +CharacteristicModeTrace (API Object) 2991 +CustomData3DPlot (API Object) 3052 +CustomDataSmithTrace (API Object) 3061 +CustomDataSurfacePlot (API Object) 3068 +CustomDataTrace (API Object) 3075 +ErrorEstimate3DPlot (API Object) 3115 +ExcitationSmithTrace (API Object) 3140 +FarField3DPlot (API Object) 3170 +FarFieldPowerIntegralTrace (API Object) 3193 +FarFieldSurfacePlot (API Object) 3208 +FarFieldTrace (API Object) 3215 +LoadSmithTrace (API Object) 3457 +LoadTrace (API Object) 3468 +NearField3DPlot (API Object) 3588 +NearFieldPowerIntegralTrace (API Object) 3608 +NearFieldSurfacePlot (API Object) 3625 +NearFieldTrace (API Object) 3633 +NetworkTrace (API Object) 3651 +PowerTrace (API Object) 3704 +SARTrace (API Object) 3793 +SParameterSurfacePlot (API Object) 3814 +SParameterTrace (API Object) 3821 +SurfaceCurrents3DPlot (API Object) 3946 +TRCoefficientTrace (API Object) 4007 +WireCurrents3DPlot (API Object) 4078 +WireCurrentsTrace (API Object) 4097 +GetClashingGeometry (API Method) +Find (API Object) 678, 678 +GetCommandRunCADFEKO (API Method) +Launcher (API Object) 3401 +GetCommandRunEDITFEKO (API Method) +Launcher (API Object) 3402 +GetCommandRunFEKO (API Method) +Launcher (API Object) 3402 +GetCommandRunOPTFEKO (API Method) +Launcher (API Object) 3402 +GetCommandRunPOSTFEKO (API Method) +Launcher (API Object) 3402 +GetCommandRunPREFEKO (API Method) +Launcher (API Object) 3402 +GetDataSet (API Function) +CharacteristicModes (API Object) 4289, 4289, 4289 +CustomData (API Object) 4291, 4291, 4291 +Excitation (API Object) 4298, 4298, 4298 +FarField (API Object) 4300, 4300, 4301 +Load (API Object) 4304, 4304, 4304 +NearField (API Object) 4310, 4310, 4311 +Network (API Object) 4313, 4313, 4313 +Power (API Object) 4315, 4315, 4315 +SAR (API Object) 4317, 4317, 4317 +SParameter (API Object) 4319, 4319, 4319 +SurfaceCurrentsAndCharges (API Object) 4321, 4321, 4321 +TRCoefficients (API Object) 4323, 4323, 4323 +WireCurrentsAndCharges (API Object) 4325, 4325, 4325 +GetDataSet (API Method) +CharacteristicModeData (API Object) 2979, 2979, 2979 +CharacteristicModeStoredData (API Object) 2984, 2984, 2984 +CustomMathScript (API Object) 3079 +CustomStoredData (API Object) 3083 +ExcitationMathScript (API Object) 3128 +ExcitationStoredData (API Object) 3145, 3145, 3145 +FarFieldData (API Object) 3176, 3177, 3177 +FarFieldMathScript (API Object) 3182 +FarFieldPowerIntegralData (API Object) 3184 +FarFieldPowerIntegralStoredData (API Object) 3187 +FarFieldReceivingAntennaData (API Object) 3199, 3200, 3200 +FarFieldStoredData (API Object) 3202, 3202, 3203 +LoadCable (API Object) 3411, 3411, 3411 +LoadCoaxial (API Object) 3415, 3415, 3415 +LoadComplex (API Object) 3419, 3419, 3419 +LoadEdge (API Object) 3428, 3428, 3428 +LoadFEM (API Object) 3432, 3432, 3432 +LoadMathScript (API Object) 3436 +LoadNetwork (API Object) 3439, 3439, 3439 +LoadParallel (API Object) 3443, 3443, 3443 +LoadSeries (API Object) 3449, 3449, 3449 +LoadStoredData (API Object) 3461, 3461, 3461 +LoadVertex (API Object) 3472, 3472, 3472 +LoadVoxel (API Object) 3475, 3475, 3476 +ModalExcitationStoredData (API Object) 3575, 3575, 3575 +NearFieldData (API Object) 3593, 3593, 3593 +NearFieldMathScript (API Object) 3598 +NearFieldReceivingAntennaData (API Object) 3616, 3616, 3617 +NearFieldStoredData (API Object) 3619, 3619, 3620 +NetworkData (API Object) 3638, 3638, 3638 +NetworkMathScript (API Object) 3642 +NetworkStoredData (API Object) 3644, 3644, 3644 +PowerData (API Object) 3687, 3687, 3687 +PowerMathScript (API Object) 3693 +PowerStoredData (API Object) 3697, 3697, 3697 +ReceivingAntennaData (API Object) 3725, 3726, 3726 +SARData (API Object) 3784, 3784, 3784 +SARStoredData (API Object) 3787, 3787, 3787 +SourceCoaxial (API Object) 3854, 3854, 3855 +SourceCurrentRegion (API Object) 3859, 3859, 3860 +SourceMagneticFrill (API Object) 3876, 3876, 3877 +SourceModal (API Object) 3881, 3881, 3881 +SourceVoltageCable (API Object) 3901, 3901, 3902 +SourceVoltageEdge (API Object) 3906, 3906, 3907 +SourceVoltageNetwork (API Object) 3911, 3911, 3912 +SourceVoltageSegment (API Object) 3916, 3916, 3917 +SourceVoltageVertex (API Object) 3921, 3922, 3922 +SourceWaveguide (API Object) 3926, 3926, 3927 +SParameterData (API Object) 3799, 3799, 3800 +SParameterMathScript (API Object) 3803 +SParameterStoredData (API Object) 3808, 3808, 3809 +SphericalModesReceivingAntennaData (API Object) 3929, 3929, 3930 +SurfaceCurrentsAndChargesStoredData (API Object) 3950, 3950, 3950 +SurfaceCurrentsData (API Object) 3953, 3953, 3953 +SurfaceCurrentsMathScript (API Object) 3957 +TransmissionLineData (API Object) 4028, 4028, 4028 +TRCoefficientData (API Object) 3994, 3994, 3994 +TRCoefficientMathScript (API Object) 3998 +TRCoefficientStoredData (API Object) 4001, 4001, 4001 +WaveguideExcitationStoredData (API Object) 4063, 4063, 4063 +WireCurrentsAndChargesStoredData (API Object) 4082, 4082, 4082 +WireCurrentsData (API Object) 4085, 4085, 4085 +WireCurrentsMathScript (API Object) 4088 +GetDefaultProperties (API StaticFunction) +AbstractAntennaArray (API Object) 66 +AbstractFEMLinePort (API Object) 72 +AbstractIdealSource (API Object) 77 +AbstractMeshEdge (API Object) 79 +AbstractMeshPort (API Object) 83 +AbstractMeshTriangleFace (API Object) 86 +AbstractMeshWire (API Object) 89 +AbstractPointSource (API Object) 95 +AbstractSurfaceCurve (API Object) 103 +AdaptiveRefinement (API Object) 108 +Align (API Object) 117 +AnalyticalCurve (API Object) 126 +AnisotropicDielectric (API Object) 133 +AnisotropicDielectricCollection (API Collection) 2286 +AntennaArrayCollection (API Collection) 2293 +Application (API Object) 147 +BaseFieldReceivingAntenna (API Object) 152 +BezierCurve (API Object) 168 +CableBundleCrossSection (API Object) 192 +CableCoaxialCrossSection (API Object) 199 +CableConnector (API Object) 204 +CableConnectorCollection (API Collection) 2298 +CableConnectorPin (API Object) 207 +CableConnectorPinCollection (API Collection) 2302 +CableCrossSection (API Object) 210 +CableCrossSectionCollection (API Collection) 2314 +CableGeneralNetwork (API Object) 214 +CableHarness (API Object) 218 +CableHarnessCollection (API Collection) 2318 +CableInstance (API Object) 222 +CableInstanceCollection (API Collection) 2322 +CableNonConductingElementCrossSection (API Object) 225 +CablePath (API Object) 232 +CablePathCollection (API Collection) 2327 +CablePathTerminal (API Object) 235 +CablePort (API Object) 239 +CableProbe (API Object) 244 +CableProbeCollection (API Collection) 2331 +CableRibbonCrossSection (API Object) 248 +Cables (API Object) 281 +CableSchematicComponentCollection (API Collection) 2344 +CableSchematicCurrentProbe (API Object) 253 +CableSchematicVoltageProbe (API Object) 257 +CableShield (API Object) 261 +CableShieldCollection (API Collection) 2351 +CableSignal (API Object) 264 +CableSignalCollection (API Collection) 2355 +CableSingleConductorCrossSection (API Object) 268 +CableSpiceNetwork (API Object) 273 +CableTwistedPairCrossSection (API Object) 278 +Capacitor (API Object) 286 +CFXModelImporter (API Object) 182 +CFXModelImportSettings (API Object) 179 +CharacterisedSurface (API Object) 301 +CharacterisedSurfaceCollection (API Collection) 2359 +CharacteristicModes (API Object) 304 +CharacteristicModesConfiguration (API Object) 308 +CollectionOf_DomainEntity (API Collection) 2362 +CollectionOf_Mesh (API Collection) 2365 +ComplexLoad (API Object) 333 +ComponentLaunchOptions (API Object) 342 +Cone (API Object) 357 +ConstrainedSurface (API Object) 371 +Cross (API Object) 385 +CrossShape (API Object) 388 +Cuboid (API Object) 397 +Currents (API Object) 404 +CurrentsCollection (API Collection) 2369 +CurrentSource (API Object) 400 +CustomAntennaArray (API Object) 414 +Cutplane (API Object) 420 +CutplaneCollection (API Collection) 2373 +Cylinder (API Object) 429 +CylindricalAntennaArray (API Object) 437 +DefaultMedium (API Object) 460 +Dielectric (API Object) 464 +DielectricBoundaryMedium (API Object) 467 +DielectricCollection (API Collection) 2377 +Edge (API Object) 494 +EdgeCollection (API Collection) 2382 +EdgeMeshPort (API Object) 499 +EdgePort (API Object) 504 +ElectricDipole (API Object) 510 +Ellipse (API Object) 518 +EllipseShape (API Object) 521 +EllipticArc (API Object) 531 +ErrorEstimation (API Object) 534 +ErrorEstimationCollection (API Collection) 2386 +Exporter (API Object) 537 +Face (API Object) 615 +FaceCollection (API Collection) 2391 +FarField (API Object) 622 +FarFieldCollection (API Collection) 2397 +FarFieldData (API Object) 633 +FarFieldOptimisationGoal (API Object) 642 +FarFieldReceivingAntenna (API Object) 652 +FarFieldReceivingAntennaCollection (API Collection) 2401 +FarFieldSource (API Object) 659 +FDTDBoundaryConditions (API Object) 545 +FEMLineMeshPort (API Object) 581 +FEMLinePort (API Object) 589 +FEMModalMeshPort (API Object) 595 +FEMModalPort (API Object) 601 +FEMModalSource (API Object) 604 +FieldData (API Object) 668 +FieldDataCollection (API Collection) 2409 +FillHoleSettings (API Object) 675 +Find (API Object) 678 +FittedSpline (API Object) 686 +Flare (API Object) 696 +FreeSpace (API Object) 816 +Frequency (API Object) 820 +GeneralNetwork (API Object) 853 +Geometry (API Object) 872 +GeometryCollection (API Collection) 2472 +GeometryExporter (API Object) 877 +GeometryGroup (API Collection) 2478 +GeometryGroupCollection (API Collection) 2483 +GeometryImporter (API Object) 882 +GeometryRebuild (API Object) 885 +GeometryRepair (API Object) 890 +GlobalMeshSettings (API Object) 898 +Ground (API Object) 914 +GroundPlane (API Object) 918 +GroundPlaneMedium (API Object) 922 +Helix (API Object) 932 +Hexagon (API Object) 940 +HexagonShape (API Object) 943 +HyperbolicArc (API Object) 961 +ImpedanceOptimisationGoal (API Object) 966 +ImpedanceSheet (API Object) 970 +ImpedanceSheetCollection (API Collection) 2487 +Importer (API Object) 973 +ImpressedCurrent (API Object) 980 +ImprintPoints (API Object) 988 +Inductor (API Object) 994 +Intersect (API Object) 1006 +KBL (API Object) 1018 +Launcher (API Object) 1028 +LaunchResult (API Object) 1022 +LayeredAnisotropicDielectric (API Object) 1031 +LayeredDielectric (API Object) 1034 +LayeredDielectricCollection (API Collection) 2493 +LayeredIsotropicDielectric (API Object) 1037 +LibraryMedium (API Object) 1040 +Line (API Object) 1048 +LinearPlanarArray (API Object) 1055 +Load (API Object) 1061 +LoadCollection (API Collection) 2499 +LocalMeshSettings (API Object) 1074 +Loft (API Object) 1090 +MagneticDipole (API Object) 1104 +MainWindow (API Object) 1115 +MdiSubWindow (API Object) 1123 +Media (API Object) 1129 +MediaLibrary (API Collection) 2503 +Medium (API Object) 1133 +Mesh (API Object) 1144 +MeshCurvilinearSegmentWire (API Object) 1157 +MeshCurvilinearTriangleFace (API Object) 1164 +MeshCurvilinearTriangleFaceCollection (API Collection) 2508 +MeshCurvilinearWire (API Object) 1167 +MeshCylinder (API Object) 1170 +MeshCylinderCollection (API Collection) 2512 +Mesher (API Object) 1247 +MeshExporter (API Object) 1174 +MeshFind (API Object) 1178 +MeshImporter (API Object) 1186 +MeshInfo (API Object) 1196 +MeshPlate (API Object) 1203 +MeshPlateCollection (API Collection) 2516 +MeshRefinementRule (API Object) 1208 +MeshRefinementRuleCollection (API Collection) 2520 +MeshRegion (API Object) 1211 +MeshSegmentCurvilinearWireCollection (API Collection) 2524 +MeshSegmentWire (API Object) 1219 +MeshSegmentWireCollection (API Collection) 2528 +MeshSettings (API Object) 1226 +MeshSettingsCollection (API Collection) 2532 +MeshTetrahedronRegion (API Object) 1231 +MeshTetrahedronRegionCollection (API Collection) 2536 +MeshTriangleFace (API Object) 1238 +MeshTriangleFaceCollection (API Collection) 2540 +MeshWire (API Object) 1243 +MessageWindow (API Object) 1251 +Metal (API Object) 1256 +MetalCollection (API Collection) 2544 +MicrostripMeshPort (API Object) 1265 +MicrostripPort (API Object) 1269 +Mirror (API Object) 1276 +Model (API Object) 1281 +ModelAttributes (API Object) 1284 +ModelContents (API Object) 1288 +ModelDecompositionCollection (API Collection) 2548 +ModelDefinitions (API Object) 1292 +ModelMeshInfo (API Object) 1302 +ModelSymmetry (API Object) 1305 +NamedPoint (API Object) 1311 +NamedPointCollection (API Collection) 2552 +NearField (API Object) 1319 +NearFieldCollection (API Collection) 2561 +NearFieldDataFileStructure (API Object) 1337 +NearFieldDataFullImport (API Object) 1344 +NearFieldOptimisationGoal (API Object) 1353 +NearFieldReceivingAntenna (API Object) 1360 +NearFieldReceivingAntennaCollection (API Collection) 2566 +NearFieldSource (API Object) 1366 +Net (API Object) 1369 +NetCollection (API Collection) 2570 +Network (API Object) 1373 +NetworkCollection (API Collection) 2577 +NumericalGreensFunction (API Object) 1379 +NurbsSurface (API Object) 1393 +Object (API Object) 1428 +OpenRing (API Object) 1441 +OpenRingShape (API Object) 1445 +OperatorCollection (API Collection) 2581 +Optimisation (API Object) 1448 +OptimisationCombination (API Object) 1451 +OptimisationGoal (API Object) 1459 +OptimisationGoalCollection (API Collection) 2588 +OptimisationGoalObjective (API Object) 1462 +OptimisationMask (API Object) 1470 +OptimisationMaskCollection (API Collection) 2592 +OptimisationOperator (API Object) 1477 +OptimisationParameters (API Object) 1480 +OptimisationSearch (API Object) 1484 +OptimisationSearchAdvancedSettings (API Object) 1488 +OptimisationSearchCollection (API Collection) 2596 +ParabolicArc (API Object) 1531 +Paraboloid (API Object) 1539 +PathSweep (API Object) 1566 +PCB (API Object) 1503 +PCBCurrentData (API Object) 1508 +PCBSource (API Object) 1514 +PerfectElectricConductor (API Object) 1569 +PerfectMagneticConductor (API Object) 1572 +PeriodicBoundary (API Object) 1580 +PlaneShape (API Object) 1595 +PlaneWave (API Object) 1602 +PointRefinement (API Object) 1624 +Polygon (API Object) 1637 +Polyline (API Object) 1645 +PolylineRefinement (API Object) 1651 +Port (API Object) 1654 +PortCollection (API Collection) 2610 +Power (API Object) 1663 +PowerOptimisationGoal (API Object) 1667 +Primitive (API Object) 1679 +ProjectGeometry (API Object) 1687 +ProtectedModel (API Object) 1693 +ProtectedModels (API Collection) 2615 +ReceivingAntennaOptimisationGoal (API Object) 1714 +Rectangle (API Object) 1723 +Region (API Object) 1733 +RegionCollection (API Collection) 2620 +RemoveSmallFeaturesSettings (API Object) 1738 +RepairAndSewFaces (API Object) 1746 +RepairAndSewFacesSettings (API Object) 1749 +RepairEdgesSettings (API Object) 1752 +RepairPart (API Object) 1760 +RepairPartsSettings (API Object) 1766 +Resistor (API Object) 1771 +Ring (API Object) 1779 +RingShape (API Object) 1783 +Rotate (API Object) 1789 +SAR (API Object) 1793 +SARCollection (API Collection) 2624 +SAROptimisationGoal (API Object) 1797 +Scale (API Object) 1814 +Schematic (API Object) 1818 +SchematicViewWindow (API Object) 1822 +Shape (API Object) 1829 +ShapeCollection (API Collection) 2635 +Simplify (API Object) 1848 +SimplifyPartRepresentationSettings (API Object) 1862 +SimulationMeshInfo (API Object) 1878 +SolutionCoefficientData (API Object) 1883 +SolutionCoefficientSource (API Object) 1889 +SolutionConfiguration (API Object) 1892 +SolutionConfigurationCollection (API Collection) 2644 +SolutionSettings (API Object) 1896 +SolverSettings (API Object) 1900 +Source (API Object) 1903 +SourceCollection (API Collection) 2656 +SParameter (API Object) 1801 +SParameterConfiguration (API Object) 1804 +SParameterOptimisationGoal (API Object) 1809 +Sphere (API Object) 1915 +SphericalModeDataFromFile (API Object) 1924 +SphericalModeDataManuallySpecified (API Object) 1929 +SphericalModeReceivingAntenna (API Object) 1941 +SphericalModeReceivingAntennaCollection (API Collection) 2660 +SphericalModeSource (API Object) 1948 +Spin (API Object) 1965 +SpiralCross (API Object) 1974 +SpiralCrossShape (API Object) 1978 +Split (API Object) 1987 +SplitRing (API Object) 1996 +SplitRingShape (API Object) 2000 +StandardConfiguration (API Object) 2005 +Stitch (API Object) 2014 +StripCross (API Object) 2023 +StripCrossShape (API Object) 2027 +StripHexagon (API Object) 2035 +StripHexagonShape (API Object) 2038 +Subtract (API Object) 2046 +SurfaceBezierCurve (API Object) 2055 +SurfaceLine (API Object) 2071 +SurfaceRegularLines (API Object) 2081 +Sweep (API Object) 2091 +TCross (API Object) 2100 +TCrossShape (API Object) 2103 +Terminal (API Object) 2107 +TerminalCollection (API Collection) 2664 +TopologyEntity (API Object) 2110 +TopologyEntityCollectionOf_Edge (API Collection) 2667 +Transform (API Object) 2115 +TransformCollection (API Collection) 2676 +Transformer (API Object) 2120 +Translate (API Object) 2125 +TransmissionLine (API Object) 2131 +TransmissionReflection (API Object) 2134 +TransmissionReflectionCollection (API Collection) 2680 +TransmissionReflectionOptimisationGoal (API Object) 2139 +Trifilar (API Object) 2147 +TrifilarShape (API Object) 2150 +Union (API Object) 2165 +UnitCell (API Object) 2169 +UnitCellCollection (API Collection) 2684 +UnprotectedInformation (API Object) 2177 +Variable (API Object) 2181 +VariableCollection (API Collection) 2689 +Version (API Object) 2187 +ViewXt (API Object) 2202 +ViewXtWindow (API Object) 2206 +VoltageControlledVoltageSource (API Object) 2211 +VoltageSource (API Object) 2214 +VoxelSettings (API Object) 2229 +WaveguideMeshPort (API Object) 2233 +WaveguidePort (API Object) 2244 +WaveguideSource (API Object) 2248 +Windscreen (API Object) 2251 +WindscreenCollection (API Collection) 2693 +WireCollection (API Collection) 2698 +WireMeshPort (API Object) 2261 +WirePort (API Object) 2266 +Workplane (API Object) 2276 +WorkplaneCollection (API Collection) 2707 +WorkSurface (API Object) 2270 +WorkSurfaceCollection (API Collection) 2703 +Zero (API Object) 2280 +GetFixedAxisAvailableValues (API Method) +CharacteristicModeTrace (API Object) 2991 +CustomData3DPlot (API Object) 3053 +CustomDataSmithTrace (API Object) 3061 +CustomDataSurfacePlot (API Object) 3068 +CustomDataTrace (API Object) 3075 +ErrorEstimate3DPlot (API Object) 3116 +ExcitationSmithTrace (API Object) 3141 +FarField3DPlot (API Object) 3170 +FarFieldPowerIntegralTrace (API Object) 3193 +FarFieldSurfacePlot (API Object) 3208 +FarFieldTrace (API Object) 3215 +LoadSmithTrace (API Object) 3458 +LoadTrace (API Object) 3468 +NearField3DPlot (API Object) 3588 +NearFieldPowerIntegralTrace (API Object) 3608 +NearFieldSurfacePlot (API Object) 3625 +NearFieldTrace (API Object) 3633 +NetworkTrace (API Object) 3651 +PowerTrace (API Object) 3704 +SARTrace (API Object) 3794 +SParameterSurfacePlot (API Object) 3814 +SParameterTrace (API Object) 3821 +SurfaceCurrents3DPlot (API Object) 3947 +TRCoefficientTrace (API Object) 4007 +WireCurrents3DPlot (API Object) 4078 +WireCurrentsTrace (API Object) 4097 +GetFixedAxisValue (API Method) +CharacteristicModeTrace (API Object) 2991 +CustomData3DPlot (API Object) 3053 +CustomDataSmithTrace (API Object) 3062 +CustomDataSurfacePlot (API Object) 3068 +CustomDataTrace (API Object) 3075 +ErrorEstimate3DPlot (API Object) 3116 +ExcitationSmithTrace (API Object) 3141 +FarField3DPlot (API Object) 3171 +FarFieldPowerIntegralTrace (API Object) 3193 +FarFieldSurfacePlot (API Object) 3208 +FarFieldTrace (API Object) 3215 +LoadSmithTrace (API Object) 3458 +LoadTrace (API Object) 3468 +NearField3DPlot (API Object) 3588 +NearFieldPowerIntegralTrace (API Object) 3608 +NearFieldSurfacePlot (API Object) 3626 +NearFieldTrace (API Object) 3634 +NetworkTrace (API Object) 3651 +PowerTrace (API Object) 3704 +SARTrace (API Object) 3794 +SParameterSurfacePlot (API Object) 3814 +SParameterTrace (API Object) 3821 +SurfaceCurrents3DPlot (API Object) 3947 +TRCoefficientTrace (API Object) 4007 +WireCurrents3DPlot (API Object) 4079 +WireCurrentsTrace (API Object) 4097 +GetInstance (API StaticFunction) +Application (API Object) 147 +GetIntersectingMeshes (API Method) +MeshFind (API Object) 1178, 1178 +GetMediaDataSet (API Function) +NearField (API Object) 4311, 4311, 4312 +GetMediaDataSet (API Method) +NearFieldData (API Object) 3593, 3594, 3594 +GetNames (API Function) +CharacteristicModes (API Object) 4290 +CustomData (API Object) 4292 +Excitation (API Object) 4299 +FarField (API Object) 4301 +Load (API Object) 4305 +MatIO (API Object) 4308 +NearField (API Object) 4312 +Network (API Object) 4314 +Power (API Object) 4316 +SAR (API Object) 4318 +SParameter (API Object) 4320 +SurfaceCurrentsAndCharges (API Object) 4322 +TRCoefficients (API Object) 4324 +WireCurrentsAndCharges (API Object) 4326 +GetPath (API Method) +Model (API Object) 3578 +GetPointMatrixForSegmentMeshIndexList (API Method) +Mesh (API Object) 3515 +GetPointMatrixForTriangleMeshIndexList (API Method) +Mesh (API Object) 3516 +GetProperties (API Method) +AbstractAntennaArray (API Object) 66 +AbstractFEMLinePort (API Object) 71 +AbstractIdealSource (API Object) 76 +AbstractMeshEdge (API Object) 79 +AbstractMeshPort (API Object) 82 +AbstractMeshTriangleFace (API Object) 85 +AbstractMeshWire (API Object) 88 +AbstractPointSource (API Object) 95 +AbstractSurfaceCurve (API Object) 102 +AdaptiveRefinement (API Object) 108 +Align (API Object) 116 +AnalyticalCurve (API Object) 125 +AnisotropicDielectric (API Object) 133 +AnisotropicDielectricCollection (API Collection) 2285 +AntennaArrayCollection (API Collection) 2292 +Application (API Object) 146 +BandwidthAnnotation (API Object) 2946 +BaseFieldReceivingAntenna (API Object) 152 +BeamwidthAnnotation (API Object) 2951 +BezierCurve (API Object) 167 +CableBundleCrossSection (API Object) 192 +CableCoaxialCrossSection (API Object) 199 +CableConnector (API Object) 204 +CableConnectorCollection (API Collection) 2297 +CableConnectorPin (API Object) 207 +CableConnectorPinCollection (API Collection) 2301 +CableCrossSection (API Object) 210 +CableCrossSectionCollection (API Collection) 2313 +CableGeneralNetwork (API Object) 214 +CableHarness (API Object) 218 +CableHarnessCollection (API Collection) 2317 +CableInstance (API Object) 222 +CableInstanceCollection (API Collection) 2322 +CableNonConductingElementCrossSection (API Object) 225 +CablePath (API Object) 232 +CablePathCollection (API Collection) 2326 +CablePathTerminal (API Object) 234 +CablePort (API Object) 239 +CableProbe (API Object) 244 +CableProbeCollection (API Collection) 2330 +CableRibbonCrossSection (API Object) 248 +Cables (API Object) 281 +CableSchematicComponentCollection (API Collection) 2343 +CableSchematicCurrentProbe (API Object) 252 +CableSchematicVoltageProbe (API Object) 256 +CableShield (API Object) 261 +CableShieldCollection (API Collection) 2350 +CableSignal (API Object) 264 +CableSignalCollection (API Collection) 2354 +CableSingleConductorCrossSection (API Object) 268 +CableSpiceNetwork (API Object) 272 +CableTwistedPairCrossSection (API Object) 277 +Capacitor (API Object) 285 +CartesianGraph (API Object) 2960 +CartesianSurfaceGraph (API Object) 2972 +CFXModelImporter (API Object) 181 +CFXModelImportSettings (API Object) 178 +CharacterisedSurface (API Object) 301 +CharacterisedSurfaceCollection (API Collection) 2358 +CharacteristicModes (API Object) 304 +CharacteristicModesConfiguration (API Object) 308 +CharacteristicModeTrace (API Object) 2991 +CollectionOf_DomainEntity (API Collection) 2361 +CollectionOf_Mesh (API Collection) 2364 +ComplexLoad (API Object) 333 +ComponentLaunchOptions (API Object) 341, 3042 +Cone (API Object) 357 +ConstrainedSurface (API Object) 371 +Cross (API Object) 384 +CrossShape (API Object) 388 +Cuboid (API Object) 396 +Currents (API Object) 404 +CurrentsCollection (API Collection) 2368 +CurrentSource (API Object) 400 +CustomAntennaArray (API Object) 413 +CustomData3DPlot (API Object) 3053 +CustomDataSmithTrace (API Object) 3062 +CustomDataSurfacePlot (API Object) 3068 +CustomDataTrace (API Object) 3075 +Cutplane (API Object) 420 +CutplaneCollection (API Collection) 2372 +Cylinder (API Object) 428 +CylindricalAntennaArray (API Object) 436 +DefaultMedium (API Object) 459 +Dielectric (API Object) 464 +DielectricBoundaryMedium (API Object) 467 +DielectricCollection (API Collection) 2376 +Edge (API Object) 493 +EdgeCollection (API Collection) 2381 +EdgeMeshPort (API Object) 498 +EdgePort (API Object) 503 +ElectricDipole (API Object) 510 +Ellipse (API Object) 518 +EllipseShape (API Object) 521 +EllipticArc (API Object) 530 +ErrorEstimate3DPlot (API Object) 3116 +ErrorEstimation (API Object) 534 +ErrorEstimationCollection (API Collection) 2385 +ExcitationSmithTrace (API Object) 3141 +ExcitationTrace (API Object) 3150 +Exporter (API Object) 537 +Face (API Object) 615 +FaceCollection (API Collection) 2390 +FarField (API Object) 622 +FarField3DPlot (API Object) 3171 +FarFieldCollection (API Collection) 2396 +FarFieldData (API Object) 633 +FarFieldOptimisationGoal (API Object) 641 +FarFieldPowerIntegralTrace (API Object) 3193 +FarFieldReceivingAntenna (API Object) 652 +FarFieldReceivingAntennaCollection (API Collection) 2400 +FarFieldSource (API Object) 658 +FarFieldSurfacePlot (API Object) 3208 +FarFieldTrace (API Object) 3215 +FDTDBoundaryConditions (API Object) 545 +FEMLineMeshPort (API Object) 580 +FEMLinePort (API Object) 588 +FEMModalMeshPort (API Object) 595 +FEMModalPort (API Object) 601 +FEMModalSource (API Object) 604 +FieldData (API Object) 668 +FieldDataCollection (API Collection) 2408 +FillHoleSettings (API Object) 675 +Find (API Object) 678 +FittedSpline (API Object) 685 +Flare (API Object) 696 +FreeSpace (API Object) 815 +Frequency (API Object) 820 +GeneralNetwork (API Object) 852 +Geometry (API Object) 872 +GeometryCollection (API Collection) 2461 +GeometryExporter (API Object) 877 +GeometryGroup (API Collection) 2477 +GeometryGroupCollection (API Collection) 2482 +GeometryImporter (API Object) 882 +GeometryRebuild (API Object) 885 +GeometryRepair (API Object) 889 +GlobalMeshSettings (API Object) 898 +Ground (API Object) 913 +GroundPlane (API Object) 917 +GroundPlaneMedium (API Object) 922 +Helix (API Object) 931 +Hexagon (API Object) 939 +HexagonShape (API Object) 943 +HyperbolicArc (API Object) 960 +ImpedanceOptimisationGoal (API Object) 965 +ImpedanceSheet (API Object) 970 +ImpedanceSheetCollection (API Collection) 2486 +ImplicitPointsAnnotation (API Object) 3382 +Importer (API Object) 973 +ImpressedCurrent (API Object) 980 +ImprintPoints (API Object) 988 +Inductor (API Object) 993 +InterpolatorSettings (API Object) 3394 +Intersect (API Object) 1005 +KBL (API Object) 1017 +Launcher (API Object) 1026 +LaunchResult (API Object) 1021 +LayeredAnisotropicDielectric (API Object) 1031 +LayeredDielectric (API Object) 1033 +LayeredDielectricCollection (API Collection) 2492 +LayeredIsotropicDielectric (API Object) 1037 +LibraryMedium (API Object) 1040 +Line (API Object) 1047 +LinearPlanarArray (API Object) 1055 +Load (API Object) 1060 +LoadCollection (API Collection) 2498 +LoadSmithTrace (API Object) 3458 +LoadTrace (API Object) 3468 +LocalMeshSettings (API Object) 1074 +Loft (API Object) 1089 +MagneticDipole (API Object) 1104 +MainWindow (API Object) 1115 +MathTrace (API Object) 3484 +MdiSubWindow (API Object) 1123 +Media (API Object) 1129 +MediaLibrary (API Collection) 2502 +Medium (API Object) 1133 +Mesh (API Object) 1142 +MeshCurvilinearSegmentWire (API Object) 1156 +MeshCurvilinearTriangleFace (API Object) 1164 +MeshCurvilinearTriangleFaceCollection (API Collection) 2507 +MeshCurvilinearWire (API Object) 1167 +MeshCylinder (API Object) 1170 +MeshCylinderCollection (API Collection) 2511 +Mesher (API Object) 1246 +MeshExporter (API Object) 1174 +MeshFind (API Object) 1178 +MeshImporter (API Object) 1185 +MeshInfo (API Object) 1196 +MeshPlate (API Object) 1202 +MeshPlateCollection (API Collection) 2515 +MeshRefinementRule (API Object) 1208 +MeshRefinementRuleCollection (API Collection) 2519 +MeshRegion (API Object) 1210 +MeshSegmentCurvilinearWireCollection (API Collection) 2523 +MeshSegmentWire (API Object) 1219 +MeshSegmentWireCollection (API Collection) 2527 +MeshSettings (API Object) 1225 +MeshSettingsCollection (API Collection) 2531 +MeshTetrahedronRegion (API Object) 1231 +MeshTetrahedronRegionCollection (API Collection) 2535 +MeshTriangleFace (API Object) 1237 +MeshTriangleFaceCollection (API Collection) 2539 +MeshWire (API Object) 1243 +MessageWindow (API Object) 1250 +Metal (API Object) 1256 +MetalCollection (API Collection) 2543 +MicrostripMeshPort (API Object) 1264 +MicrostripPort (API Object) 1269 +Mirror (API Object) 1276 +Model (API Object) 1281 +ModelAttributes (API Object) 1284 +ModelContents (API Object) 1288 +ModelDecompositionCollection (API Collection) 2547 +ModelDefinitions (API Object) 1292 +ModelMeshInfo (API Object) 1302 +ModelSymmetry (API Object) 1305 +NamedPoint (API Object) 1310 +NamedPointCollection (API Collection) 2551 +NearField (API Object) 1319 +NearField3DPlot (API Object) 3588 +NearFieldCollection (API Collection) 2561 +NearFieldDataFileStructure (API Object) 1336 +NearFieldDataFullImport (API Object) 1343 +NearFieldOptimisationGoal (API Object) 1353 +NearFieldPowerIntegralTrace (API Object) 3609 +NearFieldReceivingAntenna (API Object) 1359 +NearFieldReceivingAntennaCollection (API Collection) 2565 +NearFieldSource (API Object) 1366 +NearFieldSurfacePlot (API Object) 3626 +NearFieldTrace (API Object) 3634 +Net (API Object) 1369 +NetCollection (API Collection) 2570 +Network (API Object) 1372 +NetworkCollection (API Collection) 2576 +NetworkTrace (API Object) 3651 +NumericalGreensFunction (API Object) 1379 +NurbsSurface (API Object) 1392 +Object (API Object) 1427 +OpenRing (API Object) 1440 +OpenRingShape (API Object) 1444 +OperatorCollection (API Collection) 2580 +Optimisation (API Object) 1448 +OptimisationCombination (API Object) 1451 +OptimisationGoal (API Object) 1458 +OptimisationGoalCollection (API Collection) 2587 +OptimisationGoalObjective (API Object) 1462 +OptimisationMask (API Object) 1470 +OptimisationMaskCollection (API Collection) 2591 +OptimisationOperator (API Object) 1476 +OptimisationParameters (API Object) 1480 +OptimisationSearch (API Object) 1484 +OptimisationSearchAdvancedSettings (API Object) 1487 +OptimisationSearchCollection (API Collection) 2595 +ParabolicArc (API Object) 1530 +Paraboloid (API Object) 1539 +PathSweep (API Object) 1565 +PCB (API Object) 1502 +PCBCurrentData (API Object) 1508 +PCBSource (API Object) 1514 +PerfectElectricConductor (API Object) 1568 +PerfectMagneticConductor (API Object) 1571 +PeriodicBoundary (API Object) 1579 +PlaneShape (API Object) 1595 +PlaneWave (API Object) 1602 +PointRefinement (API Object) 1623 +PolarGraph (API Object) 3679 +Polygon (API Object) 1636 +Polyline (API Object) 1644 +PolylineRefinement (API Object) 1650 +Port (API Object) 1654 +PortCollection (API Collection) 2610 +Power (API Object) 1662 +PowerOptimisationGoal (API Object) 1667 +PowerTrace (API Object) 3704 +Primitive (API Object) 1678 +ProjectGeometry (API Object) 1686 +ProtectedModel (API Object) 1693 +ProtectedModels (API Collection) 2614 +Ray3DPlot (API Object) 3714 +ReceivingAntennaOptimisationGoal (API Object) 1714 +ReceivingAntennaTrace (API Object) 3733 +Rectangle (API Object) 1722 +Region (API Object) 1732 +RegionCollection (API Collection) 2619 +RemoveSmallFeaturesSettings (API Object) 1737 +RepairAndSewFaces (API Object) 1745 +RepairAndSewFacesSettings (API Object) 1749 +RepairEdgesSettings (API Object) 1752 +RepairPart (API Object) 1759 +RepairPartsSettings (API Object) 1766 +ReportTemplate (API Object) 3741 +Resistor (API Object) 1770 +Ring (API Object) 1779 +RingShape (API Object) 1783 +Rotate (API Object) 1788 +SAR (API Object) 1793 +SAR3DPlot (API Object) 3781 +SARCollection (API Collection) 2623 +SAROptimisationGoal (API Object) 1797 +SARTrace (API Object) 3794 +Scale (API Object) 1814 +Schematic (API Object) 1817 +SchematicViewWindow (API Object) 1821 +Shape (API Object) 1829 +ShapeCollection (API Collection) 2635 +SimpleAnnotation (API Object) 3827 +Simplify (API Object) 1847 +SimplifyPartRepresentationSettings (API Object) 1861 +SimulationMeshInfo (API Object) 1878 +SmithChart (API Object) 3836 +SolutionCoefficientData (API Object) 1883 +SolutionCoefficientSource (API Object) 1889 +SolutionConfiguration (API Object) 1892 +SolutionConfigurationCollection (API Collection) 2642 +SolutionSettings (API Object) 1896 +SolverSettings (API Object) 1900 +Source (API Object) 1902 +SourceCollection (API Collection) 2655 +SParameter (API Object) 1800 +SParameterConfiguration (API Object) 1804 +SParameterOptimisationGoal (API Object) 1809 +SParameterSurfacePlot (API Object) 3814 +SParameterTrace (API Object) 3821 +Sphere (API Object) 1914 +SphericalModeDataFromFile (API Object) 1924 +SphericalModeDataManuallySpecified (API Object) 1929 +SphericalModeReceivingAntenna (API Object) 1940 +SphericalModeReceivingAntennaCollection (API Collection) 2659 +SphericalModeSource (API Object) 1947 +SpiceProbeTrace (API Object) 3941 +Spin (API Object) 1964 +SpiralCross (API Object) 1973 +SpiralCrossShape (API Object) 1977 +Split (API Object) 1987 +SplitRing (API Object) 1995 +SplitRingShape (API Object) 1999 +StandardConfiguration (API Object) 2005 +Stitch (API Object) 2013 +StripCross (API Object) 2022 +StripCrossShape (API Object) 2026 +StripHexagon (API Object) 2035 +StripHexagonShape (API Object) 2038 +Subtract (API Object) 2045 +SurfaceBezierCurve (API Object) 2054 +SurfaceCurrents3DPlot (API Object) 3947 +SurfaceLine (API Object) 2071 +SurfaceRegularLines (API Object) 2081 +Sweep (API Object) 2090 +TCross (API Object) 2099 +TCrossShape (API Object) 2103 +Terminal (API Object) 2106 +TerminalCollection (API Collection) 2663 +TopologyEntity (API Object) 2109 +TopologyEntityCollectionOf_Edge (API Collection) 2666 +Transform (API Object) 2115 +TransformCollection (API Collection) 2675 +Transformer (API Object) 2120 +Translate (API Object) 2125 +TransmissionLine (API Object) 2130 +TransmissionReflection (API Object) 2134 +TransmissionReflectionCollection (API Collection) 2679 +TransmissionReflectionOptimisationGoal (API Object) 2138 +TRCoefficientTrace (API Object) 4007 +Trifilar (API Object) 2147 +TrifilarShape (API Object) 2150 +Union (API Object) 2164 +UnitCell (API Object) 2169 +UnitCellCollection (API Collection) 2683 +UnprotectedInformation (API Object) 2176 +Variable (API Object) 2181 +VariableCollection (API Collection) 2688 +Version (API Object) 2187 +ViewXt (API Object) 2201 +ViewXtWindow (API Object) 2206 +VoltageControlledVoltageSource (API Object) 2210 +VoltageSource (API Object) 2214 +VoxelSettings (API Object) 2229 +WaveguideMeshPort (API Object) 2233 +WaveguidePort (API Object) 2244 +WaveguideSource (API Object) 2248 +WidthAnnotation (API Object) 4070 +Windscreen (API Object) 2251 +WindscreenCollection (API Collection) 2692 +WireCollection (API Collection) 2697 +WireCurrents3DPlot (API Object) 4079 +WireCurrentsTrace (API Object) 4098 +WireMeshPort (API Object) 2260 +WirePort (API Object) 2266 +Workplane (API Object) 2275 +WorkplaneCollection (API Collection) 2706 +WorkSurface (API Object) 2270 +WorkSurfaceCollection (API Collection) 2702 +Zero (API Object) 2280 +GetSampledDataSet (API Function) +FarField (API Object) 4301, 4302, 4302, 4303 +GetSampledDataSet (API Method) +FarFieldData (API Object) 3177, 3177, 3178, 3178 +GetValues (API Method) +BandwidthAnnotation (API Object) 2946 +BeamwidthAnnotation (API Object) 2951 +ImplicitPointsAnnotation (API Object) 3382 +SimpleAnnotation (API Object) 3827 +WidthAnnotation (API Object) 4070 +GlobalCoordinates (API Object) 891 +GlobalCoordinatesList (API Object) 893 +GlobalFrequency (API Property) +SolutionConfigurationCollection (API Collection) 2640 +GlobalLoads (API Collection) +SolutionConfigurationCollection (API Collection) 2641 +GlobalMeshSettings (API Object) 895 +GlobalNetworks (API Collection) +SolutionConfigurationCollection (API Collection) 2641 +GlobalOrigin (API Object) 899 +GlobalOriginList (API Object) 901 +GlobalPlane (API Object) 903 +GlobalPlaneList (API Object) 905 +GlobalPower (API Property) +SolutionConfigurationCollection (API Collection) 2640 +GlobalSources (API Collection) +SolutionConfigurationCollection (API Collection) 2641 +GlobalVector (API Object) 907 +GlobalVectorList (API Object) 909 +GoalOperator (API Property) +FarFieldOptimisationGoal (API Object) 640 +ImpedanceOptimisationGoal (API Object) 964 +NearFieldOptimisationGoal (API Object) 1351 +OptimisationGoal (API Object) 1457 +PowerOptimisationGoal (API Object) 1665 +ReceivingAntennaOptimisationGoal (API Object) 1713 +SAROptimisationGoal (API Object) 1796 +SParameterOptimisationGoal (API Object) 1807 +TransmissionReflectionOptimisationGoal (API Object) 2137 +Goals (API Collection) +OptimisationCombination (API Object) 1451 +OptimisationSearch (API Object) 1484 +GPU (API Property) +FEKOLaunchOptions (API Object) 558, 3155 +Graph (API Object) 3353 +GraphAnnotation (API Object) 3361 +GraphAxisLabels (API Object) 3366 +GraphAxisTitle (API Object) 3368 +GraphLegend (API Object) 3370 +GraphLineFormat (API Object) 3373 +GreaterThan (API StaticFunction) +ComplexMatrix (API Object) 3023, 3023, 3024, 3024 +Matrix (API Object) 3501, 3501 +GreaterThanOrEqual (API StaticFunction) +ComplexMatrix (API Object) 3024, 3025, 3025, 3025 +Matrix (API Object) 3501, 3501 +GreyscaleEnabled (API Property) +CartesianGraph (API Object) 2955 +CartesianSurfaceGraph (API Object) 2968 +Graph (API Object) 3355 +PolarGraph (API Object) 3674 +SmithChart (API Object) 3832 +SurfaceGraph (API Object) 3962 +GreyScaleEnabled (API Property) +View3DFormat (API Object) 4051 +Grid (API Property) +CartesianGraph (API Object) 2955 +CartesianSurfaceGraph (API Object) 2969 +PolarGraph (API Object) 3675 +SmithChart (API Object) 3832 +GridInfo (API Property) +VoxelSettings (API Object) 2227 +GridMaxInterval (API Property) +VoxelGridSummary (API Object) 2222 +GridMinInterval (API Property) +VoxelGridSummary (API Object) 2222 +GridType (API Property) +SmithChart (API Object) 3832 +GridVisible (API Property) +CustomData3DFormat (API Object) 3047 +FarField3DFormat (API Object) 3164 +NearField3DFormat (API Object) 3581 +Ground (API Object) 911 +GroundBottom (API Property) +PlanarSubstrate (API Object) 1589 +GroundPlane (API Object) 915 +GroundPlane (API Property) +SolutionSettings (API Object) 1894 +GroundPlaneMedium (API Object) 919 +GroundPlaneMedium (API Property) +Media (API Object) 1127 +GroupPartsByLabelEnabled (API Property) +MeshImporter (API Object) 1182 +GroupsSelected (API Property) +RaysQuantity (API Object) 3722 +GrowthRate (API Property) +MeshAdvancedSettings (API Object) 1146 +GrowthRateLimiting (API Property) +VoxelAdvancedSettings (API Object) 2217 +GrowthRateThreshold (API Property) +VoxelAdvancedSettings (API Object) 2217 +Harness (API Property) +CablePort (API Object) 237 +HealAndSimplifyRepresentation (API Property) +PCB (API Object) 1499 +HealingType (API Property) +GeometryImporter (API Object) 881 +Height (API Property) +Box (API Object) 174 +CartesianGraph (API Object) 2955 +CartesianStructure (API Object) 296 +CartesianSurfaceGraph (API Object) 2969 +Cone (API Object) 352 +Cuboid (API Object) 392 +Cylinder (API Object) 424 +CylindricalStructure (API Object) 446 +Flare (API Object) 691 +Form (API Object) 699, 3221 +FormImage (API Object) 746, 3279 +FormProgressDialog (API Object) 779, 3317 +Graph (API Object) 3356 +Helix (API Object) 927 +MdiSubWindow (API Object) 1121 +PolarGraph (API Object) 3675 +ReportImageSizeSetting (API Object) 3735 +ResultTextBox (API Object) 3769 +SchematicViewWindow (API Object) 1820 +SmithChart (API Object) 3832 +SurfaceGraph (API Object) 3962 +View (API Object) 4039 +ViewXtWindow (API Object) 2204 +Window (API Object) 4072 +Helix (API Object) 923 +Hexagon (API Object) 933 +HexagonShape (API Object) 941 +HFieldFilename (API Property) +NearFieldDataFileStructure (API Object) 1333 +NearFieldDataFullImport (API Object) 1340 +HigherOrderEffects (API Property) +RayContributionsFacetedUTD (API Object) 1699 +HighFrequencyPOMoMCouplingType (API Property) +HighFrequencySettings (API Object) 946 +HighFrequencySettings (API Object) 944 +HighFrequencySettings (API Property) +SolverSettings (API Object) 1899 +HighFrequencySettingsList (API Object) 951 +HighlightingOption (API Property) +MeshRendering (API Object) 3547 +HOBFEnabled (API Property) +BasisFunctionGlobalSolverSettings (API Object) 154 +BasisFunctionLocalSolverSettings (API Object) 158 +HoleBoundaryTransition (API Property) +FillHoleSettings (API Object) 674 +HorizontalAxis (API Property) +CartesianGraph (API Object) 2955 +CartesianSurfaceGraph (API Object) 2969 +HorizontalGraphAxis (API Object) 3375 +HorizontalIndependentAxis (API Property) +CustomDataSurfacePlot (API Object) 3066 +FarFieldSurfacePlot (API Object) 3206 +NearFieldSurfacePlot (API Object) 3623 +ResultSurfacePlot (API Object) 3763 +SParameterSurfacePlot (API Object) 3812 +HorizontalLabelsVisible (API Property) +CartesianGridLines (API Object) 2964 +CartesianSurfaceGraphGridLines (API Object) 2975 +HorizontalLine (API Property) +CartesianGridLines (API Object) 2965 +CartesianSurfaceGraphGridLines (API Object) 2976 +HorizontalSurfaceGraphAxis (API Object) 3377 +Host (API Property) +FEKORemoteExecutionOptions (API Object) 571, 3162 +HyperbolicArc (API Object) 953 +IconPath (API Property) +FormPushButton (API Object) 784, 3322 +Identity (API StaticFunction) +ComplexMatrix (API Object) 3025 +Matrix (API Object) 3502 +IF statement +Lua 16 +IFFT (API Method) +ComplexMatrix (API Object) 3018 +Matrix (API Object) 3496 +im (API Property) +Complex (API Object) 317, 2997 +ComplexMatrix (API Object) 3017 +Im (API Property) +ComplexMatrix (API Object) 3016 +Matrix (API Object) 3494 +Imag (API Method) +Complex (API Object) 318, 2998 +ComplexMatrix (API Object) 3018 +Matrix (API Object) 3496 +Imag (API StaticFunction) +Complex (API Object) 322, 322, 3003, 3003 +ComplexMatrix (API Object) 3026 +ImageFormat (API Property) +QuickReport (API Object) 3707 +ReportTemplate (API Object) 3739 +ResultReport (API Object) 3761 +ImageSize (API Property) +QuickReport (API Object) 3707 +ReportTemplate (API Object) 3739 +ResultReport (API Object) 3761 +Impedance (API Property) +CurrentSource (API Object) 399 +DataSetMetaData (API Object) 3107 +PortProperties (API Object) 1656 +VoltageSource (API Object) 2213 +ImpedanceDefinitionMethod (API Property) +ShieldLayerSettings (API Object) 1833 +ImpedanceImaginary (API Property) +ComplexLoad (API Object) 331 +ImpedanceSheet (API Object) 969 +Load (API Object) 1058 +SurfaceImpedanceFrequencyPoint (API Object) 2061 +ImpedanceIncluded (API Property) +FrequencyContinuousQuantities (API Object) 826 +ImpedanceOptimisationGoal (API Object) 962 +ImpedanceReal (API Property) +ComplexLoad (API Object) 331 +ImpedanceSheet (API Object) 969 +Load (API Object) 1059 +SurfaceImpedanceFrequencyPoint (API Object) 2061 +ImpedanceSheet (API Collection) +Media (API Object) 1128 +ImpedanceSheet (API Object) 967 +ImpedanceSheetCollection (API Collection) 2484 +ImplicitPointsAnnotation (API Object) 3379 +Import (API Method) +CFXModelImporter (API Object) 182 +KBL (API Object) 1017 +MeshImporter (API Object) 1185 +PCB (API Object) 1502 +ImportCableDefinitionsEnabled (API Property) +CFXModelImportSettings (API Object) 176 +ImportDataSet (API Function) +DRE (API Object) 4295, 4295 +ImportedData (API Collection) +ImportSet (API Object) 3386 +ImportedDataCollection (API Collection) 4147 +ImportedDataSetCollection (API Collection) 4150 +ImportedDataSets (API Collection) +Application (API Object) 2931 +Importer (API Object) 971 +Importer (API Property) +Model (API Object) 1279 +ImportGeometryEnabled (API Property) +CFXModelImportSettings (API Object) 176 +ImportMeshEnabled (API Property) +CFXModelImportSettings (API Object) 177 +ImportMeshRulesEnabled (API Property) +CFXModelImportSettings (API Object) 177 +ImportOptimisationSearchesEnabled (API Property) +CFXModelImportSettings (API Object) 177 +ImportReportTemplate (API Method) +ReportsCollection (API Collection) 4212 +ImportResults (API Method) +Application (API Object) 2934, 2934 +ImportScaleFactor (API Property) +GeometryImporter (API Object) 881 +PCB (API Object) 1500 +ImportSet (API Object) 3384 +ImportSolutionEntitiesEnabled (API Property) +CFXModelImportSettings (API Object) 177 +ImportViasEnabled (API Property) +PCB (API Object) 1500 +ImpressedCurrent (API Object) 974 +ImpressedCurrentClosestVertexType (API Property) +ImpressedCurrent (API Object) 976 +ImprintPoints (API Method) +GeometryCollection (API Collection) 2461, 2461 +ImprintPoints (API Object) 981 +IncludeBoardOutline (API Property) +PCB (API Object) 1500 +IncludeLayerDielectric (API Property) +PCB (API Object) 1500 +IncludeLayerSignal (API Property) +PCB (API Object) 1500 +IncludeLayerSilkscreen (API Property) +PCB (API Object) 1500 +IncludeLayerSolderPaste (API Property) +PCB (API Object) 1500 +IncludeLayerSolderResist (API Property) +PCB (API Object) 1501 +IncludeLayerUserDefined (API Property) +PCB (API Object) 1501 +IncludeMissingData (API Property) +FormDataSelector (API Object) 3245 +IncludeScatteredPart (API Property) +BaseFieldReceivingAntenna (API Object) 149 +FarFieldReceivingAntenna (API Object) 649 +NearFieldReceivingAntenna (API Object) 1357 +SphericalModeReceivingAntenna (API Object) 1937 +IncludesPhi (API Property) +NearFieldQuantity (API Object) 3611 +IncludesRadius (API Property) +NearFieldQuantity (API Object) 3612 +IncludesRho (API Property) +NearFieldQuantity (API Object) 3612 +IncludesTheta (API Property) +NearFieldQuantity (API Object) 3612 +IncludesX (API Property) +NearFieldQuantity (API Object) 3612 +IncludesY (API Property) +NearFieldQuantity (API Object) 3612 +IncludesZ (API Property) +NearFieldQuantity (API Object) 3612 +IncompleteAnalysisRestartEnabled (API Property) +ADAPTFEKOLaunchOptions (API Object) 59, 2925 +Increment (API Property) +PointRange (API Object) 1613 +Independent (API Property) +TraceAxes (API Object) 4015 +IndependentAxesAvailable (API Property) +CharacteristicModeTrace (API Object) 2988 +CustomDataSmithTrace (API Object) 3059 +CustomDataSurfacePlot (API Object) 3066 +CustomDataTrace (API Object) 3072 +ExcitationSmithTrace (API Object) 3138 +ExcitationTrace (API Object) 3148 +FarFieldPowerIntegralTrace (API Object) 3190 +FarFieldSurfacePlot (API Object) 3206 +FarFieldTrace (API Object) 3212 +LoadSmithTrace (API Object) 3455 +LoadTrace (API Object) 3465 +MathTrace (API Object) 3482 +NearFieldPowerIntegralTrace (API Object) 3605 +NearFieldSurfacePlot (API Object) 3623 +NearFieldTrace (API Object) 3631 +NetworkTrace (API Object) 3648 +PowerTrace (API Object) 3701 +ReceivingAntennaTrace (API Object) 3731 +ResultSurfacePlot (API Object) 3763 +ResultTrace (API Object) 3776 +SARTrace (API Object) 3791 +SParameterSurfacePlot (API Object) 3812 +SParameterTrace (API Object) 3818 +SpiceProbeTrace (API Object) 3939 +TRCoefficientTrace (API Object) 4004 +WireCurrentsTrace (API Object) 4095 +IndependentAxis (API Property) +CharacteristicModeTrace (API Object) 2989 +CustomDataSmithTrace (API Object) 3059 +CustomDataTrace (API Object) 3072 +ExcitationSmithTrace (API Object) 3138 +ExcitationTrace (API Object) 3148 +FarFieldPowerIntegralTrace (API Object) 3190 +FarFieldTrace (API Object) 3212 +LoadSmithTrace (API Object) 3455 +LoadTrace (API Object) 3465 +MathTrace (API Object) 3482 +NearFieldPowerIntegralTrace (API Object) 3605 +NearFieldTrace (API Object) 3631 +NetworkTrace (API Object) 3648 +PowerTrace (API Object) 3701 +ReceivingAntennaTrace (API Object) 3731 +ResultTrace (API Object) 3776 +SARTrace (API Object) 3791 +SParameterTrace (API Object) 3818 +SpiceProbeTrace (API Object) 3939 +TRCoefficientTrace (API Object) 4004 +WireCurrentsTrace (API Object) 4095 +IndependentAxisFormat (API Object) 3387 +IndependentAxisValues (API Property) +InterpolatorSettings (API Object) 3394 +Index (API Property) +FormComboBox (API Object) 711, 3233 +FormConfigurationSelector (API Object) 3239 +FormDataSelector (API Object) 3245 +FormModelSelector (API Object) 3313 +MeshSegmentReference (API Object) 1212 +MeshVertexReference (API Object) 1240 +IndexM (API Property) +PortProperties (API Object) 1656 +WaveguideModeOptions (API Object) 2236 +IndexN (API Property) +PortProperties (API Object) 1656 +WaveguideModeOptions (API Object) 2236 +IndexSchemeType (API Property) +SphericalModeOptions (API Object) 1931 +Inductance (API Property) +Inductor (API Object) 991 +Load (API Object) 1059 +InductanceEnabled (API Property) +Load (API Object) 1059 +Inductor (API Object) 990 +InfinitePlanesOpacity (API Property) +View3DSolutionEntityFormat (API Object) 4057 +InfinitePlanesVisible (API Property) +View3DSolutionEntityFormat (API Object) 4057 +Info (API StaticFunction) +Form (API Object) 701, 3223 +InnerLayer (API Property) +CableShield (API Object) 259 +InnerRadius (API Property) +OpenRing (API Object) 1436 +OpenRingShape (API Object) 1443 +Ring (API Object) 1775 +RingShape (API Object) 1782 +SplitRing (API Object) 1991 +SplitRingShape (API Object) 1998 +InputOutputCrossed (API Property) +TransmissionLine (API Object) 2128 +InputPort (API Property) +SParameterOptimisationGoal (API Object) 1807 +InputPortSpecified (API Property) +SParameterOptimisationGoal (API Object) 1807 +InsideBraidFixingMedium (API Property) +ShieldLayerSettings (API Object) 1833 +inspect 20 +InspectZip (API Function) +Archive (API Object) 4287 +InstantaneousPhase (API Property) +NearFieldQuantity (API Object) 3613 +SurfaceCurrentsQuantity (API Object) 3959 +WireCurrentsQuantity (API Object) 4090 +InsufficientMemoryProtectionEnabled (API Property) +MeshAdvancedSettings (API Object) 1147 +Insulated (API Property) +CableRibbonCrossSection (API Object) 247 +CableSingleConductorCrossSection (API Object) 267 +CableTwistedPairCrossSection (API Object) 276 +InsulationMedium (API Property) +CableBundleCrossSection (API Object) 190 +CableRibbonCrossSection (API Object) 247 +CableSingleConductorCrossSection (API Object) 267 +CableTwistedPairCrossSection (API Object) 276 +InsulationThickness (API Property) +CableRibbonCrossSection (API Object) 247 +CableSingleConductorCrossSection (API Object) 267 +CableTwistedPairCrossSection (API Object) 276 +IntegralEquation (API Object) 995 +IntegralEquation (API Property) +Face (API Object) 613 +MeshCurvilinearTriangleFace (API Object) 1161 +MeshPlate (API Object) 1200 +MeshTriangleFace (API Object) 1235 +SolverSettings (API Object) 1899 +IntegralEquationList (API Object) 997 +InteractionsUpTo (API Property) +RaysQuantity (API Object) 3722 +InternalApproximationMethod (API Property) +SphericalModeReceivingAntenna (API Object) 1937 +Interpolator (API Object) 3389 +InterpolatorSettings (API Object) 3393 +Intersect (API Method) +GeometryCollection (API Collection) 2461 +Intersect (API Object) 999 +IntersectionsVisible (API Property) +Rays3DFormat (API Object) 3719 +IntrinsicWireRadiusEnabled (API Property) +VoxelSettings (API Object) 2227 +Inverse (API Method) +ComplexMatrix (API Object) 3019 +Matrix (API Object) 3496 +IsEqual (API StaticFunction) +Complex (API Object) 323, 323, 3003, 3003 +ComplexMatrix (API Object) 3026, 3026, 3026, 3027 +Matrix (API Object) 3502, 3502 +IsFrequencyPerConfiguration (API Property) +SolutionConfigurationCollection (API Collection) 2640 +IsInfinite (API Method) +Complex (API Object) 318, 2998 +IsInfinite (API StaticFunction) +Complex (API Object) 323, 3004 +IsLoadsPerConfiguration (API Property) +SolutionConfigurationCollection (API Collection) 2640 +IsNotANumber (API Method) +Complex (API Object) 318, 2999 +IsNotANumber (API StaticFunction) +Complex (API Object) 324, 3004 +IsoSurface (API Property) +NearField3DPlot (API Object) 3585 +IsoSurface3DFormat (API Object) 3395 +IsotropicDielectricLayers (API Object) 1007 +IsotropicDielectricLayersList (API Object) 1009 +IsPowerPerConfiguration (API Property) +SolutionConfigurationCollection (API Collection) 2640 +IsSourcesPerConfiguration (API Property) +SolutionConfigurationCollection (API Collection) 2640 +Italicised (API Property) +FontFormat (API Object) 3218 +SurfaceGraphFontFormat (API Object) 3975 +Item (API Method) +AnisotropicDielectricCollection (API Collection) 2285, 2285 +AntennaArrayCollection (API Collection) 2292, 2292 +CableConnectorCollection (API Collection) 2298, 2298 +CableConnectorPinCollection (API Collection) 2301, 2301 +CableCrossSectionCollection (API Collection) 2313, 2313 +CableHarnessCollection (API Collection) 2317, 2318 +CableInstanceCollection (API Collection) 2322, 2322 +CablePathCollection (API Collection) 2326, 2327 +CableProbeCollection (API Collection) 2330, 2331 +CableSchematicComponentCollection (API Collection) 2344, 2344 +CableShieldCollection (API Collection) 2350, 2351 +CableSignalCollection (API Collection) 2354, 2354 +CartesianGraphCollection (API Collection) 4102, 4102 +CartesianSurfaceGraphCollection (API Collection) 4105, 4105 +CharacterisedSurfaceCollection (API Collection) 2358, 2359 +CharacteristicModeCollection (API Collection) 4107, 4108 +CollectionOf_DomainEntity (API Collection) 2362, 2362 +CollectionOf_Mesh (API Collection) 2364, 2365 +ConfigurationCollection (API Collection) 4110, 4111 +CurrentsCollection (API Collection) 2368, 2369 +CutplaneCollection (API Collection) 2372, 2372 +DataSetAxisCollection (API Collection) 4116, 4117 +DataSetQuantityCollection (API Collection) 4120, 4121 +DielectricCollection (API Collection) 2377, 2377 +EdgeCollection (API Collection) 2381, 2381 +ErrorEstimateCollection (API Collection) 4123, 4123 +ErrorEstimationCollection (API Collection) 2385, 2386 +ExcitationCollection (API Collection) 4126, 4127 +FaceCollection (API Collection) 2390, 2390 +FarFieldCollection (API Collection) 2396, 2396, 4129, 4130 +FarFieldPowerIntegralCollection (API Collection) 4132, 4133 +FarFieldReceivingAntennaCollection (API Collection) 2400, 2401 +FieldDataCollection (API Collection) 2408, 2408 +FormGroupBoxItemCollection (API Collection) 2411, 2412, 4135, 4136 +FormItemCollection (API Collection) 2414, 2415, 4138, 4139 +FormLayoutItemCollection (API Collection) 2418, 2418, 4142, 4142 +FormScrollAreaItemCollection (API Collection) 2421, 2421, 4146, 4146 +GeometryCollection (API Collection) 2461, 2462 +GeometryGroup (API Collection) 2477, 2478 +GeometryGroupCollection (API Collection) 2482, 2482 +ImpedanceSheetCollection (API Collection) 2487, 2487 +ImportedDataCollection (API Collection) 4148, 4149 +ImportedDataSetCollection (API Collection) 4151, 4152 +LayeredDielectricCollection (API Collection) 2492, 2492 +LoadCollection (API Collection) 2498, 2499, 4154, 4155 +MathScriptCollection (API Collection) 4158, 4158 +MediaLibrary (API Collection) 2502, 2503 +MeshCubeRegionCollection (API Collection) 4161, 4162 +MeshCurvilinearSegmentWireCollection (API Collection) 4164, 4165 +MeshCurvilinearTriangleFaceCollection (API Collection) 2507, 2507, 4167, 4168 +MeshCylinderCollection (API Collection) 2511, 2511 +MeshPlateCollection (API Collection) 2515, 2515 +MeshRefinementRuleCollection (API Collection) 2519, 2520 +MeshSegmentCurvilinearWireCollection (API Collection) 2523, 2523 +MeshSegmentWireCollection (API Collection) 2527, 2527, 4170, 4171 +MeshSettingsCollection (API Collection) 2531, 2532 +MeshTetrahedronRegionCollection (API Collection) 2535, 2535, 4173, 4174 +MeshTriangleFaceCollection (API Collection) 2539, 2539, 4176, 4177 +MeshUnmeshedCylinderRegionCollection (API Collection) 4179, 4180 +MeshUnmeshedPolygonFaceCollection (API Collection) 4183, 4183 +MetalCollection (API Collection) 2544, 2544 +ModelCollection (API Collection) 4185, 4185 +ModelDecompositionCollection (API Collection) 2547, 2548 +NamedPointCollection (API Collection) 2551, 2552 +NearFieldCollection (API Collection) 2561, 2561, 4188, 4189 +NearFieldPowerIntegralCollection (API Collection) 4191, 4192 +NearFieldReceivingAntennaCollection (API Collection) 2565, 2565 +NetCollection (API Collection) 2570, 2570 +NetworkCollection (API Collection) 2576, 2577, 4194, 4195 +OperatorCollection (API Collection) 2580, 2580 +OptimisationGoalCollection (API Collection) 2587, 2587 +OptimisationMaskCollection (API Collection) 2591, 2592 +OptimisationSearchCollection (API Collection) 2595, 2596 +PolarGraphCollection (API Collection) 4198, 4198 +PortCollection (API Collection) 2610, 2610 +PowerCollection (API Collection) 4200, 4201 +ProtectedModels (API Collection) 2615, 2615 +RayCollection (API Collection) 4203, 4204 +ReceivingAntennaCollection (API Collection) 4206, 4207 +RegionCollection (API Collection) 2619, 2619 +ReportsCollection (API Collection) 4212, 4212 +ReportTemplateTagCollection (API Collection) 4209 +Result3DPlotCollection (API Collection) 4216, 4216 +ResultAnnotationCollection (API Collection) 4229, 4229 +ResultArrowCollection (API Collection) 4234, 4234 +ResultSurfacePlotCollection (API Collection) 4238, 4238 +ResultTextBoxCollection (API Collection) 4243, 4243 +ResultTraceCollection (API Collection) 4247, 4247 +SARCollection (API Collection) 2623, 2624, 4250, 4251 +ShapeCollection (API Collection) 2635, 2635 +SmithChartCollection (API Collection) 4257, 4257 +SolutionConfigurationCollection (API Collection) 2642, 2642 +SourceCollection (API Collection) 2655, 2655 +SParameterCollection (API Collection) 4253, 4254 +SphericalModeReceivingAntennaCollection (API Collection) 2659, 2660 +SpiceProbeCollection (API Collection) 4259, 4260 +StoredDataCollection (API Collection) 4262, 4263 +SurfaceCurrentsCollection (API Collection) 4265, 4266 +TerminalCollection (API Collection) 2663, 2663 +TopologyEntityCollectionOf_Edge (API Collection) 2667, 2667 +TransformCollection (API Collection) 2675, 2675 +TransmissionLineCollection (API Collection) 4271, 4272 +TransmissionReflectionCollection (API Collection) 2680, 2680 +TRCoefficientCollection (API Collection) 4268, 4269 +UnitCellCollection (API Collection) 2683, 2683 +VariableCollection (API Collection) 2688, 2688 +ViewCollection (API Collection) 4275, 4275 +WindowCollection (API Collection) 4279, 4279 +WindscreenCollection (API Collection) 2693, 2693 +WireCollection (API Collection) 2697, 2697 +WireCurrentsCollection (API Collection) 4281, 4282 +WorkplaneCollection (API Collection) 2706, 2707 +WorkSurfaceCollection (API Collection) 2702, 2702 +ItemHeight (API Property) +FormCheckBox (API Object) 706, 3228 +FormComboBox (API Object) 712, 3234 +FormConfigurationSelector (API Object) 3239 +FormDataSelector (API Object) 3245 +FormDirectoryBrowser (API Object) 717, 3250 +FormDoubleSpinBox (API Object) 722, 3255 +FormFileBrowser (API Object) 728, 3261 +FormFileSaveAsBrowser (API Object) 734, 3267 +FormGroupBox (API Object) 740, 3273 +FormImage (API Object) 746, 3279 +FormIntegerSpinBox (API Object) 751, 3284 +FormItem (API Object) 757, 3290 +FormLabel (API Object) 761, 3294 +FormLabelledItem (API Object) 765, 3298 +FormLayout (API Object) 769, 3302 +FormLineEdit (API Object) 775, 3308 +FormModelSelector (API Object) 3313 +FormPushButton (API Object) 784, 3322 +FormRadioButtonGroup (API Object) 790, 3328 +FormScrollArea (API Object) 797, 3334 +FormSeparator (API Object) 802, 3340 +FormTree (API Object) 807, 3345 +Items (API Method) +AnisotropicDielectricCollection (API Collection) 2285 +AntennaArrayCollection (API Collection) 2292 +CableConnectorCollection (API Collection) 2298 +CableConnectorPinCollection (API Collection) 2301 +CableCrossSectionCollection (API Collection) 2314 +CableHarnessCollection (API Collection) 2318 +CableInstanceCollection (API Collection) 2322 +CablePathCollection (API Collection) 2327 +CableProbeCollection (API Collection) 2331 +CableSchematicComponentCollection (API Collection) 2344 +CableShieldCollection (API Collection) 2351 +CableSignalCollection (API Collection) 2354 +CartesianGraphCollection (API Collection) 4102 +CartesianSurfaceGraphCollection (API Collection) 4105 +CharacterisedSurfaceCollection (API Collection) 2359 +CharacteristicModeCollection (API Collection) 4108 +CollectionOf_DomainEntity (API Collection) 2362 +CollectionOf_Mesh (API Collection) 2365 +ConfigurationCollection (API Collection) 4111 +CurrentsCollection (API Collection) 2369 +CutplaneCollection (API Collection) 2372 +DataSetAxisCollection (API Collection) 4117 +DataSetQuantityCollection (API Collection) 4121 +DielectricCollection (API Collection) 2377 +EdgeCollection (API Collection) 2381 +ErrorEstimateCollection (API Collection) 4124 +ErrorEstimationCollection (API Collection) 2386 +ExcitationCollection (API Collection) 4127 +FaceCollection (API Collection) 2390 +FarFieldCollection (API Collection) 2396, 4130 +FarFieldPowerIntegralCollection (API Collection) 4133 +FarFieldReceivingAntennaCollection (API Collection) 2401 +FieldDataCollection (API Collection) 2408 +FormGroupBoxItemCollection (API Collection) 2412, 4136 +FormItemCollection (API Collection) 2415, 4139 +FormLayoutItemCollection (API Collection) 2418, 4142 +FormScrollAreaItemCollection (API Collection) 2421, 4146 +GeometryCollection (API Collection) 2462 +GeometryGroup (API Collection) 2478 +GeometryGroupCollection (API Collection) 2482 +ImpedanceSheetCollection (API Collection) 2487 +ImportedDataCollection (API Collection) 4149 +ImportedDataSetCollection (API Collection) 4152 +LayeredDielectricCollection (API Collection) 2493 +LoadCollection (API Collection) 2499, 4155 +MathScriptCollection (API Collection) 4158 +MediaLibrary (API Collection) 2503 +MeshCubeRegionCollection (API Collection) 4162 +MeshCurvilinearSegmentWireCollection (API Collection) 4165 +MeshCurvilinearTriangleFaceCollection (API Collection) 2508, 4168 +MeshCylinderCollection (API Collection) 2511 +MeshPlateCollection (API Collection) 2515 +MeshRefinementRuleCollection (API Collection) 2520 +MeshSegmentCurvilinearWireCollection (API Collection) 2524 +MeshSegmentWireCollection (API Collection) 2527, 4171 +MeshSettingsCollection (API Collection) 2532 +MeshTetrahedronRegionCollection (API Collection) 2535, 4174 +MeshTriangleFaceCollection (API Collection) 2539, 4177 +MeshUnmeshedCylinderRegionCollection (API Collection) 4180 +MeshUnmeshedPolygonFaceCollection (API Collection) 4183 +MetalCollection (API Collection) 2544 +ModelCollection (API Collection) 4186 +ModelDecompositionCollection (API Collection) 2548 +NamedPointCollection (API Collection) 2552 +NearFieldCollection (API Collection) 2561, 4189 +NearFieldPowerIntegralCollection (API Collection) 4192 +NearFieldReceivingAntennaCollection (API Collection) 2566 +NetCollection (API Collection) 2570 +NetworkCollection (API Collection) 2577, 4195 +OperatorCollection (API Collection) 2581 +OptimisationGoalCollection (API Collection) 2587 +OptimisationMaskCollection (API Collection) 2592 +OptimisationSearchCollection (API Collection) 2596 +PolarGraphCollection (API Collection) 4198 +PortCollection (API Collection) 2610 +PowerCollection (API Collection) 4201 +ProtectedModels (API Collection) 2615 +RayCollection (API Collection) 4204 +ReceivingAntennaCollection (API Collection) 4207 +RegionCollection (API Collection) 2620 +ReportsCollection (API Collection) 4212 +Result3DPlotCollection (API Collection) 4216 +ResultAnnotationCollection (API Collection) 4229 +ResultArrowCollection (API Collection) 4234 +ResultSurfacePlotCollection (API Collection) 4238 +ResultTextBoxCollection (API Collection) 4243 +ResultTraceCollection (API Collection) 4247 +SARCollection (API Collection) 2624, 4251 +ShapeCollection (API Collection) 2635 +SmithChartCollection (API Collection) 4257 +SolutionConfigurationCollection (API Collection) 2643 +SourceCollection (API Collection) 2655 +SParameterCollection (API Collection) 4254 +SphericalModeReceivingAntennaCollection (API Collection) 2660 +SpiceProbeCollection (API Collection) 4260 +StoredDataCollection (API Collection) 4263 +SurfaceCurrentsCollection (API Collection) 4266 +TerminalCollection (API Collection) 2663 +TopologyEntityCollectionOf_Edge (API Collection) 2667 +TransformCollection (API Collection) 2676 +TransmissionLineCollection (API Collection) 4272 +TransmissionReflectionCollection (API Collection) 2680 +TRCoefficientCollection (API Collection) 4269 +UnitCellCollection (API Collection) 2684 +VariableCollection (API Collection) 2688 +ViewCollection (API Collection) 4275 +WindowCollection (API Collection) 4279 +WindscreenCollection (API Collection) 2693 +WireCollection (API Collection) 2698 +WireCurrentsCollection (API Collection) 4282 +WorkplaneCollection (API Collection) 2707 +WorkSurfaceCollection (API Collection) 2702 +ItemWidth (API Property) +FormCheckBox (API Object) 707, 3229 +FormComboBox (API Object) 712, 3234 +FormConfigurationSelector (API Object) 3239 +FormDataSelector (API Object) 3245 +FormDirectoryBrowser (API Object) 717, 3250 +FormDoubleSpinBox (API Object) 723, 3256 +FormFileBrowser (API Object) 728, 3261 +FormFileSaveAsBrowser (API Object) 734, 3267 +FormGroupBox (API Object) 741, 3274 +FormImage (API Object) 746, 3279 +FormIntegerSpinBox (API Object) 752, 3284 +FormItem (API Object) 757, 3290 +FormLabel (API Object) 761, 3294 +FormLabelledItem (API Object) 765, 3298 +FormLayout (API Object) 769, 3303 +FormLineEdit (API Object) 775, 3308 +FormModelSelector (API Object) 3313 +FormPushButton (API Object) 785, 3323 +FormRadioButtonGroup (API Object) 791, 3329 +FormScrollArea (API Object) 797, 3335 +FormSeparator (API Object) 802, 3340 +FormTree (API Object) 807, 3345 +iterate +ForAllValues 33 +IterativeSolverSettings (API Object) 1011 +IterativeSolverSettings (API Property) +PreconditionerSettings (API Object) 1669 +IterativeSolverSettingsList (API Object) 1014 +KBL (API Object) 1016 +KBL (API Property) +Importer (API Object) 972 +KeepWithLocalMeshSizeEnabled (API Property) +SimplifyEdgeSettings (API Object) 1850 +SimplifyFaceSettings (API Object) 1853 +SimplifyRegionSettings (API Object) 1866 +Label (API Property) +AbstractAntennaArray (API Object) 63 +AbstractFEMLinePort (API Object) 68 +AbstractIdealSource (API Object) 74 +AbstractMeshEdge (API Object) 79 +AbstractMeshPort (API Object) 82 +AbstractMeshTriangleFace (API Object) 85 +AbstractMeshWire (API Object) 88 +AbstractPointSource (API Object) 91 +AbstractSurfaceCurve (API Object) 98 +AdaptiveRefinement (API Object) 105 +Align (API Object) 114 +AnalyticalCurve (API Object) 121 +AnisotropicDielectric (API Object) 132 +AnisotropicDielectricCollection (API Collection) 2284 +AntennaArrayCollection (API Collection) 2289 +Application (API Object) 144 +BandwidthAnnotation (API Object) 2945 +BaseFieldReceivingAntenna (API Object) 149 +BeamwidthAnnotation (API Object) 2950 +BezierCurve (API Object) 163 +CableBundleCrossSection (API Object) 190 +CableCoaxialCrossSection (API Object) 197 +CableConnector (API Object) 202 +CableConnectorCollection (API Collection) 2296 +CableConnectorPin (API Object) 206 +CableConnectorPinCollection (API Collection) 2300 +CableCrossSection (API Object) 209 +CableCrossSectionCollection (API Collection) 2306 +CableGeneralNetwork (API Object) 212 +CableHarness (API Object) 217 +CableHarnessCollection (API Collection) 2316 +CableInstance (API Object) 221 +CableInstanceCollection (API Collection) 2320 +CableNonConductingElementCrossSection (API Object) 224 +CablePath (API Object) 228 +CablePathCollection (API Collection) 2325 +CablePathTerminal (API Object) 234 +CablePort (API Object) 238 +CableProbe (API Object) 242 +CableProbeCollection (API Collection) 2329 +CableRibbonCrossSection (API Object) 248 +Cables (API Object) 280 +CableSchematicComponentCollection (API Collection) 2335 +CableSchematicCurrentProbe (API Object) 251 +CableSchematicVoltageProbe (API Object) 255 +CableShield (API Object) 260 +CableShieldCollection (API Collection) 2347 +CableSignal (API Object) 263 +CableSignalCollection (API Collection) 2353 +CableSingleConductorCrossSection (API Object) 267 +CableSpiceNetwork (API Object) 271 +CableTwistedPairCrossSection (API Object) 276 +Capacitor (API Object) 284 +CFXModelImporter (API Object) 181 +CFXModelImportSettings (API Object) 177 +CharacterisedSurface (API Object) 300 +CharacterisedSurfaceCollection (API Collection) 2357 +CharacteristicModeData (API Object) 2979 +CharacteristicModes (API Object) 303 +CharacteristicModesConfiguration (API Object) 306 +CharacteristicModeStoredData (API Object) 2984 +CharacteristicModeTrace (API Object) 2989 +CollectionOf_DomainEntity (API Collection) 2361 +CollectionOf_Mesh (API Collection) 2364 +ComplexLoad (API Object) 331 +ComponentLaunchOptions (API Object) 340 +Cone (API Object) 353 +ConstrainedSurface (API Object) 366 +Cross (API Object) 380 +CrossShape (API Object) 387 +Cuboid (API Object) 392 +Currents (API Object) 403 +CurrentsCollection (API Collection) 2367 +CurrentSource (API Object) 399 +CustomAntennaArray (API Object) 411 +CustomData3DPlot (API Object) 3051 +CustomDataSmithTrace (API Object) 3059 +CustomDataSurfacePlot (API Object) 3066 +CustomDataTrace (API Object) 3073 +CustomMathScript (API Object) 3078 +CustomStoredData (API Object) 3083 +Cutplane (API Object) 417 +CutplaneCollection (API Collection) 2371 +Cylinder (API Object) 424 +CylindricalAntennaArray (API Object) 433 +DefaultMedium (API Object) 459 +Dielectric (API Object) 463 +DielectricBoundaryMedium (API Object) 466 +DielectricCollection (API Collection) 2375 +Edge (API Object) 491 +EdgeCollection (API Collection) 2380 +EdgeMeshPort (API Object) 497 +EdgePort (API Object) 501 +ElectricDipole (API Object) 507 +Ellipse (API Object) 513 +EllipseShape (API Object) 520 +EllipticArc (API Object) 526 +ErrorEstimate3DPlot (API Object) 3114 +ErrorEstimateData (API Object) 3119 +ErrorEstimation (API Object) 533 +ErrorEstimationCollection (API Collection) 2384 +ExcitationData (API Object) 3124 +ExcitationMathScript (API Object) 3127 +ExcitationSmithTrace (API Object) 3139 +ExcitationStoredData (API Object) 3144 +ExcitationTrace (API Object) 3148 +Exporter (API Object) 536 +Face (API Object) 613 +FaceCollection (API Collection) 2389 +FarField (API Object) 618 +FarField3DPlot (API Object) 3168 +FarFieldCollection (API Collection) 2393 +FarFieldData (API Object) 630, 3176 +FarFieldMathScript (API Object) 3181 +FarFieldOptimisationGoal (API Object) 640 +FarFieldPowerIntegralData (API Object) 3184 +FarFieldPowerIntegralStoredData (API Object) 3187 +FarFieldPowerIntegralTrace (API Object) 3191 +FarFieldReceivingAntenna (API Object) 649 +FarFieldReceivingAntennaCollection (API Collection) 2399 +FarFieldReceivingAntennaData (API Object) 3199 +FarFieldSource (API Object) 655 +FarFieldStoredData (API Object) 3202 +FarFieldSurfacePlot (API Object) 3206 +FarFieldTrace (API Object) 3213 +FDTDBoundaryConditions (API Object) 543 +FEMLineMeshPort (API Object) 576 +FEMLinePort (API Object) 584 +FEMModalMeshPort (API Object) 592 +FEMModalPort (API Object) 598 +FEMModalSource (API Object) 603 +FieldData (API Object) 665 +FieldDataCollection (API Collection) 2404 +FillHoleSettings (API Object) 674 +Find (API Object) 677 +FittedSpline (API Object) 681 +Flare (API Object) 691 +FormCheckBox (API Object) 707, 3229 +FormProgressDialog (API Object) 779, 3317 +FormPushButton (API Object) 785, 3323 +FreeSpace (API Object) 814 +Frequency (API Object) 819 +GeneralNetwork (API Object) 850 +Geometry (API Object) 868 +GeometryCollection (API Collection) 2432 +GeometryExporter (API Object) 876 +GeometryGroup (API Collection) 2475 +GeometryGroupCollection (API Collection) 2481 +GeometryImporter (API Object) 881 +GeometryRebuild (API Object) 884 +GeometryRepair (API Object) 887 +GlobalMeshSettings (API Object) 896 +GraphAnnotation (API Object) 3364 +Ground (API Object) 912 +GroundPlane (API Object) 916 +GroundPlaneMedium (API Object) 921 +Helix (API Object) 927 +Hexagon (API Object) 936 +HexagonShape (API Object) 942 +HyperbolicArc (API Object) 956 +ImpedanceOptimisationGoal (API Object) 964 +ImpedanceSheet (API Object) 969 +ImpedanceSheetCollection (API Collection) 2485 +ImplicitPointsAnnotation (API Object) 3381 +Importer (API Object) 972 +ImportSet (API Object) 3385 +ImpressedCurrent (API Object) 977 +ImprintPoints (API Object) 984 +Inductor (API Object) 992 +Intersect (API Object) 1001 +KBL (API Object) 1017 +Launcher (API Object) 1026 +LaunchResult (API Object) 1020 +LayeredAnisotropicDielectric (API Object) 1030 +LayeredDielectric (API Object) 1033 +LayeredDielectricCollection (API Collection) 2490 +LayeredIsotropicDielectric (API Object) 1036 +LibraryMedium (API Object) 1039 +Line (API Object) 1044 +LinearPlanarArray (API Object) 1051 +Load (API Object) 1059 +LoadCable (API Object) 3410 +LoadCoaxial (API Object) 3414 +LoadCollection (API Collection) 2496 +LoadComplex (API Object) 3418 +LoadData (API Object) 3422 +LoadDistributed (API Object) 3424 +LoadEdge (API Object) 3427 +LoadFEM (API Object) 3431 +LoadMathScript (API Object) 3435 +LoadNetwork (API Object) 3438 +LoadParallel (API Object) 3442 +LoadSeries (API Object) 3448 +LoadSmithTrace (API Object) 3456 +LoadStoredData (API Object) 3461 +LoadTrace (API Object) 3466 +LoadVertex (API Object) 3471 +LoadVoxel (API Object) 3475 +LocalMeshSettings (API Object) 1072 +Loft (API Object) 1085 +MagneticDipole (API Object) 1101 +MainWindow (API Object) 1114 +MathScript (API Object) 3478 +MathTrace (API Object) 3483 +MdiSubWindow (API Object) 1121 +Media (API Object) 1127 +MediaLibrary (API Collection) 2501 +Medium (API Object) 1132 +Mesh (API Object) 1138 +MeshCubeRegion (API Object) 3519 +MeshCurvilinearSegmentWire (API Object) 1154, 3524 +MeshCurvilinearTriangleFace (API Object) 1162, 3529 +MeshCurvilinearTriangleFaceCollection (API Collection) 2506 +MeshCurvilinearWire (API Object) 1166 +MeshCylinder (API Object) 1169 +MeshCylinderCollection (API Collection) 2510 +MeshEntity (API Object) 3537 +Mesher (API Object) 1245 +MeshExporter (API Object) 1173 +MeshFind (API Object) 1177 +MeshImporter (API Object) 1182 +MeshInfo (API Object) 1191 +MeshPlate (API Object) 1200 +MeshPlateCollection (API Collection) 2514 +MeshRefinementRule (API Object) 1205 +MeshRefinementRuleCollection (API Collection) 2518 +MeshRegion (API Object) 1210 +MeshSegmentCurvilinearWireCollection (API Collection) 2522 +MeshSegmentWire (API Object) 1217, 3551 +MeshSegmentWireCollection (API Collection) 2526 +MeshSettings (API Object) 1224 +MeshSettingsCollection (API Collection) 2530 +MeshTetrahedronRegion (API Object) 1229, 3559 +MeshTetrahedronRegionCollection (API Collection) 2534 +MeshTriangleFace (API Object) 1235, 3562 +MeshTriangleFaceCollection (API Collection) 2538 +MeshUnmeshedCylinderRegion (API Object) 3567 +MeshUnmeshedPolygonFace (API Object) 3568 +MeshWire (API Object) 1242 +MessageWindow (API Object) 1249 +Metal (API Object) 1254 +MetalCollection (API Collection) 2542 +MicrostripMeshPort (API Object) 1263 +MicrostripPort (API Object) 1267 +Mirror (API Object) 1272 +ModalExcitationStoredData (API Object) 3575 +Model (API Object) 1279, 3578 +ModelAttributes (API Object) 1283 +ModelContents (API Object) 1286 +ModelDecompositionCollection (API Collection) 2546 +ModelDefinitions (API Object) 1290 +ModelMeshInfo (API Object) 1297 +ModelSymmetry (API Object) 1304 +NamedPoint (API Object) 1307 +NamedPointCollection (API Collection) 2550 +NearField (API Object) 1316 +NearField3DPlot (API Object) 3586 +NearFieldCollection (API Collection) 2555 +NearFieldData (API Object) 3592 +NearFieldDataFileStructure (API Object) 1333 +NearFieldDataFullImport (API Object) 1341 +NearFieldMathScript (API Object) 3597 +NearFieldOptimisationGoal (API Object) 1351 +NearFieldPowerIntegralData (API Object) 3600 +NearFieldPowerIntegralStoredData (API Object) 3601 +NearFieldPowerIntegralTrace (API Object) 3606 +NearFieldReceivingAntenna (API Object) 1357 +NearFieldReceivingAntennaCollection (API Collection) 2564 +NearFieldReceivingAntennaData (API Object) 3616 +NearFieldSource (API Object) 1363 +NearFieldStoredData (API Object) 3619 +NearFieldSurfacePlot (API Object) 3624 +NearFieldTrace (API Object) 3631 +Net (API Object) 1368 +NetCollection (API Collection) 2568 +Network (API Object) 1372 +NetworkCollection (API Collection) 2573 +NetworkData (API Object) 3638 +NetworkMathScript (API Object) 3641 +NetworkStoredData (API Object) 3644 +NetworkTrace (API Object) 3649 +NumericalGreensFunction (API Object) 1378 +NurbsSurface (API Object) 1388 +Object (API Object) 1427 +OpenRing (API Object) 1436 +OpenRingShape (API Object) 1443 +OperatorCollection (API Collection) 2579 +Optimisation (API Object) 1447 +OptimisationCombination (API Object) 1450 +OptimisationGoal (API Object) 1457 +OptimisationGoalCollection (API Collection) 2584 +OptimisationGoalObjective (API Object) 1461 +OptimisationMask (API Object) 1469 +OptimisationMaskCollection (API Collection) 2590 +OptimisationOperator (API Object) 1476 +OptimisationParameters (API Object) 1479 +OptimisationSearch (API Object) 1483 +OptimisationSearchAdvancedSettings (API Object) 1486 +OptimisationSearchCollection (API Collection) 2594 +ParabolicArc (API Object) 1526 +Paraboloid (API Object) 1535 +PathSweep (API Object) 1561 +PCB (API Object) 1501 +PCBCurrentData (API Object) 1505 +PCBSource (API Object) 1511 +PerfectElectricConductor (API Object) 1568 +PerfectMagneticConductor (API Object) 1571 +PeriodicBoundary (API Object) 1576 +PlaneShape (API Object) 1594 +PlaneWave (API Object) 1598 +PointRefinement (API Object) 1620 +Polygon (API Object) 1632 +Polyline (API Object) 1640 +PolylineRefinement (API Object) 1648 +Port (API Object) 1653 +PortCollection (API Collection) 2600 +Power (API Object) 1661 +PowerData (API Object) 3687 +PowerMathScript (API Object) 3692 +PowerOptimisationGoal (API Object) 1666 +PowerStoredData (API Object) 3697 +PowerTrace (API Object) 3702 +Primitive (API Object) 1674 +ProjectGeometry (API Object) 1683 +ProtectedModel (API Object) 1690 +ProtectedModels (API Collection) 2613 +Ray3DPlot (API Object) 3713 +RayData (API Object) 3717 +ReceivingAntennaData (API Object) 3725 +ReceivingAntennaOptimisationGoal (API Object) 1713 +ReceivingAntennaTrace (API Object) 3731 +Rectangle (API Object) 1718 +Region (API Object) 1730 +RegionCollection (API Collection) 2618 +RemoveSmallFeaturesSettings (API Object) 1735 +RepairAndSewFaces (API Object) 1742 +RepairAndSewFacesSettings (API Object) 1748 +RepairEdgesSettings (API Object) 1751 +RepairPart (API Object) 1756 +RepairPartsSettings (API Object) 1763 +ReportTemplate (API Object) 3739 +Resistor (API Object) 1768 +Result3DPlot (API Object) 3748 +ResultData (API Object) 3757 +ResultPlot (API Object) 3759 +ResultSurfacePlot (API Object) 3764 +ResultTrace (API Object) 3776 +Ring (API Object) 1775 +RingShape (API Object) 1782 +Rotate (API Object) 1786 +SAR (API Object) 1791 +SAR3DPlot (API Object) 3780 +SARCollection (API Collection) 2622 +SARData (API Object) 3783 +SAROptimisationGoal (API Object) 1796 +SARStoredData (API Object) 3787 +SARTrace (API Object) 3791 +Scale (API Object) 1811 +Schematic (API Object) 1816 +SchematicViewWindow (API Object) 1820 +Shape (API Object) 1828 +ShapeCollection (API Collection) 2627 +SimpleAnnotation (API Object) 3825 +Simplify (API Object) 1843 +SimplifyPartRepresentationSettings (API Object) 1859 +SimulationMeshInfo (API Object) 1873 +SolutionCoefficientData (API Object) 1880 +SolutionCoefficientSource (API Object) 1886 +SolutionConfiguration (API Object) 1891, 3844 +SolutionConfigurationCollection (API Collection) 2641 +SolutionSettings (API Object) 1894 +SolverSettings (API Object) 1899 +Source (API Object) 1902 +SourceAperture (API Object) 3849 +SourceCoaxial (API Object) 3852 +SourceCollection (API Collection) 2648 +SourceCurrentRegion (API Object) 3857 +SourceCurrentSpace (API Object) 3862 +SourceCurrentTriangle (API Object) 3865 +SourceElectricDipole (API Object) 3868 +SourceMagneticDipole (API Object) 3871 +SourceMagneticFrill (API Object) 3874 +SourceModal (API Object) 3879 +SourcePCB (API Object) 3884 +SourcePlaneWave (API Object) 3887 +SourceRadiationPattern (API Object) 3890 +SourceSolutionCoefficient (API Object) 3893 +SourceSphericalModes (API Object) 3896 +SourceVoltageCable (API Object) 3899 +SourceVoltageEdge (API Object) 3904 +SourceVoltageNetwork (API Object) 3909 +SourceVoltageSegment (API Object) 3914 +SourceVoltageVertex (API Object) 3919 +SourceWaveguide (API Object) 3924 +SParameter (API Object) 1799 +SParameterConfiguration (API Object) 1803 +SParameterData (API Object) 3798 +SParameterMathScript (API Object) 3802 +SParameterOptimisationGoal (API Object) 1808 +SParameterStoredData (API Object) 3807 +SParameterSurfacePlot (API Object) 3812 +SParameterTrace (API Object) 3819 +Sphere (API Object) 1910 +SphericalModeDataFromFile (API Object) 1921 +SphericalModeDataManuallySpecified (API Object) 1926 +SphericalModeReceivingAntenna (API Object) 1937 +SphericalModeReceivingAntennaCollection (API Collection) 2658 +SphericalModeSource (API Object) 1944 +SphericalModesReceivingAntennaData (API Object) 3929 +SpiceProbeData (API Object) 3932 +SpiceProbeStoredData (API Object) 3935 +SpiceProbeTrace (API Object) 3939 +Spin (API Object) 1960 +SpiralCross (API Object) 1969 +SpiralCrossShape (API Object) 1976 +Split (API Object) 1982 +SplitRing (API Object) 1991 +SplitRingShape (API Object) 1998 +StandardConfiguration (API Object) 2003 +Stitch (API Object) 2009 +StripCross (API Object) 2018 +StripCrossShape (API Object) 2025 +StripHexagon (API Object) 2030 +StripHexagonShape (API Object) 2037 +Subtract (API Object) 2042 +SurfaceBezierCurve (API Object) 2050 +SurfaceCurrents3DPlot (API Object) 3945 +SurfaceCurrentsAndChargesStoredData (API Object) 3949 +SurfaceCurrentsData (API Object) 3952 +SurfaceCurrentsMathScript (API Object) 3956 +SurfaceLine (API Object) 2067 +SurfaceRegularLines (API Object) 2076 +Sweep (API Object) 2086 +TCross (API Object) 2095 +TCrossShape (API Object) 2102 +Terminal (API Object) 2105 +TerminalCollection (API Collection) 2662 +TopologyEntity (API Object) 2109 +TopologyEntityCollectionOf_Edge (API Collection) 2666 +Transform (API Object) 2112 +TransformCollection (API Collection) 2672 +Transformer (API Object) 2118 +Translate (API Object) 2122 +TransmissionLine (API Object) 2128 +TransmissionLineData (API Object) 4028 +TransmissionReflection (API Object) 2133 +TransmissionReflectionCollection (API Collection) 2678 +TransmissionReflectionOptimisationGoal (API Object) 2137 +TRCoefficientData (API Object) 3993 +TRCoefficientMathScript (API Object) 3997 +TRCoefficientStoredData (API Object) 4000 +TRCoefficientTrace (API Object) 4005 +Trifilar (API Object) 2142 +TrifilarShape (API Object) 2149 +Union (API Object) 2160 +UnitCell (API Object) 2168 +UnitCellCollection (API Collection) 2682 +UnprotectedInformation (API Object) 2176 +Variable (API Object) 2180 +VariableCollection (API Collection) 2686 +Version (API Object) 2186 +ViewXt (API Object) 2201 +ViewXtWindow (API Object) 2204 +VoltageControlledVoltageSource (API Object) 2209 +VoltageSource (API Object) 2213 +VoxelSettings (API Object) 2228 +WaveguideExcitationStoredData (API Object) 4063 +WaveguideMeshPort (API Object) 2232 +WaveguidePort (API Object) 2242 +WaveguideSource (API Object) 2246 +WidthAnnotation (API Object) 4067 +Windscreen (API Object) 2250 +WindscreenCollection (API Collection) 2691 +WireCollection (API Collection) 2696 +WireCurrents3DPlot (API Object) 4077 +WireCurrentsAndChargesStoredData (API Object) 4081 +WireCurrentsData (API Object) 4084 +WireCurrentsMathScript (API Object) 4087 +WireCurrentsTrace (API Object) 4095 +WireMeshPort (API Object) 2259 +WirePort (API Object) 2264 +Workplane (API Object) 2272 +WorkplaneCollection (API Collection) 2705 +WorkSurface (API Object) 2268 +WorkSurfaceCollection (API Collection) 2700 +Zero (API Object) 2279 +LabelItem (API Method) +FormComboBox (API Object) 713, 3235 +FormDirectoryBrowser (API Object) 718, 3251 +FormDoubleSpinBox (API Object) 724, 3257 +FormFileBrowser (API Object) 730, 3263 +FormFileSaveAsBrowser (API Object) 736, 3269 +FormIntegerSpinBox (API Object) 753, 3286 +FormLabelledItem (API Object) 766, 3299 +FormLineEdit (API Object) 777, 3310 +Labels (API Property) +AngularGraphAxis (API Object) 2926 +HorizontalGraphAxis (API Object) 3375 +HorizontalSurfaceGraphAxis (API Object) 3377 +RadialGraphAxis (API Object) 3711 +VerticalGraphAxis (API Object) 4033 +VerticalSurfaceGraphAxis (API Object) 4035 +language +Lua 14 +Launcher (API Object) 1023, 3400 +Launcher (API Property) +Application (API Object) 144 +Model (API Object) 3578 +LaunchResult (API Object) 1019, 3397 +LayerDefinition (API Property) +Windscreen (API Object) 2250 +LayeredAnisotropicDielectric (API Object) 1029 +LayeredDielectric (API Collection) +Media (API Object) 1128 +LayeredDielectric (API Object) 1032 +LayeredDielectricCollection (API Collection) 2489 +LayeredIsotropicDielectric (API Object) 1035 +Layers (API Property) +GroundPlane (API Object) 916 +LayeredAnisotropicDielectric (API Object) 1030 +LayeredIsotropicDielectric (API Object) 1036 +UnitCell (API Object) 2168 +LayerSelection (API Property) +SAR (API Object) 1792 +LeftHandRotationEnabled (API Property) +Helix (API Object) 927 +LeftVariable (API Property) +OptimisationConstraint (API Object) 1453 +Legend (API Property) +CartesianGraph (API Object) 2956 +CartesianSurfaceGraph (API Object) 2969 +CharacteristicModeTrace (API Object) 2989 +CustomData3DPlot (API Object) 3051 +CustomDataSmithTrace (API Object) 3060 +CustomDataSurfacePlot (API Object) 3066 +CustomDataTrace (API Object) 3073 +ErrorEstimate3DPlot (API Object) 3115 +ExcitationSmithTrace (API Object) 3139 +ExcitationTrace (API Object) 3148 +FarField3DPlot (API Object) 3168 +FarFieldPowerIntegralTrace (API Object) 3191 +FarFieldSurfacePlot (API Object) 3207 +FarFieldTrace (API Object) 3213 +Graph (API Object) 3356 +LoadSmithTrace (API Object) 3456 +LoadTrace (API Object) 3466 +MathTrace (API Object) 3483 +MeshRendering (API Object) 3547 +NearField3DPlot (API Object) 3586 +NearFieldPowerIntegralTrace (API Object) 3606 +NearFieldSurfacePlot (API Object) 3624 +NearFieldTrace (API Object) 3631 +NetworkTrace (API Object) 3649 +PolarGraph (API Object) 3675 +PowerTrace (API Object) 3702 +Ray3DPlot (API Object) 3713 +ReceivingAntennaTrace (API Object) 3731 +Result3DPlot (API Object) 3748 +ResultSurfacePlot (API Object) 3764 +ResultTrace (API Object) 3776 +SAR3DPlot (API Object) 3780 +SARTrace (API Object) 3792 +SmithChart (API Object) 3833 +SParameterSurfacePlot (API Object) 3812 +SParameterTrace (API Object) 3819 +SpiceProbeTrace (API Object) 3939 +SurfaceCurrents3DPlot (API Object) 3945 +SurfaceGraph (API Object) 3962 +TRCoefficientTrace (API Object) 4005 +View (API Object) 4039 +WireCurrents3DPlot (API Object) 4077 +WireCurrentsTrace (API Object) 4095 +Legend3DLinearRangeFormat (API Object) 3405 +Legend3DLogarithmicRangeFormat (API Object) 3407 +LegendEntryVisible (API Property) +TraceLegendFormat (API Object) 4017 +length +Lua 15 +Length (API Property) +Edge (API Object) 491 +MeshCurvilinearSegmentWire (API Object) 1154 +MeshSegmentWire (API Object) 1217 +Trifilar (API Object) 2143 +TrifilarShape (API Object) 2149 +View3DAxesFormat (API Object) 4048 +LengthDetermined (API Property) +TransmissionLine (API Object) 2128 +LessThan (API StaticFunction) +ComplexMatrix (API Object) 3027, 3027, 3028, 3028 +Matrix (API Object) 3503, 3503 +LessThanOrEqual (API StaticFunction) +ComplexMatrix (API Object) 3028, 3028, 3029, 3029 +Matrix (API Object) 3503, 3503 +LevelOfFill (API Property) +IterativeSolverSettings (API Object) 1012 +library +add script 53 +application macro 52, 53, 53, 53 +run script 53 +LibraryMedium (API Object) 1038 +LimitEnabled (API Property) +Variable (API Object) 2180 +Line (API Object) 1041 +Line (API Property) +CharacteristicModeTrace (API Object) 2989 +CustomDataSmithTrace (API Object) 3060 +CustomDataTrace (API Object) 3073 +ExcitationSmithTrace (API Object) 3139 +ExcitationTrace (API Object) 3148 +FarFieldPowerIntegralTrace (API Object) 3191 +FarFieldTrace (API Object) 3213 +FrameFormat (API Object) 3351 +LoadSmithTrace (API Object) 3456 +LoadTrace (API Object) 3466 +MathTrace (API Object) 3483 +NearFieldPowerIntegralTrace (API Object) 3606 +NearFieldTrace (API Object) 3631 +NetworkTrace (API Object) 3649 +PowerTrace (API Object) 3702 +ReceivingAntennaTrace (API Object) 3731 +ResultTrace (API Object) 3776 +SARTrace (API Object) 3792 +SParameterTrace (API Object) 3819 +SpiceProbeTrace (API Object) 3939 +SurfaceGraphFrameFormat (API Object) 3976 +TRCoefficientTrace (API Object) 4005 +WireCurrentsTrace (API Object) 4095 +LinearPlanarArray (API Object) 1049 +LinearRange (API Property) +Plot3DLegendFormat (API Object) 3661 +SurfacePlotLegendFormat (API Object) 3984 +LinearTolerance (API Property) +RepairEdgesSettings (API Object) 1751 +LineColour (API Property) +ResultArrow (API Object) 3750 +ResultTextBox (API Object) 3769 +LineLength (API Property) +TransmissionLine (API Object) 2129 +LineStyle (API Property) +ResultArrow (API Object) 3751 +ResultTextBox (API Object) 3769 +LinesVisible (API Property) +MeshSegmentsFormat (API Object) 3554 +Rays3DFormat (API Object) 3719 +LineWeight (API Property) +ResultArrow (API Object) 3751 +ResultTextBox (API Object) 3769 +LineWidth (API Property) +PolderTensor (API Object) 1626 +List (API Property) +FEKOGPUOptions (API Object) 554, 3152 +Load (API Method) +Application (API Object) 146 +Load (API Object) 1056 +LoadCable (API Object) 3409 +LoadCoaxial (API Object) 3413 +LoadCollection (API Collection) 2494, 4153 +LoadComplex (API Object) 3417 +LoadData (API Object) 3421 +LoadDistributed (API Object) 3424 +LoadEdge (API Object) 3426 +LoadExpression (API Property) +ExcitationQuantity (API Object) 3130 +ExcitationSmithQuantity (API Object) 3134 +LoadSmithQuantity (API Object) 3451 +LoadFEM (API Object) 3430 +LoadMathScript (API Object) 3434 +LoadNetwork (API Object) 3437 +LoadParallel (API Object) 3441 +LoadQuantity (API Object) 3445 +Loads (API Collection) +CharacteristicModesConfiguration (API Object) 307 +SolutionConfiguration (API Object) 1891, 3845 +SParameterConfiguration (API Object) 1804 +StandardConfiguration (API Object) 2004 +LoadSeries (API Object) 3447 +LoadSmithQuantity (API Object) 3451 +LoadSmithTrace (API Object) 3453 +LoadsRestored (API Property) +SParameter (API Object) 1799 +LoadStoredData (API Object) 3460 +LoadSubtractionEnabled (API Property) +ExcitationQuantity (API Object) 3130 +ExcitationSmithQuantity (API Object) 3134 +LoadSmithQuantity (API Object) 3452 +LoadSubtractionType (API Property) +ExcitationQuantity (API Object) 3130 +ExcitationSmithQuantity (API Object) 3134 +LoadsVisible (API Property) +View3DSolutionEntityFormat (API Object) 4057 +LoadTrace (API Object) 3463 +LoadType (API Property) +Load (API Object) 1059 +LoadVertex (API Object) 3470 +LoadVoxel (API Object) 3474 +LocalCoordAxes (API Property) +FarField3DPlot (API Object) 3168 +NearField3DPlot (API Object) 3586 +LocalCoordinate (API Object) 1062 +LocalCoordinateList (API Object) 1065 +LocalDefinedWorkplane (API Property) +LocalWorkplane (API Object) 1078 +LocalInternalCoordinate (API Object) 1067 +LocalInternalCoordinateList (API Object) 1069 +LocalIntrinsicWireRadiusEnabled (API Property) +Edge (API Object) 492 +MeshCurvilinearSegmentWire (API Object) 1154 +MeshSegmentWire (API Object) 1217 +LocalMeshSettings (API Object) 1071 +LocalMeshSettingsEnabled (API Property) +AbstractSurfaceCurve (API Object) 98 +AnalyticalCurve (API Object) 121 +BezierCurve (API Object) 163 +Cone (API Object) 353 +ConstrainedSurface (API Object) 366 +Cross (API Object) 380 +Cuboid (API Object) 392 +Cylinder (API Object) 424 +Ellipse (API Object) 514 +EllipticArc (API Object) 526 +FittedSpline (API Object) 681 +Flare (API Object) 691 +Geometry (API Object) 868 +Helix (API Object) 927 +Hexagon (API Object) 936 +HyperbolicArc (API Object) 956 +ImprintPoints (API Object) 984 +Intersect (API Object) 1002 +Line (API Object) 1044 +Loft (API Object) 1085 +Mesh (API Object) 1138 +NurbsSurface (API Object) 1389 +OpenRing (API Object) 1436 +ParabolicArc (API Object) 1527 +Paraboloid (API Object) 1535 +PathSweep (API Object) 1561 +Polygon (API Object) 1633 +Polyline (API Object) 1641 +Primitive (API Object) 1674 +ProjectGeometry (API Object) 1683 +Rectangle (API Object) 1718 +RepairAndSewFaces (API Object) 1742 +RepairPart (API Object) 1756 +Ring (API Object) 1775 +Simplify (API Object) 1843 +Sphere (API Object) 1910 +Spin (API Object) 1960 +SpiralCross (API Object) 1969 +Split (API Object) 1982 +SplitRing (API Object) 1991 +Stitch (API Object) 2009 +StripCross (API Object) 2018 +StripHexagon (API Object) 2031 +Subtract (API Object) 2042 +SurfaceBezierCurve (API Object) 2050 +SurfaceLine (API Object) 2067 +SurfaceRegularLines (API Object) 2076 +Sweep (API Object) 2086 +TCross (API Object) 2095 +Trifilar (API Object) 2143 +Union (API Object) 2161 +LocalMeshSize (API Property) +Edge (API Object) 492 +Face (API Object) 613 +MeshCurvilinearSegmentWire (API Object) 1154 +MeshCurvilinearTriangleFace (API Object) 1162 +MeshPlate (API Object) 1201 +MeshSegmentWire (API Object) 1217 +MeshTetrahedronRegion (API Object) 1229 +MeshTriangleFace (API Object) 1236 +Region (API Object) 1731 +LocalMeshSizeEnabled (API Property) +Edge (API Object) 492 +Face (API Object) 613 +MeshCurvilinearSegmentWire (API Object) 1155 +MeshCurvilinearTriangleFace (API Object) 1162 +MeshPlate (API Object) 1201 +MeshSegmentWire (API Object) 1217 +MeshTetrahedronRegion (API Object) 1229 +MeshTriangleFace (API Object) 1236 +Region (API Object) 1731 +LocalWireRadius (API Property) +Edge (API Object) 492 +MeshCurvilinearSegmentWire (API Object) 1155 +MeshSegmentWire (API Object) 1218 +LocalWireRadiusEnabled (API Property) +Edge (API Object) 492 +MeshCurvilinearSegmentWire (API Object) 1155 +MeshSegmentWire (API Object) 1218 +LocalWorkplane (API Object) 1075 +LocalWorkplane (API Property) +AbstractAntennaArray (API Object) 63 +AbstractFEMLinePort (API Object) 69 +AbstractIdealSource (API Object) 74 +AbstractPointSource (API Object) 91 +AbstractSurfaceCurve (API Object) 98 +AdaptiveRefinement (API Object) 105 +Align (API Object) 114 +AnalyticalCurve (API Object) 122 +BaseFieldReceivingAntenna (API Object) 150 +BezierCurve (API Object) 164 +CablePath (API Object) 229 +Cone (API Object) 353 +ConstrainedSurface (API Object) 366 +Cross (API Object) 380 +Cuboid (API Object) 392 +CustomAntennaArray (API Object) 411 +Cutplane (API Object) 417 +Cylinder (API Object) 424 +CylindricalAntennaArray (API Object) 433 +ElectricDipole (API Object) 507 +Ellipse (API Object) 514 +EllipticArc (API Object) 526 +FarField (API Object) 619 +FarFieldData (API Object) 630 +FarFieldReceivingAntenna (API Object) 649 +FarFieldSource (API Object) 655 +FEMLineMeshPort (API Object) 577 +FEMLinePort (API Object) 585 +FEMModalMeshPort (API Object) 592 +FEMModalPort (API Object) 599 +FieldData (API Object) 666 +FittedSpline (API Object) 682 +Flare (API Object) 692 +Geometry (API Object) 868 +GeometryGroup (API Collection) 2475 +Helix (API Object) 927 +Hexagon (API Object) 936 +HyperbolicArc (API Object) 957 +ImpressedCurrent (API Object) 977 +ImprintPoints (API Object) 984 +Intersect (API Object) 1002 +Line (API Object) 1044 +LinearPlanarArray (API Object) 1052 +Loft (API Object) 1085 +MagneticDipole (API Object) 1101 +Mesh (API Object) 1138 +MeshRefinementRule (API Object) 1206 +Mirror (API Object) 1273 +NamedPoint (API Object) 1308 +NearField (API Object) 1316 +NearFieldDataFileStructure (API Object) 1333 +NearFieldDataFullImport (API Object) 1341 +NearFieldReceivingAntenna (API Object) 1357 +NearFieldSource (API Object) 1363 +NurbsSurface (API Object) 1389 +OpenRing (API Object) 1436 +ParabolicArc (API Object) 1527 +Paraboloid (API Object) 1535 +PathSweep (API Object) 1562 +PCBCurrentData (API Object) 1505 +PCBSource (API Object) 1511 +PeriodicBoundary (API Object) 1576 +PlaneWave (API Object) 1598 +PointRefinement (API Object) 1621 +Polygon (API Object) 1633 +Polyline (API Object) 1641 +PolylineRefinement (API Object) 1648 +Primitive (API Object) 1674 +ProjectGeometry (API Object) 1683 +ProtectedModel (API Object) 1690 +Rectangle (API Object) 1718 +RepairAndSewFaces (API Object) 1742 +RepairPart (API Object) 1756 +Ring (API Object) 1775 +Rotate (API Object) 1786 +Scale (API Object) 1812 +Simplify (API Object) 1843 +SolutionCoefficientData (API Object) 1881 +SolutionCoefficientSource (API Object) 1886 +Sphere (API Object) 1910 +SphericalModeDataFromFile (API Object) 1922 +SphericalModeDataManuallySpecified (API Object) 1926 +SphericalModeReceivingAntenna (API Object) 1938 +SphericalModeSource (API Object) 1944 +Spin (API Object) 1960 +SpiralCross (API Object) 1969 +Split (API Object) 1982 +SplitRing (API Object) 1991 +Stitch (API Object) 2009 +StripCross (API Object) 2018 +StripHexagon (API Object) 2031 +Subtract (API Object) 2042 +SurfaceBezierCurve (API Object) 2050 +SurfaceLine (API Object) 2067 +SurfaceRegularLines (API Object) 2076 +Sweep (API Object) 2086 +TCross (API Object) 2095 +Transform (API Object) 2112 +Translate (API Object) 2123 +Trifilar (API Object) 2143 +Union (API Object) 2161 +Workplane (API Object) 2273 +LocalWorkplaneList (API Object) 1080 +Location (API Property) +Terminal (API Object) 2106 +WirePort (API Object) 2264 +LocationType (API Property) +CableProbe (API Object) 242 +LockedAspectRatio (API Property) +CartesianSurfaceGraph (API Object) 2969 +Loft (API Method) +GeometryCollection (API Collection) 2462, 2462, 2463, 2463 +Loft (API Object) 1082 +LoftEdges (API Method) +GeometryCollection (API Collection) 2463, 2464 +LoftFaces (API Method) +GeometryCollection (API Collection) 2464, 2464 +Log (API StaticFunction) +Complex (API Object) 324, 3004 +ComplexMatrix (API Object) 3029 +Matrix (API Object) 3504 +Log10 (API StaticFunction) +Complex (API Object) 324, 3004 +ComplexMatrix (API Object) 3030 +Matrix (API Object) 3504 +LogarithmicRange (API Property) +Plot3DLegendFormat (API Object) 3661 +SurfacePlotLegendFormat (API Object) 3984 +LogError (API Method) +MessageWindow (API Object) 1250 +LogHeading (API Method) +MessageWindow (API Object) 1250 +LogMessage (API Method) +MessageWindow (API Object) 1250 +LogNote (API Method) +MessageWindow (API Object) 1250 +LogProgress (API Method) +FormProgressDialog (API Object) 780, 780, 3318, 3319 +LogScaled (API Property) +HorizontalGraphAxis (API Object) 3376 +RadialGraphAxis (API Object) 3711 +VerticalGraphAxis (API Object) 4033 +LogWarning (API Method) +MessageWindow (API Object) 1250 +LoopedPlaneWaveCompression (API Property) +AdvancedSolverSettings (API Object) 109 +LossTangent (API Property) +DielectricFrequencyPoint (API Object) 469 +DielectricModelling (API Object) 474 +MagneticFrequencyPoint (API Object) 1106 +MagneticModelling (API Object) 1110 +Metal (API Object) 1254 +MetallicFrequencyPoint (API Object) 1258 +PolderTensor (API Object) 1626 +Lower (API Method) +CharacteristicModeTrace (API Object) 2992 +CustomDataSmithTrace (API Object) 3062 +CustomDataTrace (API Object) 3075 +ExcitationSmithTrace (API Object) 3141 +ExcitationTrace (API Object) 3150 +FarFieldPowerIntegralTrace (API Object) 3193 +FarFieldTrace (API Object) 3215 +LoadSmithTrace (API Object) 3458 +LoadTrace (API Object) 3468 +MathTrace (API Object) 3484 +NearFieldPowerIntegralTrace (API Object) 3609 +NearFieldTrace (API Object) 3634 +NetworkTrace (API Object) 3651 +PowerTrace (API Object) 3704 +ReceivingAntennaTrace (API Object) 3733 +ResultArrow (API Object) 3752 +ResultTextBox (API Object) 3771 +ResultTrace (API Object) 3778 +SARTrace (API Object) 3794 +SParameterTrace (API Object) 3821 +SpiceProbeTrace (API Object) 3941 +TRCoefficientTrace (API Object) 4007 +WireCurrentsTrace (API Object) 4098 +LowFrequencyStabilisationEnabled (API Property) +GeneralSolverSettings (API Object) 856 +LowFrequencyStabilisationMode (API Property) +GeneralSolverSettings (API Object) 856 +Lua +boolean 15 +comment 14 +concatenate 15 +dictionary 15 +example 24 +FOR loop 17 +function 17, 24 +IF statement 16 +language 14 +length 15 +method 24 +module 10 +namespace 24 +REPEAT loop 16 +static function 24 +string 15 +table 15 +variable assignment 14 +WHILE loop 16 +Lua modulesdefault 18, 19 +Luaeditor 11 +Luamodules 22 +LUDecomposedMatrix (API Property) +OutputFileSolverSettings (API Object) 1494 +macro recording 13 +MagneticDipole (API Object) 1099 +MagneticFrequencyPoint (API Object) 1105 +MagneticFrequencyPointList (API Object) 1107 +MagneticModelling (API Object) 1109 +MagneticModelling (API Property) +Dielectric (API Object) 463 +DielectricBoundaryMedium (API Object) 466 +FreeSpace (API Object) 815 +GroundPlaneMedium (API Object) 921 +Zero (API Object) 2279 +MagneticModellingList (API Object) 1111 +Magnitude (API Method) +Complex (API Object) 318, 2999 +ComplexMatrix (API Object) 3019 +Matrix (API Object) 3496 +Magnitude (API Property) +AbstractPointSource (API Object) 92 +CableCoaxialCrossSection (API Object) 198 +CurrentSource (API Object) 399 +ElectricDipole (API Object) 507 +FarFieldSource (API Object) 655 +FEMModalSource (API Object) 603 +FundamentalModeOptions (API Object) 844 +MagneticDipole (API Object) 1101 +NearFieldSource (API Object) 1363 +PCBSource (API Object) 1511 +PlaneWave (API Object) 1599 +SolutionCoefficientSource (API Object) 1886 +SphericalModeSource (API Object) 1944 +VoltageSource (API Object) 2213 +WaveguideModeOptions (API Object) 2236 +WaveguideSource (API Object) 2247 +Magnitude (API StaticFunction) +Complex (API Object) 324, 324, 3005, 3005 +ComplexMatrix (API Object) 3030 +Matrix (API Object) 3504 +MagnitudeScaling (API Property) +AntennaArraySource (API Object) 140 +CustomAntennaArray (API Object) 411 +MainVisible (API Property) +View3DAxesFormat (API Object) 2188, 4048 +MainWindow (API Object) 1113 +MainWindow (API Property) +Application (API Object) 145 +Major (API Property) +CartesianGraphGrid (API Object) 2963 +CartesianSurfaceGraphGrid (API Object) 2974 +PolarGraphGrid (API Object) 3682 +Version (API Object) 2186, 4030 +MajorAxisDirection (API Property) +EllipticArc (API Object) 527 +MajorGrid (API Property) +AngularGraphAxis (API Object) 2926 +HorizontalGraphAxis (API Object) 3376 +HorizontalSurfaceGraphAxis (API Object) 3377 +RadialGraphAxis (API Object) 3711 +VerticalGraphAxis (API Object) 4033 +VerticalSurfaceGraphAxis (API Object) 4035 +ManuallySetReferenceVector (API Property) +CablePath (API Object) 229 +ManuallySpecifiedBoxSize (API Property) +MLFMMSolverSettings (API Object) 1096 +ManuallySpecifiedExpression (API Property) +ManuallySpecifiedOrDerivedValue (API Object) 1117 +ManuallySpecifiedModesProperties (API Property) +WaveguideSource (API Object) 2247 +ManuallySpecifiedOrDerivedValue (API Object) 1116 +ManuallySpecifiedOrDerivedValueList (API Object) 1118 +ManualReferenceVector (API Property) +WaveguideMeshPort (API Object) 2232 +WaveguidePort (API Object) 2242 +ManualReferenceVectorEnabled (API Property) +WaveguidePort (API Object) 2242 +ManualSource (API Property) +CableSpiceNetwork (API Object) 271 +Markers (API Property) +CharacteristicModeTrace (API Object) 2989 +CustomDataSmithTrace (API Object) 3060 +CustomDataTrace (API Object) 3073 +ExcitationSmithTrace (API Object) 3139 +ExcitationTrace (API Object) 3149 +FarFieldPowerIntegralTrace (API Object) 3191 +FarFieldTrace (API Object) 3213 +LoadSmithTrace (API Object) 3456 +LoadTrace (API Object) 3466 +MathTrace (API Object) 3483 +NearFieldPowerIntegralTrace (API Object) 3606 +NearFieldTrace (API Object) 3631 +NetworkTrace (API Object) 3649 +PowerTrace (API Object) 3702 +ReceivingAntennaTrace (API Object) 3732 +ResultTrace (API Object) 3777 +SARTrace (API Object) 3792 +SParameterTrace (API Object) 3819 +SpiceProbeTrace (API Object) 3940 +TRCoefficientTrace (API Object) 4005 +WireCurrentsTrace (API Object) 4095 +MarkerSize (API Property) +RequestPoints3DFormat (API Object) 3745 +Mask (API Property) +OptimisationGoalObjective (API Object) 1461 +Masks (API Collection) +Optimisation (API Object) 1447 +MassDensity (API Property) +AnisotropicDielectric (API Object) 132 +Dielectric (API Object) 463 +FreeSpace (API Object) 815 +GroundPlaneMedium (API Object) 921 +Zero (API Object) 2279 +Math (API Property) +CharacteristicModeTrace (API Object) 2989 +CustomDataTrace (API Object) 3073 +ExcitationTrace (API Object) 3149 +FarFieldPowerIntegralTrace (API Object) 3191 +FarFieldTrace (API Object) 3213 +LoadTrace (API Object) 3466 +NearFieldPowerIntegralTrace (API Object) 3606 +NearFieldTrace (API Object) 3632 +NetworkTrace (API Object) 3649 +PowerTrace (API Object) 3702 +ReceivingAntennaTrace (API Object) 3732 +SARTrace (API Object) 3792 +SParameterTrace (API Object) 3819 +TRCoefficientTrace (API Object) 4005 +WireCurrentsTrace (API Object) 4096 +MathScript (API Object) 3477 +MathScriptCollection (API Collection) 4156 +MathScripts (API Collection) +Application (API Object) 2931 +MathTrace (API Object) 3480 +Matrix 20 +Matrix (API Object) 3486 +MatrixElements (API Property) +OutputFileSolverSettings (API Object) 1494 +MatrixIndexer (API Object) 3512 +Max (API Method) +ComplexMatrix (API Object) 3019 +Matrix (API Object) 3496 +Max (API Property) +AxisRange (API Object) 2941 +SurfaceGraphAxisRange (API Object) 3970 +Max (API StaticFunction) +ComplexMatrix (API Object) 3030, 3030 +Matrix (API Object) 3504, 3505 +MaxAspectRatio (API Property) +VoxelGridSummary (API Object) 2222 +MaxGrowthRate (API Property) +VoxelGridSummary (API Object) 2222 +Maximise (API Method) +CartesianGraph (API Object) 2960 +CartesianSurfaceGraph (API Object) 2972 +Graph (API Object) 3359 +MdiSubWindow (API Object) 1123 +PolarGraph (API Object) 3679 +SmithChart (API Object) 3836 +SurfaceGraph (API Object) 3964 +View (API Object) 4043 +Window (API Object) 4074 +Maximum (API Property) +Variable (API Object) 2180 +MaximumCurvilinearEdgeLength (API Property) +MeshInfo (API Object) 1192 +ModelMeshInfo (API Object) 1298 +SimulationMeshInfo (API Object) 1874 +MaximumCurvilinearSegmentLength (API Property) +MeshInfo (API Object) 1192 +ModelMeshInfo (API Object) 1298 +SimulationMeshInfo (API Object) 1874 +MaximumEdgeLength (API Property) +MeshInfo (API Object) 1192 +ModelMeshInfo (API Object) 1298 +SimulationMeshInfo (API Object) 1874 +MaximumElementAngle (API Property) +MeshInfo (API Object) 1192 +ModelMeshInfo (API Object) 1298 +SimulationMeshInfo (API Object) 1874 +MaximumSegmentLength (API Property) +MeshInfo (API Object) 1192 +ModelMeshInfo (API Object) 1298 +SimulationMeshInfo (API Object) 1874 +MaximumTetrahedronEdgeLength (API Property) +MeshInfo (API Object) 1192 +ModelMeshInfo (API Object) 1298 +SimulationMeshInfo (API Object) 1874 +MaximumTimeInterval (API Property) +FrequencyFDTDSettings (API Object) 840 +MaximumTimeIntervalEnabled (API Property) +FrequencyFDTDSettings (API Object) 841 +MaximumValue (API Property) +OptimisationVariable (API Object) 1490 +MaximumVoxelLength (API Property) +MeshInfo (API Object) 1193 +ModelMeshInfo (API Object) 1299 +SimulationMeshInfo (API Object) 1875 +MaxIterations (API Property) +HighFrequencySettings (API Object) 947 +IterativeSolverSettings (API Object) 1012 +MaxModalExpansionEnabled (API Property) +WaveguideMeshPort (API Object) 2232 +WaveguidePort (API Object) 2242 +MaxModalExpansionIndexM (API Property) +WaveguideMeshPort (API Object) 2232 +WaveguidePort (API Object) 2242 +MaxModalExpansionIndexN (API Property) +WaveguideMeshPort (API Object) 2232 +WaveguidePort (API Object) 2243 +MaxResiduum (API Property) +IterativeSolverSettings (API Object) 1013 +MaxRLGORayInteractions (API Property) +HighFrequencySettings (API Object) 947 +MaxRLGORayInteractionsEnabled (API Property) +HighFrequencySettings (API Object) 947 +MaxSamples (API Property) +FrequencyContinuousSettings (API Object) 831 +MaxSamplesEnabled (API Property) +FrequencyContinuousSettings (API Object) 831 +MaxSeparationDistance (API Property) +CablePath (API Object) 229 +MaxSmallEdgeLength (API Property) +RepairPartsSettings (API Object) 1763 +MaxU (API Property) +WorkSurface (API Object) 2269 +MaxUTDRayInteractions (API Property) +HighFrequencySettings (API Object) 947 +MaxUTDRayInteractionsEnabled (API Property) +HighFrequencySettings (API Object) 947 +MaxV (API Property) +WorkSurface (API Object) 2269 +MdiArea (API Collection) +MainWindow (API Object) 1114 +MdiSubWindow (API Object) 1120 +Mean (API Method) +ComplexMatrix (API Object) 3019 +Matrix (API Object) 3497 +Mean (API StaticFunction) +ComplexMatrix (API Object) 3031 +Matrix (API Object) 3505 +Media (API Object) 1125 +Media (API Property) +ModelDefinitions (API Object) 1291 +MediaLibrary (API Collection) +Application (API Object) 145 +MediaSelection (API Property) +SAR (API Object) 1792 +Medium (API Object) 1130 +Medium (API Property) +CoaxialInsulationLayer (API Object) 310 +Face (API Object) 613 +GroundPlane (API Object) 917 +IsotropicDielectricLayers (API Object) 1007 +LibraryMedium (API Object) 1039 +MeshCurvilinearTriangleFace (API Object) 1162 +MeshPlate (API Object) 1201 +MeshTetrahedronRegion (API Object) 1229 +MeshTriangleFace (API Object) 1236 +PlanarSubstrate (API Object) 1590 +Region (API Object) 1731 +TransmissionLine (API Object) 2129 +UnitCellLayer (API Object) 2171 +WindscreenSolutionMethod (API Object) 2254 +MediumNames (API Property) +DataSetMetaData (API Object) 3107 +MediumType (API Property) +LibraryMedium (API Object) 1039 +MergeEdgesEnabled (API Property) +RepairEdgesSettings (API Object) 1751 +MergeIdenticalMediaEnabled (API Property) +CFXModelImportSettings (API Object) 177 +MergeIdenticalVariablesEnabled (API Property) +CFXModelImportSettings (API Object) 178 +MergeIdenticalWorkplanesEnabled (API Property) +CFXModelImportSettings (API Object) 178 +MergeMultipleSPCurveSegmentsEnabled (API Property) +SimplifyPartRepresentationSettings (API Object) 1859 +Mesh (API Method) +Mesher (API Object) 1246 +Mesh (API Object) 1134, 3513 +Mesh (API Property) +Exporter (API Object) 536 +SolutionConfiguration (API Object) 3844 +MeshAdvancedSettings (API Object) 1145 +MeshAdvancedSettingsList (API Object) 1149 +MeshBackMedium (API Property) +MeshCurvilinearTriangleFace (API Object) 1162 +MeshCube (API Object) 3517 +MeshCubeRegion (API Object) 3518 +MeshCubeRegionCollection (API Collection) 4160 +MeshCubes (API Object) 3520 +MeshCurvilinearSegment (API Object) 3522 +MeshCurvilinearSegments (API Object) 3525 +MeshCurvilinearSegmentWire (API Object) 1151, 3523 +MeshCurvilinearSegmentWireCollection (API Collection) 4163 +MeshCurvilinearTriangle (API Object) 3527 +MeshCurvilinearTriangleFace (API Object) 1158, 3528 +MeshCurvilinearTriangleFaceCollection (API Collection) 2505, 4166 +MeshCurvilinearTriangles (API Object) 3530 +MeshCurvilinearWire (API Object) 1165 +MeshCylinder (API Object) 1168, 3532 +MeshCylinderCollection (API Collection) 2509 +MeshCylinders (API Object) 3533 +MeshEdgesFormat (API Object) 3534 +MeshElementCount (API Property) +MeshInfo (API Object) 1193 +ModelMeshInfo (API Object) 1299 +SimulationMeshInfo (API Object) 1875 +MeshElementSizeCheckingEnabled (API Property) +GeneralSolverSettings (API Object) 856 +MeshEntity (API Object) 3537 +Mesher (API Object) 1244 +Mesher (API Property) +Model (API Object) 1280 +Meshes (API Collection) +ModelContents (API Object) 1287 +MeshExporter (API Object) 1171 +MeshFacesFormat (API Object) 3538 +MeshFind (API Object) 1176 +MeshFrontMedium (API Property) +MeshCurvilinearTriangleFace (API Object) 1162 +MeshImporter (API Object) 1180 +MeshImporter (API Property) +Importer (API Object) 972 +MeshInfo (API Object) 1187 +MeshLegendFormat (API Object) 3541 +MeshMergingMediaEnabled (API Property) +MeshImporter (API Object) 1183 +MeshPlate (API Object) 1197 +MeshPlateCollection (API Collection) 2513 +MeshPolygon (API Object) 3543 +MeshPolygons (API Object) 3544 +MeshRefinementEnabled (API Property) +CablePath (API Object) 229 +MeshRefinementRule (API Object) 1204 +MeshRefinementRuleCollection (API Collection) 2517 +MeshRefinementRules (API Collection) +ModelContents (API Object) 1287 +MeshRegion (API Object) 1209 +MeshRelabelingEnabled (API Property) +MeshImporter (API Object) 1183 +MeshRendering (API Object) 3545 +MeshRendering (API Property) +View (API Object) 4040 +MeshSegment (API Object) 3550 +MeshSegmentCurvilinearWireCollection (API Collection) 2521 +MeshSegmentReference (API Object) 1212 +MeshSegments (API Object) 3553 +MeshSegmentsFormat (API Object) 3554 +MeshSegmentWire (API Object) 1214, 3551 +MeshSegmentWireCollection (API Collection) 2525, 4169 +MeshSettings (API Object) 1221 +MeshSettings (API Property) +AbstractSurfaceCurve (API Object) 99 +AnalyticalCurve (API Object) 122 +BezierCurve (API Object) 164 +Cone (API Object) 353 +ConstrainedSurface (API Object) 366 +Cross (API Object) 380 +Cuboid (API Object) 393 +Cylinder (API Object) 425 +Ellipse (API Object) 514 +EllipticArc (API Object) 527 +FittedSpline (API Object) 682 +Flare (API Object) 692 +Geometry (API Object) 868 +Helix (API Object) 927 +Hexagon (API Object) 936 +HyperbolicArc (API Object) 957 +ImprintPoints (API Object) 984 +Intersect (API Object) 1002 +Line (API Object) 1044 +Loft (API Object) 1085 +Mesh (API Object) 1138 +NurbsSurface (API Object) 1389 +OpenRing (API Object) 1436 +ParabolicArc (API Object) 1527 +Paraboloid (API Object) 1535 +PathSweep (API Object) 1562 +Polygon (API Object) 1633 +Polyline (API Object) 1641 +Primitive (API Object) 1675 +ProjectGeometry (API Object) 1683 +Rectangle (API Object) 1718 +RepairAndSewFaces (API Object) 1742 +RepairPart (API Object) 1756 +Ring (API Object) 1775 +Simplify (API Object) 1844 +Sphere (API Object) 1911 +Spin (API Object) 1960 +SpiralCross (API Object) 1969 +Split (API Object) 1982 +SplitRing (API Object) 1991 +Stitch (API Object) 2009 +StripCross (API Object) 2018 +StripHexagon (API Object) 2031 +Subtract (API Object) 2042 +SurfaceBezierCurve (API Object) 2050 +SurfaceLine (API Object) 2067 +SurfaceRegularLines (API Object) 2077 +Sweep (API Object) 2086 +TCross (API Object) 2095 +Trifilar (API Object) 2143 +Union (API Object) 2161 +MeshSettingsCollection (API Collection) 2529 +MeshSize (API Property) +PointRefinement (API Object) 1621 +PolylineRefinement (API Object) 1648 +MeshSizeOption (API Property) +GlobalMeshSettings (API Object) 897 +LocalMeshSettings (API Object) 1072 +MeshSettings (API Object) 1224 +VoxelSettings (API Object) 2228 +MeshTetrahedra (API Object) 3556 +MeshTetrahedron (API Object) 3558 +MeshTetrahedronRegion (API Object) 1227, 3559 +MeshTetrahedronRegionCollection (API Collection) 2533, 4172 +MeshTriangle (API Object) 3561 +MeshTriangleFace (API Object) 1232, 3562 +MeshTriangleFaceCollection (API Collection) 2537, 4175 +MeshTriangles (API Object) 3564 +MeshUnmeshedCylinderRegion (API Object) 3566 +MeshUnmeshedCylinderRegionCollection (API Collection) 4178 +MeshUnmeshedPolygonFace (API Object) 3568 +MeshUnmeshedPolygonFaceCollection (API Collection) 4181 +MeshVertexReference (API Object) 1239 +MeshVerticesFormat (API Object) 3570 +MeshVolumesFormat (API Object) 3572 +MeshWire (API Object) 1241 +MeshWiresFormat (API Object) 3573 +MessageWindow (API Object) 1248 +MessageWindow (API Property) +Application (API Object) 145 +metadata 32 +MetaData (API Property) +DataSet (API Object) 3091 +Metal (API Object) 1252 +MetalCollection (API Collection) 2541 +Metallic (API Collection) +Media (API Object) 1129 +MetallicFrequencyPoint (API Object) 1257 +MetallicFrequencyPointList (API Object) 1259 +MetallicVisible (API Property) +MeshEdgesFormat (API Object) 3535 +MeshFacesFormat (API Object) 3539 +MeshVerticesFormat (API Object) 3571 +method +Lua 24 +Method (API Property) +Normalisation (API Object) 3653 +PlotSamplingFormat (API Object) 3663 +SurfacePlotSamplingFormat (API Object) 3990 +TraceSamplingFormat (API Object) 4025 +UnitCellLayer (API Object) 2171 +MethodType (API Property) +OptimisationSearch (API Object) 1483 +MFLOPSRateEnabled (API Property) +FEKOParallelDiagnosticTests (API Object) 563, 3157 +MicrostripMeshPort (API Object) 1261 +MicrostripPort (API Object) 1266 +Min (API Method) +ComplexMatrix (API Object) 3019 +Matrix (API Object) 3497 +Min (API Property) +AxisRange (API Object) 2942 +SurfaceGraphAxisRange (API Object) 3971 +Min (API StaticFunction) +ComplexMatrix (API Object) 3031, 3031 +Matrix (API Object) 3505, 3505 +MinElementSize (API Property) +MeshAdvancedSettings (API Object) 1147 +Minimise (API Method) +CartesianGraph (API Object) 2960 +CartesianSurfaceGraph (API Object) 2972 +Graph (API Object) 3359 +MdiSubWindow (API Object) 1123 +PolarGraph (API Object) 3680 +SmithChart (API Object) 3836 +SurfaceGraph (API Object) 3964 +View (API Object) 4043 +Window (API Object) 4074 +Minimum (API Property) +Variable (API Object) 2180 +MinimumCurvilinearEdgeLength (API Property) +MeshInfo (API Object) 1193 +ModelMeshInfo (API Object) 1299 +SimulationMeshInfo (API Object) 1875 +MinimumCurvilinearSegmentLength (API Property) +MeshInfo (API Object) 1193 +ModelMeshInfo (API Object) 1299 +SimulationMeshInfo (API Object) 1875 +MinimumEdgeLength (API Property) +MeshInfo (API Object) 1193 +ModelMeshInfo (API Object) 1299 +SimulationMeshInfo (API Object) 1875 +MinimumElementAngle (API Property) +MeshInfo (API Object) 1193 +ModelMeshInfo (API Object) 1299 +SimulationMeshInfo (API Object) 1875 +MinimumHeight (API Property) +FormCheckBox (API Object) 707, 3229 +FormComboBox (API Object) 712, 3234 +FormConfigurationSelector (API Object) 3239 +FormDataSelector (API Object) 3245 +FormDirectoryBrowser (API Object) 717, 3250 +FormDoubleSpinBox (API Object) 723, 3256 +FormFileBrowser (API Object) 729, 3262 +FormFileSaveAsBrowser (API Object) 735, 3268 +FormGroupBox (API Object) 741, 3274 +FormImage (API Object) 747, 3280 +FormIntegerSpinBox (API Object) 752, 3285 +FormItem (API Object) 758, 3291 +FormLabel (API Object) 761, 3294 +FormLabelledItem (API Object) 765, 3298 +FormLayout (API Object) 770, 3303 +FormLineEdit (API Object) 776, 3309 +FormModelSelector (API Object) 3314 +FormPushButton (API Object) 785, 3323 +FormRadioButtonGroup (API Object) 791, 3329 +FormScrollArea (API Object) 797, 3335 +FormSeparator (API Object) 802, 3340 +FormTree (API Object) 807, 3345 +MinimumOpticalCoverage (API Property) +ShieldLayerSettings (API Object) 1833 +MinimumOuterRadius (API Property) +CableBundleCrossSection (API Object) 190 +MinimumSegmentLength (API Property) +MeshInfo (API Object) 1194 +ModelMeshInfo (API Object) 1300 +SimulationMeshInfo (API Object) 1876 +MinimumTetrahedronEdgeLength (API Property) +MeshInfo (API Object) 1194 +ModelMeshInfo (API Object) 1300 +SimulationMeshInfo (API Object) 1876 +MinimumTimeInterval (API Property) +FrequencyFDTDSettings (API Object) 841 +MinimumTimeIntervalEnabled (API Property) +FrequencyFDTDSettings (API Object) 841 +MinimumValue (API Property) +OptimisationVariable (API Object) 1490 +MinimumVoxelLength (API Property) +MeshInfo (API Object) 1194 +ModelMeshInfo (API Object) 1300 +SimulationMeshInfo (API Object) 1876 +MinimumWidth (API Property) +FormCheckBox (API Object) 707, 3229 +FormComboBox (API Object) 712, 3234 +FormConfigurationSelector (API Object) 3240 +FormDataSelector (API Object) 3246 +FormDirectoryBrowser (API Object) 718, 3251 +FormDoubleSpinBox (API Object) 723, 3256 +FormFileBrowser (API Object) 729, 3262 +FormFileSaveAsBrowser (API Object) 735, 3268 +FormGroupBox (API Object) 741, 3274 +FormImage (API Object) 747, 3280 +FormIntegerSpinBox (API Object) 752, 3285 +FormItem (API Object) 758, 3291 +FormLabel (API Object) 762, 3294 +FormLabelledItem (API Object) 766, 3299 +FormLayout (API Object) 770, 3303 +FormLineEdit (API Object) 776, 3309 +FormModelSelector (API Object) 3314 +FormPushButton (API Object) 785, 3323 +FormRadioButtonGroup (API Object) 791, 3329 +FormScrollArea (API Object) 797, 3335 +FormSeparator (API Object) 803, 3341 +FormTree (API Object) 807, 3345 +MinIncrement (API Property) +FrequencyContinuousSettings (API Object) 831 +MinIncrementEnabled (API Property) +FrequencyContinuousSettings (API Object) 831 +MiniVisible (API Property) +View3DAxesFormat (API Object) 2188, 4048 +Minor (API Property) +CartesianGraphGrid (API Object) 2963 +CartesianSurfaceGraphGrid (API Object) 2974 +PolarGraphGrid (API Object) 3682 +Version (API Object) 2186, 4031 +MinorGridSubdivisions (API Property) +AngularGraphAxis (API Object) 2927 +HorizontalGraphAxis (API Object) 3376 +HorizontalSurfaceGraphAxis (API Object) 3378 +RadialGraphAxis (API Object) 3711 +VerticalGraphAxis (API Object) 4033 +VerticalSurfaceGraphAxis (API Object) 4036 +MinU (API Property) +WorkSurface (API Object) 2269 +MinV (API Property) +WorkSurface (API Object) 2269 +Mirror (API Object) 1271 +MirrorHorizontallyAroundYAxisEnabled (API Property) +MeshExporter (API Object) 1173 +MLFMMACASettings (API Object) 1091 +MLFMMACASettings (API Property) +SolverSettings (API Object) 1899 +MLFMMACASettingsList (API Object) 1093 +MLFMMSettings (API Property) +MLFMMACASettings (API Object) 1091 +MLFMMSolverSettings (API Object) 1095 +MLFMMSolverSettingsList (API Object) 1097 +ModalExcitationCoefficientIsCalculated (API Property) +DataSetMetaData (API Object) 3107 +ModalExcitationStoredData (API Object) 3574 +Mode (API Property) +ViewDisplayMode (API Object) 2192 +ModeIndices (API Property) +SphericalModeDataManuallySpecified (API Object) 1927 +Model (API Object) 1277, 3577 +Model (API Property) +SolutionConfiguration (API Object) 3844 +ModelAttributes (API Object) 1282 +ModelAttributes (API Property) +Model (API Object) 1280 +ModelCollection (API Collection) 4184 +ModelContents (API Object) 1285 +ModelDecompositionCollection (API Collection) 2545 +ModelDecompositions (API Collection) +StandardConfiguration (API Object) 2004 +ModelDefinitions (API Object) 1289 +ModelMeshInfo (API Object) 1293 +ModelOpacity (API Property) +MeshRendering (API Object) 3548 +ViewRenderingOptions (API Object) 2197 +Models (API Collection) +Application (API Object) 2931 +ModelSolutionSolveType (API Property) +MLFMMACASettings (API Object) 1091 +ModelSymmetry (API Object) 1303 +ModelSymmetry (API Property) +SolutionSettings (API Object) 1895 +ModeMaximumIndex (API Property) +FarFieldSphericalModeSettings (API Object) 661 +ModeMaximumIndexEnabled (API Property) +FarFieldSphericalModeSettings (API Object) 661 +Modified (API Property) +Application (API Object) 2930 +Modify (API Method) +ReportTemplateTagCollection (API Collection) 4209 +ModifySegmentRadius (API Method) +Mesh (API Object) 1143 +ModifyVertex (API Method) +Mesh (API Object) 1143 +module +Lua 10 +Modulo (API StaticFunction) +Matrix (API Object) 3506, 3506 +MoveItems (API Method) +Schematic (API Object) 1818 +MoveOut (API Method) +GeometryGroup (API Collection) 2478 +MSPowerPointInstalled (API Property) +Application (API Object) 2930 +MSWordInstalled (API Property) +Application (API Object) 2930 +MultiplyByElement (API StaticFunction) +ComplexMatrix (API Object) 3031, 3032, 3032 +Matrix (API Object) 3506, 3507 +MultiportPackageGenerationEnabled (API Property) +SParameter (API Object) 1799 +MultiSelect (API Property) +FormFileBrowser (API Object) 729, 3262 +N (API Property) +CartesianDescription (API Object) 287 +CartesianRequestPoints (API Object) 291 +CylindricalDescription (API Object) 438 +LocalCoordinate (API Object) 1064 +LocalInternalCoordinate (API Object) 1067 +Name (API Property) +DataSetAxis (API Object) 3098 +DataSetQuantity (API Object) 3111 +NamedPoint (API Object) 1306 +NamedPointCollection (API Collection) 2549 +NamedPoints (API Collection) +ModelDefinitions (API Object) 1291 +NamedPointsVisible (API Property) +View3DSolutionEntityFormat (API Object) 4058 +namespace +Lua 24 +NearField (API Object) 1312 +NearField3DFormat (API Object) 3580 +NearField3DPlot (API Object) 3583 +NearFieldAdvancedSettings (API Object) 1320 +NearFieldAdvancedSettingsList (API Object) 1323 +NearFieldBoundarySurface (API Object) 1325 +NearFieldBoundarySurfaceList (API Object) 1328 +NearFieldCalculationMethod (API Property) +MLFMMSolverSettings (API Object) 1096 +NearFieldCollection (API Collection) 2553, 4187 +NearFieldData (API Object) 3590 +NearFieldDataFileStructure (API Object) 1330 +NearFieldDataFullImport (API Object) 1338 +NearFieldExportSettings (API Object) 1345 +NearFieldExportSettingsList (API Object) 1347 +NearFieldIncluded (API Property) +FrequencyContinuousQuantities (API Object) 826 +NearFieldMathScript (API Object) 3596 +NearFieldOptimisationGoal (API Object) 1349 +NearFieldPowerIntegralCollection (API Collection) 4190 +NearFieldPowerIntegralData (API Object) 3599 +NearFieldPowerIntegrals (API Collection) +SolutionConfiguration (API Object) 3845 +NearFieldPowerIntegralStoredData (API Object) 3601 +NearFieldPowerIntegralTrace (API Object) 3603 +NearFieldQuantity (API Object) 3610 +NearFieldReceivingAntenna (API Object) 1354 +NearFieldReceivingAntennaCollection (API Collection) 2563 +NearFieldReceivingAntennaData (API Object) 3615 +NearFieldReceivingAntennas (API Collection) +StandardConfiguration (API Object) 2004 +NearFields (API Collection) +CharacteristicModesConfiguration (API Object) 307 +SolutionConfiguration (API Object) 3845 +StandardConfiguration (API Object) 2004 +NearFieldSource (API Object) 1361 +NearFieldStoredData (API Object) 3618 +NearFieldSurfacePlot (API Object) 3621 +NearFieldTrace (API Object) 3628 +Negate (API StaticFunction) +ComplexMatrix (API Object) 3032 +Matrix (API Object) 3507 +NegativeFaces (API Property) +EdgeMeshPort (API Object) 497 +EdgePort (API Object) 502 +NegativeNEnabled (API Property) +NearFieldBoundarySurface (API Object) 1326 +NegativeTerminalGrounded (API Property) +EdgeMeshPort (API Object) 497 +EdgePort (API Object) 502 +NegativeUEnabled (API Property) +NearFieldBoundarySurface (API Object) 1326 +NegativeVEnabled (API Property) +NearFieldBoundarySurface (API Object) 1326 +NegativeX (API Property) +FDTDBoundaryConditions (API Object) 543 +NegativeY (API Property) +FDTDBoundaryConditions (API Object) 544 +NegativeZ (API Property) +FDTDBoundaryConditions (API Object) 544 +Net (API Object) 1367 +NetCollection (API Collection) 2567 +Nets (API Collection) +Schematic (API Object) 1817 +Nets (API Property) +Terminal (API Object) 2106 +Network (API Object) 1371 +NetworkCollection (API Collection) 2572, 4193 +NetworkData (API Object) 3636 +NetworkEnabled (API Property) +FEKOParallelDiagnosticTests (API Object) 563, 3158 +NetworkMathScript (API Object) 3640 +Networks (API Collection) +SolutionConfiguration (API Object) 3846 +NetworksIncluded (API Property) +FrequencyContinuousQuantities (API Object) 826 +NetworkStoredData (API Object) 3643 +NetworksVisible (API Property) +View3DSolutionEntityFormat (API Object) 4058 +NetworkTrace (API Object) 3646 +New (API StaticFunction) +Complex (API Object) 325, 325, 325, 3005, 3005, 3006 +ComplexMatrix (API Object) 3032, 3033, 3033, 3033 +DataSet (API Object) 3096 +Form (API Object) 701, 701, 701, 3223, 3223, 3223 +FormCheckBox (API Object) 708, 708, 3230, 3230 +FormComboBox (API Object) 713, 714, 3235, 3236 +FormConfigurationSelector (API Object) 3240, 3241 +FormDataSelector (API Object) 3247, 3247 +FormDirectoryBrowser (API Object) 719, 719, 3252, 3252 +FormDoubleSpinBox (API Object) 725, 725, 3258, 3258 +FormFileBrowser (API Object) 730, 731, 3263, 3264 +FormFileSaveAsBrowser (API Object) 736, 736, 3269, 3269 +FormGroupBox (API Object) 742, 743, 743, 3275, 3276, 3276 +FormImage (API Object) 748, 3281 +FormIntegerSpinBox (API Object) 754, 754, 3286, 3287 +FormLabel (API Object) 762, 3295 +FormLayout (API Object) 771, 771, 3304, 3305 +FormLineEdit (API Object) 777, 777, 3310, 3310 +FormModelSelector (API Object) 3315, 3315 +FormProgressDialog (API Object) 781, 781, 3319, 3319 +FormPushButton (API Object) 786, 786, 3324, 3324 +FormRadioButtonGroup (API Object) 792, 792, 3330, 3330 +FormScrollArea (API Object) 798, 799, 3336, 3337 +FormSeparator (API Object) 803, 3341 +FormTree (API Object) 808, 808, 3346, 3346 +FormTreeItem (API Object) 812, 812, 3350, 3350 +Matrix (API Object) 3507, 3507, 3508, 3508 +Point (API Object) 1605, 1605, 3667, 3667 +UVPoint (API Object) 2157, 2157 +Vector (API Object) 2184, 2184 +NewProject (API Method) +Application (API Object) 146, 2935 +NonIncludedAngle (API Property) +MeshRendering (API Object) 3548 +NonIncludedAnglesVisible (API Property) +MeshRendering (API Object) 3548 +Normal (API Property) +ConstrainedSurfacePoint (API Object) 374 +NormalDimension (API Object) 1374 +NormalDimensionList (API Object) 1375 +Normalisation (API Object) 3653 +Normalisation (API Property) +CartesianGraph (API Object) 2956 +PolarGraph (API Object) 3675 +NormalSide (API Property) +RLGOFaceAbsorbingSettings (API Object) 1695 +NotEqual (API StaticFunction) +ComplexMatrix (API Object) 3034, 3034, 3034, 3035 +Matrix (API Object) 3508, 3509 +Notices (API Property) +LaunchResult (API Object) 3398 +NotificationEnabled (API Property) +FEKOGPUOptions (API Object) 554, 3153 +NoUnit (API Property) +TraceMathExpression (API Object) 4023 +NPoints (API Property) +CylindricalStructure (API Object) 447 +NumberFormat (API Property) +GraphAxisLabels (API Object) 3367 +SurfaceGraphAxisLabels (API Object) 3969 +NumberOfCarriers (API Property) +ShieldLayerSettings (API Object) 1834 +NumberOfColumns (API Property) +GraphLegend (API Object) 3371 +NumberOfDiscreteValues (API Property) +Frequency (API Object) 819 +NumberOfFilaments (API Property) +ShieldLayerSettings (API Object) 1834 +NumberOfGridPoints (API Property) +OptimisationVariable (API Object) 1490 +NumberOfModes (API Property) +CharacteristicModes (API Object) 303 +NumberOfPins (API Property) +CableSpiceNetwork (API Object) 271 +NumberOfPoints (API Property) +OptimisationSearch (API Object) 1483 +PointRange (API Object) 1613 +NumberOfPorts (API Property) +CableGeneralNetwork (API Object) 213 +NumberOfProcessesEnabled (API Property) +FEKOParallelExecutionOptions (API Object) 567, 3160 +NumberOfRuns (API Property) +OptimisationSearchAdvancedSettings (API Object) 1486 +NumberOfRunsEnabled (API Property) +OptimisationSearchAdvancedSettings (API Object) 1486 +NumberOfSamples (API Property) +FrequencyExportSettings (API Object) 836 +NumberOfSamplesEnabled (API Property) +FrequencyExportSettings (API Object) 836 +NumberPhiPoints (API Property) +FarFieldData (API Object) 630 +NumbersVisible (API Property) +Rays3DFormat (API Object) 3719 +NumberThetaPoints (API Property) +FarFieldData (API Object) 631 +NumericalGreensFunction (API Object) 1377 +NumericalGreensFunction (API Property) +SolutionSettings (API Object) 1895 +NumLines (API Property) +SurfaceRegularLines (API Object) 2077 +NurbsControlPoint (API Object) 1380 +NurbsControlPointList (API Object) 1382 +NurbsControlPointTable (API Object) 1384 +NurbsSurface (API Object) 1386 +NVIDIAEnabled (API Property) +FEKOGPUOptions (API Object) 554, 3153 +Object (API Object) 1399 +Objective (API Property) +FarFieldOptimisationGoal (API Object) 640 +ImpedanceOptimisationGoal (API Object) 964 +NearFieldOptimisationGoal (API Object) 1352 +OptimisationGoal (API Object) 1458 +PowerOptimisationGoal (API Object) 1666 +ReceivingAntennaOptimisationGoal (API Object) 1713 +SAROptimisationGoal (API Object) 1796 +SParameterOptimisationGoal (API Object) 1808 +TransmissionReflectionOptimisationGoal (API Object) 2137 +ObjectReferenceList (API Object) 1429 +ObjectReferenceTable (API Object) 1431 +Offset (API Property) +Cutplane (API Object) 417 +ImplicitPointsAnnotation (API Object) 3381 +IndependentAxisFormat (API Object) 3387 +Windscreen (API Object) 2251 +WorkSurface (API Object) 2269 +OffsetA (API Property) +WindscreenSolutionMethod (API Object) 2254 +OffsetN (API Property) +CylindricalAntennaArray (API Object) 433 +OffsetType (API Property) +ImplicitPointsAnnotation (API Object) 3381 +OffsetU (API Property) +LinearPlanarArray (API Object) 1052 +OffsetV (API Property) +LinearPlanarArray (API Object) 1052 +OffsetX (API Property) +BandwidthAnnotation (API Object) 2945 +BeamwidthAnnotation (API Object) 2950 +CableBundleCableSpecification (API Object) 184 +GraphAnnotation (API Object) 3364 +ImplicitPointsAnnotation (API Object) 3381 +SimpleAnnotation (API Object) 3826 +WidthAnnotation (API Object) 4067 +OffsetY (API Property) +BandwidthAnnotation (API Object) 2945 +BeamwidthAnnotation (API Object) 2950 +CableBundleCableSpecification (API Object) 184 +GraphAnnotation (API Object) 3364 +ImplicitPointsAnnotation (API Object) 3381 +SimpleAnnotation (API Object) 3826 +WidthAnnotation (API Object) 4067 +OK (API Property) +FormButtons (API Object) 703, 3225 +Ones (API StaticFunction) +ComplexMatrix (API Object) 3035 +Matrix (API Object) 3509 +OnlyCheckGeometryEnabled (API Property) +FEKOLaunchOptions (API Object) 558, 3155 +OnlyScatteredPartCalculationEnabled (API Property) +FarFieldAdvancedSettings (API Object) 624 +NearFieldAdvancedSettings (API Object) 1321 +Opacity (API Property) +CustomData3DFormat (API Object) 3047 +FarField3DFormat (API Object) 3164 +NearField3DFormat (API Object) 3581 +Rays3DFormat (API Object) 3719 +OpenFile (API Method) +Application (API Object) 2935 +OpenRing (API Object) 1433 +OpenRingShape (API Object) 1442 +OperatingPrecisionTolerance (API Property) +SimplifyPartRepresentationSettings (API Object) 1859 +Operation (API Property) +OptimisationGoalProcessingSteps (API Object) 1464 +OperatorCollection (API Collection) 2578 +OppositeSide (API Property) +RLGOFaceAbsorbingSettings (API Object) 1695 +OPTFEKO (API Property) +ComponentLaunchOptions (API Object) 341, 3041 +OPTFEKOLaunchOptions (API Object) 1394, 3655 +OPTFEKOLaunchOptionsList (API Object) 1397 +Optimisation (API Object) 1446 +Optimisation (API Property) +Model (API Object) 1280 +OptimisationCombination (API Object) 1449 +OptimisationConstraint (API Object) 1452 +OptimisationConstraintList (API Object) 1454 +OptimisationGoal (API Object) 1456 +OptimisationGoalCollection (API Collection) 2582 +OptimisationGoalObjective (API Object) 1460 +OptimisationGoalProcessingSteps (API Object) 1464 +OptimisationGoalProcessingStepsList (API Object) 1466 +OptimisationMask (API Object) 1468 +OptimisationMaskCollection (API Collection) 2589 +OptimisationMaskValues (API Object) 1471 +OptimisationMaskValuesList (API Object) 1473 +OptimisationOperator (API Object) 1475 +OptimisationParameters (API Object) 1478 +OptimisationSearch (API Object) 1481 +OptimisationSearchAdvancedSettings (API Object) 1485 +OptimisationSearchCollection (API Collection) 2593 +OptimisationVariable (API Object) 1489 +OptimisationVariableList (API Object) 1491 +Options (API Property) +FormComboBox (API Object) 712, 3234 +FormRadioButtonGroup (API Object) 791, 3329 +Orientation (API Property) +PolarGraph (API Object) 3675 +OrientationWorkplane (API Property) +UnprotectedInformation (API Object) 2176 +Origin (API Property) +Cuboid (API Object) 393 +CustomAntennaArray (API Object) 411 +DataSetMetaData (API Object) 3108 +FarField3DFormat (API Object) 3165 +GlobalPlane (API Object) 903 +Mirror (API Object) 1273 +Rectangle (API Object) 1718 +Rotate (API Object) 1786 +Scale (API Object) 1812 +Spin (API Object) 1961 +Split (API Object) 1983 +View3DFormat (API Object) 4051 +Workplane (API Object) 2273 +OrthogonalMedium (API Property) +AnisotropicDielectricLayers (API Object) 135 +OuterLayer (API Property) +CableShield (API Object) 260 +OuterRadius (API Property) +CableBundleCrossSection (API Object) 190 +CableCoaxialCrossSection (API Object) 198 +OpenRing (API Object) 1437 +OpenRingShape (API Object) 1443 +Ring (API Object) 1775 +RingShape (API Object) 1782 +SplitRing (API Object) 1992 +SplitRingShape (API Object) 1998 +OutFileEnabled (API Property) +CurrentsExportSettings (API Object) 405 +FarFieldExportSettings (API Object) 634 +NearFieldExportSettings (API Object) 1346 +PREFEKOVariableExportOptions (API Object) 1519, 3659 +OutlineColour (API Property) +MeshFacesFormat (API Object) 3539 +OutlineVisible (API Property) +MeshFacesFormat (API Object) 3539 +Output (API Property) +LaunchResult (API Object) 1021, 3398 +OutputFileSettings (API Property) +GeneralSolverSettings (API Object) 856 +OutputFileSolverSettings (API Object) 1493 +OutputFileSolverSettingsList (API Object) 1496 +OutputPort (API Property) +SParameterOptimisationGoal (API Object) 1808 +OutputPortSpecified (API Property) +SParameterOptimisationGoal (API Object) 1808 +OutsideBraidFixingMedium (API Property) +ShieldLayerSettings (API Object) 1834 +OverlayModeEnabled (API Property) +ViewDisplayMode (API Object) 2193 +PageOrientation (API Property) +QuickReport (API Object) 3707 +PanDown (API Method) +SchematicViewWindow (API Object) 1821 +PanLeft (API Method) +SchematicViewWindow (API Object) 1821 +PanRight (API Method) +SchematicViewWindow (API Object) 1821 +PanUp (API Method) +SchematicViewWindow (API Object) 1821 +ParabolicArc (API Object) 1523 +Paraboloid (API Object) 1532 +Parallel (API Property) +FEKOLaunchOptions (API Object) 558, 3155 +Parameters (API Property) +OptimisationSearch (API Object) 1483 +ParametricComplexExpression (API Object) 1540 +ParametricComplexExpressionList (API Object) 1541 +ParametricComplexExpressionTable (API Object) 1543 +ParametricEnd (API Property) +AnalyticalCurve (API Object) 122 +ParametricExpression (API Object) 1545 +ParametricExpressionList (API Object) 1556 +ParametricStart (API Property) +AnalyticalCurve (API Object) 122 +ParasolidFileFormat (API Property) +GeometryExporter (API Object) 876 +ParasolidTopologyType (API Property) +GeometryExporter (API Object) 876 +ParasolidVersion (API Property) +GeometryExporter (API Object) 876 +Parent (API Property) +AbstractSurfaceCurve (API Object) 99 +AnalyticalCurve (API Object) 122 +BezierCurve (API Object) 164 +Cone (API Object) 353 +ConstrainedSurface (API Object) 367 +Cross (API Object) 381 +Cuboid (API Object) 393 +Cylinder (API Object) 425 +Ellipse (API Object) 514 +EllipticArc (API Object) 527 +FittedSpline (API Object) 682 +Flare (API Object) 692 +FormTreeItem (API Object) 811, 3349 +Geometry (API Object) 869 +Helix (API Object) 928 +Hexagon (API Object) 936 +HyperbolicArc (API Object) 957 +ImprintPoints (API Object) 984 +Intersect (API Object) 1002 +Line (API Object) 1044 +Loft (API Object) 1086 +NurbsSurface (API Object) 1389 +OpenRing (API Object) 1437 +ParabolicArc (API Object) 1527 +Paraboloid (API Object) 1535 +PathSweep (API Object) 1562 +Polygon (API Object) 1633 +Polyline (API Object) 1641 +Primitive (API Object) 1675 +ProjectGeometry (API Object) 1683 +Rectangle (API Object) 1719 +RepairAndSewFaces (API Object) 1742 +RepairPart (API Object) 1756 +Ring (API Object) 1776 +Simplify (API Object) 1844 +Sphere (API Object) 1911 +Spin (API Object) 1961 +SpiralCross (API Object) 1970 +Split (API Object) 1983 +SplitRing (API Object) 1992 +Stitch (API Object) 2009 +StripCross (API Object) 2019 +StripHexagon (API Object) 2031 +Subtract (API Object) 2042 +SurfaceBezierCurve (API Object) 2051 +SurfaceLine (API Object) 2067 +SurfaceRegularLines (API Object) 2077 +Sweep (API Object) 2086 +TCross (API Object) 2096 +Trifilar (API Object) 2143 +Union (API Object) 2161 +Patch (API Property) +Version (API Object) 2186, 4031 +PatchTopology (API Property) +FillHoleSettings (API Object) 674 +Path (API Property) +CableProbe (API Object) 242 +Net (API Object) 1368 +Paths (API Collection) +Cables (API Object) 281 +PathSweep (API Method) +GeometryCollection (API Collection) 2465, 2465, 2466 +PathSweep (API Object) 1558 +PathSweepParallel (API Method) +GeometryCollection (API Collection) 2466 +PathTerminal (API Property) +CableConnector (API Object) 202 +PBC (API Property) +FarFieldAdvancedSettings (API Object) 624 +PBCVisible (API Property) +View3DSolutionEntityFormat (API Object) 4058 +PCB (API Object) 1498 +PCB (API Property) +Importer (API Object) 972 +PCBCurrentData (API Object) 1504 +PCBSource (API Object) 1509 +PerfectElectricConductor (API Object) 1567 +PerfectElectricConductor (API Property) +Media (API Object) 1127 +PerfectMagneticConductor (API Object) 1570 +PerfectMagneticConductor (API Property) +Media (API Object) 1127 +PeriodicBoundary (API Object) 1573 +PeriodicBoundary (API Property) +SolutionSettings (API Object) 1895 +PeriodicBoundaryBeamSquintAngle (API Object) 1581 +PeriodicBoundaryBeamSquintAngleList (API Object) 1583 +PeriodicBoundaryPhaseShift (API Object) 1585 +PeriodicBoundaryPhaseShiftList (API Object) 1587 +Permeability (API Property) +ComplexTensor (API Object) 336 +Permittivity (API Property) +ComplexTensor (API Object) 336 +pf 20, 21 +Phase (API Method) +Complex (API Object) 318, 2999 +ComplexMatrix (API Object) 3019 +Matrix (API Object) 3497 +Phase (API Property) +AbstractPointSource (API Object) 92 +CurrentSource (API Object) 400 +CustomSmithTraceQuantity (API Object) 3080 +ElectricDipole (API Object) 507 +ExcitationSmithQuantity (API Object) 3134 +FarFieldSource (API Object) 655 +FEMModalSource (API Object) 603 +FundamentalModeOptions (API Object) 845 +LoadSmithQuantity (API Object) 3452 +MagneticDipole (API Object) 1101 +NearFieldSource (API Object) 1363 +PCBSource (API Object) 1511 +PlaneWave (API Object) 1599 +SolutionCoefficientSource (API Object) 1886 +SphericalModeSource (API Object) 1944 +VoltageSource (API Object) 2214 +WaveguideModeOptions (API Object) 2236 +WaveguideSource (API Object) 2247 +Phase (API StaticFunction) +Complex (API Object) 325, 326, 3006, 3006 +ComplexMatrix (API Object) 3035 +PhaseAdditionEnabled (API Property) +CustomSmithTraceQuantity (API Object) 3080 +ExcitationSmithQuantity (API Object) 3134 +LoadSmithQuantity (API Object) 3452 +PhaseDefinition (API Property) +Transformer (API Object) 2118 +PhaseFactor (API Property) +DielectricModelling (API Object) 475 +PhaseOffset (API Property) +AntennaArraySource (API Object) 140 +CustomAntennaArray (API Object) 411 +PhaseShift (API Property) +PeriodicBoundary (API Object) 1576 +PhaseShiftMethod (API Property) +PeriodicBoundary (API Object) 1576 +PhaseStepSize (API Property) +View3DAnimationFormat (API Object) 4045 +PhaseUnwrapped (API Property) +CharacteristicModeQuantity (API Object) 2982 +CustomDataQuantity (API Object) 3056 +ExcitationQuantity (API Object) 3131 +FarFieldQuantity (API Object) 3196 +LoadQuantity (API Object) 3446 +NearFieldQuantity (API Object) 3613 +ReceivingAntennaQuantity (API Object) 3727 +SParameterQuantity (API Object) 3805 +SpiceProbeQuantity (API Object) 3934 +TRQuantity (API Object) 4010 +Phi (API Property) +AbstractPointSource (API Object) 92 +ConicalRequestPoints (API Object) 359 +Cutplane (API Object) 417 +CylindricalDescription (API Object) 439 +CylindricalRequestPoints (API Object) 442 +CylindricalXRequestPoints (API Object) 451 +CylindricalYRequestPoints (API Object) 455 +ElectricDipole (API Object) 507 +FarField (API Object) 619 +FarFieldReceivingAntenna (API Object) 649 +FarFieldSource (API Object) 656 +MagneticDipole (API Object) 1101 +PeriodicBoundaryBeamSquintAngle (API Object) 1581 +PlaneWave (API Object) 1599 +SphericalDescription (API Object) 1916 +SphericalModeReceivingAntenna (API Object) 1938 +SphericalModeSource (API Object) 1945 +SphericalRequestPoints (API Object) 1950 +PhiAngle (API Property) +CylindricalAntennaArray (API Object) 433 +PhiDirection (API Property) +View3DFormat (API Object) 4051 +PhiIncrement (API Property) +HighFrequencySettings (API Object) 948 +PhiPoints (API Property) +CylindricalStructure (API Object) 447 +SphericalStructure (API Object) 1953 +PhiSpacingType (API Property) +CylindricalAntennaArray (API Object) 433 +PhiStepSize (API Property) +View3DAnimationFormat (API Object) 4045 +Pins (API Collection) +CableConnector (API Object) 203 +PitchAngle (API Property) +Helix (API Object) 928 +PlanarSubstrate (API Object) 1589 +PlanarSubstrateList (API Object) 1591 +Plane (API Property) +Mirror (API Object) 1273 +Split (API Object) 1983 +PlaneShape (API Object) 1593 +PlaneWave (API Object) 1596 +PlaneX (API Property) +ModelSymmetry (API Object) 1304 +PlaneY (API Property) +ModelSymmetry (API Object) 1304 +PlaneZ (API Property) +ModelSymmetry (API Object) 1304 +Plates (API Collection) +Mesh (API Object) 1139 +Plot3DLegendFormat (API Object) 3660 +Plots (API Collection) +CartesianSurfaceGraph (API Object) 2971 +SurfaceGraph (API Object) 3963 +View (API Object) 4041 +PlotSamplingFormat (API Object) 3663 +PlotType (API Property) +CustomData3DPlot (API Object) 3051 +FarField3DPlot (API Object) 3169 +NearField3DPlot (API Object) 3586 +NearFieldSurfacePlot (API Object) 3624 +PlotTypesAvailable (API Property) +CustomData3DPlot (API Object) 3051 +FarField3DPlot (API Object) 3169 +NearField3DPlot (API Object) 3586 +NearFieldSurfacePlot (API Object) 3624 +Point (API Object) 1603, 3665 +Point (API Property) +NamedPoint (API Object) 1308 +Point1AnnotationType (API Property) +WidthAnnotation (API Object) 4067 +Point1PositionHorizontal (API Property) +WidthAnnotation (API Object) 4068 +Point1PositionVertical (API Property) +WidthAnnotation (API Object) 4068 +Point1RelativeType (API Property) +WidthAnnotation (API Object) 4068 +Point2AnnotationType (API Property) +WidthAnnotation (API Object) 4068 +Point2PositionHorizontal (API Property) +WidthAnnotation (API Object) 4068 +Point2PositionVertical (API Property) +WidthAnnotation (API Object) 4068 +Point2RelativeType (API Property) +WidthAnnotation (API Object) 4069 +PointAngleRange (API Object) 1607 +PointAngleRangeList (API Object) 1608 +PointExpressionTable (API Object) 1610 +PointRange (API Object) 1612 +PointRangeExpression (API Object) 1614 +PointRangeExpressionList (API Object) 1615 +PointRangeList (API Object) 1617 +PointRefinement (API Object) 1619 +Points (API Object) 3669 +Points (API Property) +ConstrainedSurface (API Object) 367 +FittedSpline (API Object) 682 +ImprintPoints (API Object) 984 +Mesh (API Object) 3514 +SpecifiedRequestPoints (API Object) 1904 +PointSettings (API Property) +Simplify (API Object) 1844 +PointSpecificationMethod (API Property) +NearField (API Object) 1316 +PolarGraph (API Object) 3671 +PolarGraphCollection (API Collection) 4196 +PolarGraphGrid (API Object) 3681 +PolarGraphs (API Collection) +Application (API Object) 2932 +PolarGridLines (API Object) 3683 +PolarisationAngle (API Property) +PlaneWave (API Object) 1599 +PolarisationType (API Property) +FarFieldOptimisationGoal (API Object) 640 +TransmissionReflectionOptimisationGoal (API Object) 2137 +TRQuantity (API Object) 4010 +PolarityReversed (API Property) +FEMLinePort (API Object) 585 +MicrostripMeshPort (API Object) 1263 +MicrostripPort (API Object) 1268 +WireMeshPort (API Object) 2259 +WirePort (API Object) 2264 +PolarityType (API Property) +PlaneWave (API Object) 1599 +PolderTensor (API Object) 1625 +PolderTensor (API Property) +AnisotropicDielectric (API Object) 132 +PolderTensorList (API Object) 1628 +Polygon (API Object) 1630 +PolygonCount (API Property) +MeshInfo (API Object) 1194 +ModelMeshInfo (API Object) 1300 +SimulationMeshInfo (API Object) 1876 +PolygonImportingEnabled (API Property) +MeshImporter (API Object) 1183 +Polygons (API Property) +MeshUnmeshedPolygonFace (API Object) 3569 +Polyline (API Object) 1638 +PolylineRefinement (API Object) 1646 +Port (API Object) 1652 +PortCollection (API Collection) 2597 +PortProperties (API Object) 1655 +PortProperties (API Property) +SParameter (API Object) 1800 +PortPropertiesList (API Object) 1658 +Ports (API Collection) +ModelContents (API Object) 1287 +Position (API Property) +AbstractPointSource (API Object) 92 +CableConnector (API Object) 202 +ConstrainedSurfacePoint (API Object) 374 +ElectricDipole (API Object) 507 +FarFieldReceivingAntenna (API Object) 650 +FarFieldSource (API Object) 656 +GraphLegend (API Object) 3372 +MagneticDipole (API Object) 1101 +MeshLegendFormat (API Object) 3541 +NurbsControlPoint (API Object) 1380 +PCBSource (API Object) 1511 +Plot3DLegendFormat (API Object) 3661 +PointRefinement (API Object) 1621 +SolutionCoefficientSource (API Object) 1886 +SphericalModeReceivingAntenna (API Object) 1938 +SphericalModeSource (API Object) 1945 +TransmissionReflection (API Object) 2133 +PositionDefinition (API Property) +CableConnector (API Object) 202 +PositionDistance (API Property) +CableProbe (API Object) 243 +PositionHorizontal (API Property) +SimpleAnnotation (API Object) 3826 +PositionPercentage (API Property) +CableProbe (API Object) 243 +WirePort (API Object) 2264 +PositionVertical (API Property) +SimpleAnnotation (API Object) 3826 +PositionX (API Property) +ResultTextBox (API Object) 3769 +PositionY (API Property) +ResultTextBox (API Object) 3770 +PositiveFaces (API Property) +EdgeMeshPort (API Object) 497 +EdgePort (API Object) 502 +PositiveNEnabled (API Property) +NearFieldBoundarySurface (API Object) 1326 +PositiveTerminalGrounded (API Property) +EdgeMeshPort (API Object) 497 +EdgePort (API Object) 502 +PositiveUEnabled (API Property) +NearFieldBoundarySurface (API Object) 1327 +PositiveVEnabled (API Property) +NearFieldBoundarySurface (API Object) 1327 +PositiveX (API Property) +FDTDBoundaryConditions (API Object) 544 +PositiveY (API Property) +FDTDBoundaryConditions (API Object) 544 +PositiveZ (API Property) +FDTDBoundaryConditions (API Object) 544 +POSTFEKO +automation 9 +custom dialog 50 +PotentialType (API Property) +NearFieldAdvancedSettings (API Object) 1321 +Power (API Collection) +SolutionConfiguration (API Object) 3846 +Power (API Object) 1660 +Power (API Property) +StandardConfiguration (API Object) 2003 +Power (API StaticFunction) +Complex (API Object) 326, 326, 3006, 3007 +ComplexMatrix (API Object) 3035, 3036, 3036, 3036 +Matrix (API Object) 3509, 3509 +PowerCollection (API Collection) 4199 +PowerData (API Object) 3685 +PowerIncluded (API Property) +FrequencyContinuousQuantities (API Object) 827 +PowerIntegralQuantity (API Object) 3689 +PowerMathScript (API Object) 3691 +PowerOptimisationGoal (API Object) 1664 +PowerQuantity (API Object) 3694 +PowerScaling (API Property) +DataSetMetaData (API Object) 3108 +PowerScalingEnabled (API Property) +NearFieldQuantity (API Object) 3613 +PowerScalingFactor (API Property) +NearFieldQuantity (API Object) 3613 +PowerStoredData (API Object) 3696 +PowerTrace (API Object) 3699 +PreconditionerSettings (API Object) 1668 +PreconditionerSettings (API Property) +SolverSettings (API Object) 1899 +PreconditionerSettingsList (API Object) 1670 +PreconditionerType (API Property) +IterativeSolverSettings (API Object) 1013 +PredefinedType (API Property) +CableCoaxialCrossSection (API Object) 198 +PREFEKO (API Property) +ComponentLaunchOptions (API Object) 341, 3041 +PREFEKOLaunchOptions (API Object) 1515, 3657 +PREFEKOLaunchOptionsList (API Object) 1517 +PREFEKOVariableExportOptions (API Object) 1519, 3659 +PREFEKOVariableExportOptionsList (API Object) 1521 +PreFileWritingEnabled (API Property) +GeneralSolverSettings (API Object) 856 +Prefix (API Property) +CFXModelImportSettings (API Object) 178 +MeshImporter (API Object) 1183 +Primitive (API Object) 1672 +PrincipleDirection (API Property) +AnisotropicDielectricLayers (API Object) 136 +PrincipleMedium (API Property) +AnisotropicDielectricLayers (API Object) 136 +printlist 20 +Probes (API Collection) +CableHarness (API Object) 218 +ProbesIncluded (API Property) +FrequencyContinuousQuantities (API Object) 827 +ProbesVisible (API Property) +View3DSolutionEntityFormat (API Object) 4058 +ProbeType (API Property) +CableProbe (API Object) 243 +ProcessCount (API Property) +FEKOParallelExecutionOptions (API Object) 567, 3160 +ProcessFarmOutCount (API Property) +OPTFEKOLaunchOptions (API Object) 1395, 3656 +ProcessingSteps (API Property) +FarFieldOptimisationGoal (API Object) 641 +ImpedanceOptimisationGoal (API Object) 964 +NearFieldOptimisationGoal (API Object) 1352 +OptimisationGoal (API Object) 1458 +PowerOptimisationGoal (API Object) 1666 +ReceivingAntennaOptimisationGoal (API Object) 1713 +SAROptimisationGoal (API Object) 1796 +SParameterOptimisationGoal (API Object) 1808 +TransmissionReflectionOptimisationGoal (API Object) 2138 +ProcessPriority (API Property) +FEKOLaunchOptions (API Object) 559, 3155 +Project (API Property) +Application (API Object) 145 +ProjectGeometry (API Method) +GeometryCollection (API Collection) 2466, 2467 +ProjectGeometry (API Object) 1680 +ProjectOntoXYPlaneEnabled (API Property) +MeshExporter (API Object) 1173 +PropagationDirection (API Property) +SphericalModeDataManuallySpecified (API Object) 1927 +PropagationVelocity (API Property) +CableCoaxialCrossSection (API Object) 198 +TransmissionLine (API Object) 2129 +ProtectedModel (API Object) 1688 +ProtectedModels (API Collection) 2612 +QuadrangleImportingEnabled (API Property) +MeshImporter (API Object) 1183 +Quantities (API Collection) +DataSet (API Object) 3091 +Quantities (API Property) +FrequencyContinuousSettings (API Object) 832 +Quantity (API Property) +CharacteristicModeTrace (API Object) 2990 +CustomData3DPlot (API Object) 3052 +CustomDataSmithTrace (API Object) 3060 +CustomDataSurfacePlot (API Object) 3067 +CustomDataTrace (API Object) 3073 +ErrorEstimate3DPlot (API Object) 3115 +ExcitationSmithTrace (API Object) 3139 +ExcitationTrace (API Object) 3149 +FarField3DPlot (API Object) 3169 +FarFieldPowerIntegralTrace (API Object) 3191 +FarFieldSurfacePlot (API Object) 3207 +FarFieldTrace (API Object) 3213 +LoadSmithTrace (API Object) 3456 +LoadTrace (API Object) 3466 +NearField3DPlot (API Object) 3586 +NearFieldPowerIntegralTrace (API Object) 3606 +NearFieldSurfacePlot (API Object) 3624 +NearFieldTrace (API Object) 3632 +NetworkTrace (API Object) 3649 +PowerTrace (API Object) 3702 +Ray3DPlot (API Object) 3713 +ReceivingAntennaTrace (API Object) 3732 +SARTrace (API Object) 3792 +SParameterSurfacePlot (API Object) 3813 +SParameterTrace (API Object) 3819 +SpiceProbeTrace (API Object) 3940 +SurfaceCurrents3DPlot (API Object) 3946 +TRCoefficientTrace (API Object) 4005 +WireCurrents3DPlot (API Object) 4077 +WireCurrentsTrace (API Object) 4096 +QuantityType (API Property) +DataSetQuantity (API Object) 3111 +WireCurrentsQuantity (API Object) 4090 +QuickReport (API Object) 3706 +R (API Property) +SphericalDescription (API Object) 1917 +RadialAxis (API Property) +PolarGraph (API Object) 3675 +RadialGraphAxis (API Object) 3710 +RadialLabelsVisible (API Property) +PolarGridLines (API Object) 3684 +RadialLine (API Property) +PolarGridLines (API Object) 3684 +Radius (API Property) +Cylinder (API Object) 425 +CylindricalAntennaArray (API Object) 434 +HyperbolicArc (API Object) 957 +ImpressedCurrent (API Object) 977 +MeshSegmentsFormat (API Object) 3554 +ParabolicArc (API Object) 1527 +Paraboloid (API Object) 1535 +PointRefinement (API Object) 1621 +PolylineRefinement (API Object) 1648 +Sphere (API Object) 1911 +SphericalRequestPoints (API Object) 1950 +SphericalStructure (API Object) 1954 +RadiusN (API Property) +Sphere (API Object) 1911 +RadiusU (API Property) +Ellipse (API Object) 514 +EllipseShape (API Object) 520 +EllipticArc (API Object) 527 +Sphere (API Object) 1911 +RadiusV (API Property) +Ellipse (API Object) 514 +EllipseShape (API Object) 520 +EllipticArc (API Object) 527 +Sphere (API Object) 1911 +Raise (API Method) +CharacteristicModeTrace (API Object) 2992 +CustomDataSmithTrace (API Object) 3062 +CustomDataTrace (API Object) 3075 +ExcitationSmithTrace (API Object) 3141 +ExcitationTrace (API Object) 3150 +FarFieldPowerIntegralTrace (API Object) 3193 +FarFieldTrace (API Object) 3215 +LoadSmithTrace (API Object) 3458 +LoadTrace (API Object) 3468 +MathTrace (API Object) 3484 +NearFieldPowerIntegralTrace (API Object) 3609 +NearFieldTrace (API Object) 3634 +NetworkTrace (API Object) 3651 +PowerTrace (API Object) 3704 +ReceivingAntennaTrace (API Object) 3733 +ResultArrow (API Object) 3752 +ResultTextBox (API Object) 3771 +ResultTrace (API Object) 3778 +SARTrace (API Object) 3794 +SParameterTrace (API Object) 3821 +SpiceProbeTrace (API Object) 3941 +TRCoefficientTrace (API Object) 4007 +WireCurrentsTrace (API Object) 4098 +RandomNumberGenerationOption (API Property) +OptimisationSearchAdvancedSettings (API Object) 1486 +Range (API Property) +AngularGraphAxis (API Object) 2927 +HorizontalGraphAxis (API Object) 3376 +HorizontalSurfaceGraphAxis (API Object) 3378 +RadialGraphAxis (API Object) 3711 +VerticalGraphAxis (API Object) 4033 +VerticalSurfaceGraphAxis (API Object) 4036 +RangeSelection (API Property) +BasisFunctionGlobalSolverSettings (API Object) 154 +BasisFunctionLocalSolverSettings (API Object) 158 +RangeType (API Property) +Frequency (API Object) 819 +Rational (API StaticFunction) +Interpolator (API Object) 3391, 3392 +Ray3DPlot (API Object) 3712 +RayCollection (API Collection) 4202 +RayContributionsFacetedUTD (API Object) 1698 +RayContributionsFacetedUTD (API Property) +HighFrequencySettings (API Object) 948 +RayContributionsFacetedUTDList (API Object) 1701 +RayContributionsRLGO (API Object) 1703 +RayContributionsRLGO (API Property) +HighFrequencySettings (API Object) 948 +RayContributionsRLGOList (API Object) 1704 +RayContributionsUTD (API Object) 1706 +RayContributionsUTD (API Property) +HighFrequencySettings (API Object) 948 +RayContributionsUTDList (API Object) 1709 +RayData (API Object) 3716 +RayFieldType (API Property) +RaysQuantity (API Object) 3722 +RayGroupsVisible (API Property) +Rays3DFormat (API Object) 3719 +Rays (API Collection) +SolutionConfiguration (API Object) 3846 +Rays3DFormat (API Object) 3718 +RaysQuantity (API Object) 3721 +RaysSelected (API Property) +RaysQuantity (API Object) 3722 +RayTraceSymmetryEnabled (API Property) +HighFrequencySettings (API Object) 948 +re (API Property) +Complex (API Object) 317, 2997 +ComplexMatrix (API Object) 3017 +Re (API Property) +ComplexMatrix (API Object) 3016 +Matrix (API Object) 3494 +ReactanceAxisFont (API Property) +SmithChart (API Object) 3833 +ReactanceLine (API Property) +SmithChartGrid (API Object) 3839 +ReadFromLine (API Property) +NearFieldDataFileStructure (API Object) 1333 +ReadMatFile (API Function) +MatIO (API Object) 4308, 4308 +ReadMatFileStructure (API Function) +MatIO (API Object) 4308 +ReadMatFileToTable (API Function) +MatIO (API Object) 4308 +Real (API Method) +Complex (API Object) 319, 2999 +ComplexMatrix (API Object) 3019 +Matrix (API Object) 3497 +Real (API StaticFunction) +Complex (API Object) 326, 327, 3007, 3007 +ComplexMatrix (API Object) 3036 +RealPermittivityVariation (API Property) +DielectricModelling (API Object) 475 +RealTimeDuration (API Property) +View3DAnimationFormat (API Object) 4045 +Rearrange (API Method) +CableBundleCrossSection (API Object) 192, 192 +RearrangeCrossSections (API Method) +CableHarness (API Object) 218 +ReassociateModel (API Method) +Model (API Object) 3579 +Rebuild (API Property) +GeometryCollection (API Collection) 2432 +ReceivingAntennaCollection (API Collection) 4205 +ReceivingAntennaData (API Object) 3724 +ReceivingAntennaOptimisationGoal (API Object) 1711 +ReceivingAntennaQuantity (API Object) 3727 +ReceivingAntennas (API Collection) +SolutionConfiguration (API Object) 3846 +ReceivingAntennasVisible (API Property) +View3DSolutionEntityFormat (API Object) 4058 +ReceivingAntennaTrace (API Object) 3729 +Rectangle (API Object) 1715 +Redo (API Method) +Application (API Object) 2935 +ReduceAndTrimBGeometryEnabled (API Property) +SimplifyPartRepresentationSettings (API Object) 1860 +ReferenceDirection (API Object) 1724 +ReferenceDirectionList (API Object) 1726 +ReferenceDirectionRotation (API Property) +WaveguidePort (API Object) 2243 +ReferencedWorkplane (API Property) +LocalWorkplane (API Object) 1078 +ReferenceFace (API Property) +WorkSurface (API Object) 2269 +ReferenceImpedance (API Property) +CustomSmithTraceQuantity (API Object) 3081 +ImpedanceOptimisationGoal (API Object) 965 +SourceCoaxial (API Object) 3852 +SourceCurrentRegion (API Object) 3857 +SourceMagneticFrill (API Object) 3874 +SourceVoltageCable (API Object) 3899 +SourceVoltageEdge (API Object) 3905 +SourceVoltageNetwork (API Object) 3910 +SourceVoltageSegment (API Object) 3915 +SourceVoltageVertex (API Object) 3920 +ReferenceImpedanceExpression (API Property) +ExcitationQuantity (API Object) 3131 +ExcitationSmithQuantity (API Object) 3134 +LoadSmithQuantity (API Object) 3452 +ReferencePointType (API Property) +NearFieldReceivingAntenna (API Object) 1357 +NearFieldSource (API Object) 1364 +ReferenceVector (API Property) +CablePath (API Object) 229 +UnitCell (API Object) 2168 +WaveguideMeshPort (API Object) 2233 +WaveguidePort (API Object) 2243 +ReferenceWorkplane (API Property) +MeshTetrahedronRegion (API Object) 1230 +Region (API Object) 1731 +RefinementFactor (API Property) +MeshAdvancedSettings (API Object) 1147 +Refresh (API Method) +FormDataSelector (API Object) 3247 +ImportSet (API Object) 3386 +Region (API Object) 1728 +RegionCollection (API Collection) 2616 +Regions (API Collection) +AbstractSurfaceCurve (API Object) 100 +AnalyticalCurve (API Object) 123 +BezierCurve (API Object) 164 +Cone (API Object) 354 +ConstrainedSurface (API Object) 368 +Cross (API Object) 381 +Cuboid (API Object) 394 +Cylinder (API Object) 426 +Ellipse (API Object) 515 +EllipticArc (API Object) 528 +FittedSpline (API Object) 683 +Flare (API Object) 693 +Geometry (API Object) 869 +Helix (API Object) 929 +Hexagon (API Object) 937 +HyperbolicArc (API Object) 958 +ImprintPoints (API Object) 985 +Intersect (API Object) 1003 +Line (API Object) 1045 +Loft (API Object) 1086 +NurbsSurface (API Object) 1390 +OpenRing (API Object) 1438 +ParabolicArc (API Object) 1528 +Paraboloid (API Object) 1536 +PathSweep (API Object) 1563 +Polygon (API Object) 1634 +Polyline (API Object) 1642 +Primitive (API Object) 1675 +ProjectGeometry (API Object) 1684 +Rectangle (API Object) 1719 +RepairAndSewFaces (API Object) 1743 +RepairPart (API Object) 1757 +Ring (API Object) 1776 +Simplify (API Object) 1845 +Sphere (API Object) 1912 +Spin (API Object) 1961 +SpiralCross (API Object) 1970 +Split (API Object) 1984 +SplitRing (API Object) 1992 +Stitch (API Object) 2010 +StripCross (API Object) 2019 +StripHexagon (API Object) 2032 +Subtract (API Object) 2043 +SurfaceBezierCurve (API Object) 2052 +SurfaceLine (API Object) 2068 +SurfaceRegularLines (API Object) 2078 +Sweep (API Object) 2087 +TCross (API Object) 2096 +Trifilar (API Object) 2144 +Union (API Object) 2162 +RegionSettings (API Property) +Simplify (API Object) 1844 +RegionType (API Property) +SAR (API Object) 1792 +Reject (API Method) +Form (API Object) 700, 3222 +Relation (API Property) +OptimisationConstraint (API Object) 1453 +RelativeHighFrequencyPermittivity (API Property) +DielectricModelling (API Object) 475 +RelativePermeability (API Property) +MagneticFrequencyPoint (API Object) 1106 +MagneticModelling (API Object) 1110 +Metal (API Object) 1255 +MetallicFrequencyPoint (API Object) 1258 +RelativePermittivity (API Property) +DielectricFrequencyPoint (API Object) 469 +DielectricModelling (API Object) 475 +PolderTensor (API Object) 1627 +RelativeStaticPermittivity (API Property) +DielectricModelling (API Object) 475 +RelaxationFrequency (API Property) +DielectricModelling (API Object) 476 +ReloadChangedFiles (API Method) +Application (API Object) 2935 +Remote (API Property) +FEKOLaunchOptions (API Object) 559, 3155 +Remove (API Method) +ADAPTFEKOLaunchOptionsList (API Object) 61 +AdvancedSolverSettingsList (API Object) 111 +AngularDimensionList (API Object) 128 +AnisotropicDielectricLayersList (API Object) 138 +AntennaArraySourceList (API Object) 142 +BasisFunctionGlobalSolverSettingsList (API Object) 156 +BasisFunctionLocalSolverSettingsList (API Object) 160 +CableBundleCableSpecificationList (API Object) 186 +CartesianDescriptionList (API Object) 289 +CartesianRequestPointsList (API Object) 294 +CartesianStructureList (API Object) 297 +CoaxialInsulationLayerList (API Object) 312 +ComplexTensorList (API Object) 337 +CompositeValueHierarchyList (API Object) 347 +ConicalRequestPointsList (API Object) 362 +ConstrainedSurfacePointList (API Object) 376 +CurrentsExportSettingsList (API Object) 408 +CylindricalDescriptionList (API Object) 441 +CylindricalRequestPointsList (API Object) 445 +CylindricalStructureList (API Object) 448 +CylindricalXRequestPointsList (API Object) 453 +CylindricalYRequestPointsList (API Object) 457 +DielectricFrequencyPointList (API Object) 471 +DielectricModellingList (API Object) 477 +DimensionList (API Object) 482 +DomainDecompositionSettingsList (API Object) 487 +ExpressionList (API Object) 538 +FarFieldAdvancedSettingsList (API Object) 627 +FarFieldExportSettingsList (API Object) 637 +FarFieldPBCSettingsList (API Object) 645 +FarFieldSphericalModeSettingsList (API Object) 663 +FDTDBoundarySettingsList (API Object) 549 +FDTDSettingsList (API Object) 551 +FEKOGPUOptionsList (API Object) 555 +FEKOLaunchOptionsList (API Object) 560 +FEKOParallelDiagnosticTestsList (API Object) 565 +FEKOParallelExecutionOptionsList (API Object) 569 +FEKORemoteExecutionOptionsList (API Object) 573 +FEMSettingsList (API Object) 607 +FileReferenceList (API Object) 671 +Form (API Object) 700, 3222 +FormGroupBox (API Object) 742, 3275 +FormLayout (API Object) 771, 3304 +FormScrollArea (API Object) 798, 3336 +FrequencyAdvancedSettingsList (API Object) 824 +FrequencyContinuousQuantitiesList (API Object) 829 +FrequencyContinuousSettingsList (API Object) 834 +FrequencyExportSettingsList (API Object) 838 +FrequencyFDTDSettingsList (API Object) 843 +FundamentalModeOptionsList (API Object) 847 +GeneralSolverSettingsList (API Object) 859 +GlobalCoordinatesList (API Object) 893 +GlobalOriginList (API Object) 901 +GlobalPlaneList (API Object) 905 +GlobalVectorList (API Object) 909 +HighFrequencySettingsList (API Object) 952 +IntegralEquationList (API Object) 997 +IsotropicDielectricLayersList (API Object) 1010 +IterativeSolverSettingsList (API Object) 1015 +LocalCoordinateList (API Object) 1065 +LocalInternalCoordinateList (API Object) 1070 +LocalWorkplaneList (API Object) 1080 +MagneticFrequencyPointList (API Object) 1108 +MagneticModellingList (API Object) 1111 +ManuallySpecifiedOrDerivedValueList (API Object) 1119 +MeshAdvancedSettingsList (API Object) 1150 +MetallicFrequencyPointList (API Object) 1260 +MLFMMACASettingsList (API Object) 1093 +MLFMMSolverSettingsList (API Object) 1098 +NearFieldAdvancedSettingsList (API Object) 1324 +NearFieldBoundarySurfaceList (API Object) 1329 +NearFieldExportSettingsList (API Object) 1348 +NormalDimensionList (API Object) 1375 +NurbsControlPointList (API Object) 1382 +ObjectReferenceList (API Object) 1430 +OPTFEKOLaunchOptionsList (API Object) 1398 +OptimisationConstraintList (API Object) 1455 +OptimisationGoalProcessingStepsList (API Object) 1467 +OptimisationMaskValuesList (API Object) 1474 +OptimisationVariableList (API Object) 1492 +OutputFileSolverSettingsList (API Object) 1497 +ParametricComplexExpressionList (API Object) 1542 +ParametricExpressionList (API Object) 1557 +PeriodicBoundaryBeamSquintAngleList (API Object) 1584 +PeriodicBoundaryPhaseShiftList (API Object) 1588 +PlanarSubstrateList (API Object) 1592 +PointAngleRangeList (API Object) 1608 +PointRangeExpressionList (API Object) 1616 +PointRangeList (API Object) 1617 +PolderTensorList (API Object) 1628 +PortPropertiesList (API Object) 1659 +PreconditionerSettingsList (API Object) 1671 +PREFEKOLaunchOptionsList (API Object) 1518 +PREFEKOVariableExportOptionsList (API Object) 1522 +RayContributionsFacetedUTDList (API Object) 1702 +RayContributionsRLGOList (API Object) 1705 +RayContributionsUTDList (API Object) 1710 +ReferenceDirectionList (API Object) 1726 +RLGOFaceAbsorbingSettingsList (API Object) 1697 +ScopeSettingsList (API Object) 1825 +ShieldLayerSettingsList (API Object) 1838 +SimplifyEdgeSettingsList (API Object) 1852 +SimplifyFaceSettingsList (API Object) 1855 +SimplifyPointSettingsList (API Object) 1865 +SimplifyRegionSettingsList (API Object) 1868 +SpecifiedRequestPointsList (API Object) 1906 +SphericalDescriptionList (API Object) 1918 +SphericalModeOptionsList (API Object) 1934 +SphericalRequestPointsList (API Object) 1952 +SphericalStructureList (API Object) 1955 +SurfaceCoordinateList (API Object) 2058 +SurfaceImpedanceFrequencyPointList (API Object) 2063 +UnitCellLayerList (API Object) 2174 +UTDCylinderTerminationTypeList (API Object) 2154 +View3DAxesFormatList (API Object) 2190 +ViewDisplayModeList (API Object) 2194 +ViewRenderingOptionsList (API Object) 2199 +VoxelAdvancedSettingsList (API Object) 2220 +VoxelGridSummaryList (API Object) 2224 +WaveguideModeOptionsList (API Object) 2239 +WindscreenSolutionMethodList (API Object) 2256 +RemoveBetweenEqualDielectricRegions (API Property) +SimplifyFaceSettings (API Object) 1854 +RemoveBetweenEqualMetalRegions (API Property) +SimplifyFaceSettings (API Object) 1854 +RemoveBetweenShellRegions (API Property) +SimplifyFaceSettings (API Object) 1854 +RemoveDiscontinuitiesEnabled (API Property) +RepairPartsSettings (API Object) 1763 +RemoveGashesEnabled (API Property) +RemoveSmallFeaturesSettings (API Object) 1736 +RemoveInDielectricRegions (API Property) +SimplifyEdgeSettings (API Object) 1850 +RemoveInMetalRegions (API Property) +SimplifyEdgeSettings (API Object) 1850 +RemoveOnDielectricFaces (API Property) +SimplifyEdgeSettings (API Object) 1850 +RemoveOnMetalFaces (API Property) +SimplifyEdgeSettings (API Object) 1850 +RemoveRedundant (API Property) +SimplifyPointSettings (API Object) 1863 +RemoveSelfIntersectionsEnabled (API Property) +RepairPartsSettings (API Object) 1763 +RemoveSliverFacesEnabled (API Property) +RemoveSmallFeaturesSettings (API Object) 1736 +RemoveSmallEdgesEnabled (API Property) +RemoveSmallFeaturesSettings (API Object) 1736 +RepairPartsSettings (API Object) 1764 +RemoveSmallFacesEnabled (API Property) +RemoveSmallFeaturesSettings (API Object) 1736 +RemoveSmallFeatures (API Method) +GeometryRepair (API Object) 889 +RemoveSmallFeaturesSettings (API Object) 1734 +RemoveSmallFeaturesSettings (API Property) +GeometryRepair (API Object) 887 +RemoveSpikesEnabled (API Property) +RemoveSmallFeaturesSettings (API Object) 1736 +Repair (API Property) +GeometryCollection (API Collection) 2432 +RepairAndSewFaces (API Method) +GeometryRepair (API Object) 889 +RepairAndSewFaces (API Object) 1739 +RepairAndSewFacesSettings (API Object) 1747 +RepairAndSewFacesSettings (API Property) +GeometryRepair (API Object) 888 +RepairBadFaceFaceErrorsEnabled (API Property) +RepairPartsSettings (API Object) 1764 +RepairEdges (API Method) +GeometryRepair (API Object) 889 +RepairEdgesSettings (API Object) 1750 +RepairEdgesSettings (API Property) +GeometryRepair (API Object) 888 +RepairPart (API Object) 1753 +RepairParts (API Method) +GeometryRepair (API Object) 889 +RepairPartsSettings (API Object) 1761 +RepairPartsSettings (API Property) +GeometryRepair (API Object) 888 +RepairTolerantEdgesEnabled (API Property) +RemoveSmallFeaturesSettings (API Object) 1737 +REPEAT loop +Lua 16 +Replace (API Method) +MediaLibrary (API Collection) 2503 +Mesh (API Object) 1143 +ReplaceMissingGeometryEnabled (API Property) +RepairAndSewFacesSettings (API Object) 1748 +ReplaceSubMatrix (API Method) +ComplexMatrix (API Object) 3020 +Matrix (API Object) 3497 +report generation +PDF 24 +ReportImageSizeSetting (API Object) 3735 +ReportPageOptions (API Property) +QuickReport (API Object) 3708 +Reports (API Collection) +Application (API Object) 2932 +ReportsCollection (API Collection) 4210 +ReportTemplate (API Object) 3737 +ReportTemplateTagCollection (API Collection) 4208 +ReportTemplateTagSettings (API Object) 3742 +RequestPoints (API Property) +FarField3DPlot (API Object) 3169 +NearField3DPlot (API Object) 3587 +RequestPoints3DFormat (API Object) 3744 +RequestType (API Property) +FarFieldAdvancedSettings (API Object) 624 +Resample (API Method) +Interpolator (API Object) 3391, 3391 +Reset (API Method) +FormProgressDialog (API Object) 781, 3319 +ResetSize (API Method) +FormImage (API Object) 748, 3281 +Resistance (API Property) +Load (API Object) 1059 +Resistor (API Object) 1769 +ResistanceAxisFont (API Property) +SmithChart (API Object) 3833 +ResistanceEnabled (API Property) +Load (API Object) 1060 +ResistanceLine (API Property) +SmithChartGrid (API Object) 3839 +Resistor (API Object) 1767 +Resize (API Method) +Form (API Object) 700, 3222 +Resolution (API Property) +SurfacePlotSamplingFormat (API Object) 3991 +TraceSamplingFormat (API Object) 4025 +RestartFromRunNumber (API Property) +OPTFEKOLaunchOptions (API Object) 1395, 3656 +RestartRunEnabled (API Property) +OPTFEKOLaunchOptions (API Object) 1395, 3656 +Restore (API Method) +CartesianGraph (API Object) 2960 +CartesianSurfaceGraph (API Object) 2972 +Graph (API Object) 3359 +MdiSubWindow (API Object) 1123 +PolarGraph (API Object) 3680 +SmithChart (API Object) 3836 +SurfaceGraph (API Object) 3964 +View (API Object) 4043 +Window (API Object) 4074 +RestoreDefaults (API Method) +CFXModelImportSettings (API Object) 179 +ComponentLaunchOptions (API Object) 3042 +FillHoleSettings (API Object) 675 +RemoveSmallFeaturesSettings (API Object) 1737 +RepairAndSewFacesSettings (API Object) 1749 +RepairEdgesSettings (API Object) 1752 +RepairPartsSettings (API Object) 1766 +SimplifyPartRepresentationSettings (API Object) 1861 +result +modify 27 +result script 26 +Result3DPlot (API Object) 3746 +Result3DPlotCollection (API Collection) 4214 +ResultAnnotationCollection (API Collection) 4218 +ResultArrow (API Object) 3749 +ResultArrowCollection (API Collection) 4231 +ResultData (API Object) 3753 +ResultPlot (API Object) 3758 +ResultReport (API Object) 3760 +ResultSurfacePlot (API Object) 3762 +ResultSurfacePlotCollection (API Collection) 4236 +ResultTextBox (API Object) 3766 +ResultTextBoxCollection (API Collection) 4240 +ResultTrace (API Object) 3772 +ResultTraceCollection (API Collection) 4245 +Reversed (API Property) +Loft (API Object) 1086 +ReversedOrder (API Property) +HorizontalGraphAxis (API Object) 3376 +HorizontalSurfaceGraphAxis (API Object) 3378 +VerticalGraphAxis (API Object) 4034 +VerticalSurfaceGraphAxis (API Object) 4036 +ReverseElementNormals (API Method) +MeshCurvilinearTriangleFace (API Object) 1164 +MeshPlate (API Object) 1202 +MeshTriangleFace (API Object) 1237 +ReverseFaceNormal (API Method) +Polygon (API Object) 1636 +ReverseFaceNormals (API Method) +AbstractSurfaceCurve (API Object) 102, 102 +AnalyticalCurve (API Object) 126, 126 +BezierCurve (API Object) 167, 167 +Cone (API Object) 357, 357 +ConstrainedSurface (API Object) 371, 371 +Cross (API Object) 384, 384 +Cuboid (API Object) 396, 396 +Cylinder (API Object) 428, 428 +Ellipse (API Object) 518, 518 +EllipticArc (API Object) 531, 531 +FittedSpline (API Object) 685, 685 +Flare (API Object) 696, 696 +Geometry (API Object) 872, 872 +Helix (API Object) 931, 931 +Hexagon (API Object) 940, 940 +HyperbolicArc (API Object) 960, 960 +ImprintPoints (API Object) 988, 988 +Intersect (API Object) 1006, 1006 +Line (API Object) 1048, 1048 +Loft (API Object) 1089, 1089 +NurbsSurface (API Object) 1392, 1392 +OpenRing (API Object) 1440, 1440 +ParabolicArc (API Object) 1530, 1531 +Paraboloid (API Object) 1539, 1539 +PathSweep (API Object) 1566, 1566 +Polygon (API Object) 1636, 1636 +Polyline (API Object) 1644, 1644 +Primitive (API Object) 1678, 1678 +ProjectGeometry (API Object) 1687, 1687 +Rectangle (API Object) 1722, 1722 +RepairAndSewFaces (API Object) 1746, 1746 +RepairPart (API Object) 1760, 1760 +Ring (API Object) 1779, 1779 +Simplify (API Object) 1847, 1848 +Sphere (API Object) 1915, 1915 +Spin (API Object) 1964, 1964 +SpiralCross (API Object) 1973, 1973 +Split (API Object) 1987, 1987 +SplitRing (API Object) 1995, 1995 +Stitch (API Object) 2013, 2013 +StripCross (API Object) 2022, 2022 +StripHexagon (API Object) 2035, 2035 +Subtract (API Object) 2046, 2046 +SurfaceBezierCurve (API Object) 2054, 2054 +SurfaceLine (API Object) 2071, 2071 +SurfaceRegularLines (API Object) 2081, 2081 +Sweep (API Object) 2090, 2090 +TCross (API Object) 2099, 2099 +Trifilar (API Object) 2147, 2147 +Union (API Object) 2165, 2165 +Rho (API Property) +ConicalRequestPoints (API Object) 360 +CylindricalDescription (API Object) 439 +CylindricalRequestPoints (API Object) 443 +CylindricalXRequestPoints (API Object) 451 +CylindricalYRequestPoints (API Object) 455 +RhoStepSize (API Property) +DataSetMetaData (API Object) 3108 +RightVariable (API Property) +OptimisationConstraint (API Object) 1453 +Ring (API Object) 1772 +RingShape (API Object) 1781 +RLGOFaceAbsorbingSettings (API Object) 1694 +RLGOFaceAbsorbingSettingsList (API Object) 1696 +RLGOIncrementType (API Property) +HighFrequencySettings (API Object) 948 +Rotate (API Object) 1784 +RotateSchematicSymbol (API Method) +AbstractFEMLinePort (API Object) 72 +CableConnector (API Object) 204 +CableGeneralNetwork (API Object) 214 +CablePort (API Object) 239 +CableSchematicCurrentProbe (API Object) 252 +CableSchematicVoltageProbe (API Object) 256 +CableSpiceNetwork (API Object) 273 +Capacitor (API Object) 285 +ComplexLoad (API Object) 333 +EdgeMeshPort (API Object) 499 +EdgePort (API Object) 503 +FEMLineMeshPort (API Object) 580 +FEMLinePort (API Object) 588 +GeneralNetwork (API Object) 852 +Ground (API Object) 913 +Inductor (API Object) 993 +MicrostripMeshPort (API Object) 1264 +MicrostripPort (API Object) 1269 +Resistor (API Object) 1770 +Transformer (API Object) 2120 +TransmissionLine (API Object) 2131 +VoltageControlledVoltageSource (API Object) 2210 +WireMeshPort (API Object) 2260 +WirePort (API Object) 2266 +Rotation (API Property) +CableBundleCableSpecification (API Object) 184 +FundamentalModeOptions (API Object) 845 +PortProperties (API Object) 1657 +UnitCellLayer (API Object) 2171 +View3DFormat (API Object) 4051 +WaveguideModeOptions (API Object) 2236 +RotationN (API Property) +Mirror (API Object) 1273 +Split (API Object) 1983 +RotationU (API Property) +Mirror (API Object) 1273 +Split (API Object) 1983 +RotationV (API Property) +Mirror (API Object) 1273 +Split (API Object) 1983 +Rounded (API Property) +SurfaceGraphLegend (API Object) 3978 +View3DLegendRangeFormat (API Object) 4053 +Route (API Property) +CableInstance (API Object) 221 +rowCount (API Method) +ParametricComplexExpressionTable (API Object) 1544 +RowCount (API Method) +ExpressionTable (API Object) 541 +NurbsControlPointTable (API Object) 1385 +ObjectReferenceTable (API Object) 1432 +PointExpressionTable (API Object) 1611 +RowCount (API Property) +ComplexMatrix (API Object) 3016 +Matrix (API Object) 3494 +Run (API Method) +CustomMathScript (API Object) 3079 +ExcitationMathScript (API Object) 3128 +FarFieldMathScript (API Object) 3182 +Form (API Object) 700, 3222 +FormFileBrowser (API Object) 730, 3263 +FormFileSaveAsBrowser (API Object) 736, 3269 +Launcher (API Object) 1027, 1027 +LoadMathScript (API Object) 3436 +MathScript (API Object) 3479 +NearFieldMathScript (API Object) 3598 +NetworkMathScript (API Object) 3642 +PowerMathScript (API Object) 3693 +SParameterMathScript (API Object) 3803 +SurfaceCurrentsMathScript (API Object) 3957 +TRCoefficientMathScript (API Object) 3998 +WireCurrentsMathScript (API Object) 4088 +Run (API StaticFunction) +Launcher (API Object) 3403, 3404 +RunCADFEKO (API Method) +Launcher (API Object) 1027, 3402 +RunEDITFEKO (API Method) +Launcher (API Object) 1027, 3402 +RunFEKO (API Method) +Launcher (API Object) 1027, 3403 +RunOPTFEKO (API Method) +Launcher (API Object) 1027, 3403 +RunPOSTFEKO (API Method) +Launcher (API Object) 1027, 3403 +RunPREFEKO (API Method) +Launcher (API Object) 1028, 3403 +SampleEdgesEnabled (API Property) +NearFieldDataFileStructure (API Object) 1333 +SampleOnEdgesEnabled (API Property) +NearField (API Object) 1316 +Sampling (API Property) +CharacteristicModeTrace (API Object) 2990 +CustomDataSmithTrace (API Object) 3060 +CustomDataSurfacePlot (API Object) 3067 +CustomDataTrace (API Object) 3074 +ExcitationSmithTrace (API Object) 3139 +ExcitationTrace (API Object) 3149 +FarField3DPlot (API Object) 3169 +FarFieldPowerIntegralTrace (API Object) 3192 +FarFieldSurfacePlot (API Object) 3207 +FarFieldTrace (API Object) 3214 +LoadSmithTrace (API Object) 3456 +LoadTrace (API Object) 3467 +MathTrace (API Object) 3483 +NearFieldPowerIntegralTrace (API Object) 3607 +NearFieldSurfacePlot (API Object) 3624 +NearFieldTrace (API Object) 3632 +NetworkTrace (API Object) 3650 +PowerTrace (API Object) 3703 +ReceivingAntennaTrace (API Object) 3732 +ResultSurfacePlot (API Object) 3764 +ResultTrace (API Object) 3777 +SARTrace (API Object) 3792 +SParameterSurfacePlot (API Object) 3813 +SParameterTrace (API Object) 3820 +SpiceProbeTrace (API Object) 3940 +TRCoefficientTrace (API Object) 4006 +WireCurrentsTrace (API Object) 4096 +SamplingPointDensityOption (API Property) +CablePath (API Object) 229 +SAR (API Collection) +SolutionConfiguration (API Object) 3846 +StandardConfiguration (API Object) 2004 +SAR (API Object) 1790 +SAR3DPlot (API Object) 3779 +SARCollection (API Collection) 2621, 4249 +SARData (API Object) 3782 +SAROptimisationGoal (API Object) 1794 +SARQuantity (API Object) 3785 +SARStoredData (API Object) 3786 +SARTrace (API Object) 3789 +SaturationMagnetisation (API Property) +PolderTensor (API Object) 1627 +Save (API Method) +Application (API Object) 146, 2935 +SaveAs (API Method) +Application (API Object) 147, 2935 +Scale (API Object) 1810 +Scale (API Property) +IndependentAxisFormat (API Object) 3387 +ScaledByMagnitude (API Property) +View3DSourceFormat (API Object) 4061 +ScaledToCommonQuantity (API Property) +View3DLegendRangeFormat (API Object) 4054 +ScaledToPeakInstantaneousValues (API Property) +View3DLegendRangeFormat (API Object) 4054 +ScaledToSelectedDimensions (API Property) +View3DLegendRangeFormat (API Object) 4054 +ScaledToSelectedFrequency (API Property) +View3DLegendRangeFormat (API Object) 4054 +ScaledToSelectedTimeStep (API Property) +View3DLegendRangeFormat (API Object) 4054 +ScaledToVectorMagnitude (API Property) +View3DLegendRangeFormat (API Object) 4054 +ScaleFactor (API Property) +MeshImporter (API Object) 1184 +PathSweep (API Object) 1562 +ScaleSettings (API Property) +Power (API Object) 1661 +ScaleToMetreEnabled (API Property) +MeshExporter (API Object) 1173 +ScaleType (API Property) +View3DSourceFormat (API Object) 4060 +Schematic (API Object) 1815 +Schematic (API Property) +AbstractFEMLinePort (API Object) 69 +CableConnector (API Object) 203 +CableGeneralNetwork (API Object) 213 +CablePort (API Object) 238 +CableSchematicCurrentProbe (API Object) 251 +CableSchematicVoltageProbe (API Object) 255 +CableSpiceNetwork (API Object) 271 +Capacitor (API Object) 284 +ComplexLoad (API Object) 332 +EdgeMeshPort (API Object) 497 +EdgePort (API Object) 502 +FEMLineMeshPort (API Object) 577 +FEMLinePort (API Object) 585 +GeneralNetwork (API Object) 851 +Ground (API Object) 912 +Inductor (API Object) 992 +MicrostripMeshPort (API Object) 1263 +MicrostripPort (API Object) 1268 +Resistor (API Object) 1769 +Transformer (API Object) 2119 +TransmissionLine (API Object) 2129 +VoltageControlledVoltageSource (API Object) 2209 +WireMeshPort (API Object) 2259 +WirePort (API Object) 2264 +SchematicItems (API Property) +Schematic (API Object) 1817 +SchematicLocation (API Property) +AbstractFEMLinePort (API Object) 69 +CableConnector (API Object) 203 +CableGeneralNetwork (API Object) 213 +CablePort (API Object) 238 +CableSchematicCurrentProbe (API Object) 251 +CableSchematicVoltageProbe (API Object) 255 +CableSpiceNetwork (API Object) 271 +Capacitor (API Object) 284 +ComplexLoad (API Object) 332 +EdgeMeshPort (API Object) 498 +EdgePort (API Object) 502 +FEMLineMeshPort (API Object) 577 +FEMLinePort (API Object) 585 +GeneralNetwork (API Object) 851 +Ground (API Object) 912 +Inductor (API Object) 992 +MicrostripMeshPort (API Object) 1263 +MicrostripPort (API Object) 1268 +Resistor (API Object) 1769 +Transformer (API Object) 2119 +TransmissionLine (API Object) 2129 +VoltageControlledVoltageSource (API Object) 2209 +WireMeshPort (API Object) 2259 +WirePort (API Object) 2265 +SchematicRotation (API Property) +AbstractFEMLinePort (API Object) 69 +CableConnector (API Object) 203 +CableGeneralNetwork (API Object) 213 +CablePort (API Object) 238 +CableSchematicCurrentProbe (API Object) 252 +CableSchematicVoltageProbe (API Object) 256 +CableSpiceNetwork (API Object) 271 +Capacitor (API Object) 284 +ComplexLoad (API Object) 332 +EdgeMeshPort (API Object) 498 +EdgePort (API Object) 503 +FEMLineMeshPort (API Object) 577 +FEMLinePort (API Object) 585 +GeneralNetwork (API Object) 851 +Ground (API Object) 913 +Inductor (API Object) 992 +MicrostripMeshPort (API Object) 1263 +MicrostripPort (API Object) 1268 +Resistor (API Object) 1769 +Transformer (API Object) 2119 +TransmissionLine (API Object) 2129 +VoltageControlledVoltageSource (API Object) 2209 +WireMeshPort (API Object) 2259 +WirePort (API Object) 2265 +SchematicViewWindow (API Object) 1819 +ScopedEntities (API Property) +Currents (API Object) 403 +ErrorEstimation (API Object) 533 +ScopeSettings (API Object) 1824 +ScopeSettings (API Object) 1823 +ScopeSettings (API Property) +FarField (API Object) 619 +NearField (API Object) 1316 +ScopeSettingsList (API Object) 1825 +script +API 24 +types 24 +Script (API Property) +CustomMathScript (API Object) 3079 +ExcitationMathScript (API Object) 3127 +FarFieldMathScript (API Object) 3181 +LoadMathScript (API Object) 3435 +MathScript (API Object) 3479 +NearFieldMathScript (API Object) 3597 +NetworkMathScript (API Object) 3641 +PowerMathScript (API Object) 3692 +SParameterMathScript (API Object) 3802 +SurfaceCurrentsMathScript (API Object) 3956 +TRCoefficientMathScript (API Object) 3997 +WireCurrentsMathScript (API Object) 4087 +scripting +basics 14 +SearchActive (API Property) +OptimisationSearch (API Object) 1483 +Searches (API Collection) +Optimisation (API Object) 1447 +SecondVector (API Property) +PeriodicBoundaryPhaseShift (API Object) 1586 +SeedValue (API Property) +OptimisationSearchAdvancedSettings (API Object) 1487 +SegmentCount (API Property) +MeshInfo (API Object) 1194 +ModelMeshInfo (API Object) 1300 +SimulationMeshInfo (API Object) 1876 +SegmentImportingEnabled (API Property) +MeshImporter (API Object) 1184 +SegmentLength (API Property) +MeshImporter (API Object) 1184 +Segments (API Property) +MeshSegmentWire (API Object) 3552 +MeshWiresFormat (API Object) 3573 +SegmentStandardDeviation (API Property) +MeshInfo (API Object) 1194 +ModelMeshInfo (API Object) 1300 +SimulationMeshInfo (API Object) 1876 +SegmentWires (API Collection) +Mesh (API Object) 3515 +SelectorType (API Property) +FormDataSelector (API Object) 3246 +SEMCADEnabled (API Property) +NearFieldExportSettings (API Object) 1346 +SessionName (API Property) +Application (API Object) 2930 +SessionPath (API Property) +Application (API Object) 2931 +Set (API Method) +ExpressionTable (API Object) 541 +NurbsControlPointTable (API Object) 1385 +ObjectReferenceTable (API Object) 1432 +ParametricComplexExpressionTable (API Object) 1544 +PointExpressionTable (API Object) 1611 +SetActive (API Method) +OptimisationSearch (API Object) 1484 +SetAsDefault (API Method) +Workplane (API Object) 2275 +SetCallBack (API Method) +FormCheckBox (API Object) 708, 3230 +FormComboBox (API Object) 713, 3235 +FormDataSelector (API Object) 3247 +FormDirectoryBrowser (API Object) 719, 3252 +FormDoubleSpinBox (API Object) 724, 3257 +FormFileBrowser (API Object) 730, 3263 +FormFileSaveAsBrowser (API Object) 736, 3269 +FormIntegerSpinBox (API Object) 753, 3286 +FormLabelledItem (API Object) 766, 3299 +FormLineEdit (API Object) 777, 3310 +FormPushButton (API Object) 786, 3324 +FormRadioButtonGroup (API Object) 792, 3330 +FormTree (API Object) 808, 3346 +SetDecimals (API Method) +FormDoubleSpinBox (API Object) 724, 3257 +SetDimensions (API Method) +ExpressionTable (API Object) 541 +NurbsControlPointTable (API Object) 1385 +ObjectReferenceTable (API Object) 1432 +ParametricComplexExpressionTable (API Object) 1544 +PointExpressionTable (API Object) 1611 +SetExpressions (API Method) +VariableCollection (API Collection) 2689 +SetFilter (API Method) +FormFileBrowser (API Object) 730, 3263 +FormFileSaveAsBrowser (API Object) 736, 3269 +SetFixedAxisValue (API Method) +CharacteristicModeTrace (API Object) 2992, 2992 +CustomData3DPlot (API Object) 3053, 3054 +CustomDataSmithTrace (API Object) 3062, 3062 +CustomDataSurfacePlot (API Object) 3068, 3069 +CustomDataTrace (API Object) 3075, 3076 +ErrorEstimate3DPlot (API Object) 3116, 3116 +ExcitationSmithTrace (API Object) 3141, 3142 +FarField3DPlot (API Object) 3171, 3171 +FarFieldPowerIntegralTrace (API Object) 3193 +FarFieldSurfacePlot (API Object) 3209, 3209 +FarFieldTrace (API Object) 3215, 3216 +LoadSmithTrace (API Object) 3458, 3459 +LoadTrace (API Object) 3468, 3469 +NearField3DPlot (API Object) 3588, 3589 +NearFieldPowerIntegralTrace (API Object) 3609 +NearFieldSurfacePlot (API Object) 3626, 3626 +NearFieldTrace (API Object) 3634, 3634, 3635 +NetworkTrace (API Object) 3651, 3652 +PowerTrace (API Object) 3704, 3705 +SARTrace (API Object) 3794 +SParameterSurfacePlot (API Object) 3814 +SParameterTrace (API Object) 3821 +SurfaceCurrents3DPlot (API Object) 3947, 3947 +TRCoefficientTrace (API Object) 4007, 4008, 4008 +WireCurrents3DPlot (API Object) 4079, 4079 +WireCurrentsTrace (API Object) 4098, 4098 +SetFrequencyGlobal (API Method) +SolutionConfigurationCollection (API Collection) 2643 +SetFrequencyPerConfiguration (API Method) +SolutionConfigurationCollection (API Collection) 2643 +SetLoadsGlobal (API Method) +SolutionConfigurationCollection (API Collection) 2643 +SetLoadsPerConfiguration (API Method) +SolutionConfigurationCollection (API Collection) 2643 +SetMaximum (API Method) +FormDoubleSpinBox (API Object) 724, 3257 +FormIntegerSpinBox (API Object) 753, 3286 +SetMinimum (API Method) +FormDoubleSpinBox (API Object) 724, 3257 +FormIntegerSpinBox (API Object) 753, 3286 +SetOneDimension (API Method) +PeriodicBoundary (API Object) 1579 +SetPageCaption (API Method) +QuickReport (API Object) 3708 +SetPageIncluded (API Method) +QuickReport (API Object) 3708 +SetPageTitle (API Method) +QuickReport (API Object) 3708 +SetPins (API Method) +CableConnectorPinCollection (API Collection) 2302 +SetPosition (API Method) +CartesianGraph (API Object) 2960 +CartesianSurfaceGraph (API Object) 2972 +Graph (API Object) 3359 +MdiSubWindow (API Object) 1123 +NamedPoint (API Object) 1310 +PolarGraph (API Object) 3680 +SmithChart (API Object) 3837 +SurfaceGraph (API Object) 3964 +View (API Object) 4043 +Window (API Object) 4074 +SetPowerGlobal (API Method) +SolutionConfigurationCollection (API Collection) 2643 +SetPowerPerConfiguration (API Method) +SolutionConfigurationCollection (API Collection) 2643 +SetProperties 17 +SetProperties (API Method) +AbstractAntennaArray (API Object) 66 +AbstractFEMLinePort (API Object) 72 +AbstractIdealSource (API Object) 77 +AbstractMeshEdge (API Object) 79 +AbstractMeshPort (API Object) 82 +AbstractMeshTriangleFace (API Object) 85 +AbstractMeshWire (API Object) 88 +AbstractPointSource (API Object) 95 +AbstractSurfaceCurve (API Object) 102 +AdaptiveRefinement (API Object) 108 +Align (API Object) 116 +AnalyticalCurve (API Object) 126 +AnisotropicDielectric (API Object) 133 +AnisotropicDielectricCollection (API Collection) 2285 +AntennaArrayCollection (API Collection) 2293 +Application (API Object) 147 +BandwidthAnnotation (API Object) 2946 +BaseFieldReceivingAntenna (API Object) 152 +BeamwidthAnnotation (API Object) 2951 +BezierCurve (API Object) 167 +CableBundleCrossSection (API Object) 192 +CableCoaxialCrossSection (API Object) 199 +CableConnector (API Object) 204 +CableConnectorCollection (API Collection) 2298 +CableConnectorPin (API Object) 207 +CableConnectorPinCollection (API Collection) 2302 +CableCrossSection (API Object) 210 +CableCrossSectionCollection (API Collection) 2314 +CableGeneralNetwork (API Object) 214 +CableHarness (API Object) 218 +CableHarnessCollection (API Collection) 2318 +CableInstance (API Object) 222 +CableInstanceCollection (API Collection) 2322 +CableNonConductingElementCrossSection (API Object) 225 +CablePath (API Object) 232 +CablePathCollection (API Collection) 2327 +CablePathTerminal (API Object) 235 +CablePort (API Object) 239 +CableProbe (API Object) 244 +CableProbeCollection (API Collection) 2331 +CableRibbonCrossSection (API Object) 248 +Cables (API Object) 281 +CableSchematicComponentCollection (API Collection) 2344 +CableSchematicCurrentProbe (API Object) 252 +CableSchematicVoltageProbe (API Object) 256 +CableShield (API Object) 261 +CableShieldCollection (API Collection) 2351 +CableSignal (API Object) 264 +CableSignalCollection (API Collection) 2354 +CableSingleConductorCrossSection (API Object) 268 +CableSpiceNetwork (API Object) 273 +CableTwistedPairCrossSection (API Object) 277 +Capacitor (API Object) 285 +CartesianGraph (API Object) 2960 +CartesianSurfaceGraph (API Object) 2972 +CFXModelImporter (API Object) 182 +CFXModelImportSettings (API Object) 179 +CharacterisedSurface (API Object) 301 +CharacterisedSurfaceCollection (API Collection) 2359 +CharacteristicModes (API Object) 304 +CharacteristicModesConfiguration (API Object) 308 +CharacteristicModeTrace (API Object) 2992 +CollectionOf_DomainEntity (API Collection) 2362 +CollectionOf_Mesh (API Collection) 2365 +ComplexLoad (API Object) 333 +ComponentLaunchOptions (API Object) 342, 3042 +Cone (API Object) 357 +ConstrainedSurface (API Object) 371 +Cross (API Object) 384 +CrossShape (API Object) 388 +Cuboid (API Object) 396 +Currents (API Object) 404 +CurrentsCollection (API Collection) 2369 +CurrentSource (API Object) 400 +CustomAntennaArray (API Object) 414 +CustomData3DPlot (API Object) 3054 +CustomDataSmithTrace (API Object) 3063 +CustomDataSurfacePlot (API Object) 3069 +CustomDataTrace (API Object) 3076 +Cutplane (API Object) 420 +CutplaneCollection (API Collection) 2373 +Cylinder (API Object) 428 +CylindricalAntennaArray (API Object) 436 +DefaultMedium (API Object) 460 +Dielectric (API Object) 464 +DielectricBoundaryMedium (API Object) 467 +DielectricCollection (API Collection) 2377 +Edge (API Object) 494 +EdgeCollection (API Collection) 2382 +EdgeMeshPort (API Object) 499 +EdgePort (API Object) 503 +ElectricDipole (API Object) 510 +Ellipse (API Object) 518 +EllipseShape (API Object) 521 +EllipticArc (API Object) 531 +ErrorEstimate3DPlot (API Object) 3117 +ErrorEstimation (API Object) 534 +ErrorEstimationCollection (API Collection) 2386 +ExcitationSmithTrace (API Object) 3142 +ExcitationTrace (API Object) 3150 +Exporter (API Object) 537 +Face (API Object) 615 +FaceCollection (API Collection) 2391 +FarField (API Object) 622 +FarField3DPlot (API Object) 3171 +FarFieldCollection (API Collection) 2396 +FarFieldData (API Object) 633 +FarFieldOptimisationGoal (API Object) 642 +FarFieldPowerIntegralTrace (API Object) 3194 +FarFieldReceivingAntenna (API Object) 652 +FarFieldReceivingAntennaCollection (API Collection) 2401 +FarFieldSource (API Object) 658 +FarFieldSurfacePlot (API Object) 3209 +FarFieldTrace (API Object) 3216 +FDTDBoundaryConditions (API Object) 545 +FEMLineMeshPort (API Object) 580 +FEMLinePort (API Object) 588 +FEMModalMeshPort (API Object) 595 +FEMModalPort (API Object) 601 +FEMModalSource (API Object) 604 +FieldData (API Object) 668 +FieldDataCollection (API Collection) 2409 +FillHoleSettings (API Object) 675 +Find (API Object) 678 +FittedSpline (API Object) 685 +Flare (API Object) 696 +FreeSpace (API Object) 816 +Frequency (API Object) 820 +GeneralNetwork (API Object) 852 +Geometry (API Object) 872 +GeometryCollection (API Collection) 2467 +GeometryExporter (API Object) 877 +GeometryGroup (API Collection) 2478 +GeometryGroupCollection (API Collection) 2483 +GeometryImporter (API Object) 882 +GeometryRebuild (API Object) 885 +GeometryRepair (API Object) 890 +GlobalMeshSettings (API Object) 898 +Ground (API Object) 913 +GroundPlane (API Object) 918 +GroundPlaneMedium (API Object) 922 +Helix (API Object) 931 +Hexagon (API Object) 940 +HexagonShape (API Object) 943 +HyperbolicArc (API Object) 961 +ImpedanceOptimisationGoal (API Object) 965 +ImpedanceSheet (API Object) 970 +ImpedanceSheetCollection (API Collection) 2487 +ImplicitPointsAnnotation (API Object) 3382 +Importer (API Object) 973 +ImpressedCurrent (API Object) 980 +ImprintPoints (API Object) 988 +Inductor (API Object) 993 +InterpolatorSettings (API Object) 3394 +Intersect (API Object) 1006 +KBL (API Object) 1017 +Launcher (API Object) 1028 +LaunchResult (API Object) 1021 +LayeredAnisotropicDielectric (API Object) 1031 +LayeredDielectric (API Object) 1034 +LayeredDielectricCollection (API Collection) 2493 +LayeredIsotropicDielectric (API Object) 1037 +LibraryMedium (API Object) 1040 +Line (API Object) 1048 +LinearPlanarArray (API Object) 1055 +Load (API Object) 1060 +LoadCollection (API Collection) 2499 +LoadSmithTrace (API Object) 3459 +LoadTrace (API Object) 3469 +LocalMeshSettings (API Object) 1074 +Loft (API Object) 1089 +MagneticDipole (API Object) 1104 +MainWindow (API Object) 1115 +MathTrace (API Object) 3484 +MdiSubWindow (API Object) 1123 +Media (API Object) 1129 +MediaLibrary (API Collection) 2503 +Medium (API Object) 1133 +Mesh (API Object) 1143 +MeshCurvilinearSegmentWire (API Object) 1156 +MeshCurvilinearTriangleFace (API Object) 1164 +MeshCurvilinearTriangleFaceCollection (API Collection) 2508 +MeshCurvilinearWire (API Object) 1167 +MeshCylinder (API Object) 1170 +MeshCylinderCollection (API Collection) 2512 +Mesher (API Object) 1246 +MeshExporter (API Object) 1174 +MeshFind (API Object) 1178 +MeshImporter (API Object) 1186 +MeshInfo (API Object) 1196 +MeshPlate (API Object) 1202 +MeshPlateCollection (API Collection) 2516 +MeshRefinementRule (API Object) 1208 +MeshRefinementRuleCollection (API Collection) 2520 +MeshRegion (API Object) 1211 +MeshSegmentCurvilinearWireCollection (API Collection) 2524 +MeshSegmentWire (API Object) 1219 +MeshSegmentWireCollection (API Collection) 2528 +MeshSettings (API Object) 1225 +MeshSettingsCollection (API Collection) 2532 +MeshTetrahedronRegion (API Object) 1231 +MeshTetrahedronRegionCollection (API Collection) 2536 +MeshTriangleFace (API Object) 1237 +MeshTriangleFaceCollection (API Collection) 2540 +MeshWire (API Object) 1243 +MessageWindow (API Object) 1251 +Metal (API Object) 1256 +MetalCollection (API Collection) 2544 +MicrostripMeshPort (API Object) 1264 +MicrostripPort (API Object) 1269 +Mirror (API Object) 1276 +Model (API Object) 1281 +ModelAttributes (API Object) 1284 +ModelContents (API Object) 1288 +ModelDecompositionCollection (API Collection) 2548 +ModelDefinitions (API Object) 1292 +ModelMeshInfo (API Object) 1302 +ModelSymmetry (API Object) 1305 +NamedPoint (API Object) 1310 +NamedPointCollection (API Collection) 2552 +NearField (API Object) 1319 +NearField3DPlot (API Object) 3589 +NearFieldCollection (API Collection) 2561 +NearFieldDataFileStructure (API Object) 1336 +NearFieldDataFullImport (API Object) 1343 +NearFieldOptimisationGoal (API Object) 1353 +NearFieldPowerIntegralTrace (API Object) 3609 +NearFieldReceivingAntenna (API Object) 1359 +NearFieldReceivingAntennaCollection (API Collection) 2566 +NearFieldSource (API Object) 1366 +NearFieldSurfacePlot (API Object) 3626 +NearFieldTrace (API Object) 3635 +Net (API Object) 1369 +NetCollection (API Collection) 2570 +Network (API Object) 1372 +NetworkCollection (API Collection) 2577 +NetworkTrace (API Object) 3652 +NumericalGreensFunction (API Object) 1379 +NurbsSurface (API Object) 1393 +Object (API Object) 1427 +OpenRing (API Object) 1440 +OpenRingShape (API Object) 1444 +OperatorCollection (API Collection) 2581 +Optimisation (API Object) 1448 +OptimisationCombination (API Object) 1451 +OptimisationGoal (API Object) 1459 +OptimisationGoalCollection (API Collection) 2587 +OptimisationGoalObjective (API Object) 1462 +OptimisationMask (API Object) 1470 +OptimisationMaskCollection (API Collection) 2592 +OptimisationOperator (API Object) 1476 +OptimisationParameters (API Object) 1480 +OptimisationSearch (API Object) 1484 +OptimisationSearchAdvancedSettings (API Object) 1487 +OptimisationSearchCollection (API Collection) 2596 +ParabolicArc (API Object) 1531 +Paraboloid (API Object) 1539 +PathSweep (API Object) 1566 +PCB (API Object) 1502 +PCBCurrentData (API Object) 1508 +PCBSource (API Object) 1514 +PerfectElectricConductor (API Object) 1569 +PerfectMagneticConductor (API Object) 1572 +PeriodicBoundary (API Object) 1579 +PlaneShape (API Object) 1595 +PlaneWave (API Object) 1602 +PointRefinement (API Object) 1623 +PolarGraph (API Object) 3680 +Polygon (API Object) 1637 +Polyline (API Object) 1644 +PolylineRefinement (API Object) 1651 +Port (API Object) 1654 +PortCollection (API Collection) 2610 +Power (API Object) 1663 +PowerOptimisationGoal (API Object) 1667 +PowerTrace (API Object) 3705 +Primitive (API Object) 1678 +ProjectGeometry (API Object) 1687 +ProtectedModel (API Object) 1693 +ProtectedModels (API Collection) 2615 +Ray3DPlot (API Object) 3714 +ReceivingAntennaOptimisationGoal (API Object) 1714 +ReceivingAntennaTrace (API Object) 3733 +Rectangle (API Object) 1722 +Region (API Object) 1732 +RegionCollection (API Collection) 2620 +RemoveSmallFeaturesSettings (API Object) 1738 +RepairAndSewFaces (API Object) 1746 +RepairAndSewFacesSettings (API Object) 1749 +RepairEdgesSettings (API Object) 1752 +RepairPart (API Object) 1760 +RepairPartsSettings (API Object) 1766 +ReportTemplate (API Object) 3741 +Resistor (API Object) 1770 +Ring (API Object) 1779 +RingShape (API Object) 1783 +Rotate (API Object) 1788 +SAR (API Object) 1793 +SAR3DPlot (API Object) 3781 +SARCollection (API Collection) 2624 +SAROptimisationGoal (API Object) 1797 +SARTrace (API Object) 3795 +Scale (API Object) 1814 +Schematic (API Object) 1818 +SchematicViewWindow (API Object) 1821 +Shape (API Object) 1829 +ShapeCollection (API Collection) 2635 +SimpleAnnotation (API Object) 3828 +Simplify (API Object) 1848 +SimplifyPartRepresentationSettings (API Object) 1861 +SimulationMeshInfo (API Object) 1878 +SmithChart (API Object) 3837 +SolutionCoefficientData (API Object) 1883 +SolutionCoefficientSource (API Object) 1889 +SolutionConfiguration (API Object) 1892 +SolutionConfigurationCollection (API Collection) 2643 +SolutionSettings (API Object) 1896 +SolverSettings (API Object) 1900 +Source (API Object) 1903 +SourceCollection (API Collection) 2656 +SParameter (API Object) 1800 +SParameterConfiguration (API Object) 1804 +SParameterOptimisationGoal (API Object) 1809 +SParameterSurfacePlot (API Object) 3815 +SParameterTrace (API Object) 3822 +Sphere (API Object) 1915 +SphericalModeDataFromFile (API Object) 1924 +SphericalModeDataManuallySpecified (API Object) 1929 +SphericalModeReceivingAntenna (API Object) 1940 +SphericalModeReceivingAntennaCollection (API Collection) 2660 +SphericalModeSource (API Object) 1947 +SpiceProbeTrace (API Object) 3941 +Spin (API Object) 1964 +SpiralCross (API Object) 1973 +SpiralCrossShape (API Object) 1977 +Split (API Object) 1987 +SplitRing (API Object) 1995 +SplitRingShape (API Object) 1999 +StandardConfiguration (API Object) 2005 +Stitch (API Object) 2013 +StripCross (API Object) 2022 +StripCrossShape (API Object) 2026 +StripHexagon (API Object) 2035 +StripHexagonShape (API Object) 2038 +Subtract (API Object) 2046 +SurfaceBezierCurve (API Object) 2055 +SurfaceCurrents3DPlot (API Object) 3948 +SurfaceLine (API Object) 2071 +SurfaceRegularLines (API Object) 2081 +Sweep (API Object) 2090 +TCross (API Object) 2099 +TCrossShape (API Object) 2103 +Terminal (API Object) 2106 +TerminalCollection (API Collection) 2664 +TopologyEntity (API Object) 2110 +TopologyEntityCollectionOf_Edge (API Collection) 2667 +Transform (API Object) 2115 +TransformCollection (API Collection) 2676 +Transformer (API Object) 2120 +Translate (API Object) 2125 +TransmissionLine (API Object) 2131 +TransmissionReflection (API Object) 2134 +TransmissionReflectionCollection (API Collection) 2680 +TransmissionReflectionOptimisationGoal (API Object) 2138 +TRCoefficientTrace (API Object) 4008 +Trifilar (API Object) 2147 +TrifilarShape (API Object) 2150 +Union (API Object) 2165 +UnitCell (API Object) 2169 +UnitCellCollection (API Collection) 2684 +UnprotectedInformation (API Object) 2177 +Variable (API Object) 2181 +VariableCollection (API Collection) 2689 +Version (API Object) 2187 +ViewXt (API Object) 2201 +ViewXtWindow (API Object) 2206 +VoltageControlledVoltageSource (API Object) 2210 +VoltageSource (API Object) 2214 +VoxelSettings (API Object) 2229 +WaveguideMeshPort (API Object) 2233 +WaveguidePort (API Object) 2244 +WaveguideSource (API Object) 2248 +WidthAnnotation (API Object) 4070 +Windscreen (API Object) 2251 +WindscreenCollection (API Collection) 2693 +WireCollection (API Collection) 2698 +WireCurrents3DPlot (API Object) 4079 +WireCurrentsTrace (API Object) 4098 +WireMeshPort (API Object) 2260 +WirePort (API Object) 2266 +Workplane (API Object) 2276 +WorkplaneCollection (API Collection) 2707 +WorkSurface (API Object) 2270 +WorkSurfaceCollection (API Collection) 2702 +Zero (API Object) 2280 +SetRadiusOnAllSegments (API Method) +AbstractMeshWire (API Object) 89 +MeshCurvilinearSegmentWire (API Object) 1156 +MeshCurvilinearWire (API Object) 1167 +MeshSegmentWire (API Object) 1219 +MeshWire (API Object) 1243 +SetSchematicLocation (API Method) +AbstractFEMLinePort (API Object) 72 +CableConnector (API Object) 204 +CableGeneralNetwork (API Object) 214 +CablePort (API Object) 239 +CableSchematicCurrentProbe (API Object) 253 +CableSchematicVoltageProbe (API Object) 257 +CableSpiceNetwork (API Object) 273 +Capacitor (API Object) 285 +ComplexLoad (API Object) 333 +EdgeMeshPort (API Object) 499 +EdgePort (API Object) 504 +FEMLineMeshPort (API Object) 580 +FEMLinePort (API Object) 588 +GeneralNetwork (API Object) 852 +Ground (API Object) 914 +Inductor (API Object) 993 +MicrostripMeshPort (API Object) 1265 +MicrostripPort (API Object) 1269 +Resistor (API Object) 1770 +Transformer (API Object) 2120 +TransmissionLine (API Object) 2131 +VoltageControlledVoltageSource (API Object) 2210 +WireMeshPort (API Object) 2260 +WirePort (API Object) 2266 +SetSchematicRotation (API Method) +AbstractFEMLinePort (API Object) 72 +CableConnector (API Object) 204 +CableGeneralNetwork (API Object) 214 +CablePort (API Object) 239 +CableSchematicCurrentProbe (API Object) 253 +CableSchematicVoltageProbe (API Object) 257 +CableSpiceNetwork (API Object) 273 +Capacitor (API Object) 285 +ComplexLoad (API Object) 333 +EdgeMeshPort (API Object) 499 +EdgePort (API Object) 504 +FEMLineMeshPort (API Object) 580 +FEMLinePort (API Object) 588 +GeneralNetwork (API Object) 852 +Ground (API Object) 914 +Inductor (API Object) 993 +MicrostripMeshPort (API Object) 1265 +MicrostripPort (API Object) 1269 +Resistor (API Object) 1770 +Transformer (API Object) 2120 +TransmissionLine (API Object) 2131 +VoltageControlledVoltageSource (API Object) 2211 +WireMeshPort (API Object) 2260 +WirePort (API Object) 2266 +SetSingleStep (API Method) +FormDoubleSpinBox (API Object) 725, 3258 +FormIntegerSpinBox (API Object) 753, 3286 +SetSize (API Method) +CartesianGraph (API Object) 2960 +CartesianSurfaceGraph (API Object) 2972 +Form (API Object) 700, 3222 +FormImage (API Object) 748, 3281 +FormProgressDialog (API Object) 781, 3319 +Graph (API Object) 3359 +MdiSubWindow (API Object) 1123 +PolarGraph (API Object) 3680 +SmithChart (API Object) 3837 +SurfaceGraph (API Object) 3964 +View (API Object) 4043 +Window (API Object) 4074 +SetSourcesGlobal (API Method) +SolutionConfigurationCollection (API Collection) 2644 +SetSourcesPerConfiguration (API Method) +SolutionConfigurationCollection (API Collection) 2644 +Settings (API Property) +CFXModelImporter (API Object) 181 +Interpolator (API Object) 3390 +Launcher (API Object) 1026, 3401 +Mesher (API Object) 1245 +SetTwoDimensions (API Method) +PeriodicBoundary (API Object) 1579 +SetValueAt (API Method) +DataSetAxis (API Object) 3099 +SetViewDirection (API Method) +View (API Object) 4043 +SewTolerance (API Property) +RepairAndSewFacesSettings (API Object) 1748 +Shadow (API Property) +FrameFormat (API Object) 3352 +SurfaceGraphFrameFormat (API Object) 3976 +ShadowFormat (API Object) 3823 +ShadowSize (API Property) +ResultTextBox (API Object) 3770 +ShadowVisible (API Property) +ResultTextBox (API Object) 3770 +Shape (API Object) 1827 +Shape (API Property) +UnitCellLayer (API Object) 2172 +ShapeCollection (API Collection) 2625 +Shapes (API Collection) +CartesianGraph (API Object) 2957 +Graph (API Object) 3357 +PolarGraph (API Object) 3677 +SmithChart (API Object) 3834 +SheathThickness (API Property) +CableBundleCrossSection (API Object) 191 +Shield (API Property) +CableBundleCrossSection (API Object) 191 +CableCoaxialCrossSection (API Object) 198 +ShieldLayerSettings (API Object) 1830 +ShieldLayerSettingsList (API Object) 1838 +ShieldLayerType (API Property) +CableShield (API Object) 260 +ShieldMedium (API Property) +ShieldLayerSettings (API Object) 1834 +Shields (API Collection) +Cables (API Object) 281 +ShieldThickness (API Property) +ShieldLayerSettings (API Object) 1834 +ShieldType (API Property) +CableBundleCrossSection (API Object) 191 +Show (API Method) +CartesianGraph (API Object) 2960 +CartesianSurfaceGraph (API Object) 2972 +Graph (API Object) 3360 +MdiSubWindow (API Object) 1123 +MessageWindow (API Object) 1251 +PolarGraph (API Object) 3680 +SmithChart (API Object) 3837 +SurfaceGraph (API Object) 3965 +View (API Object) 4043 +Window (API Object) 4074 +Signal (API Property) +SpiceProbeTrace (API Object) 3940 +Signals (API Collection) +CableInstance (API Object) 221 +Signals (API Property) +SpiceProbeTrace (API Object) 3940 +SignificantDigits (API Property) +GraphAxisLabels (API Object) 3367 +SurfaceGraphAxisLabels (API Object) 3969 +SimpleAnnotation (API Object) 3824 +Simplify (API Method) +GeometryCollection (API Collection) 2467, 2467 +Simplify (API Object) 1840 +SimplifyBCurvesEnabled (API Property) +SimplifyPartRepresentationSettings (API Object) 1860 +SimplifyBSurfacesEnabled (API Property) +SimplifyPartRepresentationSettings (API Object) 1860 +SimplifyEdgeSettings (API Object) 1849 +SimplifyEdgeSettingsList (API Object) 1851 +SimplifyEnabled (API Property) +PCB (API Object) 1501 +SimplifyEntities (API Method) +GeometryCollection (API Collection) 2468 +SimplifyFaceSettings (API Object) 1853 +SimplifyFaceSettingsList (API Object) 1855 +SimplifyGeometryDuringCleaningEnabled (API Property) +RepairPartsSettings (API Object) 1764 +SimplifyModelEnabled (API Property) +GeometryImporter (API Object) 881 +SimplifyPartRepresentationSettings (API Object) 1857 +SimplifyPartRepresentationSettings (API Property) +GeometryRepair (API Object) 888 +SimplifyParts (API Method) +GeometryRepair (API Object) 890 +SimplifyPartSettings (API Property) +RepairPartsSettings (API Object) 1764 +SimplifyPointSettings (API Object) 1863 +SimplifyPointSettingsList (API Object) 1864 +SimplifyRationalGeometryEnabled (API Property) +SimplifyPartRepresentationSettings (API Object) 1860 +SimplifyRegionSettings (API Object) 1866 +SimplifyRegionSettingsList (API Object) 1867 +SimplifySPCurvesToConstantUVCurvesEnabled (API Property) +SimplifyPartRepresentationSettings (API Object) 1860 +SimplifySweptSpunSurfacesEnabled (API Property) +SimplifyPartRepresentationSettings (API Object) 1860 +SimplifyToBlends (API Property) +RepairPartsSettings (API Object) 1764 +SimulationMeshInfo (API Object) 1869 +Sin (API StaticFunction) +Complex (API Object) 327, 3007 +ComplexMatrix (API Object) 3037 +Matrix (API Object) 3510 +SinglePointAnnotationType (API Property) +SimpleAnnotation (API Object) 3826 +Size (API Property) +Arrows3DFormat (API Object) 2937 +CustomData3DFormat (API Object) 3048 +FarField3DFormat (API Object) 3165 +FontFormat (API Object) 3218 +ShadowFormat (API Object) 3823 +SurfaceGraphFontFormat (API Object) 3975 +SurfaceGraphShadowFormat (API Object) 3981 +TraceMarkersFormat (API Object) 4021 +SizeFactor (API Property) +CustomData3DFormat (API Object) 3048 +FarField3DFormat (API Object) 3165 +SizeOption (API Property) +View3DAxesFormat (API Object) 4048 +SizeType (API Property) +ReportImageSizeSetting (API Object) 3736 +SkewAngle (API Property) +UnitCell (API Object) 2168 +SlotWidth (API Property) +StripCross (API Object) 2019 +StripCrossShape (API Object) 2025 +SmallFeatureSize (API Property) +RemoveSmallFeaturesSettings (API Object) 1737 +SmallGeometrySuppression (API Property) +MeshAdvancedSettings (API Object) 1147 +VoxelAdvancedSettings (API Object) 2218 +SmallGeometryThreshold (API Property) +MeshAdvancedSettings (API Object) 1147 +SmallVoxelThreshold (API Property) +VoxelAdvancedSettings (API Object) 2218 +SmithChart (API Object) 3829 +SmithChartCollection (API Collection) 4255 +SmithChartGrid (API Object) 3838 +SmithCharts (API Collection) +Application (API Object) 2932 +SmootheningAngularTolerance (API Property) +RepairPartsSettings (API Object) 1764 +SmoothingEnabled (API Property) +MeshAdvancedSettings (API Object) 1148 +SmoothInternalEdgesEnabled (API Property) +FillHoleSettings (API Object) 674 +SolutionCoefficientData (API Object) 1879 +SolutionCoefficientSource (API Object) 1884 +SolutionConfiguration (API Object) 1890, 3840 +SolutionConfigurationCollection (API Collection) 2637 +SolutionConfigurations (API Collection) +ModelContents (API Object) 1287 +SolutionControl (API Property) +NumericalGreensFunction (API Object) 1378 +SolutionEntities (API Property) +View (API Object) 4040 +SolutionMedium (API Property) +MeshTetrahedronRegion (API Object) 1230 +Region (API Object) 1731 +SolutionMethod (API Property) +CableHarness (API Object) 217 +Edge (API Object) 492 +Face (API Object) 613 +MeshCurvilinearSegmentWire (API Object) 1155 +MeshCurvilinearTriangleFace (API Object) 1163 +MeshPlate (API Object) 1201 +MeshSegmentWire (API Object) 1218 +MeshTetrahedronRegion (API Object) 1230 +MeshTriangleFace (API Object) 1236 +Region (API Object) 1731 +SolutionSettings (API Object) 1893 +SolutionSettings (API Property) +ModelContents (API Object) 1286 +SolverSettings (API Object) 1897 +SolverSettings (API Property) +SolutionSettings (API Object) 1895 +SortBy (API Property) +WireCurrentsQuantity (API Object) 4090 +Source (API Object) 1901 +Source (API Property) +CableSignal (API Object) 263 +GeneralNetwork (API Object) 851 +LibraryMedium (API Object) 1039 +SourceAperture (API Object) 3848 +SourceCoaxial (API Object) 3851 +SourceCollection (API Collection) 2645 +SourceConnector (API Property) +CableInstance (API Object) 221 +SourceCurrentRegion (API Object) 3856 +SourceCurrentSpace (API Object) 3861 +SourceCurrentTriangle (API Object) 3864 +SourceDefinitionMethod (API Property) +Dielectric (API Object) 463 +FreeSpace (API Object) 815 +GroundPlaneMedium (API Object) 921 +ImpedanceSheet (API Object) 969 +Metal (API Object) 1255 +Zero (API Object) 2279 +SourceDefinitionType (API Property) +WaveguideSource (API Object) 2247 +SourceElectricDipole (API Object) 3867 +SourceFormat (API Property) +View3DSolutionEntityFormat (API Object) 4058 +SourceMagneticDipole (API Object) 3870 +SourceMagneticFrill (API Object) 3873 +SourceModal (API Object) 3878 +SourcePCB (API Object) 3883 +SourcePlaneWave (API Object) 3886 +SourcePower (API Property) +DataSetMetaData (API Object) 3108 +Power (API Object) 1661 +SourcePowerDecoupled (API Property) +DataSetMetaData (API Object) 3108 +SourceRadiationPattern (API Object) 3889 +Sources (API Collection) +CharacteristicModesConfiguration (API Object) 307 +StandardConfiguration (API Object) 2004 +SourceSolutionCoefficient (API Object) 3892 +SourceSphericalModes (API Object) 3895 +SourcesVisible (API Property) +View3DSolutionEntityFormat (API Object) 4059 +SourceType (API Property) +MagneticDipole (API Object) 1101 +NearFieldDataFileStructure (API Object) 1334 +NearFieldDataFullImport (API Object) 1341 +SourceVoltageCable (API Object) 3898 +SourceVoltageEdge (API Object) 3903 +SourceVoltageNetwork (API Object) 3908 +SourceVoltageSegment (API Object) 3913 +SourceVoltageVertex (API Object) 3918 +SourceWaveguide (API Object) 3923 +SourceWorkplane (API Property) +Align (API Object) 114 +Spacing (API Property) +AxisGridSpacing (API Object) 2939 +SurfaceGraphAxisGridSpacing (API Object) 3966 +SurfaceRegularLines (API Object) 2077 +SpacingMethod (API Property) +SurfaceRegularLines (API Object) 2077 +SParameter (API Object) 1798 +SParameter (API Property) +SParameterConfiguration (API Object) 1803 +SParameterCollection (API Collection) 4252 +SParameterConfiguration (API Object) 1802 +SParameterData (API Object) 3796 +SParameterIncluded (API Property) +FrequencyContinuousQuantities (API Object) 827 +SParameterMathScript (API Object) 3801 +SParameterOptimisationGoal (API Object) 1805 +SParameterQuantity (API Object) 3804 +SParameters (API Collection) +SolutionConfiguration (API Object) 3846 +SParameterStoredData (API Object) 3806 +SParameterSurfacePlot (API Object) 3810 +SParameterTrace (API Object) 3816 +SPARK3DEnabled (API Property) +NearFieldExportSettings (API Object) 1346 +SpecifiedEdgeRepairTolerance (API Property) +RepairPartsSettings (API Object) 1765 +SpecifiedMedium (API Property) +SAR (API Object) 1792 +SpecifiedPosition (API Property) +SAR (API Object) 1792 +SpecifiedRequestPoints (API Object) 1904 +SpecifiedRequestPoints (API Property) +NearField (API Object) 1317 +SpecifiedRequestPointsList (API Object) 1905 +SpecifyEdgeToleranceEnabled (API Property) +RepairPartsSettings (API Object) 1765 +SimplifyPartRepresentationSettings (API Object) 1860 +Sphere (API Object) 1907 +SphericalDescription (API Object) 1916 +SphericalDescription (API Property) +AnalyticalCurve (API Object) 122 +SphericalDescriptionList (API Object) 1918 +SphericalMagnitude (API Property) +SphericalModeOptions (API Object) 1931 +SphericalMJ (API Property) +SphericalModeOptions (API Object) 1931 +SphericalModeDataFromFile (API Object) 1920 +SphericalModeDataManuallySpecified (API Object) 1925 +SphericalModeOptions (API Object) 1930 +SphericalModeOptionsList (API Object) 1933 +SphericalModeReceivingAntenna (API Object) 1935 +SphericalModeReceivingAntennaCollection (API Collection) 2657 +SphericalModeReceivingAntennas (API Collection) +StandardConfiguration (API Object) 2005 +SphericalModes (API Property) +FarFieldAdvancedSettings (API Object) 625 +SphericalModeSource (API Object) 1942 +SphericalModesReceivingAntennaData (API Object) 3928 +SphericalN (API Property) +SphericalModeOptions (API Object) 1931 +SphericalPhase (API Property) +SphericalModeOptions (API Object) 1931 +SphericalRequestPoints (API Object) 1949 +SphericalRequestPoints (API Property) +NearField (API Object) 1317 +SphericalRequestPointsList (API Object) 1951 +SphericalStructure (API Object) 1953 +SphericalStructure (API Property) +NearFieldDataFileStructure (API Object) 1334 +SphericalStructureList (API Object) 1955 +SpiceCircuitSource (API Property) +CableSpiceNetwork (API Object) 272 +SPICEPortReference (API Property) +GeneralNetwork (API Object) 850 +SpiceProbeCollection (API Collection) 4258 +SpiceProbeData (API Object) 3931 +SpiceProbeQuantity (API Object) 3933 +SpiceProbes (API Collection) +SolutionConfiguration (API Object) 3846 +SpiceProbeStoredData (API Object) 3935 +SpiceProbeTrace (API Object) 3937 +Spin (API Method) +GeometryCollection (API Collection) 2468, 2468 +Spin (API Object) 1957 +SpiralCross (API Object) 1966 +SpiralCrossShape (API Object) 1975 +SpiralLength (API Property) +SpiralCross (API Object) 1970 +SpiralCrossShape (API Object) 1976 +Split (API Method) +GeometryCollection (API Collection) 2469, 2469 +Split (API Object) 1979 +SplitPlaneUN (API Method) +GeometryCollection (API Collection) 2469 +SplitPlaneVN (API Method) +GeometryCollection (API Collection) 2470 +SplitRing (API Object) 1988 +SplitRingShape (API Object) 1997 +Sqrt (API StaticFunction) +Complex (API Object) 327, 3008 +ComplexMatrix (API Object) 3037 +Matrix (API Object) 3510 +StabilisationFactor (API Property) +IterativeSolverSettings (API Object) 1013 +StandardConfiguration (API Object) 2001 +Start (API Property) +FEMLineMeshPort (API Object) 577 +FEMLinePort (API Object) 585 +Frequency (API Object) 819 +PointRange (API Object) 1613 +ReferenceDirection (API Object) 1725 +StartAngle (API Property) +EllipticArc (API Object) 527 +OpenRing (API Object) 1437 +OpenRingShape (API Object) 1444 +SplitRing (API Object) 1992 +SplitRingShape (API Object) 1999 +StartCapTerminated (API Property) +UTDCylinderTerminationType (API Object) 2152 +StartCornerPoint (API Property) +SurfaceRegularLines (API Object) 2077 +StartFrequency (API Property) +SolutionConfiguration (API Object) 3844 +StartFromPoint (API Property) +FarFieldData (API Object) 631 +StartMagnitude (API Property) +ImpressedCurrent (API Object) 977 +StartPhase (API Property) +ImpressedCurrent (API Object) 977 +StartPoint (API Property) +Line (API Object) 1044 +PeriodicBoundary (API Object) 1577 +SurfaceBezierCurve (API Object) 2051 +SurfaceLine (API Object) 2067 +StartPosition (API Property) +ImpressedCurrent (API Object) 977 +StartPositionX (API Property) +ResultArrow (API Object) 3751 +StartPositionY (API Property) +ResultArrow (API Object) 3751 +StartTangentPoint (API Property) +SurfaceBezierCurve (API Object) 2051 +StartTerminal (API Property) +CablePath (API Object) 230 +Net (API Object) 1368 +StartValue (API Property) +OptimisationVariable (API Object) 1490 +StartVertex (API Property) +FEMLineMeshPort (API Object) 577 +MicrostripMeshPort (API Object) 1264 +static function +Lua 24 +StaticParts (API Property) +NumericalGreensFunction (API Object) 1378 +StdOutEnabled (API Property) +PREFEKOVariableExportOptions (API Object) 1519, 3659 +Stepping (API Property) +FrequencyExportSettings (API Object) 836 +Stitch (API Method) +GeometryCollection (API Collection) 2470, 2470, 2470 +Stitch (API Object) 2006 +StitchTrimmedFacesEnabled (API Property) +GeometryImporter (API Object) 881 +StoppingCriterion (API Property) +HighFrequencySettings (API Object) 949 +IterativeSolverSettings (API Object) 1013 +Store (API Method) +CharacteristicModeTrace (API Object) 2992 +CustomData3DPlot (API Object) 3054 +ErrorEstimate3DPlot (API Object) 3117 +ExcitationSmithTrace (API Object) 3142 +ExcitationTrace (API Object) 3150 +FarField3DPlot (API Object) 3172 +FarFieldPowerIntegralTrace (API Object) 3194 +FarFieldSurfacePlot (API Object) 3209 +FarFieldTrace (API Object) 3216 +LoadSmithTrace (API Object) 3459 +LoadTrace (API Object) 3469 +NearField3DPlot (API Object) 3589 +NearFieldPowerIntegralTrace (API Object) 3609 +NearFieldSurfacePlot (API Object) 3627 +NearFieldTrace (API Object) 3635 +NetworkTrace (API Object) 3652 +PowerTrace (API Object) 3705 +Ray3DPlot (API Object) 3715 +ReceivingAntennaTrace (API Object) 3733 +Result3DPlot (API Object) 3748 +SAR3DPlot (API Object) 3781 +SARTrace (API Object) 3795 +SParameterSurfacePlot (API Object) 3815 +SParameterTrace (API Object) 3822 +SpiceProbeTrace (API Object) 3942 +SurfaceCurrents3DPlot (API Object) 3948 +TRCoefficientTrace (API Object) 4008 +WireCurrents3DPlot (API Object) 4080 +WireCurrentsTrace (API Object) 4098 +StoreConvergenceDataEnabled (API Property) +OutputFileSolverSettings (API Object) 1494 +StoreData (API Function) +DRE (API Object) 4295, 4296 +StoreData (API Method) +CharacteristicModeData (API Object) 2980 +DataSet (API Object) 3093 +ExcitationData (API Object) 3125 +ExcitationMathScript (API Object) 3128 +FarFieldData (API Object) 3179 +FarFieldMathScript (API Object) 3182 +FarFieldPowerIntegralData (API Object) 3185 +LoadCable (API Object) 3411 +LoadCoaxial (API Object) 3415 +LoadComplex (API Object) 3419 +LoadData (API Object) 3423 +LoadDistributed (API Object) 3425 +LoadEdge (API Object) 3428 +LoadFEM (API Object) 3432 +LoadMathScript (API Object) 3436 +LoadNetwork (API Object) 3439 +LoadParallel (API Object) 3443 +LoadSeries (API Object) 3449 +LoadVertex (API Object) 3472 +LoadVoxel (API Object) 3476 +NearFieldData (API Object) 3595 +NearFieldMathScript (API Object) 3598 +NearFieldPowerIntegralData (API Object) 3600 +NetworkData (API Object) 3639 +NetworkMathScript (API Object) 3642 +PowerData (API Object) 3688 +PowerMathScript (API Object) 3693 +SARData (API Object) 3784 +SourceAperture (API Object) 3850 +SourceCoaxial (API Object) 3855 +SourceCurrentRegion (API Object) 3860 +SourceCurrentSpace (API Object) 3863 +SourceCurrentTriangle (API Object) 3866 +SourceElectricDipole (API Object) 3869 +SourceMagneticDipole (API Object) 3872 +SourceMagneticFrill (API Object) 3877 +SourceModal (API Object) 3882 +SourcePCB (API Object) 3885 +SourcePlaneWave (API Object) 3888 +SourceRadiationPattern (API Object) 3891 +SourceSolutionCoefficient (API Object) 3894 +SourceSphericalModes (API Object) 3897 +SourceVoltageCable (API Object) 3902 +SourceVoltageEdge (API Object) 3907 +SourceVoltageNetwork (API Object) 3912 +SourceVoltageSegment (API Object) 3917 +SourceVoltageVertex (API Object) 3922 +SourceWaveguide (API Object) 3927 +SParameterData (API Object) 3800 +SParameterMathScript (API Object) 3803 +SpiceProbeData (API Object) 3932 +SurfaceCurrentsData (API Object) 3954 +SurfaceCurrentsMathScript (API Object) 3957 +TransmissionLineData (API Object) 4029 +TRCoefficientData (API Object) 3995 +TRCoefficientMathScript (API Object) 3998 +WireCurrentsData (API Object) 4085 +WireCurrentsMathScript (API Object) 4088 +StoredData (API Collection) +Application (API Object) 2932 +StoredDataCollection (API Collection) 4261 +StoreShadowingInfoEnabled (API Property) +HighFrequencySettings (API Object) 949 +StretchingOptimisationMethod (API Property) +CableShield (API Object) 260 +string +Lua 15 +StripCross (API Object) 2015 +StripCrossShape (API Object) 2024 +StripHexagon (API Object) 2028 +StripHexagonShape (API Object) 2036 +StripWidth (API Property) +Cross (API Object) 381 +CrossShape (API Object) 387 +SpiralCross (API Object) 1970 +SpiralCrossShape (API Object) 1977 +StripCross (API Object) 2019 +StripCrossShape (API Object) 2026 +StripHexagon (API Object) 2031 +StripHexagonShape (API Object) 2037 +TCross (API Object) 2096 +TCrossShape (API Object) 2102 +Trifilar (API Object) 2143 +TrifilarShape (API Object) 2149 +Style (API Property) +GraphLineFormat (API Object) 3374 +SurfaceGraphLineFormat (API Object) 3979 +TraceLineFormat (API Object) 4019 +SubCircuitName (API Property) +CableSpiceNetwork (API Object) 272 +SubMatrix (API Method) +ComplexMatrix (API Object) 3020 +Matrix (API Object) 3497 +SubstrateLayer (API Property) +SAR (API Object) 1792 +Subtract (API Method) +GeometryCollection (API Collection) 2471, 2471 +Subtract (API Object) 2039 +Succeeded (API Property) +Interpolator (API Object) 3390 +LaunchResult (API Object) 1021, 3398 +Sum (API Method) +ComplexMatrix (API Object) 3020 +Matrix (API Object) 3498 +Sum (API StaticFunction) +ComplexMatrix (API Object) 3037 +Matrix (API Object) 3510 +SuppressSurfaceModificationsEnabled (API Property) +RepairPartsSettings (API Object) 1765 +Surface (API Property) +ConstrainedSurfacePoint (API Object) 374 +SurfaceAreaDefinition (API Property) +NearFieldPowerIntegralTrace (API Object) 3607 +NearFieldTrace (API Object) 3632 +SurfaceAreaDefinitionsAvailable (API Property) +NearFieldPowerIntegralTrace (API Object) 3607 +NearFieldTrace (API Object) 3632 +SurfaceBezierCurve (API Object) 2047 +SurfaceCoatingType (API Property) +Face (API Object) 614 +MeshCurvilinearTriangleFace (API Object) 1163 +MeshPlate (API Object) 1201 +MeshTriangleFace (API Object) 1236 +SurfaceCoordinate (API Object) 2056 +SurfaceCoordinateList (API Object) 2058 +SurfaceCurrents (API Collection) +SolutionConfiguration (API Object) 3846 +SurfaceCurrents3DPlot (API Object) 3943 +SurfaceCurrentsAndChargesStoredData (API Object) 3949 +SurfaceCurrentsCollection (API Collection) 4264 +SurfaceCurrentsData (API Object) 3951 +SurfaceCurrentsMathScript (API Object) 3955 +SurfaceCurrentsQuantity (API Object) 3958 +SurfaceGraph (API Object) 3960 +SurfaceGraphAxisGridSpacing (API Object) 3966 +SurfaceGraphAxisLabels (API Object) 3968 +SurfaceGraphAxisRange (API Object) 3970 +SurfaceGraphAxisTitle (API Object) 3972 +SurfaceGraphFontFormat (API Object) 3974 +SurfaceGraphFrameFormat (API Object) 3976 +SurfaceGraphLegend (API Object) 3978 +SurfaceGraphLineFormat (API Object) 3979 +SurfaceGraphShadowFormat (API Object) 3981 +SurfaceGraphTextBox (API Object) 3982 +SurfaceImpedanceFrequencyPoint (API Object) 2060 +SurfaceImpedanceFrequencyPointList (API Object) 2062 +SurfaceImpedanceFrequencyPropertiesFile (API Property) +ShieldLayerSettings (API Object) 1835 +SurfaceImpedanceFrequencyPropertiesSource (API Property) +ShieldLayerSettings (API Object) 1835 +SurfaceImpedanceInterpolationMethod (API Property) +ShieldLayerSettings (API Object) 1835 +SurfaceLine (API Object) 2064 +SurfaceNormalTolerance (API Property) +SimplifyPartRepresentationSettings (API Object) 1861 +SurfacePlotLegendFormat (API Object) 3984 +SurfacePlotLegendLinearRangeFormat (API Object) 3986 +SurfacePlotLegendLogarithmicRangeFormat (API Object) 3988 +SurfacePlotSamplingFormat (API Object) 3990 +SurfaceReflections (API Property) +RayContributionsFacetedUTD (API Object) 1700 +SurfaceRegularLines (API Object) 2073 +SurfaceRoughness (API Property) +Metal (API Object) 1255 +SurfaceRoughnessEnabled (API Property) +Metal (API Object) 1255 +SurfacesVisible (API Property) +MeshSegmentsFormat (API Object) 3555 +SurfaceVisible (API Property) +CustomData3DFormat (API Object) 3048 +FarField3DFormat (API Object) 3165 +NearField3DFormat (API Object) 3581 +SurroundingMedium (API Property) +Edge (API Object) 493 +MeshCurvilinearSegmentWire (API Object) 1155 +MeshSegmentWire (API Object) 1218 +Sweep (API Method) +GeometryCollection (API Collection) 2471, 2472 +Sweep (API Object) 2083 +SwitchIndependentAxes (API Method) +CustomDataSurfacePlot (API Object) 3069 +FarFieldSurfacePlot (API Object) 3209 +NearFieldSurfacePlot (API Object) 3627 +ResultSurfacePlot (API Object) 3765 +SParameterSurfacePlot (API Object) 3815 +Symbol (API Property) +TraceMarkersFormat (API Object) 4021 +SymmetryEnabled (API Property) +ConstrainedSurface (API Object) 367 +SymmetryPlane (API Property) +ConstrainedSurface (API Object) 367 +SymmetryPlaneConstantSurfaceParameter (API Property) +ConstrainedSurface (API Object) 367 +SymmetryPlaneUValue (API Property) +ConstrainedSurface (API Object) 367 +SymmetryPlaneVValue (API Property) +ConstrainedSurface (API Object) 368 +SymmetryVisible (API Property) +View3DSolutionEntityFormat (API Object) 4059 +table +Lua 15 +Tag (API Property) +ReportTemplateTagSettings (API Object) 3742 +Tags (API Property) +ReportTemplate (API Object) 3739 +TagSettings (API Collection) +ReportTemplate (API Object) 3740 +Tan (API StaticFunction) +Complex (API Object) 327, 3008 +ComplexMatrix (API Object) 3037 +Matrix (API Object) 3510 +TargetValue (API Property) +OptimisationGoalObjective (API Object) 1461 +TargetValueType (API Property) +OptimisationGoalObjective (API Object) 1462 +TCross (API Object) 2092 +TCrossShape (API Object) 2101 +TemplateFilename (API Property) +ReportTemplate (API Object) 3739 +TensorDescription (API Property) +AnisotropicDielectric (API Object) 133 +Terminal (API Object) 2104 +Terminal (API Property) +CableConnectorPin (API Object) 206 +PortProperties (API Object) 1657 +TerminalCollection (API Collection) 2661 +TerminalCount (API Property) +GeneralNetwork (API Object) 851 +Terminals (API Collection) +Schematic (API Object) 1817 +Terminals (API Property) +AbstractFEMLinePort (API Object) 69 +CableConnector (API Object) 203 +CableGeneralNetwork (API Object) 213 +CablePort (API Object) 238 +CableSchematicCurrentProbe (API Object) 252 +CableSchematicVoltageProbe (API Object) 256 +CableSpiceNetwork (API Object) 272 +Capacitor (API Object) 284 +ComplexLoad (API Object) 332 +EdgeMeshPort (API Object) 498 +EdgePort (API Object) 503 +FEMLineMeshPort (API Object) 578 +FEMLinePort (API Object) 586 +GeneralNetwork (API Object) 851 +Ground (API Object) 913 +Inductor (API Object) 992 +MicrostripMeshPort (API Object) 1264 +MicrostripPort (API Object) 1268 +Resistor (API Object) 1769 +Transformer (API Object) 2119 +TransmissionLine (API Object) 2130 +VoltageControlledVoltageSource (API Object) 2209 +WireMeshPort (API Object) 2259 +WirePort (API Object) 2265 +TeTmType (API Property) +SphericalModeOptions (API Object) 1932 +Tetrahedra (API Property) +MeshTetrahedronRegion (API Object) 3560 +TetrahedraVisible (API Property) +MeshEdgesFormat (API Object) 3535 +MeshFacesFormat (API Object) 3540 +MeshVerticesFormat (API Object) 3571 +MeshVolumesFormat (API Object) 3572 +TetrahedronCount (API Property) +MeshInfo (API Object) 1195 +ModelMeshInfo (API Object) 1301 +SimulationMeshInfo (API Object) 1877 +TetrahedronEdgeLength (API Property) +GlobalMeshSettings (API Object) 897 +LocalMeshSettings (API Object) 1073 +MeshSettings (API Object) 1224 +TetrahedronEdgeStandardDeviation (API Property) +MeshInfo (API Object) 1195 +ModelMeshInfo (API Object) 1301 +SimulationMeshInfo (API Object) 1877 +TetrahedronImportingEnabled (API Property) +MeshImporter (API Object) 1184 +TetrahedronRegions (API Collection) +Mesh (API Object) 3515 +Text (API Property) +BandwidthAnnotation (API Object) 2945 +BeamwidthAnnotation (API Object) 2950 +GraphAnnotation (API Object) 3364 +ImplicitPointsAnnotation (API Object) 3381 +MeshLegendFormat (API Object) 3542 +Plot3DLegendFormat (API Object) 3661 +ResultTextBox (API Object) 3770 +SimpleAnnotation (API Object) 3827 +SurfaceGraphTextBox (API Object) 3983 +TextBox (API Object) 4013 +TraceLegendFormat (API Object) 4017 +WidthAnnotation (API Object) 4069 +TextBox (API Object) 4012 +TextDirection (API Property) +ResultTextBox (API Object) 3770 +ThermalAnalysisExportEnabled (API Property) +OutputFileSolverSettings (API Object) 1495 +Theta (API Property) +AbstractPointSource (API Object) 92 +Cutplane (API Object) 417 +ElectricDipole (API Object) 507 +FarField (API Object) 619 +FarFieldReceivingAntenna (API Object) 650 +FarFieldSource (API Object) 656 +MagneticDipole (API Object) 1102 +PeriodicBoundaryBeamSquintAngle (API Object) 1582 +PlaneWave (API Object) 1599 +SphericalDescription (API Object) 1917 +SphericalModeReceivingAntenna (API Object) 1938 +SphericalModeSource (API Object) 1945 +SphericalRequestPoints (API Object) 1950 +ThetaDirection (API Property) +View3DFormat (API Object) 4051 +ThetaIncrement (API Property) +HighFrequencySettings (API Object) 949 +ThetaPoints (API Property) +SphericalStructure (API Object) 1954 +ThetaStepSize (API Property) +View3DAnimationFormat (API Object) 4045 +Thickness (API Property) +AnisotropicDielectricLayers (API Object) 136 +CoaxialInsulationLayer (API Object) 310 +Face (API Object) 614 +IsotropicDielectricLayers (API Object) 1007 +LayeredIsotropicDielectric (API Object) 1036 +MeshCurvilinearTriangleFace (API Object) 1163 +MeshPlate (API Object) 1201 +MeshTriangleFace (API Object) 1236 +PlanarSubstrate (API Object) 1590 +UnitCellLayer (API Object) 2172 +Threshold (API Property) +Rays3DFormat (API Object) 3720 +TickMarkCount (API Property) +View3DAxesFormat (API Object) 4048 +TickMarkSpacing (API Property) +View3DAxesFormat (API Object) 4048 +TickMarkSpacingOption (API Property) +View3DAxesFormat (API Object) 4049 +TickMarksVisible (API Property) +View3DAxesFormat (API Object) 2189, 4049 +TileWindows (API Method) +Application (API Object) 2935 +TimeIntervalType (API Property) +FrequencyFDTDSettings (API Object) 841 +Title (API Property) +CartesianGraph (API Object) 2956 +CartesianSurfaceGraph (API Object) 2969 +Form (API Object) 699, 3221 +FormProgressDialog (API Object) 780, 3318 +Graph (API Object) 3356 +HorizontalGraphAxis (API Object) 3376 +HorizontalSurfaceGraphAxis (API Object) 3378 +Model (API Object) 1280 +PolarGraph (API Object) 3676 +SmithChart (API Object) 3833 +SurfaceGraph (API Object) 3962 +VerticalGraphAxis (API Object) 4034 +VerticalSurfaceGraphAxis (API Object) 4036 +To (API Property) +Sweep (API Object) 2087 +Translate (API Object) 2123 +ToComplexMatrix (API Method) +DataSet (API Object) 3093, 3094 +DataSetIndexer (API Object) 3105 +Tolerance (API Property) +Stitch (API Object) 2010 +ToMatrix (API Method) +DataSet (API Object) 3094, 3094 +DataSetIndexer (API Object) 3105 +Top (API Property) +Cylinder (API Object) 425 +Flare (API Object) 692 +TopCentre (API Property) +Cone (API Object) 353 +TopDepth (API Property) +Flare (API Object) 692 +TopologyEntity (API Object) 2108 +TopologyEntityCollectionOf_Edge (API Collection) 2665 +TopRadius (API Property) +Cone (API Object) 354 +TopWidth (API Property) +Flare (API Object) 692 +TouchstoneExportEnabled (API Property) +SParameter (API Object) 1800 +Trace (API Property) +BandwidthAnnotation (API Object) 2946 +BeamwidthAnnotation (API Object) 2950 +GraphAnnotation (API Object) 3364 +ImplicitPointsAnnotation (API Object) 3382 +SimpleAnnotation (API Object) 3827 +WidthAnnotation (API Object) 4069 +TraceAxes (API Object) 4014 +TraceLegendFormat (API Object) 4016 +TraceLineFormat (API Object) 4018 +TraceMarkersFormat (API Object) 4020 +TraceMathExpression (API Object) 4022 +Traces (API Collection) +CartesianGraph (API Object) 2958 +Graph (API Object) 3357 +PolarGraph (API Object) 3677 +SmithChart (API Object) 3834 +TraceSamplingFormat (API Object) 4024 +TransferAdmittanceFrequencyPropertiesFile (API Property) +ShieldLayerSettings (API Object) 1835 +TransferAdmittanceFrequencyPropertiesSource (API Property) +ShieldLayerSettings (API Object) 1835 +TransferAdmittanceInterpolationMethod (API Property) +ShieldLayerSettings (API Object) 1836 +TransferCapacitance (API Property) +ShieldLayerSettings (API Object) 1836 +TransferImpedanceFrequencyPropertiesFile (API Property) +ShieldLayerSettings (API Object) 1836 +TransferImpedanceFrequencyPropertiesSource (API Property) +ShieldLayerSettings (API Object) 1836 +TransferImpedanceInterpolationMethod (API Property) +ShieldLayerSettings (API Object) 1836 +Transform (API Object) 2111 +TransformCollection (API Collection) 2668 +Transformer (API Object) 2116 +Transforms (API Collection) +AbstractAntennaArray (API Object) 64 +AbstractFEMLinePort (API Object) 70 +AbstractIdealSource (API Object) 75 +AbstractPointSource (API Object) 93 +AbstractSurfaceCurve (API Object) 100 +AdaptiveRefinement (API Object) 106 +Align (API Object) 114 +AnalyticalCurve (API Object) 123 +BaseFieldReceivingAntenna (API Object) 150 +BezierCurve (API Object) 165 +CablePath (API Object) 230 +Cone (API Object) 354 +ConstrainedSurface (API Object) 368 +Cross (API Object) 381 +Cuboid (API Object) 394 +CustomAntennaArray (API Object) 412 +Cutplane (API Object) 418 +Cylinder (API Object) 426 +CylindricalAntennaArray (API Object) 434 +ElectricDipole (API Object) 508 +Ellipse (API Object) 515 +EllipticArc (API Object) 528 +FarField (API Object) 620 +FarFieldData (API Object) 631 +FarFieldReceivingAntenna (API Object) 650 +FarFieldSource (API Object) 656 +FEMLineMeshPort (API Object) 578 +FEMLinePort (API Object) 586 +FEMModalMeshPort (API Object) 593 +FEMModalPort (API Object) 599 +FieldData (API Object) 666 +FittedSpline (API Object) 683 +Flare (API Object) 693 +Geometry (API Object) 869 +GeometryGroup (API Collection) 2475 +Helix (API Object) 929 +Hexagon (API Object) 937 +HyperbolicArc (API Object) 958 +ImpressedCurrent (API Object) 978 +ImprintPoints (API Object) 985 +Intersect (API Object) 1003 +Line (API Object) 1045 +LinearPlanarArray (API Object) 1052 +Loft (API Object) 1087 +MagneticDipole (API Object) 1102 +Mesh (API Object) 1139 +MeshRefinementRule (API Object) 1206 +Mirror (API Object) 1274 +NamedPoint (API Object) 1308 +NearField (API Object) 1317 +NearFieldDataFileStructure (API Object) 1334 +NearFieldDataFullImport (API Object) 1341 +NearFieldReceivingAntenna (API Object) 1357 +NearFieldSource (API Object) 1364 +NurbsSurface (API Object) 1390 +OpenRing (API Object) 1438 +ParabolicArc (API Object) 1528 +Paraboloid (API Object) 1536 +PathSweep (API Object) 1563 +PCBCurrentData (API Object) 1506 +PCBSource (API Object) 1512 +PeriodicBoundary (API Object) 1577 +PlaneWave (API Object) 1600 +PointRefinement (API Object) 1621 +Polygon (API Object) 1634 +Polyline (API Object) 1642 +PolylineRefinement (API Object) 1648 +Primitive (API Object) 1675 +ProjectGeometry (API Object) 1684 +ProtectedModel (API Object) 1691 +Rectangle (API Object) 1719 +RepairAndSewFaces (API Object) 1743 +RepairPart (API Object) 1757 +Ring (API Object) 1776 +Rotate (API Object) 1786 +Scale (API Object) 1812 +Simplify (API Object) 1845 +SolutionCoefficientData (API Object) 1881 +SolutionCoefficientSource (API Object) 1887 +Sphere (API Object) 1912 +SphericalModeDataFromFile (API Object) 1922 +SphericalModeDataManuallySpecified (API Object) 1927 +SphericalModeReceivingAntenna (API Object) 1938 +SphericalModeSource (API Object) 1945 +Spin (API Object) 1962 +SpiralCross (API Object) 1971 +Split (API Object) 1984 +SplitRing (API Object) 1993 +Stitch (API Object) 2010 +StripCross (API Object) 2020 +StripHexagon (API Object) 2032 +Subtract (API Object) 2043 +SurfaceBezierCurve (API Object) 2052 +SurfaceLine (API Object) 2068 +SurfaceRegularLines (API Object) 2078 +Sweep (API Object) 2087 +TCross (API Object) 2096 +Transform (API Object) 2113 +Translate (API Object) 2123 +Trifilar (API Object) 2144 +Union (API Object) 2162 +Workplane (API Object) 2273 +Translate (API Object) 2121 +TransmissionLine (API Object) 2126 +TransmissionLineCollection (API Collection) 4270 +TransmissionLineData (API Object) 4026 +TransmissionLines (API Collection) +SolutionConfiguration (API Object) 3847 +TransmissionLinesVisible (API Property) +View3DSolutionEntityFormat (API Object) 4059 +TransmissionReflection (API Collection) +StandardConfiguration (API Object) 2005 +TransmissionReflection (API Object) 2132 +TransmissionReflectionCollection (API Collection) 2677 +TransmissionReflectionIncluded (API Property) +FrequencyContinuousQuantities (API Object) 827 +TransmissionReflectionOptimisationGoal (API Object) 2135 +Transpose (API Method) +ComplexMatrix (API Object) 3020 +Matrix (API Object) 3498 +TRCoefficientCollection (API Collection) 4267 +TRCoefficientData (API Object) 3992 +TRCoefficientMathScript (API Object) 3996 +TRCoefficients (API Collection) +SolutionConfiguration (API Object) 3846 +TRCoefficientStoredData (API Object) 3999 +TRCoefficientTrace (API Object) 4002 +TriangleCount (API Property) +MeshInfo (API Object) 1195 +ModelMeshInfo (API Object) 1301 +SimulationMeshInfo (API Object) 1877 +TriangleEdgeLength (API Property) +GlobalMeshSettings (API Object) 897 +LocalMeshSettings (API Object) 1073 +MeshSettings (API Object) 1224 +TriangleFaces (API Collection) +Mesh (API Object) 3515 +TriangleImportingEnabled (API Property) +MeshImporter (API Object) 1184 +TriangleNormalsVisible (API Property) +MeshRendering (API Object) 3548 +Triangles (API Property) +MeshTriangleFace (API Object) 3563 +Trifilar (API Object) 2140 +TrifilarShape (API Object) 2148 +TRQuantity (API Object) 4009 +Turns (API Property) +Helix (API Object) 928 +TwistAngle (API Property) +CablePath (API Object) 230 +PathSweep (API Object) 1562 +TwistDirection (API Property) +CableBundleCrossSection (API Object) 191 +CableTwistedPairCrossSection (API Object) 276 +TwistPitchLength (API Property) +CableBundleCrossSection (API Object) 191 +CableTwistedPairCrossSection (API Object) 277 +TwistRadius (API Property) +CableTwistedPairCrossSection (API Object) 277 +Type (API Property) +AbstractAntennaArray (API Object) 64 +AbstractFEMLinePort (API Object) 69 +AbstractIdealSource (API Object) 74 +AbstractMeshEdge (API Object) 79 +AbstractMeshPort (API Object) 82 +AbstractMeshTriangleFace (API Object) 85 +AbstractMeshWire (API Object) 88 +AbstractPointSource (API Object) 92 +AbstractSurfaceCurve (API Object) 99 +AdaptiveRefinement (API Object) 106 +Align (API Object) 114 +AnalyticalCurve (API Object) 123 +AnisotropicDielectric (API Object) 133 +AnisotropicDielectricCollection (API Collection) 2284 +AntennaArrayCollection (API Collection) 2289 +Application (API Object) 145, 2931 +BandwidthAnnotation (API Object) 2946 +BaseFieldReceivingAntenna (API Object) 150 +BeamwidthAnnotation (API Object) 2950 +BezierCurve (API Object) 164 +Box (API Object) 174 +CableBundleCrossSection (API Object) 191 +CableCoaxialCrossSection (API Object) 198 +CableConnector (API Object) 203 +CableConnectorCollection (API Collection) 2296 +CableConnectorPin (API Object) 206 +CableConnectorPinCollection (API Collection) 2300 +CableCrossSection (API Object) 209 +CableCrossSectionCollection (API Collection) 2306 +CableGeneralNetwork (API Object) 213 +CableHarness (API Object) 217 +CableHarnessCollection (API Collection) 2316 +CableInstance (API Object) 221 +CableInstanceCollection (API Collection) 2321 +CableNonConductingElementCrossSection (API Object) 225 +CablePath (API Object) 230 +CablePathCollection (API Collection) 2325 +CablePathTerminal (API Object) 234 +CablePort (API Object) 238 +CableProbe (API Object) 243 +CableProbeCollection (API Collection) 2329 +CableRibbonCrossSection (API Object) 248 +Cables (API Object) 280 +CableSchematicComponentCollection (API Collection) 2335 +CableSchematicCurrentProbe (API Object) 252 +CableSchematicVoltageProbe (API Object) 256 +CableShield (API Object) 260 +CableShieldCollection (API Collection) 2348 +CableSignal (API Object) 263 +CableSignalCollection (API Collection) 2353 +CableSingleConductorCrossSection (API Object) 267 +CableSpiceNetwork (API Object) 272 +CableTwistedPairCrossSection (API Object) 277 +Capacitor (API Object) 284 +CartesianGraph (API Object) 2956 +CartesianGraphCollection (API Collection) 4101 +CartesianSurfaceGraph (API Object) 2970 +CartesianSurfaceGraphCollection (API Collection) 4104 +CFXModelImporter (API Object) 181 +CFXModelImportSettings (API Object) 178 +CharacterisedSurface (API Object) 300 +CharacterisedSurfaceCollection (API Collection) 2357 +CharacteristicModeCollection (API Collection) 4107 +CharacteristicModeData (API Object) 2979 +CharacteristicModeQuantity (API Object) 2982 +CharacteristicModes (API Object) 303 +CharacteristicModesConfiguration (API Object) 307 +CharacteristicModeStoredData (API Object) 2984 +CharacteristicModeTrace (API Object) 2990 +CollectionOf_DomainEntity (API Collection) 2361 +CollectionOf_Mesh (API Collection) 2364 +Complex (API Object) 317, 2997 +ComplexLoad (API Object) 332 +ComplexMatrix (API Object) 3016 +ComplexMatrixIndexer (API Object) 3039 +ComponentLaunchOptions (API Object) 341, 3042 +Cone (API Object) 354 +ConfigurationCollection (API Collection) 4110 +ConstrainedSurface (API Object) 368 +Contours3DFormat (API Object) 3044 +Cross (API Object) 381 +CrossShape (API Object) 387 +Cuboid (API Object) 393 +Currents (API Object) 403 +CurrentsCollection (API Collection) 2367 +CurrentSource (API Object) 400 +CustomAntennaArray (API Object) 411 +CustomData3DPlot (API Object) 3052 +CustomDataQuantity (API Object) 3056 +CustomDataSmithTrace (API Object) 3060 +CustomDataSurfacePlot (API Object) 3067 +CustomDataTrace (API Object) 3074 +CustomMathScript (API Object) 3079 +CustomSmithTraceQuantity (API Object) 3081 +CustomStoredData (API Object) 3083 +Cutplane (API Object) 417 +CutplaneCollection (API Collection) 2371 +Cylinder (API Object) 425 +CylindricalAntennaArray (API Object) 434 +DataSet (API Object) 3091 +DataSetAxis (API Object) 3099 +DataSetAxisCollection (API Collection) 4113 +DataSetIndexer (API Object) 3102 +DataSetQuantity (API Object) 3111 +DataSetQuantityCollection (API Collection) 4119 +DefaultMedium (API Object) 459 +Dielectric (API Object) 463 +DielectricBoundaryMedium (API Object) 466 +DielectricCollection (API Collection) 2375 +Edge (API Object) 493 +EdgeCollection (API Collection) 2380 +EdgeMeshPort (API Object) 498 +EdgePort (API Object) 503 +ElectricDipole (API Object) 508 +Ellipse (API Object) 515 +EllipseShape (API Object) 520 +EllipticArc (API Object) 528 +ErrorEstimate3DPlot (API Object) 3115 +ErrorEstimateCollection (API Collection) 4123 +ErrorEstimateData (API Object) 3119 +ErrorEstimatesQuantity (API Object) 3120 +ErrorEstimation (API Object) 534 +ErrorEstimationCollection (API Collection) 2384 +ExcitationCollection (API Collection) 4126 +ExcitationMathScript (API Object) 3127 +ExcitationQuantity (API Object) 3131 +ExcitationSmithQuantity (API Object) 3135 +ExcitationSmithTrace (API Object) 3140 +ExcitationStoredData (API Object) 3144 +ExcitationTrace (API Object) 3149 +Exporter (API Object) 536 +Face (API Object) 614 +FaceCollection (API Collection) 2389 +FarField (API Object) 619 +FarField3DPlot (API Object) 3169 +FarFieldCollection (API Collection) 2394, 4129 +FarFieldData (API Object) 631, 3176 +FarFieldMathScript (API Object) 3182 +FarFieldOptimisationGoal (API Object) 641 +FarFieldPowerIntegralCollection (API Collection) 4132 +FarFieldPowerIntegralData (API Object) 3184 +FarFieldPowerIntegralStoredData (API Object) 3187 +FarFieldPowerIntegralTrace (API Object) 3192 +FarFieldQuantity (API Object) 3196 +FarFieldReceivingAntenna (API Object) 650 +FarFieldReceivingAntennaCollection (API Collection) 2399 +FarFieldReceivingAntennaData (API Object) 3199 +FarFieldSource (API Object) 656 +FarFieldStoredData (API Object) 3202 +FarFieldSurfacePlot (API Object) 3207 +FarFieldTrace (API Object) 3214 +FDTDBoundaryConditions (API Object) 544 +FEMLineMeshPort (API Object) 578 +FEMLinePort (API Object) 586 +FEMModalMeshPort (API Object) 592 +FEMModalPort (API Object) 599 +FEMModalSource (API Object) 603 +FieldData (API Object) 666 +FieldDataCollection (API Collection) 2404 +FillHoleSettings (API Object) 675 +Find (API Object) 677 +FittedSpline (API Object) 682 +Flare (API Object) 693 +Form (API Object) 699, 3221 +FormCheckBox (API Object) 707, 3229 +FormComboBox (API Object) 713, 3234 +FormConfigurationSelector (API Object) 3240 +FormDataSelector (API Object) 3246 +FormDirectoryBrowser (API Object) 718, 3251 +FormDoubleSpinBox (API Object) 723, 3256 +FormFileBrowser (API Object) 729, 3262 +FormFileSaveAsBrowser (API Object) 735, 3268 +FormGroupBox (API Object) 741, 3274 +FormGroupBoxItemCollection (API Collection) 2411, 4135 +FormImage (API Object) 747, 3280 +FormIntegerSpinBox (API Object) 752, 3285 +FormItemCollection (API Collection) 2414, 4138 +FormLabel (API Object) 762, 3295 +FormLayout (API Object) 770, 3303 +FormLayoutItemCollection (API Collection) 2417, 4141 +FormLineEdit (API Object) 776, 3309 +FormModelSelector (API Object) 3314 +FormProgressDialog (API Object) 780, 3318 +FormPushButton (API Object) 785, 3323 +FormRadioButtonGroup (API Object) 791, 3329 +FormScrollArea (API Object) 797, 3335 +FormScrollAreaItemCollection (API Collection) 2420, 4145 +FormSeparator (API Object) 803, 3341 +FormTree (API Object) 807, 3345 +FormTreeItem (API Object) 811, 3349 +FreeSpace (API Object) 815 +Frequency (API Object) 819 +GeneralNetwork (API Object) 852 +Geometry (API Object) 869 +GeometryCollection (API Collection) 2432 +GeometryExporter (API Object) 876 +GeometryGroup (API Collection) 2475 +GeometryGroupCollection (API Collection) 2481 +GeometryImporter (API Object) 881 +GeometryRebuild (API Object) 884 +GeometryRepair (API Object) 888 +GlobalMeshSettings (API Object) 897 +Ground (API Object) 913 +GroundPlane (API Object) 917 +GroundPlaneMedium (API Object) 921 +Helix (API Object) 928 +Hexagon (API Object) 936 +HexagonShape (API Object) 942 +HyperbolicArc (API Object) 957 +ImpedanceOptimisationGoal (API Object) 965 +ImpedanceSheet (API Object) 969 +ImpedanceSheetCollection (API Collection) 2485 +ImplicitPointsAnnotation (API Object) 3382 +ImportedDataCollection (API Collection) 4148 +ImportedDataSetCollection (API Collection) 4151 +Importer (API Object) 973 +ImportSet (API Object) 3385 +ImpressedCurrent (API Object) 977 +ImprintPoints (API Object) 985 +Inductor (API Object) 992 +Interpolator (API Object) 3390 +InterpolatorSettings (API Object) 3394 +Intersect (API Object) 1002 +KBL (API Object) 1017 +Launcher (API Object) 1026, 3401 +LaunchResult (API Object) 1021, 3398 +LayeredAnisotropicDielectric (API Object) 1030 +LayeredDielectric (API Object) 1033 +LayeredDielectricCollection (API Collection) 2491 +LayeredIsotropicDielectric (API Object) 1037 +Legend3DLinearRangeFormat (API Object) 3406 +Legend3DLogarithmicRangeFormat (API Object) 3408 +LibraryMedium (API Object) 1039 +Line (API Object) 1045 +LinearPlanarArray (API Object) 1052 +Load (API Object) 1060 +LoadCable (API Object) 3411 +LoadCoaxial (API Object) 3415 +LoadCollection (API Collection) 2496, 4154 +LoadComplex (API Object) 3419 +LoadDistributed (API Object) 3425 +LoadEdge (API Object) 3428 +LoadFEM (API Object) 3432 +LoadMathScript (API Object) 3435 +LoadNetwork (API Object) 3439 +LoadParallel (API Object) 3443 +LoadQuantity (API Object) 3446 +LoadSeries (API Object) 3449 +LoadSmithTrace (API Object) 3457 +LoadStoredData (API Object) 3461 +LoadTrace (API Object) 3467 +LoadVertex (API Object) 3472 +LoadVoxel (API Object) 3475 +LocalMeshSettings (API Object) 1073 +Loft (API Object) 1086 +MagneticDipole (API Object) 1102 +MainWindow (API Object) 1114 +MathScriptCollection (API Collection) 4157 +MathTrace (API Object) 3483 +Matrix (API Object) 3494 +MatrixIndexer (API Object) 3512 +MdiSubWindow (API Object) 1121 +Media (API Object) 1128 +MediaLibrary (API Collection) 2501 +Medium (API Object) 1132 +Mesh (API Object) 1139, 3514 +MeshCube (API Object) 3517 +MeshCubeRegion (API Object) 3519 +MeshCubeRegionCollection (API Collection) 4161 +MeshCubes (API Object) 3520 +MeshCurvilinearSegment (API Object) 3522 +MeshCurvilinearSegments (API Object) 3525 +MeshCurvilinearSegmentWire (API Object) 1155, 3524 +MeshCurvilinearSegmentWireCollection (API Collection) 4164 +MeshCurvilinearTriangle (API Object) 3527 +MeshCurvilinearTriangleFace (API Object) 1163, 3529 +MeshCurvilinearTriangleFaceCollection (API Collection) 2507, 4167 +MeshCurvilinearTriangles (API Object) 3530 +MeshCurvilinearWire (API Object) 1166 +MeshCylinder (API Object) 1169, 3532 +MeshCylinderCollection (API Collection) 2510 +MeshCylinders (API Object) 3533 +Mesher (API Object) 1245 +MeshExporter (API Object) 1173 +MeshFind (API Object) 1177 +MeshImporter (API Object) 1184 +MeshInfo (API Object) 1195 +MeshPlate (API Object) 1202 +MeshPlateCollection (API Collection) 2514 +MeshPolygon (API Object) 3543 +MeshPolygons (API Object) 3544 +MeshRefinementRule (API Object) 1206 +MeshRefinementRuleCollection (API Collection) 2518 +MeshRegion (API Object) 1210 +MeshSegment (API Object) 3550 +MeshSegmentCurvilinearWireCollection (API Collection) 2523 +MeshSegments (API Object) 3553 +MeshSegmentWire (API Object) 1218, 3552 +MeshSegmentWireCollection (API Collection) 2526, 4170 +MeshSettings (API Object) 1224 +MeshSettingsCollection (API Collection) 2530 +MeshTetrahedra (API Object) 3556 +MeshTetrahedron (API Object) 3558 +MeshTetrahedronRegion (API Object) 1230, 3560 +MeshTetrahedronRegionCollection (API Collection) 2534, 4173 +MeshTriangle (API Object) 3561 +MeshTriangleFace (API Object) 1237, 3563 +MeshTriangleFaceCollection (API Collection) 2538, 4176 +MeshTriangles (API Object) 3565 +MeshUnmeshedCylinderRegion (API Object) 3567 +MeshUnmeshedCylinderRegionCollection (API Collection) 4179 +MeshUnmeshedPolygonFace (API Object) 3569 +MeshUnmeshedPolygonFaceCollection (API Collection) 4182 +MeshWire (API Object) 1242 +MessageWindow (API Object) 1249 +Metal (API Object) 1255 +MetalCollection (API Collection) 2542 +MicrostripMeshPort (API Object) 1264 +MicrostripPort (API Object) 1268 +Mirror (API Object) 1274 +ModalExcitationStoredData (API Object) 3575 +Model (API Object) 1280, 3578 +ModelAttributes (API Object) 1283 +ModelCollection (API Collection) 4185 +ModelContents (API Object) 1287 +ModelDecompositionCollection (API Collection) 2546 +ModelDefinitions (API Object) 1291 +ModelMeshInfo (API Object) 1301 +ModelSymmetry (API Object) 1304 +NamedPoint (API Object) 1308 +NamedPointCollection (API Collection) 2550 +NearField (API Object) 1317 +NearField3DPlot (API Object) 3587 +NearFieldCollection (API Collection) 2555, 4188 +NearFieldData (API Object) 3592 +NearFieldDataFileStructure (API Object) 1334 +NearFieldDataFullImport (API Object) 1341 +NearFieldMathScript (API Object) 3598 +NearFieldOptimisationGoal (API Object) 1352 +NearFieldPowerIntegralCollection (API Collection) 4191 +NearFieldPowerIntegralData (API Object) 3600 +NearFieldPowerIntegralStoredData (API Object) 3601 +NearFieldPowerIntegralTrace (API Object) 3607 +NearFieldQuantity (API Object) 3613 +NearFieldReceivingAntenna (API Object) 1357 +NearFieldReceivingAntennaCollection (API Collection) 2564 +NearFieldReceivingAntennaData (API Object) 3616 +NearFieldSource (API Object) 1364 +NearFieldStoredData (API Object) 3619 +NearFieldSurfacePlot (API Object) 3624 +NearFieldTrace (API Object) 3632 +Net (API Object) 1369 +NetCollection (API Collection) 2568 +Network (API Object) 1372 +NetworkCollection (API Collection) 2574, 4194 +NetworkData (API Object) 3638 +NetworkMathScript (API Object) 3642 +NetworkStoredData (API Object) 3644 +NetworkTrace (API Object) 3650 +NumericalGreensFunction (API Object) 1378 +NurbsSurface (API Object) 1389 +Object (API Object) 1427 +OpenRing (API Object) 1437 +OpenRingShape (API Object) 1444 +OperatorCollection (API Collection) 2580 +Optimisation (API Object) 1447 +OptimisationCombination (API Object) 1450 +OptimisationGoal (API Object) 1458 +OptimisationGoalCollection (API Collection) 2584 +OptimisationGoalObjective (API Object) 1462 +OptimisationMask (API Object) 1469 +OptimisationMaskCollection (API Collection) 2590 +OptimisationOperator (API Object) 1476 +OptimisationParameters (API Object) 1479 +OptimisationSearch (API Object) 1483 +OptimisationSearchAdvancedSettings (API Object) 1487 +OptimisationSearchCollection (API Collection) 2594 +ParabolicArc (API Object) 1527 +Paraboloid (API Object) 1536 +PathSweep (API Object) 1562 +PCB (API Object) 1501 +PCBCurrentData (API Object) 1506 +PCBSource (API Object) 1511 +PerfectElectricConductor (API Object) 1568 +PerfectMagneticConductor (API Object) 1571 +PeriodicBoundary (API Object) 1577 +PlaneShape (API Object) 1594 +PlaneWave (API Object) 1599 +Point (API Object) 1604, 3666 +PointRefinement (API Object) 1621 +Points (API Object) 3669 +PolarGraph (API Object) 3676 +PolarGraphCollection (API Collection) 4197 +Polygon (API Object) 1633 +Polyline (API Object) 1641 +PolylineRefinement (API Object) 1648 +Port (API Object) 1653 +PortCollection (API Collection) 2600 +Power (API Object) 1662 +PowerCollection (API Collection) 4200 +PowerData (API Object) 3687 +PowerMathScript (API Object) 3692 +PowerOptimisationGoal (API Object) 1666 +PowerQuantity (API Object) 3694 +PowerStoredData (API Object) 3697 +PowerTrace (API Object) 3703 +Primitive (API Object) 1675 +ProjectGeometry (API Object) 1683 +ProtectedModel (API Object) 1690 +ProtectedModels (API Collection) 2614 +QuickReport (API Object) 3708 +Ray3DPlot (API Object) 3714 +RayCollection (API Collection) 4203 +RayData (API Object) 3717 +RaysQuantity (API Object) 3722 +ReceivingAntennaCollection (API Collection) 4206 +ReceivingAntennaOptimisationGoal (API Object) 1713 +ReceivingAntennaQuantity (API Object) 3728 +ReceivingAntennaTrace (API Object) 3732 +Rectangle (API Object) 1719 +Region (API Object) 1732 +RegionCollection (API Collection) 2619 +RemoveSmallFeaturesSettings (API Object) 1737 +RepairAndSewFaces (API Object) 1742 +RepairAndSewFacesSettings (API Object) 1749 +RepairEdgesSettings (API Object) 1751 +RepairPart (API Object) 1756 +RepairPartsSettings (API Object) 1765 +ReportsCollection (API Collection) 4211 +ReportTemplate (API Object) 3740 +Resistor (API Object) 1769 +Result3DPlotCollection (API Collection) 4215 +ResultAnnotationCollection (API Collection) 4221 +ResultArrow (API Object) 3751 +ResultArrowCollection (API Collection) 4232 +ResultSurfacePlotCollection (API Collection) 4237 +ResultTextBox (API Object) 3770 +ResultTextBoxCollection (API Collection) 4241 +ResultTraceCollection (API Collection) 4246 +Ring (API Object) 1776 +RingShape (API Object) 1782 +Rotate (API Object) 1786 +SAR (API Object) 1793 +SAR3DPlot (API Object) 3780 +SARCollection (API Collection) 2622, 4250 +SARData (API Object) 3783 +SAROptimisationGoal (API Object) 1796 +SARQuantity (API Object) 3785 +SARStoredData (API Object) 3787 +SARTrace (API Object) 3793 +Scale (API Object) 1812 +Schematic (API Object) 1817 +SchematicViewWindow (API Object) 1820 +Shape (API Object) 1828 +ShapeCollection (API Collection) 2628 +SimpleAnnotation (API Object) 3827 +Simplify (API Object) 1844 +SimplifyPartRepresentationSettings (API Object) 1861 +SimulationMeshInfo (API Object) 1877 +SmithChart (API Object) 3833 +SmithChartCollection (API Collection) 4256 +SolutionCoefficientData (API Object) 1881 +SolutionCoefficientSource (API Object) 1886 +SolutionConfiguration (API Object) 1891, 3844 +SolutionConfigurationCollection (API Collection) 2641 +SolutionSettings (API Object) 1895 +SolverSettings (API Object) 1900 +Source (API Object) 1902 +SourceAperture (API Object) 3849 +SourceCoaxial (API Object) 3853 +SourceCollection (API Collection) 2648 +SourceCurrentRegion (API Object) 3858 +SourceCurrentSpace (API Object) 3862 +SourceCurrentTriangle (API Object) 3865 +SourceElectricDipole (API Object) 3868 +SourceMagneticDipole (API Object) 3871 +SourceMagneticFrill (API Object) 3875 +SourceModal (API Object) 3879 +SourcePCB (API Object) 3884 +SourcePlaneWave (API Object) 3887 +SourceRadiationPattern (API Object) 3890 +SourceSolutionCoefficient (API Object) 3893 +SourceSphericalModes (API Object) 3896 +SourceVoltageCable (API Object) 3900 +SourceVoltageEdge (API Object) 3905 +SourceVoltageNetwork (API Object) 3910 +SourceVoltageSegment (API Object) 3915 +SourceVoltageVertex (API Object) 3920 +SourceWaveguide (API Object) 3925 +SParameter (API Object) 1800 +SParameterCollection (API Collection) 4253 +SParameterConfiguration (API Object) 1803 +SParameterData (API Object) 3798 +SParameterMathScript (API Object) 3803 +SParameterOptimisationGoal (API Object) 1808 +SParameterStoredData (API Object) 3807 +SParameterSurfacePlot (API Object) 3813 +SParameterTrace (API Object) 3820 +Sphere (API Object) 1912 +SphericalModeDataFromFile (API Object) 1922 +SphericalModeDataManuallySpecified (API Object) 1927 +SphericalModeReceivingAntenna (API Object) 1938 +SphericalModeReceivingAntennaCollection (API Collection) 2658 +SphericalModeSource (API Object) 1945 +SphericalModesReceivingAntennaData (API Object) 3929 +SpiceProbeCollection (API Collection) 4259 +SpiceProbeData (API Object) 3932 +SpiceProbeQuantity (API Object) 3934 +SpiceProbeStoredData (API Object) 3935 +SpiceProbeTrace (API Object) 3940 +Spin (API Object) 1961 +SpiralCross (API Object) 1970 +SpiralCrossShape (API Object) 1977 +Split (API Object) 1984 +SplitRing (API Object) 1992 +SplitRingShape (API Object) 1999 +StandardConfiguration (API Object) 2003 +Stitch (API Object) 2010 +StoredDataCollection (API Collection) 4262 +StripCross (API Object) 2019 +StripCrossShape (API Object) 2026 +StripHexagon (API Object) 2031 +StripHexagonShape (API Object) 2037 +Subtract (API Object) 2042 +SurfaceBezierCurve (API Object) 2051 +SurfaceCurrents3DPlot (API Object) 3946 +SurfaceCurrentsAndChargesStoredData (API Object) 3950 +SurfaceCurrentsCollection (API Collection) 4265 +SurfaceCurrentsData (API Object) 3952 +SurfaceCurrentsMathScript (API Object) 3956 +SurfaceCurrentsQuantity (API Object) 3959 +SurfaceLine (API Object) 2068 +SurfacePlotLegendLinearRangeFormat (API Object) 3987 +SurfacePlotLegendLogarithmicRangeFormat (API Object) 3989 +SurfaceRegularLines (API Object) 2078 +Sweep (API Object) 2087 +TCross (API Object) 2096 +TCrossShape (API Object) 2102 +Terminal (API Object) 2106 +TerminalCollection (API Collection) 2662 +TopologyEntity (API Object) 2109 +TopologyEntityCollectionOf_Edge (API Collection) 2666 +Transform (API Object) 2113 +TransformCollection (API Collection) 2672 +Transformer (API Object) 2119 +Translate (API Object) 2123 +TransmissionLine (API Object) 2130 +TransmissionLineCollection (API Collection) 4271 +TransmissionLineData (API Object) 4028 +TransmissionReflection (API Object) 2134 +TransmissionReflectionCollection (API Collection) 2678 +TransmissionReflectionOptimisationGoal (API Object) 2138 +TRCoefficientCollection (API Collection) 4268 +TRCoefficientData (API Object) 3994 +TRCoefficientMathScript (API Object) 3998 +TRCoefficientStoredData (API Object) 4000 +TRCoefficientTrace (API Object) 4006 +Trifilar (API Object) 2144 +TrifilarShape (API Object) 2149 +TRQuantity (API Object) 4010 +Union (API Object) 2161 +UnitCell (API Object) 2168 +UnitCellCollection (API Collection) 2682 +UnprotectedInformation (API Object) 2176 +UVPoint (API Object) 2156 +Variable (API Object) 2180 +VariableCollection (API Collection) 2686 +Vector (API Object) 2183 +Version (API Object) 2187, 4031 +View (API Object) 4040 +View3DAnimationFormat (API Object) 4046 +ViewCollection (API Collection) 4274 +ViewXt (API Object) 2201 +ViewXtWindow (API Object) 2204 +VoltageControlledVoltageSource (API Object) 2209 +VoltageSource (API Object) 2214 +VoxelSettings (API Object) 2228 +WaveguideExcitationStoredData (API Object) 4063 +WaveguideMeshPort (API Object) 2233 +WaveguidePort (API Object) 2243 +WaveguideSource (API Object) 2247 +WidthAnnotation (API Object) 4069 +WindowCollection (API Collection) 4278 +Windscreen (API Object) 2251 +WindscreenCollection (API Collection) 2691 +WireCollection (API Collection) 2697 +WireCurrents3DPlot (API Object) 4077 +WireCurrentsAndChargesStoredData (API Object) 4082 +WireCurrentsCollection (API Collection) 4281 +WireCurrentsData (API Object) 4084 +WireCurrentsMathScript (API Object) 4087 +WireCurrentsTrace (API Object) 4096 +WireMeshPort (API Object) 2260 +WirePort (API Object) 2265 +Workplane (API Object) 2273 +WorkplaneCollection (API Collection) 2705 +WorkSurface (API Object) 2270 +WorkSurfaceCollection (API Collection) 2700 +Zero (API Object) 2279 +U (API Property) +CartesianDescription (API Object) 288 +CartesianRequestPoints (API Object) 292 +FarField (API Object) 619 +LocalCoordinate (API Object) 1064 +LocalInternalCoordinate (API Object) 1068 +SurfaceCoordinate (API Object) 2057 +UIncrement (API Property) +HighFrequencySettings (API Object) 949 +UnblockGraphRedraws (API Method) +CartesianGraph (API Object) 2961 +CartesianSurfaceGraph (API Object) 2973 +Graph (API Object) 3360 +PolarGraph (API Object) 3680 +SmithChart (API Object) 3837 +SurfaceGraph (API Object) 3965 +Underlined (API Property) +FontFormat (API Object) 3218 +SurfaceGraphFontFormat (API Object) 3975 +Undo (API Method) +Application (API Object) 2935 +UniformSourceDistributionEnabled (API Property) +CylindricalAntennaArray (API Object) 434 +LinearPlanarArray (API Object) 1052 +Union (API Method) +GeometryCollection (API Collection) 2472, 2472 +Union (API Object) 2158 +UnionEnabled (API Property) +PCB (API Object) 1501 +UniqueName (API Method) +CartesianGraphCollection (API Collection) 4102 +CartesianSurfaceGraphCollection (API Collection) 4105 +CharacteristicModeCollection (API Collection) 4108 +ConfigurationCollection (API Collection) 4111 +DataSetAxisCollection (API Collection) 4117 +DataSetQuantityCollection (API Collection) 4121 +ErrorEstimateCollection (API Collection) 4124 +ExcitationCollection (API Collection) 4127 +FarFieldCollection (API Collection) 4130 +FarFieldPowerIntegralCollection (API Collection) 4133 +FormGroupBoxItemCollection (API Collection) 2412, 4136 +FormItemCollection (API Collection) 2415, 4139 +FormLayoutItemCollection (API Collection) 2418, 4142 +FormScrollAreaItemCollection (API Collection) 2421, 4146 +ImportedDataCollection (API Collection) 4149 +ImportedDataSetCollection (API Collection) 4152 +LoadCollection (API Collection) 4155 +MathScriptCollection (API Collection) 4158 +MeshCubeRegionCollection (API Collection) 4162 +MeshCurvilinearSegmentWireCollection (API Collection) 4165 +MeshCurvilinearTriangleFaceCollection (API Collection) 4168 +MeshSegmentWireCollection (API Collection) 4171 +MeshTetrahedronRegionCollection (API Collection) 4174 +MeshTriangleFaceCollection (API Collection) 4177 +MeshUnmeshedCylinderRegionCollection (API Collection) 4180 +MeshUnmeshedPolygonFaceCollection (API Collection) 4183 +ModelCollection (API Collection) 4186 +NearFieldCollection (API Collection) 4189 +NearFieldPowerIntegralCollection (API Collection) 4192 +NetworkCollection (API Collection) 4195 +PolarGraphCollection (API Collection) 4198 +PowerCollection (API Collection) 4201 +RayCollection (API Collection) 4204 +ReceivingAntennaCollection (API Collection) 4207 +ReportsCollection (API Collection) 4213 +Result3DPlotCollection (API Collection) 4216 +ResultAnnotationCollection (API Collection) 4229 +ResultArrowCollection (API Collection) 4234 +ResultSurfacePlotCollection (API Collection) 4238 +ResultTextBoxCollection (API Collection) 4243 +ResultTraceCollection (API Collection) 4248 +SARCollection (API Collection) 4251 +SmithChartCollection (API Collection) 4257 +SParameterCollection (API Collection) 4254 +SpiceProbeCollection (API Collection) 4260 +StoredDataCollection (API Collection) 4263 +SurfaceCurrentsCollection (API Collection) 4266 +TransmissionLineCollection (API Collection) 4272 +TRCoefficientCollection (API Collection) 4269 +ViewCollection (API Collection) 4275 +WindowCollection (API Collection) 4279 +WireCurrentsCollection (API Collection) 4282 +Unit (API Property) +DataSetAxis (API Object) 3099 +DataSetQuantity (API Object) 3111 +DependentAxisFormat (API Object) 3112 +IndependentAxisFormat (API Object) 3388 +ModelAttributes (API Object) 1283 +UnitCell (API Object) 2166 +UnitCellCollection (API Collection) 2681 +UnitCellLayer (API Object) 2170 +UnitCellLayerList (API Object) 2173 +UnitExpression (API Property) +TraceMathExpression (API Object) 4023 +UnitFactor (API Property) +ModelAttributes (API Object) 1283 +UnitIncluded (API Property) +Plot3DLegendFormat (API Object) 3661 +UnlinkMesh (API Method) +AbstractSurfaceCurve (API Object) 102 +AnalyticalCurve (API Object) 126 +BezierCurve (API Object) 167 +Cone (API Object) 357 +ConstrainedSurface (API Object) 371 +Cross (API Object) 384 +Cuboid (API Object) 397 +Cylinder (API Object) 429 +Ellipse (API Object) 518 +EllipticArc (API Object) 531 +FittedSpline (API Object) 686 +Flare (API Object) 696 +Geometry (API Object) 872 +Helix (API Object) 931 +Hexagon (API Object) 940 +HyperbolicArc (API Object) 961 +ImprintPoints (API Object) 988 +Intersect (API Object) 1006 +Line (API Object) 1048 +Loft (API Object) 1089 +Mesh (API Object) 1143 +NurbsSurface (API Object) 1393 +OpenRing (API Object) 1440 +ParabolicArc (API Object) 1531 +Paraboloid (API Object) 1539 +PathSweep (API Object) 1566 +Polygon (API Object) 1637 +Polyline (API Object) 1645 +Primitive (API Object) 1678 +ProjectGeometry (API Object) 1687 +Rectangle (API Object) 1722 +RepairAndSewFaces (API Object) 1746 +RepairPart (API Object) 1760 +Ring (API Object) 1779 +Simplify (API Object) 1848 +Sphere (API Object) 1915 +Spin (API Object) 1964 +SpiralCross (API Object) 1973 +Split (API Object) 1987 +SplitRing (API Object) 1995 +Stitch (API Object) 2013 +StripCross (API Object) 2022 +StripHexagon (API Object) 2035 +Subtract (API Object) 2046 +SurfaceBezierCurve (API Object) 2055 +SurfaceLine (API Object) 2071 +SurfaceRegularLines (API Object) 2081 +Sweep (API Object) 2090 +TCross (API Object) 2099 +Trifilar (API Object) 2147 +Union (API Object) 2165 +UnlinkMeshes (API Method) +Mesher (API Object) 1246, 1246 +UnmeshedCylinderRegions (API Collection) +Mesh (API Object) 3515 +UnmeshedPolygonFaces (API Collection) +Mesh (API Object) 3515 +UnprotectedInformation (API Object) 2175 +UnZip (API Function) +Archive (API Object) 4287, 4287 +UpdatePath (API Method) +Net (API Object) 1369 +UpdateStoredData (API Method) +DataSet (API Object) 3094 +UPoints (API Property) +CartesianStructure (API Object) 296 +UseAllDataBlocks (API Property) +SolutionCoefficientData (API Object) 1881 +SphericalModeDataFromFile (API Object) 1922 +UseCustomReferenceImpedance (API Property) +ExcitationQuantity (API Object) 3131 +ExcitationSmithQuantity (API Object) 3135 +LoadSmithQuantity (API Object) 3452 +UseInfinitelyThinLayersEnabled (API Property) +PCB (API Object) 1502 +UseTraceLabelText (API Property) +TraceLegendFormat (API Object) 4017 +UseTwoStepImportEnabled (API Property) +GeometryImporter (API Object) 881 +UTDCylinder (API Property) +MeshTetrahedronRegion (API Object) 1230 +Region (API Object) 1732 +UTDCylinderTerminationType (API Object) 2151 +UTDCylinderTerminationTypeList (API Object) 2153 +UTDCylinderVisible (API Property) +MeshEdgesFormat (API Object) 3535 +MeshFacesFormat (API Object) 3540 +UTDPolygonVisible (API Property) +MeshEdgesFormat (API Object) 3535 +MeshFacesFormat (API Object) 3540 +MeshVerticesFormat (API Object) 3571 +UTDRayContributionsType (API Property) +HighFrequencySettings (API Object) 949 +UVector (API Property) +DataSetMetaData (API Object) 3108 +GlobalPlane (API Object) 904 +Workplane (API Object) 2273 +UVPoint (API Object) 2155 +V (API Property) +CartesianDescription (API Object) 288 +CartesianRequestPoints (API Object) 292 +FarField (API Object) 620 +LocalCoordinate (API Object) 1064 +LocalInternalCoordinate (API Object) 1068 +SurfaceCoordinate (API Object) 2057 +ValidityRegionsSwapped (API Property) +NearFieldDataFileStructure (API Object) 1334 +Value (API Property) +FormComboBox (API Object) 713, 3235 +FormConfigurationSelector (API Object) 3240 +FormDataSelector (API Object) 3246 +FormDirectoryBrowser (API Object) 718, 3251 +FormDoubleSpinBox (API Object) 723, 3256 +FormFileBrowser (API Object) 729, 3262 +FormFileSaveAsBrowser (API Object) 735, 3268 +FormImage (API Object) 747, 3280 +FormIntegerSpinBox (API Object) 752, 3285 +FormLabel (API Object) 762, 3295 +FormLineEdit (API Object) 776, 3309 +FormModelSelector (API Object) 3314 +FormProgressDialog (API Object) 780, 3318 +FormRadioButtonGroup (API Object) 791, 3329 +IsoSurface3DFormat (API Object) 3395 +MeshSegmentReference (API Object) 1213 +MeshVertexReference (API Object) 1240 +OptimisationGoalProcessingSteps (API Object) 1464 +ValueAt (API Method) +DataSetAxis (API Object) 3099 +ValuePercentage (API Property) +IsoSurface3DFormat (API Object) 3396 +Values (API Property) +CharacteristicModeTrace (API Object) 2990 +Contours3DFormat (API Object) 3044 +CustomDataSmithTrace (API Object) 3061 +CustomDataTrace (API Object) 3074 +DataSetAxis (API Object) 3099 +ExcitationSmithTrace (API Object) 3140 +ExcitationTrace (API Object) 3149 +FarFieldPowerIntegralTrace (API Object) 3192 +FarFieldTrace (API Object) 3214 +LoadSmithTrace (API Object) 3457 +LoadTrace (API Object) 3467 +MathTrace (API Object) 3484 +NearFieldPowerIntegralTrace (API Object) 3607 +NearFieldTrace (API Object) 3633 +NetworkTrace (API Object) 3650 +OptimisationMask (API Object) 1469 +PowerTrace (API Object) 3703 +ReceivingAntennaTrace (API Object) 3732 +ResultTrace (API Object) 3777 +SARTrace (API Object) 3793 +SParameterTrace (API Object) 3820 +SpiceProbeTrace (API Object) 3941 +TRCoefficientTrace (API Object) 4006 +WireCurrentsTrace (API Object) 4096 +ValuesNormalised (API Property) +CharacteristicModeQuantity (API Object) 2982 +CustomDataQuantity (API Object) 3056 +ExcitationQuantity (API Object) 3131 +FarFieldQuantity (API Object) 3196 +LoadQuantity (API Object) 3446 +NearFieldQuantity (API Object) 3614 +PowerIntegralQuantity (API Object) 3689 +PowerQuantity (API Object) 3695 +RaysQuantity (API Object) 3723 +ReceivingAntennaQuantity (API Object) 3728 +SParameterQuantity (API Object) 3805 +SpiceProbeQuantity (API Object) 3934 +SurfaceCurrentsQuantity (API Object) 3959 +TRQuantity (API Object) 4010 +WireCurrentsQuantity (API Object) 4090 +ValuesScaledToDB (API Property) +CustomDataQuantity (API Object) 3056 +ExcitationQuantity (API Object) 3132 +FarFieldQuantity (API Object) 3197 +LoadQuantity (API Object) 3446 +NearFieldQuantity (API Object) 3614 +PowerIntegralQuantity (API Object) 3690 +PowerQuantity (API Object) 3695 +RaysQuantity (API Object) 3723 +ReceivingAntennaQuantity (API Object) 3728 +SParameterQuantity (API Object) 3805 +SpiceProbeQuantity (API Object) 3934 +SurfaceCurrentsQuantity (API Object) 3959 +TRQuantity (API Object) 4011 +WireCurrentsQuantity (API Object) 4091 +ValuesScaledToLog (API Property) +ErrorEstimatesQuantity (API Object) 3120 +ValuesType (API Property) +Contours3DFormat (API Object) 3044 +Variable (API Object) 2178 +Variable (API Property) +OptimisationVariable (API Object) 1490 +variable assignment +Lua 14 +VariableCollection (API Collection) 2685 +Variables (API Collection) +ModelDefinitions (API Object) 1291 +Variables (API Property) +OptimisationParameters (API Object) 1479 +Vector (API Object) 2182 +Version (API Object) 2185, 4030 +Version (API Property) +Application (API Object) 145, 2931 +VertexIndices (API Property) +MeshCube (API Object) 3517 +MeshCurvilinearSegment (API Object) 3522 +MeshCurvilinearTriangle (API Object) 3527 +MeshCylinder (API Object) 3532 +MeshPolygon (API Object) 3543 +MeshSegment (API Object) 3550 +MeshTetrahedron (API Object) 3558 +MeshTriangle (API Object) 3561 +VertexTolerance (API Property) +MeshImporter (API Object) 1185 +VerticalAxis (API Property) +CartesianGraph (API Object) 2956 +CartesianSurfaceGraph (API Object) 2970 +VerticalGraphAxis (API Object) 4032 +VerticalIndependentAxis (API Property) +CustomDataSurfacePlot (API Object) 3067 +FarFieldSurfacePlot (API Object) 3207 +NearFieldSurfacePlot (API Object) 3625 +ResultSurfacePlot (API Object) 3764 +SParameterSurfacePlot (API Object) 3813 +VerticalLabelsVisible (API Property) +CartesianGridLines (API Object) 2965 +CartesianSurfaceGraphGridLines (API Object) 2976 +VerticalLine (API Property) +CartesianGridLines (API Object) 2965 +CartesianSurfaceGraphGridLines (API Object) 2976 +VerticalSurfaceGraphAxis (API Object) 4035 +Vertices (API Property) +MeshRendering (API Object) 3548 +VerticesVisible (API Property) +MeshSegmentsFormat (API Object) 3555 +View (API Object) 4037 +View (API Property) +ViewXtWindow (API Object) 2204 +View3DAnimationFormat (API Object) 4044 +View3DAxesFormat (API Object) 2188, 4047 +View3DAxesFormatList (API Object) 2190 +View3DFormat (API Object) 4050 +View3DLegendRangeFormat (API Object) 4053 +View3DSolutionEntityFormat (API Object) 4056 +View3DSourceFormat (API Object) 4060 +ViewCollection (API Collection) 4273 +ViewDisplayMode (API Object) 2192 +ViewDisplayModeList (API Object) 2194 +ViewRenderingOptions (API Object) 2196 +ViewRenderingOptionsList (API Object) 2198 +Views (API Collection) +Application (API Object) 2932 +ViewXt (API Object) 2200 +ViewXtWindow (API Object) 2203 +VIncrement (API Property) +HighFrequencySettings (API Object) 949 +Visible (API Property) +Arrows3DFormat (API Object) 2937 +Axes3DFormat (API Object) 2938 +CartesianGridLines (API Object) 2965 +CartesianSurfaceGraphGridLines (API Object) 2976 +CharacteristicModeTrace (API Object) 2990 +Contours3DFormat (API Object) 3044 +CustomData3DPlot (API Object) 3052 +CustomDataSmithTrace (API Object) 3061 +CustomDataSurfacePlot (API Object) 3067 +CustomDataTrace (API Object) 3074 +ErrorEstimate3DPlot (API Object) 3115 +ExcitationSmithTrace (API Object) 3140 +ExcitationTrace (API Object) 3150 +FarField3DPlot (API Object) 3170 +FarFieldPowerIntegralTrace (API Object) 3192 +FarFieldSurfacePlot (API Object) 3207 +FarFieldTrace (API Object) 3214 +FormCheckBox (API Object) 708, 3229 +FormComboBox (API Object) 713, 3235 +FormConfigurationSelector (API Object) 3240 +FormDataSelector (API Object) 3246 +FormDirectoryBrowser (API Object) 718, 3251 +FormDoubleSpinBox (API Object) 724, 3257 +FormFileBrowser (API Object) 730, 3263 +FormFileSaveAsBrowser (API Object) 735, 3268 +FormGroupBox (API Object) 741, 3274 +FormImage (API Object) 747, 3280 +FormIntegerSpinBox (API Object) 753, 3285 +FormItem (API Object) 758, 3291 +FormLabel (API Object) 762, 3295 +FormLabelledItem (API Object) 766, 3299 +FormLayout (API Object) 770, 3303 +FormLineEdit (API Object) 776, 3309 +FormModelSelector (API Object) 3314 +FormPushButton (API Object) 786, 3324 +FormRadioButtonGroup (API Object) 792, 3330 +FormScrollArea (API Object) 798, 3335 +FormSeparator (API Object) 803, 3341 +FormTree (API Object) 808, 3346 +LoadSmithTrace (API Object) 3457 +LoadTrace (API Object) 3467 +MathTrace (API Object) 3484 +NearField3DPlot (API Object) 3587 +NearFieldPowerIntegralTrace (API Object) 3607 +NearFieldSurfacePlot (API Object) 3625 +NearFieldTrace (API Object) 3633 +NetworkTrace (API Object) 3650 +PolarGridLines (API Object) 3684 +PowerTrace (API Object) 3703 +Ray3DPlot (API Object) 3714 +ReceivingAntennaTrace (API Object) 3733 +Result3DPlot (API Object) 3748 +ResultSurfacePlot (API Object) 3764 +ResultTrace (API Object) 3777 +SAR3DPlot (API Object) 3780 +SARTrace (API Object) 3793 +ShadowFormat (API Object) 3823 +SParameterSurfacePlot (API Object) 3813 +SParameterTrace (API Object) 3820 +SpiceProbeTrace (API Object) 3941 +SurfaceCurrents3DPlot (API Object) 3946 +SurfaceGraphShadowFormat (API Object) 3981 +TRCoefficientTrace (API Object) 4006 +WireCurrents3DPlot (API Object) 4078 +WireCurrentsTrace (API Object) 4096 +Visual Basic for Applications (VBA) 10 +Visualisation (API Property) +CustomData3DPlot (API Object) 3052 +FarField3DPlot (API Object) 3170 +NearField3DPlot (API Object) 3587 +Ray3DPlot (API Object) 3714 +SurfaceCurrents3DPlot (API Object) 3946 +WireCurrents3DPlot (API Object) 4078 +VisualisationType (API Property) +RequestPoints3DFormat (API Object) 3745 +VoltageControlledVoltageSource (API Object) 2207 +VoltageGain (API Property) +VoltageControlledVoltageSource (API Object) 2210 +VoltageProbeEnabled (API Property) +Capacitor (API Object) 285 +ComplexLoad (API Object) 332 +Inductor (API Object) 993 +Resistor (API Object) 1770 +Transformer (API Object) 2119 +VoltageControlledVoltageSource (API Object) 2210 +VoltageSource (API Object) 2212 +Volumes (API Property) +MeshRendering (API Object) 3548 +VoxelAdvancedSettings (API Object) 2216 +VoxelAdvancedSettingsList (API Object) 2219 +VoxelCount (API Property) +MeshInfo (API Object) 1195 +ModelMeshInfo (API Object) 1301 +SimulationMeshInfo (API Object) 1877 +VoxelGridSummary (API Object) 2221 +VoxelGridSummaryList (API Object) 2224 +VoxelSettings (API Object) 2226 +VoxelSettings (API Property) +Mesher (API Object) 1245 +VoxelSize (API Property) +VoxelSettings (API Object) 2228 +VoxelStandardDeviation (API Property) +MeshInfo (API Object) 1195 +ModelMeshInfo (API Object) 1301 +SimulationMeshInfo (API Object) 1877 +VoxelsTotal (API Property) +VoxelGridSummary (API Object) 2222 +VoxelsX (API Property) +VoxelGridSummary (API Object) 2222 +VoxelsY (API Property) +VoxelGridSummary (API Object) 2223 +VoxelsZ (API Property) +VoxelGridSummary (API Object) 2223 +VPoints (API Property) +CartesianStructure (API Object) 296 +VVector (API Property) +DataSetMetaData (API Object) 3109 +GlobalPlane (API Object) 904 +Workplane (API Object) 2273 +Warning (API StaticFunction) +Form (API Object) 702, 3224 +Warnings (API Property) +Interpolator (API Object) 3391 +LaunchResult (API Object) 3399 +WaveguideExcitationStoredData (API Object) 4062 +WaveguideMeshPort (API Object) 2230 +WaveguideModeOptions (API Object) 2235 +WaveguideModeOptionsList (API Object) 2238 +WaveguideModeType (API Property) +PortProperties (API Object) 1657 +WaveguideModeOptions (API Object) 2237 +WaveguidePort (API Object) 2240 +WaveguideSource (API Object) 2245 +WeaveAngle (API Property) +ShieldLayerSettings (API Object) 1836 +WeaveAngleDeviation (API Property) +ShieldLayerSettings (API Object) 1837 +WeaveDefinitionMethod (API Property) +ShieldLayerSettings (API Object) 1837 +Weight (API Property) +FarFieldOptimisationGoal (API Object) 641 +GraphLineFormat (API Object) 3374 +ImpedanceOptimisationGoal (API Object) 965 +NearFieldOptimisationGoal (API Object) 1352 +NurbsControlPoint (API Object) 1381 +OptimisationCombination (API Object) 1450 +OptimisationGoal (API Object) 1458 +PowerOptimisationGoal (API Object) 1666 +ReceivingAntennaOptimisationGoal (API Object) 1714 +SAROptimisationGoal (API Object) 1797 +SParameterOptimisationGoal (API Object) 1809 +SurfaceGraphLineFormat (API Object) 3980 +TraceLineFormat (API Object) 4019 +TransmissionReflectionOptimisationGoal (API Object) 2138 +WHILE loop +Lua 16 +Width (API Property) +Box (API Object) 174 +CartesianGraph (API Object) 2956 +CartesianStructure (API Object) 296 +CartesianSurfaceGraph (API Object) 2970 +Cuboid (API Object) 393 +Form (API Object) 699, 3221 +FormImage (API Object) 747, 3280 +FormProgressDialog (API Object) 780, 3318 +Graph (API Object) 3356 +Hexagon (API Object) 937 +HexagonShape (API Object) 942 +MdiSubWindow (API Object) 1122 +PlaneShape (API Object) 1594 +PolarGraph (API Object) 3676 +Rectangle (API Object) 1719 +ReportImageSizeSetting (API Object) 3736 +ResultTextBox (API Object) 3771 +SchematicViewWindow (API Object) 1820 +SmithChart (API Object) 3833 +StripHexagon (API Object) 2032 +StripHexagonShape (API Object) 2037 +SurfaceGraph (API Object) 3962 +View (API Object) 4040 +ViewXtWindow (API Object) 2205 +Window (API Object) 4072 +WidthAnnotation (API Object) 4065 +WidthType (API Property) +WidthAnnotation (API Object) 4069 +Window (API Object) 4071 +Window (API Property) +ReportTemplateTagSettings (API Object) 3743 +WindowActive (API Property) +CartesianGraph (API Object) 2957 +CartesianSurfaceGraph (API Object) 2970 +Graph (API Object) 3356 +MdiSubWindow (API Object) 1122 +PolarGraph (API Object) 3676 +SmithChart (API Object) 3833 +SurfaceGraph (API Object) 3962 +View (API Object) 4040 +Window (API Object) 4073 +WindowCollection (API Collection) 4277 +Windows (API Collection) +Application (API Object) 2932 +Windows (API Property) +ReportTemplate (API Object) 3740 +WindowTitle (API Property) +CartesianGraph (API Object) 2957 +CartesianSurfaceGraph (API Object) 2970 +Graph (API Object) 3356 +PolarGraph (API Object) 3676 +SmithChart (API Object) 3834 +SurfaceGraph (API Object) 3963 +View (API Object) 4040 +Window (API Object) 4073 +Windscreen (API Collection) +Media (API Object) 1129 +Windscreen (API Object) 2249 +Windscreen (API Property) +Edge (API Object) 493 +Face (API Object) 614 +MeshCurvilinearSegmentWire (API Object) 1156 +MeshCurvilinearTriangleFace (API Object) 1163 +MeshPlate (API Object) 1202 +MeshSegmentWire (API Object) 1219 +MeshTriangleFace (API Object) 1237 +WindscreenCollection (API Collection) 2690 +WindscreenLayersVisible (API Property) +MeshRendering (API Object) 3549 +ViewRenderingOptions (API Object) 2197 +WindscreenOpacity (API Property) +MeshRendering (API Object) 3549 +WindscreenSolutionMethod (API Object) 2253 +WindscreenSolutionMethodList (API Object) 2255 +WindscreenVisible (API Property) +MeshEdgesFormat (API Object) 3536 +MeshFacesFormat (API Object) 3540 +MeshVerticesFormat (API Object) 3571 +Wire (API Property) +WirePort (API Object) 2265 +WireCollection (API Collection) 2694 +WireCurrents (API Collection) +SolutionConfiguration (API Object) 3847 +WireCurrents3DPlot (API Object) 4075 +WireCurrentsAndChargesStoredData (API Object) 4081 +WireCurrentsCollection (API Collection) 4280 +WireCurrentsData (API Object) 4083 +WireCurrentsMathScript (API Object) 4086 +WireCurrentsQuantity (API Object) 4089 +WireCurrentsTrace (API Object) 4092 +WireMeshPort (API Object) 2257 +WirePort (API Object) 2262 +WireRadius (API Property) +GlobalMeshSettings (API Object) 897 +LocalMeshSettings (API Object) 1073 +MeshImporter (API Object) 1185 +MeshSettings (API Object) 1225 +VoxelSettings (API Object) 2228 +Wires (API Collection) +AbstractSurfaceCurve (API Object) 100 +AnalyticalCurve (API Object) 123 +BezierCurve (API Object) 165 +Cone (API Object) 354 +ConstrainedSurface (API Object) 368 +Cross (API Object) 382 +Cuboid (API Object) 394 +Cylinder (API Object) 426 +Ellipse (API Object) 515 +EllipticArc (API Object) 528 +FittedSpline (API Object) 683 +Flare (API Object) 693 +Geometry (API Object) 869 +Helix (API Object) 929 +Hexagon (API Object) 937 +HyperbolicArc (API Object) 958 +ImprintPoints (API Object) 985 +Intersect (API Object) 1003 +Line (API Object) 1045 +Loft (API Object) 1087 +Mesh (API Object) 1139 +NurbsSurface (API Object) 1390 +OpenRing (API Object) 1438 +ParabolicArc (API Object) 1528 +Paraboloid (API Object) 1536 +PathSweep (API Object) 1563 +Polygon (API Object) 1634 +Polyline (API Object) 1642 +Primitive (API Object) 1676 +ProjectGeometry (API Object) 1684 +Rectangle (API Object) 1720 +RepairAndSewFaces (API Object) 1743 +RepairPart (API Object) 1757 +Ring (API Object) 1776 +Simplify (API Object) 1845 +Sphere (API Object) 1912 +Spin (API Object) 1962 +SpiralCross (API Object) 1971 +Split (API Object) 1984 +SplitRing (API Object) 1993 +Stitch (API Object) 2011 +StripCross (API Object) 2020 +StripHexagon (API Object) 2032 +Subtract (API Object) 2043 +SurfaceBezierCurve (API Object) 2052 +SurfaceLine (API Object) 2068 +SurfaceRegularLines (API Object) 2078 +Sweep (API Object) 2088 +TCross (API Object) 2097 +Trifilar (API Object) 2144 +Union (API Object) 2162 +Wires (API Property) +MeshRendering (API Object) 3549 +WireSegmentLength (API Property) +GlobalMeshSettings (API Object) 897 +LocalMeshSettings (API Object) 1073 +MeshSettings (API Object) 1225 +Workplane (API Object) 2271 +WorkplaneCollection (API Collection) 2704 +WorkplaneDefinitionOption (API Property) +LocalWorkplane (API Object) 1078 +Workplanes (API Collection) +ModelDefinitions (API Object) 1291 +WorkSurface (API Object) 2267 +WorkSurface (API Property) +AbstractSurfaceCurve (API Object) 99 +SurfaceBezierCurve (API Object) 2051 +SurfaceLine (API Object) 2068 +SurfaceRegularLines (API Object) 2078 +WorkSurfaceCollection (API Collection) 2699 +WorkSurfaces (API Collection) +ModelDefinitions (API Object) 1291 +X (API Property) +CylindricalXRequestPoints (API Object) 451 +GlobalCoordinates (API Object) 892 +GlobalOrigin (API Object) 899 +GlobalVector (API Object) 907 +OptimisationMaskValues (API Object) 1471 +Point (API Object) 1604, 3666 +UVPoint (API Object) 2156 +Vector (API Object) 2183 +XPosition (API Property) +CartesianGraph (API Object) 2957 +CartesianSurfaceGraph (API Object) 2970 +Graph (API Object) 3357 +MdiSubWindow (API Object) 1122 +PolarGraph (API Object) 3676 +SmithChart (API Object) 3834 +SurfaceGraph (API Object) 3963 +View (API Object) 4041 +Window (API Object) 4073 +Y (API Property) +CylindricalYRequestPoints (API Object) 455 +GlobalCoordinates (API Object) 892 +GlobalOrigin (API Object) 899 +GlobalVector (API Object) 908 +OptimisationMaskValues (API Object) 1471 +Point (API Object) 1605, 3667 +UVPoint (API Object) 2156 +Vector (API Object) 2183 +YPosition (API Property) +CartesianGraph (API Object) 2957 +CartesianSurfaceGraph (API Object) 2970 +Graph (API Object) 3357 +MdiSubWindow (API Object) 1122 +PolarGraph (API Object) 3677 +SmithChart (API Object) 3834 +SurfaceGraph (API Object) 3963 +View (API Object) 4041 +Window (API Object) 4073 +Z (API Property) +ConicalRequestPoints (API Object) 360 +CylindricalRequestPoints (API Object) 443 +GlobalCoordinates (API Object) 892 +GlobalOrigin (API Object) 900 +GlobalVector (API Object) 908 +Point (API Object) 1605, 3667 +UVPoint (API Object) 2156 +Vector (API Object) 2183 +Z0Imaginary (API Property) +Power (API Object) 1662 +TransmissionLine (API Object) 2130 +Z0Real (API Property) +Power (API Object) 1662 +TransmissionLine (API Object) 2130 +Zero (API Object) 2277 +Zero (API Property) +Media (API Object) 1128 +Zeros (API StaticFunction) +ComplexMatrix (API Object) 3038 +Matrix (API Object) 3511 +Zip (API Function) +Archive (API Object) 4288 +ZLockEnabled (API Property) +View3DFormat (API Object) 4051 +ZoomDistance (API Property) +View3DFormat (API Object) 4052 +ZoomIn (API Method) +SchematicViewWindow (API Object) 1821 +ZoomOut (API Method) +SchematicViewWindow (API Object) 1821 +ZoomToExtents (API Method) +CartesianGraph (API Object) 2961 +CartesianSurfaceGraph (API Object) 2973 +Graph (API Object) 3360 +PolarGraph (API Object) 3680 +SchematicViewWindow (API Object) 1822 +SmithChart (API Object) 3837 +SurfaceGraph (API Object) 3965 +View (API Object) 4043 +ViewXt (API Object) 2202 +Window (API Object) 4074 +ZValue (API Property) +GroundPlane (API Object) 917 +UnitCell (API Object) 2168 + +Intellectual Property Rights Notice +Copyright © 1986-2023 Altair Engineering Inc. All Rights Reserved. +This Intellectual Property Rights Notice is exemplary, and therefore not exhaustive, of intellectual +property rights held by Altair Engineering Inc. or its affiliates. Software, other products, and materials +of Altair Engineering Inc. or its affiliates are protected under laws of the United States and laws of +other jurisdictions. In addition to intellectual property rights indicated herein, such software, other +products, and materials of Altair Engineering Inc. or its affiliates may be further protected by patents, +additional copyrights, additional trademarks, trade secrets, and additional other intellectual property +rights. For avoidance of doubt, copyright notice does not imply publication. Copyrights in the below are +held by Altair Engineering Inc. or its affiliates. Additionally, all non-Altair marks are the property of their +respective owners. +This Intellectual Property Rights Notice does not give you any right to any product, such as software, +or underlying intellectual property rights of Altair Engineering Inc. or its affiliates. Usage, for example, +of software of Altair Engineering Inc. or its affiliates is governed by and dependent on a valid license +agreement. +Altair Simulation Products +Altair® AcuSolve® ©1997-2023 +Altair Activate® ©1989-2023 +Altair® Battery Designer™ ©2019-2023 +Altair Compose® ©2007-2023 +Altair® ConnectMe™ ©2014-2023 +Altair® EDEM™ ©2005-2023 +Altair® ElectroFlo™ ©1992-2023 +Altair Embed® ©1989-2023 +Altair Embed® SE ©1989-2023 +Altair Embed®/Digital Power Designer ©2012-2023 +Altair Embed® Viewer ©1996-2023 +Altair® ESAComp® ©1992-2023 +Altair® Feko® ©1999-2023 +Altair® Flow Simulator™ ©2016-2023 +Altair® Flux® ©1983-2023 +Altair® FluxMotor® ©2017-2023 +Altair® HyperCrash® ©2001-2023 +Altair® HyperGraph® ©1995-2023 +Altair® HyperLife® ©1990-2023 +p.iii +Altair Feko 2022.3 +Intellectual Property Rights Notice +Altair® HyperSpice™ ©2017-2023 +Altair® HyperStudy® ©1999-2023 +Altair® HyperView® ©1999-2023 +Altair® HyperViewPlayer® ©2022-2023 +Altair® HyperWorks® ©1990-2023 +Altair® HyperXtrude® ©1999-2023 +Altair® Inspire™ ©2009-2023 +Altair® Inspire™ Cast ©2011-2023 +Altair® Inspire™ Extrude Metal ©1996-2023 +Altair® Inspire™ Extrude Polymer ©1996-2023 +Altair® Inspire™ Form ©1998-2023 +Altair® Inspire™ Mold ©2009-2023 +Altair® Inspire™ PolyFoam ©2009-2023 +Altair® Inspire™ Print3D ©2021-2023 +Altair® Inspire™ Render ©1993-2023 +Altair® Inspire™ Studio ©1993-2023 +Altair® Material Data Center™ ©2019-2023 +Altair® MotionSolve® ©2002-2023 +Altair® MotionView® ©1993-2023 +Altair® Multiscale Designer® ©2011-2023 +Altair® nanoFluidX® ©2013-2023 +Altair® OptiStruct® ©1996-2023 +Altair® PollEx™ ©2003-2023 +Altair® PSIM™ ©2022-2023 +Altair® Pulse™ ©2020-2023 +Altair® Radioss® ©1986-2023 +Altair® romAI™ ©2022-2023 +Altair® S-FRAME® ©1995-2023 +Altair® S-STEEL™ ©1995-2023 +Altair® S-PAD™ ©1995-2023 +Altair® S-CONCRETE™ ©1995-2023 +Altair® S-LINE™ ©1995-2023 +Altair® S-TIMBER™ ©1995-2023 +p.iv +Altair Feko 2022.3 +Intellectual Property Rights Notice +Altair® S-FOUNDATION™ ©1995-2023 +Altair® S-CALC™ ©1995-2023 +Altair® S-VIEW™ ©1995-2023 +Altair® Structural Office™ ©2022-2023 +Altair® SEAM® ©1985-2023 +Altair® SimLab® ©2004-2023 +Altair® SimLab® ST ©2019-2023 +Altair SimSolid® ©2015-2023 +Altair® ultraFluidX® ©2010-2023 +Altair® Virtual Wind Tunnel™ ©2012-2023 +Altair® WinProp™ ©2000-2023 +Altair® WRAP™ ©1998-2023 +Altair® GateVision PRO™ ©2002-2023 +Altair® RTLvision PRO™ ©2002-2023 +Altair® SpiceVision PRO™ ©2002-2023 +Altair® StarVision PRO™ ©2002-2023 +Altair® EEvision™ ©2018-2023 +Altair Packaged Solution Offerings (PSOs) +Altair® Automated Reporting Director™ ©2008-2022 +Altair® e-Motor Director™ ©2019-2023 +Altair® Geomechanics Director™ ©2011-2022 +Altair® Impact Simulation Director™ ©2010-2022 +Altair® Model Mesher Director™ ©2010-2023 +Altair® NVH Director™ ©2010-2023 +Altair® NVH Full Vehicle™ ©2022-2023 +Altair® NVH Standard™ ©2022-2023 +Altair® Squeak and Rattle Director™ ©2012-2023 +Altair® Virtual Gauge Director™ ©2012-2023 +Altair® Weld Certification Director™ ©2014-2023 +Altair® Multi-Disciplinary Optimization Director™ ©2012-2023 +Altair HPC & Cloud Products +Altair® PBS Professional® ©1994-2023 +Altair® PBS Works™ ©2022-2023 +p.v +Altair Feko 2022.3 +Intellectual Property Rights Notice +Altair® Control™ ©2008-2023 +Altair® Access™ ©2008-2023 +Altair® Accelerator™ ©1995-2023 +Altair® Accelerator™ Plus ©1995-2023 +Altair® FlowTracer™ ©1995-2023 +Altair® Allocator™ ©1995-2023 +Altair® Monitor™ ©1995-2023 +Altair® Hero™ ©1995-2023 +Altair® Software Asset Optimization (SAO) ©2007-2023 +Altair Mistral™ ©2022-2023 +Altair® Grid Engine® ©2001, 2011-2023 +Altair® DesignAI™ ©2022-2023 +Altair Breeze™ ©2022-2023 +Altair® NavOps® ©2022-2023 +Altair® Unlimited™ ©2022-2023 +Altair Data Analytics Products +Altair Analytics Workbench™ © 2002-2023 +Altair® Knowledge Studio® ©1994-2023 +Altair® Knowledge Studio® for Apache Spark ©1994-2023 +Altair® Knowledge Seeker™ ©1994-2023 +Altair® Knowledge Hub™ ©2017-2023 +Altair® Monarch® ©1996-2023 +Altair® Panopticon™ ©2004-2023 +Altair® SmartWorks™ ©2021-2023 +Altair SLC™ ©2002-2023 +Altair SmartWorks Hub™ ©2002-2023 +Altair® RapidMiner® ©2001-2023 +Altair One™ ©1994-2023 +2022.3 +March 17, 2023 +Technical Support +Altair provides comprehensive software support via web FAQs, tutorials, training classes, telephone, and +e-mail. +Altair One Customer Portal +Altair One (https://altairone.com/) is Altair’s customer portal giving you access to product downloads, a +Knowledge Base, and customer support. We recommend that all users create an Altair One account and +use it as their primary portal for everything Altair. +When your Altair One account is set up, you can access the Altair support page via this link: +www.altair.com/customer-support/ +Altair Community +Participate in an online community where you can share insights, collaborate with colleagues and peers, +and find more ways to take full advantage of Altair’s products. +Visit the Altair Community (https://community.altair.com/community) where you can access online +discussions, a knowledge base of product information, and an online form to contact Support. After you +login to the Altair Community, subscribe to the forums and user groups to get up-to-date information +about release updates, upcoming events, and questions asked by your fellow members. +These valuable resources help you discover, learn and grow, all while having the opportunity to network +with fellow explorers like yourself. +Altair Training Classes +Altair’s in-person, online, and self-paced trainings provide hands-on introduction to our products, +focusing on overall functionality. Trainings are conducted at our corporate and regional offices or at your +facility. +For more information visit: https://learn.altair.com/ +If you are interested in training at your facility, contact your account manager for more details. If you +do not know who your account manager is, contact your local support office and they will connect you +with your account manager. +Telephone and E-mail +If you are unable to contact Altair support via the customer portal, you may reach out to technical +support via phone or e-mail. Use the following table as a reference to locate the support office for your +region. +Altair support portals are available 24x7 and our global support engineers are available during normal +Altair business hours in your region. +When contacting Altair support, specify the product and version number you are using along with +a detailed description of the problem. It is beneficial for the support engineer to know what type +of workstation, operating system, RAM, and graphics board you have, so include that in your +Altair Feko 2022.3 +Technical Support +p.vii +Location +Australia +Brazil +Canada +China +France +Germany +Greece +India +Israel +Italy +Japan +Malaysia +Mexico +New Zealand +South Africa +South Korea +Spain +Sweden +Telephone +E-mail ++61 3 9866 5557 +anzsupport@altair.com ++55 113 884 0414 +br_support@altair.com ++1 416 447 6463 +support@altairengineering.ca ++86 400 619 6186 +support@altair.com.cn ++33 141 33 0992 +francesupport@altair.com ++49 703 162 0822 +hwsupport@altair.de ++30 231 047 3311 +eesupport@altair.com ++91 806 629 4500 +support@india.altair.com ++1 800 425 0234 (toll free) ++39 800 905 595 +support@altairengineering.it +israelsupport@altair.com ++81 3 6225 5830 +jp-support@altair.com ++60 32 742 7890 +aseansupport@altair.com ++52 55 5658 6808 +mx-support@altair.com ++64 9 413 7981 +anzsupport@altair.com ++27 21 831 1500 +support@altair.co.za ++82 704 050 9200 +support@altair.co.kr ++34 910 810 080 +support-spain@altair.com ++46 46 460 2828 +support@altair.se +United Kingdom ++44 192 646 8600 +support@uk.altair.com +United States ++1 248 614 2425 +hwsupport@altair.com +If your company is being serviced by an Altair partner, you can find that information on our web site at +https://www.altair.com/PartnerSearch/. +See www.altair.com for complete information on Altair, our team, and our products. +Antenna Synthesis and +Analysis +A Antenna Synthesis and Analysis +Simple examples demonstrating antenna synthesis and analysis. +This chapter covers the following: +• A.1 Dipole (p. 16) +• A.2 Dipole in Front of a Cube (p. 19) +• A.3 Dipole in Front of a Plate (p. 25) +• A.4 Monopole Antenna on a Finite Ground Plane (p. 36) +• A.5 Yagi-Uda Antenna Above a Real Ground (p. 40) +• A.6 Pattern Optimisation of a Yagi-Uda Antenna (p. 44) +• A.7 Log Periodic Dipole Array Antenna (p. 49) +• A.8 Microstrip Patch Antenna (p. 54) +• A.9 Proximity Coupled Patch Antenna with Microstrip Feed (p. 65) +• A.10 Aperture Coupled Patch Antenna (p. 68) +• A.11 Different Ways to Feed a Horn Antenna (p. 77) +• A.12 Dielectric Resonator Antenna on Finite Ground (p. 88) +• A.13 Dielectric Lens Antenna (p. 97) +• A.14 Windscreen Antenna on an Automobile (p. 101) +• A.15 MIMO Elliptical Ring Antenna (Characteristic Modes) (p. 106) +• A.16 Periodic Boundary Conditions for Array Analysis (p. 113) +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +A.1 Dipole +p.16 +Calculate the radiation pattern and input impedance for a half-wavelength dipole at 74.9 MHz. The +dipole length is 2 m with a wire radius of 2 mm. +Figure 1: A 3D view of the dipole with a voltage source in CADFEKO. +A.1.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables: +• lambda = 4 (The wavelength in free space.) +• freq = c0/lambda (The operating frequency.) +• h = lambda/2 (Length of the dipole.) +• radius = 2E-3 (Radius of the wire.) +2. Create the dipole. +a) Create a line. +• Start point: (0, 0, -h/2) +• End point: (0, 0, h/2) +b) Add a wire port to the middle of the line. +c) Add a voltage source to the port. (1 V, 0°, 50 Ω). +3. Set the frequency to freq. +A.1.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a vertical far field request (-180°≤θ≤180°, with ϕ=0°). Sample the far field at θ=2° steps. +A.1.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to radius. +A.1.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.1.5 Viewing the Results +View and post-process the results in POSTFEKO. +1. View the gain (in dB) of the requested far field pattern using a polar plot. +a) On the Display tab, in the Axes group, click Axis settings, and then click the Radial tab. +Set Maximum dynamic range in dB to 10 dB. +Figure 2: A polar plot of the requested far field gain (dB) viewed in POSTFEKO. +2. Review the impedance at a single frequency using one of the following methods: +• Plot the impedance as a function of frequency on a Cartesian graph or Smith chart. +• View the impedance value in the *.out file. Open the .out file in the output file viewer (in +POSTFEKO), or in any other text file viewer. + DATA OF THE VOLTAGE SOURCE NO. 1 + real part imag. part magnitude phase + Current in A 1.0144E-02 -4.9861E-03 1.1303E-02 -26.18 + Admitt. in A/V 1.0144E-02 -4.9861E-03 1.1303E-02 -26.18 + Impedance in Ohm 7.9398E+01 3.9027E+01 8.8471E+01 26.18 + Inductance in H 8.2875E-08 +A.2 Dipole in Front of a Cube +Calculate the radiation pattern for a half-wavelength dipole in front of a cuboid. View the effect of the +cuboid on the radiation pattern. +The far field results are compared for the following cuboid configurations: +1. Perfect electric conductor (PEC) cuboid +2. Lossy metallic cuboid +3. Dielectric cuboid +Figure 3: A 3D view of the dipole in front of a PEC cuboid in CADFEKO. +Tip: Each model uses its predecessor as a starting point. Create the models in their +presentation order. Save each model to a new location to keep them. +A.2.1 Dipole and PEC Cube +Create the dipole and cuboid. Model the cuboid using PEC. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables: +• lambda = 4 (The wavelength in free space.) +• freq = c0/lambda (The operating frequency.) +• h = lambda/2 (Length of the dipole.) +• radius = 4e-3 (Radius of the wire.) +2. Define the following named points: +• cuboidCorner: (0, -lambda/4, -lambda/4) +• lineEnd: (0, 0, h/2) +• lineStart: (0, 0, -h/2) +• offset: (-3*lambda/4, 0, 0) +3. Create a cube. +a) Create a cuboid. By default the cuboid is PEC. +• Definition method: Base corner, width, depth, height +• Base corner: (cuboidCorner, cuboidCorner, cuboidCorner) +• Width (W): lambda/2 +• Depth (D): lambda/2 +• Height (H): lambda/2 +4. Create the dipole. +a) Create a line. +• Start point: (lineStart, lineStart, lineStart) +• End point: (lineEnd, lineEnd, lineEnd) +b) Translate the line in the negative X direction from (0, 0, 0) to the named point, offset. +c) Add a wire port to the middle of the line. +d) Add a voltage source to the port. (1 V, 0°, 50 Ω). +5. Set the frequency to freq. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +View the distortion in the radiation pattern of the dipole due to the proximity of the cuboid. +Create a horizontal far field request (0°≤ϕ≤360°, with θ=90°). Sample the far field at ϕ=2° steps. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to radius. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.2.2 Dipole and Lossy Metal Cube +Create the dipole and cuboid. Model the cuboid using lossy metallic surfaces and the region inside the +cuboid as a vacuum. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Dipole and PEC Cube and rename the file. +2. Create a metallic medium. +a) Label: lossy_metal +b) Conductivity: 1e2 +3. Set the region inside the cuboid to Free space. +Tip: Open the Modify Region dialog and click the Properties tab. From the Medium +list select Free space. +4. Change the cuboid faces to lossy_metal and set the thickness to 0.005. +Tip: Open the Modify Face dialog and click the Properties tab. From the Medium +list select lossy_metal. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Dipole and PEC Cube model. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for Dipole and PEC Cube model. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.2.3 Dipole and Dielectric Cube +Create the dipole and cuboid. Model the cuboid as a dielectric solid. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Dipole and Lossy Metal Cube and rename the file. +2. Create a dielectric medium. +a) Label: diel +b) Relative permittivity: 2 +3. Set the region inside the cuboid to diel. +4. Set the face media for all faces of the cuboid to Default. +Note: When the Default face medium is specified, CADFEKO selects the face medium +based on the region setting. +5. Delete the lossy_metal medium. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests from the Dipole and PEC Cube model. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for Dipole and PEC Cube model. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +A.2.4 Viewing the Results +View and post-process the results in POSTFEKO. +Compare the gain (in dB) of the requested far field patterns on a polar plot. +p.24 +Figure 4: A polar plot of the requested radiation patterns for the dipole and cuboid configurations in POSTFEKO. +Note: View the pronounced scattering effect of the cuboid on the dipole radiation pattern. +The dielectric cube results in a gain increase in the direction of the cube. +A.3 Dipole in Front of a Plate +Calculate the radiation pattern of a dipole in front of an electrically large plate. Several techniques +available in Feko are considered and the results and resource requirements compared. +The radiation pattern is compared for the following techniques: +1. Method of moments (MoM) +2. Method of moments with higher order basis functions (HOBF) +3. Finite difference time domain (FDTD) +4. Uniform theory of diffraction (UTD) +5. Ray-launching geometrical optics (RL-GO) +6. Physical optics (PO) +7. Large element physical optics (LE-PO) +Figure 5: A 3D view of the dipole with a metallic plate. +Tip: Each model uses its predecessor as a starting point. Create the models in their +presentation order. Save each model to a new location to keep them. +A.3.1 Dipole in Front of a Plate with MoM +Create the dipole and the rectangular plate. Solve the model using the method of moments (MoM). +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables: +• d = 2.25 (Distance between dipole and plate. [3*lambda/4]) +• h = 1.5 (Length of the dipole. [lambda/2]) +• a = 4.5 (Half the plate length.) +• rho = 0.03 (Radius of the wire.) +2. Create the dipole. +a) Create a line. +• Start point: (d, 0, -h/2) +• End point: (d, 0, h/2) +3. Create the plate. +a) Create a rectangle. +• Definition method: Base centre, width, depth +• Base centre (C): (0, 0, 0) +• Width (W): 2*a +• Depth (D): 2*a +• Custom workplane: +◦ Origin: (0, 0, 0) +◦ U vector: (0, 0, -1) +◦ V vector: (0, 1, 0) +4. Add a wire port to the middle of the line. +5. Add a voltage source to the port. (1 V, 0°, 50 Ω). +6. Set the Frequency to c0/3. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +View the distortion in the dipole radiation pattern due to proximity of the plate. +Create a horizontal far field request (0°≤ϕ≤360°, with θ=90°). Sample the far field at ϕ=2° steps. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to rho. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.3.2 Dipole in Front of a Plate with HOBF +Create the dipole and the rectangular plate. Solve the model using the MoM with higher order basis +functions (HOBF). +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Dipole in Front of a Plate with MoM and rename the file. +2. Activate higher order basis functions (HOBF) for the model. +Tip: Open the Solver settings dialog and click the General tab. Select the Solve +MoM with higher order basis functions (HOBF) check box. From the Element +order list, select Auto (default). +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Dipole in Front of a Plate with MoM. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for Dipole in Front of a Plate with MoM. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.3.3 Dipole in Front of a Plate with FDTD +Simulate the dipole and rectangular plate using finite difference time domain (FDTD). +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Dipole in Front of a Plate with MoM and rename the file. +2. Activate the FDTD solver. +Tip: Open the Solver settings dialog and click the FDTD tab. Select the Activate +the finite difference time domain (FDTD) solver check box. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests from the Dipole in Front of a Plate with MoM model. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for Dipole in Front of a Plate with MoM. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.3.4 Dipole in Front of a Plate with UTD +Simulate the dipole with method of moments (MoM) and the rectangular plate using uniform theory of +diffraction (UTD). +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Dipole in Front of a Plate with MoM and rename the file. +2. Set the solver method for the rectangular plate to use UTD. +Tip: Open the Modify Face dialog and click the Solution tab. From the Solve with +special solution method list, select Uniform theory of diffraction (UTD). +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Dipole in Front of a Plate with MoM. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for Dipole in Front of a Plate with MoM. +Note: No mesh triangles are created. Feko applies the UTD solution to the plate surface. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.3.5 Dipole in Front of a Plate with RL-GO +Simulate the dipole with method of moments (MoM) and the rectangular plate using ray launching +geometrical optics (RL-GO). +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Dipole in Front of a Plate with MoM and rename the file. +2. Set the solver method for the rectangular plate to use RL-GO. +Tip: Open the Modify Face dialog and click the Solution tab. From the Solve with +special solution method list, select Ray launching - geometrical optics (RL-GO). +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Dipole in Front of a Plate with MoM. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for Dipole in Front of a Plate with MoM. +Note: Triangle sizes are determined by the geometrical shape and not the operating +wavelength. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.3.6 Dipole in Front of a Plate with PO +Simulate the dipole with method of moments (MoM) and the rectangular plate using physical optics +(PO). +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Dipole in Front of a Plate with MoM and rename the file. +2. Set the solver method for the rectangular plate to use Physical optics (PO) - always +illuminated. +Tip: Open the Modify Face dialog and click the Solution tab. From the Solve with +special solution method list, select Physical optics (PO) - always illuminated. +Note: Use the “always illuminated” option since there is no shadowing effect in the +model. The “always illuminated” option avoids the ray tracing and accelerates the +physical optics solution. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Dipole in Front of a Plate with MoM. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for Dipole in Front of a Plate with MoM. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.3.7 Dipole in Front of a Plate with LE-PO +Simulate the dipole with method of moments (MoM) and the rectangular plate using large element +physical optics (LE-PO). +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Dipole in Front of a Plate with MoM and rename the file. +2. Set the solver method for the rectangular plate to use Large element PO - always illuminated. +Tip: Open the Modify Face dialog and click the Solution tab. From the Solve with +special solution method list, select Large Element PO - always illuminated. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Dipole in Front of a Plate with MoM. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the Mesh size equal to Custom +2. Set the Triangle edge length equal to a/4. +Tip: A small distance separates the dipole and rectangular plate. Use a finer than +Standard mesh setting for the LE-PO. +3. Set the Wire segment length equal to h/10. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +A.3.8 Viewing the Results +View and post-process the results in POSTFEKO. +1. Compare the gain (in dB) of the requested far field patterns on a polar plot. +p.34 +Figure 6: A polar plot of the requested radiation patterns for the different solvers in POSTFEKO. +2. View the runtime and memory requirements for each model in their respective .out files. Open +the .out file in the output file viewer (in POSTFEKO), or in any other text file viewer. +3. Use the MoM solution as reference. +Table 1: Memory and runtime requirements for the different solvers normalised to the MoM solution. +Solution method +Memory (% of MoM) +Runtime (% of MoM) +HOBF +FDTD +UTD +RL-GO +PO +2.3 +31 +0.05 +11.5 +0.95 +34 +161 +0.5 +3.4 +3.3 +Solution method +Memory (% of MoM) +Runtime (% of MoM) +LE-PO +0.11 +1.2 +A.4 Monopole Antenna on a Finite Ground Plane +Calculate the radiation pattern for a wire monopole antenna on a finite ground plane. The ground plane +is modelled as a circular PEC ground plane. +The circumference of the circular ground is 3 wavelengths at 75 MHz. The wire radius of the monopole +antenna is 1 mm. +Figure 7: A 3D view of the monopole on a finite circular ground. +A.4.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables: +• freq = 75e6 (The operating frequency.) +• lambda = c0/freq (The wavelength in free space.) +• groundRadius = 2 (Radius of the ground plane.) +• wireRadius = 1e-3 (Radius of the wire.) +2. Create the circular ground. +a) Create an ellipse. +• Centre point: (0, 0, 0) +• Radius (U): groundRadius +• Radius (V): groundRadius +• Label: ground +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +3. Create the monopole. +a) Create a line. +• Start point: (0, 0, 0) +• End point: (0, 0, lambda/4) +• Label: monopole +4. Union ground and monopole. +5. Add a wire port to the middle of the line. +p.37 +Tip: Use the port preview to ensure the port is located at the junction between the +wire and the ground plane. If the port is not located at the junction, change the port +location to Start. +6. Add a voltage source to the port. (1 V, 0°, 50 Ω). +7. Set the frequency to freq. +A.4.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +1. Create a full 3D far field request. Sample the far field at θ=2° and ϕ=2° steps. +2. Create a currents request (all currents). +A.4.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to wireRadius. +A.4.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.4.5 Viewing the Results +View and post-process the results in POSTFEKO. +1. View the total gain (in dB) in a vertical cut of the requested far field pattern using a polar plot. +Figure 8: A polar plot of the far field gain (dB) in a vertical cut at 75 MHz viewed in POSTFEKO. +2. View the 3D gain pattern in the 3D view in POSTFEKO. +Figure 9: A 3D plot of the antenna gain in POSTFEKO. +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +Hide the far fields in the 3D view. +3. View the currents on the finite ground plane. +p.39 +Figure 10: 3D view of the currents on the ground plane in POSTFEKO. +4. View the phase variation of the currents using animation. +Tip: On the Animate tab, in the Control group, click the Play icon. +A.5 Yagi-Uda Antenna Above a Real Ground +Calculate the radiation pattern for a horizontally polarised Yagi-Uda antenna consisting of a dipole, +a reflector and three directors at 400 MHz. The antenna is located 3 m above a real ground which is +modelled with the Green’s function formulation. +Figure 11: A 3D view of the Yagi-Uda antenna suspended over a real ground. +A.5.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables: +• freq = 400e6 (The operating frequency.) +• lambda = c0/freq (The wavelength in free space.) +• lr = 0.477*lambda (Length of the reflector.) +• li = 0.451*lambda (Length of the active element.) +• ld = 0.442*lambda (Length of the directors.) +• d = 0.25*lambda (Spacing between elements.) +• h = 3 (Height of the antenna above ground.) +• epsr = 10 (Relative permittivity of the ground.) +• sigma = 1e-3 (Conductivity of the ground.) +• wireRadius = 1e-3 (Radius of the wire.) +2. Create the dipole (driven element) of the Yagi-Uda antenna. +a) Create a line. +• Start point: (0, - li/2, h) +• End point: (0, li/2, h) +• Label: activeElement +b) Add a wire port to the middle of the line. +c) Add a voltage source to the port. (1 V, 0°, 50 Ω). +3. Create the reflector of the Yagi-Uda antenna. +a) Create a line. +• Start point: (-d, -lr/2, h) +• End point: (-d, lr/2, h) +• Label: reflector +4. Create the three directors of the Yagi-Uda antenna. +a) Create three lines. +Line +Start point +End point +Label +(d, -ld/2, h) +(d, ld/2, h) +(2*d, -ld/2, h) +(2*d, ld/2, h) +(3*d, -ld/2, h) +(3*d, ld/2, h) +director1 +director2 +director3 +5. Create a new dielectric called ground with relative permittivity set to epsr and conductivity to +sigma. +6. Set the lower half space to ground using the exact Sommerfeld integrals. +7. Set the frequency to freq. +A.5.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a vertical far field request (-90°≤θ≤90°, with ϕ=0°). Sample the far field at θ=0.5° steps. +a) Change the workplane origin to (0,0,3). +A.5.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to wireRadius. +A.5.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Note: The following warning may be encountered when running the Solver: +Directivity cannot be computed for far field calculations involving the +planar multilayer Green's function with losses in the dielectric layers, +gain will be computed instead. +Losses cannot be calculated in an infinitely large medium as is required for the extraction of +antenna directivity information. +Avoid this warning by requesting the far field gain instead of the directivity. Open the +Request/Modify far fields dialog, click the Advanced tab and then click Gain. +A.5.5 Viewing the Results +View and post-process the results in POSTFEKO. +1. View the gain (in dB) of the requested far field pattern on a polar plot. +2. Compare the results to a similar model where the ground plane is removed. +Figure 12: The gain pattern (in dB) of the Yagi-Uda antenna with no ground, a real ground, and the +optimised pattern with a real ground. +Note: Observe the effect of the ground plane on the radiation pattern. +A.6 Pattern Optimisation of a Yagi-Uda Antenna +Optimise a Yagi-Uda antenna design to achieve a specific radiation pattern and gain at 1 GHz. The Yagi- +Uda antenna consists of a dipole, reflector and two directors. +The initial antenna design is created from basic formulae. The antenna design is then optimised +to obtain a gain above 8 dB in the main lobe (-30°≤ϕ≤30°) and below -7 dB in the back lobe +(90°≤ϕ≤270°). +Figure 13: A 3D view of the Yagi-Uda antenna. +A.6.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables: +• freq = 1e9 (The operating frequency.) +• lambda = c0/freq (The wavelength in free space.) +• L0 = 0.2375 (Length of the reflector element in wavelengths.) +• L1 = 0.2265 (Length of the driven element in wavelengths.) +• L2 = 0.2230 (Length of the first director in wavelengths.) +• L3 = 0.2230 (Length of the second director in wavelengths.) +• S0 = 0.3 (Distance between the reflector and driven element in wavelengths.) +• S1 = 0.3 (Distance between the driven element and the first director in wavelengths.) +• S2 = 0.3 (Distance between the two directors in wavelengths.) +• r = 1e-4 (Wire radius.) +2. Set the incident power for the 50 Ω transmission line to 1 W. +3. Create the dipole (driven element) in the Yagi-Uda antenna. +a) Create a line. +• Start point: (0, 0, -L1*lambda) +• End point: (0, 0, L1*lambda) +• Label: activeElement +b) Add a wire port (vertex) to the middle of the line. +c) Add a voltage source to the port. (1 V, 0°, 50 Ω). +4. Create the reflector in the Yagi-Uda antenna. +a) Create a line. +• Start point: (-S0*lambda, 0, -L0*lambda) +• End point: (-S0*lambda, 0, L0*lambda) +• Label: reflector +5. Create the first director in the Yagi-Uda antenna. +a) Create a line. +• Start point: (S1*lambda, 0, -L2*lambda) +• End point: (S1*lambda, 0, L2*lambda) +• Label: director1 +6. Create the second director in the Yagi-Uda antenna. +a) Create a line. +• Start point: ((S1+ S2)*lambda, 0, -L3*lambda) +• End point: ((S1+S2)*lambda, 0, L3*lambda) +• Label: director2 +7. Set the frequency to freq. +A.6.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a horizontal far field request (0°≤ϕ≤180°, with θ=90°). Sample the far field at ϕ=2° steps. +a) Rename the label to H_plane. +A.6.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the Mesh size equal to Standard. +2. Set the Wire segment radius equal to r. +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +3. Mesh the model. +p.46 +A.6.4 Adding an Optimisation Search +Add the optimisation search in CADFEKO. +1. Add an optimisation search. Use the Simplex (Nelder-Mead) method and Low accuracy. +2. Specify the optimisation parameters. +a) On the Optimisation parameters dialog, on the Variables tab, define the following +variables: +Variable +Min value +Max value +Start value +Grid points +L0 +L1 +L2 +L3 +S0 +S1 +S2 +0.15 +0.15 +0.15 +0.15 +0.1 +0.1 +0.1 +0.35 +0.35 +0.35 +0.35 +0.32 +0.32 +0.32 +0.2375 +0.2265 +0.22 +0.22 +0.3 +0.3 +0.3 +Empty +Empty +Empty +Empty +Empty +Empty +Empty +b) On the Constraints tab, define the constraints. The reflector element is required to have a +greater length than the director elements. +• L2 < L0 +• L3 < L0 +3. Create optimisation mask 1 to define the upper boundary for the gain (in dB). +1. For 0° to 88°: gain < 15 dB +• The value of 15 dB in the forward direction is selected knowing that this antenna will not +be able to achieve 15 dB gain. It will not effect the optimisation. +2. For 90° to 180°: gain < -7 dB +• The value of -7 dB will have an effect on the optimisation and determines the size of the +back lobes that we are willing to accept. +• Label: Mask_max +4. Create optimisation mask 2 to define the lower boundary for the gain (in dB). +1. For 0° to 30°: gain > 8 dB +• The value of 8 dB is selected as the minimum desired main lobe gain. +2. For 32° to 180°: gain > -40 dB +• The value of -40 dB outside the main lobe is selected arbitrarily low and will not affect +the optimisation. +• Label: Mask_min +5. Define two far field goals. Use the H_plane far field request to optimise the vertically polarised +gain in dB (10*log[]). The weighting for both goals are equal since both goals are of equal +importance. +• Set the 1st goal to be greater than Mask_min. +• Set the 2nd goal to be less than Mask_max. +A.6.5 Running the Optimisation +Run OPTFEKO to optimise the model according to requirements. During optimisation, OPTFEKO will call +the Solver as required. +1. Run OPTFEKO. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun OPTFEKO (if applicable). +A.6.6 Viewing the Results +View and post-process the results in POSTFEKO. +1. Compare the radiation pattern of the antenna for both the initial and the optimised antenna +design. The gain in the back-lobe region (between 90° and 180°) is reduced to -7 dB. The gain in +the main-lobe region (between 0° and 30°) is above 8 dB. +Figure 14: The vertically polarised gain of the Yagi-Uda antenna before and after optimisation. +Tip: To view the masks on the same graph, drag each mask from the model browser +onto the graph, then apply a scale of 180 (Transform axis) to each mask's trace. +2. View the optimum parameter values found during the optimisation search in the optimisation log +file. +Value of the aim function (analysis no. 181) is 4.954552265e+02 +Optimum found for these parameters: +l0 = 2.464426480e-01 +l1 = 2.318887084e-01 +l2 = 2.315246187e-01 +l3 = 2.214966779e-01 +s0 = 2.280809962e-01 +s1 = 2.488307711e-01 +s2 = 2.975472065e-01 +No. of the last analysis: 212 +A.7 Log Periodic Dipole Array Antenna +Calculate the radiation pattern and input impedance for a log periodic dipole array (LPDA) antenna. +Non-radiating transmission lines are used to model the boom of the LPDA antenna. +The antenna operates at 46.29 MHz, with a wide operational bandwidth stretching from 35 MHz to +60 MHz. +Figure 15: 3D view of the LPDA antenna with current distribution and far fields. +A.7.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables: +• freq = 46.29e6 (The operating frequency.) +• lambda = c0/freq (The wavelength in free space.) +• tau = 0.93 (The growth factor.) +• sigma0 = 0.7 (Spacing) +• sigmaN = sigma(N-1)/tau, where N is iterated from 1 to 11 with an increment of 1. +• d0 = 0 (Position of the first element.) +• dN = d(N-1) – sigmaN, where N is iterated from 1 to 11 with an increment of 1. +• len0 = 2 (Length of the first element.) +• lenN = len(N-1)/tau, where N is iterated from 1 to 11 with an increment of 1. +• rad0 = 0.00667 (Radius of the first element.) +• radN = rad(N-1)/tau, where N is iterated from 1 to 11 with an increment of 1. +• Zline = 50 (Transmission line impedance.) +• Zload = 50 (Shunt load resistance.) +2. Create twelve dipoles. +a) Create lines 0 to N, where N is iterated from 0 to 11 with an increment of 1. +• Start point: (dN, -lenN/2, 0) +• End point: (dN, lenN/2, 0) +b) Add a wire port to the middle of the line. +c) Number the ports from 0 to 11. +3. Add a voltage source to the first dipole[1] (1 V, 0°, 50 Ω). +4. Create eleven transmission lines to connect the dipoles. +a) Create transmission lines 1 to N, where N is iterated from 1 to 11 with an increment of 1. +• Definition method: Z0, length, attenuation +• Transmission line length: sigmaN +• Real part of Z0 (Ohm): Zline +• Imaginary part of Z0 (Ohm): 0 +• Attenuation (dB/m): 0 +• Select the Cross input and output ports check box to allow the correct transmission +line orientation. +5. Connect TransmissionLineN between Port(N-1) and Port(N) in the Network schematic view, +where N is iterated from 1 to 11 with an increment of 1. +Figure 16: The network schematic view showing the connected transmission lines, general networks and +ports. +6. Define a shunt load using a general network. +• Specify the one-port Y-matrix manually. +• Y11 = 1/Zload +1. This is Line0 with WirePort0. +7. View transmission line 11 in the Network schematic view. +a) Connect the general network to port 11. +8. Set the continuous frequency range from 35 MHz to 60 MHz. +A.7.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +1. Create a vertical far field request (-180°≤θ≤180°, with ϕ=0°). Sample the far field at θ=2° steps. +2. Create a horizontal far field request (0°≤ϕ≤360°, with θ=90°). Sample the far field at ϕ=2° steps. +A.7.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the Local wire radius for each of the twelve dipoles to radN. +Tip: Open the Modify Edge dialog, and on the Properties tab and select the Local +wire radius check box. +2. Set the Mesh size equal to Standard. +3. Set the Wire segment radius equal to 0.01. +A.7.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.7.5 Viewing the Results +View and post-process the results in POSTFEKO. +1. View the vertical gain (in dB) at 46.29 MHz of the requested far field pattern on a polar plot. +Figure 17: The vertical gain of the LPDA antenna at 46.29 MHz. +Tip: If the exact frequency is not available in the drop-down list, select Frequency in +range and enter the value for the frequency in Hz. +2. View the input impedance (real and imaginary) over the operating band on a Cartesian graph. +Figure 18: The input impedance (real and imaginary) of the LPDA antenna over the operating band. +A.8 Microstrip Patch Antenna +Model a microstrip patch antenna using two feed methods (pin feed, microstrip edge feed). The +dielectric substrate is considered as a finite substrate and an infinite planar multilayer substrate. +The far field results are compared for the following configurations: +• Pin-fed, finite ground and solved using MoM (SEP). +• Pin-fed, finite ground and solved using the FDTD. +• Pin-fed, infinite substrate and solved using the MoM with the planar Green's function for +multilayered media. +• Edge-fed, infinite substrate and solved using the MoM with the planar Green's function for +multilayered media. +The simulation time and resource requirements are greatly reduced when using an infinite plane, +although the model is a less accurate representation of the physical antenna. +Tip: Each model uses its predecessor as a starting point. Create the models in their +presentation order. Save each model to a new location to keep them. +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +A.8.1 Pin-Fed, SEP Model +p.55 +Model a microstrip patch antenna using a feed pin and a finite substrate. The patch antenna is solved +with the MoM (SEP). +Figure 19: A 3D view of the pin-fed microstrip patch antenna on a finite ground. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the model unit to millimetres. +2. Define the following variables: +• epsr = 2.2 (The relative permittivity of the substrate.) +• freq = 3e9 (The centre frequency.) +• lambda = c0/freq*1e3 (The wavelength in free space.) +• lengthX = 31.1807 (The width of the patch in the X direction.) +• lengthY = 46.7480 (The depth of the patch in the Y direction.) +• offsetX = 8.9 (The location of the feed.) +• substrateLengthX = 50 (The width of the substrate in the X direction.) +• substrateLengthY = 80 (The depth of the substrate in the Y direction.) +• substrateHeight = 2.87 (The height of the substrate.) +• fmin = 2.7e9 (The minimum frequency.) +• fmax = 3.3e9 (The maximum frequency.) +• feedlineWidth = 4.5 (The feedline width for the microstrip model feed.) +3. Create the patch. +a) Create a rectangle. +• Definition method: Base centre, width, depth +• Width: lengthX +• Depth : lengthY +• Label: patch +4. Create the substrate. +a) Create a cuboid. +• Definition method: Base corner, width, depth, height +• Base corner: (-substrateLengthX/2, -substrateLengthY/2, -substrateHeight) +• Width: substrateLengthX +• Depth: substrateLengthY +• Height: substrateHeight +• Label: substrate +5. Create the feed pin as a wire between the patch and the bottom of the substrate. Position the feed +pin with an offset from the edge of the patch. +a) Create a line. +• Start point: (-offsetX, 0, -substrateHeight) +• End point: (-offsetX, 0, 0) +6. Add a wire port to the start of the line. +7. Add a voltage source to the port. (1 V, 0°, 50 Ω). +8. Union all parts and rename the union to antenna. +9. Create a new dielectric medium with label substrate and with relative permittivity set to epsr. +10. Set the region of the cuboid to substrate. +11. Set the face of the patch and the bottom face of the substrate to PEC. +12. Set a continuous frequency range from fmin to fmax. +13. Specify the symmetry about the Y=0 plane as Magnetic symmetry. +Tip: Exploit model symmetries (if it exists) in a large or complex model to reduce +computational costs. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +1. Create a vertical far field request (-90°≤θ≤90°, with ϕ=0°). Sample the far field at θ=2° steps. +2. Create a vertical far field request (-90°≤θ≤90°, with ϕ=90°). Sample the far field at θ=2° steps. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to 0.25. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +A.8.2 Pin-Fed, FDTD Model +p.58 +Model a microstrip patch antenna using a feed pin and a finite substrate. The patch antenna is solved +with the finite difference time domain (FDTD). +Figure 20: A 3D view of the pin-fed microstrip patch antenna on a finite ground. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Pin-Fed, SEP Model and rename the file. +2. Activate the FDTD solver. +Tip: Open the Solver settings dialog and click the FDTD tab. Select the Activate +the finite difference time domain (FDTD) solver check box. +3. Change the continuous frequency range to linearly spaced discrete points ranging from fmin to +fmax with the number of frequencies set to 51. +4. Define the FDTD boundary condition settings. +a) Top (+Z), -Y, +Y, -X and +X boundaries: +• Boundary definition: Open +• Select the Automatically add a free space buffer check box. +b) Bottom (-Z) boundary: +• Boundary definition: Perfect electric conductor (PEC) +• Select the Do not add a free space buffer check box. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Pin-Fed, SEP Model. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire radius equal to 0.25. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.8.3 Pin-Fed, Planar Multilayer Substrate Model +Model a microstrip patch antenna using a feed pin and a planar multilayer substrate (Green’s functions). +The patch antenna is solved with MoM. +Figure 21: A 3D view of the pin-fed microstrip patch antenna on an infinite ground. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Pin-Fed, SEP Model and rename the file. +2. Delete the substrate part contained in the antenna part. +3. Add a planar multilayer substrate (infinite plane) with a conducting layer at the bottom. +a) Add a Plane / ground. +• Select Planar multilayer substrate from the drop-down list. +• Ground plane (Layer 1): PEC +• Thickness (Layer 1): substrateHeight +• Medium (Layer 1): substrate +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Pin-Fed, SEP Model. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for Pin-Fed, SEP Model. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Note: The following warning may be encountered when running the Solver: +Directivity cannot be computed for far field calculations involving the +planar multilayer Green's function with losses in the dielectric layers, +gain will be computed instead. +Losses cannot be calculated in an infinitely large medium as is required for the extraction of +antenna directivity information. +Avoid this warning by requesting the far field gain instead of the directivity. Open the +Request/Modify far fields dialog, click the Advanced tab and then click Gain. +A.8.4 Edge-Fed, Planar Multilayer Substrate Model +Model a microstrip patch antenna using an edge feed and a planar multilayer substrate (Green’s +functions). The patch antenna is solved with MoM. +Note: This example is for demonstration purposes only. For practical applications the patch +should be inset-fed by the feed line to improve the impedance match. +To improve accuracy, the length of the edge used for the edge port should be less than +1/30 of a wavelength (around 3mm for this example). For demonstration purposes, an edge +length of 4.5 mm is used. +Figure 22: A 3D view of the edge-fed microstrip patch antenna on an infinite ground. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Pin-Fed, Planar Multilayer Substrate Model and rename the file. +2. Copy (duplicate) the patch part contained in the antenna part. +3. Delete the antenna part. +The model should now only contain the patch part. +4. Create the feedline. +a) Create a rectangle. +• Definition method: Base corner, width, depth +• Base corner: (-lengthX/2, -feedlineWidth/2, 0) +• Width: -lambda/4 +• Depth: feedlineWidth +• Label: feedline +5. Union all the parts. +6. Add a microstrip port at the edge of the feed line. +7. Add a voltage source to the port. (1 V, 0°, 50 Ω). +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Pin-Fed, SEP Model. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for Pin-Fed, SEP Model. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Note: The following warning may be encountered when running the Solver: +Directivity cannot be computed for far field calculations involving the +planar multilayer Green's function with losses in the dielectric layers, +gain will be computed instead. +Losses cannot be calculated in an infinitely large medium as is required for the extraction of +antenna directivity information. +Avoid this warning by requesting the far field gain instead of the directivity. Open the +Request/Modify far fields dialog, click the Advanced tab and then click Gain. +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +A.8.5 Viewing the Results +View and post-process the results in POSTFEKO. +Compare the gain (in dB) of the requested far field patterns on a polar plot. +p.64 +Figure 23: A polar plot of the requested E plane radiation pattern for the microstrip patch models in POSTFEKO. +Note: Observe the impact of the different feeding mechanisms on the radiation pattern. +The best design for manufacturability (DFM) is the model using the finite ground. The finite ground +version requires more time to solve compared to the infinite plane version. +A.9 Proximity Coupled Patch Antenna with +Microstrip Feed +Calculate the input reflection coefficient of a proximity coupled patch antenna on an infinite substrate. +Figure 24: A 3D view of the proximity coupled microstrip fed patch. +A.9.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the Model unit to Millimetres. +2. Define the following variables. +• epsr = 2.62 (The relative permittivity of the substrate.) +• patch_rad = 17.5 (The radius of the patch.) +• line_len = 79 (The length of the strip line.) +• line_width = 4.373 (The width of the strip line.) +• offset = 0 (The distance between the patch centre and the feed line.) +• substrate_d = 3.18 (The height of the substrate.) +• f_min = 2.8e9 (The minimum frequency.) +• f_max = 3.2e9 (The maximum frequency.) +3. Create a dielectric medium. +• Relative permittivity: epsr +• Dielectric loss tangent: 0 +• Label: substrate +4. Create the circular patch. +a) Create an ellipse. +• Centre point: (0, 0, 0) +• Radius (U): patch_rad +• Radius (V): patch_rad +5. Create the feed line. +a) Create a rectangle. +• Definition method: Base corner, width, depth. +• Base corner: (-line_width/2, 0, -substrate_d/2). +• Width (W): line_width +• Depth (D): line_len +6. Add a planar multilayer substrate (infinite plane) with a conducting layer at the bottom. +a) Add a Plane / ground. +• Select Planar multilayer substrate in the drop-down list. +• Ground plane (Layer 1): PEC +• Thickness (Layer 1): substrate_d +• Medium (Layer 1): substrate +7. Create a microstrip port +• Click on the short edge (beginning) of the feed line. +Tip: To select the edge, hide the Plane / ground or add a cutplane. +8. Add a voltage source to the port. (1 V, 0°, 50 Ω). +9. Set the frequency. +• Continuous (interpolated) range +• Start frequency (Hz): f_min +• End frequency (Hz): f_max +A.9.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +No solution requests are required. +Note: Input impedance results are always available for voltage sources. +A.9.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Adjust the sliders for the Curved geometry approximation settings on the Advanced tab. Create +different meshes with these sliders and investigate the effect on the results. +A.9.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.9.5 Viewing the Results +View and post-process the results in POSTFEKO. +View the input reflection coefficient on a Smith chart. +Figure 25: The input reflection coefficient of the proximity coupled patch in POSTFEKO. +A.10 Aperture Coupled Patch Antenna +Calculate the input reflection coefficient of an aperture coupled patch antenna. Use continuous +frequency sampling to minimise runtime. Compare results for a finite and infinite dielectric. +Model the dielectric layers with two methods: +1. Model the patch antenna using a finite substrate where the aperture is modelled as an explicit +(unmeshed) hole. The patch antenna is solved with the MoM (SEP). +2. Model the patch antenna using an infinite multilayer substrate where aperture triangles allow the +energy to couple through an infinite PEC ground plane. +Figure 26: A 3D view of the aperture coupled patch antenna with microstrip feed. +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +A.10.1 SEP Model +p.69 +Model the patch antenna using a finite substrate where the aperture is modelled as an explicit +(unmeshed) hole. The patch antenna is solved with the MoM (SEP). +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the model unit to centimeters. +2. Define the following variables. +• epsr_a = 10.2 (The relative permittivity of the bottom layer.) +• epsr_b = 2.54 (The relative permittivity of the top layer.) +• f_min = 2.1e9 (The minimum frequency.) +• f_max = 2.3e9 (The maximum frequency.) +• lambda_a = c0/f_max/sqrt(epsr_a)*100 (The wavelength in the bottom layer.) +• lambda_b = c0/f_max/sqrt(epsr_b)*100 (The wavelength in the top layer.) +• d_a = 0.16 (The height of the bottom layer.) +• d_b = 0.16 (The height of the top layer.) +• patch_l = 4.0 (The length of the patch antenna.) +• patch_w = 3.0 (The width of the patch antenna.) +• grnd_l = 2*patch_l (The length of the substrate.) +• grnd_w = 2.5*patch_w (The width of the substrate.) +• feed_l = lambda_a (The length of the microstrip feed line.) +• feed_w = 0.173 (The width of the microstrip feed line.) +• stub_l = 1.108 (Length of the matching stub on the microstrip feed line.) +• ap_l = 1.0 (The length of the aperture.) +• ap_w = 0.11 (The width of the aperture.) +3. Create a dielectric medium for the bottom layer. +• Relative permittivity: epsr_a +• Dielectric loss tangent: 0 +• Label: bottom_layer +4. Create a dielectric medium for the top layer. +• Relative permittivity: epsr_b +• Dielectric loss tangent: 0 +• Label: top_layer +5. Create the aperture. +a) Create a rectangle. +• Definition method: Base centre, width, depth. +• Base centre (C): (0, 0, 0) +• Width (W): ap_l +• Depth (D): ap_w +• Label: aperture +6. Create the finite ground plane. +a) Create a rectangle. +• Definition method: Base centre, width, depth +• Base centre (C): (0, 0, 0) +• Width (W): grnd_w +• Depth (D): grnd_l +• Label: ground +7. Create the aperture in the ground. +a) Subtract aperture from ground. +b) Rename Subtract1 to slotted_ground. +The finite ground plane now has a hole at the centre where the aperture plate was defined. +8. Create the patch. +a) Create a rectangle. +• Definition method: Base centre, width, depth. +• Base centre (C): (0, 0, d_b) +• Width (W): patch_w +• Depth (D): patch_l +• Label: patch +9. Create the microstrip feed line. +a) Create a rectangle. +• Definition method: Base corner, width, depth +• Base corner (C): (-feed_w/2, -feed_l/2 + stub_l, -d_a) +• Width (W): feed_w +• Depth (D): feed_l +• Label: feed +The source will be a voltage source placed on an edge port. +10. Create a plate (via) that connects the ground plane and feed line. +a) Create a rectangle at the end of the feed line in the XZ plane. +1. Definition method: Base corner, width, depth +2. Choose Custom workplane and change the workplane origin to (-feed_w/2, feed_l/2 ++ stub_l, -d_a). +3. Rotate the workplane by 90° around the U axis to create the rectangle in the XZ plane. +4. Base corner (C): (0, 0, 0) +5. Width (W): feed_w +6. Depth (D): d_a +7. Label: feedVia +Tip: Rotate the workplane by selecting Custom workplane and the right-click +context menu. +A positive terminal and a negative terminal are required for the edge port. +11. Split feedVia in the UV plane at (0, 0, -d_a/2). +a) Rename the two resulting parts to port_bottom and port_top respectively. +12. Union port_bottom and port_top and rename the resulting part to conducting_elements. +13. Set the properties of all the faces to PEC. +Note: This step ensures that the faces will remain PEC after future union operations. +14. Create the bottom dielectric layer. +a) Create a cuboid. +• Definition methods: Base centre, width, depth +• Base centre (C): (0, 0, -d_a) +• Width (W): grnd_w +• Depth (D): grnd_l +• Height (H): d_a +• Label: bottom_layer +15. Create the top dielectric layer. +a) Create a cuboid. +• Base centre (C): (0, 0, 0) +• Width (W): grnd_w +• Depth (D): grnd_l +• Height: d_b +• Label: top_layer +16. Union all parts. +17. Set the bottom region to bottom_layer. +18. Set the top region to top_layer. +19. Add an edge port to the edge that splits the via connection in half. +• The negative face corresponds to the face attached to the ground plane. +• The positive face is the opposite face. +Tip: The polarity of the port is not relevant for single port models. +20. Add a voltage source to the port. (1 V, 0°, 50 Ω). +21. Set a continuous frequency range from f_min to f_max. +22. Specify the symmetry about the X=0 plane as Magnetic symmetry. +Tip: Exploit model symmetries (if it exists) in a large or complex model to reduce +computational costs. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a full 3D far field request. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Specify local mesh refinements. +a) Set a local mesh size of lambda_b/40 on all four edges of the patch. +b) Set a local mesh size of ap_w*0.7 on all four edges of the aperture. +c) Set a local mesh size of feed_w/4 on the face of the feed. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.10.2 Aperture Triangles in an Infinite Ground Plane +Model the patch antenna using an infinite multilayer substrate where aperture triangles allow the +energy to couple through an infinite PEC ground plane. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +Define the variables and media. +1. Repeat Step 1 to Step 4 in SEP Model. +Create the aperture. +2. Repeat Step 5 in SEP Model. +3. Set the solver method for the aperture face to use Planar Green's function aperture. +Create the patch. +4. Repeat Step 8 in SEP Model. +Create the microstrip feed line and plate (via) that connects the infinite ground plane and feed line. +5. Repeat Step 9 and Step 10 in SEP Model. +Create the positive and negative terminals of the edge port. +6. Repeat Step 11 in SEP Model. +7. Create an infinite ground plane using a planar multilayer substrate with a conducting layer at the +bottom. +a) Select Plane / ground. +• Select Planar multilayer substrate in the drop-down list. +• Thickness (Layer 1): d_b +• Medium (Layer 1): top_layer +• Ground plane (Layer 1): PEC +• Thickness (Layer 2): d_a +• Medium (Layer 2): bottom_layer +• Ground plane (Layer 1): None +• Z value at the top of layer 1: d_a +8. Union all parts. +Add an edge port, voltage source, specify the frequency and define symmetry. +9. Repeat Step 19 to Step 22 to in SEP Model. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for SEP Model. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Use the same mesh settings as for SEP Model. +2. Set the Mesh size growth rate to Slow. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.10.3 Viewing the Results +View and post-process the results in POSTFEKO. +1. Compare the input reflection coefficient of the two methods on a Smith chart. +Figure 27: The input reflection coefficient of the aperture coupled patch in POSTFEKO. +Note: The model using an infinite plane is a good approximation of the SEP model. +2. Compare the realised gain (in dB) at boresight of both methods on a Cartesian graph. +Figure 28: Far field realised gain over frequency. +Note: The far fields have a similar shape and the center frequency deviates by less +than 2%. Increase the size of the finite substrate to obtain an even better comparison +between the two methods. +3. Compare computational resources for the two methods. +Table 2: Memory and runtime requirements for the two methods. +Model +Approximate +number of triangles +RAM [MByte] +Runtime [% of full +SEP] +SEP +10000 +Infinite ground plane +1500 +3500 +19 +100 +9.5 +Note: Use an infinite ground plane to reduce the number of triangles and the +computational resources. +A.11 Different Ways to Feed a Horn Antenna +Calculate the far field pattern of a pyramidal horn antenna at 1.645 GHz. +Figure 29: A 3D view of the pyramidal horn antenna with far field pattern cuts.. +The far field results are compared for the following configurations: +1. Physical feed pin with voltage source. +2. Waveguide port with waveguide source. +3. FEM modal port with modal source using the finite element method (FEM). +A.11.1 Wire Pin Feed Model +Feed the horn antenna with a physical feed pin and voltage source. +Figure 30: A 3D view of the horn with a wire pin feed. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the model unit to centimetres. +2. Define the following variables: +• freq = 1.645e9 (The operating frequency.) +• lambda = c0/freq * 100 (The wavelength in free space.) +• wa = 12.96 (The width of the waveguide.) +• wb = 6.48 (The height of the waveguide.) +• ha = 55 (The width of the horn.) +• hb = 42.8 (The height of the horn.) +• wl = 30.2 (The length of the waveguide section.) +• fl = wl - lambda/4 (The position of the feed wire in the waveguide.) +• hl = 46 (The length of the horn section.) +• pinlen = lambda / 4.56 (The length of the pin.) +3. Create the waveguide section. +a) Create a cuboid. +• Definition method: Base corner, width, depth, height +• Base corner (C): (-wa/2, -wb/2, -wl) +• Width (W): wa +• Depth (D): wb +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +• Height (H): wl +4. Delete the face coincident with the UV plane. +5. Create the horn section. +a) Create a flare. +p.79 +• Definition method: Base centre, width, depth, height, top width, top depth +• Bottom width (Wb): wa +• Bottom depth (Db): wb +• Height (H): hl +• Top width (Wt): ha +• Top depth (Dt): hb +6. Delete the face at the origin and the face opposite to that. +7. Create the feed pin. +a) Create a line. +• Start point: (0, -wb/2, -fl) +• End point: (0, -wb/2 + pinlen, -fl) +8. Add a wire port (segment) to the base of the line. +9. Add a voltage source to the port. (1 V, 0°, 50 Ω). +10. Union all parts. +11. Set the frequency to freq. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a far field request for the E plane cut. +1. Create a vertical far field request (-180°≤θ≤180°, with ϕ=90°). Sample the far field at θ=2° +steps. +Create a far field request for the H plane cut. +2. Create a horizontal far field request (-180°≤θ≤180°, with ϕ=0°). Sample the far field at θ=2° +steps. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the Mesh size equal to Coarse. +2. Set the Wire segment radius equal to 0.1. +Tip: Keep the runtime at a minimum by using coarse meshing to reduce the number +of triangles. +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +p.80 +A.11.2 Waveguide Feed Model +Feed the horn antenna with a waveguide port and waveguide source. +Figure 31: A 3D view of the horn with a waveguide port. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +The wire feed model is changed to use a waveguide feed. +1. Use the model considered in Wire Pin Feed Model and rename the file. +2. Delete the voltage source. +3. Delete the wire port. +4. Delete the line. +5. Apply a waveguide port to the back face of the horn. +Note: The face type for the port (rectangular, coaxial or circular) is determined +automatically by CADFEKO. +Tip: Inspect the port to check if the propagation direction and orientation of the port +is correct. +6. Add a waveguide source on the waveguide port using the default settings. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Wire Pin Feed Model. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the same mesh settings as for Wire Pin Feed Model. +Note: Removing the line (wire) from the model eliminates the need for the Wire +segment radius specification. +2. Set a local mesh size of lambda/20 on the back face of the waveguide. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.11.3 FEM Modal Port Feed Model +Feed the horn antenna with a FEM modal port and FEM modal source. +Figure 32: A 3D view of the horn with a FEM modal port with a FEM modal source. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the model unit to centimetres. +2. Define the following variables: +• freq = 1.645e9 (The operating frequency.) +• lambda = c0/freq * 100 (The wavelength in free space.) +• wa = 12.96 (The width of the waveguide.) +• wb = 6.48 (The height of the waveguide.) +• ha = 55 (The width of the horn.) +• hb = 42.8 (The height of the horn.) +• wl = 30.2 (The length of the waveguide section.) +• fl = wl - lambda/4 (The position of the feed wire in the waveguide.) +• hl = 46 (The length of the horn section.) +• pinlen = lambda / 4.56 (The length of the pin.) +3. Define a dielectric medium, air. +• Relative permittivity: 1 +• Dielectric loss tangent: 0 +• Label: air +4. Create the waveguide section. +a) Create a cuboid. +• Definition method: Base corner, width, depth, height +• Base corner (C): (-wa/2, -wb/2, -wl) +• Width (W): wa +• Depth (D): wb +• Height (H): wl +5. Set the region of the cuboid to air. +6. Select the four faces that represent the waveguide boundary walls and set to PEC. +Select all faces of the waveguide section, except the following faces: +• The face at the origin. +• The face where the FEM modal port will be located (opposite the face at the origin.) +7. Set the solution method for the air region to FEM. +Tip: Open the Modify Region dialog and click the Solution tab. From the Solution +Method drop-down list, select Finite Element Method (FEM). +8. Create the horn section. +a) Create a flare. +• Definition method: Base centre, width, depth, height, top width, top depth +• Bottom width (Wb): wa +• Bottom depth (Db): wb +• Height (H): hl +• Top width (Wt): ha +• Top depth (Dt): hb +9. Delete the face at the origin. +10. Delete the face opposite to the face deleted in Step 9. +11. Union all parts. +12. Add a FEM modal port to the back face of the waveguide. +13. Add a FEM modal source to the port. Use the default settings. +Tip: Exploit model symmetries (if it exists) in a large or complex model to reduce +computational costs. +14. Set the frequency to freq. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Wire Pin Feed Model. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the same mesh settings as for Wire Pin Feed Model. +Note: Removing the line (wire) from the model eliminates the need for the Wire +segment radius specification. +2. Set a local mesh size of lambda/20 on the back face of the waveguide. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +A.11.4 Viewing the Results +View and post-process the results in POSTFEKO. +1. Compare the gain (in dB) of the requested E plane radiation pattern on a polar graph. +p.86 +Figure 33: A polar plot of the requested E plane radiation pattern for the horn antenna in POSTFEKO. +2. Compare the gain (in dB) of the requested H plane radiation pattern on a polar graph. +Figure 34: A polar plot of the requested H plane radiation pattern for the horn antenna in POSTFEKO. +A.12 Dielectric Resonator Antenna on Finite Ground +Calculate the input impedance and radiation pattern of a dielectric resonator antenna (DRA) with a +coaxial pin feed on a finite ground. +Model the dielectric layers using the following configurations: +1. Feed with a FEM modal source and solve using the hybrid finite element (FEM) and MoM solution. +2. Feed with a waveguide source and solve using the method of moments (MoM) solution with the +surface equivalence principle (SEP). +Figure 35: 3D view of the dielectric resonator antenna on a finite ground plane. +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +A.12.1 Hybrid FEM/MoM Model +p.89 +Feed the DRA antenna with a FEM modal port. The DRA antenna is solved using the hybrid FEM/MoM +method. A layer of air dielectric is added to minimise the number of triangles on the FEM/MoM +boundary. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the model unit to millimeters. +2. Define the following variables: +• epsr = 9.5 (The relative permittivity of the substrate.) +• r = 0.63 (The radius of the feed element.) +• hBig = 1 (The height of the feed base.) +• rBig = 2.25 (The radius of the feed base.) +• rDisk = 60 (The radius of the ground.) +• rDome = 12.5 (The radius of the inner dome.) +• rDomeBig = rDome + 5.5 (The radius of the outer dome.) +• h = 7 (The height of the feed element.) +• fmin = 3e9 (The minimum frequency.) +• fmax = 6e9 (The maximum frequency.) +• lambda = c0/fmax * 1000 (The wavelength in free space. [mm]) +3. Define a named point: +• excite_b: (0, 6.5, -1) +4. Define a dielectric medium, air. +• Relative permittivity: 1 +• Dielectric loss tangent: 0 +• Label: air +5. Define a dielectric medium, dome. +• Relative permittivity: epsr +• Dielectric loss tangent: 0 +• Label: dome +6. Define a dielectric medium, isolator. +• Relative permittivity: 2.33 +• Dielectric loss tangent: 0 +• Label: isolator +7. Create a new workplane. +• Origin: excite_b +• Set the new workplane as the default workplane. +8. Create the outer conductor for the feed pin. +a) Create a cylinder. +• Radius (R): rBig +• Height (H): hBig +• Label: FeedBase +9. Create the inner conductor for the feed pin. +a) Create a cylinder. +• Radius (R): r +• Height (H): hBig + h +• Label: FeedPin +10. Set the region that makes up the feed base to isolator. +11. Set the default workplane to Global XY. +12. Create the finite ground plane. +a) Create an ellipse. +• Radius (U): rDisk. +• Radius (V): rDisk. +13. Create the inner dome. +a) Create a sphere. +• Radius: rDome. +• Label: InnerDome. +14. Create the outer dome. +a) Create a sphere. +• Radius: rDomeBig. +• Label: OuterDome. +15. Union all parts and rename the Union to DRA. +16. Delete the bottom faces of each dome. +17. Set the region of the inner dome to dome. +18. Set the region of the outer dome to air. +19. Reset any suspect regions to their correct media. +Tip: Suspect regions are overlapping regions joined in a union. +20. Set the solution method for all regions to FEM. +Tip: Open the Modify Region dialog and click the Solution tab. From the Solution +Method drop-down list, select Finite Element Method (FEM). +21. Set all faces in the model to PEC. +22. Set the following faces to the Default face medium. +• The top and bottom faces of FeedBase. +• The remaining dome faces. +23. Add a FEM modal port to the bottom face of FeedBase. +24. Add a FEM modal source to the FEM modal port. +25. Set a continuous frequency range from fmin to fmax. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a vertical far field request (-180°≤θ≤180°, with ϕ=0°). Sample the far field at θ=2° steps. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the Mesh size equal to Coarse +2. Set a lambda local mesh size on the face of the outer dome. +Tip: The mesh on the outer dome contributes a large portion to the total memory. +Coarsen the mesh to reduce the memory requirement. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +A.12.2 SEP Model +p.92 +Feed the DRA antenna with a waveguide port. The DRA antenna is solved using the MoM method. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the model unit to millimeters. +2. Define the following variables: +• epsr = 9.5 (The relative permittivity of the substrate.) +• r = 0.63 (The radius of the feed element.) +• hBig = 1 (The height of the feed base.) +• rBig = 2.25 (The radius of the feed base.) +• rDisk = 60 (The radius of the ground.) +• rDome = 12.5 (The radius of the inner dome.) +• rDomeBig = rDome + 5.5 (The radius of the outer dome.) +• h = 7 (The height of the feed element.) +• fmin = 3e9 (The minimum frequency.) +• fmax = 6e9 (The maximum frequency.) +• lambda = c0/fmax * 1000 (The wavelength in free space. [mm]) +3. Define a named point: +• excite_b: (0, 6.5, -1) +4. Define a dielectric medium, dome. +• Relative permittivity: epsr +• Dielectric loss tangent: 0 +• Label: dome +5. Define a dielectric medium, isolator. +• Relative permittivity: 2.33 +• Dielectric loss tangent: 0 +• Label: isolator +6. Create a new workplane. +• Origin: excite_b +• Set the new workplane as the default workplane. +7. Create the outer conductor for the feed pin. +a) Create a cylinder. +• Radius (R): rBig +• Height (H): hBig +• Label: FeedBase +8. Create the inner conductor for the feed pin. +a) Create a cylinder. +• Radius (R): r +• Height (H): hBig + h +• Label: FeedPin +9. Set the default workplane to Global XY. +10. Create the finite ground plane. +a) Create an ellipse. +• Radius (U): rDisk. +• Radius (V): rDisk. +11. Create the inner dome. +a) Create a sphere. +• Radius: rDome. +• Label: InnerDome. +12. Union all parts and rename the Union to DRA. +13. Delete the bottom face of the dome. +14. Set the region that makes up the feed base to isolator. +15. Set the region of the inner dome to dome. +16. Set all the faces in the model to PEC. +17. Set the following faces to the Default face medium. +• The top and bottom faces of FeedBase. +• The remaining face of the dome. +18. Add a waveguide port to the bottom face of FeedBase. +19. Add waveguide source to the waveguide port. +20. Set a continuous frequency range from fmin to fmax. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Define the same calculation requests as for Hybrid FEM/MoM Model. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Mesh size equal to Coarse. +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +p.94 +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +A.12.3 Viewing the Results +View and post-process the results in POSTFEKO. +1. Compare the input reflection coefficient (in dB) of both methods on a Cartesian graph. +p.95 +Figure 36: The input reflection coefficient of the DRA for both methods over the operating band. +2. Compare the vertical gain (in dB) of both methods on a polar graph. +Figure 37: A polar plot of the vertical gain for the DRA at 3.6 GHz for both methods. +A.13 Dielectric Lens Antenna +Calculate the radiation pattern of a dielectric lens antenna. The lens is illuminated by an equivalent +far field source with an ideal cosine pattern. The lens structure is modelled using the ray launching +geometrical optics (RL-GO). Compare the RL-GO solution with a hybrid FEM/MoM solution. +Figure 38: The 3D view of the dielectric lens model with an equivalent far field source. +A.13.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +Note: Assume the focal point of the lens is located at the global origin. +1. Define the following variables. +• freq = 30e9 (The operating frequency.) +• epsr = 6 (relative permittivity.) +• tand = 0.005 (dielectric loss tangent.) +• lambda_0 = c0/freq (The wavelength in free space.) +• D = lambda_0*10 (lens diameter.) +• F = 1.5*D (focal length.) +2. Define the following derived variables for the model construction. +• alpha = arcsin(D/(2*F)) (The included angle to the edge of the lens.) +• arclength = alpha* F (The arc length to the edge of the lens.) +• n = sqrt(epsr) (The refraction index of the lens.) +• T = (2*F - sqrt(4*F^2 - D^2))/(2*(n-1)) (The thickness of the length.) +• v0 = (F + T) / (n + 1) (The ellipse offset distance.) +• u0 = sqrt(n^2 - 1) * v0 (The diameter of the lens.) +• w0 = n*v0 (The major axis length of the ellipse.) +3. Define a dielectric medium, glass. +• Relative permittivity: epsr +• Dielectric Loss tangent: tand +• Label: Glass +Construct the lens by subtracting a sphere from an elliptical spheroid. +4. Create a sphere. +• Definition method: Centre, radius +• Centre: (0, 0, 0) +• Radius: F +5. Create the elliptical spheroid. +a) Create a sphere. +• Definition method: Centre, radius U, radius V, radius N +• Centre: (0, 0, v0) +• Radius (Ru): u0 +• Radius (Rv): u0 +• Radius (Rn): w0 +6. Subtract the sphere from the elliptical spheroid. +a) Rename Subtract1 to Lens. +A closed region is by default set to perfect electric conductor (PEC). +7. Set the region of Lens to Glass. +8. Set the solver method for the dielectric lens antenna to use RL-GO. +Tip: Open the Modify Face dialog and click the Solution tab. From the Solve with +special solution method list, select Ray launching - geometrical optics (RL-GO). +9. Set the frequency to freq. +The dielectric lens is illuminated by a far field pattern source. The E-field pattern is described by the +following equation. +(1) +10. Define the far field data. +• Load field data from a Feko Solver (*.ffe) file +• File name: Ideal_CosineQ4_Xpol.ffe +• Select Use all data blocks +• Label: FarFieldData1 +11. Create a far field equivalent source using the far field definition, FarFieldData1. +• Magnitude scale factor: 1 +• Phase offset (degrees): 0 +• Field data: FarFieldData1. +Note: The far field source is positioned at the origin which coincides with the focal +point of the lens. +A.13.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +Directivity is derived from gain by removing losses. Losses cannot be calculated in an RL-GO dielectric. +1. Create a vertical far field request (-180°≤θ≤180°, with ϕ=0°). Sample the far field at θ=0.25° +steps. +a) Modify the far field request to calculate gain. +Note: Open the Request/Modify far fields dialog, click the Advanced tab and +then click Gain. +2. Create a vertical far field request (-180°≤θ≤180°, with ϕ=90°). Sample the far field at θ=0.25° +steps. +a) Modify the far field request to calculate gain. +Tip: This setting only applies to the .out file data. +A.13.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Mesh size equal to Fine. +Tip: Curvilinear mesh triangles are created by default to accurately represent the curved +geometry. The RL-GO solution method requires an accurate geometric representation only, +which is independent of the solution frequency. +A.13.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.13.5 Viewing the Results +View and post-process the results in POSTFEKO. +1. Compare the gain (in dB) of the requested far field pattern on a polar plot. +Figure 39: A polar plot of the requested radiation pattern compared to a FEM/MoM solution and the far field +source in isolation. +Note: The gain pattern of the equivalent source (labelled Reference) is included by +importing the .ffe file. Used as a reference, it is compared to the lens antenna solved +with RL-GO and the hybrid FEM/MoM. +Tip: The memory and runtime requirements for the RL-GO solution are substantially +lower than the FEM/MoM. +2. Optional: Add an image of the lens to the polar graph. +A.14 Windscreen Antenna on an Automobile +Calculate the input impedance of a windscreen antenna constructed with wires. The windscreen consists +of a layer of glass and a layer of foil. +Figure 40: A 3D view of an automobile and windscreen antenna. +The windscreen antenna (wires) can be embedded in the windscreen layers or placed on the surface of +the windscreen. +The windscreen curvature reference can consist of multiple layers with different media. Its mesh +elements do not contribute to the solution's computational resources. +A.14.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. +Import the Parasolid geometry of the car from the file car_geometry.x_b +Note: The model is included in the Feko installation. +2. Rename the three imported parts as follows: +a) The structure for the car: car_body. +b) The structure for the antenna: antenna. +c) The structure for the windscreen: windscreen. +3. Union car_body and antenna. +Note: The windscreen curvature reference is not part of the union as it is not required +to be electrically connected to the model. +4. Add a wire port to the start of the line. +5. Add a voltage source to the port. (1 V, 0°, 50 Ω). +6. Create a dielectric medium (glass). +• Relative permittivity: 7 +• Dielectric loss tangent: 0.03 +• Label: glass +7. Create a dielectric medium (PVB foil). +• Relative permittivity: 3 +• Dielectric loss tangent: 0.05 +• Label: pvb_foil +8. Create a layered dielectric (2D). +a) Label: windscreen_layers +b) Layer 1: +• Thickness: 2.1e-3 +• Dielectric material: glass +c) Layer 2: +• Thickness: 0.76e-3 +• Dielectric material: pvb_foil +d) Layer 3: +• Thickness: 2.1e-3 +• Dielectric material: glass +9. Create a windscreen medium. +a) Layer definition: windscreen_layers +b) Offset L: 2.1e-3 + 0.76e-3 +c) Label: Windscreen1 +Tip: Variable Offset L specifies the reference plane where the windscreen +antenna (wires) are located. For this example, the antenna is placed between the +two layers, glass and pvb_foil. +10. Specify the windscreen curvature reference. +a) Select the single face of the windscreen. +b) Include the windscreen curvature reference as part of the windscreen solution. +Note: The windscreen curvature reference is used as part of the windscreen +solution to define the shape and position of the windscreen. +Tip: Open the Modify Face dialog, click the Solution tab. From the Solution +method drop-down list, select Windscreen. +A windscreen curvature reference is displayed semi-transparent in the colour of the windscreen +definition. +11. Specify the windscreen antenna (wires). +a) Select the windscreen antenna wires. +b) Include the windscreen antenna as part of the windscreen solution. +Note: Variable Offset A is the distance from the windscreen curvature reference +to the windscreen antenna (wires). For this example, set Offset A equal to 0 to +place the antenna on the reference plane. +Tip: Open the Modify Edge dialog, click the Solution tab. From the Solution +method drop-down list, select Windscreen. +Figure 41: 3D view showing the selected windscreen antenna. +12. Set the continuous frequency range from 90 MHz to 110 MHz. +A.14.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +No solution requests are required. +Note: Input impedance results are always available for voltage sources. +A.14.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the Wire segment radius equal to 150e-6. +2. Set the local mesh size on the windscreen reference face equal to 0.2. +Note: Apply a local mesh refinement on the windscreen reference face to ensure +accurate representation of the surface. The mesh elements of this face do not +contribute to the solution's computational resources. +Due to the fine geometric detail of the car, advanced mesh settings are applied. +3. Specify the advanced mesh settings. +a) Set the Refinement factor equal to Coarse. +b) Set the Minimum element size to Medium. +Tip: Open the Modify Mesh Settings dialog and click the Advanced tab. +A.14.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.14.5 Viewing the Results +View and post-process the results in POSTFEKO. +View the antenna input impedance over the operating band on a Cartesian graph. +Figure 42: The input impedance (real and imaginary) of the windscreen antenna over the operating band. +Tip: Use MLFMM for solving higher frequencies. +A.15 MIMO Elliptical Ring Antenna (Characteristic +Modes) +Calculate the current distribution and far fields for a MIMO elliptical ring antenna. Use characteristic +mode analysis to calculate the results for different modes. +The analysis is independent of sources and provides insight into how a structure resonates at the +calculated frequencies. This information can be used to excite the structure with the desired modes +only. +Figure 43: The first four electric far field modes for the MIMO ring. +A.15.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the model unit to millimetres. +2. Define the following variables: +�� rInU = 21 (The inner radius of the elliptic arc in the U direction.) +• rOutU = 31 (The outer radius of the elliptic arc in the U direction.) +• rInV = 0.8*rInU (The inner radius of the elliptic arc in the V direction.) +• rOutV = 0.8*rOutU (The outer radius of the elliptic arc in the V direction.) +• freq = 2.49e9 (The operating frequency.) +3. Create a quarter of the ring. +a) Create the first elliptic arc. +• Centre point: (0, 0, 0) +• Radius (Ru): rOutU +• Radius (Rv): rOutV +• Start angle (A0): 0° +• End angle (A1): 90° +b) Create the second elliptic arc. +• Centre point: (0, 0, 0) +• Radius (Ru): rInU +• Radius (Rv): rInV +• Start angle (A0): 0° +• End angle (A1): 90° +Create a quarter of the ring antenna. +4. Create a surface from the two elliptic arcs using the Loft tool. +a) Rename the label to sector_1. +5. Create the full ring antenna. +a) Copy and mirror sector_1 around the UN plane. +b) Copy and mirror sector_1 and the copied part from Step 5.a around the VN plane. +c) Union the four sectors to create a single ring structure. +6. Create four edge ports. +a) port_North with its port edge on the positive Y axis. +b) port_East with its port edge on the positive X axis. +c) port_South with its port edge on the negative Y axis. +d) port_West with its port edge on the negative X axis. +Figure 44: The four edge ports for the ring antenna. +Note: All four ports point in an anticlockwise direction. +7. Set the frequency to freq. +8. Specify the symmetry about 2 principal planes. +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +• X=0: Geometric symmetry. +• Y=0: Geometric symmetry. +p.108 +Tip: Exploit model symmetries (if it exists) in a large or complex model to reduce +computational costs. +Note: Electric or magnetic symmetry does not apply to characteristic mode analysis, +since there are no active sources involved. The geometrical symmetry enforces a +symmetrical mesh. +A.15.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create three configurations. The first configuration requests characteristic mode analysis. The second +and third configurations excite specific modes. +1. Request a Characteristic modes configuration. +a) Number of modes to calculate: 5 +b) Create a currents request (all currents). +c) Create a full 3D far field request. +2. Request a Standard configuration. +a) Add a voltage source to port_East. (1 V, 0°, 50 Ω). +b) Add a voltage source to port_West. (1 V, 180°, 50 Ω). +c) Create a full 3D far field request. +3. Request a second Standard configuration. +a) Add a voltage source to port_East. (1 V, 0°, 50 Ω). +b) Add a voltage source to port_West. (1 V, 0°, 50 Ω). +c) Add a voltage source to port_North. (1 V, 180°, 50 Ω). +d) Add a voltage source to port_South. (1 V, 180°, 50 Ω). +e) Create a currents request (all currents). +f) Create a full 3D far field request. +Ensure that sources are specified correctly for the specified standard configurations. +A.15.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the Mesh size equal to Fine. +Specify an advanced mesh setting. +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +2. Set the Refinement factor equal to Fine. +p.109 +Tip: The refinement factor ensures the geometry is accurately represented for the +higher order modes. +A.15.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.15.5 Viewing the Results +View and post-process the results in POSTFEKO. +When you add excitations or loads to a solution, you unknowingly calculate the weighted sum of the +various characteristic modes. Characteristic modes allow you to alter the behaviour of a structure +without making any changes to the geometry. +1. Observe how the first characteristic mode can be recreated when sources are placed in the +appropriate locations. +Note: When comparing the characteristic modes to the reconstructed modes, all +values need to be normalised. +a) Plot the currents for the CharacteristicModesConfiguration1 (mode index = 1) in the +3D view. +b) Plot the currents for StandardConfiguration1 in a second 3D view. +c) Compare the currents for the first mode in CharacteristicModesConfiguration1 +with the reconstructed mode using sources placed in the appropriate locations +(StandardConfiguration1). +Figure 45: The first characteristic mode of the MIMO ring. +Figure 46: The first reconstructed mode of the MIMO ring. +2. Observe how the fifth characteristic mode can be recreated when sources are placed in the +appropriate locations. +a) Plot the currents for the CharacteristicModesConfiguration1 (mode index = 5) in a third +3D view. +b) Plot the currents for StandardConfiguration2 in a fourth 3D view. +c) Compare the currents for the fifth mode in CharacteristicModesConfiguration1 +with the reconstructed mode using sources placed in the appropriate locations +(StandardConfiguration2). +Figure 47: The fifth characteristic mode of the MIMO ring. +Figure 48: The fifth reconstructed mode of the MIMO ring. +3. Compare the far fields of the characteristic modes configuration and the reconstructed modes on a +polar graph. +Figure 49: Comparison of the electric fields for the characteristic modes with the reconstructed modes. +Note: Results are normalised in the comparison due to a lack of sources. +The manually excited electric fields are in excellent agreement with the electric fields from the +characteristic modes. +A.16 Periodic Boundary Conditions for Array +Analysis +Calculate the far field pattern for a single element in an infinite two-dimensional array of pin-fed +patch elements. The infinite patch array is modelled using periodic boundary condition. Calculate the +approximated far field pattern for a 10x10 element array. +The mutual coupling between elements are taken into account when using periodic boundary condition +to model an infinite array. If edge effects can be neglected, use the periodic boundary condition to +model a large array accurately. +Figure 50: A 3D view of a single element in an infinite patch array in CADFEKO. +Tip: Each model uses its predecessor as a starting point. Create the models in their +presentation order. Save each model to a new location to keep them. +A.16.1 Pin-Fed Patch: Broadside Pattern by Phase Shift +Definition +Compute the broadside pattern for a single element in an infinite patch array and for a 10x10 element +array. The phase shift is specified in the u1 and u2 vector directions. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables: +• lambda = 0.1 (The spacing for periodic boundary conditions.) +• freq = c0/lambda (The operating frequency.) +• epsr = 2.55 (Relative permittivity of the substrate.) +• base_width = 0.5*lambda (Width of the substrate.) +• base_length = 0.5*lambda (Length of the substrate.) +• base_height = 0.02*lambda (Height of the substrate.) +• patch_width = 0.3*lambda (Width of the patch antenna.) +• patch_length = 0.3*lambda (Length of the patch antenna.) +• pin_pos = patch_length/4 (Distance of feed pin from patch centre.) +2. Create a new dielectric called substrate with relative permittivity set to epsr and the dielectric +loss tangent to 0. +3. Create the substrate. +a) Create a cuboid. +• Definition method: Base centre, width, depth, height +• Base corner: (0, 0, 0) +• Width: base_width +• Depth: base_length +• Height: base_height +4. Create the patch. +a) Create a rectangle. +• Definition method: Base centre, width, depth, height +• Base centre: (0,0, base_height) +• Width: patch_length +• Depth: patch_width +5. Create the feed pin. +a) Create a wire between the patch and the bottom of the substrate. +• Start point: (-pin_pos, 0, 0) +• End point: (-pin_pos, 0, base_height) +6. Union all elements and label the union antenna. +7. Set the region of the cuboid to substrate. +8. Set the face of the patch and the bottom face of the substrate to PEC. +9. Add a wire port (segment) to the middle of the line. +10. Add a voltage source to the port. (1 V, 0°, 50 Ω). +11. Set the frequency to freq. +12. Set the periodic boundary conditions of the model to end exactly on the edge of the substrate to +expand in both the X direction and Y direction. +13. Specify the phase shift for the two directions to u1=0° and u2=0°. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +1. Create a vertical far field request (-180°≤θ≤180°, with ϕ=0°). Sample the far field at θ=1° steps. +2. Request the far field calculation for an array of 10x10 elements. +a) Create a vertical far field request (-180°≤θ≤180°, with ϕ=0°). Sample the far field at θ=1° +steps. +Tip: Open the Request/Modify far fields dialog, click the Advanced tab and +then click the Calculate far field for an array of elements check box. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to 0.0001. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.16.2 Pin-Fed Patch: Broadside Pattern by Squint Angle +Definition +Compute the broadside pattern for a single element in an infinite patch array and for a 10x10 element +array. The phase shift is determined from the direction into which the beam is pointing (“squint angle”). +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Pin-Fed Patch: Broadside Pattern by Phase Shift Definition and +rename the file. +2. Modify the periodic boundary conditions. +a) Determine the phase shift by setting the beam angle for Theta and Phi to 0°. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Pin-Fed Patch: Broadside Pattern by Phase Shift Definition. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for Pin-Fed Patch: Broadside Pattern by Phase Shift Definition. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.16.3 Pin-Fed Patch: Squint Pattern by Phase Shift +Definition +Compute the squint pattern for a single element in an infinite patch array and for a 10x10 element +array. The phase shift is specified in the u1 and u2 vector directions. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Pin-Fed Patch: Broadside Pattern by Phase Shift Definition and +rename the file. +2. Modify the periodic boundary conditions. +a) Set the phase shift for the two directions to u1=−61.56° and u2=0°. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Pin-Fed Patch: Broadside Pattern by Phase Shift Definition. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for Pin-Fed Patch: Broadside Pattern by Phase Shift Definition. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +A.16.4 Pin-Fed Patch: Squint Pattern by Squint Angle +Definition +Compute the broadside pattern for a single element in an infinite patch array as well for a 10x10 +element array. The phase shift is determined from the direction into which the beam is pointing (“squint +angle”). +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Pin-Fed Patch: Broadside Pattern by Phase Shift Definition and +rename the file. +2. Modify the periodic boundary conditions. +a) Determine the phase shift by setting the beam angle for Theta=20° and Phi=0°. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Pin-Fed Patch: Broadside Pattern by Phase Shift Definition. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for Pin-Fed Patch: Broadside Pattern by Phase Shift Definition. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +A.16.5 Viewing the Results +View and post-process the results in POSTFEKO. +p.119 +Compare the gain (in dB) of the requested far field patterns for a single patch antenna and for the +10x10 element array. +Note: +• The single patch antenna model includes the mutual coupling between the elements as +if the patch antenna is in an infinite array. +• The gain is about 20 dB higher for the 10x10 element array than for the single element. +Figure 51: The far field gain for a single element and a 10×10 element patch array in the broadside direction. +Figure 52: The far field gain for a single element and a 10×10 element patch array in the 20° squint direction. +A.17 Finite Antenna Array with Non-Linear Spacing +Calculate the radiation pattern for an array of arbitrarily placed pin-fed patch antennas. Use the +finite array tool to construct the array and the domain Green's function method (DGFM) to minimize +computational resources. +Figure 53: A 3D view of the finite antenna array with far field pattern in POSTFEKO +A.17.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the model unit to millimetres. +2. Define the following variables: +• freq = 2.4e9 (The operating frequency.) +• lam0 = c0/freq*1000 (The wavelength in free space.) +• epsr = 2.08 (Relative permittivity of the substrate.) +• patchLength = 41 (The length of the patch antenna.) +• patchWidth = 35 (The width of the patch antenna.) +• h = 3.5 (The height of the substrate.) +• pinOffset = -11 (Distance between the feed pin and patch centre.) +• wireRadius = 0.1 (The radius of the feed pin wire.) +3. Create the patch. The patch is the base element to be used in the finite antenna array. +a) Create a rectangle. +• Definition method: Base centre, width, depth +• Base centre: (0, 0, 0) +• Width (W): patchWidth +• Depth (D): patchLength +4. Create the feed line. +a) Create a line. +• Start point: (0, pinOffset, -h) +• End point: (0, pinOffset, 0) +5. Union all parts in the tree. +6. Create a dielectric medium. +a) Dielectric loss tangent: 0 +b) Relative permittivity: epsr +c) Label: substrate +7. Add a planar multilayer substrate (infinite plane) with a conducting layer at the bottom. +a) Select Plane / ground. +• Select Planar multilayer substrate from the Definition method drop-down list. +• Thickness (Layer 1): h +• Medium (Layer 1): substrate +• Ground plane (Layer 1): PEC +• Z value at the top of layer 1: 0 +8. Add a wire port (segment) to the middle of the line. +9. Add a voltage source to the port. (1 V, 0°, 50 Ω). +10. Set the frequency to freq. +Note: The steps up to this point represents the base element. The next steps will +create an array from the base element. +Figure 54: Layout of the final array. +11. Create a planar array. +• Number of elements = 4 (in both the U and V dimensions) +• Offset along X axis = lam0. +Altair Feko 2022.3 +A Antenna Synthesis and Analysis +• Offset along Y axis = lam0. +p.123 +Convert an array into a custom array to allow an element to be rotated or repositioned with respect to +one another. Rotate an element by modifying its local workplane. An element can also be deleted from +the array. +12. Convert the array into a custom array. +Tip: For this example, the elements are not rotated, but you are encouraged to rotate +a few of the elements after obtaining the initial results to investigate the effect on the +array pattern. +13. Delete the elements from the third row and third column. Only nine elements should remain. +14. Solve the antenna array with the DGFM. +Tip: Open the Solver Settings dialog, click the Domain Decomposition tab and +then select the Solve model with Domain Green's Function Method (DGFM) +check box. +A.17.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a full 3D far field request. Sample the far field at θ=1.5° and ϕ=1.5° steps. +a) Change the workplane origin to (1.5*lam0, 1.5*lam0, 0) to place the far field at the middle of the +antenna array. +A.17.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to wireRadius. +A.17.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Note: The following warning may be encountered when running the Solver: +Directivity cannot be computed for far field calculations involving the +planar multilayer Green's function with losses in the dielectric layers, +gain will be computed instead. +Losses cannot be calculated in an infinitely large medium as is required for the extraction of +antenna directivity information. +Avoid this warning by requesting the far field gain instead of the directivity. Open the +Request/Modify far fields dialog, click the Advanced tab and then click Gain. +A.17.5 Viewing the Results +View and post-process the results in POSTFEKO. +1. View the gain (in dB) of the requested far field pattern using a polar plot. +2. Compare the far field pattern of the finite antenna array with the equivalent full MoM model. +Figure 55: A polar plot of the far field gain (dB) viewed in POSTFEKO. The gain of the finite antenna array is +compared to the equivalent full MoM model. +Note: The finite array tool simplifies array construction. For larger arrays, the performance +improvement of the DGFM are more pronounced. +Antenna Placement +B Antenna Placement +Simple examples demonstrating antenna placement. +This chapter covers the following: +• B.1 Antenna Coupling on an Electrically Large Object (p. 127) +• B.2 Antenna Coupling Using an Ideal Receiving Antenna (p. 131) +B.1 Antenna Coupling on an Electrically Large +Object +Calculate the S-parameters (coupling) over a frequency range for three monopole antennas located +near the front, middle and rear of a Rooivalk helicopter mock-up. +Figure 56: A 3D view of the Rooivalk helicopter with the monopole antennas located near the front, middle and +rear. +B.1.1 Creating the Model +Note: This model contains complex geometry. The creation steps are not provided, but the +model is included in the Feko installation. +Solve the model with the MLFMM. +Tip: Open the Solver settings dialog, click the MLFMM / ACA tab and then click Solve +model with the multilevel fast multipole method (MLFMM). +B.1.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +Request the S-parameters for the model. Add the three ports in the S-parameter request and specify a +reference impedance of 50 Ω each. Set the three ports to active. +B.1.3 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +B.1.4 Viewing the Results +View and post-process the results in POSTFEKO. +The resource requirements (time and memory) for the MLFMM solution are notably smaller than for the +full MoM solution. Some solution times from the .out file are given below. Note that times are strongly +dependent on the hardware. + SUMMARY OF REQUIRED TIMES IN SECONDS + CPU-time runtime + Reading and constructing the geometry 1.630 1.631 + Calcul. of the MLFMM transfer function 0.876 0.876 + Fourier transform of MLFMM basis funct. 4.505 4.508 + Calcul. of matrix elements 126.248 126.251 + Calcul. of right-hand side vector 0.099 0.099 + Preconditioning system of linear eqns. 44.603 44.603 + Solution of the system of linear eqns. 112.489 112.486 + ------------ ------------ + total times: 293.942 293.941 + (total times in hours: 0.082 0.082) + Specified CPU-times are referring to the master process only + Sum of the CPU-times of all processes: 2351.498 seconds ( 0.653 hours) + On average per process: 293.937 seconds ( 0.082 hours) + Peak memory usage during the whole solution: 443.363 MByte +1. For the antennas mounted on the helicopter: +a) View the coupling between the antennas as a function of frequency on a Cartesian graph. +Figure 57: The antenna coupling as a function of frequency on a Cartesian graph. +2. View the reflection coefficients of the antennas as a function of frequency on a Cartesian graph. +Figure 58: The reflection coefficients of the antennas as a function of frequency on a Cartesian graph. +B.2 Antenna Coupling Using an Ideal Receiving +Antenna +Calculate the coupling between a helix antenna and a Yagi-Uda antenna located in front of a large plate. +Reduce computational resources by using the uniform theory of diffraction (UTD) and an ideal receiving +antenna. +The receiving antenna is modelled with three equivalent field types: +1. +2. +far field radiation pattern +far field spherical modes +3. near field aperture +The results will be compared for all three field types. +Note: Equivalent field sources and receiving antennas are impressed fields and are not +influenced by nearby physical structures. +For accuracy, ensure sufficient distance to the physical structures. +Three models are provided for this example: +• Antenna_Coupling_Helix_Antenna.cfx: Model of the helix antenna used to pre-calculate the +three field types that will be used in the ideal receiving antennas. +• Antenna_Coupling_Receiving_Antenna.cfx: Model that calculates the antenna coupling using the +ideal receiving antenna types. +• Antenna_Coupling_Full.cfx: Full model for both antennas. +Figure 59: 3D view of the full model. +B.2.1 The Helix Antenna - Full Model +Calculate the near field, far field and spherical modes of a helix antenna. Export the fields to a file to +use as an ideal receiving antenna. +Figure 60: 3D view of the helix antenna. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Create the following variables. +• freq = 1.654e9 (The operating frequency.) +• lambda = c0/freq (The wavelength in free space.) +• n = 10 (number of turns for the helix.) +• helix_alpha = 13 (pitch angle of the helix.) +• helix_radius = lambda*cos(helix_alpha*pi/180)/pi/2 (radius of the helix.) +• plate_radius = 0.75*lambda (radius of the ground plate.) +• wire_radius = 0.65e-3 (radius of the helix wire segments.) +2. Create the circular base plate of the helix. +a) Create an ellipse. +• Centre point: (0, 0, 0) +• Radius (U): plate_radius +• Radius (V): plate_radius +3. Create the helix +• Definition method: Base centre, radius, pitch angle, turns +• Origin: (0, 0, 0) +• Radius: helix_radius +• Pitch angle: helix_alpha +• Number of turns: n +4. Union the helix and ellipse. +5. Add a wire port to the start of the line. +6. Add a voltage source to the port. (1 V, 0°, 50 Ω). +7. Set the frequency to freq +Defining Calculation Requests +Define the calculation requests in CADFEKO. +1. Create a full 3D far field request. +a) On the Advanced tab of the far field request, enable Export fields to ASCII file (*.ffe). +b) Enable Calculate spherical expansion mode coefficients. +c) Enable Export spherical expansion mode coefficients to ASCII file. +Note: +• Define a far field receiving antenna using a .ffe file. +• Define a spherical modes receiving antenna using a .sph file. +2. Create a near field request. +a) Definition method: Spherical +b) On the Advanced tab enable Export fields to ASCII file (*.efe/*.hfe) +c) Start: (0.45, 0, 0) +d) End: (0.45, 180, 360) +e) Increment: (0, 5, 5) +Note: Define a near field aperture receiving antenna using .efe/.hfe files. +Since the near field surface should capture the entire radiating area of the +antenna and the helix antenna has a small ground plane, a spherical near field +request surrounding the antenna is sufficient. +The exported files are used in the set up of Antenna Coupling with Ideal Receiving Antenna. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to wire_radius. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +B.2.2 Antenna Coupling with Ideal Receiving Antenna +Calculate the antenna coupling between a Yagi-Uda and helix antenna. Create the Yagi-Uda antenna and +use an ideal receiving antenna in place of the helix antenna. +Use the field data exported to file in The Helix Antenna - Full Model. +Figure 61: 3D view of the ideal receiving antenna. +Creating the Variables and Named Points +Create the variables and named points used in the construction of the Yagi-Uda antenna. +1. Create the following variables. +• freq = 1.654e9 (The operating frequency.) +• lambda = c0/freq (The wavelength in free space.) +• yagi_ld = lambda * 0.442 (length of the director element.) +• yagi_li = lambda * 0.451 (length of the active element.) +• yagi_lr = lambda * 0.477 (length of the reflector element.) +• yagi_d = 0.25 * lambda (spacing between Yagi elements.) +• yagi_rho = lambda * 0.0025 (radius of the helix wire segments.) +2. Create the following named points. +• helix_centre = (-1.5/2, 0.75, 1.5) (helix antenna location.) +• yagi_centre = (-1.5/2, -0.75, 1.5) (Yagi antenna location.) +Constructing the Yagi-Uda Antenna +Build a parametric model of a Yagi-Uda antenna. Use variables and named points already created. +1. Create a line (active element). +• Start point: (0, 0, -yagi_li/2) +• End point: (0, 0, yagi_li/2) +• Label: yagi_active +2. Create a line (director element). +• Start point: (0, -yagi_d, -yagi_ld/2) +• End point: (0, -yagi_d, yagi_ld/2) +• Label: yagi_director +3. Create a line (reflector element) +• Start point: (0, yagi_d, -yagi_lr/2) +• End point: (0, yagi_d, yagi_lr/2) +• Label: yagi_reflector +4. Create another director element. +• Create a copy of the yagi_director element. +• Translate the copy from (0, 0, 0) to (0, -yagi_d, 0). +5. Create another director element. +• Create a copy of the first yagi_director element. +• Translate this new copy from (0, 0, 0) to (0, -2 * yagi_d, 0). +6. Union the lines and rename the resulting part to yagi_antenna. +7. Place the Yagi antenna in the correct position and orientation. +a) Rotate the yagi_antenna part around the N axis by -(90+15)°. +b) Translate the yagi_antenna part from (0, 0, 0) to (yagi_centre, yagi_centre, +yagi_centre). +Creating a Wire Port and Setting the Frequency +Add a wire port and voltage source to the Yagi-Uda antenna. +1. Add a wire port to the middle of the yagi_active element. +2. Add a voltage source to the port. (1 V, 0°, 50 Ω). +3. Set the frequency to freq. +Creating the Plate +Create the plate. Apply the UTD solution method to the plate. +1. Create the plate. +a) Create a rectangle. +• On the Geometry tab, from the Definition methods drop-down list, select Base +corner, width, depth +• Base corner (C): (-3, 0, 0) +• Width (W): 6 +• Depth (D): 3 +• Label: metal_plate. +• On the Workplane tab, select Predefined workplane. From the drop-down list, select +Global YZ. +2. Set the UTD solution properties on the metal_plate part. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +1. Define far field data. +a) Number of theta points: 37 +b) Number of phi points: 73 +c) File name: Browse for the .ffe file +Tip: Click on Field/Current data on the Construct tab to find all the field data +types. Select Define Far Field Data. +2. +Import the spherical mode data from file. +a) File name: Browse for the .sph file. +Define near field data. +3. Select Define Near Field Data. +a) Source type: Load from .efe and .hfe file. +b) E-field file: Browse for the .efe file. +c) H-field file: Browse for the .hfe file. +d) Coordinate system: Spherical +e) Radius (R): 0.45 +f) Number of points along theta: 37 +g) Number of points along phi: 73 +h) On the Workplane tab set the following: +1. Select Custom workplane +2. Origin: (helix_centre, helix_centre, helix_centre) +3. U vector: (1, 0, 1). +4. Create a far field receiving antenna request. +a) Field data: FarFieldData1 +b) On the Workplane tab set the following: +• Select Custom workplane +• Origin: (helix_centre, helix_centre, helix_centre) +• U vector: (1, 0, 1) +5. Create a spherical modes receiving antenna request. +a) Field data: SphericalModesData1 +b) Set the Workplane identical to that set in the far field receiving antenna request in Step 4. +c) On the Advanced tab select Use far field approximation. +Tip: A spherical modes source requires that no geometry breaches the far field +distance of the source. Feko will give a warning if this is the case. +6. Create a near field receiving antenna request. +a) On the General tab select Combine individual faces +b) Field data: NearFieldData1 +7. Set the radiated power to 100W. +Tip: To set the radiated power, on the Source/Load tab select Power and select the +option Total source power (no mismatch). +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to yagi_rho. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Altair Feko 2022.3 +B Antenna Placement +B.2.3 Viewing the Results +View and post-process the results in POSTFEKO. +p.139 +A model of the full solution (no ideal receivers or sources) is provided. The ideal receiving antenna +calculates the coupling assuming a matched load. The helix antenna is loaded with its complex +conjugate impedance. The power in the load represents the total power received by the antenna. +Results can then be compared directly. +The coupling results are derived from the received power data. In POSTFEKO the received power may +be plotted on a graph. It is also given in the .out file. +Compute the coupling from the following equation: +(2) +Table 3: Coupling results for the four models at 1.654 GHz +Model +Received +power (mW) +Coupling (dB) +Runtime (s) +Full model +Far field pattern +Spherical modes +Near field +2.66 +2.56 +2.60 +2.67 +-45.75 +-45.92 +-45.82 +-45.73 +15 +<3 +<3 +<3 +For convenience results were computed over a frequency range and plotted on a graph in POSTFEKO. +Figure 62: Coupling results over a frequency range for the four models. +Tip: For coupling in dB, use Enable math and enter the equation 10*log(self/100). +B.3 Antenna Coupling Using an Equivalent Source +and Ideal Receiving Antenna +Calculate the coupling between two horn antennas separated by 60 wavelengths. A metallic plate +between the horn antennas blocks the line-of-sight coupling. Replace the horn antennas with a far field +equivalent source and ideal far field receiving antenna. +Three models are provided for this example. The creation steps are not provided, but the models are +included in the installation. +• Pyramidal_Horn.cfx: Model of the horn antenna on its own. The far field pattern will be used in +the equivalent source and ideal receiving antenna. +• Full_Model.cfx: Full model of two horn antennas and plate. +• Point_Source_Coupling.cfx: Model that calculates the antenna coupling using the far field +equivalent source and ideal receiving antenna. +Figure 63: The model using equivalent source and receiving antenna. +B.3.1 Solving the Horn Antenna to Obtain the Fields +Calculate the far field of the horn antenna. Export the fields to file to use as far field equivalent source +and ideal receiving antenna. +Figure 64: 3D view of the horn antenna. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +The model of the horn is not constructed but provided. +Open Pyramidal_Horn.cfx. +Note: +• The waveguide port is placed on the YZ plane and the horn is centered with respect to +these axes. +• The phase centre of the horn is located inside the flare. The far field is calculated with +the offset axis origin at X = -21.6 cm. +◦ The phase centre is required for accurate placement of the equivalent sources, but +this calculation is beyond the scope of this example. +◦ The phase centre varies over frequency. However, for the narrow bandwidth of this +example, this variation is ignored. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +B.3.2 Solving the Equivalent Sources Model +Calculate the antenna coupling between two horn antennas represented by a far field equivalent source +and an ideal receiving antenna. +Use the far fields exported to file in the previous section. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +In CADFEKO open Point_Source_Coupling.cfx. +Note: The transmitted power is set to 1 W which simplifies the coupling equation to: +(3) +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +B.3.3 Obtaining a Full Wave Reference Solution +Calculate the coupling between two horn antennas. Use the full models of both antennas to obtain a +reference solution. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +In CADFEKO, open Full_Model.cfx. +Note: Full models of both horns are used. The coupling is computed from the S- +parameters. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +B.3.4 Viewing the Results +View and post-process the results in POSTFEKO. +1. Create an empty Cartesian graph. +2. Add the FarFieldReceivingAntenna1 results to the graph. +3. Add the S-matrix results (S21) to graph. +Figure 65: Comparison of the coupling between the antennas using a full solution vs equivalent sources. +Radar Cross Section (RCS) +C Radar Cross Section (RCS) +Simple examples demonstrating radar cross section (RCS) calculations of objects. +This chapter covers the following: +• C.1 RCS of a Thin Dielectric Sheet (p. 148) +• C.2 RCS and Near Field of a Dielectric Sphere (p. 151) +• C.3 Scattering Width of an Infinite Cylinder (p. 155) +• C.4 Periodic Boundary Conditions for FSS Characterisation (p. 159) +C.1 RCS of a Thin Dielectric Sheet +Calculate the bistatic radar cross section of an electrically thin dielectric sheet. The sheet is modelled +using the thin dielectric sheet approximation and is illuminated by an incident plane wave. +Figure 66: 3D view of a thin dielectric sheet. +C.1.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables: +• freq = 100e6 (The operating frequency.) +• d = 0.004 (Plate thickness.) +• a = 2 (Width of plate.) +• b = 1 (Depth of plate.) +• epsr = 7 (Relative permittivity.) +• tand = 0.03 (Loss tangent.) +• thetai = 20 (Zenith angle of incidence.) +• phii = 50 (Azimuth angle of incidence.) +• etai = 60 (Polarisation angle of incident wave.) +2. Create the media for the thin dielectric. +a) Create a dielectric with the relative permittivity set to epsr, dielectric loss tangent to tand. +Rename its label to substrate. +b) Create a single-layered dielectric. +• Label: thin_dielsheet +• Thickness: d +• Dielectric material: substrate +3. Create a rectangular plate centred at the origin in the XY plane. +a) Create a rectangle. +• Definition method: Base centre, width, depth +• Base centre: (0, 0, 0) +• Width: a +• Depth: b +4. Set the face medium of the rectangular plate to thin_dielsheet. +5. Add a single incident plane wave source from direction θ=thetai and ϕ = phii. Set the polarisation +angle to etai. +6. Set the frequency to freq. +C.1.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a vertical far field request (-180°≤θ≤180°, with ϕ=0°). Sample the far field at θ=2° steps. +C.1.3 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +C.1.4 Viewing the Results +View and post-process the results in POSTFEKO. +View the bistatic RCS of the dielectric sheet at 100 MHz as function of the angle θ, in the plane ϕ=0°. +Figure 67: Bistatic RCS of a thin dielectric sheet. +C.2 RCS and Near Field of a Dielectric Sphere +Calculate the radar cross section and the near field inside and outside of a dielectric sphere using the +surface equivalence principle (SEP). +Figure 68: 3D view of a dielectric sphere with a plane wave (source). +The bistatic radar cross section for sphere[2] is computed by: +. +(4) +C.2.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables: +• lambda = 20 (The wavelength in free space.) +• freq = c0/lambda (The operating frequency.) +• radius = 1 (Sphere radius.) +• epsilon = 36 (Relative permittivity.) +2. Create a new dielectric labeled diel with relative permittivity set to epsilon. +3. Create a sphere. +• Centre: (0, 0, 0) +• Radius: Radius +2. C. A. Balanis, Advanced Engineering Electromagnetics, Wiley, 1989, pp. 655. +4. Set the region of the sphere to diel. +5. Add a single incident plane wave with θ=180° and ϕ=0°. +6. Set the frequency to freq (≈15 MHz) +C.2.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +1. Create a vertical far field request (0°≤θ≤180°, with ϕ=0°). Sample the far field at θ=2° steps. +2. Create a near field request along the Z axis. +a) Definition method: Cartesian +b) Select Specify number of points from the list. +c) Start: (0, 0, -2*radius) +d) End: (0, 0, 2*radius) +e) Number of field points: (1, 1, 80) +C.2.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Mesh size to Fine. +Tip: The wavelength is large compared to the size of the sphere requiring a mesh that +accurately represents the geometry. Use a Custom mesh size for an even finer mesh. +C.2.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +C.2.5 Viewing the Results +View and post-process the results in POSTFEKO. +1. Compare the near field along the Z axis between the exact and the computed near field. +Figure 69: Near field along the Z axis. +2. Compare the RCS results on a far field graph. +a) Change the Y axis to a logarithmic scale for improved visualisation. +Figure 70: Bistatic radar cross section of the dielectric sphere. +Compare the results with the literature reference (C. A. Balanis, Advanced Engineering +Electromagnetics, Wiley, 1989, pp. 607.). The results agree well with the literature reference. +C.3 Scattering Width of an Infinite Cylinder +Calculate the scattering width of an infinite cylinder. The infinite cylinder is modelled using an one- +dimensional periodic boundary condition (PBC). +Figure 71: 3D view of the infinite cylinder defined as a unit cell with a one-dimensional PBC with a plane wave +(source). +The scattering by a circular cylinder[3] is computed by: +. +(5) +C.3.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +The model consists of a circular cylinder. The cylinder height is set to half a wavelength at the excitation +frequency. +1. Define the following variables: +• lambda = 1 (The wavelength in free space.) +• freq = c0/lambda (The frequency for free space wavelength.) +• h = lambda/2 (The height of the cylinder.) +3. C. A. Balanis, Advanced Engineering Electromagnetics, Wiley, 1989, pp. 607. +• r = 0.1 (The radius of the infinite cylinder.) +2. Create a cylinder. +• Definition method: Base centre, radius, height +• Base centre: (0, 0, -h/2) +• Radius: r +• Height: h +3. Delete the top and bottom faces of the cylinder. +4. Add a single incident plane wave with θ=90° and ϕ=180°. +5. Set the frequency to the variable freq. +C.3.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +This model considers the scattering width of an infinite cylinder. The incident plane wave is normal to +the cylinder. +1. Define a one dimensional periodic boundary condition. +• Start point: (0, 0, -h/2) +• End point of first vector: (0, 0, h/2) +Note: The geometry is allowed to touch the periodic boundaries. +2. Create a near field request. The scattering width is derived from the direction-dependent scattered +field. +• Definition method: Cylindrical +• Select Specify increments from the list. +• Start: (500*lambda, 0, 0) +• End: (500*lambda, 360, 0) +• Increment: (0, 0.5, 0) +• Calculate only the scattered part of the field. This removes the effect of the plane wave on the +calculated field. As a result only the scattered fields are considered. +Tip: Open the Request/Modify near fields dialog, click the Advanced tab and +then click the Calculate only the scattered part of the field check box. +C.3.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Create the mesh by using the Fine auto-mesh setting. +C.3.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +C.3.5 Viewing the Results +View and post-process the results in POSTFEKO. +View the computed scattering width as a function of the bistatic observation angle (ϕ) for a cylinder +radius of r=0.1 and r=0.6. +a) The scattering width is obtained by using the equation at the top of the example with the values +provided to simplify to +. +(6) +b) To use the equation in POSTFEKO, ensure the magnitude of the electric field is displayed. +c) Select the Enable maths check box and enter the following: +2*pi*500*ABS(self)^2 +Figure 72: The scattering width of an infinite cylinder, modelled with r=0.1 and r=0.6 where r is the radius of the +cylinder. +Compare the results with the literature reference (C. A. Balanis, Advanced Engineering +Electromagnetics, Wiley, 1989, pp. 607.). The results agree well with the literature reference. +C.4 Periodic Boundary Conditions for FSS +Characterisation +Calculate the transmission and reflection coefficients for a Jerusalem cross FSS (frequency selective +surface) structure. The cross is modelled with a periodic boundary condition and is excited with an +incident plane wave. +Figure 73: 3D view of the Jerusalem cross unit-cell structure defined as a unit cell with two-dimensional PBC with a +plane wave (source) . +C.4.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables: +• Set the model unit to millimetres (mm). +• d = 15.2 (The spacing for periodic boundary condition.) +• fmin = 2e9 (The minimum frequency.) +• fmax = 12e9 (The maximum frequency.) +• armLength = 13.3 (The arm length of the cross.) +• armWidth = 1.9 (The arm width of the cross.) +• stubLength = 5.7 (Stub length at the end of the cross.) +• stubWidth = armWidth (Stub width at the end of the cross.) +2. Create the main arm of the cross. +a) Create a rectangle centred at the origin. +• Definition method: Base centre, width, depth +• Base centre: (0, 0, 0) +• Width: armWidth +• Depth: armLength +3. Create the stub rectangle. +a) Create a rectangle centred at the origin. +• Definition method: Base centre, width, depth +• Base centre: (0, 0, 0) +• Width: stubLength +• Depth: stubWidth +4. Translate the stub rectangle as follows: +• From: (0, -stubWidth/2, 0) +• To: (0, -6.65, 0) +5. Copy and mirror the stub across the XZ plane. +There should now be a stub at each end of the main arm. +6. Copy and rotate all the parts by 90°. +7. Union all the parts and simplify Union1. +8. Add a single incident plane wave with θ=0° and ϕ=0°. +9. Set a continuous frequency range from fmin to fmax. +C.4.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +This model considers the transmission and reflection coefficients for an incident plane wave. +1. Request Transmission/reflection coefficients with the phase origin at (0, 0, 0). +2. Define Periodic Boundary Conditions in Two dimensions. +a) Start point: (-d/2 , -d/2 ,0) +b) End point of first vector: (d/2 , -d/2 ,0) +c) End point of second vector: (-d/2 , d/2 ,0) +d) For Phase shift select Determine from plane-wave excitation. +C.4.3 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Altair Feko 2022.3 +C Radar Cross Section (RCS) +C.4.4 Viewing the Results +View and post-process the results in POSTFEKO. +View the total computed transmission and reflection coefficients. +p.161 +Figure 74: The transmission and reflection coefficients for the specified incident plane wave. +Compare the results with the literature reference, Ivica Stevanovic, Pedro Crespo-Valero, Katarina +Blagovic, Frederic Bongard and Juan R. Mosig, Integral-Equation Analysis of 3-D Metallic Objects +Arranged in 2-D Lattices Using the Ewald Transformation, IEEE Trans. Microwave Theory and +Techniques, vol. 54, no. 10, October 2006, pp. 3688–3697. +Altair Feko 2022.3 +C Radar Cross Section (RCS) +C.5 Bandpass FSS +p.162 +Calculate the transmission coefficient of a second order, electrically thin bandpass FSS (frequency +selective surface) structure. The structure is modelled with a periodic boundary condition and is excited +with an incident plane wave. +Model the structure using the following two solvers: +1. The method of moments (MoM) solution with the surface equivalence principle (SEP). +2. The hybrid finite element method and method of moments (FEM/MoM) method. +Figure 75: 3D view view of the second order FSS. +Compare the transmission coefficient with the reference.[4] +C.5.1 SEP Model +The frequency selective surface (FSS) is solved using the surface equivalence principle (SEP) method. +Note: The SEP model will require more runtime compared to the FEM version. +4. A New Technique for Design of Low-Profile Second-Order, Bandpass Frequency Selective Surfaces, +Mudar Al-Joumayly and Nader Behdad, IEEE Trans. Antennas and Propagation, Vol. 57, No.2, Feb +2009 +Altair Feko 2022.3 +C Radar Cross Section (RCS) +Creating the Model +p.163 +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the model unit to millimeters. +2. Define the following variables: +• d = 5.8 (The spacing for the periodic boundary condition.) +• h = 0.5 (The thickness of the substrate.) +• t = 0.091 (The thickness of the bonding material.) +• s1 = 0.15 (The width of the dielectric surface, bottom layer.) +• s2 = 0.18 (The width of the dielectric surface, upper layer.) +• w = 2.5 (The width of the centre metallic surface.) +• fmin = 5e9 (The minimum frequency.) +• fmax = 15e9 (The maximum frequency.) +3. Create the two dielectric media. +a) Create the dielectric medium, Dielectric1. +• Relative permittivity: 3.38 +• Dielectric loss tangent: 0 +• Label: Dielectric1 +b) Create the dielectric medium, Glue. +• Relative permittivity: 3.3 +• Dielectric loss tangent: 0 +• Label: Glue +4. Create a cross shape. +• Arm length (Lu): d/2 +• Arm length (Lv): d/2 +• Strip width: w +• Label: Cross +5. Create a plane shape for the bottom layer. +• Width (W): d-s2 +• Depth (D): d-s2 +• Label: Plane_Bot +6. Create a plane shape for the top layer. +• Width (W): d-s1 +• Depth (D): d-s1 +• Label: Plane_Top +7. Create a unit cell. +a) In the Reference vector drop-down list select U vector. +b) Dimensions: +• Skew angle : 0.0 +• Distance (U): d +• Distance (V): d +c) Create the following layers: +Layer 1: +• Method: Select Metal in the drop-down list +• Shape: Select Plane_Top in the drop-down list +• Rotation: 0 +• OffsetU: d/2 +• OffsetV: d/2 +Layer 2: +• Method: Select Substrate in the drop-down list +• Medium: Select Dielectric1 in the drop-down list +• Thickness: h +Layer 3: +• Method: Select Metal in the drop-down list +• Shape: Select Cross in the drop-down list +• Rotation: 0 +• OffsetU: d/2 +• OffsetV: d/2 +Layer 4: +• Method: Select Substrate in the drop-down list +• Medium: Select Glue in the drop-down list +• Thickness: t +Layer 5: +• Method: Select Substrate in the drop-down list +• Medium: Select Dielectric1 in the drop-down list +• Thickness: h +Layer 6: +• Method: Select Metal in the drop-down list +• Shape: Select Plane_Bot in the drop-down list +• Rotation: 0 +• OffsetU: d/2 +• OffsetV: d/2 +d) Z value at the top of layer 1: 0 +e) Label: UnitCell1 +8. Select the UnitCell1 (under the Unit Cells group) and click Build Geometry +a) On the dialog, select the Set Periodic Boundary Condition (PBC) checkbox. +Figure 76: Top view of the FSS after building the geometry of the unit cell +Note: To visualise the periodic nature of the geometry, make a copy of the built +geometry part (UnitCell1) in the X direction. Then copy both geometry parts in the +model tree in the Y direction. +9. Add a single incident plane wave with θ=0° and ϕ=0°. +10. Set a continuous frequency range from fmin to fmax. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +This model considers the transmission coefficients for an incident plane wave. +Request Transmission/reflection coefficients with the phase origin at (0, 0, h+t+h). +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Specify local mesh refinement. +a) Set a local mesh size of d/50 on the dielectric faces on the upper most face of the geometry +as well as the bottom most face. +Tip: Open the Modify Face dialog, click the Meshing tab and then select the Local +mesh size check box. +a) Set a local mesh size of d/50 on the Glue region. +2. Set the Mesh size equal to Fine. +Altair Feko 2022.3 +C Radar Cross Section (RCS) +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +p.166 +Altair Feko 2022.3 +C Radar Cross Section (RCS) +C.5.2 Hybrid FEM / MoM Model +p.167 +The frequency selective surface (FSS) is solved using the hybrid finite element method and method of +moments (FEM /MoM) solution method. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in SEP Model and rename the file. +2. Set the solution method for all regions to FEM. +Tip: Open the Modify Region dialog and click the Solution tab. From the Solution +Method drop-down list, select Finite Element Method (FEM). +3. Set the data storage precision to Double precision for faster convergence. +Note: Open the Solver settings dialog and click the General tab. Under Data +storage precision, select Double precision. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Define the same calculation requests as for the SEP Model. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for the SEP Model. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Altair Feko 2022.3 +C Radar Cross Section (RCS) +C.5.3 Viewing the Results +View and post-process the results in POSTFEKO. +p.168 +1. View the total computed transmission coefficient of both the SEP and FEM/MoM on a Cartesian +graph. +Figure 77: The transmission coefficients for both the SEP and FEM / MoM solution methods. +The FEM is a computationally more efficient solution. +2. +[Optional] Compare the results with the literature reference A New Technique for Design of Low- +Profile Second-Order, Bandpass Frequency Selective Surfaces, Mudar Al-Joumayly and Nader +Behdad, IEEE Trans. Antennas and Propagation, Vol. 57, No.2, Feb 2009. +EMC Analysis and Cable +Coupling +D EMC Analysis and Cable Coupling +Simple examples demonstrating electromagnetic compatibility (EMC) analysis and cable coupling. +This chapter covers the following: +• D.1 Shielding Factor of a Sphere with Finite Conductivity (p. 170) +• D.2 Calculating Field Coupling into a Shielded Cable (p. 177) +• D.3 A Magnetic-Field Probe (p. 181) +D.1 Shielding Factor of a Sphere with Finite +Conductivity +Calculate the shielding factor of a hollow sphere with finite conductivity. The sphere is constructed from +a lossy metal with a thickness of 2.5 nm. +An incident plane wave is defined from 1 MHz to 100 MHz. Use a single near field point located at the +centre of the sphere to compute the shielding factor. +Figure 78: A 3D view of the sphere with a plane wave (source) and symmetry in CADFEKO. +The shielding factor results are compared using the following solution methods: +• Method of moments (MoM) +• Finite element method (FEM) +Tip: Each model uses its predecessor as a starting point. Create the models in their +presentation order. Save each model to a new location to keep them. +Altair Feko 2022.3 +D EMC Analysis and Cable Coupling +D.1.1 MoM Model +p.171 +Calculate the shielding factor of a hollow sphere with finite conductivity. The sphere is solved using +MoM. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables: +• r0 = 1 (Sphere radius.) +• f_min = 1e6 (The minimum frequency.) +• f_max = 100e6 (The maximum frequency.) +• d = 2.5e-9 (Thickness of the shell.) +2. From the media library, add the predefined medium, Silver to the model. +3. Create a sphere. +• Definition method: Centre, radius +• Centre: (0, 0, 0) +• Radius: r0 +• Label: Sphere1 +4. Set the region of the sphere to Free space. +5. Set the face of the sphere to the medium, Silver. Set the thickness to d. +6. Create a single incident plane wave source with θ=90° and ϕ=180°. +7. Set a continuous frequency range from f_min to f_max. +8. Specify the symmetry about 3 principal planes: +a) X=0: Geometric symmetry +b) Y=0: Magnetic symmetry +c) Z=0: Electric symmetry +Tip: Exploit model symmetries (if it exists) in a large or complex model to reduce +computational costs. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a near field request. The request is a single point located at the centre of the sphere. +• Definition method: Cartesian +• Select Specify number of points from the list. +• Start: (0, 0, 0) +• End: (0, 0, 0) +Altair Feko 2022.3 +D EMC Analysis and Cable Coupling +• Number of field points: (1, 1, 1) +p.172 +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Mesh size equal to Standard. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Altair Feko 2022.3 +D EMC Analysis and Cable Coupling +D.1.2 FEM Model +p.173 +Calculate the shielding factor of a hollow sphere with a finite conductivity. The sphere is modelled with +FEM. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in MoM Model and rename the file. +2. Define the following variable: +• r1 = 1.2 (Radius of FEM vacuum sphere.) +3. Create a new dielectric labeled air with the default properties of Free space. +4. Create a sphere. +• Definition method: Centre, radius +• Centre: (0, 0, 0) +• Radius: r1 +5. Set the regions of both spheres to air. +Tip: A dielectric with similar properties to free space is used instead of free space. It +allows the region to be meshed as a tetrahedral volume for FEM. +6. Union the two spheres. +7. Set the solver method for the regions to FEM. +8. Add a single incident plane wave with θ=90° and ϕ=180°. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for MoM Model. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Use the same mesh settings as for MoM Model. +2. Mesh the model. +Altair Feko 2022.3 +D EMC Analysis and Cable Coupling +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +p.174 +Altair Feko 2022.3 +D EMC Analysis and Cable Coupling +D.1.3 Viewing the Results +p.175 +Compare the shielding factor results for the sphere using the MoM and FEM solution methods. +View the shielding factor of the sphere with respect to the incident electric and magnetic fields. +Tip: Calculate the ratio between the field measured inside the sphere and the field incident +on the sphere. +a) Incident electric field on sphere: The incident electric field strength was set to Ei = 1 V/m. +b) Incident magnetic field on sphere: Calculate the incident magnetic field from the wave impedance +for a plane wave as follows: +c) The shielding factor is calculated from as follows: +(7) +(8) +(9) +Figure 79: The shielding factor for the electric fields for a sphere with finite conductivity. +Figure 80: The shielding factor for the magnetic fields for a sphere with finite conductivity. +D.2 Calculating Field Coupling into a Shielded Cable +Calculate the coupling between a monopole antenna and a nearby shielded cable that follows an +arbitrary path above a ground plane. +The cable analysis method is used to analyse the cable harness. This method first solves the model +without the cable and then calculates the coupling into the cable using the cable transfer impedance. +Included in the cable analysis method is a database of measured cable properties (integrated in Feko). +Note: Simple cables such as unshielded cables or twisted pairs can also be modelled using +the full MoM solver method. However, the memory requirement and solution time will be +much larger than the cable analysis method. +Figure 81: 3D view of an RG58 shielded cable illuminated by a monopole above an infinite ground plane. +D.2.1 Creating the Monopole and Ground Plane +Create a monopole antenna and infinite PEC ground plane. +1. Define the following variables: +• fmin = 1e6 (The minimum frequency.) +• fmax = 35e6 (The maximum frequency.) +• wireRadius = 1e-3 (The wire radius of the monopole.) +2. Create the monopole. +a) Create a line. +• Start point: (0, 0, 0) +• End point: (0, 0, 10) +3. Add a wire port (segment) to the base of the line. +4. Add a voltage source to the port. (1 V, 0°, 50 Ω). +5. Set the total source power (no mismatch) to 10 W. +6. Add an infinite PEC ground plane. +D.2.2 Creating the Shielded Cable, Connections and +Terminations +Create a cable path section with cable harness. Create the connections and terminations in the +schematic view. Set the frequency. +1. Create a cable path with the following (x, y, z) corners: +1. Corner 1: (0, 2, 0.01) +2. Corner 2: (10, 2, 0.01) +3. Corner 3: (10, 5, 0.01) +4. Corner 4: (7, 8, 0.01) +5. Corner 5: (0, 8, 0.01) +2. Create a cable harness. +A typical harness consists of multiple cables routed along the same cable path. +3. Create two cable connectors for both ends of the cable path. Rename their labels to +startConnector and endConnector. +Both connectors will have two pins; one that is live and one for ground (cable shield). +4. Create a coaxial cable and select RG58 C/U from the list of predefined coaxial cable types. +5. Create a cable instance that runs from startConnector to endConnector. +1. Connect the two live pins. Ensure the live pins connect to the centre conducting wire. +2. Connect the two ground pins. Ensure the ground pins connect to the outer shielding of the +cable. +3. Verify that the connections are correct by looking at the labels in the preview. +6. Open the CableHarness1 schematic view. +a) Add a 50 Ω complex load to each connector to terminate the cable. The load must be +connected between the live and ground pins. +b) Connect the outer shields of the cables (ground pins) to the global ground in the schematic +view. +7. Set a continuous frequency range from fmin to fmax. +D.2.3 Defining Calculation Requests +Define the calculation requests in CADFEKO. +Add a voltage probe over the load termination at the connector with label startConnector. +Tip: If the port impedance or power is of interest, a current probe must be requested in +series to the terminating load. The values can then be derived using Ohm’s law. +D.2.4 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to wireRadius. +D.2.5 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +D.2.6 Viewing the Results +View and post-process the results in POSTFEKO. +View the voltage over the terminating load on a Cartesian graph. +Figure 82: Voltage induced in a terminated shielded cable by an external source. +D.3 A Magnetic-Field Probe +Calculate the segment current on a magnetic-field probe as a function of the plane wave incidence +angle. +The wavelength, λ, is approximately 10 m at 30 MHz. +Figure 83: 3D view of the magnetic-field probe with plane wave incidence over multiple angles. +D.3.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables: +• freq = 30e6 (The operating frequency.) +• lambda = c0/freq (The wavelength in free space.) +• rBig = 1 (Radius of revolution.) +• rSmall = 0.1 (The pipe radius.) +• wireRad = 5e-3 (The wire segment radius.) +2. Create an elliptic arc with radius set to rSmall. Change the workplane origin to (-rBig ,0,0). Set +the U vector to (0, 0, 1) and V vector to (1, 0, 0). +3. Rotate the arc over an angle of 185° around the Z axis. +4. Spin the ellipse over an angle of 350° around the Z axis. +5. Draw an elliptic arc through the centre of the toroidal section. (radius = rBig, start angle = 0°, +end angle = 360°) +6. Add an incident plane wave that loops over multiple incident angles with 0°≤θ≤90° and ϕ=0°. Set +the Polarisation (angle) to 90°. Increment the incident angle, θ, in 10° steps. +7. Set the frequency to freq. +D.3.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a currents request (segment currents). +D.3.3 Meshing the Model +Create the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Create the mesh by using either the Fine or Standard auto-mesh setting. +2. Set the Wire segment radius equal to wireRad. +Tip: Experiment with the advanced mesh settings. Open the Modify mesh dialog and +click the Advanced tab. +D.3.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +D.3.5 Viewing the Results +Use POSTFEKO to view the results. +Create a Cartesian graph and add the segment currents to the graph. +Figure 84: The current in an arbitrary segment vs plane wave source incidence angle. +Note: Each segment will result in a slightly different current as a function of the plane wave +source angle of incidence. +D.4 Antenna Radiation Hazard (RADHAZ) Safety +Zones +Calculate the safety zones around a Yagi-Uda antenna based on radiation INIRC88 and NRPB89 +standards. View the safety zone ISO surfaces. +Calculate a full 3D near field cube of the antenna's immediate surroundings. Use math scripts to identify +the safety zones. +Figure 85: The 3D safety zones for 80% and maximum exposure levels according to the INIRC 88 standard at 0.95 +GHz. +Note: The INIRC (International Non-ionising Radiation Committee) and NRPB (The UK +National Radiological Protection Board) provide standards that determine safe radiation +thresholds. These standards are typically frequency dependent and defined in a piece-wise +manner. +D.4.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables. +• freq = 1e9 (The operating frequency.) +• fmin = 0.4e9 (The minimum frequency.) +• fmax = 1.5e9 (The maximum frequency.) +• lambda = c0/freq (The frequency for free space wavelength.) +• L0 = 0.2375 (Length of the reflector element in wavelengths.) +• L1 = 0.2265 (Length of the driver element in wavelengths.) +• L2 = 0.223 (Length of the first director element in wavelengths.) +• L3 = 0.223 (Width of the second director element in wavelengths.) +• S0 = 0.3 (Spacing between the reflector and driver element in wavelengths.) +• S1 = 0.3 (Spacing between the driver element and first director element.) +• S2 = 0.3 (Spacing between directors.) +• r = 0.1e-3 (Wire radius in mm.) +2. Create the dipole (driven element) of the Yagi-Uda antenna. +a) Create a line. +• Start point: (0, 0, -L1*lambda) +• End point: (0, 0, L1*lambda) +b) Add a wire port to the middle of the line. +c) Add a voltage source to the port. (1 V, 0°, 50 Ω). +3. Create the reflector of the Yagi-Uda antenna. +a) Create a line. +• Start point: (-S0*lambda, 0, -L0*lambda) +• End point: (-S0*lambda, 0, L0*lambda) +4. Create the first director of the Yagi-Uda antenna. +a) Create a line. +• Start point: (S1*lambda, 0, -L2*lambda) +• End point: (S1*lambda, 0, L2 *lambda) +5. Create the second director of the Yagi-Uda antenna. +a) Create a line. +• Start point: ((S1+S2)*lambda, 0, -L3*lambda) +• End point: ((S1 + S2)*lambda, 0, L3*lambda) +6. Set the incident power as follows: +a) Select Incident power (transmission line model). +b) Source power (Watt): 25 +c) Real part of Z0: 50 +7. Set the continuous frequency range from fmin to fmax. +D.4.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a near field request. +• Definition method: Cartesian +• Select Specify number of points from the list. +• Start: (-0.6, -0.6, -0.6) +• End: (1.2, 0.6, 0.6) +• Number of field points: (20, 10, 10) +D.4.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to r. +D.4.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +D.4.5 Viewing the Results +View and post-process the results in POSTFEKO. +Note: The session, radiation_zones.pfs, is included in the Feko installation. +The session contains the results from the antenna simulation and the following three scripts: +• INIRC88 +This script generates a near field result that incorporates the calculated near fields and the +INIRC 88 safety standards for occupational limits. +NRPB89 +This script generates a near field result that incorporates the calculated near fields and the +NRPB 89 safety standards. +standards +This is a custom dataset that contains both the INIRC 88 and NRPB 89 safety standards. +The result shows the maximum field limits for both magnetic and electric fields over the +calculated frequency band. +1. View the electric and magnetic field limits for the INIRC 88 and NRPB 89 safety standards over the +frequency band. +Figure 86: The electric field values at a given location (-0.0316, -0.067, -0.2) m over frequency. +2. Determine if the point (-0.0316, -0.067, -0.2) m is within the safety limits. +Figure 87: The electric and magnetic field limits for the INIRC 88 and NRPB 89 safety standards. +Note: The electric field exceeds the maximum limit over the bandwidth of 1.031 – +1.179 GHz. +Altair Feko 2022.3 +D EMC Analysis and Cable Coupling +Script - Create Dataset +p.189 +This script illustrates how the INIRC 88 safety standards and NRPB 89 safety standards are added as a +dataset that allows you to plot the threshold values on a graph. +-- Create a dataset containing the standards formulae for reference +standards = pf.DataSet.New() +standards.Axes:Add( pf.Enums.DataSetAxisEnum.Frequency, pf.Enums.FrequencyUnitEnum.Hz, +400e6, 1.5e9 ,21 ) +standards.Quantities:Add( "E_inirc88",pf.Enums.DataSetQuantityTypeEnum.Scalar,"V/m") +standards.Quantities:Add( "E_nrpb89",pf.Enums.DataSetQuantityTypeEnum.Scalar,"V/m") +standards.Quantities:Add( "H_inirc88",pf.Enums.DataSetQuantityTypeEnum.Scalar,"A/m") +standards.Quantities:Add( "H_nrpb89",pf.Enums.DataSetQuantityTypeEnum.Scalar,"A/m") +for freqIndex = 1,standards.Axes[pf.Enums.DataSetAxisEnum.Frequency].Count do +local freqHz = standards[freqIndex]:AxisValue(pf.Enums.DataSetAxisEnum.Frequency) +local freqMHz = freqHz/1e6 -- frequency in MHz +local freqGHz = freqHz/1e9 -- frequency in GHz +local standardsPt = standards[freqIndex] +-- Electric field limits +standardsPt.E_inirc88 = 3*math.sqrt(freqMHz) +standardsPt.E_nrpb89 = 97.1*math.sqrt(freqGHz) +-- Magnetic field limits +standardsPt.H_inirc88 = 0.008*math.sqrt(freqMHz) +standardsPt.H_nrpb89 = 0.258*math.sqrt(freqGHz) +end +return standards +Altair Feko 2022.3 +D EMC Analysis and Cable Coupling + INIRC 88 Standard +p.190 +The definition for electric and magnetic field limits according to INIRC 88 between 0.4 GHz to 2.0 GHz. +Field type +Definition (f in MHz) +Electric field +Magnetic field +Unit +V/m +A/m +(10) +(11) +Script - RADHAZ Safety Zone Using INIRC 88 Standard +This script generates a near field result that incorporates the calculated near fields and the INIRC 88 +safety standards for occupational limits. +The normalised threshold as per INIRC 88 +Each near field value is processed and normalised to the maximum field value that the standard allows +for that frequency. A value of “1” corresponds to the field threshold according to the standard. A value +higher than “1” is over the limit and a value lower than“1” is a safe zone. +-- This example illustrates how advanced calculations +-- can be performed to display radiation hazard zones. +-- The INIRC 88 standards are used. +nf = pf.NearField.GetDataSet("yagi.StandardConfiguration1.nf3D") +function calculateRADHAZThresholds(index, nf) +-- Get a handle on the indexed near field point +local nfPt = nf[index] +-- Set up the threshold according to the standards +-- Frequency in MHz +local freq = nfPt:AxisValue(pf.Enums.DataSetAxisEnum.Frequency)/1e6 +local EfieldLimit = 3*math.sqrt(freq) +local HfieldLimit = 0.008*math.sqrt(freq) +-- SCALE THE ELECTRIC FIELD VALUES +-- Scale the values to indicate percentages. The percentage represents +-- the field value relative to the limit of the standard. +nfPt.EFieldComp1 = nfPt.EFieldComp1/(EfieldLimit) +nfPt.EFieldComp2 = nfPt.EFieldComp2/(EfieldLimit) +nfPt.EFieldComp3 = nfPt.EFieldComp3/(EfieldLimit) +-- SCALE THE MAGNETIC FIELD VALUES +-- Scale the values to indicate percentages. The percentage represents +-- the field value relative to the limit of the standard. +nfPt.HFieldComp1 = nfPt.HFieldComp1/(HfieldLimit) +nfPt.HFieldComp2 = nfPt.HFieldComp2/(HfieldLimit) +nfPt.HFieldComp3 = nfPt.HFieldComp3/(HfieldLimit) +end +pf.DataSet.ForAllValues(calculateRADHAZThresholds, nf) +-- Note that in essence, the values being returned are +-- no longer near fields. As such, interpret them +-- carefully in POSTFEKO. +return nf +Altair Feko 2022.3 +D EMC Analysis and Cable Coupling + NRPB 89 Standard +p.191 +The definition for electric and magnetic field limits according to NRPB 89 between 0.4 GHz to 2.0 GHz. +Field type +Definition (F in MHz) +Electric field +Magnetic field +Unit +V/m +A/m +(12) +(13) +Script - RADHAZ Safety Zone Using NRPB 89 Standard +This script generates a near field result that incorporates the calculated near fields and the NRPB 89 +safety standards. +The normalised threshold as per NRPB 89 +Each near field value is processed and normalised to the maximum field value that the standard allows +for that frequency. A value of “1” corresponds to the field threshold according to the standard. A value +higher than “1” is over the limit and a value lower than“1” is a safe zone. +-- This example illustrates how advanced calculations +-- can be performed to display radiation hazard zones. +-- The NRPB 89 standards are used. +nf = pf.NearField.GetDataSet("yagi.StandardConfiguration1.nf3D") +function calculateRADHAZThresholds(index, nf) +-- Get a handle on the indexed near field point +local nfPt = nf[index] +-- Set up the threshold according to the standards +-- Frequency in GHz +local freq = nfPt:AxisValue(pf.Enums.DataSetAxisEnum.Frequency)/1e9 +local EfieldLimit = 97.1*math.sqrt(freq) +local HfieldLimit = 0.258*math.sqrt(freq) +-- SCALE THE ELECTRIC FIELD VALUES +-- Scale the values to indicate percentages. The percentage represents +-- the field value relative to the limit of the standard. +nfPt.EFieldComp1 = nfPt.EFieldComp1/(EfieldLimit) +nfPt.EFieldComp2 = nfPt.EFieldComp2/(EfieldLimit) +nfPt.EFieldComp3 = nfPt.EFieldComp3/(EfieldLimit) +-- SCALE THE MAGNETIC FIELD VALUES +-- Scale the values to indicate percentages. The percentage represents +-- the field value relative to the limit of the standard. +nfPt.HFieldComp1 = nfPt.HFieldComp1/(HfieldLimit) +nfPt.HFieldComp2 = nfPt.HFieldComp2/(HfieldLimit) +nfPt.HFieldComp3 = nfPt.HFieldComp3/(HfieldLimit) +end +pf.DataSet.ForAllValues(calculateRADHAZThresholds, nf) +-- Note that in essence, the values being returned are +-- no longer near fields. As such, interpret them +-- carefully in POSTFEKO. +return nf +Waveguide and Microwave +Circuits +E Waveguide and Microwave Circuits +Simple examples demonstrating using waveguides and microwave circuits. +This chapter covers the following: +• E.1 Microstrip Filter (p. 193) +• E.2 S-Parameter Coupling in a Stepped Waveguide Section (p. 204) +• E.3 Using a Non-radiating Network to Match a Dipole Antenna (p. 211) +• E.4 Subdividing a Model Using Non-Radiating Networks (p. 216) +Altair Feko 2022.3 +E Waveguide and Microwave Circuits +E.1 Microstrip Filter +p.193 +Calculate the S-parameters of a simple microstrip notch filter. Use different solvers and compare the +results. +The S-parameter results are compared for the following solvers: +• Finite substrate with FEM method. +• Finite substrate with SEP method. +• Infinite substrate with planar mutilayer substrate (Green's functions). +Note: Reference: +G. V. Eleftheriades and J. R. Mosig, “On the Network Characterization of Planar Passive +Circuits Using the Method of Moments”, IEEE Trans. MTT, vol. 44, no. 3, March 1996, pp. +438-445, Figs 7 and 9. +Figure 88: 3D view of the microstrip filter (cut plane view). +E.1.1 Microstrip Filter on a Finite Substrate (FEM) +Model the microstrip filter using the finite element method. Use a FEM modal port for the source. +Construct the substrate and shielding box from cuboids. Construct the microstrip line with a cuboid and +delete the undesired faces. Construct the stub from a line, swept to form a surface. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the model unit to millimetres. +2. Define the following variables: +• shielding_height = 11.4 (height of the shielding box.) +• substrate_height = 1.57 (substrate height.) +• epsr = 2.33 (relative permittivity.) +• gnd_length = 92 (length and width of substrate.) +• port_offset = 0.5 (inset of feed point.) +• strip_width = 4.6 (width of microstrip sections.) +• strip_offset = 23 (microstrip offset from ground edge.) +• fmin = 1.5e9 (lowest calculation frequency.) +• fmax = 4e9 (highest calculation frequency.) +• stub_length = 18.4 (length of the stub.) +• stub_offset = 41.4 (distance from the ground edge to stub.) +3. Create dielectric media: +1. +2. +• Label: air +• Relative permittivity: 1 +• Label: substrate +• Relative permittivity: epsr +4. Create the substrate layer. +a) Create a cuboid. +• Base corner (C): (0, 0, 0) +• Width (W): gnd_length +• Depth (D): gnd_length +• Heigth (H): substrate_height +• Label: substrate +5. Create the shielding box. +a) Create a cuboid. +• Base corner (C): (0, 0, 0) +• Width (W): gnd_length +• Depth (D): gnd_length +• Heigth (H): shielding_height +• Label: shielding_box +6. Create the microstrip. +a) Create a cuboid. +• Base corner (C): (port_offset, strip_offset, 0) +• Width (W): gnd_length-port_offset*2 +• Depth (D): strip_width +• Heigth (H): substrate_height +• Label: microstrip +Note: A cuboid is created whereby the bottom face will be coincident with the +ground plane (bottom face of shielding_box). Alternately, a polygon or rectangle +could have been used to create the microstrip. +7. Delete all the vertical faces of the microstrip part. +8. Create the stub. +a) Create a line. +• Start point: (stub_offset, strip_offset+strip_width, substrate_height) +• End point: (stub_offset+strip_width, strip_offset+strip_width, +substrate_height) +• Label: leading_edge. +b) Sweep the line. +• Start point: (0, 0, 0) +• End point: (0, stub_length, 0) +c) Rename the sweep to stub. +9. Create the feed segments. +a) Create the first line. +• Start point: (0, strip_offset+strip_width/2, substrate_height) +• End point: (port_offset, strip_offset+strip_width/2, substrate_height) +• Label: feed1 +b) Create the second line. +• Start point: (gnd_length-port_offset, strip_offset+strip_width/2, +substrate_height) +• End point: (gnd_length, strip_offset+strip_width/2, substrate_height) +• Label: feed2 +10. Union all the parts and rename the Union to shielded_filter. +11. Set the Region of the substrate to substrate. +12. Set the Region above the substrate to air. +13. Set the solution method on all regions to FEM. +Tip: Open the Modify Region dialog and click the Solution tab. From the Solution +method drop-down list, select Finite Element Method (FEM). +14. Set all the face properties to PEC except for the two faces of the substrate (at the height of +substrate_height). +15. Set the frequency +• Continuous interpolated range +• Start frequency (Hz): fmin. +• End frequency (Hz): fmax. +16. Add two FEM line ports, one for each feed line. +Tip: From the Source/Load tab select FEM Line Port, use the option Specify port +as an edge and click on the feed line in the 3D view. +Figure 89: Zoomed in 3D view of one of the FEM line ports. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +1. Create a S-parameters request. +a) Set FEMLinePort1 as the active port +b) Add FEMLinePort2 but set this port as inactive. +Tip: Every active port is treated as a new source increasing the runtime. +Altair Feko 2022.3 +E Waveguide and Microwave Circuits +2. Delete StandardConfiguration1. +p.197 +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +E.1.2 Microstrip Filter on a Finite Substrate (SEP) +Model the microstrip filter using the surface equivalence principle. Use a voltage source on an edge port +for the source. +Modify the finite element model from Microstrip Filter on a Finite Substrate (FEM) to use the surface +equivalence principle. Remove the line ports. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Request a standard configuration and delete the existing S-Parameter configuration. +2. Delete the FEM line ports. +3. Expand shielded_filter and delete Feed1 and Feed2. +4. Set the region properties of both regions back to the the default, namely MoM/MLFMM with +surface equivalence principle (SEP) - default. +5. Set the air region back to Free Space. +6. Create two vertical plates between the microstrip feeding edges and the ground plane. +a) Set the Selection type to Edges and select the leading edges of the microstrip line (at the +input and output locations of the model). +b) Create a copy of these edges. +c) Select the copied edges (parts in the tree) and use the Sweep tool to sweep the edges in the +negative Z direction a distance of substrate_height. +7. Create edges for the edge ports on the vertical plates. +a) Split the vertical plates on a perpendicular plane at a height exactly halfway between the +microstrip line and ground plane. +8. Union all the parts in the tree. +9. Create edge ports on the edges separating the two halves of the vertical plates. +Note: Edge ports must be surrounded on all sides by the same medium - these +cannot be on the surface of a finite dielectric. +10. Set all the face properties to PEC except for the boundary surface between the dielectric layers. +11. Set a local mesh size on the microstrip faces of strip_width/2. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +1. Create a S-parameters request. +a) Set EdgePort1 as the active port +b) Add EdgePort2 but set this port as inactive. +2. Delete StandardConfiguration1. +Altair Feko 2022.3 +E Waveguide and Microwave Circuits +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +p.199 +E.1.3 Microstrip Filter on an Infinite Substrate (Planar +Multilayer Green's Function) +Model the microstrip filter using an infinite substrate and planar multilayer Green's function. Use a +voltage source on a microstrip port for the source. +Modify the finite element model from Microstrip Filter on a Finite Substrate (FEM) to use an infinite +substrate. Remove the line ports. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Request a standard configuration. +2. Delete the FEM line ports. +3. Expand shielded_filter and delete Feed1 and Feed2. +4. Set the region properties of the two regions back to the default (MoM/MLFMM with surface +equivalence principle (SEP) - default). +5. Delete all horizontally orientated faces, except that of the top of the box, the microstrip line and +stub. +6. Add a planar multilayer substrate (infinite plane) with a conducting layer at the bottom. +a) Select Plane / Ground. +• Click Planar multilayer substrate. +• Thickness (Layer 1): substrate_height +• Medium (Layer 1): substrate +• Ground plane (Layer 1): PEC +• Z value at the top of layer 1: substrate_height +7. Add microstrip ports to the edges of the feedline . +Figure 90: Microstrip ports were added to the edges of the feedline. Note that the infinite plane is hidden and +a cutplane was added to show the port locations. +Figure 91: Zoomed in 3D view of one of the microstrip ports. +Tip: The microstrip port connects to a single edge and is only used with infinite +substrates. The positive terminal is indicated by the red cylinder in the 3D view. +8. Set a local mesh size on the microstrip lines (faces) of strip_width/2. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +1. Create a S-parameters request. +a) Set MicrostripPort1 as the active port +b) Add MicrostripPort2 but set this port as inactive. +2. Delete StandardConfiguration1. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Altair Feko 2022.3 +E Waveguide and Microwave Circuits +E.1.4 Viewing the Results +View and post-process the results in POSTFEKO. +1. Plot the magnitude of S11 for all 3 models on the same Cartesian graph. +2. Create a Duplicate view of the graph and change the traces to display S21. +Note: The different solution methods are in good agreement. +p.202 +Figure 92: S11 in dB of the microstrip filter. +Figure 93: S21 in dB of the microstrip filter. +E.2 S-Parameter Coupling in a Stepped Waveguide +Section +Calculate the transmission and reflection for a stepped waveguide transition from the Ku- to X-band. +Use two solver methods, the method of moments (utilising waveguide ports) and the finite element +method (utilising FEM modal ports). +The waveguide consists of a Ku-band section and an X-band section. Only the H10 mode with cutoff +frequency, + GHz is considered. +The Ku-band section dimensions are as follows: +• a = 15.8 mm +• b = 7.9 mm +The X-band section dimensions are as follows: +• a = 22.9 mm +• b = 10.2 mm +Calculate S-parameters from the cutoff frequency to 15 GHz. +Figure 94: 3D view of the waveguide step. +E.2.1 S-Parameter Coupling in a Stepped Waveguide +Section (MoM) +Calculate the transmission and reflection for the waveguide with the method of moments. Use +waveguide ports for the sources. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the model unit to millimeters. +2. Define the following variables: +• a1 = 15.8 (width of Ku section.) +• b1 = 7.9 (height of Ku section.) +• l1 = 12 (length of Ku section.) +• a2 = 22.9 (width of X section.) +• b2 = 10.2 (height of X section.) +• l2 = 12 (length of X section.) +• fmin = 9.4872e9 (minimum calculation frequency.) +• fmax = 15e9 (maximum calculation frequency.) +Note: fmin is just above the cutoff frequency for the Ku band waveguide section. +3. Create the Ku band section. +a) Create a cuboid +• Base corner (C): (-a1/2, -l1, -b1/2) +• Width (W): a1 +• Depth (D): l1 +• Height (H): b1 +• Label: Ku_band_wguide +4. Create the X band section. +a) Create a cuboid. +• Base corner (C): (-a2/2, 0, -b2/2) +• Width (W): a2 +• Depth (D): l2 +• Height (H): b2 +• Label: X_band_wguide +5. Union both cuboids. +6. Set the both regions to free space. +Tip: Free space changes the region from solid PEC to vacuum. +7. Simplify the part with the simplify tool. +Tip: The simplify tool removes the face at the junction between the two cuboids. +Alternately, use face selection to delete this face. +8. Rename the face at the end of the Ku band section to Port1 and at the X band section to Port2. +9. Add waveguide ports to the faces with labels Port1 and Port2. +Tip: For accurate phase results set the reference vector with the same orientation for +both ports. This is not required for the magnitude. +10. Check that the propagation direction of each port is set inwards. +11. Set the frequency. +• Continuous interpolated range. +• Start frequency (Hz): fmin +• End frequency (Hz): fmax +Tip: Set symmetry to save computational resources. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +1. Create a S-parameters request. +a) Set WaveguidePort1 as the active port. +b) Include WaveguidePort2 but set this port as inactive. +c) For the Properties tab choose Fundamental. +Tip: Every active port acts as a new source, increasing the runtime. +2. Delete the standard configuration. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Mesh size equal to Fine. +Altair Feko 2022.3 +E Waveguide and Microwave Circuits +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +p.207 +E.2.2 S-Parameter Coupling in a Stepped Waveguide +Section (FEM) +Calculate the transmission and reflection through the waveguide with the finite element method. Use +FEM modal ports for the source. Modify the model from S-Parameter Coupling in a Stepped Waveguide +Section (MoM). +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Delete the waveguide ports. +2. Create a dielectric medium: +• Label: air +• Relative permittivity: 1 +3. Set the Region medium of the waveguide to air. +Note: The FEM solver uses tetrahedral volume meshing. To mesh the volume of the +waveguide into tetrahedra, a dielectric of air is created. +4. Change the solver to use the FEM. +Tip: Open the Modify Region dialog and click the Solution tab. From the Solution +method drop-down list, select Finite Element Method (FEM). +5. Create FEM modal ports on the faces for FEMModalPort1 and FEMModalPort2. +6. Set all the faces of the model, except the port faces, to PEC. +Note: FEM modal port faces must be of the dielectric type. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a S-parameters request. +a) Set FEMModalPort1 as the active port +b) Add FEMModalPort2 but set this port as inactive. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Mesh size equal to Fine. +Altair Feko 2022.3 +E Waveguide and Microwave Circuits +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +p.209 +E.2.3 Viewing the Results +View and post-process the results in POSTFEKO. +Plot S11 and S21 for both models on a Cartesian graph. +Figure 95: S-parameter results for the waveguide step in POSTFEKO. +The two solvers give identical results. +E.3 Using a Non-radiating Network to Match a +Dipole Antenna +Match a short dipole for resonance at 1.4 GHz with an LC matching section. The matched network is +modelled using a Spice circuit and S-parameters. +The dipole length is approximately 1/3λ. The matching network consists of a 2.43 pF shunt capacitor +and 41.2 nH series inductor and is connected between the source and the dipole. +Figure 96: 3D view of the dipole (left) and the schematic representing the matching network used at the port +(right). +Note: The matching SPICE file (Match_circuit.cir) and Touchstone file (Matching.s2p) +are included with the example. +E.3.1 Dipole Matching Using a SPICE Network +Match the dipole using a SPICE network. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the model unit to millimetres. +2. Define the following variables. +• fmin = 1.3e9 (The lowest simulation frequency.) +• fmax = 1.5e9 (The highest simulation frequency.) +• h = 70 (The height of the dipole.) +• wireRadius = 0.1 (The radius of the dipole segments.) +3. Create the dipole. +a) Create a line. +• Start point: (0, 0, -h/2) +• End point: (0, 0, h/2) +• Label: dipole +b) Add a wire port to the middle of the line. +c) Label the port Port1. +4. Set a continuous frequency range from fmin to fmax. +5. Create a general network using a SPICE circuit. +a) Rename GeneralNetwork1 to MatchingNetwork. +Note: The network label must correspond to the internal network name used in +Match_circuit.cir. +Matching circuit +.SUBCKT MatchingNetwork n1 n2 +c1 n1 0 2.43pF +l1 n1 n2 41.2nH +.ENDS NWN1 +.end +6. Create a voltage source. +a) For Port select MatchingNetwork.Port1 +7. +In the schematic view, connect Port1 (the dipole) to Port2 of the network. +Figure 97: Schematic view of the matching network and port of the dipole. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +No solution requests are required. +Note: Input impedance results are always available for voltage sources. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to wireRadius. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +E.3.2 Dipole Matching Using a General S-Parameter +Network +Match the dipole using a general S-parameter network. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in Dipole Matching Using a SPICE Network and rename the file. +2. Modify the general network to define it in terms of S-parameters using a Touchstone file +(Matching.s2p). +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for Dipole Matching Using a SPICE Network. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to wireRadius. +Altair Feko 2022.3 +E Waveguide and Microwave Circuits +E.3.3 Viewing the Results +View and post-process the results in POSTFEKO. +Compare the reflection coefficient of the unmatched dipole and the matched dipole. +p.215 +Figure 98: The reflection coefficient of the dipole before and after application of the feed matching. +Note: The reflection coefficient of the unmatched dipole is close to 0 dB over the frequency +band. Hide the traces for the matched dipole to view the variation in the reflection coefficient +of the unmatched dipole. +E.4 Subdividing a Model Using Non-Radiating +Networks +Calculate the input impedance of a circularly polarised patch antenna fed through a microstrip branch +coupler. Replace the branch coupler with a non-radiating network and compare with a full solution. +Figure 99: 3D view of the patch antenna with feed network. +Follow the steps below to solve the model: +1. Solve the S-parameters of the feed network separately and export to a Touchstone file. +2. Use the Touchstone file in a non-radiating network to feed the two input ports directly connected +to the patch. +3. Solve the full model of the feed network and patch together. +4. Compare the results between the full model and subdivided model. +Altair Feko 2022.3 +E Waveguide and Microwave Circuits +E.4.1 Feed Network +p.217 +Calculate the S-parameters of the branch coupler and export to a Touchstone file. The branch coupler is +designed for 120 Ω, distributes power evenly and has a 90 degree phase shift between the output ports. +Figure 100: 3D view of the feed network. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Create a dielectric medium. +• Label: RogersDuroid5870 +• Relative permittivity: 2.2 +• Dielectric loss tangent: 0.0012 +2. Add a planar multilayer substrate (infinite plane) with a conducting layer at the bottom. +a) Select Plane / Ground. +• Click Planar multilayer substrate. +• Thickness (Layer 1): 2.5e-3 +• Medium (Layer 1): RogersDuroid5870 +• Ground plane (Layer 1): PEC +• Z value at the top of layer 1: 0. +3. Create the branch coupler. +a) Import the Parasolid model from file. +Tip: On the Home tab, select Import and select Geometry. Browse for the +feedNetwork.x_b Parasolid file. +4. Create four microstrip ports on the four terminals of the network. Number the ports sequentially in +an anti-clockwise manner. +Figure 101: 3D view of the feed network showing the port numbering. +5. Add a 120 Ω load on MicrostripPort4. +6. Set the frequency. +• Continuous interpolated range +• Start frequency (Hz): 0.8*2.4e9 +• End frequency (Hz): 1.2*2.4e9 +• On the Export tab check the Specify number of samples for exported data check box +and enter a value of 100. +Note: The setting ensures that the exported Touchstone file contains 100 +frequency samples. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create an S-parameters request. +a) Set MicrostripPort1 to MicrostripPort3 as active ports. +b) For Impedance enter 120 for all the ports. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the Mesh size equal to Custom. +2. Set the Triangle edge length equal to 1.4e-3. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +E.4.2 Patch with Non-Radiating Feed Network +Calculate the input impedance of the patch antenna with non-radiating feed network. Use the network +parameters obtained from the Touchstone file. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Create a dielectric medium. +• Label: RogersDuroid5870 +• Relative permittivity: 2.2 +• Dielectric loss tangent: 0.0012 +2. Add a planar multilayer substrate (infinite plane) with a conducting layer at the bottom. +a) Select Plane / Ground. +• Click Planar multilayer substrate. +• Thickness (Layer 1): 2.5e-3 +• Medium (Layer 1): RogersDuroid5870 +• Ground plane (Layer 1): PEC +• Z value at the top of layer 1: 0 +3. Create the patch. +a) Create a rectangle. +• Definition method: Base centre, width, depth +• Base centre (C): (0, 0, 0) +• Width (W): 39e-3 +• Depth (D): 39e-3 +4. Create the inset feeds. +a) Create a rectangle. +• Definition method: Base corner, width, depth +• Base centre (C): (-1.4e-3, -39e-3/2, 0) +• Width (W): 2.8e-3 +• Depth (D): 6.5e-3 +• Label: InsetRectangleLarge +b) Create another rectangle. +• Definition method: Base corner, width, depth +• Base centre (C): (-1.4e-3/2, -39e-3/2, 0) +• Width (W): 1.4e-3 +• Depth (D): 6.5e-3 +• Label: InsetRectangleSmall +c) Union InsetRectangleSmall with InsetRectangleLarge. +d) Copy and rotate the Union by 90 degrees. +e) Union all the parts in the tree. +f) Delete the two face pairs from the newly created Union1 to complete the inset feeds. +Figure 102: Construction of the inset feeds for the patch (redundant faces to be deleted in yellow.) +5. Create two microstrip ports on the outer edges of the inset feeds, one port for each feed. +6. Create a new network. +• Data type: S-matrix +• Source: Touchstone file +• Number of network terminals: 3 +• Browse for the .s3p file. +7. Connect the input ports of the patch to the output ports of the network in the schematic view. +Figure 103: Schematic view showing the port connections. +8. Add a voltage source to GeneralNetwork1.Port1 +Note: The voltage source will not be displayed in the schematic view. +9. Set the frequency. +• Continuous (interpolated) range +• Start frequency (Hz): 0.8*2.4e9 +Altair Feko 2022.3 +E Waveguide and Microwave Circuits +• End frequency (Hz): 1.2*2.4e9 +p.222 +Note: No output requests are necessary. The intput impedance of the voltage source +is computed automatically. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the Mesh size equal to Standard. +2. Set a local mesh size on the two faces for the inset feeds of 1.4e-3. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +E.4.3 Patch with Full Feed Network +Calculate the input impedance of the patch antenna and full feed network combined. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Open the model touchstoneFedPatch.cfx. +2. Save the model as completePatch.cfx. +3. Delete the voltage source. +4. Delete the general network connections in the schematic view. +5. Delete the general network. +6. Delete all the ports. +7. +Import the model feedNetwork.cfx. +a) On the Import CADFEKO model window select the following check boxes: +• Geometry +• Meshing rules +• Merge identical variables +• Merge identical media +8. Delete MicrostripPort2 and MicrostripPort3. +Note: The output ports of the feed network are removed but the input ports are +retained. +9. Union the feed network and patch. +10. Add a voltage source to MicrostripPort1 (1 V, 0°, 50 Ω). +11. Add a 120 Ω load to MicrostripPort4. +Note: No output requests are necessary. The input impedance of the voltage source is +computed automatically. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the Mesh size equal to Standard. +2. Set a local mesh size on all of the faces of the feed network and inset feeds of 1.4e-3. +Altair Feko 2022.3 +E Waveguide and Microwave Circuits +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +p.224 +Altair Feko 2022.3 +E Waveguide and Microwave Circuits +E.4.4 Viewing the Results +View and post-process the results in POSTFEKO. +p.225 +1. Load both the full model and subdivided model into POSTFEKO. +2. Plot the real and imaginary parts of the input impedance (MicrostripPort1) on a Cartesian graph. +3. Compare the computational resources of the models. +Table 4: Comparison of the computational resources for the models (per frequency point). +Model +Full model +Network only +Patch with network +Memory (MByte) +Time (s) +3.7 +3.3 +3.4 +184 +78 +138 +The solution time is reduced when substituting the feed network with a non-radiating network. +This method reduces the design time of the full model if the feed network design is final but the +antenna requires further changes. For larger models the computational resource differences will be +more pronounced. +Figure 104: Input impedance of the patch: Full model vs using a non-radiating network. +E.5 Microstrip Coupler +Calculate the S-parameters (coupling) of a four port microstrip coupler. Use the finite difference time +domain (FDTD). +Figure 105: Transparent top view of the microstrip coupler containing multiple layers. +E.5.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the model unit to millimetres. +2. Define the following variables. +• d1 = 2.22 (Distance between apertures.) +• d2 = 12.51 (Distance between apertures.) +• epsr = 2.2 (The relative permittivity of the substrate.) +• s = 10 (Length of the aperture.) +• w = 4.6 (Width of the microstrip.) +• strip_feed_arc_radius = 2*s (The radius of curved microstrip line.) +• strip_length = 2* s + d2 + d1 (The straight section length of the microstrip line.) +• substrate_depth = 50 (The substrate depth.) +• substrate_height = 1.58 (The substrate height.) +• substrate_width = 140 (The substrate width.) +• f_max = 5e9 (The maximum frequency.) +• f_min = 2.5e9 (The minimum frequency.) +3. Create a dielectric medium. +• Dielectric loss tangent: 0 +• Relative permittivity: epsr +• Label: substrate +4. Create the straight section of the microstrip line. +a) Create a rectangle. +• Definition method: Base corner, width, depth +• Base corner (C): (0, -w/2, substrate_height) +• Width (W): strip_length +• Depth (D): w +5. Create the feed section of the microstrip. +a) Create a rectangle. +• Definition method: Base corner, width, depth +• Base corner (C): (0, 0, 0) +• Width (W): w +• Depth (D): substrate_height +• On the Workplane tab set the Origin: (strip_length+strip_feed_arc_radius-w/2, +strip_feed_arc_radius, 0) +b) Rotate the workplane of the rectangle 90° around the U axis to align the rectangle in the XZ +plane. +Tip: Right-click on the Origin box of the workplane and click Rotate +workplane. +6. Create the arc section of the microstrip. +a) Create an elliptic arc. +• Centre point (C): (strip_length, strip_feed_arc_radius, substrate_height) +• Radius (U): strip_feed_arc_radius + w/2 +• Radius (V): strip_feed_arc_radius + w/2 +• Start angle: -90 +• Stop angle: 0 +• Label: outer_circle +7. Create a line. +• From: (0, -strip_feed_arc_radius-w/2, 0) +• To: (0, -strip_feed_arc_radius+w/2, 0) +• On the Workplane tab set the Origin: (strip_length, strip_feed_arc_radius, substrate_height +8. Pathsweep Line1 on outer_circle. +9. Union all parts. +The resulting geometry represents half of the top microstrip section. +Figure 106: Geometry after Union operation. +10. Copy and rotate Union1 by 180° around the U axis. +Note: The new part represents half of the bottom microstrip. +11. Create the ground plate. +a) Create a rectangle. +• Base Corner (C): (0, -substrate_depth/2, 0) +• Width (W): substrate_width/2 +• Depth (D): substrate_depth +• Label: ground_plate +12. Create an aperture. +a) Create a rectangle. +• Base corner (C): (d2/2, -s/2, 0) +• Width (W):s +• Depth (D):s +• Label: aperture_1 +13. Create a second aperture. +a) Create a rectangle. +• Base corner (C): (d2/2+s+d1, -s/2, 0) +• Width (W):s +• Depth (D):s +• Label: aperture_2 +14. Subtract aperture_1 and aperture_2 from ground_plate. +The resulting geometry is a ground plane between two microstrip lines with two square holes. +15. Copy and mirror all geometry around the VN plane. +Figure 107: Geometry after the copy and mirror operation. +16. Union all the parts. +17. Set all faces to perfect electric conductor (PEC). +Tip: Faces set to PEC remain PEC when becoming faces of a dielectric region. +18. Add edge ports. +Port1 +Port2 +Port3 +Port4 +Define an edge port between the bottom microstrip feed on the negative X side and the +ground plate. +Define an edge port between the bottom microstrip feed on the positive X side and the +ground plate. +Define an edge port between the top microstrip feed on the negative X side and the ground +plate. +Define an edge port between the top microstrip feed on the positive X side and the ground +plate. +19. Create two substrate layers. +a) Create a cuboid to construct the top layer. +• Definition method: Base centre, width, depth, height +• Base centre (C): (0, 0, 0) +• Width (W): substrate_width +• Depth (D): substrate_depth +• Height (H): substrate_height +• Label: top_layer +b) Create a second cuboid to construct the bottom layer. +• Definition method: Base centre, width, depth, height +• Base centre (C): (0, 0, -substrate_height) +• Width (W): substrate_width +• Depth (D): substrate_depth +• Height (H): substrate_height +• Label: bottom_layer +c) Union top_layer and bottom_layer. +d) Set both regions for this Union to the dielectric, substrate. +20. Union all the parts in the model. +21. Activate the FDTD solver. +Tip: Open the Solver settings dialog and click the FDTD tab. Select the Activate +the finite difference time domain (FDTD) solver check box. +22. Set the frequency. +• Linearly spaced discrete points +• Start frequency (Hz): f_min +• End frequency (Hz): f_max +• Number of frequencies: 101 +E.5.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +Add an S-Parameter Configuration. +a) Include all four ports with a 50Ω reference impedance. +b) Set only Port1 as Active. +E.5.3 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +E.5.4 Viewing the Results +View and post-process the results in POSTFEKO. +Plot the magnitude of S21, S31 and S41 (in dB) on a Cartesian graph. +Figure 108: S21, S31 and S41 of the microstrip coupler. +Compare the results with the literature reference, On the design of planar microwave components using +multilayer structures”, by W. Schwab and W. Menzel, IEEE Trans. MTT, vol. 40, no. 1, Jan 1992, pp. +67-72, Fig 9. +Note: The measured data from the referenced article are in good agreement with the +simulated results. Any differences are most likely due to uncertainties regarding the model +dimensions or dielectric properties. +Bio Electromagnetics +F Bio Electromagnetics +Simple examples demonstrating phantom and tissue exposure analsysis. +This chapter covers the following: +• +• +F.1 Exposure of Muscle Tissue Using the MoM/FEM Hybrid (p. 233) +F.1 Exposure of Muscle Tissue Using the MoM/FEM +Hybrid +Calculate the exposure for a sphere of muscle tissue illuminated by a dipole antenna. +Figure 109: 3D view of the muscle tissue sphere, dipole antenna with a voltage source and single near field request +point. +Note: The model contains an air layer around the muscle sphere. The air layer is not +required, but it reduces the number of triangle elements on the boundary between the +FEM (dielectric sphere) region and MoM (free space region and dipole) region. Resource +requirements are reduced when the number of boundary triangles are reduced. The +computational resource benefit is strongly model dependent. +F.1.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables. +• freq = 900e6 (The operating frequency.) +• f_min = 100e6 (The minimum frequency.) +• f_max = 1e9 (The maximum frequency.) +• d = 0.1 (Distance between the dipole and muscle sphere.) +• rA = 0.03 (Radius of the outer sphere.) +• rM = 0.025 (Radius of the inner sphere.) +• lambda = c0/freq (The wavelength in free space.) +• wireRadius = 1e-3 (Radius of the wire.) +2. Add the medium, Muscle_Parallel_Fibers_Ovine from the media library to the model. +3. Create a dielectric medium. +• Dielectric loss tangent: 0 +• Relative permittivity: 1 +• Label: air +4. Create the inner sphere. +• Definition method: Centre, radius +• Centre: (0, 0, 0) +• Radius: rM +• Label: Muscle +5. Create the outer sphere. +• Definition method: Centre, radius +• Centre: (0, 0, 0) +• Radius: rA +• Label: Air +6. Union the spheres, Muscle and Air. +7. Set the region of the inner sphere to Muscle_Parallel_Fibers_Ovine. +8. Set the region between the inner and outer sphere to air. +9. Set the solution method for the regions to FEM. +10. Create the dipole. +a) Create a line. +• Start point: (0, -lambda/4, -d) +• End point: (0, lambda/4, -d) +11. Add a wire port to the middle of the line. +12. Add a voltage source to the port. (1 V, 0°, 50 Ω). +13. Set the total source power (no mismatch) to 1 W. +14. Set a continuous frequency range from f_min to f_max. +F.1.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a near field request. The request is a single point located at the centre of the sphere. +• Definition method: Cartesian +• Select Specify number of points from the list. +• Start: (0, 0, 0) +Altair Feko 2022.3 +F Bio Electromagnetics +• End: (0, 0, 0) +• Number of field points: (1, 1, 1) +p.235 +F.1.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Wire segment radius equal to wireRadius. +F.1.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +F.1.5 Viewing the Results +View and post-process the results in POSTFEKO. +View the electric field strength as a function of frequency. +Figure 110: The electric field at the centre of the sphere over frequency. +F.2 Magnetic Resonance Imaging (MRI) Birdcage +Head Coil Example +Calculate the fields, S-parameters and B quantities of an MRI birdcage head coil containing an elliptical +phantom. +The coil is of the 7T highpass type with the tuning capacitors placed in the end-ring gaps between the +16 rungs. +Figure 111: Geometry for the 7T head coil with elliptical phantom. +F.2.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +Note: This model contains complex geometry. The creation steps are not provided, but the +model is included in the Feko installation. +Note the following model details: +• The coil has an inner radius of 15 cm and an RF shield radius of 17.54 cm. +• The elliptical phantom has a major radius of 11 cm and a minor radius of 8.5 cm. Average head +tissue properties are assigned to the phantom as follows: +◦ +◦ +relative permittivity: 36 +conductivity: 0.657 +• Capacitive loads (C = 4.15 pF) are added to the wire ports between the end-ring gaps on both +sides of the birdcage. +Note: This example is solved with MoM (SEP), but MoM/FEM or FDTD could also be used. +F.2.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +The model uses multiple configurations. +• The first configuration is a standard configuration for calculating the currents. +• The second configuration is an S-parameter configuration. +1. Define the standard configuration (default configuration). +a) Set the frequency for the standard configuration to 300 MHz. +b) Add two voltage sources to the I and Q feed ports for the quadrature excitation. +• The magnitude is set to 20 V for both ports. +• A 90° phase delay is set on the Q port. +c) Create a currents request (all currents). +d) Create a near field request at Z=0. +2. Add an S-parameter configuration. +a) Set a continuous frequency range for the S-parameter configuration from 290 MHz to +310 MHz. +b) Set the ports PortI1 and PortQ1 to Active. +F.2.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use a custom mesh to accurately resolve the geometry. +1. Set the Mesh size equal to Custom. +2. Set the Triangle edge length equal to 4 cm. +3. Set the Wire segment length equal to cap_length. +4. Set the Wire segment radius equal to 0.01 cm. +F.2.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Altair Feko 2022.3 +F Bio Electromagnetics +F.2.5 Viewing the Results +View and post-process the results in POSTFEKO. +1. View the S-parameters on a Cartesian graph. +p.239 +Figure 112: S-parameters for the I and Q feed ports of the coil. +2. View the currents in the 3D view and hide the phantom. +Figure 113: Surface currents of the coil rung with the phantom hidden. +The B1+ and ratio (B1+/B1-) results are obtained from the MRI quantities automation script in +POSTFEKO. The script is provided in the same folder as the CADFEKO model. +3. Add the results from the script to the 3D view. +Figure 114: B1+ field distribution at Z=0. +Figure 115: Ratio of (B1+/B1-) +Time Domain +G Time Domain +A simple example demonstrating the time analysis of an incident plane wave on an obstacle. +This chapter covers the following: +G.1 Effect of Incident Plane Wave on an Obstacle +Using Time Analysis +Observe the effect of an obstacle on a plane wave. Obtain frequency domain results using a wideband +simulation using the method of moments (MoM). Perform post-processing of the frequency domain data +to obtain a time response. +Figure 116: 3D view of the obstacle and time domain results. +Note: A .pfs session file is included with the example. The time signals have been set up +and you can view the near field results in the time domain. +G.1.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define a variable. +• d = 1 (Length of the cuboid.) +2. Create a cuboid. +• Definition method: Base centre, width, depth, height +• Base centre (C): (0, 0, -d/2) +• Width (W): d +• Depth (D): d +• Height (H): d +3. Add a single incident plane wave with θ=75° and ϕ=45°. +4. Set the frequency span between 2.5 MHz to 300 MHz using a list of discrete points. +a) Import the list of discrete frequency points from the file frequency_list.txt. +G.1.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +1. Create a currents request (all currents). +2. Create a near field request. +• Start: (-2*d, -2*d, 0) +• End: (2*d, 2*d, 0) +• Number of field points: (31, 31, 1) +• Sample on edges: enabled +G.1.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the mesh size equal to Coarse. +G.1.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +G.1.5 Viewing the Results +View and post-process the results in POSTFEKO. +The currents and near fields were calculated within a predetermined frequency range. Any time signal +can be analysed provided its spectral content is within this range. +1. Create the input Gaussian pulse and triangular pulse using the following parameters: +Property +Gaussian pulse +Triangular pulse +Time axis unit +Total signal duration +ns +100 +ns +100 +Property +Amplitude +Pulse delay +Pulse width +Number of samples +Gaussian pulse +Triangular pulse +19 +400 +19 +400 +Tip: On the Time analysis tab, in the Time signal group, click the New time signal +icon. +Figure 117: The Gaussian and triangular input signals. +2. View the time response of the system when a Gaussian pulse or a triangular pulse is applied. +Figure 118: Near field time response for the Gaussian pulse after 19 ns. +Figure 119: Near field time response for the triangular pulse (right) after 19 ns. +Tip: Gain insight into the time domain behaviour of a system using animation. +3. View the near field magnitude plotted over time at position (-2, -2, 0) m. +Figure 120: E-field magnitude at position (-2, -2, 0) m. +Special Solution Methods +H Special Solution Methods +Simple examples demonstrating using continuous frequency range, using the MLFMM for large models, +using the LE-PO (large element physical optics) on subparts of the model and optimising the waveguide +pin feed location. +This chapter covers the following: +• H.1 Forked Dipole Antenna (Continuous Frequency Range) (p. 249) +• H.2 Using the MLFMM for Electrically Large Models (p. 253) +• H.3 Horn Feeding a Large Reflector (p. 256) +• H.4 Optimise Waveguide Pin Feed Location (p. 269) +H.1 Forked Dipole Antenna (Continuous Frequency +Range) +Calculate the input admittance for a simple forked dipole. +Figure 121: A 3D view of the forked dipole with a voltage source. +H.1.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables: +• fmin = 100e6 (The minimum frequency.) +• fmax = 300e6 (The maximum frequency.) +• wireRadius = 1e-3 (Radius of the wire.) +2. Define the following named points. +• point1: (-0.01, 0, 0.5) +• point2: (0, 0, 0.01) +• point3: (0.01, 0, 0.466) +• point4: (0, 0, -0.01) +3. Create a line with the start and end coordinates of point1 and point2. +4. Create a line with the start and end coordinates of point2 and point3. +5. Copy and mirror the two lines around the UV plane. +6. Create a line with the start and end coordinates of point2 and point4. Rename the label to feed. +7. Union all the lines. +8. Add a wire port to the middle of the line. +9. Add a voltage source to the port. (1 V, 0°, 50 Ω). +10. Set a continuous frequency range from fmin to fmax. +H.1.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +No solution requests are required. +Note: Input impedance results are always available for voltage sources. +H.1.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the Mesh size equal to Standard. +2. Set the Wire segment radius equal to wireRadius. +H.1.4 Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +H.1.5 Viewing the Results +View and post-process the results in POSTFEKO. +View the input admittance (real and imaginary) of the voltage source on a Cartesian graph. +Figure 122: The input admittance (real and imaginary) of the forked dipole. +Figure 123: The input admittance (real and imaginary) of the forked dipole at the resonance point. +Compare the results with the literature reference, Efficient wide–band evaluation of mobile +communications antennas using [Z] or [Y] matrix interpolation with the method of moments”, by K. L. +Virga and Y. Rahmat-Samii, in the IEEE Transactions on Antennas and Propagation, vol. 47, pp. 65–76, +January 1999. +H.2 Using the MLFMM for Electrically Large Models +Consider the resource saving advantage of using the MLFMM for electrically large models +The size of the trihedral (13.5λ2 surface area) is selected to allow the model to also be solved using the +standard MoM. +Figure 124: 3D view of the electrically large trihedral with an incident plane wave (source). +H.2.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables. +• lambda = 1 (The wavelength in free space.) +• freq = c0/lambda (The operating frequency.) +• s = 3*lambda (Side lengths of the trihedral.) +2. Create the trihedral. +a) Create the first polygon. +• Corner 1: (0, 0, 0) +• Corner 2: (s, 0, 0) +• Corner 3: (0, s, 0) +b) Create the second polygon. +• Corner 1: (0, 0, 0) +• Corner 2: (0, 0, s) +• Corner 3: (s, 0, 0) +c) Create the third polygon. +Altair Feko 2022.3 +H Special Solution Methods +• Corner 1: (0, 0, 0) +• Corner 2: (0, s, 0) +• Corner 3: (0, 0, s) +3. Union the plates. +4. Add a single incident plane wave with θ=60° and ϕ=45°. +5. Set the frequency to freq. +6. Solve the model with the MLFMM solver. +p.254 +Tip: Open the Solver settings dialog, click the MLFMM / ACA tab and then click +Solve model with the multilevel fast multipole method (MLFMM). +H.2.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a vertical far field request (-180°≤θ≤180°, with ϕ=45°). Sample the far field at θ=2° steps. +H.2.3 Viewing the Results +View and post-process the results in POSTFEKO. +1. View the runtime and memory using one of the following methods: +• in the *.out file +• in the model browser +Tip: In the model browser click Results tab and select Solution Information. +View the solution information in the details browser. +2. Compare the runtime and memory for the MLFMM and MoM. +Table 5: Memory and runtime requirements for the MLFMM and MoM models. +Solution method +Memory (MBytes) +Runtime (seconds) +MoM +MLFMM +336 +127 +35 +3. Compare the bistatic RCS of the trihedral for the MLFMM and MoM models. +Figure 125: Comparison of the bistatic RCS for a trihedral using MLFMM and MoM . +H.3 Horn Feeding a Large Reflector +Calculate the gain for a cylindrical horn feeding a parabolic reflector at 12.5 GHz. The reflector is +electrically large (diameter of 36 wavelengths) and well separated from the horn. Several techniques +available in Feko are considered to reduce the required resources for electrically large models. +Use the following techniques to reduce the required resources: +• For electrically large models, use the multilevel fast multipole method (MLFMM) instead of the +method of moments (MoM). The required memory is reduced considerably by using MLFMM. +• For subparts of the model, use large element physical optics (LE-PO) . +• Subdivide the problem and use an equivalent source. +◦ Near field source - A region can be replaced by equivalent electric and magnetic field sources +on the boundary of the region. +◦ Spherical modes source - A far field can also be used as an impressed source. +Figure 126: A 3D view of the cylindrical horn and parabolic reflector. +Tip: Each model uses its predecessor as a starting point. Create the models in their +presentation order. Save each model to a new location to keep them. +H.3.1 MoM Horn and LE-PO Reflector +Create the horn and the parabolic reflector. Solve the horn using MoM and the reflector using LE-PO. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Define the following variables. +• freq = 12.5e9 (The operating frequency.) +• lam = c0/freq (The wavelength in free space.) +• lam_w = 0.0293 (The guide wavelength.) +• h_a = 0.51*lam (The waveguide radius.) +• h_b0 = 0.65*lam (Flare base radius.) +• h_b = lam (Flare top radius.) +• h_l = 3.05*lam (Flare length.) +• ph_centre = -2.6821e-3 (Horn phase centre.) +• R = 18*lam (Reflector radius.) +• F = 25*lam (Reflector focal length.) +• w_l = 2*lam_w (The waveguide length.) +2. Create the horn. +a) Create a cylinder along the Z axis. +1. Definition method: Base centre, radius, height +2. Base centre: (0, 0, -w_l-h_l) +3. Radius (R): h_a +4. Height (H): w_l +5. Label: waveguide +b) Create a cone. +• Definition method: Base centre, base radius, top radius, height +• Base centre: (0, 0, -h_l) +• Base radius: h_b0 +• Height: h_l +• Top radius: h_b +• Label: flare +c) Union the two parts and simplify the resulting union. +d) Rename the union of the two parts to horn. +e) Delete the face at the front end of the horn to create an opening. +f) Rotate the horn by -90°. +• Axis direction: (0, 1, 0) +g) Create a waveguide port on the face at the back end of the waveguide section. +h) Add a waveguide source on the waveguide port. Use the default settings. +3. Create the parabolic reflector. +a) Create a paraboloid. +• Base centre: (0, 0, F) +• Radius (R): R +• Focal depth: -F +• Label: reflector +a) Rotate the paraboloid by -90°. +• Axis direction: (0, 1, 0) +b) Set the solver method for the reflector face to use LEPO - always illuminated method. +Tip: Open the Modify Face dialog and click the Solution tab. From the +Solve with special solution method, select Large element PO - always +illuminated method. +4. Decouple the MoM and LE-PO. +Tip: Open the Solver settings dialog, click the High frequency tab and then click +Decouple PO and MoM solutions. +Tip: The decouple setting will save computational resources. It is not recommended +where the coupling (interaction) between the PO and MoM objects is strong. +5. Set the frequency to freq. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a full 3D far field request (-180°≤θ≤180° and 0°≤ϕ≤180°). Sample the far field at θ=5° and +ϕ=5° steps. +a) Enable the option, Calculate continuous far field data. +Tip: Open the Request/Modify far fields dialog, click the Advanced tab and then +select the Calculate continuous far field data check box. +Tip: Spatially continuous far fields allow the far field to be re-sampled to any +resolution in POSTFEKO. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the Mesh size equal to Coarse. +Note: Reduce simulation time for this example by using the coarse mesh setting. The +standard mesh setting is recommended in general. +2. Set a local mesh size of lam/20 on the waveguide port face. +Tip: Open the Modify Face dialog, click the Meshing tab and then select the Local +mesh size check box. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +H.3.2 MLFMM Horn and PO Reflector +Solve the horn using MLFMM and the reflector using PO. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in MoM Horn and LE-PO Reflector and rename the file. +2. Set the solver method for the reflector face to use PO - always illuminated method. +Tip: Open the Modify Face dialog and click the Solution tab. From the Solve with +special solution method list, select Physical optics (PO) - always illuminated. +3. Solve the model with the MLFMM solver. +Tip: Open the Solver settings dialog, click the MLFMM / ACA tab and then click +Solve model with the multilevel fast multipole method (MLFMM). +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for MoM Horn and LE-PO Reflector. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for MoM Horn and LE-PO Reflector. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +H.3.3 MLFMM Horn and LE-PO Reflector +Solve the horn using MLFMM and the reflector using LE-PO. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in MLFMM Horn and PO Reflector and rename the file. +2. Change the solver method for the reflector face to LEPO. +Tip: Open the Modify Face dialog and click the Solution tab. From the Solve with +special solution method, select Large element PO - always illuminated method. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for MoM Horn and LE-PO Reflector. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for MoM Horn and LE-PO Reflector. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +H.3.4 Obtaining the Fields from the Horn Antenna +Calculate the fields of only the horn antenna. Export the fields to file for usage in an equivalent source. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Open the model from MoM Horn and LE-PO Reflector. +2. Save the model with a new name. +3. Delete the reflector. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +1. Modify the existing far field request to export spherical modes. +a) On the Advanced tab, select the check box Calculate spherical expansion mode +coefficients. +b) Select the check box Export spherical expansion coefficients to ASCII file. +2. Create a near field request and export the fields to file. +• Definition methods: Spherical +• Start: (1.3*w_l, 0, 0) +• End: (1.3*w_l, 180, 360) +• Increment: (0, 5, 5) +• Clear the Sample on edges check box. +• On the Advanced tab, select the Export fields to ASCII file check box. +Tip: Sampling on the edges would create duplicate request points at 0° and 360°. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for MoM Horn and LE-PO Reflector. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +H.3.5 Near Field Source and LE-PO Reflector +Solve the horn using an equivalent near field source and the reflector using LE-PO. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in MoM Horn and LE-PO Reflector and rename the file. +2. Remove the horn part. +3. Create a near field data definition. +• E-field file: Browse for the .efe file. +• H-field file: Browse for the .hfe file. +• Coordinate system: Spherical +• Radius (R): 1.3*w_l +• Number of points along theta: 36 +• Number of points along phi: 72 +• Workplane origin: (w_l, 0, 0) +4. Create a near field source that makes use of the near field data definition. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for MoM Horn and LE-PO Reflector. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for MoM Horn and LE-PO Reflector. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +H.3.6 Spherical Modes Source and LE-PO Reflector +Solve the horn using a spherical modes source and the reflector using LE-PO. +Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Use the model considered in MoM Horn and LE-PO Reflector and rename the file. +2. Remove the horn part. +3. Create the spherical modes field data definition. +a) Browse for the *.sph file. +4. Create a spherical modes source that uses the spherical modes data definition. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Use the same calculation requests as for MoM Horn and LE-PO Reflector. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Use the same mesh settings as for MoM Horn and LE-PO Reflector. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Altair Feko 2022.3 +H Special Solution Methods +H.3.7 Comparing the Results +p.266 +Compare the resource requirements and far field gain patterns for the models using different solver +techniques. +1. Compare the resource requirements for the different techniques. +Table 6: Comparison of resources using different techniques. Generating the equivalent source data required +negligible resources. +Model +MLFMM (reference) +MLFMM Horn + PO Reflector +MLFMM Horn + LE-PO Reflector +MoM Horn + LE-PO Reflector +Near field source + LE-PO Reflector +Spherical modes source + LE-PO Reflector +RAM [MB] +Total Time [s] +4210 +700 +259 +540 +32 +21 +753 +3663 +100 +161 +Note: +• Use LE-PO as the solution method for the reflector to reduce the memory +requirement and solution time by several orders of magnitude. +• Subdivide the model into equivalent source models to reduce the resource +requirements. +2. Compare the far field gain patterns for the models. +Figure 127: Gain of the reflector antenna calculated using different techniques over a 180 degree angle. +Figure 128: Gain of the reflector antenna calculated using different techniques - main lobe. +The difference in results is due to coupling between the horn and reflector that is only taken into +account for the MLFMM solution. Although there is no restriction on the size of LE-PO triangles, the +geometry must be accurately meshed. +For example, had a flat plate been used, only two triangles would have been required to obtain +the same results. +H.4 Optimise Waveguide Pin Feed Location +Analyse the effect of the pin offset on the reflection coefficient using an optimisation grid search and the +NGF solution settings. +A waveguide can be fed using a pin placed at a quarter of a waveguide wavelength from a terminated +waveguide end. For an arbitrary cross-sectioned waveguide, the waveguide wavelength is not always +known making it difficult to determine the pin feed position. +Figure 129: A 3D view of the waveguide fed with a pin feed and waveguide port. +H.4.1 Creating the Model +Create the model in CADFEKO. Define any ports and sources required for the model. Specify the +operating frequency or frequency range for the model. +1. Set the model unit to millimetres. +2. Define the following variables: +• freq = 10e9 (The operating frequency.) +• lambda = c0/freq*1e3 ( The wavelength in free space. Note the unit is in millimetres.) +• n = 1 (Feed pin position index.) +• pin_step_size = lambda/32 (Distance between the pin positions.) +• pin_length = 0.9*lambda/4 (Length of pin feed monopole.) +• pin_offset = pin_step_size*n (Pin offset from waveguide tip.) +• radius = 0.1 (Radius of pin wires.) +• waveguide_length = lambda*2 (Length of waveguide section.) +• wr90_height = 10.16 (Waveguide height for WR90 (X-Band, 8.2-12.4 GHz).) +• wr90_width = 22.86 (Waveguide width for WR90 (X-Band, 8.2-12.4 GHz).) +Note: The model unit is millimetres. The variable lambda is not the actual wavelength +but a parameter used in the geometry definition. +3. Create the waveguide. +a) Create a cuboid. +• Definition method: Base centre, width, depth, height +• Base centre: (0, 0, 0) +• Width: wr90_width +• Depth: waveguide_length +• Height: wr90_height +• Label: waveguide +4. Set the waveguide region to Free space. +5. +Imprint vertices on the mesh for the feed pin connections. +a) Create a line. +• Start point: (0, -waveguide_length/2, 0) +• End point: (0, -waveguide_length/2 + pin_step_size, 0) +• Label: imprinted_edge_1 +b) Copy and translate imprinted_edge_1. +• From: (0, 0, 0) +• To: (0, 2*pin_step_size, 0) +• Number of copies: 7 +6. Union all geometry. Rename the resulting part to waveguide_perforated. +7. Activate the NGF and set waveguide_perforated as a static part. +Note: The + icon in the model tree, next to waveguide_perforated, indicates it is +a static part and may not be edited. +8. Create the feed pin. +a) Create a line. +• Start point: (0, pin_offset, 0) +• End point: (0, pin_offset, pin_length) +• Workplane origin: (0, -waveguide_length/2, 0) +9. Add a wire port at the connection point between the feed pin and the waveguide floor. +10. Place a waveguide port at the opposite waveguide end. This will absorb the power injected by the +pin feed. +a) Rotate the reference direction with 90°. +11. Add a voltage source to the wire port. (1 V, 0°, 50 Ω). +12. Set the frequency to freq. +Note: A magnetic plane of symmetry exists about the X=0 plane, but no +computational performance benefit is obtained when used in conjunction with the NGF. +H.4.2 Defining Calculation Requests +Define the calculation requests in CADFEKO. +No solution requests are required. The input impedance and reflection coefficient are by default +available as output for voltage sources in the model. +H.4.3 Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +1. Set the Mesh size equal to Fine. +2. Set the Wire segment radius equal to radius. +H.4.4 Adding an Optimisation Search +Add an optimisation search. +1. Add an optimisation search. Use the Grid search method and Default number of points equal +to 15. +2. Specify the optimisation parameters. +a) Define the variable to be optimised. +Variable +Min value +Max value +Start value +Grid points +15 +Empty +15 +3. Define an Impedance goal to minimise the magnitude of the reflection coefficient for +VoltageSource1. +H.4.5 Running the Optimisation +Run OPTFEKO to optimise the model according to requirements. During optimisation, OPTFEKO will call +the Solver as required. +1. Run OPTFEKO. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun OPTFEKO (if applicable). +H.4.6 Viewing the Results +View and post-process the results in POSTFEKO. +For the first solver run, the full calculation needs to be performed. The static domain solution is stored +to file and then re-used in subsequent solver iterations. By storing the solution to the static domain (for +this example the waveguide), the Solver only needs to calculate the effect of the feed pin location in +subsequent iterations. +1. View the resource requirements for each iteration. +Table 7: Comparison of resource requirements for each iteration. +Iteration +Memory (MBytes) +Runtime (seconds) +10 +11 +12 +13 +14 +15 +153 +153 +153 +153 +153 +153 +153 +153 +153 +153 +153 +153 +153 +153 +153 +27 +Note: After the first iteration, the run time was significantly reduced. This effect of +reduced run time after the first iteration becomes more pronounced as the size of the +static domain increases relative to the dynamic domain. +2. View the reflection coefficient for each feed position on a Smith chart. +a) The port is optimally matched when the magnitude of the reflection coefficient is as small as +possible or the input impedance is equal to 50 Ω. This condition is roughly met at iteration 6, +see Figure 130. This corresponds to a feed position given by +(14) +Figure 130: Smith chart showing the reflection coefficient for each feed pin position. +Tip: Keep the temporary files. Then create the graph by plotting each model's +source data. +H.5 Characterised Surfaces for FSS +Use characterised surfaces with ray launching geometrical optics (RL-GO) for an efficient solution of a +frequency selective surface (FSS). +Characterised surfaces are defined with a .tr file that describes the transmission and reflection +properties of the surface as a function of both frequency and angle of incidence (θ , ϕ). The first part +of this example demonstrates how to create the .tr file for an FSS element. The second part of this +example demonstrates how a characterised surface can be defined, using the .tr file. +Note: Characterised surfaces are only supported with the RL-GO method. +H.5.1 Creating the FSS Model and Writing the .TR File +Generate a .tr file for an FSS element. +Note: The transmission / reflection request is only supported with periodic boundary +conditions or the planar Green's function. +Creating the Model +Set up the model to write the transmission / reflection coefficients .tr file to be used for the +characterised surface. +1. Use the model created in Periodic Boundary Conditions for FSS Characterisation and rename the +file. +2. Specify the symmetry about the X=0 and Y=0 planes as Geometric symmetry. +3. Set the frequency to 10 GHz. +4. Modify the plane wave source settings: +• Click Loop over multiple directions. +• Set the θ range from 0 to 180°. +• Set the ϕ range from 0 to 360°. +• Increment the incident angle, θ, in 6° steps. +• Increment the incident angle, ϕ, in 6° steps. +• Select the Calculate orthogonal polarisations check box. +Tip: Use a single theta cut for elements with small / no variation in ϕ. +Tip: For many θ and ϕ samples use the provided .tr file to save time. +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Modify the transmission / reflection coefficients request. +a) Select the Export transmission and reflection coefficients to file (*.tr) check box to export +the coefficients to file. +Modifying the Auto-Generated Mesh +Modify the model mesh in CADFEKO using the correct settings. A mesh is a discretised representation of +a geometry model or mesh model used for simulation in the Solver. +Set the Mesh size equal to Fine. +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Viewing the Results +View the results from the FSS element solution in POSTFEKO. +Plot the coefficients as a function of the plane wave theta and phi angles. +Tip: For (nearly) constant coefficients (such as in ϕ), use one θ cut to describe the surface. +Figure 131: Transmission / reflection coefficient versus plane wave theta. +Figure 132: Transmission / reflection coefficient versus plane wave phi. +Note that the FSS elements have relatively good transmission through all θ and ϕ (> 0.7) at 10 GHz. +The plots also show that sufficient resolution (6°) was used to capture the variations in θ and ϕ. +H.5.2 Creating the Characterised Surface +Use the .tr file and create a characterised surface for simulation with RL-GO. +Characterised Surface with RL-GO +Define a characterised surface that uses the .tr file. +Define a large rectangular plate where the characterised surface medium is set: +1. Create a new CADFEKO model. +2. Change the model unit to mm. +3. Define a new variable d=15.2 (this is the size of the FSS element used in Periodic Boundary +Conditions for FSS Characterisation). +4. Define a rectangular plate. +• Base centre: (0, 0, 0). +• Width = d*31. +• Length = d*31. +• The plate size is equivalent to 31x31 FSS elements. +5. Create a Characterised surface medium using the .tr file that was created in Creating the FSS +Model and Writing the .TR File. +6. Set the solver method for the rectangular plate to use RL-GO. +Tip: Open the Modify Face dialog and click the Solution tab. From the Solve with +special solution method list, select Ray launching - geometrical optics (RL-GO). +7. Apply the characterised surface to the rectangular plate. +a) Medium: CharacterisedSurface1 +b) U-vector: +1. Start point: (0, 0, 0) +2. End point: (1, 0, 0) +Tip: Open the Modify Face dialog and click the Solution tab. +Note: Defining the U-Vector determines the orientation of the characterised +surface elements on the face. In this example, the original orientation used for +the FSS simulation is unchanged so the U-Vector is defined as X directed. +8. Set the Solution frequency to 10 GHz. +9. Define a plane wave source that loops over multiple directions with θ from 0 to 180° with and +increment of 6°. +Altair Feko 2022.3 +H Special Solution Methods +Defining Calculation Requests +Define the calculation requests in CADFEKO. +Create a near field request. +a) Start: (0, 0, 0) +b) End: (0, 0, d*5) +c) Number of field points: (1, 1, 101) +p.279 +Running the Feko Solver +Run the Solver to compute the calculation requests. +1. Run the Solver. +2. +Investigate any warnings/errors found by the Solver (if applicable). +3. Address any errors and rerun the Solver (if applicable). +Viewing the Results +View and post-process the results from the characterised surface in POSTFEKO. +View the E-field above the characterised surface on a Cartesian graph. The results are compared +to those calculated with a full solution using MLFMM where the geometry of the FSS element was +duplicated to create the finite 31x31 element sheet. +Table 8: Computational requirements +31x31 FSS element sheet +Memory +Characterised surface - RL-GO +91 MB +Full solution - MLFMM +332 MB +Run time +9 sec +408 sec +Note the significant reduction in computational requirements over the MLFMM solution. +A practical example where the characterised surface is extremely useful is shown below: an FSS +nosecone radome is represented using this feature. Due to the size and complexity of the structure, it +becomes prohibitive to model and solve with a full wave solution. However it can be solved readily with +the characterised surface approach. +Figure 133: E-field above the characterised surface for 2 theta angles. +Figure 134: Full model of the 31x31 element FSS sheet solved with MLFMM. +Figure 135: E-feld distribution through an FSS radome calculated using a characterised surfaces. +User Interface Tools +I User Interface Tools +Simple examples demonstrating using Feko application automation, matching circuit generation with +Optenni Lab and optimising a bandpass filter with HyperStudy. +This chapter covers the following: +• +• +• +I.1 Introduction to Application Automation (p. 283) +I.2 Automatic Report Generation Using API (p. 326) +I.1 Introduction to Application Automation +Use application automation to perform operations with CADFEKO and POSTFEKO. Typical tasks include +repetitive tasks, tasks that require several steps, or calculations. +Note: The base language for the application automation is Lua. +• View the official Lua Reference Manual: http://www.lua.org/manual/5.1/ +• Programming introduction: http://www.lua.org/pil/ +• Community maintained Wiki: http://lua-users.org/wiki/ +I.1.1 Automation Terminology +Learn the terminology of automation to create an automation script. +Lua +API +handle +object +app +cf / pf / feko +project +Lightweight multi-paradigm programming language designed as +a scripting language. Both CADFEKO and POSTFEKO feature a +scripting interface based on the Lua language. +The Feko application programming interface (API) defines the +namespaces, objects, methods and functions used to access and +control the Feko applications. +A handle is a variable that refers to an object. Instead of referring +to the object itself, the handle is used to refer to the object. +An object is an entity within an object oriented programming +language with two main characteristics: a state and a behaviour. +The settings of the object are stored in its properties and its +abilities are accessed through methods. +The application is either CADFEKO or POSTFEKO. +Each application has a “namespace” that groups all objects +and properties for that particular application. The CADFEKO +namespace is cf and the POSTFEKO namespace is pf. This means +that all objects, static functions and nested namespaces will be +accessed using the application’s namespace. As an example, +cf.GetApplication() calls the GetApplication() static function +in the cf namespace. For functions that can be shared between +the applications, a common namespace feko is also defined. +The project is the specific CADFEKO model the user is working on, +for example, patch_antenna.cfx. +type +collection +enum +method +Note: project is specific to CADFEKO. +Each object has a type. Lua supports the following standard +types: number, boolean, string, table, function, userdata and nil. +Objects created in CADFEKO or POSTFEKO will usually have a +type property. +A collection is a special object that contains objects of which +there can be more than one. For example, there can be multiple +sources, far fields, geometry parts and so on. When referencing +an item in a collection, an index must always be specified, for +example farfield[1] or farfield[“FarField”]. +An enumerated list or enum is a set of options. In the graphical +user interface these options relate to grouped options in a +dropdown box or a radio button group. The user is unable to +modify the list of options and must select one of the options. +Examples of enums: +• For the Create dielectric medium dialog select either +the Frequency independent, Debye relaxation, Cole-Cole, +Havriliak-Negami, Djordjevic-Sarkar or the Frequency list +option for the Definition method. +• For the Create mesh dialog, select either the Fine, +Standard, Coarse or Custom option for the Mesh size. +A method is a function that acts on a particular object. Methods +are called using the “:” after the object to which the method +belongs. For example, Cuboid:ConvertToPrimitive() +returns the geometry in its primitive base form, whereas +farField:Duplicate() returns a duplicate far field +solution entity. Cuboid and farField are the objects and +ConvertToPrimitive and Duplicate are the methods. +Note: Use “.” instead of “:” after cf. +static function +A static function is a function that is not associated with an +object, as opposed to a method that works on a particular object. +Static functions are called using “.”. +Note: Use “.” instead of “:” after cf. +For example, cf.Cuboid.GetDefaultProperties() is a +static function that creates the properties table for a cuboid. +cf.GetApplication() is a static function that returns the +application object. +I.1.2 Navigate the API Documentation +Learn to navigate the API documentation to find the correct syntax for an automation script. +The application programming interface (API) documentation is contained in the Feko User Guide. The +integrated help is simple to navigate due to its Back and Forward functionality and the Index or +Search tab is useful to find a specific item. +For this example we will make use of the Index tab in the integrated help. For conciseness we will +make use of the terminology, search, when we refer to the Look for: box on the Index tab. +Hyperlinks are indicated by blue text. Clicking on a hyperlink will navigate to other sections in the +documentation. +The following example illustrates how to navigate the documentation and to use the correct syntax. The +example contains steps to create a wire-fed patch antenna on a planar multilayer substrate. +Note: +The model is included in the Feko installation in the following directory: +examples\ExampleGuide_models\Example-I01- +Introduction_to_Application_Automation +I.1.3 Example: Patch Antenna on a Planar Multilayer +Substrate +Learn to navigate the API documentation to create a patch antenna using an automation script. +The complete Lua script to create the model, is included in this example. +Creating a New Project +Define a new CADFEKO project. +myApplication = cf.Application.getInstance() +myProject = myApplication:NewProject() +1. Get a “handle” on the CADFEKO application. +myApplication = cf.Application.getInstance() +2. Start a new empty project and get a “handle” on the project. +myApplication:NewProject() +Altair Feko 2022.3 +I User Interface Tools +Defining a Point +p.287 +Define a point at (-0.25, -0.25, 0) that will be used as the base corner of a patch (rectangle). +myBaseCorner = cf.Point(-0.25, -0.25, 0) +1. Search for Point[5] in the Help[6]. +2. View the example and note that a point is defined as follows: +cf.Point(y, y, z) +3. Fill in the coordinates (-0.25, -0.25, 0): +cf.Point(-0.25, -0.25, 0) +4. Add a “handle” to the point: +myBaseCorner = cf.Point(-0.25, -0.25, 0) +5. Point (Object) +6. Feko Scripting and API Reference Guide or WebHelp. +Altair Feko 2022.3 +I User Interface Tools +Creating a Patch (Rectangle) +p.288 +Create a rectangle with base corner (myBaseCorner), width = 0.5, depth = 0.5 and label Patch. +myPatch = myProject.Contents.Geometry:AddRectangle(myBaseCorner, 0.5, 0.5) +myPatch.Label = "Patch" +Figure 136: A rectangle with base corner (-0.25, -0.25, 0), width = 0.5, depth = 0.5 and label Patch. +1. A rectangle is a geometry object and since there may be multiple geometry objects in the model, +it is part of the GeometryCollection. +2. Search for GeometryCollection in the Help[7]. +3. +In the Help, under GeometryCollection > Method List, search for applicable methods: +• AddRectangle (cornerpoint Point, width Expression, depth Expression) +• AddRectangle (properties table) +• AddRectangleAtCentre (centrepoint Point, width Expression, depth Expression) +To create a rectangle with a base corner, we will use the method: +AddRectangle(cornerpoint Point, width Expression, depth Expression) +4. Fill in the corner point (use the point, myBaseCorner), width and depth: +AddRectangle(myBaseCorner, 0.5, 0.5) +7. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +5. Determine the syntax to prepend to AddRectangle: +a) Since AddRectangle is a method, it is indicated by prepending a “:” (colon). +:AddRectangle(myBaseCorner, 0.5, 0.5) +b) In the Help, under GeometryCollection > Usage locations, note the following: +ModelContents object has collection Geometry[8] +c) Click ModelContents. +d) In the Help, under ModelContents > Usage locations, note the following: +Model object has property Contents[9] +Since we know that Model is the one of the top levels in the model tree, the result is then: +Contents.Geometry:AddRectangle(myBaseCorner, 0.5, 0.5) +e) Since the project is the highest level, we prepend our reference to the project: +myProject.Contents.Geometry:AddRectangle(myBaseCorner, 0.5, 0.5) +6. Add a “handle” to the rectangle: +myPatch = myProject.Contents.Geometry:AddRectangle(myBaseCorner, 0.5, 0.5) +7. Set the rectangle label to Patch: +myPatch.Label = "Patch" +Tip: View the Rectangle (object) in the Help for a short example. +8. The part that is prepended to the method, maps to the CADFEKO model tree structure. +9. The part that is prepended to the method, maps to the CADFEKO model tree structure. +Altair Feko 2022.3 +I User Interface Tools +Defining a Dielectric +p.290 +Define the first dielectric with + = 1.5 with label Substrate1. +myDiel1 = myProject.Definitions.Media.Dielectric:AddDielectric(1.5, 0, 1000) +myDiel1.Label = "Substrate1" +Figure 137: A dielectric with + = 1.5 and label Substrate. +1. A dielectric is an object and since there may be multiple objects in the model, it is part of the +DielectricCollection. +2. Search for DielectricCollection in the Help[10]. +3. +In DielectricCollection, under Method List, search for methods that are applicable to +dielectrics: +• AddDielectric (properties table) +• AddDielectric (relativepermittivity Expression, losstangent Expression, massdensity +Expression) +• AddDielectric () +To create the first dielectric, we will use the method: +AddDielectric(relativepermittivity Expression, losstangent Expression, + massdensity Expression) +4. Fill in the values for the dielectric +AddDielectric(1.5, 0, 1000) +5. Determine the syntax to prepend to AddDielectric: +a) Since AddDielectric is a method, it is indicated by prepending a “:” (colon). +:AddDielectric(1.5, 0, 1000) +10. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +b) In the Help, under DielectricCollection > Usage locations, note the following: +Media object has collection Dielectric[11] +Since we know that Media is the not one of the top levels in the model tree, click Media. +In the Help, under Media > Usage locations , note the following: +ModelDefinitions object has property Media. +c) Click ModelDefinitions. +d) In the Help, under ModelDefinitions > Usage locations, note the following: +Model object has property Definitions. +Since we know that Model is the one of the top levels in the model tree, the result is then: +Definitions.Media.Dielectric:AddDielectric(1.5, 0, 1000) +e) Since the project is the highest level, we prepend our reference to the project: +myProject.Definitions.Media.Dielectric:AddDielectric(1.5, 0, 1000) +6. Add a “handle” to the dielectric: +myDiel1 = myProject.Definitions.Media.Dielectric:AddDielectric(1.5, 0, 1000) +7. Set the dielectric label to Substrate1: +myDiel1.Label = "Substrate1" +Tip: View the Dielectric (object) in the Help for a short example. +11. The part that is prepended to the method, maps to the CADFEKO model tree structure. +Defining a Dielectric Using the Properties Method +Define the second dielectric with + = 2.5, = 1e-2 and with label Substrate2. +myProp = cf.Dielectric.GetDefaultProperties() +myDiel2 = myProject.Definitions.Media.Dielectric:AddDielectric(myProp) +myProp.MassDensity = "4" +myProp.Label = "Substrate2" +myProp.DielectricModelling.RelativePermittivity = "2.5" +myProp.DielectricModelling.ConductivityType + = cf.Enums.MediumDielectricConductivityTypeEnum.Conductivity +myProp.DielectricModelling.Conductivity = "1e-2" +myDiel2:SetProperties(myProp) +Figure 138: A dielectric with + = 2.5, + = 1e-2 and label Substrate2. +1. Create the second dielectric using the properties method: +AddDielectric (properties table) +2. Since we want to know the properties for a Dielectric, search for Dielectric (object) in the Help[12]. +3. +In the Help, under Dielectric > Static Function List, note the following: +GetDefaultProperties () +4. Use GetDefaultProperties() to obtain the default properties of a dielectric: +myProp = cf.Dielectric.GetDefaultProperties() +5. Specify the properties of the dielectric: +a) In the Help, under Dielectric > Property List, note the properties of interest: +• Label +• DielectricModelling +12. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +Set the Label property, for DielectricModelling we need to navigate deeper: +myProp.Label = "Substrate2" +b) In the Help, click on the link in Dielectric > Static Function List > (Read/Write +DielectricModelling) to navigate to the dielectric modelling properties. +c) In the Help, under DielectricModelling > Property List, note the properties of interest: +• RelativePermittivity +• Conductivity and ConductivityType +Set the RelativePermittivity property, for Conductivity we need to navigate deeper: +myProperties.DielectricModelling.RelativePermittivity = "2.5" +d) In the Help, click on the link in DielectricModelling > Property List > +ConductivityType > MediumDielectricConductivityTypeEnum. +e) Specify that conductivity will be used as well as the value for the conductivity: +myProp.DielectricModelling.ConductivityType + = cf.Enums.MediumDielectricConductivityTypeEnum.Conductivity +myProp.DielectricModelling.Conductivity = "1e-2" +6. Update myDielec1 with its new properties using SetProperties (): +myDielec2:SetProperties(myProp) +Creating a Planar Multilayer Substrate +Create a planar multilayer substrate using the properties method that contains two layers. Layer 1 is set +to substrate2 and Layer2 is set to substrate1. The second layer has a PEC ground plane. +myProp = myProject.Contents.SolutionSettings.GroundPlane:GetProperties() +myProp.DefinitionMethod + = cf.Enums.GroundPlaneDefinitionMethodEnum.MultilayerSubstrate +myProp.ZValue = "0.0" +myProp.Layers[1].Thickness = "0.351" +myProp.Layers[1].Medium = myDiel2 +myProp.Layers[2] = {} +myProp.Layers[2].Thickness = "0.2" +myProp.Layers[2].Medium = myDiel1 +myProp.Layers[1].GroundBottom = cf.Enums.GroundBottomTypeEnum.None +myProp.Layers[2].GroundBottom = cf.Enums.GroundBottomTypeEnum.PEC +myProject.Contents.SolutionSettings.GroundPlane:SetProperties(myProp) +Figure 139: Define a planar multilayer substrate with two layers. +1. Since we want to know the properties for a ground plane, search for GroundPlane (object) in the +Help[13]. +13. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +2. +In the Help, under GroundPlane > Method List, note the following: +GetProperties () +3. Use GetProperties() method to obtain the properties of a ground plane: +GroundPlane:GetProperties() +4. Determine the syntax to prepend to GroundPlane: +a) In the Help, under GroundPlane > Usage locations, note the following: +SolutionSettings object has property GroundPlane[14]. +b) Click SolutionSettings. +c) In the Help, under SolutionSettings > Usage locations, note the following: +ModelContents object has property SolutionSettings. +d) Click ModelContents. +e) In the Help, under ModelContents > Usage locations, note the following: +Model object has property Contents +Since we know that Model is the one of the top levels in the model tree, the result is then: +Contents.SolutionSettings.GroundPlane:GetProperties() +f) Since the project is the highest level, we prepend our reference to the project: +myProp = myProject.Contents.SolutionSettings.GroundPlane:GetProperties() +5. Set the ground plane type to planar multilayer substrate: +a) In the Help, click on the link in GroundPlane > Property List > DefinitionMethod > +(Read/Write GroundPlaneDefinitionMethodEnum). +b) In the Help, under GroundPlaneDefinitionMethodEnum, note the option: +MultilayerSubstrate +The result is then: +myProp.DefinitionMethod + = cf.Enums.GroundPlaneDefinitionMethodEnum.MultilayerSubstrate +6. Next we want to specify the two layers: +a) In the Help, under GroundPlane > Property List, note the properties of interest that still +need to be specified: +Layers +ZValue +14. The part that is prepended to the method, maps to the CADFEKO model tree structure. +b) For this example, layer 1 is located at Z = 0. +myProp.ZValue = "0.0" +7. To specify the layers, search for PlanarSubstrate (object) in the Help. +a) In the Help, under PlanarSubstrate > Property List, note the following properties of +interest: +GroundBottom +Medium +Thickness +b) The result is then: +myProp.Layers[1].Thickness = "0.351" +myProp.Layers[1].Medium = myDiel2 +myProp.Layers[2] = {} +myProp.Layers[2].Thickness = "0.2" +myProp.Layers[2].Medium = myDiel1 +c) To specify the PEC ground plane below the layers, under Property List > +GroundBottomTypeEnum. +d) The result is then: +myProp.Layers[1].GroundBottom = cf.Enums.GroundBottomTypeEnum.None +myProp.Layers[2].GroundBottom = cf.Enums.GroundBottomTypeEnum.PEC +8. Update myProp with its new properties using SetProperties (): +application.Project.Contents.SolutionSettings.GroundPlane:SetProperties(myProp) +Altair Feko 2022.3 +I User Interface Tools +Creating the Feed Line +Create a feed line with start point (0, 0, 0) , end point (0, 0, -0.551) and label Feedline. +myPoint1 = cf.Point(0, 0, 0) +myPoint2 = cf.Point(0, 0, -0.551) +myLine = myProject.Contents.Geometry:AddLine(myPoint1, myPoint2) +myLine.Label = "Feedline" +p.297 +Figure 140: A line with start point (0, 0, 0) and end point (0, 0, -0.551). +1. Define two points, myPoint1 and mypoint2 . +myPoint1 = cf.Point(0, 0, 0) +myPoint2 = cf.Point(0, 0, -0.551) +2. A line is a geometry object and since there may be multiple geometry objects in the model, it is +part of the GeometryCollection. +3. Search for GeometryCollection in the Help[15]. +4. +In the Help, under GeometryCollection > Method List, search for methods that are applicable +to lines: +• AddLine (properties table) +• AddLine (startpoint Point, endpoint Point) +15. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +To create a line, we will use the method: +AddLine(startpoint Point, endpoint Point) +5. Fill in the startpoint and endpoint (use the points, myPoint1 and myPoint2): +AddLine(myPoint1, myPoint2) +6. Determine the syntax to prepend to AddLine: +a) Since AddLine is a method, it is indicated by prepending a “:” (colon). +:AddLine(myPoint1, myPoint2) +b) In the Help, under GeometryCollection > Usage locations, note the following: +ModelContents object has collection Geometry.[16] +c) Click ModelContents. +d) In the Help, under ModelContents > Usage locations, note the following: +Model object has property Contents[17] +Since we know that Model is the one of the top levels in the model tree, the result is then: +Contents.Geometry:AddLine(myPoint1, myPoint2) +e) Since the project is the highest level, we prepend our reference to the project: +myProject.Contents.Geometry:AddLine(myPoint1, myPoint2) +7. Add a reference to the newly created line: +myLine = myProject.Contents.Geometry:AddLine(myPoint1, myPoint2) +8. Set the line label to Feedline: +myLine.Label = "Feedline" +Tip: View the Line (object) in the Help for a short example. +16. The part that is prepended to the method, maps to the CADFEKO model tree structure. +17. The part that is prepended to the method, maps to the CADFEKO model tree structure. +Altair Feko 2022.3 +I User Interface Tools +Unioning the Model +Union all geometry in the model (Feedline and Patch) and set its label to Union1. +myUnion = myProject.Contents.Geometry:Union() +myUnion.Label = "Union1" +p.299 +Figure 141: The model tree showing the union of Feedline and Patch with label Union1. +1. The union operation is a geometry object and since there may be multiple geometry objects in the +model, it is part of the GeometryCollection. +2. Search for GeometryCollection in the Help[18]. +3. +In the Help, under GeometryCollection > Method List, search for methods that are applicable +to the union operation: +• Union (geometrylist List of Geometry) +• Union () +To union all geometry in the model, we will use the method: +Union() +4. Determine the syntax to prepend to Union(): +a) Since Union is a method, it is indicated by prepending a “:” (colon). +:Union +b) In the Help, under GeometryCollection > Usage locations, note the following: +ModelContents object has collection Geometry.[19] +c) Click ModelContents. +d) In the Help, under ModelContents > Usage locations, note the following: +Model object has property Contents[20] +18. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +19. The part that is prepended to the method, maps to the CADFEKO model tree structure. +20. The part that is prepended to the method, maps to the CADFEKO model tree structure. +Since we know that Model is the one of the top levels in the model tree, the result is then: +Contents.Geometry:Union() +e) Since the project is the highest level, we prepend our reference to the project: +myProject.Contents.Geometry:Union() +5. Add a reference to the newly created union: +myUnion = myProject.Contents.Geometry:Union() +6. Set the union label to Union1: +myUnion.Label = "Union1" +Tip: View the Union (object) in the Help for a short example. +Creating the Wire Port +Define a wire port at the end of Feedline with label Port1. +myPort = myProject.Contents.Ports:AddWirePort(myUnion.Wires[1]) +myPort.Label = "Port1" +Figure 142: A wire port is placed at the end of Feedline with label Port1. +1. A port is a object and since there may be multiple objects in the model, it is part of the +PortCollection. +2. Search for PortCollection in the Help[21]. +3. +In the Help, under PortCollection > Method List, search for methods that are applicable to +geometry wire ports: +• AddWirePort (table table) +• AddWirePort (wire Edge) +To create a wire port, we will use the method: +AddWirePort(wire Edge) +4. Add the wire where wire port will be placed. +AddWirePort(myUnion.Wires[1]) +Note: Use indexing to access a face, wire, edge or region in the details tree. +5. Determine the syntax to prepend to AddWirePort: +a) Since AddWirePort is a method, it is indicated by prepending a “:” (colon). +:AddWirePort(myUnion.Wires[1]) +21. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +b) In the Help, under PortCollection > Usage locations, note the following: +ModelContents object has collection Ports.[22] +c) Click ModelContents. +d) In the Help, under ModelContents > Usage locations, note the following: +Model object has property Contents[23] +Since we know that Model is the one of the top levels in the model tree, the result is then: +Contents.Ports:AddWirePort(myUnion.Wires[1]) +e) Since the project is the highest level, we prepend our reference to the project: +myProject.Contents.Ports:AddWirePort(myUnion.Wires[1]) +6. Add a reference to the newly created wire port: +myPort = myProject.Contents.Ports:AddWirePort(myUnion.Wires[1]) +7. Set the wire port label to Port1: +myPort.Label = "Port1" +Tip: View the WirePort (object) in the Help for a short example. +22. The part that is prepended to the method, maps to the CADFEKO model tree structure. +23. The part that is prepended to the method, maps to the CADFEKO model tree structure. +Altair Feko 2022.3 +I User Interface Tools +Creating a Voltage Source +p.303 +Add a global voltage source to Port1 for the default configuration, StandardConfiguration1. +myVoltageSource = + myProject.Contents.SolutionConfigurations.GlobalSources:AddVoltageSource(myPort) +myVoltageSource.Label = "Source1" +Figure 143: A voltage source is added to Port1. +1. A voltage source is a object and since there may be multiple objects in the model, it is part of the +SourceCollection. +2. Search for SourceCollection in the Help[24]. +3. +In the Help, under SourceCollection > Method List, search for methods that are applicable to +voltage sources: +• AddVoltageSource (properties table) +• AddVoltageSource (portterminal Port) +To create a voltage source, we will use the method: +AddVoltageSource(portterminal Port) +4. Fill in the port terminal (use port, Port1): +AddVoltageSource(Port1) +5. Determine the syntax to prepend to AddVoltageSource: +a) Since AddVoltageSource is a method, it is indicated by prepending a “:” (colon). +:AddVoltageSource(myPort) +b) In the Help, under SoureCollection > Usage locations, note the following: +SolutionConfigurations collection has collection GlobalSources[25] +24. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +25. The part that is prepended to the method, maps to the CADFEKO model tree structure. +Since we know that Contents is the one of the top levels in the configuration tree, the result +is then: +Contents.SolutionConfigurations.GlobalSources:AddVoltageSource(myPort) +c) Since the project is the highest level, we prepend our reference to the project: +myProject.Contents.SolutionConfigurations.GlobalSources:AddVoltageSource(myPort) +6. Add a reference to the newly created voltage source: +myVoltageSource = + myProject.Contents.SolutionConfigurations.GlobalSources:AddVoltageSource(myPort) +7. Set the voltage source label to Source1: +myPatch.Label = "Source1" +Tip: View the VoltageSource (object) in the Help for a short example. +Altair Feko 2022.3 +I User Interface Tools +Setting the Frequency +Specify a single global frequency as 300 MHz. +p.305 +myProject.Contents.SolutionConfigurations.GlobalFrequency.Start = "300e6" +Figure 144: Specify a single global frequency as 300 MHz. +1. Search for Frequency (object) in the Help[26]. +2. +In the Help, under Frequency > Property List, search for properties that are applicable to +setting a single frequency: +• Start - The first frequency value (Hz). +3. Fill in the frequency value: +Start = "300e6" +4. Determine the syntax to prepend to Start: +a) Since Start is a property it is indicated by prepending a “.”: +.Start = "300e6" +Tip: For a single frequency solution, you only need to specify the start frequency. +b) In the Help, under Frequency > Usage locations, note the following: +SolutionConfiguration object has property GlobalFrequency. +Since Contents is the one of the top levels in the configuration tree, the result is: +Contents.SolutionConfigurations.GlobalFrequency.Start = "300e6" +c) Since the project is the highest level, we prepend our reference to the project: +myProject.Contents.SolutionConfigurations.GlobalFrequency.Start = "300e6" +26. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +Specifying the Wire Segment Radius +Specify the wire segment radius as 0.001 m. +myProject.Mesher.Settings.WireRadius = "0.001" +Figure 145: Specify a wire segment radius of 0.001 m +1. Since the Mesher object meshes the model, search for Mesher (object) in the Help[27]. +a) In the Help, under Mesher > Usage locations , note the following: +Model object has property Mesher. +b) In the Help, click on the link in Mesher > Property List > Settings > (Read only +MeshSettings) to navigate to the properties applicable to mesh creation. +2. MeshSettings (object): +a) In the Help, under MeshSettings > Property List, note the properties: +• WireRadius +3. Fill in the wire segment radius: +WireRadius = "0.001" +4. Determine the syntax to prepend to WireRadius: +a) Since Start is a property it is indicated by prepending a “.”: +.WireRadius = "0.001" +b) From 1.a and since we know that Model is the one of the top levels in the model tree, the +result is then: +Mesher.Settings.WireRadius = "0.001" +c) Since the project is the highest level, we prepend our reference to the project: +myProject.Mesher.Settings.WireRadius = "0.001" +27. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +Altair Feko 2022.3 +I User Interface Tools +Meshing the Model +Create a mesh. +myProject.Mesher:Mesh() +p.307 +Figure 146: Specify a wire segment radius of 0.001 m +1. Since the Mesher object meshes the model, search for Mesher (object) in the Help[28]. +a) In the Help, under Mesher > Usage locations, note the following: +Model object has property Mesher. +b) In the Help, under Mesher > Property List, note the method: +• Mesh() +2. Determine the syntax to prepend to Mesh: +a) Since Start is a property it is indicated by prepending a “.”: +:Mesh() +b) In the Help, under MeshSettings > Usage locations, note the following: +Mesher object has property Settings. +The result is then: +myProject.Mesher:Mesh() +28. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +Altair Feko 2022.3 +I User Interface Tools +Defining a Far Field Request +p.308 +Create a far field request (0°≤θ≤90°, with 0°≤ϕ≤360°). Sample the far field at θ=5° and ϕ=5° steps. +The far field request is added to the default configuration, StandardConfiguration1. +myFarField = myProject.Contents.SolutionConfigurations[1].FarFields:Add(0, 0, 90, 360, 5, 5) +myFarField.Label = "FarField1" +Figure 147: A far field request is added to the model. +1. A far field request is a object and since there may be multiple objects in the model, it is part of +the FarFieldCollection. +2. Search for FarFieldCollection in the Help[29]. +3. +In the Help, under FarFieldCollection > Method List, search for methods that are applicable to +adding a fra field request: +• Add (properties table) +• Add (starttheta Expression, startphi Expression, endtheta Expression, endphi Expression, +thetaincrement Expression, phiincrement Expression) +29. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +• Add3DPattern () +• AddHorizontalCutUVPlane () +• AddRequestInPlaneWaveIncidentDirection () +• AddSquareGrid () +• AddVerticalCutUNPlane () +• AddVerticalCutVNPlane () +To create a far field request, we will use the method: +Add(starttheta Expression, startphi Expression, endtheta Expression, endphi + Expression, thetaincrement Expression, phiincrement Expression) +4. Fill in the and values and increments: +Add(0, 0, 90, 360, 5, 5) +5. Determine the syntax to prepend to Add: +a) Since Add is a method, it is indicated by prepending a “:” (colon). +:Add(0, 0, 90, 360, 5, 5) +b) In the Help, under FarFieldCollection > Usage locations (collections), note that the +following objects contain the FarFieldCollection collection: +SolutionConfigurations(.FarFields)[30] +Since we know that Contents is one of the top levels in the configuration tree, the result is: +Contents.SolutionConfigurations.FarFields:Add(0, 0, 90, 360, 5, 5) +But we also know that a far field request is added per configuration, the result is then: +Contents.SolutionConfigurations[1].FarFields:Add(0, 0, 90, 360, 5, 5) +c) Since the project is the highest level, we prepend our reference to the project: +myProject.Contents.SolutionConfigurations[1].FarFields:Add(0, 0, 90, 360, 5, 5) +6. Add a reference to the newly created far field request: +myFarField = + myProject.Contents.SolutionConfigurations[1].FarFields:Add(0, 0, 90, 360, 5, 5) +7. Set the far field request label to Source1: +myFarField.Label = "FarField1" +Tip: View the FarField (object) in the Help for a short example. +30. The part that is prepended to the method, maps to the CADFEKO model tree structure. +Altair Feko 2022.3 +I User Interface Tools +Defining a Current Request +Create a currents request. The currents request is added for the default configuration, +StandardConfiguration1. +myCurrents = myProject.Contents.SolutionConfigurations[1].Currents:Add() +myCurrents.Label = "Currents" +p.310 +Figure 148: A current request is added to the model. +1. A currents request is a object and since there may be multiple objects in the model, it is part of +the CurrentsCollection. +2. Search for CurrentsCollection in the Help[31]. +3. +In the Help, under CurrentsCollection > Method List, search for methods that are applicable to +adding a currents request: +• Add (properties table) +• Add () +To create a currents request, we will use the method: +Add () +4. Determine the syntax to prepend to Add: +a) Since Add() is a method, it is indicated by prepending a “:” (colon). +:Add() +b) In the Help, under CurrentsCollection > Usage locations (collections), note that the +following objects contain the CurrentsCollection collection: +SolutionConfigurations(.Currents)[32] +31. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +32. The part that is prepended to the method, maps to the CADFEKO model tree structure. +Since we know that Contents is the one of the top levels in the configuration tree, the result +is then: +Contents.SolutionConfigurations.Currents:Add() +But we also know that a currents request is added per configuration, the result is then: +Contents.SolutionConfigurations[1].Currents:Add() +c) Since the project is the highest level, we prepend our reference to the project: +myProject.Contents.SolutionConfigurations[1].Currents:Add() +5. Add a reference to the newly created currents request: +myCurrents = myProject.Contents.SolutionConfigurations[1].Currents:Add() +6. Set the far field request label to Currents1: +myCurrents.Label = "Currents" +Tip: View the Currents (object) in the Help for a short example. +Altair Feko 2022.3 +I User Interface Tools +Saving the Project +Save the project to a .cfx file. +p.312 +myApplication:SaveAs("Example-I01-Introduction_to_Application_Automation.cfx") +1. Since all actions like loading a project, saving a project or exiting the application are done on the +application level, search for application (object) in the Help[33]. +2. +In the Help, under Application > Method List, search for methods that are applicable to saving +the project: +• Save () +• SaveAs (filename string) +To specify a file name and save the model, we will use the method: +SaveAs (filename string) +3. Fill in the file name: +SaveAs("Example-I01-Introduction_to_Application_Automation.cfx") +4. Determine the syntax to prepend to SaveAs(): +a) Since SaveAs is a method, it is indicated by prepending a “:” (colon). +:SaveAs("Example-I01-Introduction_to_Application_Automation.cfx") +b) Since SaveAs is a method on the Application object, prepend our reference to Application, +myApplication: +myApplication:SaveAs("Example-I01-Introduction_to_Application_Automation.cfx") +33. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +Enabling the Parallel Solver +Activate the parallel solver and specify the number of parallel processes as four. +myApplication.Launcher.Settings.FEKO.Parallel.NumberOfProcessesEnabled = true +myApplication.Launcher.Settings.FEKO.Parallel.ProcessCount = 4 +1. Since the Launcher object coordinates the launching of Feko and external processes, search for +Launcher (object) in the Help[34]. +a) In the Help, under Launcher > Usage locations (object properties), note that the +following objects have properties using the Launcher object: +Application(.Launcher) +b) In the Help, click on the link in Launcher > Property List > Settings > (Read/Write +ComponentLaunchOptions) to navigate to the component launch options properties. +2. ComponentLaunchOptions (object): +a) In the Help, under ComponentLaunchOptions > Usage locations (object properties), +note that the following objects have properties using the ComponentLaunchOptions object: +Launcher(.Settings) +b) In the Help, click on the link in ComponentLaunchOptions > Property List > FEKO > +(Read/Write FEKOLaunchOptions) to navigate to the Feko launch options. +3. FEKOLaunchOptions (Object): +a) In the Help, under FEKOLaunchOptions > Usage locations (object properties), note +that the following objects have properties using the FEKOLaunchOptions object: +Settings(.FEKO) +b) In the Help, click on the link in FekoLaunchOptions > Property List > Parallel > (Read/ +Write FEKOParallelExeccutionOptions) to navigate to the parallel execution options. +4. FEKOParallelExecutionOptions (object): +a) In the Help, under FEKOParallelExecutionOptions > Usage locations +(object properties), note that the following objects have properties using the +FEKOParallelExecutionOptions object: +FEKO(.Parallel) +b) In the Help, under FEKOParallelExecutionOptions > Property List, note the properties: +• NumberOfProcessesEnabled +• ProcessCount +The result is then: +myApplication.Launcher.Settings.FEKO.Parallel.NumberOfProcessesEnabled = true +myApplication.Launcher.Settings.FEKO.Parallel.ProcessCount = 4 +34. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +Altair Feko 2022.3 +I User Interface Tools +Running the Solver +Launch the Solver. +myApplication.Launcher:RunFEKO() +p.314 +1. Since the Launcher object coordinates the launching of Feko and external processes, search for +Launcher (object) in the Help[35]. +2. +In the Help, under Launcher > Method List, search for a method to launch the Solver: +• RunFEKO() +3. Determine the syntax to prepend to RunFEKO(): +a) Since RunFEKO() is a method, it is indicated by prepending a “:” (colon): +:RunFEKO() +b) In the Help, under Launcher > Usage locations (object properties), note that the +following objects have properties using the Launcher object: +Application(.Launcher) +The result is then: +myApplication.Launcher:RunFEKO +35. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +I.1.4 Example: Post-Processing the Results +Post-process the results of a patch antenna on a multilayer substrate. +Learn to navigate the API documentation to do post-processing with POSTFEKO. +Altair Feko 2022.3 +I User Interface Tools +Creating a New POSTFEKO Project +Define a new POSTFEKO project and open a .fek file. +p.316 +myApplication = pf.GetApplication() +myApplication:NewProject() +myApplication:OpenFile("Example-I01-Introduction_to_Application_Automation.fek") +1. Get a “handle” on the POSTFEKO application. +myApplication = pf.GetApplication() +2. Start a new empty project. +myApplication:NewProject() +3. Open the .fek file of the patch antenna already solved. +myApplication:OpenFile("Example-I01-Introduction_to_Application_Automation.fek") +Getting a “Handle” on the Far Field Result +Get a “handle” on the far field result in the far field collection. +myFarFieldResult = myApplication.Models[1].Configurations[1].FarFields[1] +1. A far field result is an object and since there may be multiple far field results in a project, it is part +of the FarFieldCollection. +2. Search for FarFieldCollection in the Help[36]. +3. +In FarFieldCollection, under Index List, note the following options to specify a specific far field +result in the collection: +• [number] +• [string] +To specify the far field data in the collection, we will use [number] since we only added a single far +field request (as a result there will only be one far field result. +4. +In the Help, under FarFieldCollection > Usage locations, note the following: +SolutionConfiguration object has collection FarFields. +The result is then: +FarFields[1] +5. Determine the syntax to prepend to FarFields[1]: +a) Since we know that far field requests are defined per configuration and there may be multiple +configurations in the project, it is part of the ConfigurationCollection. +b) In the Help, under ConfigurationCollection > Usage locations, note the following: +Model object has collection Configurations. +c) In ConfigurationCollection, under Index List, note the following options to specify a +specify a configuration in the collection: +• [number] +• [string] +To specify the configuration in the collection, we will use [number] since the model only +contains a single configuration. The result is then: +Configurations[1].FarFields[1] +6. Determine the syntax to prepend to Configurations[1]: +a) Since we know that there may be multiple models in a project a, it is part of the +ModelCollection. +36. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +b) In the Help, under ModelCollection > Usage locations, note the following: +Application object has collection Models. +c) In ModelCollection, under Index List, note the following options to specify a specific model +in the collection: +• [number] +• [string] +To specify the model in the project, we will use [number] since the project only contains a +single model. The result is then: +d) Since we already have a “handle” on the application, the result is: +myApplication.Models[1].Configurations[1].FarFields[1] +7. Add a reference to the far field result: +myFarFieldResult = myApplication.Models[1].Configurations[1].FarFields[1] +Adding a Far Field Result Trace to A Cartesian Graph +Create a Cartesian graph and add a far field result trace, change the independent and fixed axes, +quantities and format the graph. +Adding a Cartesian Graph +Add a Cartesian graph to the project. +myGraph = myApplication.CartesianGraphs:Add() +1. A Cartesian graph is an object and since there may be multiple Cartesian graphs in the project, it +is part of the CartesianGraphCollection. +2. Search for CartesianGraphCollection in the Help[37]. +3. +In CartesianGraphCollection, under Method List, search for an applicable method: +• Add() +4. Determine the syntax to prepend to Add(): +a) Since Add() is a method, it is indicated by prepending a “:” (colon). +:Add() +b) In the Help, under CartesianGraphCollection > Usage locations, note the following: +Application object has collection CartesianGraphs. +The result is then: +CartesianGraphs:Add() +c) Since we already have a “handle” on the application, the result is then: +myApplication.CartesianGraphs:Add() +5. Add a reference to the newly created graph: +myGraph = myApplication.CartesianGraphs:Add() +37. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +Adding a Result Trace to a Cartesian Graph +Add a trace (for this example, a far field result) to a Cartesian graph. +myFarFieldTrace = myGraph.Traces:Add(myFarFieldResult) +Figure 149: The traces panel in the result palette. +1. A trace is an object and since there may be multiple traces in the project, it is part of the +ResultTraceCollection. +2. Search for ResultTraceCollection in the Help[38]. +3. +In ResultTraceCollection, under Method List, search for an applicable method: +• Add(result) +Since we already have a “handle” on the far field result, the result is: +Add(myFarFieldResult) +4. Determine the syntax to prepend to Add(myFarFieldResult): +a) Since Add(myFarFieldResult) is a method, it is indicated by prepending a “:” (colon). +:Add(myFarFieldResult) +b) In the Help, under ResultTraceCollection > Usage locations, note the following: +CartesianGraph object has collection Traces. +The result is then: +Traces:Add(myFarFieldResult) +c) Since we already have a “handle” on the Cartesian graph, the result is: +myGraph.Traces:Add(myFarFieldResult) +5. Add a reference to the trace: +myFarFieldTrace = myGraph.Traces:Add(myFarFieldResult) +38. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +Changing the Axes of the Trace (Independent and Fixed) +Set the independent axis of the far field trace to Phi and the fixed axis to Theta = 30°. +myFarFieldTrace.IndependentAxis = "Phi" +myFarFieldTrace:SetFixedAxisValue("Theta",30, "deg") +Figure 150: The Slice panel in the result palette. +1. Search for the FarFieldTrace object in the Help[39]. +2. +In the Help under FarFieldTrace > Property List, search for an applicable property to specify +the independent axis: +• IndependentAxis +The result is then: +IndependentAxis = "Phi" +3. Determine the syntax to prepend to IndependentAxis: +a) Since IndependentAxis is a property, it is indicated by prepending a “.”: +The result is then: +.IndependentAxis = "Phi" +b) Since we already have a handle on the trace, the result is: +myFarFieldTrace.IndependentAxis = "Phi" +4. +In the Help under FarFieldTrace > Method list, search for an applicable method to specify the +fixed axis: +• SetFixedAxisValue (axis string, numvalue number, unit string) +• SetFixedAxisValue (axis string, strvalue string) +To specify the fixed axis, we will use the method: +SetFixedAxisValue (axis string, numvalue number, unit string) +The result is then: +SetFixedAxisValue("Theta", 30, "deg") +5. Determine the syntax to prepend to IndependentAxis: +39. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +a) Since SetFixedAxisValue is a method, it is indicated by prepending a “:” (colon): +The result is then: +:SetFixedAxisValue("Theta", 30, "deg") +b) Since we already have a handle on the trace, the result is: +myFarFieldTrace:SetFixedAxisValue("Theta", 30, "deg") +Modifying the Quantities of a Far Field Result Trace +Change the far field trace axis to dB. +myFarFieldTrace.Quantity.ValuesScaledToDB = true +Figure 151: The quantity panel in the result palette. +1. Search for the FarFieldQuantity object in the Help[40]. +2. +In the Help under FarFieldQuantity > Property List, search for a property applicable to +changing the trace values to dB: +• ValuesScaledToDB +3. +In the Help, under FarFieldQuantity > Usage locations, note the following: +FarFieldTrace object has property Quantity. +The result is then: +Quantity.ValuesScaledToDB = true +4. Since we already has a “handle” on the far field trace, the result is: +myFarFieldTrace.Quantity.ValuesScaledToDB = true +40. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +Altair Feko 2022.3 +I User Interface Tools +Formatting the Graph +p.324 +Change the font size for both the vertical axis and horizontal axis to 12. +myGraph.HorizontalAxis.Title.Font.Size = 12 +myGraph.VerticalAxis.Title.Font.Size = 12 +1. Search for the CartesianGraph object in the Help[41]. +2. +In the Help under CartesianGraph > Property List, search for properties applicable to graph +axes: +• HorizontalAxis +• VerticalAxis +a) In the Help under CartesianGraph > Property List, click on the link (Read only +HorizontalAxis) to navigate to the HorizontalAxis object. +3. +In the Help under HorizontalGraphAxis > Property List, search for a property applicable to the +axis title: +• Title +a) In the Help under HorizontalGraphAxis > Property List, click on the link (Read only +GraphAxisTitle) to navigate to the HorizontalAxis object. +4. +In the Help under GraphAxisTitle > Property List, search for a property applicable to font: +• Font +a) In the Help under GraphAxisTitle > Property List, click on the link (Read only +FontFormat) to navigate to the FontFormat object. +5. +In the Help under FontFormat > Property List, search for a property applicable to the axis title: +• Size +a) In the Help under HorizontalGraphAxis > Property List, click on the link (Read only +GraphAxisTitle) to navigate to the HorizontalAxis object. +The result is then: +HorizontalAxis.Title.Font.Size +6. Since we already have a handle on the Cartesian graph, the result is then: +myGraph.HorizontalAxis.Title.Font.Size +7. Specify the font size as 12. +myGraph.HorizontalAxis.Title.Font.Size = 12 +8. Similar to Step 7, the font size can be specified for the vertical axis: +myGraph.VerticalAxis.Title.Font.Size = 12 +41. The API is available in the Feko Scripting and API Reference Guide (PDF) or Feko WebHelp. +Altair Feko 2022.3 +I User Interface Tools +Script +View the completed POSTFEKO automation script. +The completed script. +p.325 +--[[PATCH ANTENNA ON PLANAR MULTILAYER SUBSTRATE +==================================================================== +This script post-process the calculated results of the patch antenna +placed on a planar multilayer substrate. +]]-- +app = pf.GetApplication() +app:NewProject() +app:OpenFile("patch_antenna_scripted_model.fek") +-- Add a Cartesian graph +my_graph = app.CartesianGraphs:Add() +-- Add a far field result to a Cartesian graph +my_farfield_trace = my_graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) +-- Scale the quantity to dB +my_farfield_trace.Quantity.ValuesScaledToDB = true +-- Set the independent axis to Phi +my_farfield_trace.IndependentAxis = "phi" +-- Set the fixed axis to Theta = 30 deg +my_farfield_trace:SetFixedAxisValue("theta",30, "deg") +-- Add the surface currents to the 3D view +this_3Dview = app.Views[1] +my_3Dview_currents_plot = + this_3Dview.Plots:Add(app.Models[1].Configurations[1].SurfaceCurrents[1]) +-- Scale the quantity to dB +my_3Dview_currents_plot.Quantity.ValuesScaledToDB = true +-- Set the font size of the title +my_graph.VerticalAxis.Title.Font.Size = 14 +my_graph.HorizontalAxis.Title.Font.Size = 14 +-- Set the font size of the labels +my_graph.HorizontalAxis.Labels.Font.Size = 14 +my_graph.VerticalAxis.Labels.Font.Size = 14 +I.2 Automatic Report Generation Using API +Increase productivity when dealing with predictable and repeatable POSTFEKO sessions (for example, +exporting a report) using application automation. Use an automation script to configure a session and +export a report that highlights the antenna properties of the model. +Note: The script can be used on various models with repeatable results. +Figure 152: Results of the automatic report generation for two different antenna types. +I.2.1 The Models +Two models are included with the example to provide content to export a report. +The following assumptions are made for both models: +• The first configuration contains 3D far field data. +• The far field can be wrapped in the θ direction. +• There is a ϕ angle calculated at ϕ=0° and at ϕ=90°. This also implies that the main direction of +radiation is in the positive Z axis. +Note: Apart from these assumptions, any antenna geometry can be used as an input. The +script can be adapted to iterate over multiple models or to display different properties of +interest. +Altair Feko 2022.3 +I User Interface Tools +I.2.2 Script +p.327 +View the script used to configure a session and export a report that highlights the antenna properties of +the model. +--[[ +AUTOMATIC QUICK REPORT GENERATION FOR ANTENNA PATTERN ANALYSIS +============================================================== +This script loads the specified model. It then creates various +views and graphs that display the far field pattern. These +views are then exported to a PDF report +]]-- +modelName = {} +modelName[1] = "Horn" +modelName[2] = "Patch" +-- Get user input through Forms +form = pf.Form.New("Select model") +comboBox = pf.FormComboBox.New("Model name", modelName) +form:Add(comboBox) +form:Run() +index = comboBox.Index +app = pf.GetApplication() +app:NewProject() +app:OpenFile(modelName[index]..".fek") +selectedModel = app.Models[modelName[index]] +selectedConfig1 = selectedModel.Configurations[1] +ffData = selectedConfig1.FarFields[1] -- This is a handle on the far field data + itself +view3D = app.Views[1] +ffPlot = view3D.Plots:Add(ffData) +ffPlot.Label = "ff3D" +ffPlot.Quantity.ValuesScaledToDB = true +view3D_top = view3D:Duplicate() +view3D_top:SetViewDirection(pf.Enums.ViewDirectionEnum.Top) +view3D_right = view3D:Duplicate() +view3D_right:SetViewDirection(pf.Enums.ViewDirectionEnum.Right) +view3D_front = view3D:Duplicate() +view3D_front:SetViewDirection(pf.Enums.ViewDirectionEnum.Front) +polarGraph = app.PolarGraphs:Add() +ffTracePhi_00 = polarGraph.Traces:Add(ffData) +ffTracePhi_00.IndependentAxis = "Theta (wrapped)" +ffTracePhi_00.Quantity.ValuesScaledToDB = true +ffTracePhi_90 = polarGraph.Traces:Add(ffData) +ffTracePhi_90.IndependentAxis = "Theta (wrapped)" +ffTracePhi_90.Quantity.ValuesScaledToDB = true +ffTracePhi_90:SetFixedAxisValue(ffTracePhi_90.FixedAxes[2],90,"deg") +polarGraph:ZoomToExtents() +polarGraph.Title.Text = "Gain" +polarGraph.Legend.Position = pf.Enums.GraphLegendPositionEnum.OverlayTopRight +polarGraph.BackColour = pf.Enums.ColourEnum.LightGrey +polarGraph:Restore() +quickReport = app:CreateQuickReport(modelName[index].."AntennaQuickReport", +pf.Enums.ReportDocumentTypeEnum.PDF) +quickReport.DocumentHeading = modelName[index]..[[ Antenna: +Automated Quick Report]] +quickReport:SetPageTitle(view3D.WindowTitle, "Isometric View") +quickReport:SetPageTitle(view3D_top.WindowTitle, "Top View") +quickReport:SetPageTitle(view3D_right.WindowTitle, "Right View") +quickReport:SetPageTitle(view3D_front.WindowTitle, "Front View") +quickReport:SetPageTitle(polarGraph.WindowTitle, "Theta Cuts") +quickReport:Generate() +I.2.3 Exercise 1 +Modify the provided script to complete exercise 1. +• Change the rendering of the mesh to be 60% opaque. +• Automatically generate reports for all of the models in the modelName list. +• Save the sessions under unique names. +I.2.4 Exercise 2 +Write a new script using the documentation to complete exercise 2. +1. Reproduce the following polar graph. +2. Export the graph to a .pdf file. +3. Save the session. +I.3 Using Altair HyperStudy with Feko to Optimise a +Bandpass Filter +Design a bandpass coupled line filter with Altair HyperStudy as optimisation engine and Feko as the +computational solver. +The design aims to obtain the best spacings for S1 - S3 in the depiction of the geometry below. +The spacings are optimised to maximize the coupling between the input and output ports within the +operating frequency range. +Figure 153: Top view of the bandpass filter. +Note: The parametric model is provided for convenience. For the sake of simplicity, the +cutoff frequencies and out-of-band performance will not be considered for the design. +I.3.1 HyperStudy Model Modification and Interpretation +Approaches +Learn the four approaches in HyperStudy to modify a model and interpret the results. +The design of experiments (DOE) approach +The DOE approach can be defined as a test or a series of tests in which purposeful changes are made to +the input variables of a process or system so that the reasons for changes in the output response can +be identified and observed. Responses can be extracted, but will not affect how the model permutations +are generated. +A fit approach +The fit approach approximates the response of a model by creating a mathematical equivalent of a +model. This approach uses previous approaches as inputs that are used to predict how a model would +behave for a change in design variables. This approach is recommended where computational resources +are scarce. +Altair Feko 2022.3 +I User Interface Tools +The optimisation approach +p.330 +Optimisation approaches are used to generate a model that behaves in the desired manner. The +responses that are extracted from simulations are used to determine what the next model permutation +should be. +The stochastic approach +Stochastic approaches are used to analyse the effect of tolerances in the design variables (for example, +from material properties, manufacturing tolerances). These approaches can help identify the probability +of responses adhering to defined specification. +I.3.2 Workflow +Learn the HyperStudy workflow. Learn study setup and configuration phases. +A typical workflow for HyperStudy is as follows: +1. Configure a study setup. +This includes defining which models need to be included in a study, which solvers need to be used, +which design variables may be altered and which responses to analyse. +2. Run the study by using any of the four approaches, “Design of Experiments”, “Fit”, “Stochastic” or +“Optimisation.” +Feko is a registered solver for HyperStudy. When a solver is registered the majority of the +workflow is integrated into Hyperstudy. The following phases form part of the configuration +process. +Define models +With this phase, the solver input file is provided. HyperStudy +will create this file for each run from the initial template file, +using the current value of the design variables. Once the +model has been added, the Import Variables button will +analyse the model and identify design variables that may +be modified. These variables can be used in subsequent +approaches to generate different model permutations. +Define design variables +A table of variables have been imported in the model definition +phase. These variables may now be edited, deactivated and +the value ranges can be set. +Evaluate +This phase is responsible to write files, execute the solver +and extract values from the results. +• Write: During the write phase, HyperStudy will create +subdirectories with a copy of the model and all of the files +that the model depends on to be executed. The model +variables will be updated before executing the solver. +• Execute: During the execution phase, the solver will +be run and output data will be generated. Note that this +includes any post-processing of the raw simulation data +(e.g. by running a script on output data). +• Extract: The extraction phase is responsible for +identifying output response values and pulling them back +into HyperStudy. +Note: ASCII files can be processed during the extraction phase. +Figure 154: HyperStudy and Feko integration workflow. +I.3.3 Optimising the Bandpass Filter with HyperStudy +Using a POSTFEKO Session +Configure the bandpassfilter.pfs file with the S11 data to minimise the reflection coefficient in +HyperStudy. +1. Open CADFEKO. +2. Click Application Macro under the Scripting group. +3. +In the drop-down list, select Macro Library and run the EG I3: Bandpass Filter script. +Figure 155: The Application Macro Collection dialog. +4. Save the model with the name bandpassfilter.cfx and execute the solver. +5. Launch POSTFEKO from inside CADFEKO or open bandpassfilter.fek in POSTFEKO. +6. Create a Cartesian graph and add the S11 trace from the SParamOpt request. +7. +[Optional] From the Measure tab add a Global minimum annotation to the graph to extract this +value to a data source in HyperStudy. +Note: Other annotations are also supported and will be extracted from a Cartesian or +Polar graph. +Figure 156: The reflection coefficient (S11) of the bandpass filter before optimisation from 3.960 GHz to +4 GHz. +8. Save the bandpassfilter.pfs file in the same location as the bandpassfilter.cfx. +9. On the Home tab in the in the Scripting group, click Application macro. +The scripts loaded in the Macro library is displayed. +Figure 157: Example of the scripts available Application macro library. +10. Click Utility and select Optimise Model in HyperStudy. +The following Create HyperStudy Session dialog is shown. +Figure 158: The Create HyperStudy Session dialog. +11. In the Study label field, enter a value for the name of the study. +12. In the Study folder field, specify a value for the directory of the HyperStudy session. +13. In the Installation directory field, specify the directory where HyperStudy is installed. +Note: Use the following structure when pointing to the HyperStudy installation +directory: /hwdesktop/hst +14. [Optional] Set the FEKO_HST_INSTALLATION_DIR environment variable to use a specific +version of HyperStudy. +15. [Optional]Select Create HyperStudy preference file to create a preference file with the correct +solver path for the current installation. +16. [Optional] Select Launch HyperStudy to launch HyperStudy after creating the HyperStudy +session. +17. Click OK to start to create a HyperStudy session. +The following Create HyperStudy Session dialog is shown. +The extraction script bandpassfilter.cfx_extract.lua is created in the same directory as the +bandpassfilter.pfs. +Note: The trace on the Cartesian graph is extracted to the HyperStudy +output file automatically. No additional scripting is required in the +bandpassfilter.cfx_extract.lua file. +18. Click OK to launch HyperStudy. +19. Under the File menu, select Use Preferences File and set the preference file in the study folder. +Figure 159: An example of how to select a custom preference file. +20. Under Define models, verify the Solver Execution Script field is set to use the correct solver +version. +Note: +• The script is accessible under Edit > Register Solver Script, which offers the +possibility to register another solver or version. +• The argument -np can be typed in Solver Input Arguments to specify the +number of cores to use. +• If a legacy CADFEKO model is optimised the solver path should point to +%FEKO_HOME%/bin/legacy/feko/bin/runfeko.bat +21. Under Define Input Variables, select which variables to include in the study. Only S1 – S3 +should be activated and the default ranges used. +An example of the selected variables is displayed. +Figure 160: Example of the variable selection +22. Click Next. +23. Click Run Definition. +Figure 161: Example selecting the Run Definition button. +During the Write phase, the bandpassfilter.cfx_extract.lua file was copied to the run +directory and executed after the Feko solver was run in the Extract phase. This generated an +output file that HyperStudy can process easily. +Note: The script bandpassfilter.cfx_extract.lua is different if a .pfs file was +present before importing the variables and will automatically extract the visible traces +on a Cartesian graph and polar graph. +See Figure 162 for the completed definition run for the Write, Execute and Extract phases for +the initial test run done by HyperStudy. +Figure 162: Example of the completed definition run. +24. Click Next. +25. Select Add Output Response. +An output response is added with the Expression field highlighted. +26. Select the Expression field. +The Expression Builder:Response1(r1) dialog is shown. +Note: The Data Sources m1_ds_1 and m1_ds2 is added from the POSTFEKO graph. +27. In the Expression field, enter max(m1_ds_1) and click OK. +28. Under Goals click + to add an optimisation goal. +The following dialog is displayed. +Figure 163: Example adding an optimisation goal. +29. Set the goal Type to Minimize and click OK. +30. Click Evaluate to extract the value from the output file. +Figure 164: Example selecting the Evaluate button. +HyperStudy is now configured to understand which model to use, which variables are available for +modification and how to process the output. +31. Right-click on the defined study in the Explorer tab and click Add. +Figure 165: The Add dialog and selecting an optimisation approach. +32. Under Select Type, select Optimization. +33. In the Definition from: drop-down list, select Setup and click OK +The optimisation approach is created in the Explorer tab +Figure 166: Example of the Optimisation 1 approach created. +34. Click Optimization 1 > Specifications, and select the Adaptive Response Surface Method as +the optimiser. +Figure 167: Selecting the Adaptive Response Surface Method. +35. Click Apply and click Next. +Figure 168: Example selecting the Apply button. +36. Click Evaluate Tasks. +Figure 169: Example selecting the Evaluate Tasks button. +Each of the input variables is altered randomly, and its effect on the response analysed. +Figure 170: Typical progress data for an ARSM optimisation. +37. Click Iteration History tab and look for the row highlighted in green. +The optimum values are as follows: +• S1 = 0.4500000 +• S2 = 1.9254786 +• S3 = 2.2000000 +I.3.4 Feko Modelling and Performance +Generate a model with the optimum values in Feko and solve. +The optimisation relied on five samples within the frequency range of interest, namely 3.96 - 4.00 GHz. +To get a better sense of the frequency response for the optimum model, it is run in Feko. +1. Make a copy of the original CADFEKO model. +2. Update the following variables. +• S1 = 0.45 +• S2 = 1.9254786 +• S3 = 2.20 +3. +Include the S-parameter configuration labelled SParamBand that is defined over the frequency +range. +4. Mesh the model and run the Solver. +The results show a reflection coefficient of less than -10 dB over the design frequency range. +Figure 171: S-parameters for the bandpass filter between 3.9 – 4.1 GHz. +Index +Special Characters +.tr file 274 +ADAPTFEKO 249 +adaptive sampling 249 +admittance 249 +antenna +dielectric resonator 88 +antenna array 121 +antenna placement 127 +aperture 68 +aperture source 77, 131 +API +terminology 283 +app 283 +application +antenna analysis 16, 19, 25, 65, 68, 77, 88, 97, 101, 106, 121, 216 +antenna coupling 131, 141 +microstrip 193 +radhaz 184 +time analysis 243 +waveguide 204 +application automation 283, 315 +array 49 +bistatic 148, 151 +cable analysis 177 +cable modelling 177 +CADFEKO 283, 315, 329 +cf 283 +CFIE 127 +characterised surface 274 +coaxial 88 +collection 283 +continuous frequency 249 +coupling 127, 177, 204 +cross 162 +cuboid 19 +current 181 +currents 36 +decouple 256 +DGFM 121 +dielectric 19, 151 +dielectric losses 233 +dielectric resonator antenna 88, 88 +dielectric substrate 54 +dipole 16, 19, 25, 49, 249 +DRA antenna 88 +edge feed 54 +edge port 106 +electrically large 127 +electromagnetic compatibility 177 +ellipse 36 +EMC 170, 177, 181 +enum 283 +equivalent source 256 +excitation, See source +exposure analysis 233 +far field 16, 19, 25, 40, 49, 77, 88, 106, 113, 121, 184, 193, 256 +far field source 131, 141 +FDTD 54 +feed, See source +feko 283 +FEM 170 +FEM modal +port 204 +FEM modal port 77, 88 +FEM/MoM hybrid 233 +filter 329 +finite array 121 +finite conductivity 170 +finite difference time domain 25, 54 +finite element method 77, 88, 162, 193, 204 +finite ground 36 +frequency selective surface 159, 162 +FSS 159, 162, 274 +gain 16, 36 +Gaussian pulse 243 +glass 101 +Green's function 193 +grid search 269 +half-wavelength dipole 16, 19, 25 +handle 283 +higher order basis functions 25, 155 +HOBF 155 +horn 256 +horn antenna 77 +HyperStudy 329 +ideal receiving antenna 131, 141 +infinite 54, 65, 68, 193 +infinite cylinder 155 +infinite planar Green's function 40 +INIRC 184 +input impedance 16 +large element physical optics 25 +large model 253 +lens 97 +line 16, 36 +lossy metal 19 +Lua 283 +magnetic field 181 +method 283 +method of moments 16, 19, 25, 25, 65, 68, 77, 88, 101, 106, 121, 141, 155, 184, 193, 204, 216, 243 +microstrip 54, 216, 329 +microstrip antenna 65, 68, 121 +MIMO 106 +MLFMM 127, 253, 256, 274 +MoM 155, 170 +monopole 36 +monostatic 151 +near field 151, 159, 170, 233, 243 +near field source 77, 131, 256 +network 216 +NGF 269 +non-radiating network 216 +NRPB 184 +object 283 +optimisation 40, 44, 54, 159, 269, 329 +patch antenna 54 +PBC 274 +PEC 19 +periodic boundary condition 113, 155, 159, 162 +periodic boundary conditions 274 +periodic structures 162 +pf 283 +physical optics 25, 256 +pin feed 54 +plane 162 +plane wave 148, 151, 155, 159, 162, 170, 181, 243 +PO 256 +POSTFEKO 283, 315, 329 +probe 181 +project 283 +proximity coupled 65 +radar cross section 148, 253 +radiation pattern 16, 19, 25, 44, 77, 88, 106, 121, 184, 193 +ray launching geometrical optics 25, 97 +RCS +bistatic 148 +real ground 40 +reflector 256 +results +coupling 131, 141 +far field 16, 19, 25, 68, 88, 97, 106, 121, 131 +input impedance 16, 65, 68, 88, 101, 106, 216 +iso surface 184 +near field 243 +radiation pattern 16, 19, 25, 77, 88, 106, 121, 184 +received power 131, 141 +S-parameters 193, 204 +RL-GO 97, 274 +S-parameters 204 +scattering width 155 +scripting 283, 315 +SEP 54, 151 +shapes 162 +shielded cable 177 +shielding 170, 181 +shielding factor 170 +solution method +domain Green's function method 121 +finite difference time domain 25 +finite element method 77, 88, 162, 193, 204 +higher order basis functions 25 +large element physical optics 25 +method of moments 16, 19, 25, 65, 68, 77, 88, 101, 106, 121, 141, 184, 193, 204, 216, 243 +physical optics 25 +planar multilayer substrate 65, 68, 121, 193 +ray launching geometrical optics 25, 97 +uniform theory of diffraction 25, 131 +windscreen 101 +source +far field source 97 +sphere 151 +spherical modes 131 +spherical modes source 131, 256 +static functiom 283 +surface equivalence principle 54, 151 +symmetry 36, 68 +TDS 148 +terminology +API 283 +thin dielectric sheet 148 +time analysis 243 +time domain 243 +Touchstone 216 +transmission coefficient 162 +transmission line 49 +triangular pulse 243 +trihedral 253 +type 283 +uniform theory of diffraction 25, 131 +unit cell 155 +voltage source 65, 68, 101, 106, 113, 121 +waveguide +port 204 +waveguide port 77, 88 +windscreen 101 +wire 16, 19, 25, 36 +wire port 65, 68, 101, 121 +Yagi-Uda 44 +Yagi-Uda antenna 40 + +Intellectual Property Rights Notice +Copyright © 1986-2023 Altair Engineering Inc. All Rights Reserved. +This Intellectual Property Rights Notice is exemplary, and therefore not exhaustive, of intellectual +property rights held by Altair Engineering Inc. or its affiliates. Software, other products, and materials +of Altair Engineering Inc. or its affiliates are protected under laws of the United States and laws of +other jurisdictions. In addition to intellectual property rights indicated herein, such software, other +products, and materials of Altair Engineering Inc. or its affiliates may be further protected by patents, +additional copyrights, additional trademarks, trade secrets, and additional other intellectual property +rights. For avoidance of doubt, copyright notice does not imply publication. Copyrights in the below are +held by Altair Engineering Inc. or its affiliates. Additionally, all non-Altair marks are the property of their +respective owners. +This Intellectual Property Rights Notice does not give you any right to any product, such as software, +or underlying intellectual property rights of Altair Engineering Inc. or its affiliates. Usage, for example, +of software of Altair Engineering Inc. or its affiliates is governed by and dependent on a valid license +agreement. +Altair Simulation Products +Altair® AcuSolve® ©1997-2023 +Altair Activate® ©1989-2023 +Altair® Battery Designer™ ©2019-2023 +Altair Compose® ©2007-2023 +Altair® ConnectMe™ ©2014-2023 +Altair® EDEM™ ©2005-2023 +Altair® ElectroFlo™ ©1992-2023 +Altair Embed® ©1989-2023 +Altair Embed® SE ©1989-2023 +Altair Embed®/Digital Power Designer ©2012-2023 +Altair Embed® Viewer ©1996-2023 +Altair® ESAComp® ©1992-2023 +Altair® Feko® ©1999-2023 +Altair® Flow Simulator™ ©2016-2023 +Altair® Flux® ©1983-2023 +Altair® FluxMotor® ©2017-2023 +Altair® HyperCrash® ©2001-2023 +Altair® HyperGraph® ©1995-2023 +Altair® HyperLife® ©1990-2023 +p.iii +Altair Feko 2022.3 +Intellectual Property Rights Notice +Altair® HyperSpice™ ©2017-2023 +Altair® HyperStudy® ©1999-2023 +Altair® HyperView® ©1999-2023 +Altair® HyperViewPlayer® ©2022-2023 +Altair® HyperWorks® ©1990-2023 +Altair® HyperXtrude® ©1999-2023 +Altair® Inspire™ ©2009-2023 +Altair® Inspire™ Cast ©2011-2023 +Altair® Inspire™ Extrude Metal ©1996-2023 +Altair® Inspire™ Extrude Polymer ©1996-2023 +Altair® Inspire™ Form ©1998-2023 +Altair® Inspire™ Mold ©2009-2023 +Altair® Inspire™ PolyFoam ©2009-2023 +Altair® Inspire™ Print3D ©2021-2023 +Altair® Inspire™ Render ©1993-2023 +Altair® Inspire™ Studio ©1993-2023 +Altair® Material Data Center™ ©2019-2023 +Altair® MotionSolve® ©2002-2023 +Altair® MotionView® ©1993-2023 +Altair® Multiscale Designer® ©2011-2023 +Altair® nanoFluidX® ©2013-2023 +Altair® OptiStruct® ©1996-2023 +Altair® PollEx™ ©2003-2023 +Altair® PSIM™ ©2022-2023 +Altair® Pulse™ ©2020-2023 +Altair® Radioss® ©1986-2023 +Altair® romAI™ ©2022-2023 +Altair® S-FRAME® ©1995-2023 +Altair® S-STEEL™ ©1995-2023 +Altair® S-PAD™ ©1995-2023 +Altair® S-CONCRETE™ ©1995-2023 +Altair® S-LINE™ ©1995-2023 +Altair® S-TIMBER™ ©1995-2023 +p.iv +Altair Feko 2022.3 +Intellectual Property Rights Notice +Altair® S-FOUNDATION™ ©1995-2023 +Altair® S-CALC™ ©1995-2023 +Altair® S-VIEW™ ©1995-2023 +Altair® Structural Office™ ©2022-2023 +Altair® SEAM® ©1985-2023 +Altair® SimLab® ©2004-2023 +Altair® SimLab® ST ©2019-2023 +Altair SimSolid® ©2015-2023 +Altair® ultraFluidX® ©2010-2023 +Altair® Virtual Wind Tunnel™ ©2012-2023 +Altair® WinProp™ ©2000-2023 +Altair® WRAP™ ©1998-2023 +Altair® GateVision PRO™ ©2002-2023 +Altair® RTLvision PRO™ ©2002-2023 +Altair® SpiceVision PRO™ ©2002-2023 +Altair® StarVision PRO™ ©2002-2023 +Altair® EEvision™ ©2018-2023 +Altair Packaged Solution Offerings (PSOs) +Altair® Automated Reporting Director™ ©2008-2022 +Altair® e-Motor Director™ ©2019-2023 +Altair® Geomechanics Director™ ©2011-2022 +Altair® Impact Simulation Director™ ©2010-2022 +Altair® Model Mesher Director™ ©2010-2023 +Altair® NVH Director™ ©2010-2023 +Altair® NVH Full Vehicle™ ©2022-2023 +Altair® NVH Standard™ ©2022-2023 +Altair® Squeak and Rattle Director™ ©2012-2023 +Altair® Virtual Gauge Director™ ©2012-2023 +Altair® Weld Certification Director™ ©2014-2023 +Altair® Multi-Disciplinary Optimization Director�� ©2012-2023 +Altair HPC & Cloud Products +Altair® PBS Professional® ©1994-2023 +Altair® PBS Works™ ©2022-2023 +p.v +Altair Feko 2022.3 +Intellectual Property Rights Notice +Altair® Control™ ©2008-2023 +Altair® Access™ ©2008-2023 +Altair® Accelerator™ ©1995-2023 +Altair® Accelerator™ Plus ©1995-2023 +Altair® FlowTracer™ ©1995-2023 +Altair® Allocator™ ©1995-2023 +Altair® Monitor™ ©1995-2023 +Altair® Hero™ ©1995-2023 +Altair® Software Asset Optimization (SAO) ©2007-2023 +Altair Mistral™ ©2022-2023 +Altair® Grid Engine® ©2001, 2011-2023 +Altair® DesignAI™ ©2022-2023 +Altair Breeze™ ©2022-2023 +Altair® NavOps® ©2022-2023 +Altair® Unlimited™ ©2022-2023 +Altair Data Analytics Products +Altair Analytics Workbench™ © 2002-2023 +Altair® Knowledge Studio® ©1994-2023 +Altair® Knowledge Studio® for Apache Spark ©1994-2023 +Altair® Knowledge Seeker™ ©1994-2023 +Altair® Knowledge Hub™ ©2017-2023 +Altair® Monarch® ©1996-2023 +Altair® Panopticon™ ©2004-2023 +Altair® SmartWorks™ ©2021-2023 +Altair SLC™ ©2002-2023 +Altair SmartWorks Hub™ ©2002-2023 +Altair® RapidMiner® ©2001-2023 +Altair One™ ©1994-2023 +2022.3 +March 17, 2023 +Technical Support +Altair provides comprehensive software support via web FAQs, tutorials, training classes, telephone, and +e-mail. +Altair One Customer Portal +Altair One (https://altairone.com/) is Altair’s customer portal giving you access to product downloads, a +Knowledge Base, and customer support. We recommend that all users create an Altair One account and +use it as their primary portal for everything Altair. +When your Altair One account is set up, you can access the Altair support page via this link: +www.altair.com/customer-support/ +Altair Community +Participate in an online community where you can share insights, collaborate with colleagues and peers, +and find more ways to take full advantage of Altair’s products. +Visit the Altair Community (https://community.altair.com/community) where you can access online +discussions, a knowledge base of product information, and an online form to contact Support. After you +login to the Altair Community, subscribe to the forums and user groups to get up-to-date information +about release updates, upcoming events, and questions asked by your fellow members. +These valuable resources help you discover, learn and grow, all while having the opportunity to network +with fellow explorers like yourself. +Altair Training Classes +Altair’s in-person, online, and self-paced trainings provide hands-on introduction to our products, +focusing on overall functionality. Trainings are conducted at our corporate and regional offices or at your +facility. +For more information visit: https://learn.altair.com/ +If you are interested in training at your facility, contact your account manager for more details. If you +do not know who your account manager is, contact your local support office and they will connect you +with your account manager. +Telephone and E-mail +If you are unable to contact Altair support via the customer portal, you may reach out to technical +support via phone or e-mail. Use the following table as a reference to locate the support office for your +region. +Altair support portals are available 24x7 and our global support engineers are available during normal +Altair business hours in your region. +When contacting Altair support, specify the product and version number you are using along with +a detailed description of the problem. It is beneficial for the support engineer to know what type +of workstation, operating system, RAM, and graphics board you have, so include that in your +Altair Feko 2022.3 +Technical Support +p.vii +Location +Australia +Brazil +Canada +China +France +Germany +Greece +India +Israel +Italy +Japan +Malaysia +Mexico +New Zealand +South Africa +South Korea +Spain +Sweden +Telephone +E-mail ++61 3 9866 5557 +anzsupport@altair.com ++55 113 884 0414 +br_support@altair.com ++1 416 447 6463 +support@altairengineering.ca ++86 400 619 6186 +support@altair.com.cn ++33 141 33 0992 +francesupport@altair.com ++49 703 162 0822 +hwsupport@altair.de ++30 231 047 3311 +eesupport@altair.com ++91 806 629 4500 +support@india.altair.com ++1 800 425 0234 (toll free) ++39 800 905 595 +support@altairengineering.it +israelsupport@altair.com ++81 3 6225 5830 +jp-support@altair.com ++60 32 742 7890 +aseansupport@altair.com ++52 55 5658 6808 +mx-support@altair.com ++64 9 413 7981 +anzsupport@altair.com ++27 21 831 1500 +support@altair.co.za ++82 704 050 9200 +support@altair.co.kr ++34 910 810 080 +support-spain@altair.com ++46 46 460 2828 +support@altair.se +United Kingdom ++44 192 646 8600 +support@uk.altair.com +United States ++1 248 614 2425 +hwsupport@altair.com +If your company is being serviced by an Altair partner, you can find that information on our web site at +https://www.altair.com/PartnerSearch/. +See www.altair.com for complete information on Altair, our team, and our products. +Introduction +1 Introduction +This installation guide provides instructions for the Altair Feko 2022.3 installation on supported +platforms. +The Altair Feko 2022.3 installation includes the following Altair Simulation 2022.3 applications: +• Feko +• newFASANT +• WinProp +where each application makes use of the Altair Units (AUs) licensing system. +The Altair Units licensing allows the Altair License Management (ALM) system to be used if ALM is +installed and properly configured. The Altair License Management licensing allows the flexibility to use +other Altair Simulation 2022.3 applications. +In order to run Altair Simulation 2022.3 applications, you need to connect the applications to the Altair +License Management System 14.0 (or higher, using the latest version is recommended). Details of the +installation and how to start the Altair License Manager can be found in the Altair License Management +System 14.0 Installation Guide. The license packages are available on Altair Connect or Altair One +System Requirements +2 System Requirements +Before you install Altair Feko (which includes Feko, newFASANT and WinProp), we recommend that you +verify that your computer meets or exceeds the minimum system requirements. +This chapter covers the following: +• 2.1 Minimum Operating System Requirements (p. 13) +2.1 Minimum Operating System Requirements +For more details regarding the minimum operating system requirements, view the Altair Simulation +Quick Installation Guide with additional details in the Altair Simulation Advanced Installation Guide. +Determining Missing Linux System Dependencies +If CADFEKO or POSTFEKO fails to start up with a message referring to “xcb”, the following commands +can be run to determine if a system has missing dependencies: +• +• +ldd $FEKO_HOME/bin/platforms/libqxcb.so | grep "not found" +ldd $FEKO_HOME/bin/xcbglintegrations/libqxcb-glx-integration.so | grep "not found" +where $FEKO_HOME is set to the Feko installation path which contains the bin subdirectory. +Note: Ignore libQt* dependencies, since these are resolved by the application at startup. +2.2 Hardware Requirements +For more details regarding the minimum hardware requirements, view the Altair Simulation Quick +Installation Guide. +Student Edition Limitations +3 Student Edition Limitations +The student edition provides full functionality apart from a number of limitations. +This chapter covers the following: +• 3.1 Feko Student Edition Limitations (p. 16) +• 3.2 newFASANT Student Edition Limitations (p. 17) +• 3.3 WinProp Student Edition Limitations (p. 18) +3.1 Feko Student Edition Limitations +Model Elements +• Number of wires in CADFEKO: 100 +• Number of faces in CADFEKO: 200 +• Number of mesh wire segments: 2 500 +• Number of mesh triangles: 25 000 +• Number of tetrahedral volume elements: 250 000 +• Number of voxel elements (FDTD): 500 000 +Solution Specification +• Near field observation points per request: 10 000 +• Far field observation directions per request: 20 000 +• Number of frequency values: 20 +Solution Metrics +• Main memory that can be allocated by Solver: 1 GByte +• Number of processes for parallel Solver version: 4 +• Total run-time (wall-clock time) of Solver: 20 min +• Number of adaptive frequency sampling points: 101 +• Number of simultaneously active excitations: 20 +• Number of optimisation variables (degrees of freedom): 3 +• Number of optimisation steps (iterations): 50 +Note: +• Geometry import and geometry export filters are not supported. +• Parasolid geometry export is supported. +3.2 newFASANT Student Edition Limitations +Model Elements +• MoM +◦ Number of subdomains: 100 000 +• GTD, GTD-PO and US +◦ Number of surfaces: 200 +◦ Number of internal facets: 2000 +◦ Number of curved surfaces: 200 +• PO +◦ Number of facets: 1000 +◦ Number of mesh elements: 50 000 +• PE +◦ Number of points to be analysed by profile: 200 +3.3 WinProp Student Edition Limitations +Indoor +• Number of objects in database smaller than 501 +• Number of transmitting antennas <=4 +Urban +• Number of objects in database smaller than 2001 +• Number of transmitting antennas <= 12 +Combined Indoor / Urban +• Number of objects in database smaller than 2001 (same as urban limit) +• Number of transmitting antennas <= 4 +Rural / Suburban +• Area smaller than 200 km2 +• Number of buildings smaller than 501 +• Number of transmitting antennas <=12 +CoMan +• Number of objects in database smaller than 501 +• Number of sensors/antennas <= 20 +Note: The WinProp API is not supported for the student edition. +3.4 WRAP Student Edition Limitations +• Station coordinates can only be in the range 14°-18° East and 57°-59° North +• Maximum number of stations: 6 +• Manually generated terrain profiles cannot be used +• It is not possible to add a Geo Class, and in the present class only the terrain code data and the +effective Earth radius can be edited +• Drag and drop can only be done within the current project +• Not supported to use MapDataManager to convert WRAP compatible maps, however +MapDataManager can be started +Note: The WRAP API is not supported for the student edition. +Installation Modes +4 Installation Modes +Install Altair Feko 2022.3 on a machine using either graphical user interface (GUI) mode, console mode +or silent mode. +The choice of installation modes allows for flexibility in selecting the installation mode that best suits +your needs and environment. +GUI Mode +The graphical user interface (GUI) mode installation is in the form of a GUI wizard with step-by-step +instructions. +Console Mode +A console mode installation process mimics the default GUI wizard steps, but uses only the standard +input and output. Console mode allows for text to be output to the console. +Silent Mode +A silent mode installation installs Altair Feko 2022.3 without requiring any user interaction. The installer +makes use of a response file that contains the installation options to run the installation from start to +end without any user input. +See Also +GUI Mode (Windows Installation) +GUI Mode (Linux Installation) +Console Mode (Linux Installation) +Silent Mode (Windows Installation) +Install Altair Feko +5 Install Altair Feko +Install Altair Feko 2022.3 installation using the Altair Units licensing system. +This chapter covers the following: +• 5.1 Preparing to Install Altair Feko (p. 22) +• 5.2 Installing on Microsoft Windows (Local) (p. 23) +• 5.3 Installing on Linux (Local) (p. 45) +• 5.4 Installing on Microsoft Windows (Server / Client) (p. 73) +• 5.5 Installing on Microsoft Windows (Cluster) (p. 83) +5.1 Preparing to Install Altair Feko +What you need to install and successfully run Feko, newFASANT and WinProp using Altair Units: +• Altair Feko 2022.3 installer (which includes Feko, newFASANT and WinProp) for your platform. +hwFeko2022.3_win64.exe +hwFeko2022.3_linux64.bin +hwFeko2022.3_edu_win64.exe +hwFeko2022.3_edu_linux64.bin +Installer of Altair Feko +Installer of Altair Feko Student Edition +• If you are using a server-based license, you will need access to an activated license server that +allows Altair Simulation applications to draw license units. +• A compatible machine that contains the minimum hardware/software requirements. +• Sufficient disk space for the installation. +The general procedure is: +• Install Altair Feko on the designated machine(s). +See Also +Minimum Operating System Requirements +Hardware Requirements +5.2 Installing on Microsoft Windows (Local) +5.2.1 GUI Mode +Starting the Installation Process +The installation process is started by extracting the software. +1. Complete the following steps to extract and install the software. +a) Log in to the machine on which the software is to be installed. +b) Place the downloaded installation file in a temporary directory. +c) Start the installation process by double-clicking the installation file to start the installer. +d) If user account control (UAC) is enabled and you are an administrator, a prompt displays +showing the Altair Engineering, Inc. digital signature for elevated permissions. Click Yes to +continue. +2. The Altair Feko installer (which includes Feko, newFASANT and WinProp) extracts the JVM (Java +Virtual Machine) and installs the modules to the TMP location of the machine and launches the +installer. +3. The Altair Feko 2022.3 splash screen is displayed while the installer is loaded. +Altair Feko 2022.3 +5 Install Altair Feko +Viewing the License Agreement +The License Agreement panel is displayed. +1. Read through the license agreement. +2. Click I accept the terms of the License Agreement to continue with the installation. +3. Click Next to continue. +p.24 +Altair Feko 2022.3 +5 Install Altair Feko +Introducing the Installation Wizard +The Introduction panel is displayed. +1. Read the introduction. +2. Click Next to continue. +p.25 +Altair Feko 2022.3 +5 Install Altair Feko +Choosing the Installation Type +The Choose Installation Type panel is displayed. +1. Select one of the following options: +• Local +p.26 +Select this option if you want the installation to be performed on your local machine. +Server +Select this option if you want to perform a server mode installation. You can either use +the local machine as server or install on a network share. Simulations are performed on +the client machines, not on the server. +Note: PowerShell must be available for a newFASANT server installation. +2. Click Next to continue. +See Also +Continue with Server Installation +Altair Feko 2022.3 +5 Install Altair Feko +Choosing the Install Folder +The Choose Install Folder panel is displayed. +p.27 +1. The default install folder is the Altair Simulation install folder and Feko, newFASANT and WinProp +will be installed in a feko subfolder. +Note: +• The installer does not allow the use of characters “#” and “;”. +• Installing to a root drive is not permitted, for example C:\. +2. Click Next to continue. +Attention: +If an existing installation of Feko is detected in the install folder, a warning prompt will +be displayed. +• Click Continue to overwrite all the files in the specified installation directory. +• Click Cancel Installation to abort the installation process. +Specifying the Location for Start Menu Shortcuts +The Change Shortcut Folder (Local) panel is displayed. +1. Specify the folder name that will contain the start menu shortcuts. +2. +[Optional] Specify the suffix string to be added to the shortcuts. +3. Select one of the following options: +• Yes +• No +Select this option if you want Altair Feko icons on the desktop. +Select this option if you do not want Altair Feko icons on the desktop. +4. Click Next to continue. +Specifying Additional Installation Options +The Other Installation Options panel is displayed. +1. Select option if applicable: +• Create file associations +Select this option if the installer should associate the file types used by Altair Feko +applications with this version. +If multiple Feko versions are installed then selecting this check box removes file +associations with previous Altair Feko versions. Feko, newFASANT and WinProp file +types will now be associated with this instance of Altair Feko. +• Add Windows Firewall exceptions +Select this option if the installer should automatically add Windows Firewall rules for the +parallel Feko executables and parallel services. +The rules are created as follows for each of the executables: for TCP and UDP +connections, allow incoming and outgoing connections on any local or remote port for +any local or remote address from any computer on your private networks. You can +make the rules more strict using Windows Firewall settings +Note: This option is only available when the user is installing Feko as an +administrator. +• Allow automatic updates +Select this option to enable the automated check for updates per machine. +2. Specify a temporary directory where the Feko solver can write temporary files. +3. Click Next to continue. +Warning: +When not using Windows Firewall, you need to add exceptions for all MPI related programs +to your antivirus / firewall software to prevent interference with MPI communication (this +may result in unexpected errors). +Add the following exceptions to your antivirus / firewall software: +• %ALTAIR_HOME%\feko\bin\feko_mkl.csv.impi.exe +• %ALTAIR_HOME%\feko\bin\feko_mkl.csv.mpich.exe +• %ALTAIR_HOME%\feko\bin\feko_mkl.csv.msmpi.exe +• %ALTAIR_HOME%\mpi\win64\intel-mpi\bin\hydra_service.exe +• %ALTAIR_HOME%\mpi\win64\intel-mpi\bin\mpiexec.exe +• %ALTAIR_HOME%\mpi\win64\intel-mpi\bin\mpiexec.hydra.exe +• %ALTAIR_HOME%\mpi\win64\intel-mpi\em64t\bin\hydra_service.exe +• %ALTAIR_HOME%\mpi\win64\intel-mpi\em64t\bin\mpiexec.exe +• %ALTAIR_HOME%\mpi\win64\intel-mpi\em64t\bin\mpiexec.hydra.exe +• %ALTAIR_HOME%\mpi\win64\intel-mpi\intel64\bin\hydra_service.exe +• %ALTAIR_HOME%\mpi\win64\intel-mpi\intel64\bin\mpiexec.exe +• %ALTAIR_HOME%\mpi\win64\intel-mpi\intel64\bin\mpiexec.hydra.exe +• %ALTAIR_HOME%\mpi\win64\mpich\bin\mpiexec.exe +• %ALTAIR_HOME%\mpi\win64\mpich\bin\smpd.exe +• %ALTAIR_HOME%\mpi\win64\mpich\bin\wmpiexec.exe +Allowing Computer to Be Used as a Remote Host +The Remote Execution panel is displayed. It allows you to specify if the Feko temporary directory +(specified on the Other Installation Options panel) should be a shared directory or not. +1. Select one of the following options: +• Allow this computer to be used as a remote host by using shared folders +This option will allow the current computer to be used as a remote host. It allows you to +build your model on one computer and then run the Feko solver on another computer. +The temporary folder will be shared as \\%COMPUTERNAME%\feko_remote$ and have full +permissions for “Authenticated Users”. Guests or unauthenticated users will not have +access by default. +• Not use this computer as a remote host by using shared folders +This option is used when the current computer is not to be used as a remote host. +Note: If you select this option, you can still use remote launching using +SSH (if available on the computer). +2. Click Next to continue. +Specifying the License Location +The Altair Licence Management System panel is displayed. +Note: This dialog is only displayed if ALTAIR_LICENSE_PATH has not been set. +1. Select the location for the environment variable ALTAIR_LICENSE_PATH. If uncertain +about the location, leave the field empty, but you will need to manually set the value of +ALTAIR_LICENSE_PATH after the installation is complete. +2. Click Next to continue. +Verifying the Pre-Installation Options +The Pre-Installation Summary panel is displayed. The summary contains details about the pending +installation. +1. Review the installation details. +2. Click Next to continue. +Altair Feko 2022.3 +5 Install Altair Feko +Viewing the Installation Progress +The Installing Altair Feko 2022.3 panel is displayed. +View the installation progress. +p.35 +Specifying the Parallel Run Settings +The Select Parallel Run Settings panel is displayed. +1. Select one of the following options: +• Run on local machine only +This option allows you to perform parallel runs on one or more local, multi-core CPU. +The installer automatically inserts the detected number of cores/CPUs as a default +number, but it may be changed if you wish to run a different number of parallel +processes. +• Run on a Windows cluster with Active Directory integration +This option is applicable if you have installed Altair Feko on a Windows cluster that is +part of a Windows domain and you intend to perform parallel runs on the cluster. +• Run on a Windows cluster and encrypt credentials into registry +This option is applicable if you have installed Altair Feko on a Windows cluster that is +not part of a Windows domain and you intend to perform parallel runs on the cluster. +• Run on a non-Windows cluster (e.g. Linux) +This option is applicable if you have installed Altair Feko on a non-Windows cluster and +you wish to perform parallel runs on the cluster. +2. Click Next to continue. +Altair Feko 2022.3 +5 Install Altair Feko +Specifying the Machines Info +p.37 +The Specify Machines Info panel is displayed when the Run on a Unix/Linux cluster option was +selected. +1. Select one of the following options: +• Create new machines file +This option allows you to create a new machines file which specifies the list of machines +used to perform parallel runs. +• Copy existing machines file +This option allows you to use an existing machines file. The selected machines file will +be copied to the new Altair Feko installation directory. +2. Click Next to continue. +See Also +Create New Machines File +Copy Existing Machines File +Altair Feko 2022.3 +5 Install Altair Feko +Defining the Machines File +The Machines File Editor panel is displayed. +p.38 +1. +If the Create new machines file option was selected, for each machine specify its name and +number of parallel processes. Use the format, hostname:number_of_processes, for example: +clustermachine.mydomain:4. +2. Click Next to continue. +Altair Feko 2022.3 +5 Install Altair Feko +Exiting the Installation Wizard +The Install Complete panel is displayed. +1. Once the installation is complete, the Install Complete panel is displayed. +2. Click Done to exit the installer. +p.39 +Altair Feko 2022.3 +5 Install Altair Feko +5.2.2 Silent Mode +p.40 +A silent mode installation installs Altair Feko 2022.3 without requiring any user interaction. The installer +makes use of a response file that contains the installation options to run the installation from start to +end without any user input. +1. Create a response file. Run the installer in interactive mode with the r option to save the +installation properties to a response file. +[INSTALLER_NAME] -r "[RESPONSE_PATH]\installer.properties" +2. Trigger a silent mode installation from the command line using one of the following options: +• Use the default property values as provided by the installer package. +[INSTALLER_NAME] -i silent +• Specify properties. +[INSTALLER_NAME] -i silent -D[Property]=[VALUE] +• For example: +-DACCEPT_EULA=YES -DUSER_INSTALL_DIR=C:\\Program Files\\Altair\\2022.3 +• Use a response file containing properties. +[INSTALLER_NAME] -i silent -f "[RESPONSE_PATH]\installer.properties" +Note: +• [INSTALLER_NAME] is the installer binary. +• [RESPONSE_PATH] is the path where the response file resides. +• Use quotes around directory and pathnames that contain spaces. +• Do not use spaces between VARIABLE=VALUE statements in the response file. +• Specify ACCEPT_EULA=YES to agree with the end user license agreement (EULA) +and continue with the installation. +Altair Feko 2022.3 +5 Install Altair Feko +Response Files +p.41 +A response file is an installer properties file used to provide properties for an installer running in silent +mode. The files contain text in a simple VARIABLE=VALUE format. +The properties in the response files are captured by executing the installer and the captured variables +are then used as default values for future silent installs. The installer automatically checks the same +directory as the installer for a file called installer.properties to use as input to the installer. +An example of a response file containing properties: +#Accept End User License Agreement (EULA) and Continue with the Installation +#------------------------ +ACCEPT_EULA=YES +#Choose Installation Type +#------------------------ +LOCAL_INSTALLATION=0 +SERVER_INSTALLATION=1 +#Choose Install Folder +#--------------------- +USER_INSTALL_DIR=Program Files\Altair\2022.3\feko +#Change Shortcut Folder (Local) +#------------------------------ +SET_START_MENU_FOLDER=Altair 2022.3 +INSTALL_DESKTOP_SHORTCUTS=0 +#UNC Mount Path +#-------------- +UNC_MOUNT_POINT_PANEL=\\\\MachineName\\SharedFolder\\InstallFolder +#Other Installation Options +#-------------------------- +CREATE_FILE_ASSOCIATION=1 +FEKO_CREATE_FIREWALL_ENTRIES=1 +FEKO_TMPDIR=C:\\Temp +#Remote Execution +#---------------- +FEKO_REMOTE_CREATE_SHARE=0 +#Enter Licence Path Location +#----------------------------- +FEKO_ALTAIR_LICENSE_PATH=6200@server.domain +#Select Parallel Runs Settings +#----------------------------- +FEKO_RUN_LOCALONLY=1 +FEKO_NUMBER_OF_CORES_TO_USE=2 +FEKO_RUN_WIN_CLUSTER_AD=0 +FEKO_RUN_WIN_CLUSTER_MPIREGISTER=0 +FEKO_RUN_ON_LINUX_CLUSTER=0 +#Choose Log File Location +#----------------------------- +INSTALL_LOG_NAME=InstallLogFile +INSTALL_LOG_DESTINATION=C:\\InstallerLogFile +#Choose Log File Location +#----------------------------- +INSTALL_LOG_NAME=InstallLogFile +INSTALL_LOG_DESTINATION=C:\\InstallerLogFile +Note: Spaces should not be used between the VARIABLE=VALUE statements in the +response files. +Altair Feko 2022.3 +5 Install Altair Feko +Response File Properties +General Properties +ACCEPT_EULA +p.43 +YES: You have read and accepted the end user license agreement (EULA). +USER_INSTALL_DIR +The default install folder is Program Files\Altair\2022.3\feko. +LOCAL_INSTALLATION +0: The installation is performed on a server (can be either a local machine or on a network share). +1: The installation is performed on your local machine. +SERVER_INSTALLATION +0: The installation is performed on your local machine. +1: The installation is performed on a server (can be either a local machine or on a network share). +SET_START_MENU_FOLDER +Specify the name of the start menu folder. +INSTALL_DESKTOP_SHORTCUTS +0: No shortcuts are created. +1: Shortcuts are created. +CREATE_FILE_ASSOCIATION +0: Do not create file associations. +1: Create file associations. +FEKO_CREATE_FIREWALL_ENTRIES +0: Do not add Windows Firewall exceptions. +1: Add Windows Firewall exceptions. +FEKO_TMPDIR +Specify the location of a folder where Feko can write temporary files. This folder must be +accessible by all users that will be running the Solver. +FEKO_REMOTE_CREATE_SHARE +0: Do not allow this computer to be used as a remote host by using shared folders. +1: Allow this computer to be used as a remote host by using shared folders. +INSTALL_LOG_NAME +Specify the name of the installer log file. The default installer log file name consists of the product +name, version and date. +INSTALL_LOG_DESTINATION +Specify the folder for the installer log file. The default log file folder is the ALTAIR_HOME/logs +folder. +Local Machine Properties +When Feko is to be run only on a local machine, specify FEKO_RUN_LOCALONLY=1 and the number of +parallel processes with FEKO_NUMBER_OF_CORES_TO_USE. +Altair Feko 2022.3 +5 Install Altair Feko +Cluster Properties +p.44 +When Feko is to be run on a cluster, set one of the following three properties equal to 1, +FEKO_RUN_LOCALONLY=0 and the remaining two properties in the group to 0: +FEKO_RUN_WIN_CLUSTER_AD +0: Parallel runs are not performed on a Windows cluster with Active directory integration. +1: Parallel runs are performed on a Windows cluster with Active directory integration. +FEKO_RUN_WIN_CLUSTER_MPIREGISTER +0: Parallel runs are not performed on a Windows cluster and encrypted into registry. +1: Parallel runs are performed on a Windows cluster and encrypted into registry. +FEKO_RUN_ON_LINUX_CLUSTER +0: Parallel runs are not performed on a Linux cluster. +1: Parallel runs are performed on a Linux cluster. +CREATE_NEW_MACHINESFILE +0: Do not create a new machines file which specifies the list of machines used to perform parallel +runs. +1: Create a new machines file which specifies the list of machines used to perform parallel runs. +USE_EXISTING_MACHINESFILE +0: Do no use existing machine file. +1: Copy existing machines file. +EXISTING_MACHINESFILE +Path to the existing machines file (use with USE_EXISTING_MACHINESFILE=1) +Server (Client / Server) Properties +UNC_MOUNT_POINT_PANEL +UNC mount path to the server machine (for example, \\MachineName\SharedFolder +\InstallFolder). +5.3 Installing on Linux (Local) +5.3.1 GUI Mode +Starting the Installation Process +The installation process is started by extracting the software. +1. Open a command terminal. +a) “cd” - change directory - to the location where the installer executable resides. +b) Execute “sh hwFeko2022.3_linux64.bin” +2. The Altair Feko installer (which includes Feko, newFASANT and WinProp) extracts the JVM (Java +Virtual Machine) and installs the modules to the TMP location of the machine and launches the +installer. +3. The Altair Feko 2022.3 splash screen is displayed while the installer is loaded. +Altair Feko 2022.3 +5 Install Altair Feko +Viewing the License Agreement +The License Agreement panel is displayed. +1. Read through the license agreement. +2. Click I accept the terms of the License Agreement to continue with the installation. +3. Click Next to continue. +p.46 +Altair Feko 2022.3 +5 Install Altair Feko +Introducing the Installation Wizard +The Introduction panel is displayed. +1. Read the introduction. +2. Click Next to continue. +p.47 +Altair Feko 2022.3 +5 Install Altair Feko +Choosing the Install Folder +The Choose Install Folder panel is displayed. +p.48 +1. The default install folder is the Altair Simulation install folder and Feko, newFASANT and WinProp +will be installed in a feko subfolder. +Note: +• The installer does not allow the use of characters “#” and “;”. +• Installing to a root drive is not permitted, for example /. +2. Click Next to continue. +Attention: +If an existing installation of Feko is detected in the install folder, a warning prompt will +be displayed. +• Click Continue to overwrite all the files in the specified installation directory. +• Click Cancel Installation to abort the installation process. +Specifying Additional Installation Options +The Other Installation Options panel is displayed. +1. Select option if applicable: +• Allow automatic updates +Select this option to enable the automated check for updates per machine. +2. Specify a temporary directory where the Feko solver can write temporary files. +3. Click Next to continue. +Select MPI Implementation To Use +The Select MPI Implementation To Use panel is displayed. +1. Select one of the following options[1]: +• Intel MPI [11] +Intel MPI is the default and recommended MPI implementation for most platforms. +It supports SMP (symmetrical multi-processing) and communication protocols like +Ethernet, GigaBit Ethernet and Myrinet or Infiniband through suitable DAPL providers. +To use Intel MPI, enter “11” in the field below. +• MS MPI [13] +MS MPI is the MPI implementation provided by Microsoft. It provides tighter integration +with the Windows HPC (high-performance computing) job scheduler. It is unavailable in +general on Windows systems, as it is a part of the Microsoft HPC Server 2008, Microsoft +HPC Server 2008 R2, Microsoft HPC Server 2012, Microsoft HPC Server 2012 R2, +Microsoft HPC pack and Microsoft Windows Compute Cluster Server 2003. +• MPICH [1] +The MPICH is the high-performance and portable MPI implementation. MPICH is not +recommended for general use and is provided as a fall-back should a problem with Intel +MPI be observed.To use MPICH, enter “1” in the field below. +Note: This library is included with the Altair Feko installation. +• SGI MPT [4] +SGI MPT (message passing toolkit) is a message passing toolkit containing user and +system tools and libraries. The toolkit provides optimised MPI functionality for SGI +systems such as the SGI UV and SGI ICE.To use SGI MPT, enter “4” in the field below. +Note: The SGI MPT library is not included with the Altair Feko installation and +must be available on the system. +2. Enter either 1, 4, 11 or 13 and click Next to continue +1. View the MPI documentation in the $ALTAIR_HOME\mpi\win64 folder. + +Specifying the License Location +The Altair Licence Management System panel is displayed. +Note: This dialog is only displayed if ALTAIR_LICENSE_PATH has not been set. +1. Select the location for the environment variable ALTAIR_LICENSE_PATH. If uncertain +about the location, leave the field empty, but you will need to manually set the value of +ALTAIR_LICENSE_PATH after the installation is complete. +2. Click Next to continue. +Verifying the Pre-Installation Options +The Pre-Installation Summary panel is displayed. The summary contains details about the pending +installation. +1. Review the installation details. +2. Click Next to continue. +Altair Feko 2022.3 +5 Install Altair Feko +Viewing the Installation Progress +The Installing Altair Feko 2022.3 panel is displayed. +View the installation progress. +p.54 +Specifying the Parallel Run Settings +The Select Parallel Run Settings panel is displayed. +1. Select one of the following options: +• Run on local machine only +This option allows you to perform parallel runs on one or more local, multi-core CPU. +The installer automatically inserts the detected number of cores/CPUs as a default +number, but it may be changed if you wish to run a different number of parallel +processes. +• Run on a Unix/Linux cluster +This option is applicable if you have installed Altair Feko on a non-Windows cluster and +you wish to perform parallel runs on the cluster. +2. Click Next to continue. +Altair Feko 2022.3 +5 Install Altair Feko +Specifying the Machines Info +p.56 +The Specify Machines Info panel is displayed when the Run on a Unix/Linux cluster option was +selected. +1. Select one of the following options: +• Create new machines file +This option allows you to create a new machines file which specifies the list of machines +used to perform parallel runs. +• Copy existing machines file +This option allows you to use an existing machines file. The selected machines file will +be copied to the new Altair Feko installation directory. +2. Select one of the following options: +• Use SSH +This option allows you to make use of the ssh (secure shell) method to remotely log in +to a computer. This method makes use of encryption. +• Use RSH +This option allows you to make use of the rsh (remote shell) method to remotely log in +to a computer. +3. Click Next to continue. +Altair Feko 2022.3 +5 Install Altair Feko +See Also +Create New Machines File +Copy Existing Machines File +p.57 +Altair Feko 2022.3 +5 Install Altair Feko +Defining the Machines File +The Machines File Editor panel is displayed. +p.58 +1. +If the Create new machines file option was selected, for each machine specify its name and +number of parallel processes. Use the format, hostname:number_of_processes, for example: +clustermachine.mydomain:4. +2. Click Next to continue. +Performing Connectivity Tests +The Remote Node Connectivity Tests panel is displayed. +The installer will attempt to perform connectivity tests on the nodes specified in the machines file. Be +advised that the remote connectivity tests could take some time. +Click Next to continue with the connectivity tests. +See Also +Connectivity Tests are Unsuccessful +Connectivity Tests are Successful +See Also +Unsuccessfully Completing the Connectivity Tests +Successfully Completing the Connectivity Tests +Failing the Connectivity Tests on the Nodes +The Testing ssh Failed On Some Nodes panel is displayed if any of the connectivity tests failed on +the nodes. It also lists potential problems and their solutions. +1. Fix any errors before continuing. +2. Click Next to continue. +Retrying the Connectivity Tests +The Retry the connectivity tests? dialog is displayed. +If you want to retry the connectivity tests, click Yes. If you want to continue with the installation +regardless of the failed connectivity tests, click No. +Determining the Remote Node Feko Versions +The Remote Node Feko Versions panel is displayed. +1. The installer will attempt to determine the Feko versions installed on the nodes. Be advised that +determining the Feko versions could take some time. +2. Click Next to continue. +See Also +Unsuccessfully Determining the Feko Versions +Successfully Determining the Feko Versions +Allowing Remote Installation on the Nodes +The Remote Installation panel is displayed. +1. The Remote Installation panel is displayed if the installer did not find Feko on all the nodes. +You now have the option to let the Altair Feko installer copy Feko to all the specified nodes, or +you can copy the files to each node manually. You can also export the installation directory via a +distributed file system like NFS, and then no copying will be necessary. +2. Click Next to continue. +Retrying the Detection of Feko on the Nodes +The Retry the detection of Feko on the nodes dialog is displayed. +Click one of the following options: +• Continue without installing +This option is applicable if you want to perform the installation on the node independently of +the current server installation. +• Perform remote install +This option is applicable if you want the installer to perform the remote node installation. +• Retry detection +This option is applicable if you want to retry the detection of Feko on the remote nodes. +See Also +Retry Detection +Perform Remote Install +Continue Without Installing +Copying the Feko Files to the Nodes +The Remote Node Altair Feko Installation is displayed, +1. +If the Perform remote install option was selected on the Retry the detection of Feko on the +node dialog, the Remote Node Feko panel is displayed. Be advised that installing Feko on the +remote node(s) could take some time. +2. Click Next to continue. +Copying Failed to Some Node +The Copying failed to some nodes panel is displayed, +The Copying failed to some nodes panel is displayed if Feko was not successfully installed on the +remote node(s). +See Also +Next Step +Previous Step +Altair Feko 2022.3 +5 Install Altair Feko +Exiting the Installation Wizard +The Install Complete panel is displayed. +1. Once the installation is complete, the Install Complete panel is displayed. +2. Click Done to exit the installer. +p.67 +Altair Feko 2022.3 +5 Install Altair Feko +5.3.2 Console Mode +p.68 +A console mode installation process mimics the default GUI wizard steps, but uses only the standard +input and output. Console mode allows for text to be output to the console. +Note: +• Installing Altair Feko using console mode is only supported on Linux. +• If the terminal does not have any GUI/X capabilities (such as a pure SSH terminal +session), launching the installer without any additional options will automatically start +the console mode. +Trigger a console mode installer from the command line by appending the following command +parameter to the installer: +-i console +1. Open a command terminal. +a) Change directory to the location where the installer resides. +b) Execute the “sh” command on the installer binary where [INSTALLER_NAME] is the installer +binary with the additional command parameter: +sh [INSTALLER_NAME] -i console +2. The Altair Feko installer extracts the Java Virtual Machine (JVM) and the install modules to the +TMP location of the machine and launches the installer. +3. Follow the console prompt to complete the installation. +Altair Feko 2022.3 +5 Install Altair Feko +5.3.3 Silent Mode +p.69 +A silent mode installation installs Altair Feko 2022.3 without requiring any user interaction. The installer +makes use of a response file that contains the installation options to run the installation from start to +end without any user input. +1. Create a response file. Run the installer in interactive mode with the r option to save the +installation properties to a response file. +[INSTALLER_NAME] -r "[RESPONSE_PATH]\installer.properties" +2. Trigger a silent mode installation from the command line using one of the following options: +• Use the default property values as provided by the installer package. +[INSTALLER_NAME] -i silent +• Specify properties. +[INSTALLER_NAME] -i silent -D[Property]=[VALUE] +• For example: +-DACCEPT_EULA=YES -DUSER_INSTALL_DIR=C:\\Program Files\\Altair\\2022.3 +• Use a response file containing properties. +[INSTALLER_NAME] -i silent -f "[RESPONSE_PATH]\installer.properties" +Note: +• [INSTALLER_NAME] is the installer binary. +• [RESPONSE_PATH] is the path where the response file resides. +• Use quotes around directory and pathnames that contain spaces. +• Do not use spaces between VARIABLE=VALUE statements in the response file. +• Specify ACCEPT_EULA=YES to agree with the end user license agreement (EULA) +and continue with the installation. +Altair Feko 2022.3 +5 Install Altair Feko +Response Files +p.70 +A response file is an installer properties file used to provide properties for an installer running in silent +mode. The files contain text in a simple VARIABLE=VALUE format. +The properties in the response files are captured by executing the installer and the captured variables +are then used as default values for future silent installs. The installer automatically checks the same +directory as the installer for a file called installer.properties to use as input to the installer. +An example of a response file containing properties: +#Accept End User License Agreement (EULA) and Continue with the Installation +#------------------------ +ACCEPT_EULA=YES +#Choose Install Folder +#--------------------- +USER_INSTALL_DIR=/home/user/2022.3/Altair/feko +#Change Shortcut Folder (Local) +#------------------------------ +SET_START_MENU_FOLDER=Altair 2022.3 +INSTALL_DESKTOP_SHORTCUTS=0 +#Other Installation Options +#-------------------------- +CREATE_FILE_ASSOCIATION=1 +FEKO_CREATE_FIREWALL_ENTRIES=1 +FEKO_TMPDIR=C:\\Temp +#Remote Execution +#---------------- +FEKO_REMOTE_CREATE_SHARE=0 +#Enter Licence Path Location +#----------------------------- +FEKO_ALTAIR_LICENSE_PATH=6200@server.domain +#Select Parallel Runs Settings +#----------------------------- +FEKO_RUN_LOCALONLY=1 +FEKO_NUMBER_OF_CORES_TO_USE=2 +FEKO_RUN_WIN_CLUSTER_AD=0 +FEKO_RUN_WIN_CLUSTER_MPIREGISTER=0 +FEKO_RUN_ON_LINUX_CLUSTER=0 +#Choose Log File Location +#----------------------------- +INSTALL_LOG_NAME=InstallLogFile +INSTALL_LOG_DESTINATION=C:\\InstallerLogFile +#Choose Log File Location +#----------------------------- +INSTALL_LOG_NAME=InstallLogFile +INSTALL_LOG_DESTINATION=C:\\InstallerLogFile +Note: Spaces should not be used between the VARIABLE=VALUE statements in the +response files. +Altair Feko 2022.3 +5 Install Altair Feko +Response File Properties +General Properties +ACCEPT_EULA +YES: You have read and accepted the end user license agreement (EULA). +USER_INSTALL_DIR +The default install folder is /home/user/2022.3/Altair/feko. +SET_START_MENU_FOLDER +Specify the name of the start menu folder. +p.71 +INSTALL_DESKTOP_SHORTCUTS +0: No shortcuts are created. +1: Shortcuts are created. +CREATE_FILE_ASSOCIATION +0: Do not create file associations. +1: Create file associations. +FEKO_CREATE_FIREWALL_ENTRIES +0: Do not add Windows Firewall exceptions. +1: Add Windows Firewall exceptions. +FEKO_TMPDIR +Specify the location of a folder where Feko can write temporary files. This folder must be +accessible by all users that will be running the Solver. +FEKO_REMOTE_CREATE_SHARE +0: Do not allow this computer to be used as a remote host by using shared folders. +1: Allow this computer to be used as a remote host by using shared folders. +INSTALL_LOG_NAME +Specify the name of the installer log file. The default installer log file name consists of the product +name, version and date. +INSTALL_LOG_DESTINATION +Specify the folder for the installer log file. The default log file folder is the ALTAIR_HOME/logs +folder. +Local Machine Properties +When Feko is to be run only on a local machine, specify FEKO_RUN_LOCALONLY=1 and the number of +parallel processes with FEKO_NUMBER_OF_CORES_TO_USE. +Cluster Properties +When Feko is to be run on a cluster, set one of the following three properties equal to 1, +FEKO_RUN_LOCALONLY=0 and the remaining two properties in the group to 0: +FEKO_RUN_WIN_CLUSTER_AD +0: Parallel runs are not performed on a Windows cluster with Active directory integration. +1: Parallel runs are performed on a Windows cluster with Active directory integration. +FEKO_RUN_WIN_CLUSTER_MPIREGISTER +0: Parallel runs are not performed on a Windows cluster and encrypted into registry. +1: Parallel runs are performed on a Windows cluster and encrypted into registry. +FEKO_RUN_ON_LINUX_CLUSTER +0: Parallel runs are not performed on a Linux cluster. +1: Parallel runs are performed on a Linux cluster. +CREATE_NEW_MACHINESFILE +0: Do not create a new machines file which specifies the list of machines used to perform parallel +runs. +1: Create a new machines file which specifies the list of machines used to perform parallel runs. +USE_EXISTING_MACHINESFILE +0: Do no use existing machine file. +1: Copy existing machines file. +EXISTING_MACHINESFILE +Path to the existing machines file (use with USE_EXISTING_MACHINESFILE=1) +5.4 Installing on Microsoft Windows (Server / +Client) +Perform a Server / Client installation on Microsoft Windows platform. +A typical use case for a Server / Client installation is in a large company where the server installation is +performed and maintained (updates / upgrades) by the system administrator. Users of Altair Feko inside +the company (clients) then only have to perform a Client installation[2] (NETSETUP.bat) on their local +machine. +A client installation creates shortcuts on the user's machine that point to the server machine. When the +system administrator installs updates / upgrades on the server machine, all clients will automatically +have the updated version. +5.4.1 Server +A server installation can be performed on either a local machine or on a network share. +Starting the Server Installation +The Server installation process is similar to installing the Local Altair Feko installation. +Follow the instructions from Starting the Installation Process to Choosing the Installation Type. +2. Client installations are small in size in comparison with a Local installation. +Choosing the Install Folder +The Choose Install Folder panel is displayed. +1. Specify the pathname where you want to install the software. +Note: +• Append “_server” to the install path so as not to conflict with local Altair +Simulation installs. +• The installer does not allow the use of characters “#” and “;”. +• Installing to a root drive is not permitted, for example C:\. +2. Click Next to continue. +Attention: +If an existing installation of Feko is detected in the install folder, a warning prompt will +be displayed. +• Click Continue to overwrite all the files in the specified installation directory. +• Click Cancel Installation to abort the installation process. + +Specifying the Location for Start Menu Shortcuts +The Change Shortcut Folder (Server) panel is displayed. +1. Specify the folder location that will contain the start menu shortcuts that point to the server +installation. +2. Specify the folder name that will contain the start menu shortcuts. +3. Select one of the following options: +• Yes +• No +Select this option if you want Feko icons on the desktop. +Select this option if you do not want Feko icons on the desktop. +4. Click Next to continue. +Altair Feko 2022.3 +5 Install Altair Feko +Specifying the UNC Mount Path +The UNC Mount Path panel is displayed. +p.77 +1. Specify the UNC mount path to the server machine. This will ensure when the client machine is +installed later, the shortcut links on the client machine points correctly to the server installation. +2. Click Next to continue. +Completing the Server Installation +The remaining steps for completing the Server / Client installation is similar to the Local installation. +Follow the instructions from Specifying Additional Installation Options to Exiting the Installation Wizard +to complete the Server installation. +Altair Feko 2022.3 +5 Install Altair Feko +5.4.2 Client +p.78 +A client installation (NETSETUP.bat) is performed on a client machine. Simulations are performed on the +client machine, not on the server machine. +Starting the Client Installation +Requirements for a NETSETUP client install include: +• The existence of a Feko server installation on either a local machine or a server machine. +• The UNC path to the Feko server installation. +1. Locate the server machine on the network and find the install folder for the server installation. +2. Go to the NETSETUP\win64 folder and locate NETSETUP.bat. +3. Click on NETSETUP.bat to launch the installer. +4. A command prompt terminal window is displayed showing that the installer is unpacking on the +client machine. +********************************************************************** +Unpacking and running Altair NETSETUP Client installer, please wait... +********************************************************************** +The locale language selection prompt is then displayed. +5. Select the locale language and click OK to continue. +Specifying the Location for Start Menu Shortcuts +The Install Desktop Shortcuts panel is displayed. +1. Specify the folder name that will contain the start menu shortcuts (that points to the location of +the server machine). +2. Select one of the following options: +• Yes +• No +Select this option if you want Feko icons on the desktop. +Select this option if you do not want Feko icons on the desktop. +Altair Feko 2022.3 +5 Install Altair Feko +Set Up Licensing +The Set up Licensing panel is displayed. +Select one of the following options: +p.80 +• Enter license server(port@host) or choose a license file +If you are using a license file located on a network, use the format:port@hostname. +If you are using a local license file, set the value to the full pathname of the file. +• Skip this step +If you are uncertain about the location, you will need to manually set the value of +ALTAIR_LICENSE_PATH after the installation is complete. +See Also +Connecting to Altair License Server +Verifying the Pre-Installation Summary +The Pre-Installation Summary panel is displayed. The summary contains details about the pending +installation. +1. Review the installation details. +2. Click Next to continue. +Exiting the Installation Wizard +The Install Complete panel is displayed once the installation is complete. +Click Done to exit the installer. +5.5 Installing on Microsoft Windows (Cluster) +Install Feko on a Windows high performance computing (HPC) cluster. +5.5.1 Installing on Windows HPC Server +Install Altair Feko on a Microsoft Windows high performance computing (HPC) server. +1. Log in to a node. The node should be either a test machine or the head node which will not be +used as a compute node. +2. Place the downloaded installation file in a temporary directory. +3. +Install Feko on the head node and record the installation properties in a response file. +Note: A response file can also be recorded by launching the installer in GUI mode +from a command terminal window. See Silent Mode for details on the process. +4. Copy the installation file and response file (installer.properties) to the same shared network +location reachable by all cluster nodes. +[INSTALLER_NAME] -r "[RESPONSE_PATH]\installer.properties" +5. Start the silent mode installation on all the cluster nodes from the head node where +[NETWORK_PATH] is the full UNC path to the shared network location where the installation file +and response file reside[3]: +clusrun start /wait "[NETWORK_PATH]\[INSTALLER_NAME]" -i silent -f + "[NETWORK_PATH]\installer.properties" +Note: The installation of each node could be a lengthy process and no output is given +during the installation process. +A return value of 0 for each node will indicate a successful installation. +General Notes +There are many ways to submit a job to the HPC system. Company policies may enforce a specific +way of submitting a job to a HPC system, as a result the information provided here is to be seen as +examples of how it can be done. +• A job can be submitted from either the head node or from any machine that: +◦ has access to the cluster +3. The clusrun tool is part of the Windows HPC pack toolset and is available on the head node. The +clusrun command will install Feko on all cluster nodes that are configured and approved by the +Windows Compute Cluster Administrator Management Console SnapIn. See the documentation for +the clusrun tool for additional commandline options when installing on a subset of the nodes. +Altair Feko 2022.3 +5 Install Altair Feko +◦ has the Windows HPC Pack installed +p.84 +Figure 1: Three methods to submit a job to a Microsoft Windows HPC server. +• You must have direct access to the head node and submit the job from the head node using the +command line interface or the HPC Job Manager. +• You connect to the head node using Remote Desktop Connection and then submit the job as you +have direct access. +• You have the HPC Pack installed on your desktop machine and directly submits the job to the job +scheduler using for example, the command line interface or the HPC Job Manager. +• The machine from where a job is being submitted does not necessarily need to have Feko installed +(but mostly it will be there because of pre- and post-processing). +• The model files must be accessible via network from all the cluster nodes. +• The real command in the submitted job / task is then: +"C:\Program Files\Altair\2022.3\feko\bin\runfeko.exe" "" --use-job- +scheduler +• The working directory for the job must be set to the network location where the model files are +located. +• All options (for example, regarding which machines to use and how many nodes will participate in +this run) have to be specified when submitting / creating this HPC job or task. This can be done in +many ways and has to be specified by the cluster administrator. +• The jobs are submitted to the job queue of the HPC cluster and are then run automatically +whenever the requested resources are available. +5.5.2 Submitting a Job to the HPC Cluster Manager (GUI) +Define a basic task that runs a single instance of a message passing interface (MPI) application on a +high performance cluster using a graphical user interface (GUI). +1. Click Start and navigate to HPC Pack, and then click HPC Cluster Manager to launch HPC +Cluster Manager. +2. To create an MPI task, in the Actions panel (panel to the right of the window), click New Job. +Note: An alternative option is to click New Single Task Job. +This option provides a quick way to submit an MPI task using the default job property +values as defined by the job template that you use. +The New Job dialog is displayed. +In the left pane of the New Job dialog, click Edit Tasks[4]. +3. +4. To the right of the New Job dialog, click the Add drop-down list and select Basic Task. +A Task Details and I/O Redirection dialog is displayed. +In the Task name field, type a name for your task. +In the Command line field, type the task command, for example: +5. +6. +"C:\Program Files\Altair\2022.3\feko\bin\runfeko.exe" example_01 --use-job- +scheduler +7. +In the Working directory field, specify the directory for your task. +Note: A working directory should be indicated with a universal naming convention +(UNC) path, not a relative or a local path. +8. +In the Standard input, Standard output and Standard error fields, specify the names relative +to the working directory. +9. +In the Minimum field, type the minimum number of cores to be used. +10. In the Maximum field, type the maximum number of cores to be used. +11. Click Save to add the task to your job and to return to the New Job dialog. +5.5.3 Submitting a Job From the Command Line +Define a basic task that runs a single instance of a message passing interface (MPI) application on a +high performance cluster using the command line. +Assume you have the example: +• A model with file name example_01.pre. +• The model is located on a shared network location at \\server\share. +• There will be four nodes participating in this parallel run. +Launch the job using the following command in a single line: +job submit /numprocessors:4-4 + /jobname:Altair_Feko_job_1 + /workdir:\\server\share + /stdout:\\server\share\example_01.stdout + /stdErr:\\server\share\example_01.stderr +4. +In older versions this could be Task List. +"C:\Program Files\Altair\2022.3\feko\bin\runfeko.exe" example_01 --use- +job-scheduler +A task is created with a single job. The task is run immediately if the resources are available on the +cluster. +All information is read from and written to the directory where the model is located. Normal output +(STDOUT) and the error messages (STDERR) are redirected into files and will be available after the +computation is finished. +You can extend this command by specifying additional parameters[5] for the job command. +5. https://docs.microsoft.com/en-us/powershell/high-performance-computing/job-submit? +view=hpc16-ps +5.6 Altair License Management +The Altair License Management (ALM) provides a common units-based licensing model for Altair +software related to CAE, on-demand computing, and business intelligence. +One of the components of the Altair License Management System is the License Server. +5.6.1 Connecting to Altair License Server +The Altair License Server is an application that runs on supported platforms and serves licenses to Altair +Licensing System enabled clients. Altair Simulation provides value and flexibility through a patented, +units-based licensing system. Altair Units allow metered usage of the entire suite of products as well as +an expanding library of Altair Partner Alliance solutions. +In order to use the Altair License Server, point the environment variable, ALTAIR_LICENSE_PATH, to the +appropriate location. +Note: +• If you are using a local license file, simply set the value to the full pathname of the file. +• If you are using a license file located on a network, use the format: port@hostname. +• Separate multiple license paths using a semicolon (;) on Windows and a colon (:) on +Linux. +• For High Availability License (HAL) System and / or Multiple Servers setups, list the +three servers in the order: primary; secondary; tertiary. +Note: When the hostname is specified without the Fully Qualified Domain Name (FQDN) +and there are multiple Forward Lookup Zones, some time is spent on the DNS query, +delaying the license check-out time. This delay is significant when multiple license check- +outs are required over a short period of time. +Tip: To minimize the delay, use the FQDN on the hostname. For example, instead of using +6200@hostname use 6200@hostname.somecollege.com or even the IP address, for example +6200@192.168.0.1 +Examples of license paths on Windows: +ALTAIR_LICENSE_PATH=c:\Program Files\Altair\Licensing12.0\altair_lic.dat +ALTAI_LICENSE_PATH=6200@server.foo.bar.com +ALTAIR_LICENSE_PATH=6200@srv1;6200@srv2;6200@srv3 +Examples of license paths on Linux: +ALTAIR_LICENSE_PATH=/usr/local/altair/licensing121.0/altair_lic.dat +ALTAIR_LICENSE_PATH=6200@server.foo.bar.com +ALTAIR_LICENSE_PATH=6200@srv1:6200@srv2:6200@srv3 +5.6.2 Reconnecting to Altair License Server +When the connection to the Altair License Server fails, use the retry button provided by the graphical +user interface. +When the licence error dialog appears, click the Retry button. +Figure 2: The CADFEKO: Licence error dialog. +Install Altair WRAP +6 Install Altair WRAP +Install Altair WRAP in an existing Altair Feko 2022.3 installation using the Altair Units licensing system. +This chapter covers the following: +• 6.1 Preparing to Install Altair WRAP (p. 90) +• 6.2 Installing on Microsoft Windows (p. 91) +• 6.3 Altair WRAP Third-Party Installer (p. 100) +6.1 Preparing to Install Altair WRAP +What you need to install and successfully run WRAP: +• Altair WRAP 2022.3 installer for Microsoft Windows. +hwWrap2022.3_win64.exe +Installer of Altair WRAP +• An existing Altair Feko 2022.3 installation. +• ITS HF Propagation (version 2016.12.07) installer (required for HF functionality within WRAP). +The general procedure is: +• Install Altair Feko on the designated machine(s). +• Install Altair WRAP inside the existing Altair Feko installation. +• [Optional] Install ITS HF Propagation (version 2016.12.07) if HF functionality is required. +6.2 Installing on Microsoft Windows +6.2.1 Make Backup of Database Settings +If you have an existing installation of Altair WRAP, first make a backup of your writeable databases. +Important: This step is only applicable if you have an existing installation of Altair WRAP +and have made changes to the database settings that you would like to keep. +[6]. +1. Make a backup of your writeable databases in %FEKO_SHARED_HOME%\wrap\Databases +2. Make a backup[7] of your Geo class settings file: %FEKO_USER_HOME%\wrap\WrapGeo.wgc +[8]. +See Also +Restore Backup of Database Settings +6.2.2 Starting the Installation Process +The installation process is started by extracting the software. +Important: Running this installer requires administrative privileges. +1. Complete the following steps to extract and install the software. +a) Log in to the machine on which the software is to be installed. +b) Insert the USB/DVD, or place the downloaded installation file in a temporary directory. +c) Start the installation process by double-clicking the installation file to start the installer. +d) If user account control (UAC) is enabled and you are an administrator, a prompt displays +showing the Altair Engineering, Inc. digital signature for elevated permissions. Click Yes to +continue. +6. The %FEKO_SHARED_HOME% variable is set to the directory that is used to write files shared between +Altair Feko users on the same machine. For Microsoft Windows systems, this is by default set to +C:\ProgramData\altair\feko\xx.yy. Here xx.yy represent the major and minor version numbers. +7. The map settings .wgc file can also be backed up using the Settings > Geographical > Save All/ +Backup menu option. +8. The %FEKO_USER_HOME% variable is set to the directory used to write user specific initialisation +files. It is provided to allow different users to save unique configurations, and for situations where +the user does not have write access to the Feko directory. For Microsoft Windows systems this is +typically %APPDATA%\feko\xx.yy. Here xx.yy represent the major and minor version numbers. +2. The Altair WRAP installer extracts the JVM (Java Virtual Machine) and installs the modules to the +TMP location of the machine and launches the installer. +3. The Altair WRAP 2022.3 splash screen is displayed while the installer is loaded. +6.2.3 Viewing the License Agreement +The License Agreement panel is displayed. +1. Read through the license agreement. +2. Scroll down to the end of the license agreement and click I accept the terms of the License +Agreement to continue with the installation. +3. Click Next to continue. +6.2.4 Choosing the Install Folder +The Choose Install Folder panel is displayed. +1. The default install folder is the Altair Simulation install folder. +Attention: An existing Altair Feko installation is required to install WRAP. +Note: +• The installer does not allow the use of characters “#” and “;”. +• Installing to a root drive is not permitted, for example C:\. +2. Click Next to continue. +Attention: +If an existing installation of Feko was not detected in the install folder, a warning +prompt will be displayed. +• Click Cancel Installation to abort the installation process. +• Click Previous to return to the previous installation panel. + +6.2.5 Verifying the Pre-Installation Options +The Pre-Installation Summary panel is displayed. The summary contains details about the pending +installation. +1. Review the installation details. +2. Click Next to continue. +6.2.6 Viewing the Installation Progress +The Installing Altair Wrap 2022.3 panel is displayed. +View the installation progress. +6.2.7 Exiting the Installation Wizard +The Install Complete panel is displayed. +1. Once the installation is complete, the Install Complete panel is displayed. +2. Click Done to exit the installer. +Note: When WRAP is installed in an existing Altair Feko installation, WRAP is enabled on the +Launcher utility. +6.2.8 Restore Backup of Database Settings +If you have made a backup of your writeable databases of a previous installation, restore your backup. +Important: This step is only applicable if you had an existing installation of Altair WRAP +and made a backup of your database settings. +1. Copy back the databases into a suitable location or in the new default location +%FEKO_SHARED_HOME%\wrap\Databases. +2. Connect the databases using ChangeDB. +3. Copy back your .wgc file into %FEKO_USER_HOME%\wrap +The updated version of WRAP is now ready to be used with the existing writeable database and Geo +class settings. +[9]. +See Also +Make Backup of Database Settings +9. The %FEKO_USER_HOME% variable is set to the directory used to write user specific initialisation +files. It is provided to allow different users to save unique configurations, and for situations where +the user does not have write access to the Feko directory. For Microsoft Windows systems this is +typically %APPDATA%\feko\xx.yy. Here xx.yy represent the major and minor version numbers. +6.3 Altair WRAP Third-Party Installer +WRAP has a dependency on ITS HF Propagation version 2016.12.07 (third-party software) that must be +installed to make use of HF functionality within WRAP. +6.3.1 Installing ITS HF Propagation +ITS HF Propagation only needs to be installed if HF functionality is to be used within WRAP. It handles +propagation calculations in the 2 MHz to 30 MHz band with inclusion of ionospheric reflection. +If you start an HF calculation and ITS HF Propagation is not installed, the following informational dialogs +are displayed: +Figure 3: WRAP informational dialogs that are displayed when you start an HF calculation and ITS HF Propagation is +not installed. +1. Locate itshfbc_180417a.exe in the ITSHF folder in the WRAP installation package. +Attention: Version 2016.12.07 is required. +2. Double-click itshfbc_180417a.exe to start the installation. +The ITS HF Propagation 2016.12.07 panel is displayed. +3. Click Next to start the installation process. +Figure 4: The ITS HF Propagation 2016.12.07 dialog. +The Important information panel is displayed. +4. Click Next to continue the installation process. +Figure 5: The Important information dialog. +The License agreement panel is displayed. +5. Click I agree to these terms and conditions to continue with the installation and click Next. +Figure 6: The License agreement dialog. +The Installation options panel is displayed. +6. Use the default installation folder and click Install to complete the installation process. +Figure 7: The Installation options dialog. +Note: If you are not using the default installation folder, set the same path in WRAP +on the Change WRAP Win settings dialog (Other Paths tab). +Figure 8: The Change WRAP Win settings dialog. +The Installation completed panel is displayed. +7. Click Finish to complete the installation process. +Figure 9: The Installation completed dialog. +Modifying the Altair Feko +Installation +7 Modifying the Altair Feko Installation +After the installation process is complete, any installation option can be modified by performing a re- +installation. +1. Start the installation process. +2. Click Continue when the Altair Feko 2022.3 Warning prompt is displayed to overwrite the files +in the specified installation directory. +Uninstall Altair Feko +8 Uninstall Altair Feko +The uninstaller removes all files from the Altair Feko installation (which includes Feko, newFASANT +and WinProp). Backup all files you wish to save prior to running the uninstaller. There is no partial +uninstaller available. +This chapter covers the following: +• 8.1 Uninstalling on Microsoft Windows (Local) (p. 107) +• 8.2 Uninstalling on Linux (Local) (p. 109) +• 8.3 Uninstalling the Server (Server / Client) (p. 110) +• 8.4 Uninstalling the Client (Server / Client) (p. 111) +• 8.5 Uninstalling on Microsoft Windows HPC Server (p. 112) +• 8.6 Log Files (p. 113) +Note: If Altair WRAP was installed into the Altair Feko installation, uninstalling Altair Feko +8.1 Uninstalling on Microsoft Windows (Local) +8.1.1 Uninstalling in GUI Mode +1. Start the uninstalling process by selecting one of the following workflows: +• Select the start menu for Feko and run Uninstall Altair Feko 2022.3. +• Open Control Panel > Programs > Programs and features > Uninstall or change a +program to launch the Feko uninstaller. +2. +If user account control (UAC) is enabled and you are an administrator, a prompt displays showing +the Altair Engineering, Inc. digital signature for elevated permissions. Click Yes to continue. +The Uninstall Altair Feko 2022.3 panel is displayed +3. Click Uninstall to continue. +The Uninstall Complete panel is displayed once the installation is removed. +4. Click Done to exit. +8.1.2 Uninstalling Using a Response File +Silent uninstalls for Altair Feko removes all folders, directories and files of the Altair Feko install. +A response file is required for using the silent uninstall capabilities. +1. Create a response file by adding the following three variables to the file. +INSTALLER_UI=silent +FEATURE_UNINSTALL=COMPLETE +INSTALL_CLEANUP_ALL=1 +2. Save the response file as uninstaller.properties. +3. Open a command prompt. +Tip: Use administrative elevation to bypass User Account Control prompts. +4. Run the Feko uninstaller executable using the response file, uninstaller.properties. +"\2022.3\uninstalls\Uninstall_FEKO2022.3\Uninstall Altair + Feko 2022.3.exe" -i -f +\hwfeko2022.3_silent_uninstaller.properties +where the parameters are defined as follows: +INSTALL_PATH +Specify the location of the Altair Feko install directory. +-i +Sets the uninstalled interface mode to silent. +Altair Feko 2022.3 +8 Uninstall Altair Feko +-f +The location of the response file is specified. +RESPONSE_PATH +Specify the location where the response file resides. +p.108 +8.2 Uninstalling on Linux (Local) +8.2.1 Uninstalling Using the Command Line +Use the command line to remove the files and folders. +Run the following command to uninstall the product, where [INSTALL_DIRECTORY] is where the Altair +Feko installation you would like to remove resides: +rm –Rf [INSTALL_DIRECTORY] +8.3 Uninstalling the Server (Server / Client) +Remove the Server part of the Server / Client installation. Removing the Server installation is similar to +removing the Local Altair Feko installation. +Follow the instructions from Uninstalling in GUI Mode to remove the Server installation. +8.4 Uninstalling the Client (Server / Client) +Uninstall the Client part of the Server / Client installation. +1. Locate the folder where the start menu shortcuts were installed during the Client installation, +for example, C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Altair 2022.3 +(Client)\Tools\Uninstall_NETSETUP2022.3. +2. Click Uninstall_NETSETUP2022.3 to uninstall the Client. +3. On the Uninstall_NETSETUP 2022.3 panel, click Next to uninstall the Client. +4. On the Select Uninstall Type panel, click Uninstall to remove all files and folders in the Client +installation. +5. Click Done to exit. +8.5 Uninstalling on Microsoft Windows HPC Server +Remove the Altair Feko installation from nodes in a cluster. +1. Start the uninstallation on a node (preferably the head node) by recording to a response file. +2. Repeat the uninstallation process on the other nodes using the response file. +See Also +Response Files +Altair Feko 2022.3 +8 Uninstall Altair Feko +8.6 Log Files +p.113 +During uninstallation, a log file is generated that can be used to troubleshoot issues with the installer. +Note: The uninstall log file can be viewed at the following locations: +• Windows +%TEMP%\feko_uninstall_logs +\Altair_Feko_2022.3_Install_.log +• Linux +$TEMP/feko_uninstall_logs/ +Altair_Feko_2022.3_Install_.log +Uninstall Altair WRAP +9 Uninstall Altair WRAP +To uninstall Altair WRAP that was installed in an existing Altair Feko installation, run the Altair Feko +uninstaller. +Note: When uninstalling WRAP; do not delete the following folders if you want to keep your +existing writeable databases: +• +%FEKO_SHARED_HOME% +[10] +• %FEKO_SHARED_HOME%\shared +See Also +Uninstall Altair Feko +See Also +Make Backup of Database Settings +Restore Backup of Database Settings +10. The %FEKO_SHARED_HOME% variable is set to the directory that is used to write files shared between +Altair Feko users on the same machine. For Microsoft Windows systems, this is by default set to +Parallel / Distributed +Processing +10 +10 Parallel / Distributed Processing +Feko makes use of the MPI (message passing interface) communication system for parallel /distributed +solver runs. +This chapter covers the following: +• 10.1 Parallel / Distributed Processing Requirements (p. 116) +• 10.2 MPI Overview (p. 117) +• 10.3 Modifying the Default MPI Used (p. 119) +10.1 Parallel / Distributed Processing +Requirements +Compute nodes requirements to use the parallel processing capabilities of Feko. +Compute nodes must meet the following requirements: +• An identical operating environment for all users. +◦ The file structure of a compute node must be identical to other compute nodes (except for files +that specify unique node or sub cluster identification or configuration). +◦ All compute nodes must run the same software image (kernel, libraries and commands). +◦ The provided system-wide software must be properly configured and have a consistent runtime +environment. +Altair Feko 2022.3 +10 Parallel / Distributed Processing +10.2 MPI Overview +p.117 +Message passing interface (MPI) implementations are platform and system dependent. Feko supports +the Intel MPI, MS-MPI, MPICH and SGI MPT implementations for parallel solver runs. +Tip: View the MPI documentation in the $ALTAIR_HOME\mpi\win64 folder. +The following MPI implementations are supported by Feko: +• Intel MPI +Intel MPI is the default and recommended MPI implementation for most platforms. It +supports SMP (symmetrical multi-processing) and communication protocols like Ethernet, +GigaBit Ethernet and Myrinet or Infiniband through suitable DAPL providers. +The Intel MPI library supports the following job schedulers: +Microsoft Windows +◦ Altair PBS Professional +◦ Microsoft HPC Pack +Linux +◦ Altair PBS Professional +◦ Torque +◦ OpenPBS +◦ +IBM Platform LSF +◦ Parallelnavi NQS +◦ SLURM +◦ Univa Grid Engine +Note: Intel MPI is the default on all systems (except for Windows HPC). +• MS MPI +MS MPI is the MPI implementation provided by Microsoft. It provides tighter integration with +the Windows HPC (high-performance computing) job scheduler. It is unavailable in general +on Windows systems, as it is a part of the Microsoft HPC Server 2008, Microsoft HPC Server +2008 R2, Microsoft HPC Server 2012, Microsoft HPC Server 2012 R2, Microsoft HPC pack and +Microsoft Windows Compute Cluster Server 2003. +Note: MS MPI is the default on Windows HPC. +• MPICH +The MPICH is the high-performance and portable MPI implementation. MPICH is not +recommended for general use and is provided as a fall-back should a problem with Intel MPI +be observed. +Altair Feko 2022.3 +10 Parallel / Distributed Processing +• SGI MPT +p.118 +SGI MPT (message passing toolkit) is a message passing toolkit containing user and system +tools and libraries. The toolkit provides optimised MPI functionality for SGI systems such as +the SGI UV and SGI ICE. +10.3 Modifying the Default MPI Used +Modify the default message passing interface (MPI) implementation used by Feko. +Modify the default MPI implementation using one of the following workflows: +• Set the environment variable FEKO_WHICH_MPI. +• Modify the value of the variable FEKO_WHICH_MPI_SETUP in the file +FEKOenvironmentFromSetup.lua located in the %FEKO_HOME% directory or any user-specific file. +Intel MPI +MS-MPI +MPICH +SGI MPT +FEKO_WHICH_MPI = 11 +FEKO_WHICH_MPI = 13 +FEKO_WHICH_MPI = 1 +FEKO_WHICH_MPI = 4 +Note: It is not recommended in a normal workflow to change the default MPI +implementation used. +10.4 Parallel Authentication Methods +When running the Solver in parallel, involving multiple machines, the processes must be authenticated. +Use encrypted credentials in registry (Windows only) +This option uses a previously stored encrypted user name and password from the Windows +registry. Save the login credentials before starting a parallel computation. The credential is a +per-user setting and must be updated on each change of your user password. If using remote- +parallel launching, the credentials must also be saved on the remote host where the Solver is run +in parallel. +Save or update your credentials by using the Update parallel credentials provided on the +Launcher utility (Utilities tab). +Use SSPI (Active Directory) integration (Windows only, requires domain) +Note: +• Machines must be a member of a Microsoft Windows (Active Directory) domain. +• User accounts must be domain accounts. +This option uses internal Windows functions to carry-out authentication without the need to +encrypt login credentials into the registry. +Once-off configuration settings might be required to set up by the domain administrator to +prepare the Windows domain for the authentication[11]. +Local run only (no authentication required) +This option allows you to perform parallel runs on a single or local, multi-core CPU. The installer +automatically inserts the default number equal to the detected number of cores/CPUs. Change the +default number of cores if you wish to run a different number of parallel processes processes. +Default (rsh/ssh for UNIX, registry for Windows) +This option uses the default authentication method for the target operating platform. +• For UNIX systems, the public key authentication of rsh/ssh is used. +• For Windows systems, the registry method is used. +11. View the MPI documentation in the $ALTAIR_HOME\mpi\win64 folder. +Remote Launching / Farming +Overview +11 +11 Remote Launching / Farming Overview +Prepare a system to support the remote launching and/or optimisation farming capabilities of Feko. +This chapter covers the following: +• 11.1 Remote Launching and Farming Requirements (p. 122) +• 11.2 Remote Launching / Farming Methods (p. 123) +• 11.3 MPI Method (p. 124) +11.1 Remote Launching and Farming Requirements +General requirements to use the remote launching and farming capabilities of Feko. +General Requirements +The following requirements are applicable to both remote launching and farming: +• Altair Feko installed on both the local client and the remote host. +• The remote host must have been configured during installation to be used as a remote host. If the +remote host was not configured as a remote host, either: +◦ Modify the installation. +◦ Create the network share manually and add the Feko bin directory to the PATH environment +variable. +• The user starting the job must have access to the remote machine using a Windows account (same +account must be created on both machines or domain-based security must be used). +• Ensure there are sufficient Altair Units to grant the license check out. +Remote Launching Requirements +Compute nodes must meet the following requirements for remote launching: +• An identical operating environment for all users. +◦ The file structure of a compute node must be identical to other compute nodes (except for files +that specify unique node or subcluster identification or configuration). +◦ All compute nodes must run the same software image (kernel, libraries and commands). +◦ The provided system-wide software must be properly configured and have a consistent runtime +environment. +Note: It is not required for the file systems to be shared. File copy operations are +performed automatically. +Farming Requirements +A single multi-core machine must meet the following requirement for farming: +• Both the client and server setup for remote launching must be available on the machine. +11.2 Remote Launching / Farming Methods +Set up support for remote launching/farming by using either the MPI (message passing interface) +method or SSH (secure shell) method. +Feko provides cross platform remote launching. For example, you can launch a remote job from a +Windows PC on a Linux cluster, and from Linux to Linux. +MPI Method +Use this method when only Windows hosts are participating in the remote launching process or farming. +This method uses the normal copy commands and the created network share on the remote host for +transferring the files to and from the remote host. +Note: This is the recommended method to set up support for remote launching or farming. +SSH Method +This method works from / to all platforms, but requires additional steps to configure. +11.3 MPI Method +Set up the remote machine (server) to support the remote launching and farming capabilities of Feko +using the MPI method. No additional steps are required to set up the client machine. +11.3.1 Setting Up the Remote Machine +Setting Up Network Share +Set up the network share on the remote host if remote launching was not selected during installation or +more advanced network share settings are required. +The installer creates the following default network share settings: +Path +Share +%FEKO_TMPDIR% +feko_remote$ +Security +Full access for authenticated users +Edit the file %FEKO_HOME%\bin\feko_remote_mpi.bat if the location or share name is different from the +above defaults. +Edit the lines: +set FEKO_REMOTE_DIR_LOCAL=!FEKO_TMPDIR! +set FEKO_REMOTE_DIR_SHARE=feko_remote$ +Note: If sharing FEKO_TMPDIR as feko_remote$ with full access for authenticated users is +unsuitable, you can change the location and/or security settings, provided the network share +name feko_remote$ is kept. Ensure that all accounts used for computations get access to +this share on the remote machine(s). +11.3.2 Configuring the Environment Setup +Set up the User Environment Setup. +1. Add the PATH environment variable per user if it is not set globally. +2. Ensure the account(s) used to start / launch the Feko remote computations must: +• exist on both the local and remote machine +• have sufficient rights to copy from and to the remote machine +• have the same password / credentials such that no additional authentication dialog will open +upon the copy and remote launching operations +Note: +• If the machines are part of domain, this should be accomplished automatically by +the domain membership and group policies or ask your domain administrator. +• If the machines are standalone machines, ensure to create the same accounts +(same account and passwords) on both machines. +11.4 SSH Method +Set up the system to support the remote launching and farming capabilities of Feko using the SSH +method. An SSH client must be installed on the local machine (client) and an SSH server must be +installed on the remote machine (server). +11.4.1 Setting Up the Client Machine +Setting Up the Client Machine on Windows +Set up an SSH client on the local machine with a Windows operating system. Additional software is +required to add the functionality to Windows. +Windows operating systems do not ship with any SSH client application by default. +Set up the client machine setup using one of the following software: +• PuTTY +• SSH from Cygwin +• OpenSSH for Windows +See Also +Configuring PuTTY +Setting Up the Client Machine on Linux +Set up an SSH client on the local machine with a Linux operating system. +Since SSH is readily available by default in most distributions, normally no additional steps are required. +If this is not the case, then either query the package manager for a suitable SSH package or obtain +OpenSSH. +Ensure that “ssh” is in your PATH to be able to launch it without having to supply the full path to the +directory where “ssh” is located. +Note: Help might also be available from “man ssh”. +Configuring the Environment Setup +Set up the User Environment Setup. +1. Set up the private and public key authentication. This step needs only to be done if no such keys +are yet available. +• Under Linux and Cygwin: Use the command “ssh-keygen -t dsa -N ""” to create the keys. +You will find a “.ssh” directory inside your HOME directory which contains the private key +(dquoteid_dsa) and your public key (id_dsa.pub). +• When using PuTTY: Convert this public key into PuTTY syntax by using “puttygen”. (Use +Conversions > Import Key, select your private key file created before, select Save private +key and save it to a .ppk file at a location where you can reach it later.) You can also use +“puttygen” to completely create the key pair, but then you also have to copy the keys in +OpenSSH syntax to the remote machine’s directory. +The public key must then be added to the file “authorized_keys” on the remote host. The +private key must be used on the client while attempting to connect to the remote host. +2. Set up the profile scripts. +• Linux: Add the initfeko script to the .bashrc file in the HOME directory of each user to +get the correct environment loaded. Simply add the following line to that file (note the dot +followed by a space followed by the full path to the script): +. /altair/feko/bin/initfeko +• Windows: No special step is required since the relevant information is saved in the registry. +Just ensure that the Feko bin directory is added to the PATH environment variable. +11.4.2 Setting Up the Remote Machine +Setting Up the Remote Machine on Linux +Set up an SSH client on the remote machine with a Linux operating system. +Since SSH is readily available by default in most distributions, normally no additional steps are required. +If this is not the case, then either query the package manager for a suitable SSH package or obtain +OpenSSH. +Ensure the SSH daemon (“sshd)” is configured and running, as this is part of the initial system +installation. If this is not the case, please refer to your distribution’s documentation on how to setup the +SSH daemon to start automatically and allow users to connect. +Note: Help might also be available from “man sshd” or “man sshd_config”. +Setting Up the Remote Machine on Windows +Set up an SSH server on the machine with a Windows operating system. Additional software is required +to add the functionality to Windows. +Windows operating systems do not ship with any SSH component by default. +Set up the client machine setup using one of the following software; +• SSHd from Cygwin +Altair Feko 2022.3 +11 Remote Launching / Farming Overview +• OpenSSH for Windows +• CopSSH - OpenSSH for Windows +p.128 +Note: Nearly all implementations are based on the OpenSSH implementation and might +vary only on the installation/configuration steps (effort) and the included versions, since all +use precompiled binaries. The implementations are mainly some kind of “wrapper” around a +slimlined installation of the Cygwin part (they install and maintain some minimalistic Cygwin +environment only for the SSH functionality.) +Updater +12 +12 Updater +The feko_update_gui utility and the feko_update utility allows you the flexibility to install an update +containing features, minor software enhancements and bug fixes on top of an existing base installation +for Altair Feko (which includes Feko, newFASANT and WinProp). +This chapter covers the following: +• 12.1 Version Numbers (p. 130) +• 12.2 GUI Update Utility (p. 131) +• 12.3 Command Line Update Utility (p. 137) +• 12.4 Proxy Settings Overview (p. 139) +12.1 Version Numbers +Each major release, upgrade or update is assigned a version number. A version number contains a +unique set of numbers assigned to a specific software release for identification purposes. You can +determine from the version number if its an initial release, update or upgrade. +The following terminology is used to define a version number: +Feko .. +for example: +Feko 2019.1.2 +2019 +Indicates the major release version. A major release is made available roughly once a year and +has a minor and patch version of “0”. +Note: +• The update utility does not support upgrades between major versions. +• A major release requires a new installer. +Indicates the minor release version and is referred to as an upgrade. Large feature enhancements +and bug fixes are included in the upgrade. Minor upgrades are released quarterly, for example “1” +indicates the first minor upgrade after the initial release. Use the update utility to upgrade to a +newer minor version (when available). +Indicates the patch version and is referred to as an update or “hot fix”. Minor feature +enhancements and bug fixes are included in the update. Patch updates are released between +minor upgrades, for example “2” indicates the second patch update after an upgrade. +12.2 GUI Update Utility +Use the feko_update_gui to check for new versions of the software and install an update using a +graphical user interface (GUI). +Click on Application menu > Check for updates to do a forced check for updates[12]. +When either CADFEKO, EDITFEKO or POSTFEKO is launched and the scheduled interval time has +elapsed, the update utility (GUI mode) automatically checks for updates. By default the schedule is set +to check for updates once a week. If updates are available, the update utility displays a notification alert +as well as giving you the option to select and install updates. +The GUI update utility can be started from the command line using: +feko_update_gui +Updates can be installed from a web repository[13] or a local repository. During an update a list +containing the latest software is retrieved and compared to installed components. +Note: No information is collected during an update. +12.2.1 Viewing the Installed Component Versions +View the version numbers of the installed Feko components. +1. Open the Updater using the Launcher utility. +2. On the Altair Feko update dialog, click the Installed versions tab. +3. View the Component, Version and Date information for the current installation. +12. A forced update can also be done from the application menu in CADFEKO, POSTFEKO and +EDITFEKO. +13. Requires internet access. +Figure 10: The Altair Feko update dialog - Installed versions tab. +4. Click the Update tab and click Close to exit the Altair Feko update dialog. +12.2.2 Updating or Upgrading to a New Version +Updating and upgrading refers to the process of installing a new version containing features, minor +software enhancements and bug fixes on top of an existing base installation. +1. Open the Updater using the Launcher utility. +2. On the Altair Feko update dialog, click the Update tab. +3. Click the Refresh button to view the available Feko versions for download. +4. Select a version to view the available components and their individual file size in the table. +Tip: Click Details to view the release notes in the message window. +Figure 11: The Altair Feko update dialog - Update tab. +5. Click Update to update or upgrade to the selected version. +a) Before an upgrade is started, you will be asked to confirm the upgrade from the current +version to the selected version. Click Continue with upgrade to allow the update/upgrade +process to proceed. +b) During the update process, click Details to expand the message window and view detailed +information regarding the update process. +6. When the update or upgrade is complete, click Close. +12.2.3 Updating From a Local Repository (GUI) +Update (or upgrade) from a local repository using the graphical user interface. +1. Open the Updater using the Launcher utility. +2. On the Altair Feko update dialog, click the Settings tab. +3. Under Update from, click Local repository to update from a local repository. +Figure 12: The Altair Feko update dialog - Settings tab. +4. Under Local repository, select one of the following: +• If the local repository contains extracted archives or multiple zipped archives, select Folder +(with extracted or zipped archives) and specify the folder. +The path for the local Feko update repository must be an absolute file path which can point to +an unmapped network share (Windows), mapped (mounted) network share or a directory on +a local drive. +Warning: Point the local repository path to the root folder of the updates. +Example: The Feko updates for the Windows and Linux platforms were extracted +and merged to C:\Updates. The path to the local repository points to C:\Updates. +C:\Updates + └─FEKO_2022.3.x + └─WIN64_X86_64 + └─LINUX_X86_64 +• If the local repository contains a single zipped archive, select File (zipped archive) and +specify the zip file. +5. Click Save to save the local repository settings. +6. Update or upgrade to a new version. +Troubleshooting: Error 16700: Unable to find the file 'XX/YY/manifest.xml.gz' +in the local repository. +Error 16700 indicates that the path to the local repository is incorrect. The path must point +to the root folder of the local update repository and the folders should not be modified. +Related tasks +Creating a Local Update Repository +12.2.4 Scheduling Automatic Updates +Schedule and configure an automatic Feko update. +1. Open the Updater using the Launcher utility. +2. On the Altair Feko update dialog, click the Settings tab. +Figure 13: The Altair Feko update dialog - Settings tab. +3. Select the Check for updates automatically check box to automatically check for updates. +Select one of the following options: +• every week +• every month +• every N days +4. Select the download location under Update from group box. +Web +The updates are downloaded from the web repository. +Local repository +This option is recommended when the computer network or cluster has no internet +access due to security reasons or only limited available bandwidth. The updates may be +downloaded from the Connect website by the system administrator and placed at a location +accessible for the computer network or cluster. +5. Optional: Specify the proxy server and authentication when the web is specified as the repository +under Proxy group box. +6. Click Save to save the new settings. +Related concepts +Proxy Settings Overview +12.3 Command Line Update Utility +Use the feko_update utility for scripted updates or updates from a Feko terminal. +The command line update utility is called from the command line using: +feko_update +-h,--help +Displays the help message. +--version +Output only the version information to the command line and terminate. +UPGRADE_OPTION +Argument that allows a specific major patch version to be specified. This option is used to view +the Feko component changes for a specific major patch version, their respective download size +and the release notes. UPGRADE_OPTION can be any of the following: +1-9 +latest +Indicates the major patch version. +This option selects the largest valid major patch version that has a repository. +--check [UPGRADE_OPTION] [[USER:PASSWORD@]PROXY[:PORT]] +The update utility checks if new versions are available. If UPGRADE_OPTION was not specified and +new versions are available, it will list the version and its associated UPGRADE_OPTION value. For +example: +Update/upgrade options are available (UPGRADE_OPTION): +0: Minor update to version 2022.3.0.1 +If the computer is behind a proxy server, the proxy server address and the login details can be +supplied as required. +--check-from LOCATION [UPGRADE_OPTION] +The update utility checks if new versions are available. Here the update source is the local +repository specified by LOCATION. If UPGRADE_OPTION was not specified and new versions are +available, it will list the version and its associated UPGRADE_OPTION value. +--update [USER:PASSWORD@]PROXY[:PORT]] +The update utility checks if new versions are available within the current patch major version +from the web repository. If an update is available, download and install the new version. If the +computer is behind a proxy server, the proxy server address and the login details can be supplied +as required. If updates are available, the following information is printed to the screen: +• Print each file which is being downloaded (only available when the update does not contain +many files). +• Print each file which is being updated (only available when the update does not contain many +files). +• Print a message stating that the update was successful and exit. +Altair Feko 2022.3 +12 Updater +--update-from LOCATION +p.138 +The update utility checks if new versions are available within the current patch major version +and installs the new version. Here the update source is the local repository specified by +LOCATION. The path must be an absolute file path which can point to an unmapped network +share (Windows), mapped (mounted) network share or a directory on a local drive that can +contain either extracted archives, multiple zipped archives or a single zipped archive. +--upgrade UPGRADE_OPTION [[USER:PASSWORD@]PROXY[:PORT]] +The update utility checks if new patch major versions are available from the web repository. If an +upgrade is available, download and install the new version. +--upgrade-from LOCATION UPGRADE_OPTION +The update utility checks if new patch major versions are available from the web repository. If an +upgrade is available, it will download and install the new version. Here the update source is the +local repository specified by LOCATION. The path must be an absolute file path which can point +to an unmapped network share (Windows), mapped (mounted) network share or a directory on a +local drive that can contain either extracted archives, multiple zipped archives or a single zipped +archive. +--no-progress +Suppress the download progress when updating from a web repository. +--no-proxy +Suppress the use of a proxy (including the system proxy). +12.3.1 Updating From a Local Repository (Command Line) +Download a new software update (or upgrade) from a local repository using the command line utility. +1. Open a command terminal using the Launcher utility. +2. Download the latest version using one of the following workflows: +• To update (if an update is available) within the current minor version, type: +feko_update --update-from LOCATION +• To upgrade to a new minor version, type: +feko_update --upgrade-from LOCATION VERSION +where LOCATION is either an absolute file path which can point to an unmapped network share +(Windows), mapped (mounted) network share or a directory on a local drive that can contain +either extracted archives, multiple zipped archives or a single zipped archive. +The version is the minor version that you would like to upgrade to and would usually be 1, 2 or 3, +but it is possible to use latest to upgrade to the latest version. +The command line updater has many options to check for updates without updating or update to +the latest version. Use the following command to see a list of options: +feko_update --help +12.4 Proxy Settings Overview +The feko_update_gui utility and feko_update utility (GUI and command line) use the system proxy by +default, although it may be changed or the use of a proxy suppressed. +Windows +The proxy used is the same as is used by Internet Explorer. The proxy can be specified or by using a +proxy auto-config (PAC) file. +Linux +The system proxy is defined by the environment variable http_proxy. If the environment variable +http_proxy is not defined, then no proxy will be used. +Suppressing the Use of a Proxy +The parameter --no-proxy bypasses the system settings and use a direct connection. +Figure 14: The Altair Feko update dialog - Settings tab. +12.5 Creating a Local Update Repository +Create a local Feko update repository to allow users to update without internet access or to limit the +list of update versions that users can use. Local update repositories can also be used to reduce the +amount of data being downloaded by downloading a repository once and making it available to many +local machines or compute clusters. +A local repository folder can be set up using: +• downloaded and extracted archives +• downloaded, zipped archives +1. Create the local repository folder, for example, C:\Updates. +2. +If you already have an update repository for the same version, delete previous updates located in +this local repository folder. +3. Download the updates for the required platforms from Altair Connect. +For example, if both the Windows and Linux platforms are required, download the following: +• FEKO_2022.3_WIN64_X86_64.zip +• FEKO_2022.3_LINUX_X86_64.zip +4. Create the repository using one of the following workflows: +• Unzip the downloaded archives to the local repository folder. The zip file contains a folder +structure which must be kept intact. Below is an example of the directory structure for the +two platforms after extracting the zip archives to C:\Updates: +C:\Updates + └─FEKO_2022.3 + └─WIN64_X86_64 + └─LINUX_X86_64 +Note: If multiple platforms are downloaded, the platform updates must be +located at the same folder (grouped by version) and “merged” as seen in the +example. +• Copy the zipped archives to the local repository without extracting the files. +Related tasks +Updating From a Local Repository (GUI) +Appendices +This chapter covers the following: +• A-1 Feko Environment Overview (p. 142) +• A-2 Terminal Script Files (p. 146) +• A-3 Remote Launching / Farming Setup (p. 147) +Feko Environment Overview +A-1 +A-1 Feko Environment Overview +The Feko environment is setup using the Lua scripting language and internal functions. The +A-1.1 Environment Settings Overview +The Feko environment is set up internally by means of Lua applications and internal functions +Each application is “self-aware”. It will detect and set up the environment based on its location. The +default environment for the current installation will be loaded from a set of mandatory files. Any user- +specific environment variables can then be added/changed in optional files loaded after the mandatory +files. It allows for the user-specific environment variables to overwrite the global environment variables, +rather than editing the file containing the global default environment variables +The Lua scripts are loaded in the following order: +1. FEKO_HOME/FEKOenvironmentFromSetup.lua +This mandatory file is created at installation time. It contains the global default settings for +the current installation. It is not advised to edit this file, unless a different setting is required +than specified during installation. +2. FEKO_HOME/FEKOenvironment.lua +This mandatory file is provided and managed by Feko to ensure correct functionality. This +file may be updated by the update utility, so any changes to it may be lost. +3. FEKO_USER_HOME/FEKOenvironment.lua +This is an optional file. It must be created by the user if and when required. +4. Windows: +%HOMEDRIVE%%HOMEPATH%\FEKOenvironment.lua +It must be created by the user if and when required. If it is not found, it will be silently +ignored and operation continues. +%HOMEDRIVE%%HOMEPATH%\FEKOenvironment.lua +It must be created by the user if and when required. If it is not found, it will be silently +ignored and operation continues. +%USERPROFILE%\FEKOenvironment.lua +It must be created by the user if and when required. If it is not found, it will be silently +ignored and operation continues. +Altair Feko 2022.3 +A-1 Feko Environment Overview +Linux: +$HOME/FEKOenvironment.lua +p.144 +It must be created by the user if and when required. If it is not found, it will be silently +ignored and operation continues. +5. FEKO_USER_ENV_INIFILE +It must be created by the user if and when required. If it is not found, it will be silently +ignored and operation continues. +A-1.2 Functions for Environment-Related Tasks +• getEnv(variable name, getExpanded) +Returns the value of the environment variable name. +Name +Description +variable name +Name of environment variable. (String) +getExpanded (optional) +true: If the value contains reference to other variables, get the +expanded value. (default) +false: Get the value as is with no extra expansion applied. +(Boolean) +return value +Value of the environment variable (might be nil, if not set) +(String) +• setEnv(variable name, value, forceOverwrite) +Modifies the environment variable variable name to the specified value. +Name +Description +variable name +Name of environment variable. (String) +value +Value to be prepended. +(String) +forceOverWrite +(optional) +parname: Always set the value. Overwrite if variable already +exists. +false: Only set the value if variable does not exist. (default) +(Boolean) +Name +Description +return value +- +• prependEnv(variable name, value, delimReq) +Prepends (or sets, if not exists) the environment variable variable name with the specified value. +Name +Description +variable name +Name of environment variable. (String) +value +Value to be prepended. +(String) +delimReq +(optional) +Delimiter character/string to be used to separate values when +concatenating (operating system default will be used, if not +exists) +(String) +return value +- +• appendEnv(variable name, value, delimReq) +Appends (or sets, if not exists) the environment variable variable name with the specified value . +Name +Description +variable name +Name of environment variable. (String) +value +Value to be appended. +(String) +delimReq +(optional) +Delimiter character/string to be used to separate values when +concatenating (operating system default will be used, if not +exists) +(String) +return value +- +Terminal Script Files +A-2 +A-2 Terminal Script Files +The files initfeko.bat (batch file on Windows) and initfeko (bash shell script on Unix/Linux) are run +from a terminal to configure the Feko environment. From this environment, the Feko applications can be +run. +Apply the settings to the current environment context: +• Windows: Call the batch file +• Linux: Source the shell script +The terminal script files are located in the FEKO_HOME/bin directory. +INITFEKO Environment Loader Script for Feko Terminal +Syntax: initfeko [-h | --help | /?] | [-v] [-d] [-terminal] +Options: +-h | --help | /? +Shows help (this screen) +-v Verbose mode (prints some informational output) +-d Shows extended debug output while setting the environment +-terminal +Mode to setup a complete standalone Feko Terminal +Windows: (used by the Start Menu shortcut) +Remote Launching / Farming +Setup +A-3 +A-3 Remote Launching / Farming Setup +View the steps for configuring either PuTTY or Cygwin to support the remote launching and farming +Altair Feko 2022.3 +A-3 Remote Launching / Farming Setup +A-3.1 Configuring PuTTY +p.148 +PuTTY is an SSH and telnet client for Windows and UNIX platforms. +PuTTY[14] requires no installation since it comes in a ZIP archive that is extracted into a directory. +1. Select one of the following workflows to prevent having to provide the full path: +• Place directory of your PuTTY installation in the system PATH environment variable. +• Extract PuTTY to the Feko bin directory. +2. Create a backup copy of feko_remote_ssh.bat before editing the file. +3. Modify the Feko remote launching file, feko_remote_ssh.bat. +a) Locate the line “set SSH=ssh” and change to “set SSH=plink”. +b) Locate the line “set SSH_OPTIONS=” and change to “set SSH_OPTIONS=-ssh -batch -l + -i ” +c) Locate the line set SCP=scp and change to “set SCP=pscp” +d) Locate the line “set SCP_OPTIONS=-p -B” and change to “set SCP_OPTIONS=-scp -p +-batch -l -i -unsafe” +e) Locate the line “set SCP_OPTIONS=-p -B -q” and change to “set SCP_OPTIONS=-scp -p +-batch -l -i -unsafe -q” where in the +above “” must be replaced by the real username to be used on the remote +system and “” must be the absolute path to the private key +file. +4. Convert the public key file from OpenSSH syntax to PuTTY syntax. This file has to be used in the +above commands. +5. Log into the remote machine once using an interactive PuTTY session. +6. Save the fingerprint to the registry to prevent the following error: “The server’s host key is +not cached in the registry.” +For additional options and configuration settings regarding the PuTTY suite, refer to the help screens of +PuTTY and the individual components. +14. http://www.chiark.greenend.org.uk/~sgtatham/putty/ +Altair Feko 2022.3 +A-3 Remote Launching / Farming Setup +A-3.2 Cygwin SSH Installation +p.149 +Cygwin SSH server is an emulation of the Linux environment and OpenSSH for Windows. Install the +SSH client on the client machine and server. Install the SSHd daemon on the server machine. +Setting Up SSH Client on Client and Server +Set up the SSH client on both the client machine and server. +1. Download setup.exe from www.cygwin.com. +2. Optional: Save the file to a shared location if it is to be used as a local repository. +3. Run setup.exe. +4. Select Install from Internet. If you are installing a second machine and use the same location, +you can select Install from Local Directory. +5. Use the default options when selecting the root install directory and installation parameters or +change according to your requirements. +Note: +• Do not use spaces in the directory name. +• The default settings are recommended. +6. Select a location to store the downloaded installation packages. If the file is to be re-used, save it +to the same location as setup.exe above. +7. Select the type of internet connection. Specify the Proxy host and Port. +8. Select a mirror close to you for maximum download speed. +9. Click View to change to Full. +a) Scroll down to openssh. +b) Click on the left-most icon to select openssh as well as openssl and their dependencies. +10. Wait while the packages download and install. +11. Optional: Choose if you want shortcuts to be created (recommended). +12. Click Finish to exit the installer. +Set the PATH environment variable to launch Cygwin without having to provide the full path. +13. Place the bin directory of your Cygwin installation in the system PATH environment variable. +14. Reboot the system. +Setting Up the SSH Server +Configure the SSHd deamon on the server (remote machine) to allow the client to connect to the server. +1. Open a Bash Shell found under Start > All Programs > Cygwin. +2. Ensure the files “/etc/passwd” and “/etc/group” are up to date (showing the correct entries as +to what is configured in Windows). Otherwise create them by: +mkpasswd -l > /etc/passwd +Altair Feko 2022.3 +A-3 Remote Launching / Farming Setup +mkgroup -l > /etc/grou +p.150 +3. Now configure the SSHd daemon/service by running “ssh-host-config”. Answer Yes to all +questions. When asked for the value of the CYGWIN variable, enter “ntsec tty”. +4. Start the service by “net start sshd” or “cygrunserv –start sshd”. +• To correct permission errors: +◦ Run the following commands to correct the permissions: +chmod +r /etc/passwd +chmod u+w /etc/passwd +chmod +r /etc/group +chmod u+w /etc/group +chmod 755 /var +chmod 664 /var/log/sshd.log +• To correct memory errors, the Cygwin DLLs have to be rebased by the following procedure: +1. Exit all Cygwin processes (close all windows of Cygwin and also stop all running services +of Cygwin). +2. Start a Microsoft Windows (!) command prompt (Start > Run > cmd.exe) with +administrative privileges. +3. Go to the Cygwin installation bin directory (“cd C:\Cygwin\bin”). +Inside ash then run “/usr/bin/rebaseall” and then close again. +4. +Troubleshooting +A-4 +A-4 Troubleshooting +A-4.1 Crash When Using CADFEKO Over Remote Desktop +Problem +Clicking on New Project when using CADFEKO over a remote desktop connection, results in a crash. +Cause +3D support for remote desktop is disabled for the host machine's graphics card. +Solution +1. Enable 3D support on host machine for remote desktop. +a) Open the Microsoft Windows Start menu. +b) Type Local Group Policy and click Edit group policy. +c) On the Local Group Policy Editor dialog, click Computer Configuration > +Administrative Templates > Windows Components > Remote Desktop Services > +Remote Desktop Session Host > Remote Session Environment. +d) Enable the following: +• Use the hardware default graphics adapters for all Remote Desktop Services sessions +• Prioritize H.264/AVC 444 graphics mode for Remote Desktop Connections +• Configure H.264/AVC hardware encoding for Remote Desktop Connections +• Configure compression for RemoteFX data +• Configure image quality for RemoteFX Adaptive Graphics +• Enable RemoteFX encoding for RemoteFX clients designed for Windows Server 2008 +R2 SP1 +• Configure RemoteFX Adaptive Graphics +Figure 15: The Local Group Policy Editor dialog in Microsoft Windows. +2. Download a special patch for NVIDIA graphics card drivers from https://community.altair.com/. +Index +ALM 87 +ALS 87 +Altair Feko 21 +Altair License Manager 87 +Altair License Server 87, 88 +Altair PBS Professional 117 +Altair WRAP 89 +ALTAIR_LICENSE_PATH 87 +appendEnv(variable name, value, delimReq) 143 +client machine setup +SSH method +Linux 126 +Windows 126 +cluster install 83 +connection 88 +Cygwin 126, 126 +end user license agreement (EULA) 40, 41, 43, 69, 70, 71 +environment variable 87 +EULA 40, 41, 43, 69, 70, 71 +farming +requirements 122 +Feko 21 +FEKO_USER_ENV_INIFILE 143 +FEKOenvironment.lua 143 +FEKOenvironmentFromSetup.lua 143 +response 40, 41, 43, 69, 70, 71 +file +getEnv(variable name, getExpanded) 143 +graphics card +OpenGL 14 +hardware 14 +IBM Platform LSF 117 +install +Altair WRAP 89 +Feko 21 +newFASANT 21 +WinProp 21 +ITS HF Propagation 100, 101 +job scheduler +Altair PBS Professional 117 +IBM Platform LSF 117 +Microsoft HPC Pack 117 +OpenPBS 117 +Parallelnavi NQS 117 +Torque 117 +Univa Grid Engine 117 +licence error 88 +licensing +Altair Units (AUs) 11 +local install +console mode 20 +GUI mode 20 +silent mode 20 +log file +uninstall 113 +machine +client 148 +message passing interface 123, 124 +Microsoft HPC Pack 117 +modify installation 105 +MPI 123, 124 +MPI method +user environment 124 +network share 124 +newFASANT 21 +NVIDIA 152 +OpenPBS 117 +OpenSSH 126 +OpenSSH for Windows 126, 126 +Parallelnavi NQS 117 +prependEnv(variable name, value, delimReq) 143 +PuTTY 126, 126, 148 +reconnecting 88 +remote desktop 152 +remote launching +requirements 122 +remote machine setup +MPI method +network share 124 +SSH method 126 +rendering +hardware 14 +software 14 +response file 40, 41, 43, 69, 70, 71 +screen resolution 14 +secure shell 123, 126 +setEnv(variable name, value, forceOverwrite) 143 +SLURM 117 +SSH 123, 126, 148 +SSH method +user environment 126 +student edition limitation +Feko 16 +newFASANT 17 +WinProp 18 +WRAP 19 +system requirements 12 +third-party installer +ITS HF Propagation 100 +Torque 117 +toubleshooting 151 +troubleshooting +remote desktop 152 +uninstall +Altair Feko 106 +Altair WRAP 114 +GUI mode (Linux) 107 +log file 113 +Univa Grid Engine 117, 117 +update +Feko 129 +newFASANT 129 +WinProp 129 +updater +automatic updates 135 +command line 138 +component version 131, 137 +create local repository 140 +feko_update_gui 131 +proxy settings 139 +update 132 +update from local repository 134 +upgrade 132 +version number 130 +WinProp 21 +WRAP +third-party installer 101 + +Intellectual Property Rights Notice +Copyright © 1986-2023 Altair Engineering Inc. All Rights Reserved. +This Intellectual Property Rights Notice is exemplary, and therefore not exhaustive, of intellectual +property rights held by Altair Engineering Inc. or its affiliates. Software, other products, and materials +of Altair Engineering Inc. or its affiliates are protected under laws of the United States and laws of +other jurisdictions. In addition to intellectual property rights indicated herein, such software, other +products, and materials of Altair Engineering Inc. or its affiliates may be further protected by patents, +additional copyrights, additional trademarks, trade secrets, and additional other intellectual property +rights. For avoidance of doubt, copyright notice does not imply publication. Copyrights in the below are +held by Altair Engineering Inc. or its affiliates. Additionally, all non-Altair marks are the property of their +respective owners. +This Intellectual Property Rights Notice does not give you any right to any product, such as software, +or underlying intellectual property rights of Altair Engineering Inc. or its affiliates. Usage, for example, +of software of Altair Engineering Inc. or its affiliates is governed by and dependent on a valid license +agreement. +Altair Simulation Products +Altair® AcuSolve® ©1997-2023 +Altair Activate® ©1989-2023 +Altair® Battery Designer™ ©2019-2023 +Altair Compose® ©2007-2023 +Altair® ConnectMe™ ©2014-2023 +Altair® EDEM™ ©2005-2023 +Altair® ElectroFlo™ ©1992-2023 +Altair Embed® ©1989-2023 +Altair Embed® SE ©1989-2023 +Altair Embed®/Digital Power Designer ©2012-2023 +Altair Embed® Viewer ©1996-2023 +Altair® ESAComp® ©1992-2023 +Altair® Feko® ©1999-2023 +Altair® Flow Simulator™ ©2016-2023 +Altair® Flux® ©1983-2023 +Altair® FluxMotor® ©2017-2023 +Altair® HyperCrash® ©2001-2023 +Altair® HyperGraph® ©1995-2023 +Altair® HyperLife® ©1990-2023 +p.iii +Altair Feko 2022.3 +Intellectual Property Rights Notice +Altair® HyperSpice™ ©2017-2023 +Altair® HyperStudy® ©1999-2023 +Altair® HyperView® ©1999-2023 +Altair® HyperViewPlayer® ©2022-2023 +Altair® HyperWorks® ©1990-2023 +Altair® HyperXtrude® ©1999-2023 +Altair® Inspire™ ©2009-2023 +Altair® Inspire™ Cast ©2011-2023 +Altair® Inspire™ Extrude Metal ©1996-2023 +Altair® Inspire™ Extrude Polymer ©1996-2023 +Altair® Inspire™ Form ©1998-2023 +Altair® Inspire™ Mold ©2009-2023 +Altair® Inspire™ PolyFoam ©2009-2023 +Altair® Inspire™ Print3D ©2021-2023 +Altair® Inspire™ Render ©1993-2023 +Altair® Inspire™ Studio ©1993-2023 +Altair® Material Data Center™ ©2019-2023 +Altair® MotionSolve® ©2002-2023 +Altair® MotionView® ©1993-2023 +Altair® Multiscale Designer® ©2011-2023 +Altair® nanoFluidX® ©2013-2023 +Altair® OptiStruct® ©1996-2023 +Altair® PollEx™ ©2003-2023 +Altair® PSIM™ ©2022-2023 +Altair® Pulse™ ©2020-2023 +Altair® Radioss® ©1986-2023 +Altair® romAI™ ©2022-2023 +Altair® S-FRAME® ©1995-2023 +Altair® S-STEEL™ ©1995-2023 +Altair® S-PAD™ ©1995-2023 +Altair® S-CONCRETE™ ©1995-2023 +Altair® S-LINE™ ©1995-2023 +Altair® S-TIMBER™ ©1995-2023 +p.iv +Altair Feko 2022.3 +Intellectual Property Rights Notice +Altair® S-FOUNDATION™ ©1995-2023 +Altair® S-CALC™ ©1995-2023 +Altair® S-VIEW™ ©1995-2023 +Altair® Structural Office™ ©2022-2023 +Altair® SEAM® ©1985-2023 +Altair® SimLab® ©2004-2023 +Altair® SimLab® ST ©2019-2023 +Altair SimSolid® ©2015-2023 +Altair® ultraFluidX® ©2010-2023 +Altair® Virtual Wind Tunnel™ ©2012-2023 +Altair® WinProp™ ©2000-2023 +Altair® WRAP™ ©1998-2023 +Altair® GateVision PRO™ ©2002-2023 +Altair® RTLvision PRO™ ©2002-2023 +Altair® SpiceVision PRO™ ©2002-2023 +Altair® StarVision PRO™ ©2002-2023 +Altair® EEvision™ ©2018-2023 +Altair Packaged Solution Offerings (PSOs) +Altair® Automated Reporting Director™ ©2008-2022 +Altair® e-Motor Director™ ©2019-2023 +Altair® Geomechanics Director™ ©2011-2022 +Altair® Impact Simulation Director™ ©2010-2022 +Altair® Model Mesher Director™ ©2010-2023 +Altair® NVH Director™ ©2010-2023 +Altair® NVH Full Vehicle™ ©2022-2023 +Altair® NVH Standard™ ©2022-2023 +Altair® Squeak and Rattle Director™ ©2012-2023 +Altair® Virtual Gauge Director™ ©2012-2023 +Altair® Weld Certification Director™ ©2014-2023 +Altair® Multi-Disciplinary Optimization Director™ ©2012-2023 +Altair HPC & Cloud Products +Altair® PBS Professional® ©1994-2023 +Altair® PBS Works™ ©2022-2023 +p.v +Altair Feko 2022.3 +Intellectual Property Rights Notice +Altair® Control™ ©2008-2023 +Altair® Access™ ©2008-2023 +Altair® Accelerator™ ©1995-2023 +Altair® Accelerator™ Plus ©1995-2023 +Altair® FlowTracer™ ©1995-2023 +Altair® Allocator™ ©1995-2023 +Altair® Monitor™ ©1995-2023 +Altair® Hero™ ©1995-2023 +Altair® Software Asset Optimization (SAO) ©2007-2023 +Altair Mistral™ ©2022-2023 +Altair® Grid Engine® ©2001, 2011-2023 +Altair® DesignAI™ ©2022-2023 +Altair Breeze™ ©2022-2023 +Altair® NavOps® ©2022-2023 +Altair® Unlimited™ ©2022-2023 +Altair Data Analytics Products +Altair Analytics Workbench™ © 2002-2023 +Altair® Knowledge Studio® ©1994-2023 +Altair® Knowledge Studio® for Apache Spark ©1994-2023 +Altair® Knowledge Seeker™ ©1994-2023 +Altair® Knowledge Hub™ ©2017-2023 +Altair® Monarch® ©1996-2023 +Altair® Panopticon™ ©2004-2023 +Altair® SmartWorks™ ©2021-2023 +Altair SLC™ ©2002-2023 +Altair SmartWorks Hub™ ©2002-2023 +Altair® RapidMiner® ©2001-2023 +Altair One™ ©1994-2023 +2022.3 +March 17, 2023 +Technical Support +Altair provides comprehensive software support via web FAQs, tutorials, training classes, telephone, and +e-mail. +Altair One Customer Portal +Altair One (https://altairone.com/) is Altair’s customer portal giving you access to product downloads, a +Knowledge Base, and customer support. We recommend that all users create an Altair One account and +use it as their primary portal for everything Altair. +When your Altair One account is set up, you can access the Altair support page via this link: +www.altair.com/customer-support/ +Altair Community +Participate in an online community where you can share insights, collaborate with colleagues and peers, +and find more ways to take full advantage of Altair’s products. +Visit the Altair Community (https://community.altair.com/community) where you can access online +discussions, a knowledge base of product information, and an online form to contact Support. After you +login to the Altair Community, subscribe to the forums and user groups to get up-to-date information +about release updates, upcoming events, and questions asked by your fellow members. +These valuable resources help you discover, learn and grow, all while having the opportunity to network +with fellow explorers like yourself. +Altair Training Classes +Altair’s in-person, online, and self-paced trainings provide hands-on introduction to our products, +focusing on overall functionality. Trainings are conducted at our corporate and regional offices or at your +facility. +For more information visit: https://learn.altair.com/ +If you are interested in training at your facility, contact your account manager for more details. If you +do not know who your account manager is, contact your local support office and they will connect you +with your account manager. +Telephone and E-mail +If you are unable to contact Altair support via the customer portal, you may reach out to technical +support via phone or e-mail. Use the following table as a reference to locate the support office for your +region. +Altair support portals are available 24x7 and our global support engineers are available during normal +Altair business hours in your region. +When contacting Altair support, specify the product and version number you are using along with +a detailed description of the problem. It is beneficial for the support engineer to know what type +of workstation, operating system, RAM, and graphics board you have, so include that in your +Altair Feko 2022.3 +Technical Support +p.vii +Location +Australia +Brazil +Canada +China +France +Germany +Greece +India +Israel +Italy +Japan +Malaysia +Mexico +New Zealand +South Africa +South Korea +Spain +Sweden +Telephone +E-mail ++61 3 9866 5557 +anzsupport@altair.com ++55 113 884 0414 +br_support@altair.com ++1 416 447 6463 +support@altairengineering.ca ++86 400 619 6186 +support@altair.com.cn ++33 141 33 0992 +francesupport@altair.com ++49 703 162 0822 +hwsupport@altair.de ++30 231 047 3311 +eesupport@altair.com ++91 806 629 4500 +support@india.altair.com ++1 800 425 0234 (toll free) ++39 800 905 595 +support@altairengineering.it +israelsupport@altair.com ++81 3 6225 5830 +jp-support@altair.com ++60 32 742 7890 +aseansupport@altair.com ++52 55 5658 6808 +mx-support@altair.com ++64 9 413 7981 +anzsupport@altair.com ++27 21 831 1500 +support@altair.co.za ++82 704 050 9200 +support@altair.co.kr ++34 910 810 080 +support-spain@altair.com ++46 46 460 2828 +support@altair.se +United Kingdom ++44 192 646 8600 +support@uk.altair.com +United States ++1 248 614 2425 +hwsupport@altair.com +If your company is being serviced by an Altair partner, you can find that information on our web site at +https://www.altair.com/PartnerSearch/. +See www.altair.com for complete information on Altair, our team, and our products. +Introduction to Feko +1 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. +This chapter covers the following: +• 1.1 Feko Overview (p. 23) +• 1.2 Feko Applications (p. 26) +• 1.3 How to Get Started (p. 34) +Altair Feko 2022.3 +1 Introduction to Feko +1.1 Feko Overview +p.23 +Feko is a comprehensive computational electromagnetics (CEM) software product used widely in the +telecommunications, automotive, aerospace and defense industries. +The name Feko is an abbreviation derived from the German phrase “FEldberechnung bei Körpern mit +beliebiger Oberfläche” (field computations involving bodies of arbitrary shape). As the name suggests, +Feko can be used for various types of electromagnetic field analyses involving objects of arbitrary +shapes. Feko offers several frequency domain electromagnetic (EM) solution methods as well as a +time domain method under a single license. Hybridisation of these methods enables efficient analysis +of a broad spectrum of EM problems, including antennas, microstrip circuits, radio frequency (RF) +components and biomedical systems, the placement of antennas on electrically large structures, the +calculation of scattering (RCS), as well as the investigation of electromagnetic compatibility (EMC). +Feko offers tools that are tailored to solve the more challenging EM interactions, including dedicated +solvers for characteristic mode analysis (CMA) and bi-directional cables coupling. Special formulations +are included for efficient simulation of integrated windscreen antennas and antenna arrays. +Combined with the multilevel fast multipole method (MLFMM), and true hybridisation of the solvers, +Feko is considered the global market leader for antenna placement analysis. +Figure 1: Illustration of the numerical analysis techniques in Feko. +Solver Overview +The Solver supports the following solution methods: +• Full wave frequency domain solution methods: +◦ MoM (method of moments) +◦ FEM (finite element method) +◦ MLFMM (multilevel fast multipole method) +• Full wave time domain solution methods: +◦ FDTD (finite difference time domain) +• Asymptotic solution methods: +◦ PO (physical optics) +◦ LE-PO (large element physical optics) +◦ RL-GO (ray launching geometrical optics) +◦ UTD (uniform theory of diffraction) +CPU Parallelisation for Shared and Distributed Memory Systems +In Feko, true distributed computing and “farming” parallelisation of simulation are two distinct concepts. +• With true distributed computing, any particular solution (for example, a single frequency) can +be parallelised across multiple nodes. This is achieved via rigorous MPI-based parallelisation for +clusters and shared memory computers. The efficiency of the parallelisation is improved by limiting +the MPI interaction between processes. +• Farming assigns individual optimisation iterations to separate CPU cores, while not distributing the +solution of the iterations. +Efficiency in Feko is further boosted by integration for different high speed networking technologies such +as Gigabit Ethernet and Infiniband. +• For multiple cores of a single CPU, OpenMP technology is used for parallelisation. +• For clusters or shared memory multi-CPU servers, select memory blocks are copied between +processes. Communication is reduced and simulation time decreased, but a penalty is paid in terms +of memory efficiency. +• In contrast, the cores of multi-core CPUs address the same memory block much faster than in +shared memory multi-CPU systems. OpenMP parallelisation of Feko for multi-core CPUs make use +of this fact to reduce memory requirements. +MPI and OpenMP distributed parallelisation methods are hybridised in Feko to harness the strengths of +both schemes. +GPU Acceleration +Feko supports the use of multiple GPUs for simulation acceleration using the unified device architecture +(CUDA) framework from NVIDIA. The computational phases targeted for execution on CUDA-based +GPUs show a significant speedup when compared to standard CPU-based execution. +Optimisation +Feko offers state-of-the-art optimisation engines based on genetic algorithm (GA) and other +methods, which can be used to automatically optimise the design and determine the optimum +solution. Furthermore, for advanced design exploration, the interface to Altair HyperStudy offers a +comprehensive post-processing functionality (including trade off analysis and stochastics). +User Interface +The Feko components with a graphical user interface (CADFEKO, EDITFEKO and POSTFEKO) make +use of a ribbon driven interface that focusses on improved efficiency of workflow. CADFEKO supports +parametric model construction. Complex geometry models and mesh models can be imported or +exported in a wide range of industry standard formats. Use the application programming interface (API) +to control CADFEKO or POSTFEKO from an external script or to automate repetitive and mundane tasks. +Updater +Feko has an updater utility that allows you the flexibility to install an update containing new features, +minor software enhancements and bug fixes on top of an existing base installation. +Altair Units +Feko is part of the Altair Units based licensing system which allows metered usage of the entire Altair +suite of products. This value-based licensing model has been extended to Altair's extensive partner +network, providing the most comprehensive and dynamic set of solutions to the market. +Altair Feko 2022.3 +1 Introduction to Feko +1.2 Feko Applications +p.26 +Feko is applicable to a wide range of applications in electromagnetic engineering. +The wide range of applications can be attributed to the support for various solution methods and the +hybridisation of the methods. No single solution methods is applicable to the full frequency range +and model complexity. Feko is uniquely positioned to efficiently solve models with a wide range of +complexities and size. +Figure 2: Illustration of the applications of Feko. +Feko is used in, but not limited to, the following applications: +Antenna design +Analysis of wide-ranging antenna. Examples include wireless communication devices and systems +(FM, GPS, 3G, TV, LTE and MIMO), reflector antenna, antennas for radars, antennas with radomes +and many more. +Antenna placement +Analysis of antenna and the interaction with electrically large environments. Examples include +antennas on vehicles, aircraft, satellites, ships, cellular base-stations, including radiation patterns, +co-site interference and RADHAZ analysis. +Electromagnetic compatibility (EMC) analysis +Analysis which involve cables, which either radiate through imperfect shields and cause coupling +into other cables, devices or antennas, or which receive (irradiation) external electromagnetic +fields (radiated from antennas or leaked through other devices) and then cause disturbance +voltages and currents potentially resulting in a malfunctioning of the system. +Altair Feko 2022.3 +1 Introduction to Feko +Radar cross section / scattering +p.27 +Analysis and scattering of large metallic / dielectric and composite structures, for example, +aircraft, vehicles, tanks, ships, buildings and wind turbines. +Radomes +Analysis of complex shapes, multi-layer and electrically large structures. +Waveguides +Analysis of complex waveguide components, for example, waveguide filters and couplers. +Bio-electromagnetics +Analysis of human-structure interaction, for example, hearing aids, active and passive implants +using pacemakers, neural implants, stents and microwave imaging technologies. +Microstrip circuits +Analysis using optimised formulations for layered media, for example, microstrip antenna array +and split ring resonators. +Special materials +Analysis of frequency selective surfaces (FSS), anisotropic materials (for example, carbon fiber) +and metamaterials. +1.2.1 Antenna Design +Feko’s broad range of solution methods technologies makes it applicable to solve a range of different +antenna types. +For example, the method of moments (MoM) solver is well suited to solve metallic antennas while the +finite difference time domain (FDTD) method is a better choice for broadband or multi-band antennas. +Typical antennas types including wire antennas, microstrip antennas, horn and aperture antennas with +lenses, broadband and multi-band antennas, multiple-input and multiple-output (MIMO) designs for +wireless communications, reflectors, phased arrays and conformal antennas. +Key features: +• Variety of accurate, powerful and reliable 3D electromagnetic (EM) solution methods, including +dedicated tools for designing windscreen antennas. +• Unique characteristic mode analysis (CMA) solver for intelligent design. +• Dedicated tools for antenna arrays including periodic boundary condition (PBC) for repeating +structures and domain Green’s function method (DGFM) for large, but finite arrays. +• Parametric modelling and a powerful optimisation engine. +Figure 3: A base station antenna including supporting mast (on the left) and a log periodic antenna (to the right). +1.2.2 Antenna Placement +It is often necessary to understand (and optimise) how an antenna's performance is influenced by the +structure (for example, an aeroplane, vehicle or ship) it is mounted on. +The electrically large nature of the structures that need to be considered make them challenging to +simulate. Feko’s solver offering make it the leading tool for antenna placement and co-site interference +analysis. +Key features: +• multilevel fast multipole method (MLFMM) for the efficient simulation of electrically large platforms. +• True hybridised, asymptotic solvers for simulation of electrically very large platforms. +• Model decomposition allows equivalent representation of transmit / receive antenna to reduce +computational requirements. +• Unique characteristic mode analysis (CMA) solver for understanding placement aspects. +Figure 4: Wireless antenna placement in a vehicle (on the left) and co-site interference analysis for a naval +platform (to the right). +1.2.3 Radar Cross Section / Scattering +The scattering performance of an object describes how energy is scattered when the object is exposed +to incident electromagnetic fields. +Applications include mono- and bi-static radar cross sections of defence platforms, scattering from wind +turbines and optimisation of other radar systems like automotive collision detection systems. Feko’s +high frequency methods are used to solve these typically electrically large, platforms. +Key features: +• The multilevel fast multipole method (MLFMM) is used to efficiently simulate electrically large +platforms. +• True hybridised, asymptotic solvers for simulation of electrically very large platforms. +• Model decomposition allows equivalent representation of transmitter / receiver antennas to reduce +computational requirements. +Figure 5: RCS calculation for a helicopter. +1.2.4 Electromagnetic Compatibility (EMC) Analysis +Electromagnetic compatibility (EMC) analysis is not only used to predict emission and immunity +performance, but also in the product design phase to mitigate problems due to external or co-site +interfaces. +Feko is used extensively for immunity and radiated emissions testing, shielding effectiveness, noise +coupling, radiation hazard (RADHAZ) analysis, electromagnetic pulses (EMP), lightning analysis, high +intensity radiated fields (HIRF), reverberation and anechoic chamber simulations. +Key features: +• Efficient solvers enable simulation of EMC tests including device under test (DUT) and the test +environment. +• Specialised cable modelling and solver tool, to analyse inter-cable coupling, and coupling between +cables and antennas or other devices. +• Model decomposition uses equivalent representation of electronic control units in emission tests to +reduce computational requirements. +• Time analysis tools to investigate the time domain behaviour in lightning, EMP and noise coupling. +Figure 6: Simulation of an anechoic chamber with antenna under test (AUT). +1.2.5 Waveguides +Feko is well suited to the simulation and optimisation of waveguide components. Due to the typically +metallic structures, they can be analysed accurately and efficiently with the method of moments (MoM) +and finite element method (FEM) solvers. +Applications include waveguide filters, couplers, circulators, diplexers and multiplexers. Waveguides are +also used to feed certain antennas. +Key features: +• Efficient solvers suited to simulating typical waveguide geometries. +• S-parameter analysis, import / export of Touchstone files and general network blocks for circuit +representation. +• Parametric model creation using canonical shapes through GUI or scripting, and extensive CAD +import support. +Figure 7: Ku-band waveguide filter. +Altair Feko 2022.3 +1 Introduction to Feko +1.2.6 Radomes +p.31 +Although radomes are designed to be transparent, they typically have some small effect on the antenna +performance which needs to be quantified. +This can be challenging because they are generally electrically large structures, often consisting of +multiple thin dielectric layers. Feko offers a range of features and methods that are well suited to +simulation of radomes. +Key features: +• The multilevel fast multipole method (MLFMM) for the efficient simulation of electrically large +platforms. +• True hybridised, asymptotic solvers for simulation of electrically very large platforms. +• Efficient treatment of thin dielectric layers and coatings. +• Model decomposition for equivalent representation of antennas to reduce computational +requirements. +Figure 8: Various radome designs for plane nose cones. +1.2.7 Bio-Electromagnetics +Electromagnetic simulation plays a key role in designing products and investigating safety aspects for +healthcare systems, which often include wireless telemetry. +Applications include wireless bio-sensors, implanted devices like pacemakers and neuro-stimulators, +and MRI systems. Feko’s broad solver offering allows the most efficient method to be used for each +task: MoM at early design stages with homogeneous phantoms; finite difference time domain (FDTD) +or finite element method (FEM) for final analysis with anatomical phantoms. Use uniform theory of +diffraction (UTD) and FEM for investigation of effects on large structures. +Key features: +• Efficient simulation with the most suitable solvers and cross-validation strategies. +• Spatial peak specific absorption rate (SAR) and other relevant post-processing performance +parameters. +• Free anatomical models available directly from Feko; other models available from various partners. +Figure 9: A seven Tesla magnetic resonance (MRI) head coil with anatomical head phantom (on the left) and a +three Tesla spinal MRI array (to the right). +1.2.8 Special Materials +Synthetic materials like composites are used increasingly in product design. +In some cases the material is chosen intentionally to influence how the structure interacts with an +incident electromagnetic (EM) field. It is therefore important that these materials can be modelled +accurately. Feko offers a range of different features that consider these special materials. +Key features: +• Efficient solution methods for periodic structures like frequency selective surfaces (FSS). +• Meta-materials, composites (for example, carbon fiber), metals, dispersive and anisotropic +dielectrics. +• Special approximations for coatings and thin dielectric sheets. +Figure 10: A meta-material resonator. +Altair Feko 2022.3 +1 Introduction to Feko +1.2.9 Microstrip Circuits +p.33 +Feko offers tools for microstrip circuit design and analysis of filters, resonators, couplers, passive +components like spiral inductors, or even complex feed structures for array antennas. +Key features: +• Efficient treatment of multilayer substrates with the planar Green’s function. +• Efficient analysis of wideband responses of circuits with the finite difference time domain (FDTD) +solver. +• S-parameter analysis, import / export of Touchstone files and general network blocks for circuit +representation. +• Parametric model creation using canonical shapes through graphical user interface (GUI) or +scripting, and extensive computer-aided design (CAD) import support. +Figure 11: Various microstrip circuit elements and filters. +1.3 How to Get Started +If you are new to Feko, take the following steps to learn about Feko. +1. Watch the videos in the Feko installation directory: +• Tour and demo +• CADFEKO introduction +• POSTFEKO introduction +2. The Quick tips highlights the essential information regarding the CADFEKO and POSTFEKO +environments. +• Quick tips for CADFEKO +• Quick tips for POSTFEKO +3. The Feko Getting Started Guide contains step-by-step instructions on how to create CADFEKO +geometry, request calculations, mesh the geometry, run the Solver and view the results in +POSTFEKO. +4. The Feko Example Guide contains examples that show the application of features as discussed +in the Feko User Guide. The Feko Example Guide assumes you are familiar with interface and +focusses on solving more realistic problems. Find an example close to a problem of interest and +follow the steps to solve the problem. +5. The Feko User Guide contains information regarding Feko and its features. +6. The Feko Scripting and API Reference Guide contains information regarding scripting, macro +recording, and CADFEKO and POSTFEKO application programming interface (API). +7. The Feko Errors, Warnings and Notes Reference Guide is a reference for messages that may +be encountered in Feko. +8. The Altair web site[2], provides additional resources as well as online training (self-paced +training). +9. The Altair Community[3] allows you to post a question or view answers from previous posts. Join +the active forum community to get email notifications of new content. +2. https://www.altair.com/feko +3. https://community.altair.com +1.4 About This Manual +The Feko User Guide is part of the Feko documentation and is an extensive reference guide to using +Feko. +If you are a beginner user, you are recommended to view the Feko Getting Started Guide. +1.4.1 Purpose of This User Guide +The Feko User Guide provides guidance, best practices and comprehensive technical information +regarding the key concepts in Feko. +1.4.2 Document Conventions +The Feko User Guide, makes use of a number of conventions to help you quickly learn about Feko. +• Hyperlinks are indicated in blue. +• Text cited from the GUI interface, are written in bold text, for example, the Add button. +• A combination of keystrokes are joined with the “+” sign, for example, Alt+0. +• To draw your attention to important information, the information is marked as a note, tip or +warning, for example: +Note: This is a note to draw your attention to critical information. +1.4.3 Feedback +We value your feedback regarding the Feko components and the documentation. +If you have comments or suggestions regarding the Feko component and the documentation, please +send an email to support@altair.co.za or contact your local Altair representative. +CADFEKO +2 CADFEKO +CADFEKO is used to create and mesh the geometry or model mesh, specify the solution settings and +calculation requests in a graphical environment. +This chapter covers the following: +• 2.1 Introduction to CADFEKO (p. 38) +• 2.2 Quick Tour of the CADFEKO Interface (p. 44) +• 2.3 Preferences (p. 69) +• 2.4 Saving a Model (p. 70) +• 2.5 3D View (p. 71) +• 2.6 Model Protection (p. 83) +• 2.7 Model Definitions (p. 86) +• 2.8 Constructing Geometry (p. 94) +• 2.9 Component Library (p. 145) +• 2.10 Groups (p. 151) +• 2.11 Repairing Geometry (p. 153) +• 2.12 Repairing Mesh Parts (p. 166) +• 2.13 Importing Models into CADFEKO (p. 169) +• 2.14 Exporting Models from CADFEKO (p. 181) +• 2.15 Field/Current Data (p. 185) +• 2.16 Defining Media (p. 197) +• 2.17 Applying Media Settings (p. 219) +• 2.18 Periodic Boundary Condition (PBC) (p. 230) +• 2.19 Finite Antenna Arrays (p. 233) +• 2.20 Windscreen Tools (p. 240) +• 2.21 Cables (p. 250) +• 2.22 Solution Frequency (p. 306) +• 2.23 Power (p. 310) +• 2.24 Ports (p. 312) +• 2.25 Sources (p. 333) +• 2.26 Loads and Non-Radiating Networks (p. 347) +• 2.27 Multiple Configurations (p. 356) +• 2.28 Requesting Calculations (p. 365) +• 2.29 Infinite Planes and Half-Spaces (p. 384) +• 2.30 Meshing the Geometry / Model Mesh (p. 388) +Altair Feko 2022.3 +2 CADFEKO +• 2.32 Validating the CADFEKO Model (p. 410) +• 2.33 Solver Settings (p. 420) +• 2.34 Component Launch Options (p. 450) +• 2.35 Tools (p. 455) +• 2.36 Model Tree Icons (p. 459) +• 2.37 Details Tree Icons (p. 461) +• 2.38 Files Generated by CADFEKO (p. 462) +• 2.39 Default Shortcut Keys (p. 463) +p.37 +2.1 Introduction to CADFEKO +Use CADFEKO to configure a solver-ready input file for Solver simulations. +CADFEKO is the Feko component that allows you to create complex CAD geometry using primitive +structures (for example, cuboids and polygons) and to perform Boolean operations (for example, +union and subtract) on the geometry. Complex geometry models and mesh models can be imported or +exported in a wide range of industry standard formats. Reduce development time by using a component +from the list of antennas and platforms in the component library. +In CADFEKO, you can request multiple solution configurations, specify calculation requests as well as +specify the solution settings for the model. If an optimisation search is required, you can specify the +optimisation parameters and goals. +You can generate triangular surface meshes or volume meshes (tetrahedra or voxels) from CAD or +mesh parts. The type of mesh generated depends on the solution methods being used. +2.1.1 Feko Components and Workflow +View the typical workflow when working with the Feko components. +Use CADFEKO +Create / modify +geometry +Set soluon sengs +or add component +from +component library +Define frequency, +sources and requests +Run Feko Solver +Use POSTFEKO +Create new +graph / display +Add / view results +Post-processing of +results / scripng +Export results / +generate report +CADFEKO +Create or modify the geometry (or model mesh) in CADFEKO, import geometry or mesh, or use a +component from the component library. Apply solution settings, define the frequency, specify the +required sources and request calculations. +When the frequency is specified or local mesh settings are applied, the automatic mesh algorithm +calculates and creates the mesh to obtain a discretised representation of the geometry or model mesh. +View the status of the model in the Notification centre. If any warnings or errors are given, correct the +model before running the Solver. +Altair Feko 2022.3 +2 CADFEKO +Solver +p.39 +Run the Solver to calculate the specified output requests. +POSTFEKO +Create a new graph or 3D view and add results of the requested calculations on a graph or 3D view. +Results from graphs can be exported to data files or images for reporting or external post-processing. +Reports can be created that export all the images to a single document or a custom report can be +created by configuring a report template. +After viewing the results, it is often required to modify the model again in CADFEKO and then repeat the +process until the design is complete. +2.1.2 Launching CADFEKO (Windows) +There are several options available to launch CADFEKO in Windows. +Launch CADFEKO using one of the following workflows: +• Open CADFEKO using the Launcher utility. +Figure 12: The Launcher utility. +• Open CADFEKO by double-clicking on a .cfx file. +• Open CADFEKO from other components, for example, from inside POSTFEKO or EDITFEKO. +Note: If the application icon is used to launch CADFEKO, no model is loaded and the +start page is shown. Launching CADFEKO from other Feko components automatically +loads the model. +Related tasks +Opening the Launcher Utility (Windows) +2.1.3 Launching CADFEKO (Linux) +There are several options available to launch CADFEKO in Linux. +Launch CADFEKO using one of the following workflows: +• Open CADFEKO using the Launcher utility. +• Open a command terminal. Use the absolute path to the location where the CADFEKO executable +resides, for example: +/home/user/2022.3/altair/feko/bin/cadfeko +• Open a command terminal. Source the “initfeko” script using the absolute path to it, for example: +. /home/user/2022.3/altair/feko/bin/initfeko +Sourcing initfeko ensures that the correct Feko environment is configured. Type cadfeko and +press Enter. +Note: Take note that sourcing a script requires a dot (".") followed by a space (" ") and +then the path to initfeko for the changes to be applied to the current shell and not a +sub-shell. +Related tasks +Opening the Launcher Utility (Linux) +2.1.4 Command Line Arguments for Launching CADFEKO +CADFEKO can be called via the command line. Use command line arguments to pass configuration +information to CADFEKO. +If CADFEKO is launched and a file is specified, the model or .lua script is opened. Without any models +specified, CADFEKO will start and display the start page. +Command-line options: +cadfeko [FILENAME] [OPTIONS] +FILENAME +Name of the .cfx or .lua file to load. If the model does not exist, a new empty model is created +with this name. +OPTIONS +-h, --help +Displays the help message. +--version +Print the version information and then exit. +--non-interactive +Special execution mode for running automation scripts without user interaction. +--run-script SCRIPTFILE +Specifies an automation script to load and run. +--configure-script CONFIGSTRING +Executes the string CONFIGSTRING before running the script specified in SCRIPTFILE. This +option is only used with the “non-interactive” option. +--file-info [=OUTPUTFORMAT] FILENAME.CFX +Display the CADFEKO versions used to create and modify the file. +cadfeko startup.cfx --file-info[4] +cadfeko startup.cfx --non-interactive --file-info |more[5] +cadfeko startup.cfx --non-interactive --file-info > versions.txt[6] +=OUTPUTFORMAT +Optional argument that is used to specify the output format. If the argument is set +to xml, version information is written out in XML format. XML will only be output to +stdout, and only if --non-interactive was also specified. +cadfeko startup.cfx --file-info=xml --non-interactive | more[7] +2.1.5 Start Page +The Feko start page is displayed when starting a new instance (no models are loaded) of CADFEKO, +EDITFEKO or POSTFEKO. +The start page provides quick access to Create a new model, Open an existing model, and a list of +Recent models. +Links to the documentation (in PDF format), introduction videos and website resources are available on +the start page. Click the + icon to launch the Feko help. +4. Opens a dialog and displays the version information. +5. Writes the version information out to standard output stream (stdout). +6. Redirects the version information to the specified file. +7. Writes the version information in XML format in non-interactive mode, displaying the content one + screen at a time. +Figure 13: The CADFEKO start page. +2.2 Quick Tour of the CADFEKO Interface +View the main elements and terminology in the CADFEKO application window. +Figure 14: The CADFEKO window. +1. Quick access toolbar +2. Ribbon +3. Configuration list +4. Model tree +5. Details tree +6. Status bar +7. Model Status +8. Notes view +9. Notification Centre +10. 3D view +11. Help +12. Search bar +Altair Feko 2022.3 +2 CADFEKO +13. Application launcher +p.45 +2.2.1 Quick Access Toolbar +The quick access toolbar is a small toolbar that gives quick access to actions that are often performed. +The toolbar is located at the top-left corner of the application window, just below the title bar. It allows +you to create a new model, open a model, save a model, undo a model operation or redo a model +operation using fewer mouse clicks for a faster workflow. The actions available on the quick access +toolbar are also available via the ribbon. +2.2.2 Ribbon +The ribbon is a command bar that groups similar actions in a series of tabs. +Figure 15: The ribbon in CADFEKO. +1. File menu +The File menu is the first item on the ribbon. The menu allows saving and loading of models, +import and export options as well as giving access to application-wide settings and a recent file +list. +2. Core tabs +A tab that is always displayed on the ribbon, for example, the Home tab and Construct tab. +The Home tab is the first tab on the ribbon and contains the most frequently used commands for +quick access. +3. Contextual tab sets +A tab that is only displayed in a specific context. +For example, the Schematic contextual tab set contains the Network Schematic contextual +tab. Contextual tabs appear and disappear as the selected items such as a view or item on a view, +change. +4. Ribbon group +A ribbon tab consists of groups that contain similar actions or commands. +5. Dialog launcher +Click the dialog launcher to launch a dialog with additional and advanced settings that relate to +that group. Most groups don't have dialog launcher buttons. +Altair Feko 2022.3 +2 CADFEKO +Keytips +p.46 +A keytip is the keyboard shortcut for a button or tab that allows navigating the ribbon using a +keyboard (without using a mouse). Press F10 to display the keytips. Type the indicated keytip to +open the tab or perform the selected action. +Figure 16: An example of keytips. +Application Menu +The application menu is similar to a standard file menu of an application. It allows saving and loading of +models, print functionality and gives access to application-wide settings. +When you click on the application menu drop-down button, the application menu, consisting of two +panels, is displayed. +The first panel gives you access to application-wide settings, for example: +• Creating a new model. +• Opening a model, saving a model and closing a model. +• Component library +• Archive +• Import +• Export +• Print +• Check for updates +• Settings +◦ Preferences +◦ Colour settings (for example, preview colour and background colour) +◦ 3D mouse sensitivity setting +◦ Snapping settings (when Ctrl+Shift is used) +◦ Rendering options (for example, rendering mode and transparency mode) +◦ Model unit +◦ Model extents +◦ Solver settings +◦ Component launch options +◦ Tabs on the ribbon +• Feko help +• About +◦ Version information about CADFEKO +Information about Altair Simulation Products +Information about third-party libraries +◦ +◦ +• Exit +The second panel consists of a recent file list and is replaced by a sub-menu when a menu item is +selected. +Figure 17: The application menu in CADFEKO. +Home Tab +The Home tab is the first tab on the ribbon and contains the most frequently used operations. +Figure 18: The Home tab in CADFEKO. +2.2.3 Configuration List +The configuration list displays all configurations in the model. +The panel is located to the left of the application window, just below the ribbon. A new model starts by +default with a single standard configuration. The following configuration types are supported: +• Standard configuration +• Multiport S-parameter configuration +• Characteristic modes configuration. +Tip: Multiple configurations allow you to perform efficient simulations using different +configurations (different loads or sources) in a single model. +2.2.4 Model Tree +The model tree contains the variables, named points, the model-creation hierarchy, ports and +configuration-specific items of the model. The model tree is split between construction and configuration +items. +The panel is located below the configuration list and contains a Construct tab and Configuration tab. +Variables, media and named points are listed in both the Construct tab and the Configuration tab to +provide quick access. A right-click context menu is available for all items in the model tree. Double-click +on an item to open its properties. +Altair Feko 2022.3 +2 CADFEKO +Construction Tab +p.49 +The Construction tab contains the geometry and mesh representation of the current model in a tree +structure. It also lists ports and the optimisation configuration. +The tree contains a Definitions branch, Model branch and Optimisation branch. +Figure 19: The Construction tab in the model tree. +Definitions Branch +The Definitions branch contains by default the predefined variables, named points, media, mesh +settings, workplanes, field/current data, worksurfaces and cables. +Model Branch +The Model branch is mainly a visualisation of the geometry and mesh creation hierarchy. Where +geometry or mesh objects are derived from existing ones, the original (parent) objects are +removed from the top level of the model and listed as sub-levels (children) under the new object. +Note: The highest-level items in the Model are referred to as “parts”. +For example, Cone1 and Cuboid1 (parent objects) were unioned and the result is that they have +become children of the new object (Union1). Union1 is the highest-level item and referred to as +a part. +Figure 20: The Construction tab in the model tree showing the part, Union1. +The Model branch also contain the ports, meshing rules, cutplanes and solution settings. +Optimisation Branch +The Optimisation branch contains the optimisation searches, associated masks, parameters and +goal functions defined for the model. +Note: The Optimisation branch is only displayed if the model contains an +optimisation search or mask. +Altair Feko 2022.3 +2 CADFEKO +Configuration Tab +p.51 +The Configuration tab contains the global and configuration-specific model settings and requests of the +current model in tree form. +The tree contains a Definitions branch, Global branch and Configuration specific branch. +Figure 21: The Configuration tab in the model tree. +Definitions Branch +The Definitions branch contains by default the predefined variables, named points, media, mesh +settings, workplanes, field/current data, work surfaces and cables. +Global Branch +The Global branch contains the global specific model settings. From the right-click context menu +define solver settings, specify the global frequency, sources, loads, networks and power. +Configuration specific Branch +The Configuration specific branch contains configuration specific settings. From the right- +click context menu define requests per configuration, frequency per configuration, sources per +configuration, loads per configuration and power per configuration. +Project Filter Tool +Filter items in the model tree and details tree according to the specified criteria. The filtering can also +be applied to 3D views. +In the model tree, at the top right, click the + Project Filter icon to open the Project Filter dialog. +Figure 22: An example showing the unfiltered model tree and details tree (left). An example of the model tree and +details tree filtered (right) shows only items with local mesh settings applied. +The following filter criteria are supported: +• Items with errors +• Items that are set suspect +• Items that are hidden +• Items with local mesh sizes +• Items that use specified mesh settings +• Items that use specific media +• Items that use specific variables +The following filter criteria are supported: +• Items with errors +• Suspect items +• Hidden items +• Items with local mesh sizes specified +• Items with coating specified +• Items that use the specified mesh settings +• Items that use the specified medium +Altair Feko 2022.3 +2 CADFEKO +• Items that use the specified variable +• Faces that use a specified solution method +• Regions that use a specified solution method +• Wires that use a specified solution method +• Numerical Green's function items +p.53 +When the Project Filter tool is active, the text (filtered) indicate that the model or details tree are +only showing filtered entities. +Figure 23: The text (filtered) indicates that Project Filter tool is active. +To disable filtering, re-open the Project Filter tool and unselect the filter items. +2.2.5 Details Tree +The details tree panel displays the relevant wires, edges, faces and regions for the geometry or mesh +part selected in the Construct tab. +The details tree is located below the model tree. From the right-click context menu specify the +properties for a wire, edge, face or region properties (which also include solution settings and custom +mesh settings) in the details tree. +Edges and Wires (Geometry) +Edges are the boundaries of faces. Wires are not associated with faces and are often referred to as “free +edges”. +Selecting an edge or a wire in the 3D view selects the corresponding edge or wire in the details tree. +Conversely, selecting an edge or wire in the details tree selects the corresponding edge or wire in the +3D view. +Figure 24: Select an edge in the 3D view to highlight the corresponding entry in the details tree. The converse is +also true. +The following can be applied to an edge: +• Local mesh size +The following can be applied to a wire: +• Local wire radius +• Wire core medium (metallic, layered dielectric, impedance sheet) +• Coating (layered dielectric) +• Local mesh size +• Solution method +Faces (Geometry) +Faces are individual surfaces of a part. By default, a face is set to perfect electric conductor (PEC). +Note: The term “face” is used to differentiate from “surface”. A surface refers to a 2D +primitive (for example, a polygon). +Selecting a face in the 3D view selects the corresponding face in the details tree. Conversely, selecting a +face in the details tree selects the corresponding face in the 3D view. +Figure 25: Select a face in the 3D view to highlight the corresponding entry in the details tree. The converse is also +true. +The following can be applied to faces: +• Face medium +◦ Metallic (to model skin effect). +◦ Layered dielectric +◦ +Impedance sheets (to represent metal surfaces in cases where only the surface impedance per +unit area is known). +◦ Characterised surface +• Coating (layered dielectric) +• Dielectric sheet +• Local mesh size +• Solution methods +• Basis functions (local setting) +When an operation results in a face being split into multiple faces, both the resulting faces inherit the +properties of the parent. +For operations where multiple faces need to be merged but have conflicting properties, an assumption +will be made and the face will be marked suspect to indicate that the settings need to be reviewed. +Regions (Geometry) +A region is an enclosed volume. By default, a region is set to perfect electric conductor (PEC). +Selecting a region in the 3D view selects the corresponding region in the details tree. Conversely, +selecting a region in the details tree selects the corresponding region in the 3D view. +Figure 26: Select a region in the 3D view to highlight the corresponding entry in the details tree. The converse is +also true. +The following can be applied to regions: +• Media +◦ Dielectrics +◦ Anisotropic media (3D) +• Local mesh size +• Solution methods +• Basis functions (local setting) +Boolean operations can be applied to the parents of regions. Where geometry operations introduce +intersections of existing regions, and the parent regions have conflicting settings, the resulting regions +are marked suspect to indicate that the settings need to be reviewed. +Note: Deleting a face that forms part of the region boundary effectively removes the region +or merges the region with the surrounding region. +Any setting applied to a region is also used for faces bounding the region. +Attention: If the face has a conflicting setting, the face setting takes precedence over the +region setting. +2.2.6 Status Bar +The status bar is the small toolbar that provides access to macro recording, general display settings, +tools, selection method and type, snap settings and the model unit. +The status bar is located at the bottom-right of the application window. Options on the status bar are +also available on the ribbon, but since the status bar is always visible, they are easily accessible no +matter which ribbon tab is selected. +Altair Feko 2022.3 +2 CADFEKO +2.2.7 Notes View +p.57 +The notes view is a rich-text editor tool that allows you to add comments to your model. +On the Home tab, in the Create view group, click the + Notes icon. +The notes view opens with a basic template in a new window allowing you to use multiple computer +screens (model on the one and notes view on another), but only a single notes view is supported for +each model. +Figure 27: The notes view in CADFEKO. It is by default disabled. +The contents of the notes view are written to the top of the .pre file as a series of comments. +Altair Feko 2022.3 +2 CADFEKO +2.2.8 Notification Centre +p.58 +The Notification centre performs computational electromagnetic model (CEM) validation and shows the +status of the model and notifications. +The Notification centre lets you stay informed of the model status at all times. When problems in +the model are detected, it is highlighted in the Notification centre with hyperlinks to the problematic +entities. +The Notification centre can be hidden but the Model Status icon in the status bar will still indicate the +current status of the model. +Figure 28: The Notification centre in CADFEKO. Note the Model Status icon at the bottom that shows the current +status of the model. +Show or hide the Notification centre using one of the following workflows: +• Click the Model Status icon in the status bar. +• Drag the splitter from the right edge of the application to open the pane. To close, drag the splitter +all the way to the right. +• On the Home, in the Validate group, click the + Model Status icon. +Altair Feko 2022.3 +2 CADFEKO +2.2.9 3D View +p.59 +3D views are used to display and interact with the model. You can zoom, rotate and pan around a 3D +model using the keyboard, mouse or a combination of both. You can use a 3D mouse, specify a view or +select specific parts of a model. Multiple 3D views are supported. +2.2.10 Navigate the 3D View Using Keyboard and Mouse +Navigate the 3D view using a mouse, a keyboard or a combination of both. +Related concepts +Custom Keyboard Shortcut Settings +Custom Mouse Bindings +Panning the 3D view +Shift the location of the model (without any magnification) inside the 3D view. +Use one of the following methods to pan the 3D view: +• Press Ctrl and hold down the left mouse button. Drag the view. +• Hold down the middle mouse button. Drag the view. +Related reference +Pan the 3D view using the ribbon +Rotating the 3D view Angle +Rotate the model in the 3D view. +Press the left mouse button and drag the view. +Zooming to Extents +Zoom the model to the full extent of the 3D view. +Press F5 to use the keyboard shortcut. +Zooming In and Out +Zoom the 3D view to display the model at the desired scale. +Use one of the following methods to zoom the 3D view: +• Scroll the mouse wheel. Press Shift to slow down the zooming. +• Press Shift and hold down the left mouse button. Drag the view up or down. +Altair Feko 2022.3 +2 CADFEKO +2.2.11 Search Bar +p.60 +The search bar is a single-line text field that allows you to enter search terms and find relevant +information in the GUI or the documentation. +The search bar is located at the top-right of the application window. +Tip: +• Enter a search term in the search bar to populate a drop-down list of actions as well as +the location of the action on the ribbon or context menu. +• Click an item in the list to execute the action. +• Partial searches are supported. +• Search the documentation. +2.2.12 Application Launcher +The application launcher toolbar is a small toolbar that provides quick access to other Feko components. +2.2.13 Application Menu +The application menu is similar to a standard file menu of an application. It allows saving and loading of +models, print functionality and gives access to application-wide settings. +When you click on the application menu drop-down button, the application menu, consisting of two +panels, is displayed. +The first panel gives you access to application-wide settings, for example: +• Creating a new model. +• Opening a model, saving a model and closing a model. +• Component library +• Archive +• Import +• Export +• Print +• Check for updates +• Settings +◦ Preferences +◦ Colour settings (for example, preview colour and background colour) +◦ 3D mouse sensitivity setting +◦ Snapping settings (when Ctrl+Shift is used) +◦ Rendering options (for example, rendering mode and transparency mode) +◦ Model unit +◦ Model extents +◦ Solver settings +◦ Component launch options +◦ Tabs on the ribbon +• Feko help +• About +◦ Version information about CADFEKO +Information about Altair Simulation Products +Information about third-party libraries +◦ +◦ +• Exit +The second panel consists of a recent file list and is replaced by a sub-menu when a menu item is +selected. +Figure 29: The application menu in CADFEKO. +Custom Keyboard Shortcut Settings +CADFEKO provides default keyboard shortcuts. To better fit your workflow and work style, you can +reassign keyboard shortcuts to different commands. +To reassign mouse buttons, click the Application menu button. On the application menu panel, click +Settings > Keyboard Shortcut Settings. +Figure 30: The Keyboard Shortcut Settings dialog. +For example, to change the shortcut key for the undo command, on the Keyboard Shortcut Settings +dialog, click in the CurrentKeySequence column and enter the shortcut key that suits your work style. +Altair Feko 2022.3 +2 CADFEKO +Custom Mouse Bindings +p.63 +CADFEKO provides default commands for all the mouse buttons. To better fit your workflow and work +style, you can reassign mouse buttons to different commands. +To reassign mouse buttons, click the Application menu button. On the application menu panel, click +Settings > Mouse Binding Settings. +Figure 31: The Mouse Binding Settings dialog. +For example, to reverse the mouse wheel direction to better suit your workflow, on the Mouse +Bindings dialog, click Click to Configure. On the Zoom dialog, select the Invert check box. +Figure 32: The Zoom dialog. +2.2.14 Feko Source Data Viewer +The Feko Source Data Viewer is a tool that allows you to view the currents per frequency for a PCB +current data, defined using a .rei file. +In the model tree, under + Field/Current Data, select a PCB current data. From the right-click +context menu, click + Visualise PCB Current Data. +The tool allows you to view multiple PCB current data definitions by using the Import Currents +Source data tool to import additional current source data. For each currents source data (.rei file), +you can specify the frequency, layers and nets that you want to view, as well as scale the layer height in +the 3D view. +Figure 33: The Feko Source Data Viewer tool where you can view currents per frequency for a PCB current data +definition. +Related tasks +Defining PCB Current Data from File +Visualising PCB Current Data +Altair Feko 2022.3 +2 CADFEKO +2.2.15 Help +p.65 +The Help icon provides access to the Feko documentation. +Press F1 to access context-sensitive help. The context-sensitive help opens the help on a page that is +relevant to the selected dialog, panel or view. +Tip: When no help context is associated with the current dialog or panel, the help opens +on the main help page that allows you to navigate the documentation or search in the +documentation for relevant information. +Altair Feko 2022.3 +2 CADFEKO +2.2.16 Dialog Error Feedback +p.66 +CADFEKO provides error feedback for dialogs by showing a soft message bubble when validation fails on +a dialog. +Click the + icon to show or hide the message bubble or click elsewhere in CADFEKO to hide the +message bubble. The error feedback is also shown per tab when the validation fails on a multi-tab +dialog. +Figure 34: The soft message bubble indicating that an undefined variable was used on the Geometry tab of the +Create Rectangle dialog. +2.2.17 Scripting +Use the application programming interface (API) to control CADFEKO from an external script. +Scripting allows repetitive or complex tasks to be performed in a script that would have taken a long +time to perform manually. Scripts are created and edited in the script editor or scripts can be recorded +(macro recording) by enabling the recording and then performing the actions in the graphical interface. +The recorded script can be modified to perform a more complex task. Scripts that are used regularly +can be added to the ribbon providing easy access and hiding the complexity of the script. Forms +(dialogs) can be created in the scripting environment that obtain input from the script user without +having to edit the script. +Altair Feko 2022.3 +2 CADFEKO +Script Editor +p.67 +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. +On the Home tab, in the Scripting group, click the + Script editor icon. +The script editor includes the following IDE (integrated development environment) features: +1. Syntax highlighting. +2. +3. +Intelligent code completion. +Indentation for blocks to convey program structure, for example, loops and decision blocks in +scripts. +4. Use of breakpoints and stepping in scripts to debug code or control its execution. +5. An active console to query variables or execute simple commands. +Figure 35: The script editor in CADFEKO. +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. +On the Home tab, in the Scripting group, click the + Record Macro icon. +Application Macros +An application macro is a reference to an automation script, an icon file and associated metadata. +Application macros are available directly or can be added, removed, modified or executed from the +application macro library. +Tip: A large collection of application macros are available in CADFEKO and POSTFEKO. +On the Home tab, in the Scripting group, click the + Application macro icon. +Related concepts +CADFEKO Application Macros +POSTFEKO Application Macros +Altair Feko 2022.3 +2 CADFEKO +2.3 Preferences +p.69 +CADFEKO has various default settings that you can configure to customise it to your preference. +On the application menu, click + Settings > Preferences. The settings can be reset to the default +settings at any time, restoring the settings to the state of a new installation. +Many of the settings are applied immediately, but some of the settings such as 3D view font changes +and rendering options require the application to be restarted before the changes take effect. +Figure 36: The Default settings dialog. +2.4 Saving a Model +Store a CADFEKO model and calculation requests to a .cfx file to reopen later. +On the Home tab, in the File group, click the + Save icon. +The model is saved to a .cfx file. When saving a model, the following files are also created: +• .cfm (if the model has a mesh) +• .pre +Altair Feko 2022.3 +2 CADFEKO +2.5 3D View +p.71 +3D views are used to display and interact with the model. You can zoom, rotate and pan around a 3D +model using the keyboard, mouse or a combination of both. You can use a 3D mouse, specify a view or +select specific parts of a model. Multiple 3D views are supported. +2.5.1 Point Entry +Use point entry (Ctrl+Shift+left click) to add values from the 3D view (for example, coordinates, +faces and edges) or values from the model tree or details tree (for example, named points, variables, +workplanes, faces and edges) to point-entry supported fields on a dialog. +Point entry is the mechanism of entering values in a field that has focus (on a dialog) based on the +Ctrl+Shift+left click in the 3D view or model tree. It allows the spatial definition or editing of geometry +or solution requests based on a series of clicks in the 3D view (or tree). +Note: A field on a dialog that has focus and a yellow outline, indicates that point entry is +active and allowed. Often multiple fields will be active for point entry at the same time. +For a one-dimensional input field (for example, the radius of a sphere), the value is calculated based on +the distance between the specified point and the coordinates or values already defined in the previous +fields on the dialog (for example, the centre of the sphere). +Figure 37: The Base corner field has focus. The yellow outline indicates that point entry is active for that field. The +values in italic are a preview of the values. +Using Point Entry to Add Coordinates to a Dialog +Use point entry to add coordinates from the 3D view to fields on a dialog. +As an example, specify the base corner of a cuboid by snapping to a point in the 3D view and use point +entry to add the coordinates to the dialog. +1. Open the Create cuboid dialog. +2. Verify that the Base corner field is outlined in yellow. +3. Press and hold down the Ctrl+Shift keys while hovering with the mouse cursor over a specific +point in the 3D view. +4. Left click on the red rectangle to snap to that point. You can now release the Ctrl+Shift keys. +The coordinate of the snapped point is added to the Base corner fields and the focus has moved +to the next field. +Using Point Entry to Add Named Points to a Dialog +Use point entry to add the coordinates of a named point in the model tree to fields on a dialog. +As an example, specify the base corner of a cuboid using point entry to add the coordinates of the +named point (in the model tree) to the dialog. +1. Open the Create cuboid dialog. +2. Verify that the Base corner field is outlined in yellow. +3. Press and hold down the Ctrl+Shift keys while hovering with the mouse cursor over a named point +in the model tree. +4. Left click on a named point in the model tree to perform point entry on the named point. You can +now release the Ctrl+Shift keys. +The named point is added to the Base corner fields and the focus has moved to the next field. +Lock Point Entry Fields +Lock an individual field in a collection of fields that accepts multiple components from a single point +entry (for example, the U coordinate, V coordinate and N coordinate for a point). +A field which accepts multiple values from point entry has a + button next to it. If the button is +clicked, the + button indicates that the field maintains its current value and will not be updated during +point entry. +Figure 38: The + button indicates that the point entry field is unlocked. +As an example, use point entry to enter the coordinates of a point in the 3D view as the base +corner of a cuboid. Lock the X coordinate and Y coordinate and use point entry again to enter a +different Z coordinate. +2.5.2 Snapping to Points in the 3D view +Snap to points (for example, named points, geometry points, geometry face centre, geometry edge +centre, mesh vertices and grid) in the 3D view. +1. Press and hold down Ctrl+Shift while hovering with the mouse cursor over the model. +Note: +• An active snapping point is indicated by a dot +• Special snapping points near the mouse cursor are indicated by a dot with a cyan +outline. +• A preview of the geometry is displayed in green (transparent). +Figure 39: Press Ctrl+Shift to view the snapping preview. +2. Left click on a dot and release Ctrl+Shift to snap to that point. +When snapping to align a new workplane, the history of the starting point and the route followed +to the destination points, affects the orientation of the workplane (for example the orientation of +an edge). +Snapping Settings +Specify the snapping targets and workplane grid that apply when pressing Ctrl+Shift. +On the Tools tab, in the Snapping group, click the + Snap Settings icon. +Figure 40: The Snapping settings dialog. +Snapping targets +You can specify the type of snapping targets that apply when pressing Ctrl+Shift. The following +snapping targets are available: +• Named points +• Geometry (interest points only) +• Geometry surfaces and wires +• Mesh +Workplane / Work surface snap options +You can specify how to snap to points on the workplane. +Auto grid +The workplane grid size is determined automatically. You can snap to any point on the grid lattice. +Continuous +You can snap to any point on the workplane. +Fixed grid +The workplane grid is specified by Size. You can snap to any point on the grid lattice. +Figure 41: Enable the workplane grid display and tick marks to view the grid lattice. +Snapping Offset +You can specify the snap offset from a surface or plane. In the Snap offset from surfaces and planes +field, enter a value for the offset. +Tip: Specify the snap offset to define a cable path at an offset from complex geometry. +2.5.3 Navigate the 3D View Using the Ribbon +Navigate by means of panning, rotating and zooming the 3D view using the ribbon. +All 3D view interactions are available on the ribbon. It is not practical for advanced users to use the +ribbon for 3D interactions, but the ribbon provides a list of all the interactions. Hovering over a ribbon +button will show the tooltip that also shows the keyboard shortcut for that action (if a shortcut exists for +that action). +Pan +View the list of the available panning methods using the ribbon. +The zoom settings are found on the View tab, in the Panning group. +Icon +Icon text +Description +Panning Mode +Places the mouse cursor in panning mode. +Pan Left +Pan to the left. +Pan Right +Pan to the right. +Pan Up +Pan up. +Pan Down +Pan down. +Rotate +View the list of the available rotation types using the ribbon. +The zoom settings are found on the View tab, in the Rotate group. +Icon +Icon text +Description +Phi (-) +Rotate the model in the negative ϕ direction. +Phi (+) +Rotate the model in the positive ϕ direction. +Theta (-) +Rotate the model in the negative θ direction. +Theta (+) +Rotate the model in the positive θ direction. +Altair Feko 2022.3 +2 CADFEKO +Zoom +View the list of the available zoom methods using the ribbon. +The zoom settings are found on the View tab, in the Zoom group. +p.77 +Icon +Icon text +Description +Shortcut +Zoom to Extents Zoom the content of the window to its extents. +F5 +Zoom Area +Zoom to display an area specified by a rectangular +window. +Zoom In +Zoom in on the contents of the window. +Zoom Out +Zoom out from the contents of the window. ++ +- +2.5.4 View Settings +Specify the origin, view direction and zoom distance for a 3D view to allow you to consistently +reproduce a view for reporting or set the 3D view to a predefined view. +On the View tab, in the View Manipulation group, click the + Transform View icon. +Figure 42: The Transform view dialog. +Predefined Views +View the list of available predefined views. +The predefined view settings are found on the View tab, in the View Manipulation group. +Icon +Icon text +Description +Shortcut +Isometric +Displays an isometric view of the model. +Top +Front +Left +Displays a top view of the model. +Displays front view of the model. +Displays a left view of the model. +Bottom +Displays a bottom view of the model. +Back +Right +Displays a back view of the model. +Displays a right view of the model. +Ctrl+5 +View History +The view actions are found on the View tab, in the View Manipulation group. The view history +is separate from the normal undo stack making it possible to undo the view manipulations without +undoing changes in the model. +Icon +Icon text +Description +Undo View +Undo the last 3D view. +Redo View +Redo the last 3D view. +Depth Lighting +Depth lighting adds depth perception to a model visualised in the 3D view. +Depth lighting is enabled by default, but you can disable this setting for specific views. +On the View tab, in the View Manipulation group, click the + Depth Lighting icon. +Figure 43: A model with depth lighting enabled (on the left) and a model with depth lighting disabled (to the right). +2.5.5 Selection in the 3D View +Left-click on a part of a model in the 3D view to select it. +Selection in the 3D view is set to Auto selection by default. Auto selection cycles through the available +selection type each time you left-click on a model in the 3D view. +The selection type is specified at the following locations: +• Tools tab, in the Selection group +• Status bar +Tip: +• Press Ctrl+A to select all entities (edge, wire, face or region) of the same type in the +collection[8]. +• Press Ctrl+Shift+A to select all entities (edge, wire, face or region) of the same type in +the model. +Selection Method +View the list of available selection methods. +Icon +Icon text +Description +Single Select +Select the item under the mouse cursor. +Rectangle Select Select all items in the rectangle. Click once to place the first corner of +the rectangle. Move the mouse cursor and click again to indicate the +second point in the rectangle. +8. For example, in the model tree, a collection can be geometry, meshes, ports, meshing rules, +cutplanes and solution settings. In the details tree, a collection can be wires, edges, faces and +regions. +Altair Feko 2022.3 +2 CADFEKO +Icon +Icon text +Description +p.80 +Polygon Select +A polygon selection area is defined using successive clicks. The +elements inside the polygonal area are selected. +Selection Type +View the list of available selection type settings. +The select by type settings are found on the Tools tab, in the Selection group. +Icon +Icon text +Description +Auto +When this option is selected, the selection will cycle through the +available selection types. +Geometry parts +Select geometry parts in the 3D view. +Faces +Select faces in the 3D view. +Edges / wires +Select edges / wires in the 3D view. +Regions +Select regions in the 3D view. +Mesh Parts +Select mesh parts in the 3D view. +Mesh Label +Select mesh label in the 3D view. +Mesh Element +Select mesh element in the 3D view. +Mesh Vertex +Select mesh vertex in the 3D view. +Edge Selection Tool +Use the edge selection tool when selecting edges for the hole filling tool to minimise the number of +edges that need to be selected manually. +On the Tools tab, in the Selection group, click the + Selection Tools icon. From the drop-down list +select the + Select Edge Tool icon. +When this tool is activated, the smallest loop containing the already selected laminar and / or free +edges (wires) edges is selected. A laminar edge is an edge that is associated with a single face. +Note: An edge is laminar when the edge is only on the boundary of a single face. +Tip: Press Q+C to select the smallest loop containing the edges. +Figure 44: Example 1 showing two selected wires. Using the Select edge loop tool results in the smallest loop +containing these edges being selected. Note that the background colour was changed to show the selection +(indicated in yellow) more clearly. +Figure 45: Example 2 showing two selected wires. Using the Select edge loop tool results in the smallest loop +containing these edges being selected. +Selection History +Selection operations can be undone / redone independently of any geometry modifications. +The selection actions are found on the Tools tab, in the Selection group. +Icon +Icon text +Description +Undo Selection +Undo the last selection. +Redo Selection +Redo the last selection. +2.5.6 Changing the Rendering Speed for a Model +Improve the rendering speed of a large model in the 3D view at the cost of visual quality. +On the View tab, in the Show group, click the + Speed icon. From the drop-down list, select one of +the following options: +• +• +• + Default +Finer tessellation results in high quality rendering, but rendering speed is slower. + Fast +Coarser tessellation results in a medium quality rendering, but rendering speed is faster. + Faster +Coarsest tessellation results in low quality rendering, but rendering speed is the best. +Altair Feko 2022.3 +2 CADFEKO +2.6 Model Protection +Protect a model with a password. +p.83 +The primary usage of model protection is to allow a prepared simulation model to be shared as a +“component” that may be included in the construction of another model, while maintaining limited +visibility of the internal details of the model as well as the simulation quantities for anyone who does +not know the password for the protected model. When a protected model is imported, no geometry or +mesh is visible or editable for that part of the model and limitations are imposed on the requests that +may be calculated. +Model protection may also be used to ensure that those who do not have the password are unable to +open the model. When using protection in this way, please keep in mind that, though a protected model +can be simulated by running the solver, some simulation results may not be calculated and no mesh will +be available in POSTFEKO for post processing after simulation. It is generally advisable to unprotect the +model before simulation to avoid these limitations. +Protecting and Removing Protection from a Model +To add protection, on the Home tab, click the Protection + icon and in the drop-down list click +Protect Model. Enter a new password in the dialog. To remove protection, click Unprotect Model +and enter the password that was used to protect the model. When a model is protected, a protection +indicator is shown in the bottom right hand corner of the CADFEKO window. A protected model also has +an additional Unprotected Information branch in the configuration tree. The Unprotected Information +includes an Orientation Workplane that may be positioned relative to the geometry of the protected +model. This Orientation Workplane defines a reference that can be used to accurately align or position +the protected model structure relative to other geometry after importing the protected model as a +component into a different simulation. +When protection is added to a model, CADFEKO will check if the solver selected in the protected +model is supported. A subset of solvers are currently supported for protected models to avoid solver +combinations and settings that are not supported in the same model. If the solver of the model to +be protected is not currently supported, a warning will be given and protecting the model will not be +allowed. +Note: Supported solver combinations will be extended in future versions. +Importing a Protected Model +To import a protected model as a component to be used as part of a simulation with other geometry, +mesh or requests, click on the Protection + icon and click Import Protected Model. No password +is necessary to import the protected model in this way. Once a protected model has been imported, a +grey translucent box with a size equal to the bounding box of the model construction in the 3D view. +The model geometry is also represented in the configuration tree under Protected Models. +Using an Imported Protected Model +Transforms (such as Translate, Rotate and Scale) can be applied to imported Protected Models in order +to prepare and position them correctly relative to other geometry and requests before simulation. +Accurate alignment of a Protected Model can be achieved using the Align tool and by referencing the +Orientation Workplane for that model. Orientation Workplanes from all imported Protected Models are +included in the list of predefined workplanes in the relevant dialogs and may be used just as any other +Workplane. +Right-click on a Protected Model in the configuration tree to Rename, Reload, Expose or Conceal +the model. Exposing the model requires that the password for that Protected Model be entered. +When exposed, the geometry of the model will be shown withing the bounding box. This is useful +when debugging or visualizing the usage of protected models for which a user knows the password. +Concealing the model will again hide the geometry. Reloading a Protected Model will re-import the +model from the location that it was initially imported from. A successful reload is only possible if the +model that was initially imported is in the same path (absolute or relative) when the reload is triggered. +Transforms applied to the protected model will be maintained during reload. Some changes made to +simulation configurations linked to that model (such as renaming, deleting or disabling a configuration) +will not be maintained. +Simulation configurations from the model (with some relevant details hidden) are loaded into new +configurations denoted ProtectedModelName.ConfigurationName where ProtectedModelName is +the name of the protected model in the configuration tree and ConfiurationName is the name of the +configuration in the imported protected model. Both the protected model and its configurations may be +renamed after import. +Figure 46: An offset reflector with an imported protected model of a horn (feed) showed in grey in CADFEKO. +Simulations Including Protected Models +The process of running a simulation with a model that includes imported protected models is exactly +the same as for a model that does not contain imported protected models. Various limitations on output +file-formats and solution output will be imposed when parts of the simulation are protected. Some parts +of text files (such as the .pre file) will be encrypted and not editable or readable. The solver will limit +details written to the screen and output files and certain output files (such as export of files for thermal +analysis) are not supported and the setting will be ignored. Some requests (most notably, near-field +or current calculations) will be excluded from the simulation even if the requests are defined. Warning +and error messages in the CADFEKO notification center will indicate where these limitations are applied. +Limitations on requests will be relaxed in future releases. +Fek files which include protected models cannot currently be loaded into POSTFEKO. This means that +models including protected parts cannot be visualized in the 3D view. Results can be plotted on 2D and +surface graphs and post-processed as normal. Results that can be viewed in the 3D view (such as far- +fields) need to be copied to a Custom Dataset before adding them to a 3D view. This restriction will be +relaxed in future releases. +Table 1: Supported solver combinations of the protected model and the rest of the model. +Protected Model +Rest of Model +Info +SEP +SEP +SEP +MoM +MoM +MoM +PO +PO +Windscreen +SEP with MLFMM +FEM +UTD +RL-GO +PO +MoM +MLFMM +Protected model contains dielectric(s) using SEP. +Rest of model contains mesh elements solved with +the Windscreen method. +Protected model and rest of model contain +dielectric(s) using SEP. The MLFMM solver is +activated. +Protected model contains dielectric(s) using SEP. +Rest of model contains dielectric(s) using FEM. +Protected model contains metallic-only faces using +MoM. Rest of model contains faces set to UTD. +Protected model contains metallic-only faces using +MoM. Rest of model contains faces set to RL-GO. +Protected model contains metallic-only faces using +MoM. Rest of model contains metallic-only faces +set to PO. +Protected model contains metallic-only faces using +PO. Rest of model contains metallic faces set to +MoM. +Protected model contains metallic-only faces using +PO. The MLFMM solver is activated. +Altair Feko 2022.3 +2 CADFEKO +2.7 Model Definitions +p.86 +Define the model unit, variables, named points, workplanes and the model extents for the model. +2.7.1 Model Unit +The model unit specifies the unit that is used for all dimensions in the model. +When you modify the model unit, the unit does not modify any numbers specified in CADFEKO, but +rather the internal interpretation of all numbers created before and after the unit change. +Note: You may change the model unit at any stage during and after the construction of the +model. +The model unit is specified at the following locations: +• Home tab, in the Model Attributes group +• Construct tab, in the Define group +• Status bar +Changing the Model Unit +Change the model unit that is used for all dimensions in the model. +1. On the Home tab, in the Model Attributes group, click the + Model Unit icon. +Figure 47: The Model unit dialog. +2. Specify the unit you want to use in the model. +• To use one of the standard units, click the unit you want to use for the model. +• To specify an arbitrary unit conversion factor with respect to metres, click Specify. In the m +field, enter a value. +Note: For example, if you want to change the unit to micrometres, enter 1e-6 to +specify a conversion factor of 1x10-6. +Altair Feko 2022.3 +2 CADFEKO +3. Click OK to close the dialog. +2.7.2 Variables +p.87 +Create a fully parametric geometry in CADFEKO by using variables and mathematical expressions. +Most input fields in CADFEKO allow variables and expressions to be entered. The variables and +expressions are stored as part of the model. When a variable is modified, any items referencing that +variable are re-evaluated and updated. +Variable names +• The first character must be either: +◦ Alphabetic (for example, a - z, A - Z) +◦ Underscore (for example, “_”) +• The remaining characters may be alphanumeric or an underscore (for example, a - z, A - Z, 0 - 9 +and “_”). +• Variable names are case-insensitive. +Variable expressions +• A variable expression may be a single value. +• A variable expression may be a mathematical expression using round brackets and the operators +, +-, *, \ and ^ (exponential notation). +• A variable expression may reference other variables. +• A variable expression may use trigonometric and other built-in functions. +• A variable expression may use any of the predefined variables in CADFEKO. +Defining a Variable to Create Parametric Geometry +Create a variable to create parametric geometry. +1. On the Construct tab, in the Define group, click the + Add Variable icon. +2. +3. +4. +5. +In the Label field, enter a name for the variable. +In the Expression field, enter a value, expression or an already defined variable. +[Optional] In the Comment field, add a comment or description for the variable. +[Optional] Select the Limit check box to define a range for the value of the variable. +• In the Minimum field, enter a value for the smallest variable value. +• In the Maximum field, enter a value for the largest variable value. +6. Select one of the following workflows to close the dialog. +• To create the variable and close the dialog, click Create. +• To create the variable, but keep the dialog open to create another variable, click Add. +Figure 48: The Create Variable dialog. +Functions in Expressions +View the list of available functions in CADFEKO. +Table 2: Mathematical functions supported in expressions. +Trigonometric functions (arguments expected in radians). +sin +cos +tan +cot +arcsin +Trigonometric inverse functions (results in radians). +arccos +arctan +arccot +eps0 +The permittivity of free space in F/m. +atan2 +atan2(y,x) yields arctan(y/x) in the range - ... . +pi +The mathematical constant (Ludolph’s number). +Hyperbolic functions +sinh +cosh +tanh +fmod +fmod(a,b) returns the remainder of the division a/b. +deg +rad +Converts radians to degrees. +Converts degrees to radians. +log +ln +exp +sqrt +abs +step +Logarithm to base 10 +Natural logarithm +Exponential function +Square root +Absolute value +step(x) is 1 when x>0; otherwise it is 0. +ceil +Rounded upwards +floor +Rounded downwards +min +max +min(a,b) gives the minimum of the two arguments. +max(a,b) gives the maximum of the two arguments. +Predefined Variables +A new model contains a list of predefined variables by default. +A predefined variable may be deleted or modified and only have an effect if you explicitly refer to that +variable. +Table 3: Predefined variables in CADFEKO. +c0 +The speed of light in free space in m/sec. +eps0 +The permittivity of free space in F/m. +mu0 +The permeability of free space in H/m. +pi +zf0 +The mathematical constant (Ludolph’s number). +The characteristic impedance of free space in Ohm. +Modifying Multiple Variables +Modify multiple variables on a single dialog. +1. On the Construct tab, in the Define group, click the + Edit Variables icon. +Figure 49: The Modify Variables +2. Click the fields in the Name column to modify the name of a variable. +3. Click the fields in the Expression column to modify a value of a variable. +4. Select the check box in the Limiting column to specify a range for the variable. +• Enter a value in the Minimum and Maximum fields. +• In the Expression field, adjust the slider bar to the required value. +• The result of the Expression field is displayed in the Evaluation field. +5. Select one of the following workflows to close the dialog. +• To modify the variables and close the dialog, click OK. +• To modify the variables, but keep the dialog open for further modifications, click Apply. +2.7.3 Named Points +Create named points that can be referenced by geometry and requests, similar to variables. +The X coordinate, Y coordinate and Z coordinate of a point can be accessed using a dot followed by the +required component. +For example, Point1.x gives access to the X coordinate of named point, Point1. +Points can also be constructed using the “pt” command. +For example, the expression pt(1,1,1) + pt(2,1,1) results in a point definition of pt(3,2,2). +The following actions are allowed on points: +• The subtract and add operations are allowed between two points. +• A point may be multiplied or divided by a scalar. +• The distance from the origin to a point is obtained using the abs function. +Defining a Named Point to Use in Geometry Creation +Create a named point to create parametric geometry. +1. On the Construct tab, in the Define group, click the + Add Point icon. +Figure 50: The Create named point dialog. +2. +In the Label field, enter a name for the named point. +3. Under Point, enter the U coordinate, V coordinate and N coordinate using one of the following +workflows: +• Enter the values manually. +• Use point-entry to add the coordinates from the 3D view. +The calculated result is displayed in the Value field. +Note: The result is maintained until the next time the expression is evaluated. +4. Select one of the following workflows to close the dialog. +• To create the named point and close the dialog, click Create. +• To create the named point, but keep dialog open to create another named point, click Add. +2.7.4 Workplanes +Use workplanes to simplify the geometry creation process by creating new geometry on an oblique +plane. +When the global coordinates are used to construct primitives in CADFEKO, the orientation of the new +entity is fixed. A simple and efficient method is to create a workplane at the intended position and +orientation and then create the geometry using the workplane definition. +The following workplanes are predefined by default (and cannot be modified): +• Global XY +• Global XZ +• Global YZ +Anyone of the above workplanes may be set as the default workplane. From its right-click context +menu, select Set as default. +In addition to the three predefined workplanes, user-defined workplanes may be defined and set as the +default workplane. +When a workplane is set as the default workplane, it is indicated by the text [Default] in the +model tree. The default workplane will be used as the initial workplane for primitive creation, operators +and transforms. +Defining a Workplane to Aid in Geometry Creation +Add a new workplane to the model to aid with geometry creation. +1. On the Construct tab, in the Define group, click the + Add Workplane icon. +Figure 51: The Create Workplane dialog. +2. Under Predefined Workplane in the drop-down list, select a reference workplane. +3. Under Origin, enter the position of the workplane using one of the following methods: +• Enter the coordinates for the origin manually. +• Use point entry to enter the coordinates for the origin from the 3D view. +4. Specify the rotation of the workplane by using one of the following methods: +• Enter values for the U-Vector and V-Vector. +• Click on any field and from the right-click context menu, click one of the following: +• Around U +• Around V +Altair Feko 2022.3 +2 CADFEKO +• Around N +and specify the angle of rotation. +p.93 +Figure 52: Rotate the workplane using the Rotate workplane right-click context menu. +5. +In the Label field, add a unique label for the workplane. +6. Click OK to create the workplane and to close the dialog. +Note: Apply transforms on the workplane by selecting the workplane in the model tree. +From the right-click context menu, click Transforms and select the transform. +Figure 53: Transforms can be applied to any defined workplanes. +2.8 Constructing Geometry +Create fully parametric and complex CAD geometry using canonical structures and perform Boolean +operations on these. +Basic geometry includes solids (cuboid, flare, sphere, cylinder and cone), surfaces (rectangle, polygon, +ellipse, paraboloid and NURBS) and arcs (line, polyline, fitted spline, Bézier curve, analytical curve, +elliptic arc, parabolic arc, hyperbolic arc and helix). Use Boolean operations such as union, separate, +subtract, intersect, split and stitch to create complex geometry. Extend the geometry using spin, loft, +sweep and path sweep. Transform the geometry using translate, mirror, rotate, scale, align and project. +2.8.1 Creating Basic Geometry +Create basic geometry using solids, surfaces and arcs and using transforms and Boolean operations. +Creating Arcs +An arc is any smooth curve between two points. +Line +Create a line to be used either as a building block for constructing or modifying geometry or as a wire. +On the Construct tab, in the Create Curve group, click the + Line icon. +Tip: Press V,1 to use the shortcut key. +Start point (P1) +The starting point of the line. +End point (P2) +The end point of the line. +Polyline +Create a polyline to be used either as a building block for constructing geometry or as a wire. +Polylines consist of consecutive straight lines and result in mesh vertices being created at each corner. +The lines of a polyline should not cross itself, but if this is required, the polygon can be sub-divided. +On the Construct tab, in the Create Curve group, click the + Polyline icon. +Tip: Press V,2 to use the shortcut key. +Corner 1 (C1) +The first point of the polyline. +Corner 2 (C2) +The second point of the polyline. +...Corner n (Cn) +Additional points in the polyline. There may be an +arbitrary number of points. +Fitted Spline +Create a fitted spline to be used either as a building block for constructing geometry or as a wire. The +fitted spline fits a smooth curve through all the node points in the definition. +Fitted splines are smooth over the entire path (no sharp corners). Fitted splines are preferred over +polylines when reconstructing geometry from points (for example, exported from another source) since +they do not cause mesh vertices to be created at the node points. +On the Construct tab, in the Create Curve group, click the + Fitted Spline icon. +Tip: Press V,3 to use the shortcut key. +Point 1 (P1) +The starting point of the curve. +Point 2 (P2) +The second point through which the spline curve will +pass. +...Point n (Pn) +The additional points through which the spline must +pass. There may be an arbitrary number of points. +Analytical Curve +Create an analytical curve to be used either as a building block for constructing geometry or as a +wire. Analytical curves are parametric definitions (in the parameter “t”) that define the path in three +coordinate systems. +The derivatives of the expressions are required and need to exist over the entire path. If dividing the +derivative by zero, the definition is not accepted. An alternative would be to calculate the points in the +scripting environment and create a fitted spline. +On the Construct tab, in the Create Curve group, click the + Analytical Curve icon. +Tip: Press V,5 to use the shortcut key. +Table 4: Method 1: Cartesian +P[u(t),v(t),n(t)] +Parametric interval +Interval over which the analytical curve is +parametrically defined. +Cartesian +description +The description of the curve using the Cartesian +coordinate system. The U, V and N dimensions as a +function of variable t. +Table 5: Method 2: Cylindrical +P[ (t), (t),n(t)] +Parametric interval +Interval over which the analytical curve is +parametrically defined. +Cylindrical +description +The cylindrical description of the curve in the ρ, θ and ϕ +dimensions as a function of variable t. +Parametric interval +Interval over which the analytical curve is +parametrically defined. +Spherical +description +The spherical description of the curve in the r, θ and ϕ +dimensions as a function of variable t. +Table 6: Method 3: Spherical +P[r(t), (t), (t)] +Bézier Curve +Create a Bézier curve to be used either as a building block for constructing geometry or as a wire. +Bézier curves are defined by four points. The curve will start and stop at the first and last point, while +the other two points “pull” the curve in their direction, but do not usually pass through them. +On the Construct tab, in the Create Curve group, click the + Bézier Curve icon. +Tip: Press V,4 to use the shortcut key. +Corner 1 (C1) +The starting point of the curve. +Corner 2 (C2) +The first control point of the Bézier curve (the curve +does not necessarily pass through this point). +Corner 3 (C3) +The second control point of the Bézier curve (the curve +does not necessarily pass through this point). +Corner 4 (C4) +The end point of the curve. +Parabolic Arc +Create a parabolic arc to be used either a building block for constructing geometry or as free-standing +wires. +Parabolic arcs are often used in conjunction with the spin operator to create parabolic dishes for +reflector antennas. +On the Construct tab, in the Create Arc group, click the + Parabolic Arc icon. +Tip: Press A,2 to use the shortcut key. +Method 1: Base centre, focal depth, radius +Base centre (C) +The centre of the parabola on which the arc lies. +Focal depth (F) +The focal depth of the parabola. +Radius (R) +The radius of the aperture of the parabolic arc. +Method 2: Base centre, radius, depth +Base centre (C) +The centre of the parabola on which the arc lies. +Radius (R) +The radius of the aperture of the parabolic arc. +Depth (D) +The distance from the apex of the parabola to the +centre of the aperture. +Altair Feko 2022.3 +2 CADFEKO +Method 3: Aperture centre, radius, depth +Aperture centre +(C) +The aperture centre of the parabolic arc section. +Radius (R) +The radius of the aperture of the parabolic arc. +Depth (D) +The distance from the apex of the parabola to the +centre of the aperture. +Hyperbolic Arc +Create a hyperbolic arc to be used either as a building block for constructing geometry or as a wire. +Hyperbolic arcs are often used in conjunction with the spin operator to create hyperbolic dishes for +reflector antennas. +On the Construct tab, in the Create Arc group, click the + Hyperbolic Arc icon. +Tip: Press A,3 to use the shortcut key. +Method 1: Base centre, depth, radius, eccentricity +Base centre (C) +The centre of the hyperbola on which the arc lies. +Depth (D) +The distance from the apex of the hyperbola to the +centre of the arc aperture. +Radius (R) +The radius of the aperture of the hyperbolic arc. +Eccentricity +The eccentricity of the hyperbola on which the +hyperbolic arc section lies. +Conditions to create a valid hyperbolic arc: +where D is denoted by the depth, R by the aperture radius R and the eccentricity. +p.98 +(1) +Altair Feko 2022.3 +2 CADFEKO +Method 2: Aperture centre, depth, radius, eccentricity +Aperture centre +(C) +The centre of the aperture formed by the hyperbolic +arc. +Depth (D) +The distance from the apex of the hyperbola to the +centre of the arc aperture. +Radius (R) +The radius of the aperture of the hyperbolic arc. +Eccentricity +The eccentricity of the hyperbola on which the +hyperbolic arc section lies. The eccentricity must be +greater than one to specify a valid hyperbola. +Note: Not all values greater than one +specifies a valid hyperbola. +Conditions to create a valid hyperbolic arc: +where D is denoted by the depth, R by the aperture radius R and the eccentricity. +Elliptic Arc +Create an elliptic arc to be used either as a building block for constructing geometry or as a wire. +On the Construct tab, in the Create Arc group, click the + Elliptic Arc icon. +Tip: Press A,1 to use the shortcut key. +Method 1: Centre point, radii, start angle, end angle +p.99 +(2) +Centre point (C) +The centre of the ellipse on which the arc lies. +Radius (RU) +Radius (RV) +The radius (half of the axis length) in the U axis +direction of the ellipse on which the arc lies. +The radius (half of the axis length) in the V axis +direction of the ellipse on which the arc lies. +Start angle (A0) +The angle, from the positive U axis direction where the +arc begins. +End angle (A1) +The angle, from the positive U axis direction where the +arc ends +Method 2: V major axis direction - Aperture centre, depth, aperture radius, +eccentricity +Aperture centre +(C) +The centre of the aperture formed by the elliptical arc +section. +Depth (D) +The distance from the aperture centre point to the apex +of the elliptical arc section. +Aperture radius (R) The radius of the aperture of the elliptic arc. +Eccentricity +The eccentricity of the ellipse on which the elliptical arc +section lies. +Note: The eccentricity must be less than 1 +to specify a valid ellipse. +Conditions for creating a valid elliptic arc: +(3) +where D is denoted by the depth, R by the aperture radius and the eccentricity. +Method 3: U major axis direction - Aperture centre, depth, aperture radius, +eccentricity +Aperture centre +(C) +The centre of the aperture formed by the elliptical arc +section. +Depth (D) +The distance from the aperture centre point to the apex +of the elliptical arc section. +Figure 54: Method 3 +Aperture radius (R) The radius of the aperture of the elliptic arc. +Eccentricity +The eccentricity of the ellipse on which the elliptical arc +section lies. +Note: The eccentricity must be less than 1 +to specify a valid ellipse. +Conditions for creating a valid elliptic arc: +(4) +where D is denoted by the depth, R by the aperture radius and the eccentricity. +Helix +Create a helix to be used either as a building block for constructing geometry or as a wire. +On the Construct tab, in the Create Arc group, click the + Helix icon. +Tip: Press A,4 to use the shortcut key. +Method 1: Base centre, base radius, end radius, height, turns +Origin (C) +The centre point of the helix base. +Base radius (Rb) +The radius of the helix base (parallel to the UV plane). +End radius (Rt) +The height of the helix, in the N axis direction. +Turns (N) +The number of turns of the helix (the rotation direction +is selected based on the Left handed check box). +Method 2: Base centre, radius, pitch angle, turns +Origin (C) +The centre point of the helix base. +Radius (R) +The radius of the helix (parallel to the UV plane). +Pitch angle (A) +The angle formed between the tangent of the curve and +the UV plane - constant along the length of the helix. +Turns (N) +The number of turns of the helix (the rotation direction +is selected based on the Left handed check box). +Method 3: Base centre, radius, height, pitch angle +Origin (C) +The centre point of the helix base. +Radius (R) +The radius of the helix (parallel to the UV plane). +Height (H) +The height of the helix, in the N axis direction. +Pitch angle +(A) +The angle formed between the tangent of the curve and the +UV plane - constant along the length of the helix. +Creating Surfaces +A surface can be defined and used to create more complex structures. +Rectangle +Create a rectangle or a square. +On the Construct tab, in the Create Surface group, click the + Rectangle icon. +Tip: Press S,1 to use the shortcut key. +Method 1: Base corner, width, depth +Base corner (C) +A corner of the rectangle. +Width (W) +The width of the rectangle. +Depth (D) +The depth of the rectangle. +Altair Feko 2022.3 +2 CADFEKO +Method 2: Base centre, width, depth +Base centre (C) +The centre of the rectangle. +Width (W) +The width of the rectangle. +Depth (D) +The depth of the rectangle. +p.103 +Polygon +Create a two-dimensional polygonal surface. +The corner points of the polygon are required to be on the same plane. If this is not the case, the +surface must be constructed using smaller polygons that do lie in a common plane. +On the Construct tab, in the Create Surface group, click the + Polygon icon. +Tip: Press S,2 to use the shortcut key. +Corner 1 (C) +The first corner of the polygon. +Corner 2 (C2) +The second corner of the polygon. +...Corner n (Cn) +Additional corners of the polygon (an arbitrary +number). All must be in the same plane. The polygon is +closed by connecting the last point to C1. +Ellipse +Create an ellipse or a circle. +On the Construct tab, in the Create Surface group, click the + Ellipse icon. +Tip: Press S,3 to use the shortcut key. +Centre point (C) +The centre of the ellipse. +C Ru +Rv +Radius (Ru) +Radius (Rv) +The radius (half of the axis length) in the U axis +direction. +The radius (half of the axis length) in the V axis +direction. +Paraboloid +Create a paraboloid. +On the Construct tab, in the Create Surface group, click the + Paraboloid icon. +Tip: Press S,4 to use the shortcut key. +Centre point (C) +The apex of the paraboloid. +Radius (R) +The radius of the paraboloid aperture, parallel to the UV +plane. +Focal depth (F) +The focal depth (F) of the paraboloid is the distance +from the centre point (C) to the focal point. If this +is negative, the paraboloid is oriented towards the +negative N axis. +The focal depth is related to the dimensions of paraboloid by +where (H) denotes the distance from the centre point (C) to the aperture centre of the paraboloid. +(5) +NURBS +Create a non-uniform rational basis spline (NURBS) surface. +On the Construct tab, in the Create Surface group, click the + NURBS Surface icon. +Tip: Press S,5 to use the shortcut key. +Altair Feko 2022.3 +2 CADFEKO +11 +21 +22 +32 +33 +42 +43 +13 +14 +24 +12 +23 +34 +44 +31 +41 +p.105 +Specify the order +of the Bézier +curves +The degree of the Bézier curve in the Uʹ direction and Vʹ +direction. +Point position +The position of each surface control point is specified. +Weight +The weight of each surface control points is specified. +Creating Solids +Solid geometries are closed surfaces and have an enclosed region. +A solid primitive is by default a perfect electric conductor (PEC). The solid can be changed to a dielectric +or a shell structure by setting the region properties. +Cuboid +Create a cuboid. +On the Construct tab, in the Create Solid group, click the + Cuboid icon. +Tip: Press C,1 to use the shortcut key. +Method 1: Base corner, width, depth, height +Base corner (C) +One corner of the cuboid. +Width (W) +The cuboid dimension in the U axis direction. +Depth (D) +The cuboid dimension in the V axis direction. +Height (H) +The cuboid dimension in the N axis direction. +Altair Feko 2022.3 +2 CADFEKO +Method 2: Base centre, width, depth, height +p.106 +Base centre (C) +The base centre of the cuboid. +Width (W) +The cuboid dimension in the U axis direction. +Depth (D) +The cuboid dimension in the V axis direction. +Height (H) +The cuboid dimension in the N axis direction. +Flare +Create a flare or a pyramid. Flares are often used in the construction of horn antennas and waveguide +transitions. +On the Construct tab, in the Create Solid group, click the + Flare icon. +Tip: Press C,2 to use the shortcut key. +Method 1: Base centre, bottom width, bottom depth, height, top width, top depth +Base centre (C) +The centre of the flare base +Bottom width (Wb) The width of the base in the U axis direction. +Bottom depth (Db) The depth of the base in the V axis direction. +Height (H) +The height of the flare, in the N axis direction. +Top width (Wt) +The width of the top in the U axis direction. +Top depth (Dt) +The depth of the top in the V axis direction. +Method 2: Base corner, bottom width, bottom depth, height, top width, top depth +Base corner (C) +The corner of the flare base. +Bottom width (Wb) The width of the base in the U axis direction. +Bottom depth (Db) The depth of the base in the V axis direction. +Height (H) +The height of the flare, in the N axis direction. +Top width (Wt) +The width of the top in the U axis direction. +Top depth (Dt) +The depth of the top in the V axis direction. +Method 3: Base corner, top corner, bottom width, bottom depth +Base corner (C) +The corner of the flare base. +Top corner (Ct) +The corner of the flare top. +Bottom width (Wb) The width of the base in the U axis direction. +Bottom depth (Db) The depth of the base in the V axis direction. +Method 4: Base centre, width, depth, height, flare angle 1, flare angle 2 +Base centre (Cb) +The centre of the flare base. +Bottom width (Wb) The width of the base in the U axis direction. +Bottom depth (Db) The depth of the base in the V axis direction. +Height (H) +The height of the flare in the N axis direction. +Flare angle (AU) +The angle of the flare from the UN plane. +Flare angle (AV) +The angle of the flare from the VN plane. +Sphere +Create a sphere or a spheroid (radius varies). +On the Construct tab, in the Create Solid group, click the + Sphere icon. +Tip: Press C,3 to use the shortcut key. +Altair Feko 2022.3 +2 CADFEKO +Method 1: Centre, radius +p.108 +Centre (C) +The centre point of the sphere. +Radius (R): +The radius of the sphere. +Method 2: Centre, radius U, radius V, radius N +Centre (C) +The centre point of the sphere. +Radius (Ru) +The radius of the ellipsoid in the U dimension. +Rv +Radius (Rv) +Radius (Rn) +The radius of the ellipsoid in the V dimension. +The radius of the ellipsoid in the N dimension. +\ +Rn +Ru +Cylinder +Create a cylinder. +On the Construct tab, in the Create Solid group, click the + Cylinder icon. +Tip: Press C,4 to use the shortcut key. +Method 1: Base centre, radius, height +Base centre (B) +The centre of the cylinder base. +Radius (R) +Cylinder radius (parallel to the UV plane). +Height (H) +Cylinder height in the N direction measured from B. +Altair Feko 2022.3 +2 CADFEKO +Method 2: Base centre, top centre, radius +p.109 +Base centre (B) +The centre of the cylinder base. +Top centre (T) +The centre of the cylinder top. +Radius (R) +The cylinder radius (perpendicular to the line from B to +T). +Related tasks +Creating a UTD Cylinder +Cone +Create a cone. +On the Construct tab, in the Create Solid group, click the + Cone icon. +Tip: Press C,5 to use the shortcut key. +Method 1: Base centre, base radius, height, top radius +Base centre +(B) +Base radius +(Rb) +The centre of the base of the cone. +The radius of the cone base (parallel to the UV plane). +Height (H) +The cone height in the N direction measured from B. +Top radius +(Rt) +The radius of the cone top (parallel to the UV plane). +Method 2: Base centre, top centre, base radius, top radius +Base centre (B) +The centre of the base of the cone. +Top centre (T) +The centre of the top of the cone. +Base radius (Rb) +The radius of the cone base (perpendicular to the line +from B to T). +Top radius (Rt) +The radius of the cone top (parallel to the UV plane). +Method 3: Base centre, base radius, height, cone angle +Base centre (B) +The centre of the base of the cone. +Base radius (Rb) +The radius of the cone base (parallel to the UV plane). +Height (H) +The cone height in the N direction. +Flare angle (A) +The growth angle measured from the N axis. +Method 4: Base centre, top centre, base radius, cone angle +Base centre (B) +The centre of the base of the cone. +Top centre (T) +The centre of the top of the cone. +Base radius (Rb) +The radius of the cone base (perpendicular to the line +from B to T). +Flare angle (A) +The growth angle measured from the line defined +between B to T. +2.8.2 Constructing Complex Surfaces +Create fully parametric and complex surfaces. +Complex surfaces include crosses (cross, strip cross, spiral cross and T-cross), rings (ring, open ring +and split ring), hexagons (hexagon and strip hexagon) and a trifilar. As with basic geometry, use +Boolean, extend and transform operations to even more complex geometry. +Cross +Create a cross to be used either as a primitive or as a building block for constructing complex geometry. +On the Construct tab, in the Create Surface group, click the + Complex Surfaces icon. From the + Crosses drop-down list, select + Cross. +Lu +Arm length (Lu) +The arm length in the U axis direction. +Arm length (Lv) +The arm length in the V axis direction. +Strip width (Ws) +The width of the strip. +Altair Feko 2022.3 +2 CADFEKO +Lv +Ws +Strip Cross +Create a strip cross to be used either as a primitive or as a building block for constructing complex +geometry. +On the Construct tab, in the Create Surface group, click the + Complex Surfaces icon. From the + Crosses drop-down list, select + Strip Cross. +Lv +Lu +Ws +Centre point (C) +The centre point of the cross. +Arm length (Lu) +The arm length in the U axis direction. +Arm length (Lv) +The arm length in the V axis direction. +Strip width (Ws) +The width of the strip. +Slot width (w) +The width of the slot. +Spiral Cross +Create a spiral cross to be used either as a primitive or as a building block for constructing complex +geometry. +On the Construct tab, in the Create Surface group, click the + Complex Surfaces icon. From the + Crosses drop-down list, select + Spiral Cross. +Ls +Le +Ws +Centre point (C) +The centre point of the cross. +Arm length (L) +The arm length (all directions equal) +Edge length (Le) +The edge length (all equal). +Spiral length (Ls) +The length of the spiral at the end of each arm. +Altair Feko 2022.3 +2 CADFEKO +T-Cross +Create a T-cross to be used either as a primitive or as a building block for constructing complex +geometry. +On the Construct tab, in the Create Surface group, click the + Complex Surfaces icon. From the + Crosses drop-down list, select + T-Cross. +Le +Ws +Centre point (C) +The centre point of the cross. +Arm length (L) +The arm length (all directions) +Edge length (Le) +The edge length (all arms). +Strip width (Ws) +The width of the strip. +Ring +Create a ring to be used either as a primitive or as a building block for constructing complex geometry. +On the Construct tab, in the Create Surface group, click the + Complex Surfaces icon. From the + Rings drop-down list, select + Ring. +Centre point (C) +The centre point of the ring. +Outer radius (R) +The outer radius of the ring. +Inner radius (r) +The inner radius of the ring. +Open Ring +Create an open ring to be used either as a primitive or as a building block for constructing complex +geometry. +On the Construct tab, in the Create Surface group, click the + Complex Surfaces icon. From the + Rings drop-down list, select + Open Ring. +Outer radius (R) +The outer radius of the ring. +Inner radius (r) +The inner radius of the ring. +Start angle ( ) +The start angle of the ring. +Gap angle ( ) +The gap angle of the ring. +Altair Feko 2022.3 +2 CADFEKO +Split Ring +Create a split ring to be used either as a primitive or as a building block for constructing complex +geometry. +On the Construct tab, in the Create Surface group, click the + Complex Surfaces icon. From the + Rings drop-down list, select + Split Ring. +Centre point (C) +The centre point of the ring. +Outer radius (R) +The outer radius of the ring. +Inner radius (r) +The inner radius of the ring. +Start angle ( ) +The start angle of the ring. +Gap angle ( ) +The gap angle of the ring. +Hexagon +Create a hexagon to be used either as a primitive or as a building block for constructing complex +geometry. +On the Construct tab, in the Create Surface group, click the + Complex Surfaces icon. From the + Hexagons drop-down list, select + Hexagon. +Centre point (C) +The centre point of the hexagon. +Width (W) +The width of the hexagon. +p.114 +Altair Feko 2022.3 +2 CADFEKO +Strip Hexagon +Create a strip hexagon to be used either as a primitive or as a building block for constructing complex +geometry. +On the Construct tab, in the Create Surface group, click the + Complex Surfaces icon. From the + Hexagons drop-down list, select + Strip Hexagon. +Centre point (C) +The centre point of the strip hexagon. +Width (W) +The width of the hexagon. +Srip width (Ws) +The width of the strip. +Ws +Trifilar +Create a trifilar to be used either as a primitive or as a building block for constructing complex +geometry. +On the Construct tab, in the Create Surface group, click the + Complex Surfaces icon. Select + Trifilar. +Ws +Centre point (C) +The centre point of the trifilar. +Length (L) +The arm length. +Srip width (Ws) +The width of the strip. +2.8.3 Constructing Periodic Structures +Create periodic structures. +Periodic structures include shapes in the form of crosses, rings, hexagons, a trifilar, a plane and an +ellipse. Use the shapes to construct a unit cell for solving with periodic boundary conditions. +Related tasks +Accessing the Periodic Structures Tab on the Ribbon +Accessing the Periodic Structures Tab on the Ribbon +Open the Periodic Structures tab on the ribbon to access advanced tools related to defining periodic +structures. +By default, the Periodic Structures tab is not displayed on the ribbon. To access the Periodic +Structures tab, you must configure the ribbon to show the tab. +On the Home tab, in the Extensions group, click the + Periodic Structures icon. +When the Periodic Structures tab is enabled, it is located on the ribbon between the Transform tab +and Source/Load tab. +Figure 55: The ribbon in CADFEKO (Periodic Structures tab) +Creating Shapes +Create shapes for periodic structures. +Shapes include crosses (cross, strip cross, spiral cross and T-cross), rings (ring, open ring and split +ring), hexagons (hexagon and strip hexagon), a trifilar, a plane and an ellipse. Use these shapes to +construct a unit cell for solving with periodic boundary conditions and to obtain transmission and +reflection coefficients. +Cross Shape +Create a cross shape to be used in the construction of a unit cell. +On the Periodic Structures tab, in the Shapes group, from the + Crosses drop-down list, select + Cross. +Arm length (Lu) +The arm length in the U axis direction. +Lu +Arm length (Lv) +The arm length in the V axis direction. +Strip width (Ws) +The width of the strip. +Lv +Ws +Strip Cross Shape +Create a strip cross shape to be used in the construction of a unit cell. +On the Periodic Structures tab, in the Shapes group, from the + Crosses drop-down list, select + Strip Cross. +Lu +Lv +Ws +Arm length (Lu) +The arm length in the U axis direction. +Arm length (Lv) +The arm length in the V axis direction. +Strip width (Ws) +The width of the strip. +Slot wdith (W) +The width of the slot. +Spiral Cross Shape +Create a spiral cross shape to be used in the construction of a unit cell. +On the Periodic Structures tab, in the Shapes group, from the + Crosses drop-down list, select + Spiral Cross. +Le +Ls +Arm length (L) +The arm length from the origin (all directions). +Edge length (Le) +The arm length of the first extension. +Ws +Edge length (Ls) +The arm length of the last extension. +Strip width (Ws) +The width of the strip. +Altair Feko 2022.3 +2 CADFEKO +T-Cross Shape +p.117 +Create a T-cross shape to be used in the construction of a unit cell. +On the Periodic Structures tab, in the Shapes group, from the + Crosses drop-down list, select + T-Cross. +Le +Ws +Arm length (L) +The arm length (all directions). +Edge length (Le) +The length of the T-section. +Strip width (Ws) +The width of the strip. +Ring Shape +Create a ring shape to be used in the construction of a unit cell. +On the Periodic Structures tab, in the Shapes group, from the + Rings drop-down list, select + Ring. +Outer radius (R) +The outer radius of the ring. +Inner radius (r) +The inner radius of the ring. +Split Ring Shape +Create a split ring shape to be used in the construction of a unit cell. +On the Periodic Structures tab, in the Shapes group, from the + Rings drop-down list, select + Split Ring. +Outer radius (R) +The outer radius of the ring. +Inner radius (r) +The inner radius of the ring. +Start angle ( ) +The start angle of the ring. +Gap angle ( ) +The gap angle of the ring. +Open Ring Shape +Create an open ring shape to be used in the construction of a unit cell. +On the Periodic Structures tab, in the Shapes group, from the + Rings drop-down list, select + Open Ring. +Outer radius (R) +The outer radius of the ring. +Inner radius (r) +The inner radius of the ring. +Start angle ( ) +The start angle of the ring. +Gap angle ( ) +The gap angle of the ring. +Hexagon Shape +Create a hexagon shape to be used in the construction of a unit cell. +On the Periodic Structures tab, in the Shapes group, from the + Hexagons drop-down list, select + Hexagon. +Width (W) +The width of the hexagon. +Strip Hexagon Shape +Create a strip hexagon shape to be used in the construction of a unit cell. +On the Periodic Structures tab, in the Shapes group, from the + Hexagons drop-down list, select + Strip Hexagon. +Altair Feko 2022.3 +2 CADFEKO +Ws +Width (W) +The width of the hexagon. +Srip width (Ws) +The width of the strip. +p.119 +Plane Shape +Create a plane shape to be used in the construction of a unit cell. +On the Periodic Structures tab, in the Shapes group, select + Plane. +Width (W) +The width of the plane. +Depth (D) +The depth of the plane +Ellipse Shape +Create an ellipse shape to be used in the construction of a unit cell. +On the Periodic Structures tab, in the Shapes group, select + Ellipse. +Radius (Ru) +The radius in the U axis direction. +Rv +Ru +Radius (Rv) +The radius in the V axis direction. +Trifilar Shape +Create a trifilar shape to be used in the construction of a unit cell. +On the Periodic Structures tab, in the Shapes group, select + Trifilar. +Altair Feko 2022.3 +2 CADFEKO +Ws +Length (L) +The arm length. +Srip width (Ws) +The width of the strip. +p.120 +Building a Shape +Build the geometry of a shape to use in a model. +On the Periodic Structures tab, in the Build group, select + Build Geometry. +Tip: Directly create shape geometry using the Complex Surfaces + icon (Construct +tab). +Creating a Unit Cell +Create a unit cell for solving periodic structures. +Create a finite layered structure comprising layers of substrate and metal to solve with periodic +boundary conditions. Alternately imprint the structure onto a surface to construct frequency selective +surfaces (FSS). +Some applications for the unit cell are as follows: +• Use as periodic structure for solving transmission and reflection coefficients. +• Realise the geometry and attach to a flat or curved surface to be used as a frequency selective +surface (FSS). +Defining a Unit Cell +Define a layered unit cell using layers of substrate, free space and metal. +1. On the Periodic Structures tab, in the Structure group, select + Unit Cell. +Figure 56: The Create Unit Cell dialog. +2. From the Reference Vector drop-down list, select one of the following: +• To specify the skew angle relative to the U axis, select U vector. +• To specify the skew angle relative to the V axis, select V vector. +3. Under Dimensions, specify dimensions and orientation of the unit cell: +a) In the Skew angle ( ) field, specify the unit cell skew angle. +Tip: A skew angle of 0 degrees yields a rectangular unit cell. +b) In the Distance (U) field, specify the unit cell dimension in the U axis direction. +c) In the Distance (V) field, specify the unit cell dimension in the V axis direction. +4. For each layer: +a) From the Method drop-down list, select one of the following: +• To specify a layer of substrate (dielectric) or vacuum (Free space), select Substrate. +• To specify a layer of metal, select Metal or Aperture. +Tip: A Metal layer realises the shape exactly. An Aperture layer realises a +metallic layer minus the shape. +b) For a layer of substrate, specify the following: +• In the Medium field, specify the dielectric medium or Free space for vacuum. +• In the Thickness field, specify the thickness of the layer. +c) For a layer of metal (Metal or Aperture), specify the following: +• In the Shape field, specify the shape to be used. +• In the Rotation field, specify the rotation of the shape. +• [Optional] To specify a thickness, select the Define thickness check box and in the +Thickness field specify the metal thickness. +Tip: Specifying thickness creates a 3D layer of metal. +5. +In the Z-value at the top of layer 1 field, specify the Z axis position of the top of layer 1. +6. Click OK to define the unit cell and to close the dialog. +Building a Unit Cell +Build the geometry of a unit cell to use in a model. +1. On the Periodic Structures tab, in the Build group, select + Build Geometry. +2. +[Optional] On the Build Geometry dialog, select the Set Periodic Boundary Condition (PBC) +check box to apply a periodic boundary condition based on the unit cell dimensions. +2.8.4 Creating Complex Geometry Using Boolean +Operations +Boolean operations include union, separate, subtract from, intersection, split and stitch. These operators +allow parts to be combined. +Union +Combine multiple geometry parts into a single part and to ensure mesh connectivity once the geometry +is meshed. +Note: Geometry parts that touch or intersect, but that are not unioned, will not be +physically connected in the simulation mesh (except for FDTD where unioning is not +required.) +Unconnected geometry results in invalid meshes (overlapping or misaligned) that could generate errors +during the Feko solution. Unioning geometry ensures that faces occupying the same space are merged +into a single face where solution settings can be applied. +In some cases it could happen that a union of geometry parts fails. First use the Simplify (repair +operation) tool on the primitive parts before attempting the union again. +Note: In some cases it could appear that a union of faces from imported geometry form +closed regions, but do not result in new regions (details tree). The stitch tool would be +better suited in this case. +Related concepts +Stitch +Simplify +Combining Geometry Using Union +Apply the union operation to obtain a single, physically connected part. +1. Select the geometry parts that you want to union. +2. On the Construct tab, in the Modify group, click the + Union icon. +The geometry parts are physically connected and will create an electrically connected mesh once the +geometry is meshed. +Editing a Part in a Union +Modify an item in a union. The union may contain multiple multi-level unions. Parts inside unions can +be edited directly, for example, changing the height of a cuboid. When more complex editing is required +(setting properties on faces), the part should be copied out, edited and placed back into the union. +1. +In the model tree, find the relevant union that you want to edit. +2. Under the union, select the part that you want to edit. +3. From the right-click context menu, select Copy (duplicate). +4. Edit the duplicated part. +5. +In the model tree, drag the modified part back into the union of Step 2. +6. From the right-click context menu, select Replace. +You can replace a part with a completely different part. For example, replace a cuboid with a flare +or sphere. +Subtract From +Create complex geometry by subtracting geometry from an overlapping (target) part. +After a subtract operation is performed, the target part is indicated by the + icon in the model tree. +Figure 57: The + indicating the target part in the subtract operation. +Note: Regions are taken into account during the subtract operation: +• Subtracting a shell structure (a free space region that implies an empty / hollow +closed structure) generates new regions, faces or edges on intersecting geometry. No +geometry is removed. +• Subtracting a solid structure (a region that is not set to free space) results in geometry +being removed from any intersecting parts. +Figure 58: An intersecting flare and sphere (on the left), flare subtracted from sphere (shell) (middle) and flare +subtracted from sphere (solid) (to the right). +Altair Feko 2022.3 +2 CADFEKO +Subtracting Geometry +p.125 +Apply the subtract operation to remove the overlapping part of the geometry. +1. Select the geometry part to subtract. +2. On the Construct tab, in the Modify group, click the + Subtract From icon. +3. Select the geometry part to be subtracted from (target). +The overlapping part of the geometry is removed (for solids) or new faces, edges, regions are created +on the overlapping part (for shells). +Intersection +Create complex geometry by removing non-overlapping parts and keeping the common part. +Note: If an intersection operation intersects two overlapping faces, the resulting faces have +the properties common to both parents. +Figure 59: A cylinder and cone (on the left) and the intersection of the cylinder and cone (on the right). +Intersecting Geometry +Apply the intersect operation to remove non-overlapping parts. +1. Select the relevant geometry parts. +2. On the Construct tab, in the Modify group, click the + Intersection icon. +The overlapping parts are removed. +Split +Divide the selected geometry parts at a specified plane. +Note: If a subtract operation splits a face in two, both the resulting faces inherit the +properties of the parent (original) face. +Splitting a Geometry Part at a Specified Plane +Apply the split operation at a specified plane to divide a geometry part. +1. Select the geometry part that you want to split. +2. On the Construct tab, in the Modify group, click the + Split icon. +Figure 60: The Split dialog. +3. Under Origin, specify the position of the plane to split the geometry. +4. Under Plane, select one of the following: +• UV +• UN +• VN +5. Under Rotate split plane, specify the angle of rotation around the plane selected in Step 4. +6. Click Create to split the geometry and to close the dialog. +Separate +Obtain the individual parts that were used to create a union. +A union could consist of several parts of which some could also be unions themselves. The separate +tool, in a sense, copies out all the parts that were used to make the last union. If the separated (copied +out) parts are unions themselves, then the tool can be run again to separate those parts as well. +Note: +When a union that contains a transform is separated the transform is deleted and the +entities revert back to the state prior to being unioned. +Altair Feko 2022.3 +2 CADFEKO +Separating a Union +Apply the separate operation to separate (disband) a union. +1. Select the geometry part that you want to separate. +2. On the Construct tab, in the Modify group, click the + Separate icon. +All the parts contained in the union are listed in the model tree. +p.127 +Convert to Group +Collect all the sub-parts (child parts) of a parent part into a group. +A part could consist of several sub or child parts of which some could contain further child parts. This +tool converts the child parts into a group with a single label. +Note: Only the highest level child parts are converted to a group. +Converting a Part to a Group +Apply the convert to group tool to obtain the child parts of a part and group them together. +1. Select the geometry part that you want to convert to a group. +2. On the Construct tab, in the Modify group, click the + Convert to Group icon. +The child parts contained in the parent part are grouped together under a single label in the +model tree. +Stitch +When imported geometry (sheet parts) are unconnected or have small sections that overlap, use the +stitch operation to ensure mesh connectivity. +Sheet parts that are within the specified tolerance are considered to be connected and meshed +correctly. +The stitch tool can lead to strange geometry display in CADFEKO due to the tolerance of edges, faces +and nodes being large and displayed anywhere within the tolerance area. The mesh does not suffer the +same display issues since the mesh elements have a very small tolerance. +Note: +Use the stitch operation as a replacement for the union operation for sheet parts that have +small misalignments or imperfections (usually introduced through CAD translation). +The stitch operation is generally faster and more efficient than the union operation, but +is limited to sheet bodies and introduces a tolerance (small uncertainty in the exact +geometrical location). +Altair Feko 2022.3 +2 CADFEKO +Stitching Sheet Parts +Apply the stitch operation to ensure electrical connectivity for unconnected sheet parts. +1. Select the sheet parts that you want to stitch. +2. On the Construct tab, in the Modify group, click the + Stitch icon. +p.128 +Figure 61: The Stitch Parts dialog. +3. +[Optional] Clear the Auto-calculate tolerance check box and in the Tolerance field specify the +range over which adjoining faces are stitched. +4. Click the Create button to stitch the faces and to close the dialog. +Electrical Connectivity When Combining Geometry +Geometry parts need to physically connect to ensure electrical connectivity once the model is meshed +(except when using FDTD). Use the union, stitch or imprint operation to ensure electrical connectivity. +The simulated model has electrical connectivity as long as the mesh elements align and do not +intersect. This results in the correct basis functions being created for the simulation. The following +operations allow for geometry parts to be physically connected by ensuring that the resulting mesh +elements align correctly: +Union +Stitch +This operation is used to physically connect geometry parts. This is the default and most common +operator used in CADFEKO. +This operation is used to physically connect imported sheet parts where geometry is unconnected +or have small sections that overlap. The stitch operation is generally faster than the union +operation. +Imprint points +This option allows you to specify points and projecting the points onto the closest point of the +selected geometry part, either on a face or on an edge. The imprinted points are considered +when meshing the model. Snap to the imprinted points to create physically connected geometry. +Imprinting points is especially useful when connecting wires to faces when you do not want to +union the wire onto the face. +Related concepts +Union +Stitch +Display Setting for Mesh Connectivity +Related tasks +Imprinting Points onto a Face or Edge +2.8.5 Extending Geometry to Create Complex Geometry +Use the spin, loft, sweep and path sweep on basic geometry to create complex geometry. +Spin +Rotationally sweep a geometry part, containing only edges and faces (not solids or closed regions), +around an axis through a specified angle. +The spin operation applied to lines produces faces and to faces produces volumes. For surface bodies, +the body must have a single boundary which does not close on itself and no edge may be attached to +more than two faces. +Note: The spin operation is applied separately to each of the selected geometry parts. +Figure 62: Spinning a curve results in a surface. +Figure 63: Spinning a surface results in a solid. +Spinning Geometry to Create Surface or Solids +Apply the spin operation to rotate the selected geometry around an axis to create surfaces or solids. +1. Select the geometry part that you want to spin. +2. On the Construct tab, in the Extend group, click the + Spin icon. +Figure 64: The Spin dialog. +3. Under Origin, specify the origin around which the geometry is spun. +4. Under Axis direction, specify the orientation of the spin axis. +5. Under Rotation angle, specify the angle through which the geometry is spun. +6. Click Create to spin the selected geometry and to close the dialog. +Altair Feko 2022.3 +2 CADFEKO +Loft +p.131 +Create a smooth surface by connecting two curves, two surfaces or an edge and a surface; or connect +two surfaces to create a solid shape. +Loft any geometry parts that contain edges / faces. Solid or closed regions cannot be lofted. +Figure 65: The lofting of edges within parts. +For surface bodies, the body must have a single boundary which does not close on itself and no edge +may be attached to more than two faces. +Figure 66: The loft of two ellipses to create a solid (on the left) and the loft of two elliptic arcs to create a cylindrical +surface (on the right). +For curved bodies (bodies without faces), the body must be continuous. Open profiles (arcs) and closed +profiles (circles) may be lofted, but cannot be used together in a single loft. A valid surface loft can be +created, for example, between two lines, between two circles (closed elliptical arcs), between a line and +an open polyline, or between a circle and a closed polyline, but a line cannot be lofted to a circle or to a +closed polyline. +Different surface primitives, such as ellipses and rectangles, can be specified as the loft cross-section +profiles to create a solid body. +If the two loft profiles have an equal number of edges or vertices, the loft operation connects each pair +of edges. For an unequal number of wires / edges, some vertices on one profile are matched to a single +vertex on the other profile. Points can be imprinted on one or both of the profiles to improve matching, +or to influence the shape of the loft. +Figure 67: The loft of a line and polyline (on the left) and the preview of the loft (on the right). +When lofting closed edges or faces, use the Alignment index to change the relative alignment of the +two profiles in the loft, thereby introducing or removing twists. +Loft operations can be performed on edges / wires and faces within parts if the selected entities are of +the same type. Entities within parts are copied out during the loft operation. +Note: Copied entities are snapshots of the model when the copy was made. The resulting +loft is not linked to the parent object in any way and will not update with changes made to +the original geometry. +Related tasks +Alignment Index +Lofting to Create a Smooth Surface +Apply the loft operation between curves, between surfaces or between an edge and face to create a +smooth surface. +1. Select the two geometry entities that you want to loft. +2. On the Construct tab, in the Extend group, click the + Loft icon. +Figure 68: The Loft dialog. +To achieve a valid loft, it may be necessary to reverse the orientation of one of the profiles in the loft, +so that the bounding edge matching is done in the opposite direction along the profile. +3. +[Optional] Select the Reverse orientation check box to reverse the orientation of one of the +profiles in the loft. +Figure 69: Loft preview showing a valid loft (on the left) and an invalid loft (to the right). +When lofting closed edges or faces, you can introduce twists or remove twists to change the relative +alignment of the two profiles in the loft. +4. +5. +6. +In the Alignment index field, increase the number to change the alignment index. +In the Label field, specify a unique label for the loft operation. +[Optional] Use the Workplane tab to enter a resulting origin (location) and orientation for the +loft. +7. Click the Create button to apply the loft operation and to close the dialog. +Sweep +Extrude the selected geometry part from a start point to an end point. +The sweep path is taken as the straight line between the start point and the end point. +Figure 70: A polygon (on the left) and the polygon swept along the Z axis (on the right). +Sweeping Geometry to Create a Surface or Solid +Apply the sweep operation to curves to create surfaces, and to surfaces to create solids. +1. Select the geometry part that you want to sweep. +2. On the Construct tab, in the Extend group, click the + Sweep icon. +Figure 71: The Sweep dialog. +3. Under From, specify the start point for the sweep operation. +4. Under To, specify the end point for the sweep operation. +5. Click Create to sweep the geometry and to close the dialog. +Path Sweep +Sweep (or extrude) geometry along a path. +The sweep path may be any part that consists of only free edges and curves that form a joined, non- +overlapping path. +Figure 72: A polygon and fitted spline (on the left) and the polygon swept along the fitted spline (on the right). +Sweeping Geometry Along a Path +Sweep curves along a path to create surfaces, and surfaces to create solids. +1. Select the geometry part that you want to sweep. +2. On the Construct tab, in the Extend group, click the + Path Sweep icon. +Figure 73: The Create path sweep dialog. +3. Select the path to sweep along. +The selected geometry is swept along the specified path. +2.8.6 Transforming Geometry +Transform geometry (or meshes) using the translate, mirror, rotate, scale and align operations. +Translating Geometry from Start Point to End Point +Move the selected geometry from a specified start point to an end point. +1. On the Transform tab, in the Transform group, click the + Translate icon. +Figure 74: The Translate dialog. +2. Under From, specify the start point of the translation. +3. Under To, specify the end point of the translation. +4. Click OK to translate the selected geometry parts and to close the dialog. +Mirroring Geometry about an Axis +Apply the mirror operation to move the selected geometry part about an axis. +1. Select the geometry part that you want to mirror. +2. On the Transform tab, in the Transform group, click the + Mirror icon. +Figure 75: The Mirror dialog. +3. Under Origin, specify the origin of the mirror operation. +4. Under Plane, specify the mirror plane. +5. Under Rotate mirror plane, specify the rotation of the mirror plane. +6. Click the OK button to mirror the selected geometry part and to close the dialog. +Rotating Geometry +Apply the rotate operation on the selected geometry part. +1. Select the geometry part that you want to rotate. +2. On the Transform tab, in the Transform group, click the + Rotate icon. +Figure 76: The Rotate dialog. +3. Under Origin, specify the origin for the rotate operation. +4. Under Axis direction, specify the direction of the axis around which the rotation will take place. +5. +In the Angle [degrees] field, specify the rotation angle in degrees. +6. Click the OK button to rotate the selected geometry part and to close the dialog. +Scaling Geometry +Apply a scale operation on the selected geometry part. +1. Select the part that you want to scale. +2. On the Transform tab, in the Transform group, click the + Scale icon. +Figure 77: The Scale dialog. +3. Under Origin, specify the origin around which the scaling is applied. +4. Under Scale factor, specify the scaling factor. +5. Click OK to scale the selected geometry part and to close the dialog. +Placing Geometry on Objects (Align) +Align an object onto another object, for example, placing an antenna onto a ship. +1. Select the geometry part that you want to align relative to another part. +2. On the Transform tab, in the Transform group, click the + Align icon. +Figure 78: The Align dialog. +3. Under Source workplane, specify the following: +a) Under Origin, specify the origin for the source workplane. +b) Under U vector and V vector, specify the workplane orientation. +c) Under Rotate workplane, specify the angle to rotate the workplane by. +4. Repeat Step 3 for the Destination workplane. +5. Click OK to create align the selected geometry part and to close the dialog. +Tip: Press Ctrl+Shift at the location of the desired origin in the 3D view. +Projecting Geometry onto Other Geometry +Project the edges of the selected part onto a target part. Where projected faces form a closed path, a +new face is created. +1. Select the part whose edges you want to project. +2. On the Transform tab, in the Imprint group, click the + Project icon. +Figure 79: The Project dialog. +3. Select the target part to project onto. +The edges of the selected parts are projected onto the faces of the target part. +Imprinting Points onto a Face or Edge +Project a list of specified points onto the selected geometry (either on a face or an edge) to ensure +vertices at these points after meshing. +The specified points are projected onto the closest point on the selected part. +Note: +• Points may not be imprinted on top of existing points. +• Points can only be imprinted on a single geometry part at a time. +1. Select the geometry part where you want to imprint the points. +2. On the Transform tab, in the Imprint group, click the + Imprint Points icon. +Figure 80: The Imprint Points on Geometry dialog. +3. Specify the points to imprint using one of the following workflows: +• Specify the points manually. +• Import the points from a file. +• Use point-entry to specify the points. +4. Click Create to imprint the points and to close the dialog. +The imprint operation creates a new entry in the model tree to still allow access to the part without the +imprinted points. +Modifying Face Normal / Orientation +The face normal of a triangle is determined in a mathematically positive sense from the direction of the +edges. +A face normal is of importance when it is required to specify settings for a specific side of a face since +the setting is applied on either the face normal side or the opposite side. The face normal can be +modified so that a group of faces have the same orientation and settings can be applied to the group. +For example: +• PO using the option to only illuminate from the front. +• RL-GO when setting the face absorbing properties for the normal side and opposite to normal side. +• The combined field integral equation (CFIE) requires closed structures and the face normal to point +away from the zero-field region. +• Windscreen and specifying the order of the layers for the windscreen. +• Thin dielectric sheets for RL-GO, PO and LE-PO, the normal side is important when the specifying +the order of the layers. +Related concepts +Thin Dielectric Sheets +Altair Feko 2022.3 +2 CADFEKO +Related tasks +Creating a Windscreen Layer +Using the CFIE For Closed PEC Regions +Solving Faces with Physical Optics (PO) +Solving a Model with RL-GO +Reversing Face Normals +Invert the normal of a face. +p.141 +1. Select the part for which you want to reverse the face normal. +2. On the Transform tab, in the Alter group, click the + Reverse Normals icon. +Use a display setting to colour the geometry according to the normal direction of the faces. +3. +[Optional] On the 3D View context tab, on the Display Options tab, in the Style group, click the +Colour icon. From the drop-down list select + Element Normal. +Note: +• Geometry +◦ Normal side: Green +◦ Reverse side: Red +• Mesh +◦ Normal side: Blue +◦ Reverse side: Brown +Simplify +The simplify tool removes redundant regions, faces and edges. +Dielectric boundary faces are redundant if they have the same medium (for example, free space, the +same metal or dielectric) on both sides. When a face separating an internal free space region from the +outside free space is deleted, the internal region is merged with the outside one. Since the outside +medium is free space, faces can only be removed from closed regions if the internal medium is set to +free space. +Edges are not redundant if the face normal on either side of the edge are in opposite directions. +The simplify operation results in the model being electromagnetically the same as the original, but may +not have the same meshing constraints. For example, if an imprinted point is removed, a mesh vertex +cannot be guaranteed at this location. Faces cannot be deleted unless the regions they separate can be +merged. The same applies to edges on face boundaries and geometry points at the ends of edges. +Figure 81: Simplify operations. +Simplifying Geometry +Use the simplify tool to remove redundant regions, faces and edges. +1. On the Transform tab, in the Simplify group, click the + Simplify icon. +Figure 82: The Simplify dialog. +2. Select the relevant options. +3. Click Create to simplify the model and to close the dialog. +Exploding Geometry Parts +Break up a geometry part into separate faces and wires. +Note: The new parts represent a snapshot of the geometry at the time it was exploded. +The faces and wires are not parametric. +1. Select the geometry part that you want to explode. +2. On the Transform tab, in the Alter group, click the + Explode icon. +The geometry part is exploded into separate parts and listed in the model tree. The + icon indicates +that it is an exploded face. +2.8.7 Re-Evaluating Geometry +Re-evaluate rebuilds the full model and performs all operations again, replacing any cached geometry in +the operator tree. It is mostly used when there have been improvements or corrections in Parasolid (3D +modelling engine). +CADFEKO uses advanced mapping algorithms to keep track of individual items when the geometry +is modified. A model re-evaluates automatically when a model is loaded that was created in earlier +versions. Resolve any suspect items before making any changes to the model or setting additional +properties. +Not all the mapping information is available in models created in earlier CADFEKO versions. As a result, +it may be impossible to map all items during the re-evaluation and the items are marked suspect. All +properties (such as local mesh sizes) set on suspect items, will be lost during re-evaluation. Faces or +edges that were deleted, may re-appear if they cannot be successfully mapped. +It is possible that during geometry re-evaluation, new faults are identified in the model. This could +happen with models built in previous versions of CADFEKO, or models containing imported geometry. +These faults may provide additional information that is useful in repairing a model. +Re-Evaluating Geometry +For models created in previous CADFEKO versions, re-evaluate to rebuild and perform all operations on +the model again. +1. Select the geometry part or full model that you want to re-evaluate. +2. On the Transform tab, in the Alter group, click the + Re-evaluate icon. +The selected geometry part (or full model) is re-evaluated. +2.8.8 Excluding a Part from the Model and Solution +A geometry part (or mesh part) that does not contain any ports, sources or loads can be temporarily +excluded from the model without having to delete the part. +1. +In the model tree select the geometry part (or mesh part) that you want to exclude from the +model. +2. From the right-click context menu, select Include/Exclude. +The excluded part is hidden in the 3D view. The part is not (re)meshed and is excluded in the mesh info +dialog. +An excluded part is indicated by the + icon in the model tree. +Note: To include the part again, from the right-click context menu select Include/ +Exclude. +Related tasks +Viewing the Mesh Information +2.8.9 Hiding a Part in the 3D view +Hide a part temporarily in the 3D view. +1. +In the model tree select the geometry part (or mesh part) that you want to hide in the 3D view. +2. Select one of the following workflows to hide the selected part: +• From the right-click context menu, select Show / Hide. +• Press Ctrl+H. +The selected part is hidden in the 3D view. A hidden part is indicated by a greyed out icon in the +model tree. +2.9 Component Library +The component library contains an extensive list of common components, such as antennas and +platforms. +This tool allows you to add components to new or existing models. Change the centre frequency, solver +method and other settings to create an antenna that suits your requirements, thereby reducing the +development time. +The component library tool is also a great way for students to learn about the different types of +antennas and its typical characteristics. +Figure 83: The component library. +2.9.1 Introduction to the Component Library +The component library contains a list of components that can be used as a new model or be added to an +existing model. +A component can be one of the following: +• Antenna +Each antenna component is defined by fully parametric geometry, created using variables +and mathematical expressions. When a variable is modified, any item in the antenna that +references the variable is re-evaluated and updated. +Antennas are indicated by the + icon in the library. +Altair Feko 2022.3 +2 CADFEKO +• Platform +p.146 +A platform is geometry that is used as a mechanical structure for mounting antennas, for +example, a tower truss. +Platforms are indicated by the + icon in the library. +2.9.2 Component Library Start Page +The component library start page is displayed when opening the Component library dialog, and a +component has yet to be selected from the component list. +The start page shows the steps for adding a component. +Figure 84: The component library start page. +Tip: To view the component library start page once a component was selected, close and +reopen the Component library dialog. +2.9.3 Quick Tour of the Component Library +The component library consists of two main panels. +The first panel allows you to browse through the available components. The second panel (only +applicable to antennas) allows you to refine the selected antenna. +Figure 85: The Component library dialog. On the left, the first panel for browsing components and to the right, the +second panel for refining the component. +1. Components +View the list of components (antennas and platforms) in the component library. Find a +component quickly by either entering filter text or filter the list according to the component +type. To select a component, click on an item in the list. +2. Geometry preview / results +View images of the selected component in 1. Click on an image to maximise and click again +to minimise. +3. Description +View a summary of the selected component in 1, as well as keywords relevant to the +component. +Tip: Use the keywords as filter text in 1 to find similar components. +4. Antenna settings +Refine the selected antenna with additional options and settings. +5. +Click the + icon to view the solution methods in the Feko documentation. +Altair Feko 2022.3 +2 CADFEKO +6. Solver information +p.148 +View a summary of the solution methods that can be selected to solve the antenna. Not +all solution methods are supported for each component due to differences in how the +component model is set up. +2.9.4 Workflows for Using the Component Library +There are two workflows available when using the component library. +1. Browse the component library, select a component, and create a new model[9]. +2. Open an existing .cfx file and add a component to the existing model. +2.9.5 Adding a Component to a Model +Browse the components in the component library, select a component and either create a new model +from the component or add the component to an existing model. +1. Open the Component library dialog using one of the following workflows: +• On the Home tab, in the File group, click the + Component Library icon. +• Press Ctrl+L to use the keyboard shortcut. +The Component library dialog is displayed +2. Select the component using one of the following workflows: +• Select a component from the library by clicking on a component in the list. +• Enter the filter text[10] criteria in the Filter field. +3. Proceed to the next step in adding the component: +• if you selected an antenna, click Next[11] and proceed to Step 4. +• if you selected a platform, proceed to Step 9. +4. +In the Frequency (Hz) field, specify the centre frequency of the antenna. +Frequency scaling will be applied and the geometry of the antenna will be added according to the +specified centre frequency, +5. From the Solver type drop-down list, select the desired solver type for the antenna. +6. +In the Add configurations field, select one of the following: +9. This workflow assumes that there is no model open (the CADFEKO start page is displayed). +10. The filter text criteria is not case-sensitive. +11. An alternative method is to double-click the antenna in the list. +• Both single frequency and frequency range +Select this option to add two standard configurations to the model. The first +configuration is at a single frequency and the second configuration uses a continuous +(interpolated) range. +• Single frequency +Select this option to add a standard configuration at a single frequency to the model. +• Frequency range +Select this option to add a standard configuration using a frequency range to the model. +For FDTD a discrete frequency configuration is added. +• None +Select this option if no configurations are to be added to the model. +7. Click the Add ground plane check box to add a ground plane. This option is only available for +antenna components that have a ground plane (either finite or infinite ground plane). +8. Click the Align created component in model check box if you want to use the Align tool to +place the component. +9. Click Create model/Add to model to create the model or to add the component to the existing +model. +If the Align created component in model check box was selected in Step 8, the Align dialog is +displayed. Use the Align tool to change the placement and orientation of the component. +Note: Click Cancel on the Align dialog to use the default placement at the origin. +The component is added as a new model or added to an existing model using the default workplane. +Related concepts +Workplanes +Related tasks +Placing Geometry on Objects (Align) +Component Library Conventions +A set of naming conventions are used in the definition of antenna-specific variables, configurations, and +units in components. +Variables +All antenna-specific variables start with the antenna name (for example, Dipole1). When a new antenna +is added and one of its variable names is not unique, the antenna name is incremented (for example, +Dipole1, Dipole2). +An underscore (“_”) is used as a delimiter. +Note: To change the centre frequency of an antenna after it was added to a model, modify +the antenna_f_ctr variable (for example, Dipole1_f_ctr). +Configurations +All antenna-specific configurations start with the antenna name (for example, Dipole1). +• A configuration specified at a single (centre) frequency is indicated by the _f_ctr suffix (for +example, Dipole1_f_ctr). +• A configuration specified over a frequency range is indicated by the _f_range suffix (for example, +Dipole1_f_range). For a FDTD a discrete frequency configuration is added. +Units +When creating a component in a new model, the model unit is set to millimetres if the centre frequency +is greater than 1 GHz. +Related concepts +Variables +Multiple Configurations +Model Unit +2.10 Groups +Organise geometry and mesh parts by grouping geometry and mesh in the model tree. +2.10.1 Creating a Group +Move the selected geometry parts or mesh parts into a group in the model tree. +Note: Geometry parts and mesh parts cannot be added to the same group. +1. Select the geometry part or mesh parts that you want to place in a group. +2. On the Transform tab in the Groups group, click the + Create icon. +A group is indicated by the + icon in the model tree. +2.10.2 Moving a Part into an Existing Group +Move a selected geometry part or mesh part into an existing group. +1. Select the geometry part or mesh parts that you want to move into in a group. +2. From the right-click context menu, select Group > Move to. +3. From the drop-down list select one of the following: +• To create a new group, click (new). +• To move the selected part into an existing group, select a group. +2.10.3 Disassembling a Group +Separate a group and move its content back to the same level as the group in the model tree. +1. Select the group in the model tree that you want to disassemble. +2. On the Transform tab in the Groups group, click the + Disassemble icon +The group is disassembled and its parts placed at the same level in the model tree as the original +group. +2.10.4 Removing a Part from a Group +Remove a part from a group and place at the same level in the model tree as the group. +1. Select the geometry part or mesh parts that you want to remove from the group. +2. On the Transform tab in the Groups group, click the + Move Out icon. +The selected part is moved out from the group and placed at the same level in the model tree as its +former group. +2.11 Repairing Geometry +2.11.1 Creation History of a Geometry Part +Remove the creation history of a geometry part to reduce memory and processing time for complex +models by converting it to a primitive part. +CADFEKO stores the creation history of every part, allowing you to modify the part at any point in the +creation history, although the history may require a significant amount of memory and processing time +for complex models. +For example, if a small component of a union operation is modified, CADFEKO needs to recreate the +parent parts to re-execute the union. Since these are not stored at every level, it means constructing +them again from the lowest level up. However, quite often a large part of the model remains +unchanged. +For example, often the model of a specific motor vehicle will remain the same, but it is common to place +different antennas on such a vehicle. As a result, it is not required to re-evaluate the vehicle each time +a small part of the geometry is changed. +Note: Depending on the complexity of the model, this operation may require a significant +amount of time. +Converting a Geometry Part to a Primitive +Create a primitive of the geometry part. +1. Select the geometry part that you want to convert to a primitive. +2. On the Transform tab, in the Alter group, click the + Convert to Primitive icon. +The primitive part is indicated by the + icon in the model tree. +Note: +• The history of the CAD model is removed. +• Removing the history can reduce the size of large .cfx files. +2.11.2 CAD Fixing Tools Overview +Use the CAD fixing tools to repair a range of CAD geometry issues and faults. The tools repair the fault- +containing CAD model for analysis by reducing the complexity and removing faults in the model. +Tip: +• Apply the CAD fixing tools directly after importing a model. +• First, attempt the Repair part tool. +• In a number of cases, it may be necessary to apply several of the CAD fixing tools in +succession to obtain a usable model. +For most cases, the default settings of the CAD fixing tools will suffice. When modifying the advanced +settings of the CAD fixing tools, a general rule of thumb is to use the smallest tolerance possible, or no +tolerance at all, if the option allows. +Note: Specified tolerances are given in the model unit. +Related concepts +Repair Part +Related tasks +Converting a Geometry Part to a Primitive +2.11.3 Repair Part +The Repair part tool heals a body in an attempt to create a valid geometry part. +The tool attempts to fix the following: +• topology with an invalid sense +• invalid edge and vertex tolerances +• invalid geometry +• self-intersecting geometry +• non-G1[12] geometry +• missing edge or vertex geometry +• missing vertices +• vertices not on curve of edge +• edges and vertices not on surface of face +12. A surface can be composed of several NURBS surfaces known as patches. These patches should be +fitted together in a way that the boundaries are invisible. This is mathematically expressed by the +concept of geometric continuity. One of the options to establish geometric continuity is by means of +Tangential continuity (G1). It requires the end vectors of two curves or surfaces to be parallel which +eliminates sharp edges. +Figure 86: The imported model containing faults (left) and the result of the Repair part tool on the model (right). +On the Transform tab in the Repair group, click the + Repair Part icon. +After repairing a part, the part is renamed to the default RepairPart1 and the repair part icon is +displayed next to the part in the model tree. +Figure 87: A repaired part displayed in the model tree. +Figure 88: The Repair Part dialog, Advanced tab. +Advanced settings +Remove small edges +Edges are removed whose arc length is less than the Maximum length of small edges. +Maximum length of small edges +Edges are removed with arc lengths of edges less than the Maximum length of small edges. +Upper bound on deviation between original and repaired geometry +The tolerance for repairing the part. +Specify edge tolerance +To be more consistent with the surfaces in the model, it may be the case that the distance +changes in the surface geometry are more important than the exact locations of the edges. If this +option is selected, a more lenient tolerance for edge geometry can be specified for Edge repair +tolerance. +Edge repair tolerance +An optional tolerance that is specified to permit greater latitude in repairing edges. +Remove self-intersections +When a surface contains self-intersections located outside its face boundaries, then this portion +of the surface will be removed by splitting the surface. This may result in the face being split into +multiple faces. +Advanced self-intersection removal +A more in-depth algorithm is used to fix self-intersecting surfaces. +Remove discontinuities +Surface discontinuities are removed. If the discontinuity has a change in the tangent of less than +the angular tolerance, the discontinuity will be smoothed. If the change in tangent is greater than +Angular tolerance for geometry smoothening (degrees), the face or edge will be split at the +surface’s discontinuity. The same applies to curve G1 discontinuities. +Angular tolerance for geometry smoothening (degrees) +The tangent change angle in degrees above which G1 discontinuities are removed by splitting +topology rather than smoothening the geometry. +Suppress surface modifications +Surface geometry is preserved and repairs are confined to repairing face boundaries as far as +possible. +Repair bad face-face errors +Attempt to repair face-face collisions in the body. +Repair surfaces by simplifying to blends +Surfaces are cleaned by simplifying to blends. +Simplify B-surfaces to analytic / swept / spun surfaces +Any B-surfaces are simplified where possible to planes, cylinders, cones, spheres or tori where +possible. +Simplify swept / spun surfaces to analytic surfaces +Any swept or spun surfaces are simplified to planes, cylinders, cones, spheres or tori. +Simplify B-curves to analytic curves +Any B-curves are simplified to lines, circles or ellipses. +Simplify rational B-geometry to non-rational geometry +Any rational B-surfaces are simplified to non-rational B-surfaces. Non-rational B-surfaces have +fewer degrees of freedom than rational B-surfaces. +Reduce high-degree and trim large B-geometry +Any high-degree B-surfaces are trimmed or simplified to cubic B-surfaces. +Simplify to constant U or V curves +The tool will attempt to simplify SP-curves[13] to be constant in one parameter (U or V). +Merge multiple segments +The tool will attempt to merge multiple curve segments into a single segment. +Operating precision (tolerance) +The tolerance for replacement geometry. +Specify edge tolerance +To be more consistent with the surfaces in the model, it may be the case that the distance +changes in the surface geometry are more important than the exact locations of the edges. If this +option is selected, a more lenient tolerance for edge geometry can be specified for Edge repair +tolerance. +Edge repair tolerance +This is an optional tolerance to permit greater latitude in repairing edges. +Convert surfaces to blend surfaces +The surfaces are cleaned by attempting to simplify to blends. +Constrain surface normals along smooth edges +The tool will attempt to ensure that smooth edges will remain smooth[14] since the maximum +deviation between the normals for these faces will be equal to the surface normal tolerance. +Surface normal tolerance (degrees) +The angular tolerance for constraining surface normals in degrees. +2.11.4 Simplify Part Representation +The Simplify part representation tool simplifies a curve or a surface. +The tool will attempt to fix the following: +• simplification of rational and non-rational B-spline surfaces to analytic surfaces (plane, cylinder, +sphere, cone, torus) where possible +• simplification of rational and non-rational B-spline curve to analytic curves (line, circle, ellipse) +13. They are surface parameter curves and are defined only in terms of the U and V parameters of the +surface they belong to. +14. Edges between faces where there is a smooth transition from face to face. +• simplification of swept and spun surfaces to analytic surfaces (plane, cylinder, sphere, cone, torus) +where possible +• simplification of surface parameter curves controlled by given options +On the Transform tab in the Repair group, click the + Simplify Part Representation icon. +Figure 89: The Simplify Part Representation dialog. +Advanced settings +Simplify B-surfaces to analytic / swept / spun surfaces +Any B-surfaces are simplified where possible to planes, cylinders, cones, spheres or tori where +possible. +Simplify swept / spun surfaces to analytic surfaces +Any swept or spun surfaces are simplified to planes, cylinders, cones, spheres or tori. +Simplify B-curves to analytic curves +Any B-curves are simplified to lines, circles or ellipses. +Simplify rational B-geometry to non-rational geometry +Any rational B-surfaces are simplified to non-rational B-surfaces. Non-rational B-surfaces have +fewer degrees of freedom than rational B-surfaces. +Reduce high-degree and trim large B-geometry +Any high-degree B-surfaces are trimmed or simplified to cubic B-surfaces. +Simplify to constant U or V curves +The tool will attempt to simplify SP-curves[15] to be constant in one parameter (U or V). +15. They are surface parameter curves and are defined only in terms of the U and V parameters of the +surface they belong to. +Altair Feko 2022.3 +2 CADFEKO +Merge multiple segments +p.159 +The tool will attempt to merge multiple curve segments into a single segment. +Operating precision (tolerance) +The tolerance for replacement geometry. +Specify edge tolerance +To be more consistent with the surfaces in the model, it may be the case that the distance +changes in the surface geometry are more important than the exact locations of the edges. If this +option is selected, a more lenient tolerance for edge geometry can be specified for Edge repair +tolerance. +Edge repair tolerance +This is an optional tolerance to permit greater latitude in repairing edges. +Convert surfaces to blend surfaces +The surfaces are cleaned by attempting to simplify to blends. +Constrain surface normals along smooth edges +The tool will attempt to ensure that smooth edges will remain smooth[16] since the maximum +deviation between the normals for these faces will be equal to the surface normal tolerance. +Surface normal tolerance (degrees) +The angular tolerance for constraining surface normals in degrees. +2.11.5 Repair Edges +The Repair edges tool attempts to repair inaccuracies in the edges of a sheet or a solid body. +The tool pairs tolerant geometry by recalculating edge and vertex geometry to a specified tolerance +wherever possible. It also ensures that edges, designed to be tangential, are tangential within a +specified tolerance. The tool will attempt to remove any mergeable edges or vertices in the geometry +part (this option is disabled by clearing the Merge edges check box). +Figure 90: Examples of situations where edges can be repaired. The blue spheres represent the tolerance, within +which the differing edges are meant to be considered as the same edge. The first and third image show the input +geometry, while the second and last images indicate the edges after they were repaired. +16. Edges between faces where there is a smooth transition from face to face. +On the Transform tab in the Repair group, click the + Repair Edges icon. +Figure 91: The Repair Edges dialog, Advanced tab. +Advanced settings +Linear tolerance for repairing +The linear tolerance used for repairing. +Merge edges +Any redundant edges or vertices are removed. +2.11.6 Repair and Sew Faces +The Repair and Sew Faces tool attempts to repair any problems in the faces of the part and then tries to +sew them into a solid or sheet part. +The tool will perform the following actions: +• heal the input faces +• pre-process the faces for sewing by identifying and removing those that are invalid due to bad +trimming curves +• identify and remove sliver faces from the part +• sew the faces +• post-process the resulting part by sewing up remaining thin gashes +• construct new faces to fill any holes caused by missing geometry that were removed during the +pre-processing stage. +Figure 92: A part with several faults where the edges and vertices do not align (left) and after the Repair and sew +faces tool was used on the model (right). +On the Transform tab in the Repair group, click the + Repair and Sew Faces icon. +After applying the repair and sew faces tool to a part, the part is renamed to the default +RepairAndSewFaces1 and the repair and sew faces icon is displayed next to the part in the +model tree. +Figure 93: A part displayed in the model tree for which the repair and sew faces tool was used. +Figure 94: The Repair and Sew Faces dialog, Advanced tab. +Sew tolerance +The supplied tolerance is used as the tolerance when sewing the sheets. +Advanced settings +Angular tolerance (degrees) +The tangent change angle in degrees above which G1discontinuities will be removed by splitting +rather than smoothing. (A surface can be composed of several NURBS surfaces or “patches”. +These patches should be fitted together in a way that the boundaries are invisible. This is +mathematically expressed by the concept of geometric continuity. One of the options to establish +geometric continuity is by means of Tangential continuity (G1).It requires the end vectors of two +curves or surfaces to be parallel which eliminates sharp edges). +Replace missing geometry +The tool attempts to generate surface geometry for faces that will cap holes in the resulting body. +If the resultant body has closed circuits of laminar edges that appear to bound a missing face, the +tool attempts to generate a surface to span the gap (bounded by the edges) and make a capping +face from it. +2.11.7 Remove Small Features +The Remove small features tool attempts to remove small features, such as edges, faces, spikes and +gashes. +Figure 95: A model containing small entities (left) and the model after the small entities were removed (right). +On the Transform tab in the Repair group, click the + Remove Small Features icon. +Figure 96: The Remove Small Features dialog, Advanced tab. +Small feature size +This field specifies the radius of a sphere drawn around a small face. If the face falls within the +radius of the sphere, the face is removed. A gash will be removed if its width is less than the +Small feature size. +Altair Feko 2022.3 +2 CADFEKO +Advanced settings +Remove spikes +p.163 +A spike is a section of a face that has a high aspect ratio and small area. Spikes can lead to +modelling failures. If this option is selected, spikes are removed from the geometry part. +Remove small edges +Small edges have a length less than specified by Small feature size. If this option is selected, +small edges are removed. +Remove small faces +A small face is any face that fits within a sphere of a radius specified by Small feature size. If this +option is selected, small faces are removed. +Remove sliver faces +Sliver faces have a high aspect ratio and small area. Removing unwanted sliver faces can simplify +a body and lead to more reliable downstream operations. If this option is selected, sliver faces are +removed. Small feature size for sliver faces is defined as the tolerance which is the width of the +sliver face. +Remove gashes +Gashes are similar to spikes. They also have a high aspect ratio and small area. Gashes are +always located between at least two faces. If this option is selected, gashes are removed. The +Small feature size for gashes is the maximum width of any gash to be removed. +Gash aspect bound (0,1] +The maximum width to length ratio of any gash that is to be removed. Any gashes with an aspect +ratio larger than this value are not removed from the body. +Repair tolerant edges (wounds) +If this option is selected, the tool attempts to heal tolerant edges. These edges are created during +the removal of narrow features such as sliver faces, spikes and gashes. +2.11.8 Fill Hole Tool +The Fill hole tool attempts to fill a hole based on the currently selected laminar or free edges (wires). +Note: An edge is laminar when the edge represents (part of) the boundary of a single face. +On the Transform tab in the Rebuild group, click the + Fill Hole icon. +Figure 97: The Fill Hole dialog. +Tip: +• Select one or more wire/laminar edges in the 3D view. +• Press Q+C (Q followed by C) to automatically select the smallest loop of edges +containing the currently selected edges. +• Click OK to activate the tool. +The following hole filling (hole boundary transition) options are available: +Cornered face-face transition +The hole is filled while ignoring all smoothness requirements at the boundary. The sheet is +analytic if possible. +Smooth face-face transition +The hole is filled with a sheet that is smooth at the boundary. The sheet is analytic if possible. +Remove hole (extend bounding faces) +The tool attempts to grow neighbouring faces to fill the hole, without creating additional faces. +Figure 98: Example showing the result of hole filling. +The following topology surface settings are available for the patch filling the hole: +Minimum number of faces +The tool attempts to minimise the number of faces in the patch. +Multiple faces +The tool creates a patch if it is possible. The patch may contain multiple faces. +Single face +The tool attempts to fill the hole with a single face patch. This option may result in performance +improvements if a single face solution is required, but will not work in all cases. +Smooth internal edges +If this option is selected and the Topology is set to Multiple faces, the internal edges of the +faces used to fill the hole will be smooth without discontinuities. +2.12 Repairing Mesh Parts +Mesh parts can be manipulated in CADFEKO. Basic mesh editing and fixing capabilities allow triangles to +be added, removed and mesh parts to be merged. +2.12.1 Creating a Mesh Triangle +When the mesh contains holes or faulty triangles were deleted, you can add a mesh triangle manually +to the mesh. +1. Select the model mesh using one of the following workflows: +• In the 3D view, select the relevant mesh part. +• In the model tree, select the relevant mesh part. +Note: The selection must be a single mesh part. +2. On the Mesh tab, in the Repair group, click the + Create Triangle icon. +Figure 99: The Create Triangle dialog. +3. Specify the triangle vertices using point-entry. +4. Click OK to create the mesh triangle and to close the dialog. +The mesh triangle is added to the mesh part. +2.12.2 Merging Meshes (Union for Meshes) +When mesh parts are imported as separate mesh parts, merge the separate mesh parts to ensure +electrical connectivity or to add an edge port between the mesh parts. +1. Select the multiple model meshes using one of the following workflows: +• In the 3D view, select the relevant mesh parts. +• In the model tree, select the relevant mesh parts. +2. On the Mesh tab, in the Repair group, click the + Merge Meshes icon. +2.12.3 Removing Collapsed Mesh Elements +A collapsed mesh element is a degenerate triangle where two or mode vertices coincide. +1. Select the model mesh using one of the following workflows: +• In the 3D view, select the relevant mesh part. +• In the model tree, select the relevant mesh part. +2. On the Mesh tab, in the Repair group, click the + Remove Collapsed icon. +2.12.4 Removing Mesh Duplicates +When using imported meshed or you have edited the mesh manually, it can often occur that the mesh +contains duplicate triangles. +1. Select the model mesh using one of the following workflows: +• In the 3D view, select the relevant mesh part. +• In the model tree, select the relevant mesh part. +2. On the Mesh tab, in the Repair group, click the + Remove Duplicates icon. +If duplicate elements exist in the model, CADFEKO deletes all but one. +When deleting duplicate elements from separate faces, the face with the non-PEC face medium is +regarded as the original. The duplicate elements from the face with a default/PEC face medium is +removed. +View the number of duplicate mesh faces removed in the Notification centre. +2.12.5 Merging Vertices +Mesh connectivity relies on vertices of adjacent mesh elements being within a small tolerance of each +other. +1. Select the model mesh using one of the following workflows: +• In the 3D view, select the relevant mesh part. +• In the model tree, select the relevant mesh part. +2. On the Mesh tab, in the Repair group, click the + Merge Vertices icon. +Figure 100: The Merge mesh vertices dialog. +3. +4. +5. +In the Tolerance field, specify a value for the tolerance. Any two points separated by less than +this distance are merged to the coordinates of one of the original vertices. +[Optional] Select the Snap to geometry check box to allow mesh vertices to snap to geometry +points lying within the specified tolerance. +[Optional] Select the Snap to named points check box to allow mesh vertices to snap to named +points lying within the specified tolerance. +For example, if a named point lies between two mesh vertices that are less than the specified +tolerance away from one another, the mesh vertices are merged to the named point. +6. Click the OK button to merge the vertices and to close the dialog. +2.13 Importing Models into CADFEKO +Import a CAD (geometry) model or mesh model from a wide range of industry formats into CADFEKO to +save time and development costs. +2.13.1 Importing CADFEKO Model Files (.CFX) +Import an existing CADFEKO model (.cfx file) into a CADFEKO model. +1. On the Home tab, in the File group, click the + Import icon. From the drop-down list select the + CADFEKO Model (*.cfx) icon. +2. Select the .cfx file you want to import. +3. Under Import, select the entities to import (for example, geometry, meshes, meshing rules, cable +definitions, solution entities and optimisation searches). +Figure 101: The Import CADFEKO Model dialog. +Note: Frequency, infinite planes and mesh settings are not considered during the +import process and will not affect the destination model in any way. +4. +[Optional] Merge identical variables and media in the imported model and target model. +a) To merge identical variables and points, under Merge options, select the Merge identical +variables and points check box. +b) To merge identical media, under Merge options, select the Merge identical media check +box. +c) To merge identical media, under Merge options, select the Merge identical workplanes +check box. +5. +[Optional] If there are naming conflicts between the names of the imported entities and the +existing entities in the model, in the Prefix field, enter a prefix that will be pre-pended to all +imported entity names. +6. Click OK to import the file and to close the dialog. +2.13.2 PCB Formats for Import +View the supported ECAD file formats for import into CADFEKO. +Note: The ECAD file formats are only supported on Microsoft Windows. +The following file formats are supported: +• Altium +◦ Designer (.pcbdoc) +◦ PCAD (.pcb) +• AutoDesk - Eagle (.brd) +• Cadence +◦ Allegro (folder) +◦ Specctra/OrCAD Layout (.dsn) +• CADVANCE (folder) +• IPC2581 (.xml) +• Mentor Graphics +◦ Board Station (folder) +◦ Neutral (folder) +◦ Xpedition (folder) +◦ PADs (.asc) +• ODB++ (.tgz, .tar.gz) +• Zuken +◦ CADSTAR (.cpa) +◦ CR5000/CR8000 (.pcf, .pnf, .ftf) +◦ CR5000 PWS (.bsf, .ccf, .mdf, .udf, .wdf) +• PEMA (Altair) (.pema) +Figure 102: An example of a PCB import. +Importing a PCB +Use the PCB import tool to import all major ECAD file formats. +1. On the Home tab, in the File group, click the + Import icon. From the drop-down list select the + Import PCB File icon. +Figure 103: The PCB Import Tool dialog. +2. +In the File format drop-down list, select the type of file to import. +3. Browse to the location of the file to import. +4. +[Optional] Under Layer type control, select the applicable options: +• Include cutout layer +Include the layer(s) that contains the PCB outline including cutouts/holes that are cut +out during PCB fabrication using a routing bit. +• Include signal conducting / plane +Include all metal layer(s) such as signal traces, ground and power planes and metal +fills. +• Include dielectric +Include the dielectric layer(s). +• Include solder-resist +Include the layer(s) that contains the insulating coating which covers the circuit pattern. +• Include solder-paste +Include the layer(s) that define the solder paste mask. +• Include silkscreen +Include the layer(s) that contains annotations (such as letters numbers and symbols as +well as component footprints). +• Include user defined +Include all user-defined layer(s). +Note: Any media defined in the PCB file and referenced in the layers are available in +the model tree under Media. Media without labels are given the label of the layer. For +example, if the solder paste layer contains a dielectric without a label, it is given the +label SolderPaste. +5. Click OK to import the PCB model and to close the dialog. +Related tasks +Changing the Rendering Speed for a Model +Advanced PCB Import Options +View the advanced PCB options available for import (depending on the type of file to be imported). +Use infinitely thin layers +This option reduces the layers of a PCB with a finite thickness to infinitely thin layers. +Import vias +This option imports the vias defined in the PCB file and adds as wires between the PCB layers. +Union resultant geometry +This option unions the imported PCB model. +Simplify resultant geometry +This option simplifies the imported PCB model. +Heal and simplify internal representation of PEMA data +When using this option, simplification (removal of redundant faces and edges) as well as +tolerance-related corrections are applied during the conversion from the PCB data. In some cases +this may result in desired information (such as shapes defined within a metal fill) being removed +from the layout. Re-do the import without this option to retain this information. +Scale by +Specify a value by which the PCB model must be scaled during import. CADFEKO will suggest +a default value based on the CADFEKO model unit and the unit of the PCB file that is to be +imported. This suggested value can be changed as needed. +2.13.3 Geometry (CAD) Formats for Import +View the supported geometry formats that can be imported into CADFEKO and the supported versions. +CADFEKO is based on the Parasolid solid modelling kernel that allows models to be imported and +exported from and to the native Parasolid format without any translation. +Since all imported CAD models are converted to a Parasolid format during the import process, importing +from other CAD formats may cause unexpected results. Differences in the internal representation used +by various CAD formats may cause adjoining surfaces not to line up correctly. This discrepancy is due to +tolerance differences. Models that use a numerical representation can cause faults during scaling. +The following geometry (CAD) formats are supported for import: +File Format +Supported Versions +.sat +.dxf +R1 – 2022 1.0 +2.5 – 2023 +.model, .session, .exp +4.1.9 to 4.2.4 +.CATPart, .CATProduct, +.CATShape +V5 R8 to V5–6 R2022 +.iges, .igs +Up to 5.3 +.x_t, .x_b, .xmt_txt +9.0 - 34.0.153 +.prt, .asm +.step, .stp +.prt +16 to Creo 9.0 +AP203, AP214, AP242 +11 - NX 2206 +Formats +ACIS +AutoCAD +CATIA V4 +CATIA V5 +IGES +Parasolid +Pro / Engineer +STEP +Unigraphics and NX +AutoCAD +Supported entities are: +• 3D face +• Arc +• Circle +• Ellipse +• Line +• Polyline +• Polyface mesh (3D) +Unsupported entities are: +• Point +• Spline +• 3D Solid +• Trace +• Dimensional annotations +Parasolid +Isolated vertices (acorns) are not imported.[17] The coordinates are written to the message window and +can be created manually should they be required. +Importing CAD (Geometry) +Import a CAD (geometry) model into CADFEKO. +Note: +• Best results are obtained during importing if the CADFEKO model unit is in “m”. +• If a large model is imported and the source file unit is different to the CADFEKO model +unit, the import process may be slow. +1. On the Home tab, in the File group, click the + Import icon. From the drop-down list select the + Geometry icon. +2. Click the File and Format tab. +a) In the Filename field, browse for the file you want to import. +Specify the advanced settings for the geometry import. +3. +[Optional] Select the Advanced tab. Specify the relevant advanced import settings. +17. These are not the same as named points. +4. Click Import to import the geometry and close the dialog. +Advanced CAD Import Options +View the advanced geometry options available for import (depending on the type of file to be imported). +Healing options +This option controls the healing of data containing performance-expensive errors. +• No healing +◦ No healing is applied to the imported file. +• Standard healing / Advanced healing +◦ Geometrical and topological irregularities are repaired and healed. The translated file is +scanned for corrupted data and invalid data is fixed. +If the imported model contains face-face inconsistencies, it will cause multiple separate +parts to be created during the healing process. After importing, use the union or stitch +operation to combine the parts into a single part. +Note: The advanced healing option adds a few more time consuming and +extensive healing operations to the conversion process. +Simplify model +This option controls the process of cleaning and removing redundant topologies and geometries +from the model during translation. If a vertex is redundant, the vertex is deleted and the +associated edges are merged. If an edge is redundant, the edge is removed and the associated +faces merged. +Stitch trimmed faces +This option controls the stitching of trimmed[18] faces during the translation process. +Use two step import process +Some models may not import correctly with the current import process. Use the two-step import +process that makes use of the older, legacy import process to attempt to import problematic +models. +Extrude +Enables the extrusion option (only for .dxf file imports). +Auto-stitch faces +Faces that touch are automatically stitched (only for .dxf file imports). +Auto-merge wires +Wires that touch are automatically stitched (only for .dxf file imports). +18. A trimmed surface is a surface which was divided into multiple pieces as a result of a modelling +operation. A portion of the surface may no longer be required to support the model topology. The +redundant pieces are then discarded. +Viewing the Geometry Import Log +View the log file for a summary of the last geometry import. This information is useful in cases where +the import conversion fails. +1. On the Home tab, in the File group, click the + Import icon. From the drop-down list select the + Geometry Import Log icon. +2. Click the Warning tab or Errors tab to view any errors in the import process (when applicable). +Troubleshooting: View the model format conversions performed during a geometry +import in the log file located at %FEKO_USER_HOME%/logs/CADimport.*.log +[19]. +3. Click Close to close the dialog. +2.13.4 Mesh Formats for Import +View the supported mesh formats for import. +CADFEKO imports most of the mesh formats[20] by running PREFEKO and importing the resulting +.fek file. Since these formats do not support specifying dielectric media, all segments, triangles and +polygonal plates are imported as PEC structures in free space. Tetrahedra obtain the medium Unknown. +19. This directory is used to write user specific initialisation files. It is provided to allow different users +to save unique configurations, and for situations where the user does not have write access to the +Feko directory. For Microsoft Windows systems this is normally %APPDATA%\feko\xx.yy and on +UNIX systems it is usually set to $HOME/.feko/xx.yy during the installation. Here xx.yy represent +the major and minor version numbers. +20. Except for .fek file, .raw file and .txt file imports +When importing .fek files, only the mesh parts (wire segments, triangles, polygonal plates and +tetrahedra) are imported. Information regarding the solution configuration is completely ignored. +Medium information and segment radii are retained during import. +The following mesh formats are supported for import: +Formats +Feko model +CADFEKO mesh +Feko HyperMesh +Femap neutral +NASTRAN +AutoCAD +STL +PATRAN +ANSYS +CONCEPT +ABAQUS +ASCII +GiD +NEC data +I-DEAS universal format +Voxel +File Format +.fek +.cfm +.fhm +.neu +.nas +.dxf +.stl +.pat +.cdb +.dat +.inp +.msh +.nec +.unv +.raw, .txt +Femap Neutral Mesh +Boundary surfaces, bordered with line curves, are imported as polygonal plates. +AutoCAD +Only LINE and POLYLINE structures, which define segments and triangles, are supported. +GiD +Hexahedral elements are ignored. +Altair Feko 2022.3 +2 CADFEKO +Importing a Mesh +Import a mesh model into CADFEKO. +p.178 +1. On the Home tab, in the File group, click the + Import icon. From the drop-down list select the + Mesh icon. +2. Select the File and Format tab. +a) In the Filename field, browse for the file you want to import. +Specify the advanced settings for the mesh import. +3. +[Optional] Select the Advanced tab. Specify the relevant advanced import settings. +4. Click Import to import the mesh model and close the dialog. +Note: When importing a .fhm file and an .inc file exists in the same folder with the +exact file name, then the media definitions are imported from the .inc file. +PREFEKO imports the resulting .fek file[21]. +5. The dialog is closed if there are no errors or warnings. +If there are errors or warnings given, click the Warnings tab or Errors tab to view the relevant +information. +21. PREFEKO is not run for .fek file, .raw file and .txt file imports +Advanced Mesh Import Options +View the supported mesh import options (depending on the type of file to be imported). +Import segments, triangles, tetrahedra, polygons, cylinders or quadrangles +Select the elements to import. +Note: Quadrangles are divided into triangles. +Mesh conversion +In cases where the resulting mesh is in a different format than the source mesh, the mesh +conversion option can be specified to determine the output mesh format. This option is available +for voxel mesh imports. +Merge identical media +For mesh formats where materials are specified, this option provides functionality to merge media +with identical properties. An optional prefix can be provided to append the imported material +label. +Group into separate parts (using labels) +Import meshes into separate parts. During the import process, faces are grouped into +parts as they were at the time of export. Imported meshes without labels are grouped as +UnknownMeshParts parts in the model tree. +To import the mesh as a single mesh part with label MeshImport, unselect the Group into +separate parts (using labels) check box. +Default wire radius +Only ANSYS files support segment radius information. For all other formats and ANSYS files where +the segment radius is not specified, a default radius must be specified. +Scale factor to metres +A scale factor can be specified if the unit of the imported mesh is not in metres. +Segment length +For meshed AutoCAD DXF files, the LINE elements are divided into segments according to the +value of the Segment length. If the LINE elements may not be sub-divided, this value must be +larger than the longest line. This option is only available for .dxf mesh imports. +Mesh vertex tolerance +The mesh vertex tolerance is specified. If the tolerance is small, Feko will interpret the vertices as +connected. Usually, the default setting should suffice. +Viewing the Mesh Import Log +View the log file for a summary of the last mesh import. This information is useful in cases where the +import conversion fails. +1. On the Home tab, in the File group, click the + Import icon. From the drop-down list select the + Mesh icon. +2. Click the Warning tab or Errors tab to view any errors in the import process (when applicable). +3. Click Close to close the dialog. +2.14 Exporting Models from CADFEKO +A CADFEKO model can be exported to a variety of industry standard geometry and mesh formats to be +used in other applications. +2.14.1 CAD (Geometry) Formats for Export +The geometry can be exported to a number of industry-standard CAD formats. +The following CAD formats are supported for export: +Formats +ACIS +CATIA V4 +CATIA V5 +IGES +Parasolid +STEP +File Format +.sat +.model, .session, .exp +.CATPart, .CATProduct, .CATShape +.iges, .igs +.x_t, .x_b +.STEP, .stp +Scaling is often the source of many importing errors when translating between CAD file formats (ACIS, +CATIA, IGES, Pro Engineer, STEP, Unigraphics / NX, Parasolid). +CADFEKO does not perform any scaling during the export (scaling could cause tolerance errors during +the subsequent import process). Change the scaling by modifying the CADFEKO model unit or model +extents. If a model does not import as expected, change the scaling to import the geometry correctly. +Parasolid Models +Parasolid models are inherently limited to a 1000x1000x1000 unit box centred at the origin. CADFEKO +introduces a scaling factor to make this more flexible. The Scale factor is the factor by which the +CADFEKO model must be scaled during export to convert it to correct units required in the Parasolid +model. A scale factor of 0.1 implies that the dimensions of the saved Parasolid model are one-tenth of +the native dimensions as set in CADFEKO. +Typically, programs that import Parasolid models allow specifying a factor by which the Parasolid model +must be scaled during the import. To maintain the correct units and scale, this factor should then be the +inverse of the scale factor used in the export of the model from CADFEKO. +For large models (larger than 500 of the current CADFEKO units), the extents must be increased. +For smaller models (less than 50 CADFEKO units), the extents should be decreased. +In general, changing the model extents is not recommended (unless the model is very small and +precision or geometric accuracy problems are encountered). Using the default extents results in an +unscaled Parasolid model, and it is not necessary to keep track of the scale factor during model import / +export. +Exporting CAD to Parasolid Format +Export the geometry in Parasolid CAD format. +Note: Only the final geometry is exported. The full creation history is lost, similar to +creating a primitive. +1. On the Home tab, in the File group, click the + Export icon. From the drop-down list select the + Geometry icon. From the drop-down list select Parasolid (*.x_t / *.x_b). +Figure 104: The Export dialog model dialog. +2. +In the Parasolid file format drop-down list, select one of the following: +• To export the Parasolid model in text format, select Text. +• To export the Parasolid mode in binary format, select Binary. +3. +In the Topology type drop-down list, select one of the following: +• Manifold +A manifold body is any body that can exist in the real world or could be manufactured. +Wire bodies must be one-dimensional open (linear sections with two endpoints) or +closed (loops with no endpoints); they may not contain junctions. Sheet bodies must be +two-dimensional open or closed and may not contain junctions. +• General +General bodies differ from manifold bodies in that they usually cannot exist in the real +world. They are often idealized representations of bodies, for example, infinitely thin +sheets joined in a T-junction. Bodies of mixed dimensions are also general, for example, +a body with wires, sheets and solids. +4. +5. +In the Version field, from the drop-down list select a version between 16 and 30 (latest). +[Optional] To export only the selected geometry, click the Only export selection check box. +6. Click the OK to export the geometry and to close the dialog. +2.14.2 Mesh Formats for Export +The model mesh or simulation mesh can be exported to a variety of industry-standard mesh formats. +The following mesh formats are supported for export: +Formats +CADFEKO mesh +Feko HyperMesh +NASTRAN +STL +Gerber +I-DEAS mesh +DXF +File Format +.cfm +.fhm +.nas +.stl +.gbr +.unv +.dxf +Exporting a Mesh +Export the model mesh or simulation mesh. +1. +[Optional] Select the geometry parts or mesh parts to export. If no part is selected, all included +meshes of the specified type are exported. +2. On the Home tab, in the File group, click the + Export icon. From the drop-down list select the + Mesh icon. +Figure 105: The Mesh Exporter Tool dialog. +If a geometry part or mesh part was selected in Step 1, the Only export selection check box is +selected. +3. +4. +[Optional] To export only the meshes associated with the selected parts, select the Only export +selection check box. +[Optional] To export only the bounding faces of volume meshes, select the Only export +bounding faces of volume meshes check box. +Note: This setting applies to NASTRAN mesh, STL mesh and I-DEAS mesh. +5. +[Optional] To export dimensions in metre, select the Scale to metre check box. +Note: This setting applies to CADFEKO mesh, Feko HyperMesh, NASTRAN mesh and +STL mesh. +If the model contains mesh parts (imported meshes) and simulation meshes (meshed geometry or +remeshed mesh parts), the options under Specify which mesh to export are enabled. +6. Under Specify which mesh to export, select one of the following: +• To export the meshed model of the geometry or the remeshed version of an imported mesh, +click Simulation mesh. +• To export an imported mesh, click Model mesh. +7. Click OK to export the mesh and to close the dialog. +CAUTION: Exporting a .fhm file also replaces the .inc file of the same name (if it +exists). +2.15 Field/Current Data +Define field or current data using either far field data, near field data, spherical mode data or PCB +current data. Use the field/current definition when defining an equivalent source or a receiving antenna. +The workflow for creating field/current data: +1. Create a field/current definition +Create a field/current data definition by defining the field data manually or by importing the +field/current data from a file. A range of file formats is supported. +2. Define an equivalent source or receiving antenna +Use the field/current data definition to define an equivalent source or a receiving antenna. +Related concepts +Equivalent Sources +Ideal Receiving Antennas +2.15.1 Defining Far Field Data from File +Import far field data from a Feko (.ffe), external ASCII or a CST far field scan (.ffs) file to create a +far field data definition. Use the far field data when defining an equivalent source or receiving antenna. +The far field must be defined in spherical coordinates. +1. On the Construct tab, in the Define group, click the + Field/Current Data icon. From the +drop-down list select + Define Far Field Data. +Figure 106: The Define Far Field Data dialog. +2. Select one of the following file types to import: +• Load field data from Feko Solver (*.ffe) file +• Load field data from an external data file +• Loaf field data from a CST far field scan (*.ffs) +3. +In the File name field, browse to the file location. +4. Select one of the following: +• To select far field data from a multi-frequency .ffe or .ffs file, select Use all data blocks. +The data is interpolated for use at the operating frequency. +• To select far field data at a specific frequency in a .ffe or .ffs file, select Use specified +data block number and enter the number of the relevant data block. +• To select a specific far field pattern in a .ffe or .dat file, select Use specified point +range[22]. +1. +2. +3. +In the Start from point number field, specify the line number of the first line to read. +In the Number of theta points field, specify the number of theta points used in the +imported far field. +In the Number of phi points field, specify the number of phi points used in the +imported far field. +22. Far field patterns are typically frequency-dependent and models with radiation pattern sources +usually have only a single solution frequency. If the radiation pattern is calculated using a +frequency sweep in Feko, the .ffe file contains multiple patterns. +5. +In the Label field, specify a unique label for the far field data. +6. Click Create to define the far field data and to close the dialog. +Related tasks +Adding a Far Field Source +Requesting Ideal Receiving Antenna (Far Field Pattern) +2.15.2 Defining Near Field Aperture from File +Import near field data from a .efe file and / or .hfe file to define a near field data aperture. Use the +near field data aperture when defining an equivalent source or receiving antenna. +The .efe and .hfe files do not contain information regarding the coordinates system, frequency or +number of points. As a result, you need to supply the above information to define the near field data +aperture. +1. On the Construct tab, in the Define group, click the + Field/Current Data icon. From the +drop-down list select + Define Near Field Data. +Figure 107: The Define Near Field Data dialog. +2. +In the Aperture data definition drop-down list, select one of the following: +• Electric and Magnetic field +• Electric field +• Magnetic field +3. +In the Source type field, select one of the following: +• Load an ASCII text file +Note: The units are V/m for the E-field and A/m for the H-field. +• Load from *.hfe file +4. +5. +6. +In the E-field file field, browse to the E-field file location. +In the H-field file field, browse to the H-field file location +In the Coordinate system field, select one of the following: +• Cartesian +• Cylindrical (option only available when selecting Electric and Magnetic field) +• Spherical (option only available when selecting Electric and Magnetic field) +The physical location of the sample points and how they relate to the defined aperture can be specified. +7. +[Optional] Select the Also sample along edges check box to assume the outer sample points lie +on the edges of the defined aperture. +CAUTION: For multiple near field sources in a single model, sample points may +not lie on any two aperture edges that share a common side. This results in two +elementary dipoles with the same location and polarisation to be included, leading to +incorrect results. +8. For options Cylindrical or Spherical, select the Swap source and field validity regions check +box if the fields on the inside of the region are equivalent to the calculated field values. +9. +In the Width (W) field, specify the aperture width. +10. In the Height (H) field, specify the aperture height. +11. Select one of the following: +• To select near field data from multi-frequency .efe and .hfe files, select Use all data +blocks. The data is interpolated for use at the operating frequency. +• To select near field data at a specific frequency in .efe and .hfe files, select Use specified +data block number and enter the number of the relevant data block. +• To select a specific near field pattern in .efe and .hfe files, select Use specified point +range[23]. +1. +In the Start reading from line number field, specify the first line number to be read +in the file. +23. Near field patterns are typically frequency-dependent and models with radiation pattern sources +usually have only a single solution frequency. If the radiation pattern is calculated using a +frequency sweep in Feko, the .efe and .hfe files contain multiple patterns. +Note: Comment lines and empty lines are not counted. +For example, a file with 100 points per near field, the second block starts reading from +line 101, regardless of any comment lines. +2. +3. +In the Number of points along U field, specify the number of points along the U axis. +In the Number of points along V field, specify the number of points along the V axis. +12. In the Label field, specify a unique label for the near field data. +13. Click Create to define the near field data and to close the dialog. +Related tasks +Adding a Near Field Source +Requesting Ideal Receiving Antenna (Near Field Pattern) +2.15.3 Defining Near Field Data from File +Import near field data from Feko field on a Cartesian boundary (.efe and / or .hfe), Sigrity input file +(.nfd), Orbit / Satimo measurement file (.mfxml) or a CST near field scan (.nfs) to create a near +field data definition. Use the near field data definition when defining an equivalent source or receiving +antenna. +1. On the Construct tab, in the Define group, click the + Field/Current Data icon. From the +drop-down list select + Import Near Field Data From File. +Figure 108: The Import Near Field Data dialog. +2. +In the Format field, select one of the following: +• Feko Solver field on Cartesian boundary +• Sigrity (*.nfd) input file +• Orbit / Satimo (*.mfxml) measurement file +• CST near field scan (CST NFS) +3. For option Feko Solver field on Cartesian boundary, specify the following: +a) In the Source type drop-down list, select one of the following: +• Load from *.efe and *.hfe file and browse to the file locations. +• Load from *.efe file and browse to the file location for the e-field. +• Load from *.hfe file and browse to the file location for the h-field. +4. For options Sigrity (*.nfd) input file and Orbit / Satimo (*.mfxml) measurement file, in the +File name field, specify the file location. +5. For option CST near field scan (CST NFS), in the Directory field, specify the folder location. +6. +[Optional] Unselect the Use all data blocks check box to specify a specific data block to use. +a) In the Use data block number field, specify the data block number that corresponds to the +near field data at a specific frequency. +7. Select the Swap source and field validity regions check box if the fields on the opposite side +of the aperture (inside the boundary) are equivalent to the measured or calculated field values. +8. +In the Label field, specify a unique label for the near field data. +9. Click Create to define the near field data and to close the dialog. +Related tasks +Adding a Near Field Source +Requesting Ideal Receiving Antenna (Near Field Pattern) +2.15.4 Defining Spherical Modes Data from File +Import spherical modes data from a TICRA .sph file or import from a .sph file exported by CADFEKO, +to create a spherical modes data definition. Use the spherical modes data definition when defining an +equivalent source or receiving antenna. +1. On the Construct tab, in the Define group, click the + Field/Current Data icon. From the +drop-down list select + Import Spherical Modes Data From File. +Figure 109: The Import Spherical Mode Data dialog. +2. +In the TICRA (*.sph) file field, browse to the file location. +3. Specify the data block to be used: +• To select data from a multi-frequency .sph file, select the Use all data blocks. The data is +interpolated for use at the operating frequency. +• To select data from a specific frequency in the .sph file, clear the Use all data blocks and +enter the number of the relevant data block. +4. +In the Label field, specify a unique label for the spherical modes data. +5. Click Create to define the spherical modes data and to close the dialog. +Related tasks +Adding a Spherical Mode Source +Requesting Ideal Receiving Antenna (Spherical Modes) +2.15.5 Defining Spherical Modes Data Manually +Define the propagation direction, index scheme and modes to create spherical modes data. Use the +spherical modes data definition when defining an equivalent source or receiving antenna. +1. On the Construct tab, in the Define group, click the + Field/Current Data icon. From the +drop-down list select + Manually Define Spherical Modes Data. +Figure 110: The Define spherical modes dialog. +2. Under Propagation direction, select one of the following: +• To illuminate the model with modes propagating towards +, spherical Hankel function of +the first kind, +, select Inward. +• To illuminate the model with modes propagating towards +, spherical Hankel function of +the second kind, +, select Outward. +3. +In the TE/TM cell, select one of the following: +• TE +The transverse electric mode of propagation (no E-field in the direction of propagation). +Altair Feko 2022.3 +2 CADFEKO +TM +p.192 +The transverse magnetic mode of propagation (no H-field in the direction of +propagation). +4. +In the Index scheme cell, select one of the following: +• Normal +This scheme uses the traditional smn index. You can specify TE-mode (s = 1) or TM- +mode (s = 2) and the indices M and N. +M is the mode index in the azimuth direction and N is the mode index in the radial +direction and must be in the range 1, 2...∞. +Feko does not distinguish between even and odd modes (with + and +angular dependencies), but rather use the angular dependency +also be negative, but it must be in the range −N..N. +. The index M can +Compressed +This scheme uses compressed one-dimensional mode numbering scheme. The J mode +index is then specified in the index column. Here +where s = 1 for TE-modes and s = 2 for TM-modes. +This unified mode numbering scheme allows the computation of an extended scattering +matrix (with network and radiation ports). The index J then represents a unique port +number in the scattering matrix. +(6) +5. +In the Mag. sqrt(W) cell, specify the absolute value of the complex amplitude for the spherical +mode. Due to the spherical modes normalisation, the amplitude unit is +. +6. +7. +In the Phase [deg.] field, specify the phase of the complex amplitude for the spherical mode. +In the Label field, specify a unique label for the spherical modes data. +8. Click Create to define the spherical modes data and to close the dialog. +Related concepts +Exporting a .sph file in CADFEKO +Related tasks +Adding a Spherical Mode Source +Requesting Ideal Receiving Antenna (Spherical Modes) +2.15.6 Defining PCB Current Data from File +Import printed circuit board (PCB) current data from a PollEx radiated emission interface (.rei) file to +create a PCB current data definition. Use the current data definition when defining an equivalent source. +1. On the Construct tab, in the Define group, click the + Field/Current Data icon. From the +drop-down list select + Import PCB Current Data From File. +Figure 111: The Import PCB Current Data dialog. +2. +In the Current data (*.rei) file field, browse to the file location of the .rei PCB current data file +that was written out by PollEx. +3. +In the Label field, specify a unique label for the PCB current data. +4. Click Create to define the PCB current data and to close the dialog. +Related concepts +Feko Source Data Viewer +Related tasks +Adding a PCB Source +Visualising PCB Current Data +Visualising PCB Current Data +View the PCB board outline with currents per frequency for a PCB current data definition. +1. +In the model tree, under + Field/Current Data, select a PCB current data. From the right-click +context menu, click + Visualise PCB Current Data. +Figure 112: The Visualise PCB Current Data right-click context menu option. +The Visualise PCB Current Data dialog is displayed. +Figure 113: The Visualise PCB Current Data dialog. +2. On the Visualise PCB Current Data dialog, in the Frequencies field, specify the frequencies +(values are in Hz): +Note: +• Leave the field empty to visualise all frequencies. +• Specify a single value: +1e9 +• Specify a comma-separated list: +500 MHz, 2GHz +• Specify a frequency range: +1GHz - 2GHz +• Use a combination of a comma-separated list and range: +500 MHz, 2GHz, 1GHz - 2GHz +If the requested frequency is not included in the PCB current data, the closest +frequencies to the requested value are included. +3. Click OK to view the PCB current data in the Feko Source Data Viewer. +Figure 114: The Feko Source Data Viewer where you can view currents per frequency for a PCB current data +definition. +Related concepts +Feko Source Data Viewer +Related tasks +Defining PCB Current Data from File +2.15.7 Defining Solution Coefficient Data from File +Import solution coefficient data (multi-frequency or single frequency) from a .sol file to create a +solution coefficient data definition. Use the solution coefficient data definition when defining a solution +coefficient source. +Note: Export surface currents on specified structures to a .sol file using a domain +decomposition request. +1. On the Construct tab, in the Define group, click the + Field/Current Data icon. From the +drop-down list select + Import Solution Coefficient Data From File. +Figure 115: The Import Solution Coefficient Data dialog. +2. +In the Solution coefficient data (*.sol) file field, browse to the file location. +3. Specify the data block to be used: +• To select data from a multi-frequency .sol file, select the Use all data blocks check box. +The data is interpolated for use at the operating frequency. +• To select data at a specific frequency in the .sol file, clear the Use all data blocks check +box and enter the number of the relevant data block. +4. +In the Label field, specify a unique label for the solution coefficient data. +5. Click Create to define the spherical modes data and to close the dialog. +Related tasks +Exporting a .sol file in CADFEKO +Adding a Solution Coefficient Source +Requesting Model Decomposition +Altair Feko 2022.3 +2 CADFEKO +2.16 Defining Media +p.197 +Define a medium with specific material properties, import a predefined medium from the media library +or add a medium from your model to the media library. +Note: Only passive media are supported. Passive media can be either lossless or lossy.[24] +The following media types are supported: +1. Dielectric +2. Metal +3. Layered dielectric (isotropic and anisotropic) +4. +Impedance sheet +5. Characterised surface +6. Windscreen layer +7. Anisotropic medium (3D) +Media are displayed in the model tree. This includes user-defined media and media added from the +media library. +Figure 116: The media definitions in the model tree +The colour square next to each medium entry indicates the colour that is used to display the medium in +the 3D view as well as in POSTFEKO. To change the display colour, click the dielectric in the model tree +and from the right-click context menu, select Change display colour. +24. A lossless passive medium allows fields to pass through the medium without attenuation. In a lossy +passive medium, a fraction of the power is transformed to heat, as an example. +Altair Feko 2022.3 +2 CADFEKO +Predefined Media +p.198 +Predefined media are available by default in CADFEKO and includes Perfect electric conductor, +Perfect magnetic conductor and Free space. +Figure 117: The predefined media in the model tree +Tip: Edit the properties of free space if the model is inside an infinite medium. +2.16.1 Media Library +The media library contains a list of predefined and user-defined media. You can either add a predefined +medium from the library to your model or add your medium to the library. +On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, select +the + Media Library icon. +Figure 118: The Modify Media Library dialog. +Note: The medium type is indicated in the Type column. +1. Predefined media (provided as part of the Feko installation) are indicated by the +text Altair Feko. +2. User defined media are indicated by the text User. +Using a Medium from the Media Library +Add a predefined or user-defined medium from the media library to your model. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +select the + Media Library icon. +2. +In the Filter field, enter a medium to narrow down the search. +3. Click the medium in the list you want to add to your model. +4. +[Optional] To view the medium properties, under View mode, click Advanced. +5. To add the selected medium to your model, click Add to model. +6. Click Close to close the dialog. +Adding a Medium to the Media Library +Add a medium from your model to the media library. In a new model, you can then reuse the medium +by adding it from the media library to your model. +1. +In the model tree, click the medium you want to add to the library. +2. From the right-click context menu, select Add to library. +The medium is added to the media library. +2.16.2 Creating a Dielectric Medium +Create a frequency-independent dielectric. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +click the + Dielectric icon. +2. Click Manually define medium. +3. +4. +[Optional] In the Mass density (kg/m^3) field, enter a value for ρ. +In the Label field, enter a unique label for the dielectric. +5. Click Create to create the dielectric and to close the dialog. +Related tasks +Applying a Dielectric to a Region +Creating an Isotropic Layered Dielectric (2D) +Dielectric Properties +Specify the dielectric properties of the dielectric medium. +1. Click the Dielectric modelling tab. +2. +3. +In the Definition method field, from the drop-down list select Frequency independent. +In the Relative permittivity field, enter a value for εr. +Specify the dielectric losses in the dielectric by either specifying the dielectric loss tangent or the +conductivity. The two loss terms are related by +. +Note: Low loss dielectric substrates are typically specified in terms of loss tangent, while +human tissue (used in SAR[25] studies) are specified in terms of conductivity. +4. Select one of the following: +• To specify the dielectric loss tangent, click Dielectric loss tangent. +• In the Dielectric loss tangent field, enter a value for tanδ. +• To specify the conductivity directly, click Conductivity (S/m). +• In the Conductivity (S/m) field, enter a value for σ. +Magnetic Properties +Specify the magnetic properties of the dielectric medium. +1. Click the Magnetic modelling tab. +2. Specify the magnetic properties of the dielectric. +• To create a non-magnetic dielectric, from the Definition method drop-down list select Non +magnetic. +• To create a dielectric with frequency-independent-magnetic-properties, from Definition +method drop-down list select Frequency independent. +1. +2. +In the Relative permeability field, enter the value for μr. +In the Magnetic loss tangent field, enter the value for tanδμ. +• To create a dielectric with frequency-dependent-magnetic-properties, from the Definition +method drop-down list select Frequency list (linear interpolation). +• To enter each frequency points manually, enter the magnetic properties for each +frequency point. +• To import the frequency points from a file, click Import points. +1. +2. +In the File name field, browse for the file you want to import. +[Optional] In the Scale by field, enter a value to scale the points. +For example, if you import a value of “2”, scale it by “10e9” to change the value to +2 GHz. +25. +specific absorption rate +3. Under Delimiter, click the delimiter type you use in your file. +4. Click OK to close the Import Points dialog. +Frequency Dependent Dielectrics +Define a frequency-dependent medium to use in your model or to add to the media library. +The following frequency-dependent definitions are supported: +Debye relaxation +Use this method to describe the relaxation characteristics of +gasses and fluids at microwave frequencies. It is derived for freely +rotating spherical polar molecules in a predominantly non-polar +background. +Cole-Cole +This method is similar to the Debye relaxation but makes use of +an additional parameter to describe the model. +Havriliak-Negami +Use this method to model liquids, solids and semi-solids. +Djordjevic-Sarkar +Use this method for composite dielectrics. +Frequency List +Use this method to define a frequency-dependent dielectric by +specifying data points at a range of frequencies. The values for +the dielectric properties are linearly interpolated to obtain the +dielectric properties at frequency points other than specified. +Related concepts +Dielectric Media Formulations +Creating a Dielectric Medium (Debye Relaxation) +Create a frequency-dependent dielectric using the Debye relaxation method. Use the Debye model to +describe the relaxation characteristics of gasses and fluids at microwave frequencies. It is derived for +freely rotating spherical polar molecules in a predominantly non-polar background. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +click the + Dielectric icon. +Figure 119: The Create Dielectric Medium dialog (Debye relaxation). +2. +3. +4. +5. +6. +7. +8. +In the Definition method field, from the drop-down list select Debye relaxation. +In the Relative static permittivity field, enter a value for εs. +In the Relative high frequency permittivity field, enter a value for ε∞. +In the Relaxation frequency field, enter a value for fr. +[Optional] Specify the magnetic properties of the dielectric. +[Optional] In the Mass density (kg/m^3) field, enter a value for ρ. +In the Label field, enter a unique label for the dielectric. +9. Click Create to create the dielectric and to close the dialog. +Related tasks +Applying a Dielectric to a Region +Creating an Isotropic Layered Dielectric (2D) +Creating a Dielectric Medium (Cole-Cole) +Create a frequency-dependent dielectric using the Cole-Cole method. The method is similar to the +Debye relaxation but makes use of an additional parameter to describe the model. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +click the + Dielectric icon. +Figure 120: The Create Dielectric Medium dialog (Cole-Cole). +2. +3. +4. +5. +6. +7. +8. +9. +In the Definition method field, from the drop-down list select Cole-Cole. +In the Relative static permittivity field, enter a value for εs. +In the Relative high frequency permittivity field, enter a value for ε∞. +In the Relaxation frequency field, enter a value for fr. +In the Attenuation factor field, enter a value for α. +[Optional] Specify the magnetic properties of the dielectric. +[Optional] In the Mass density (kg/m^3) field, enter a value for ρ. +In the Label field, enter a unique label for the dielectric. +10. Click Create to create the dielectric and to close the dialog. +Related tasks +Applying a Dielectric to a Region +Creating an Isotropic Layered Dielectric (2D) +Creating a Dielectric Medium (Havriliak-Negami) +Create a frequency-dependent dielectric using the Havriliak-Negami method. Use this method to model +liquids, solids and semi-solids. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +click the + Dielectric icon. +Figure 121: The Create Dielectric Medium dialog (Havriliak-Negami). +In the Definition method field, from the drop-down list select Havriliak-Negami. +In the Relative static permittivity field, enter a value for εs. +In the Relative high frequency permittivity field, enter a value for ε∞. +In the Relaxation frequency field, enter a value for fr. +In the Attenuation factor field, enter a value for α. +In the Phase factor field, enter a value for β. +[Optional] Specify the magnetic properties of the dielectric. +In the Label field, enter a unique label for the dielectric. +2. +3. +4. +5. +6. +7. +8. +9. +10. Click Create to create the dielectric and to close the dialog. +Related tasks +Applying a Dielectric to a Region +Creating an Isotropic Layered Dielectric (2D) +Creating a Dielectric Medium (Djordjevic-Sarkar) +Create a frequency-dependent dielectric using the Djordjevic-Sarkar method. Use this method for +composite dielectrics. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +click the + Dielectric icon. +Figure 122: The Create Dielectric Medium dialog (Djordjevic-Sarkar). +In the Definition method field, from the drop-down list select Djordjevic-Sarkar. +In the Variation of real permittivity field, enter a value for Δε. +In the Relative high frequency permittivity field, enter a value for ε∞. +In the Conductivity (S/m) field, enter a value for σ. +In the Lower limit of angular frequency field, enter a value for ω1. +In the Upper limit of angular frequency, enter a value for ω2. +[Optional] Specify the magnetic properties of the dielectric. +[Optional] In the Mass density (kg/m^3) field, enter a value for ρ. +2. +3. +4. +5. +6. +7. +8. +9. +10. In the Label field, enter a unique label for the dielectric. +11. Click Create to create the dielectric and to close the dialog. +Related tasks +Applying a Dielectric to a Region +Creating an Isotropic Layered Dielectric (2D) +Creating a Dielectric Medium from a Frequency List +Define a frequency-dependent dielectric by specifying data points at a range of frequencies. The values +for the dielectric properties are linearly interpolated to obtain the dielectric properties at frequency +points other than specified. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +click the + Dielectric icon. +Figure 123: The Create Dielectric Medium dialog (Frequency list). +2. +In the Definition method field, from the drop-down list select Frequency list (linear +interpolation). +Specify if the frequency points are manually entered or imported from a file. +3. Select one of the following: +• To enter each frequency point, click Dielectric loss tangent or Conductivity and enter the +dielectric properties for each frequency point. +• To import the frequency points from a file, click Import points. +1. +2. +In the File name field, browse for the file you want to import. +[Optional] In the Scale by field, enter a value to scale the points. +For example, if you import a value of “2”, scale it by “10e9” to change the value to +2 GHz. +3. Under Delimiter, click the delimiter type you use in your file. +4. Click OK to close the Import Points dialog. +[Optional] Specify the magnetic properties of the dielectric. +[Optional] In the Mass density (kg/m^3) field, enter a value for ρ. +In the Label field, enter a unique label for the dielectric. +4. +5. +6. +7. Click Create to create the dielectric and to close the dialog. +Related tasks +Applying a Dielectric to a Region +Creating an Isotropic Layered Dielectric (2D) +2.16.3 Creating an Isotropic Layered Dielectric (2D) +Create a layered dielectric medium. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +select the + Layered Dielectric (2D) icon. +Figure 124: The Create Layered Dielectric dialog. +In the Label field, enter a unique label for the dielectric. +In the Thickness field, enter a value for the layer thickness. +In the Dielectric material field, select one of the following options: +• To add a dielectric layer consisting of a predefined dielectric, select the dielectric. +• To add a dielectric layer consisting of a dielectric, which is not yet defined in the model, click +the + icon to define the dielectric or add a dielectric from the media library. +[Optional] To add an additional layer, click Add. +[Optional] To remove a layer, click Remove. +2. +3. +4. +5. +6. +7. Click Create to create the dielectric and to close the dialog. +Related tasks +Applying a Coating to a Wire or Face +Applying a Thin Dielectric Sheet to a Face +2.16.4 Creating an Anisotropic Layered Dielectric (2D) +Create an anisotropic layered dielectric. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +select + Anisotropic Layered Dielectric (2D) icon. +2. +In the Label field, enter a unique label for the dielectric. +Figure 125: The Create Layered Dielectric (Anisotropic) dialog. +3. +4. +5. +In the Thickness field, enter a value for the layer thickness. +In the Principal direction (deg) field, enter the angle of the principal direction. +In the Material in principal direction field, select one of the following: +• To add a dielectric layer in the principal direction, consisting of a predefined dielectric, select +the dielectric. +• To add a dielectric layer in the principal direction consisting of a dielectric, which is not yet +defined in the model, click the + icon to define the dielectric or add a dielectric from the +media library. +6. +In the Material in orthogonal direction field, select one of the following: +• To add a dielectric layer in the orthogonal direction consisting of a predefined dielectric, select +the dielectric. +• To add a dielectric layer in the orthogonal direction consisting of a field, which is not yet +defined in the model, click the + icon to define the dielectric or add a dielectric from the +media library. +7. +8. +[Optional] To add an additional layer, click Add. +[Optional] To remove a layer, click Remove. +Related tasks +Applying a Layered Anisotropic to a Face +2.16.5 Creating a Metallic Medium +Create a metal. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +select the + Metallic icon. +2. Click Manually define medium. +3. Specify the magnetic properties of the metal. +• To create a frequency-independent metal, from the Definition method drop-down list select +Frequency independent. +• To create a frequency-dependent metal, from the Definition method drop-down list select +Frequency list (linear interpolation). +• To enter each frequency point manually, enter the magnetic properties for each frequency +point. +• To import the frequency points from a file, click Import points. +1. +2. +In the File name field, browse for the file you want to import. +[Optional] In the Scale by field, enter a value to scale the points. +For example, if you import a value of “2”, scale it by “10e9” to change the value to +2 GHz. +3. Under Delimiter, click the delimiter type you use in your file. +4. Click OK to close the Import Points dialog. +4. +[Optional] To include the effects of a rough surface, select the Surface roughness (RMS value +in m) check box and enter a value (root mean square value in metre). +Related tasks +Applying a Metal to a Face +2.16.6 Importing a Medium from File +Import a dielectric, metal or impedance sheet from a .XML file that describes the medium properties. +1. Select one of the following: +• Create a dielectric. On the Construct tab, in the Define group, click the + Media icon. +From the drop-down list, click the + Dielectric icon. +• Create a metal. On the Construct tab, in the Define group, click the + Media icon. From +the drop-down list, select the + Metallic icon. +• Create an impedance sheet. On the Construct tab, in the Define group, click the + Media +icon. From the drop-down list, select the + Impedance Sheet icon. +2. Click Import medium from file. +3. +In the File name field, browse for the file you want to import. +4. Click Create to import the medium and to close the dialog. +XML File Format for Importing Media +View the .xml file format that describes the medium properties of a dielectric, metal or impedance +sheet. +Overview +Define the medium using the following workflow: +1. Define the frequency independent (static) properties for the medium using keywords. +2. Define the frequency dependent properties for the medium using keywords. +When the file is read, the internal XML parser populates the missing values for the frequency dependent +data points using the static data points. +Keywords for the .xml file +Use the following keywords to define the medium: +Dielectric +freq, permittivity, diel_loss_tangent, mag_loss_tangent, conductivity, permeability. +Metal +freq, conductivity, permeability, mag_loss_tangent. +Impedance sheet +freq, surf_imp_re, sur_imp_im +Example of an .xml file +The following is an example of an .xml file that describes a medium with frequency independent (static) +values as well as measured frequency independent values. +Note: For demonstrative purposes, the keywords val_A, val_B and val_C are used as the +same format is applicable for defining a dielectric, metallic or impedance sheet. + + + + + + + + + + + + +In line 4 to 10: Define the frequency dependent properties for mediumA. + +The internal XML parser then populates the missing values. The above example is parsed internally as if +you specified the following file: + + + + + + + + + + + + +Legend: +static value +frequency dependent value +implicit value +10 +constant +extrapolation +linear interpolation +constant +extrapolation +constant +extrapolation +linear interpolation +constant +extrapolation +constant +extrapolation +linear interpolation +constant +extrapolation +_ +_ +_ +Frequency +10 +Figure 126: An illustration showing the result of the parsed XML file. +2.16.7 Anisotropic Media (3D) +Create an anisotropic medium with specified material properties. +The following tensor types descriptions are supported: +• Polder tensor (for ferrites) +Altair Feko 2022.3 +2 CADFEKO +• Diagonalised tensor +• Full tensor +• Complex tensor +Related concepts +Anisotropic Media Formulations +p.212 +Creating an Anisotropic Medium (Ferrite) +Create a ferrimagnetic medium. The medium is described by the permittivity and permeability tensors +where the static magnetic field is orientated along the U axis, V axis and N axis respectively. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +select the + Anisotropic (3D) icon. +Figure 127: The Create Anisotropic Dielectric dialog (Polder tensor). +2. +In the Tensor type field, from the drop-down list select Polder tensor (ferrites). +3. Specify the magnetic properties. +a) Under Medium properties, in the Saturation magnetisation (Gauss) field, enter a value +for 4 Ms. +b) Under Medium properties, in the Line width (Oersted) field, enter a value for ΔH. +c) Under Magnetostatic bias field, in the DC bias field (Oersted) field, enter a value for H0. +d) Under Magnetostatic bias field, from the Field direction drop-down list, select one of the +following: +• X directed +• Y directed +• Z directed +4. Specify the dielectric properties. +a) In the Relative permittivity field, enter a value for εr. +b) In the Dielectric loss tangent field, enter a value for tanδ. +5. +In the Label field, enter a unique label for the ferrite medium. +6. Click Create to create the anisotropic medium and to close the dialog. +Related tasks +Applying an Anisotropic Dielectric to a Region +Creating an Anisotropic Medium (Diagonalised Tensor) +Create an anisotropic medium by defining the diagonal permittivity tensor and diagonal permeability +tensor. +Tip: Create up to three dielectrics constituting the medium properties along the UU axis, VV +axis and NN axis. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +select the + Anisotropic (3D) icon. +Figure 128: The Create Anisotropic Dielectric dialog (Diagonalised tensor). +2. +In the Tensor type field, from the drop-down list select Diagonalised tensor. +3. For each diagonal entry, select one of the following options: +• To use the medium properties of free space, from the drop-down list select Free space. +• To indicate that no linear dependencies exist between the two axes, from the drop-down list +select 0. +• To use the medium properties of a predefined dielectric, from the drop-down list, select the +dielectric. +• To use the medium properties of a dielectric, which is not yet defined in the model, click the + icon to define the dielectric or add a dielectric from the media library. +4. +[Optional] In the Mass density (kg/m^3) field, enter a value for ρ. +5. Click Create to create the anisotropic medium and to close the dialog. +Related tasks +Applying an Anisotropic Dielectric to a Region +Creating an Anisotropic Medium (Full Tensor) +Create an anisotropic medium by defining the diagonal-permittivity tensor and diagonal-permeability +tensor along the UU axis, UV axis, UN axis, VU axis, VV axis, VN axis, NU axis, NV axis and NN axis. +Tip: Create up to nine dielectrics constituting the medium properties along the UU axis, UV +axis, UN axis, VU axis, VV axis, VN axis, NU axis, NV axis and NN axis. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +select the + Anisotropic (3D) icon. +Figure 129: The Create Anisotropic Dielectric dialog (Full tensor). +2. +In the Tensor type field, from the drop-down list select Full tensor. +3. For each entry, select one of the following options: +• To use the medium properties of free space, from the drop-down list select Free space. +• To indicate that no linear dependencies exist between the two axes, from the drop-down list +select 0. +• To use the medium properties of a predefined dielectric, from the drop-down list, select the +dielectric. +• To use the medium properties of a dielectric, which is not yet defined in the model, click the + icon to define the dielectric or add a dielectric from the media library. +4. +[Optional] In the Mass density (kg/m^3) field, enter a value for ρ. +5. Click Create to create the anisotropic medium and to close the dialog. +Altair Feko 2022.3 +2 CADFEKO +Related tasks +Applying an Anisotropic Dielectric to a Region +p.215 +Creating an Anisotropic Medium (Complex Tensor) +Create an anisotropic medium by defining the permittivity tensor and permeability tensor using complex +values. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +select the + Anisotropic (3D) icon. +Figure 130: The Create Anisotropic Dielectric dialog (Complex tensor). +2. +In the Tensor type field, from the drop-down list select Complex tensor. +3. Click the Dielectric modelling tab. +a) Enter a complex value in the relevant entries. +4. Click the Magnetic modelling tab. +a) Enter a complex value in the relevant entries. +Important: +• An entry in the tensor must be a complex number, pure real number or a pure +imaginary number. +• An entry may not be 0. +5. +[Optional] In the Mass density (kg/m^3) field, enter a value for ρ. +6. Click Create to create the anisotropic medium and to close the dialog. +Related tasks +Applying an Anisotropic Dielectric to a Region +2.16.8 Creating a Windscreen Layer +Create a windscreen layer consisting of dielectric layers. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +select the + Windscreen icon. +Figure 131: The Define windscreen dialog. +2. +In the Layer definition field, select one of the following: +• To create a windscreen layer consisting of a predefined layered dielectric, select the layered +dielectric. +• To create a windscreen layer consisting of a layered dielectric, which is not yet defined in the +model, click the + icon to define the layered dielectric. +Note: The enumeration of the windscreen layers increases in the opposite direction as +the reference direction. +3. +In the Offset L field, enter a value for the distance from the windscreen curvature reference to +the top of layer 1. +4. +In the Label field, enter a unique label for the windscreen medium. +5. Click Create to create a windscreen layer and to close the dialog. +Related tasks +Applying a Windscreen Layer to a Face +Displaying Windscreen Thickness +2.16.9 Creating an Impedance Sheet +Define a frequency-dependent impedance sheet. Apply the impedance sheet to wires or faces bordering +free space or a dielectric region. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +select the + Impedance Sheet icon. +Figure 132: The Create Impedance Sheet dialog. +2. +3. +4. +In the Definition method field, from the drop-down list select Frequency independent. +In the Real part field, enter a value for the real part of the impedance sheet. +In the Imaginary field, enter a value for the imaginary part of the impedance sheet. +Specify the frequency points manually or import them from a file. +5. Select one of the following: +• To import the frequency points from a file, click Import points. +1. +2. +In the File name field, browse for the file you want to import. +[Optional] In the Scale by field, enter a value to scale the points. +3. Under Delimiter, click the delimiter type you use in your file. +4. Click OK to close the Import Points dialog. +6. +In the Label field, enter a unique label for the impedance sheet. +7. Click Create to create the impedance sheet and to close the dialog. +2.16.10 Creating a Characterised Surface +Define a surface that is characterised by previously obtained data in a .tr file. +Note: Only supported in conjunction with the RL-GO solution method. +1. On the Construct tab, in the Define group, click the + Media icon. From the drop-down list, +select the + Characterised Surface icon. +Figure 133: The Create characterised surface medium dialog. +2. +3. +In the Filename field, browse to the location of the .tr file. +In the Label field, enter a unique label for the characterised surface. +4. Click Create to define the characterised surface and to close the dialog. +Related concepts +Ray Launching Geometrical Optics (RL-GO) +Related tasks +Applying a Characterised Surface to a Face +2.17 Applying Media Settings +Defined media can be applied to the model in various ways. Some media settings are applied to +regions, others on faces and wires. The rules for defining media varies between the different solution +methods. +2.17.1 Applying a Metal to a Face +Apply a metal to a face bordering a free space or dielectric region. +1. Select the face where you want to apply a metal. +2. From the right-click context menu, select Properties. +3. On the Modify Face dialog, click the Properties tab. +Figure 134: The Modify Face dialog (Properties tab). +4. +5. +In the Medium drop-down list, select the metal that you want to apply to the face. +In the Thickness field, enter the metal thickness. +6. Click OK to apply the metallic medium and to close the dialog. +Note: Closed regions containing metallic faces cannot be set to (solid) PEC. +2.17.2 Applying a Dielectric to a Region +Apply a dielectric to a region. +1. Select the region where you want to apply a dielectric. +2. From the right-click context menu, select Properties. +3. On the Region properties dialog, click the Properties tab. +Figure 135: The Modify Region dialog (Properties tab). +4. +In the Medium drop-down list, select the dielectric that you want to apply to the region. +5. Click OK to apply the dielectric and to close the dialog. +2.17.3 Coatings +A coating can be applied to wires or to both sides of a conducting face. +A coating can be applied to a face under the following conditions: +• One side must have free space. +• The other side must have free space or PEC. +Coating +Conducting surface +Coating +Figure 136: Coatings are applied to both sides of conducting surfaces. +The following coating thickness requirements apply when using the MoM / MLFMM, PO or RL-GO solution +methods: +Solution Method Coating Thickness Requirement +CO Card Equivalent +MoM / MLFMM +Both electrically thin and geometrically +thin +Electrically thin surface coating +MoM / MLFMM +Electrically thick, but geometrically thin +(single layer). +Dielectric / magnetic surface coating +(single layer) +Solution Method Coating Thickness Requirement +CO Card Equivalent +Note: +• Only for closed +structures with a PEC +surface and the normal +vector pointing towards +the source(s). +• Coating is applied to +both sides of the PEC +surface, since fields will +be zero where there is +no sources. +PO +RL-GO +Electrically thick, but geometrically thin Dielectric / magnetic surface coating +Both electrically thick and geometrically +thick +Dielectric / magnetic surface coating +Note: A geometrically thin coating must be thin relative to the triangle size (and as a result +also to the free space wavelength) as well as the curvature radius of the surface. +Applying a Coating to a Wire or Face +Add a surface coating to a wire or to both sides of a conducting face. +1. Create the layered dielectric to use as a coating: +a) Create the dielectric(s). +b) Create a layered dielectric to be used as the coating. +2. +In the details tree select the wire or face where you want to apply a coating. +3. From the right-click context menu, select Properties. +Figure 137: The Modify Face dialog. +4. On the Modify Edge / Modify Face dialog, click the Properties tab. +5. Under Coating, select the Apply coating check box and select the coating type. +• Electrically thin +Use this option to add an electrically thin, multilayer dielectric / magnetic coating. +• Electrically thick (single layer only) +Use this option to add a single layer, electrically thick, dielectric / magnetic coating to +a closed structure with a PEC surface. This is typically used to model radar-absorbing +materials (RAM)[26]. +• Characterised surface +Use this option to add a characterised surface as coating. +6. +In the Coating name field, from the drop-down list, select the layered dielectric or characterised +surface to be used as the coating. +The next step only applies for characterised surfaces. +7. Under U-Vector, specify the start point and end point for the U-Vector. The vector is not required +to be exactly in the plane of the face, since it is projected onto the face, but it should be +approximately parallel to the face. +8. +In the Thickness field, specify the thickness of the coating. +9. Click OK to apply the coating to the wire or face and to close the dialog. +2.17.4 Thin Dielectric Sheets +A thin dielectric sheet can be applied to one side of a face to model flat multilayer dielectric structures. +Typical applications include radome enclosed antennas and automobile windscreens. +Note: A thin dielectric sheet can only be set on faces bordering free space regions. +26. A high-shielding coating. +Important: The order of the dielectric sheet layers is important when using RL-GO or UTD. +For example,consider a model with two layers. One layer is a good absorber and the second is a good +conducting layer. When a ray is incident on the side of the absorber, the reflection is zero. When a ray is +incident on the side of the conducting layer, the reflection is near perfect. The transmission coefficient in +both cases is zero. +Normal vector +d/2 +d/2 +Ray 1 +Ray 2 +Reference +Medium/layers +Figure 138: The order of the layers for thin dielectric sheets is important when used in conjunction with RL-GO and +UTD. +The definition of which side is the front / rear is determined by the normal vector n of the triangles. If +one ray is incident in the direction of the normal vector (ray 1) and as a result hits the first layer (index +number n - layer with the highest index number). An incident ray in the opposite direction of the normal +vector (ray 2) will first hit the layer with the lowest index number. +Applying a Thin Dielectric Sheet to a Face +Add a thin dielectric sheet to a face bordering a free space region. +The thin dielectric sheet approximation changes the surface impedance of triangular elements. Only the +boundary condition is affected. +1. Create the layered dielectric to use as a thin dielectric sheet: +a) Define the dielectric(s). +b) Define the layered dielectric. +2. +In the details tree select the face where you want to apply the thin dielectric sheet. +3. From the right-click context menu, select Properties. +4. On the Modify Face dialog, click the Properties tab. +Figure 139: The Modify Face dialog. +5. Under Face medium, in the Medium drop-down list, select the layered dielectric medium to be +used as the thin dielectric sheet. +6. Click OK to apply the thin dielectric sheet to the face and to close the dialog. +2.17.5 Applying a Layered Anisotropic to a Face +Apply a layered anisotropic dielectric to a face bordering a free space or dielectric region. +1. Define a layered anisotropic dielectric. +2. Select the face where you want to apply a layered anisotropic dielectric. +3. From the right-click context menu, select Properties. +4. On the Modify Face dialog, click the Properties tab. +Figure 140: The Modify Face dialog (Properties tab). +5. +In the Medium drop-down list, select the layered anisotropic that you want to apply to the face. +6. Under Reference direction, specify the Start point and End point to define the principal +direction of the layered anisotropic medium. +7. Click the OK to apply the layered anisotropic to the face and to close the dialog. +2.17.6 Applying an Anisotropic Dielectric to a Region +Apply an anisotropic dielectric to a region. +Note: When using the FDTD solution method, the anisotropic medium orientation is defined +in the global coordinate system. For FEM, the orientation can be defined in a local coordinate +system. +1. Define an anisotropic (3D) medium. +2. Select the region where you want to apply the anisotropic dielectric. +3. From the right-click context menu, select Properties. +4. On the Modify Region dialog, click the Properties tab. +Figure 141: The Modify Region dialog (Properties tab). +5. +6. +In the Medium drop-down list, select the layered anisotropic that you want to apply to the face. +In the Definition method drop-down list, select the coordinate system in which the medium +orientation is defined (only for FEM solution method). +• Cartesian +• Cylindrical +• Spherical +7. +In the Reference workplane drop-down list, select the workplane in which the medium +orientation is defined. +8. Click OK to apply the anisotropic medium to the region and to close the dialog. +2.17.7 Applying an Impedance Sheet to a Wire or a Face +Apply a surface impedance to a wire or a face bordering a free space or dielectric region. +As an example, an impedance sheet is applied to a face. The steps are similar for applying an +impedance sheet to a wire. +1. Define an impedance sheet. +2. Select the face where you want to apply a surface impedance. +3. From the right-click context menu, select Properties. +4. On the Modify Face dialog, click the Properties tab. +Figure 142: The Modify Face dialog (Properties tab). +5. +In the Medium drop-down list, select the impedance sheet that you want to apply to the face. +6. Click the OK to apply the impedance sheet and to close the dialog. +2.17.8 Applying a Windscreen Layer to a Face +Apply a windscreen layer to a face bordering a free space or dielectric region. +1. Define a windscreen layer. +2. Select the face where you want to apply a windscreen layer. +3. From the right-click context menu, select Properties. +4. On the Modify Face dialog, click the Solution tab. +Figure 143: The Modify Face dialog (Solution tab). +5. +6. +In the Solve with special solution method group, in the Solution method drop-down list, +select Windscreen. +In the Windscreen name drop-down list, select the windscreen layer that you want to apply to +the face. +7. +In the Definition methods drop-down list, select one of the following: +• To define the curvature reference for the windscreen, select Reference element. +• To define the metallic antenna elements for the windscreen, select Windscreen solution +element. +8. Click OK to apply the windscreen layer to the face and to close the dialog. +2.17.9 Applying a Characterised Surface to a Face +Apply a characterised surface to a face bordering free space or dielectric regions. +Note: Characterised surfaces are only supported in conjunction with the RL-GO or +MoM/MLFMM solution methods. +When a characterised surface definition is applied to a face, you must specify a vector to ensure the +correct surface orientation. The U-Vector should be set to point into the direction of the U-Vector (or X +vector in global coordinates) of the original characterised surface. This characterisation is performed +either through solving with periodic boundary conditions, an infinite ground plane or measurements. +The projection of the U-Vector onto the face correspond to the U-Vector (or principal direction) of the +original characterised surface. +The orientation of the U-Vector is only important when the characterised surface is anisotropic +(properties dependent on the plane wave angle of incidence). Isotropic surfaces do not depend on the +orientation of the U-Vector. Consequently the only requirement for the U-Vector is that there should be +a valid projection of the vector onto the face. In essence this means that the U-Vector is not allowed to +point into the direction of the face normal. +Note: The face normal vector is the vector that is perpendicular to the face. +• For flat faces, the normal is the same everywhere on the face. +• For curved faces, the normal changes as a function of the position on the face. +Curved surfaces such as radomes have to be split into smaller faces so that a valid U-Vector can be +defined for each surface. As an illustration, consider a sphere. There is no single vector that has a valid +projection onto the surface of a sphere, since at two points, the vector points in the direction of the face +normal. +1. Select a face to apply a characterised surface. +2. From the right-click context menu, select Properties. +3. On the Modify Face dialog, click the Properties tab. +Figure 144: The Modify Face dialog (Properties tab). +4. +5. +In the Medium drop-down list, select the characterised surface to apply to the face. +In the Thickness field, specify the thickness of the characterised surface (only supported for +MoM/MLFMM). +The U-Vector is defined as the reference direction projected onto the face. +6. Under U-Vector, specify the start point and end point for the U-Vector. The vector is not required +to be exactly in the plane of the face, since it is projected onto the face, but it should be +approximately parallel to the face. +Figure 145: The display in CADFEKO when setting the U-Vector. Opacity settings were modified in order to +see the U-Vector preview. +7. Click OK to apply the characterised surface and to close the dialog. +The U-Vector can be displayed in POSTFEKO to verify that all faces have the correct settings and +U-Vector orientations applied. +Figure 146: Characterised surface orientation displayed in POSTFEKO where each face has a different U- +Vector applied. +Related concepts +Ray Launching Geometrical Optics (RL-GO) +2.17.10 Creating a Slot in a Face Using Aperture Triangles +Define an aperture or slot in an infinite ground plane using aperture triangles. +1. Select the face where you want to apply the aperture triangles. +2. From the right-click context menu, select Properties. +3. On the Modify Face dialog, click the Solution tab. +Figure 147: The Modify Face dialog (Solution tab). +4. Under Solve with special solution method, in the drop-down list select Planar Green's +function aperture. +5. Click OK to apply the aperture triangles and to close the dialog. +2.18 Periodic Boundary Condition (PBC) +Use a periodic boundary condition (PBC) to analyse infinite periodic structures. A typical application of +PBC is to analyse frequency selective surface (FSS) structures. +The unit-cell definition for the periodic boundary condition solution is based on vectors. For the one- +dimensional case, the start point and end point of a single vector are required. Periodicity is defined +based on two planes perpendicular to the vector formed between them. The vector used to define one- +dimensional periodicity can have any orientation but must have a non-zero length. +For the two-dimensional case, two vectors are required. These vectors form the two boundaries of the +unit cell which is infinite in the direction normal to the plane in which both vectors lie. The vectors that +define the unit-cell for two-dimensional periodicity must have non-zero length, and cannot be oriented +in the same direction. +Figure 148: The periodic boundary condition for two-dimensional periodicity. +A phase shift can be applied in the direction of the vectors defining the unit-cell. The specified values for +the phase-shift are only used if a plane wave source is not present. +Note: If a plane wave source is present and a phase is specified, the Solver will return an +error during the solution. +For array modelling using periodic boundary conditions, the beam (squint) angle is specified by defining +the theta and phi angle. The phase along the periodic lattice vectors is computed automatically to +ensure the specified beam direction. +2.18.1 Defining a Periodic Boundary Condition (PBC) +Specify a periodic boundary condition (PBC) to analyse infinite periodic structures. +1. On the Construct tab, in the Structures group, click the + Planes/Arrays icon. From the +drop-down list, select + Periodic Boundary Conditions. +Figure 149: The Periodic Boundary Conditions dialog. +2. From the Number of dimensions list, select one of the following: +• To create a one-dimensional PBC where the unit cell is repeated along a line, select One +dimension. +• To create a two-dimensional PBC where the unit cell is repeated to form a surface, select Two +dimensions. +• To remove the PBC from the model, select No periodic boundary. +3. Under Start point, specify the start point of the vector. +4. Under End point of first vector, specify the end point of first vector. +5. Under End point of second vector, specify the end point of the second vector. +6. Under Phase shift, select one of the following: +• When a plane wave is used as excitation, the phase difference between the cells cannot be +specified. To determine the phase shift of the excitation, select Determine from plane- +wave excitation. +• To specify the phase shift, select Specify manually. +• In the u1 field, specify the phase shift in the first direction, u1. +• In the u2 field, specify the phase shift in the second direction, u2. +• To specify the theta and phi angle of the “squint” angle, select Determine from beam +pointing (squint) angle. +• In the Theta field, specify the theta angle of the “squint” angle. +• In the Phi field, specify the phi angle of the “squint” angle. +7. Click OK to define the PBC and to close the dialog. +2.19 Finite Antenna Arrays +Create an arbitrary finite antenna array that consists of an array of contributing elements, either with +direct feeds for each element or via indirect coupling, and solve with the efficient domain Green's +function method (DGFM). +Create the base element (antenna) and create a linear, planar, cylindrical or circular finite antenna array +with ease. Add custom antenna array elements to create complex and arbitrary finite antenna array +structures. +The DGFM solver considers the self-coupling, mutual coupling and the edge effects of the finite array, +but only uses the computational resources equivalent to solving the base element. +Note: The base element encompasses all structures in the model when creating a finite +antenna array (except for infinite planes). +2.19.1 Creating a Linear / Planar Antenna Array +Create a linear or planar finite antenna array model. +1. On the Construct tab, in the Structures group, click the + Planes/Arrays icon. From the +drop-down list, select the + Linear/Planar Array icon. +2. Specify the elements in the U dimension. +a) Under U dimension, in the Number of elements field, specify the number of array +elements. +b) Under U dimension, in the Offset along U axis field, specify the offset between the array +elements. +3. Specify the elements in the V dimension. +a) Under V dimension, in the Number of elements field, specify the number of array +elements. +b) Under V dimension, in the Offset along V axis field, specify the offset between the array +elements. +4. +In the Label field, add a unique label for the antenna array. +Figure 150: The Create Linear Planar Array dialog. +5. Click the Distribution tab to specify the array distribution. +• To create an antenna array where the distribution is calculated from the plane wave (if a +plane wave is present in the model), click the Uniform distribution or calculated from +plane wave check box. +• To create an antenna array with a specified excitation for each element, clear the Uniform +distribution or calculated from plane wave check box. +Note: When specifying each element, take note of the array element indexing. +Figure 151: Image depicting the array element indexing. +• To specify the magnitude scaling and phase offset manually: +1. +2. +In the Magnitude scaling field, specify the excitation magnitude for the individual +element relative to the base element. +In the Phase offset (degrees) field, specify the phase offset (in degrees) for the +individual element relative to the base element. +• To specify the magnitude scaling and phase offset by importing the points from file, click +Import. +◦ +◦ +In the File name field, browse for the file you want to import. +[Optional] In the Scale by field, enter a value to scale the points. +◦ Under Delimiter, click the delimiter type you use in your file. +◦ Click OK to close the Import Points dialog. +2.19.2 Creating a Cylindrical / Circular Antenna Array +Create a cylindrical or circular finite antenna array model. +1. On the Construct tab, in the Structures group, click the + Planes/Arrays icon. From the +drop-down list, select the + Cylindrical/Circular Array icon. +2. +In the Radius field, enter the radius of the cylindrical / circular antenna array. +3. Specify the elements in the phi dimension. +a) Under Phi dimension, in the Number of elements field, specify the number of array +elements. +b) Under Phi dimension, in the Specify increment field, specify the offset between the array +elements. +4. Specify the elements in the N dimension. +a) Under N dimension, in the Number of elements field, specify the number of array +elements. +b) Under N dimension, in the Offset along N axis field, specify the offset between the array +elements. +5. Specify the element rotation. +• To place the array elements with the same orientation as the base element, clear the +Element orientation check box. +• To rotate the array elements sequentially, select the Element orientation check box. +6. +In the Label field, add a unique label for the antenna array. +Figure 152: The Create Cylindrical Circular Array dialog. +7. Click the Distribution tab to specify the array distribution. +• To create an antenna array where the distribution is calculated from the plane wave (if a +plane wave is present in the model), click the Uniform distribution or calculated from +plane wave check box. +• To create an antenna array with a specified excitation for each element, clear the Uniform +distribution or calculated from plane wave check box. +Note: When specifying each element, take note of the array element indexing. + 6 + 3 + 5 + 2 + 4 + 1 +Figure 153: Image depicting the array element indexing. +• To specify the magnitude scaling and phase offset manually: +1. +In the Magnitude scaling field, specify the excitation magnitude for the individual +element relative to the base element. +2. +In the Phase offset (degrees) field, specify the phase offset (in degrees) for the +individual element relative to the base element. +• To specify the magnitude scaling and phase offset by importing the points from file, click +Import. +◦ +◦ +In the File name field, browse for the file you want to import. +[Optional] In the Scale by field, enter a value to scale the points. +◦ Under Delimiter, click the delimiter type you use in your file. +◦ Click OK to close the Import Points dialog. +2.19.3 Creating a Custom Array Element +Create a custom array element. Use a custom array element to create an irregular-spaced array. +1. On the Construct tab, in the Structures group, click the + Planes/Arrays icon. From the +drop-down list, select the + Custom Array Element icon. +2. Under Origin, enter the position of the workplane using one of the following methods: +• Enter the coordinates for the origin manually. +• Use point entry to enter the coordinates for the origin from the 3D view. +3. Under Excitation, in the Magnitude scaling field, enter the excitation magnitude for the +element. +4. Under Excitation, in the Phase offset (degrees) field, enter the phase offset for the element in +degrees. +5. +In the Label field, add a unique label for the antenna array. +Figure 154: The Create Antenna Array Element dialog. +2.19.4 Converting an Array to a Custom Array +Convert a linear, planar, cylindrical or circular antenna array to a custom array as a starting point to +create complex and regular-spaced or irregular-spaced array elements. +1. +In the model tree, click the linear, planar, cylindrical or circular antenna array that you want to +convert to custom antenna array elements. +2. From the right-click context menu, select Convert to Custom Array. +The individual array elements from the original antenna array are converted to custom array +elements. +2.19.5 Finite Antenna Array Solver Settings +View the solver settings applicable to finite antenna arrays. +On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. Click the +Domain decomposition tab. +Figure 155: The Solver Settings (Domain decomposition) dialog. +Solve model with Domain Green's Function Method (DGFM) +Select the Solve model with Domain Green's Function Method (DGFM) check box to solve +the model with the faster finite antenna array solution method. Clear the check box to solve the +model using a full wave solution method (for example MoM or MLFMM) +Tip: Clear the check box to do comparisons at specific frequencies over a frequency +range. +Deactivate coupling between domains +Select the Deactivate coupling between domains check box to ignore the mutual coupling +between the antenna array elements. +Tip: Use this option when the coupling between array elements is negligible. +Altair Feko 2022.3 +2 CADFEKO +2.19.6 Base Element Display +p.239 +View the original base element and the full finite antenna array in the 3D view. +After a finite antenna array has been created, the base (original) element is indicated by green hatching +in the 3D view. +Figure 156: The base (original) element is indicated by green hatching in the 3D view. +Note: A large finite array with non-uniform distribution will affect the 3D rendering and +performance in POSTFEKO and in CADFEKOwhen modifying large arrays. +2.20 Windscreen Tools +Use the windscreen tools to define a curved reference surface constrained by a cloud of points, normals +and optional U′V′ parameters. The constrained surface is then used as a reference to create a work +surface where windscreen layers and curved parameterised windscreen antenna elements can be +created. +2.20.1 Parametrised Windscreen Antenna Elements +View the workflow for creating curved parameterised windscreen antenna elements. +1. +Import windscreen glass and antenna boundary. +• The antenna boundary will be used as the outline for the constrained surface. +2. Project antenna boundary onto windscreen surface. +• To ease snapping, the antenna boundary and windscreen surface should be a single part. +Union the windscreen and antenna boundary. If the antenna boundary is not coincident with +the windscreen surface, project its outline onto the windscreen surface. +3. Create a constrained surface. +• The windscreen surface is approximated by a constrained surface specified by a cloud of +points, normals and optional U′V′ parameters. +4. Create a work surface. +• A work surface is created from the constrained surface. The work surface is used to define +surface curves in the U′V′ parameter space of this surface. +5. Create windscreen antenna elements. +• Windscreen antenna elements are defined in the specified work surface using Surface lines, +Surface Bézier curves and Surface regular lines curves. +6. Mesh the model. +• To prevent the constrained surface from being meshed, exclude the constrained surface in the +model. +2.20.2 Accessing the Windscreen Tab on the Ribbon +The Windscreen tab is not displayed on the ribbon by default. To access the Windscreen tab, you +must configure the ribbon to show the tab. +On the Home tab, in the Extensions group, click the + Windscreen icon. +Figure 157: The ribbon with Windscreen tab selected. +When the Windscreen tab is enabled, it is displayed between the Transform tab and Source/Load +tab. +2.20.3 Constrained Surface +A constrained surface is a reference surface constrained by a cloud of points, normals and optional +U′V′ parameters. Use a constrained surface as a reference to create windscreen layers and curved +parameterised windscreen antenna elements. +Surface parameters (U′ and V′) define the outline and internal grid lines of a constrained surface. +Define the same U′ value at a set of points to force a single U′ grid line to flow through the points. +Similarly, define the same V′ value at a set of points to force a single V′ grid line. +Lines of constant U' values +Lines of constant +V' +values +V' +U' +Figure 158: Constrained surface with lines of constant U' and V' values highlighted. +The range of values assigned to the U′ or V′ grid lines only determine relative distances in the U′V′ +space. +For example, setting the range of the U′ grid lines as -1...1, 0...1 or 0...100 will only influence +the relative U′ distance between the adjacent U′ grid lines. +Creating a Constrained Surface +Define a constrained surface that will be used to create windscreen layers and curved parametrised +windscreen antenna elements. +Before creating a constrained surface: +1. Enable the Windscreen tab on the ribbon. +2. +Import the windscreen glass and antenna boundary. +3. Union the windscreen glass and antenna boundary. +4. +If the antenna boundary does not lie on the windscreen surface, project its outline onto the +windscreen surface. +If the prerequisite steps have been executed, then proceed as follows: +1. On the Windscreen tab, in the Surface Preparation group, click the + Constrained Surface +icon. +Specify the outline of the constrained surface. +2. Use point-entry to add points to the table by snapping to points on the windscreen outline. +Table 7: Creating a constrained surface. +Tip: For the moment ignore the Surface parameter column. The surface parameters +(U′ and V′) control the flow of the grid lines and are specified in Step 5 to Step 8. +A blue square indicates a point added to the table. A red square indicates the current selected +point in the table. Its number corresponds to its location in the table. +The preview of the constrained surface is indicated in green. +Note: The windscreen was offset slightly away from the camera to improve rendering. +If the windscreen is symmetric, you only need to specify points on half of the windscreen. +3. +[Optional] Click the Advanced tab. +a) Check the Mirror points w.r.t symmetry plane check box. +b) Specify the symmetry plane for the windscreen by either clicking UV, UN or VN. +c) Define the surface parameter (U′ or V′) which is constant at the symmetry plane and its +value at the symmetry plane. +Table 8: Mirroring the constrained surface. +4. Click the Geometry tab. +[Optional] Specify the U′ (or V′) value at the symmetry plane. +5. +If the U′ (or V′) value at the symmetry plane was defined in Step 3.c, specify this value at the +points on the symmetry grid line. +For this example, the Constant surface parameter at plane is specified as U′=1. +Points 3, 4, 5, 6 and 7 on the symmetry plane are set to U′=1. +Define the U′ values for the points to control the left and right grid lines. +6. Start at a corner point on and enter a U′ value. Repeat for remaining points on the left grid line +and right grid line. +Table 9: Setting the constant U' parameters for the constrained surface. +Number +U′ +V′ +14 +Number +U′ +V′ +13 +12 +11 +10 +For this example, corner point 1 and points 14, 13, 12, 11 and 10 are set to U′=0. +Points 3, 4, 5, 6 and 7 were defined in Step 5 as it is located on the symmetry plane. +Define the V′ values for the points to control the top and bottom grid lines. +7. Start at a corner point and enter a V′ value. Repeat for the remaining points on the top grid line +and bottom grid line. +Table 10: Setting the constant V' parameters for the constrained surface. +Number +U′ +V′ +10 +For this example, corner point points 10, 9, 8 and 7 are set to V′=0. +Points 1, 2 and 3 are set to V′=4. +8. +[Optional] Add additional internal points to ensure the internal grid lines follow the imported +guidelines. +For this example, points, 15, 16 and 17 were added. +Table 11: Setting optional additional internal points for the constrained surface. +Number +11 +15 +13 +16 +17 +14 +U′ +V′ +9. Click Create to create the constrained surface and to close the dialog. +Related tasks +Accessing the Windscreen Tab on the Ribbon +2.20.4 Creating a Work Surface +Create a work surface from a constrained surface. The work surface is used to define surface curves in +the U′V′ parameter space of this surface. +1. On the Windscreen tab, in the Surface Preparation group, click the + Work Surface icon. +2. With the Reference face field active, click on the constrained surface in the 3D view. +Figure 159: The Create Work Surface dialog. +3. +In the Offset field, specify the work surface offset from the constrained surface. +4. Click Create to create the work surface and to close the dialog. +The defined work surface is displayed in the model tree. +Figure 160: Snippet of the model tree after creating the work surface. +Related tasks +Accessing the Windscreen Tab on the Ribbon +2.20.5 Defining Windscreen Elements on a Curved Work +Surface +Define curved parameterised windscreen antenna elements on a specified work surface by using surface +lines, surface Bézier curves or an array of linearly spaced lines. +Figure 161: A preview of regular spaced surface lines on a curved work surface. +1. Create a line in the curved work space. +a) On the Windscreen tab, in the Create Surface Curve group, click the + Surface Line +icon. +Figure 162: The Create Surface Line dialog. +b) Specify the Start point, End point and Work surface. +c) Click Create to create the surface line and to close the dialog. +2. Create a surface Bézier curve in the curved workspace. +a) On the Windscreen tab, in the Create Surface Curve group, click the + Surface Bézier +Curve icon. +Figure 163: The Create Surface Bezier Curve dialog. +b) Specify the Start point, Start tangent point, End tangent point, End point and Work +surface. +c) Click Create to create the surface Bézier curve and to close the dialog. +3. Create an array of linearly-spaced lines in the curved workspace. +a) On the Windscreen tab, in the Create Surface Curve group, click the + Surface +Regular Lines icon. +Figure 164: The Create Surface Regular Lines dialog. +b) Specify the Constant parameter, Start corner point, End corner point, Number of +lines and the Work surface. +c) Click Create to create the regular spaced surface lines and close the dialog. +Related tasks +Accessing the Windscreen Tab on the Ribbon +Altair Feko 2022.3 +2 CADFEKO +2.21 Cables +p.250 +Many electromagnetic compatibility and interference problems involve cables that either radiate, are +irradiated or cause coupling into other cables, devices or antennas. Use the cable modelling tool and +solver to analyse the coupling and radiation. +The following terminology is used: +Cable instance +A cable instance is a single cable (for example, coaxial cable or cable bundle) with a start +connector and an end connector, routed along a cable path. +Cable harness +A cable harness is a collection of cable instances along a specific cable path with a specified +solution method and cable coupling parameters. +2.21.1 Workflow for Analysing Cables +The general process is explained for setting up a complete cable analysis. +1. Define a cable instance. +a. Define the cable type or the cable cross section (for example, a cable bundle). +b. +[Optional] Define the cable shield. +c. Define the cable path. +d. Define the start connector and end connector. +e. Define the cable instance. +Altair Feko 2022.3 +2 CADFEKO +2. Define the cable harness. +p.251 +a. Specify the relevant cable path and view the cable instances routed along this path. +b. Specify the solution method for the outer cable problem. +c. Specify the cable coupling parameters. +3. Open the cable schematic view for each harness. +a. Add the circuit elements (for example, resistors, capacitors, inductors, SPICE circuits, ports, +ground) and connect the connector pins to the circuit elements. +4. Define the sources, loads and requests. +a. Add sources and loads to the cable ports. +b. Add schematic probes, cable probes or S-parameter requests to request results. +Related tasks +Defining a Cable Instance +Defining a Cable Harness +2.21.2 Accessing the Cables Tab on the Ribbon +Open the Cables tab on the ribbon to access advanced tools related to defining cable harnesses. +By default, the Cables tab is not displayed on the ribbon. To access the Cables tab, you must configure +the ribbon to show the tab. +On the Home tab, in the Extensions group, click the + Cables icon. +When the Cables tab is enabled, it is located on the ribbon between the Transform tab and Source/ +Load tab. +Figure 165: The ribbon in CADFEKO (Cables tab) +2.21.3 Harness Description List (KBL) Specification +Cable harnesses are becoming increasingly complex with innovations in the automotive industry. Import +a complex cable harness from a .kbl file using the “harness description list” (KBL) specification. +The following KBL[27] entities are supported: +• Coordinates +27. Kabelbaumliste, the German translation for “harness description list”. +• Cartesian_point +• Node +• Segment +• Routing +• Cable paths +• Cross sections +• Cable harnesses +• Contact_points +• Connector_occurrance +Note: +• Cross sections are read as single conductors and media properties are ignored. +• CADFEKO supports only a subset of the v2.3 KBL format. +• No manufacturing information, material information or proprietary information is parsed +from the .kbl file. +Workflow for Analysing Cables by Importing From a .KBL File +The general process is explained for setting up a complete cable analysis by importing a complex cable +harness from a .kbl file. +1. +Import the .kbl file. +2. Find specific cable instances and combine the multiple single conductors into a single cable. +3. Specify the solution method for the outer cable problem. +4. Specify the cable coupling parameters. +5. Open the cable schematic view of each harness. +a. Add the circuit elements (for example, resistors, capacitors, inductors, SPICE circuits, ports, +ground) and connect the connector pins to the circuit elements. +6. Define the sources, loads and requests. +a. Add sources and loads to the cable ports. +b. Add schematic probes, cable probes or S-parameter requests to request results. +Importing a Harness Description List (.KBL) File +Add a complex cable harness (defined in a .kbl) to the cable assembly for analysis. +1. On the Home tab, in the File group, click the + Import icon. From the drop-down list select the + KBL File (*.kbl) icon. +2. Select the .kbl file you want to import. +2.21.4 Cable Types +A comprehensive range of cable types is supported for cable analysis. +The following cable types are supported: +• Single conductor +• Coaxial cable +◦ Add a predefined coaxial cable from industry +◦ Define using cable characteristics +◦ Define using cable dimensions +• Ribbon cable +• Twisted pair +• Cable bundle +• Non-conducting element +Defining a Single Conductor Cable +Define a single conductor consisting of a core with an optional outer coating. +1. On the Cables tab, in the Definitions group, click the + Single Conductor icon. +Figure 166: The Create Single Conductor dialog. +2. Under Core, from the Metal drop-down list, select one of the following: +• To create a PEC core, select Perfect electric conductor. +• To create a core consisting of a predefined metal, select a metal. +• To create a core consisting of a metal, which is not yet defined in the model, click the + icon +to define a metal or add a metal from the media library. +3. Under Core, in the Radius field, enter the cable radius. +4. Under Insulation layer (coating), specify the following: +• To remove the coating, clear the With insulation check box. +• To add a coating, select the With insulation check box. +• To add a coating consisting of a predefined dielectric, select a dielectric. +• To add an insulation layer consisting of a dielectric, which is not yet defined in the model, +click the + icon to define a dielectric or add a dielectric from the media library. +5. Under Insulation layer (coating), in the Thickness field, enter the layer (coating) thickness. +6. +In the Label field, add a unique label for the single conductor. +7. Click Create to create the single conductor and to close the dialog. +Related tasks +Accessing the Cables Tab on the Ribbon +Adding a Predefined Coaxial Cable from Industry +Feko has an internal coaxial cable database that contains more than 20 popular coaxial cable types from +industry. +1. On the Cables tab, in the Definitions group, click the + Coaxial icon. +Figure 167: The Create Coaxial Cable dialog. +2. From the drop-down list, select a predefined coaxial cable from industry. +3. +In the Label field, add a unique label for the coaxial cable. +4. Click Create to create the coaxial cable and close the dialog. +Related tasks +Accessing the Cables Tab on the Ribbon +Defining a Coaxial Cable Using Cable Characteristics +Define a coaxial cable by its characteristic impedance and propagation constant. +1. On the Cables tab, in the Definitions group, click the + Coaxial icon. +2. Under Cable definition, from the Definition type drop-down list, select Specify cable +characteristics. +Figure 168: The Create Coaxial Cable dialog (Specify coaxial cable characteristics). +3. Under Characteristics, specify the following: +• In the Magnitude of characteristic imp. (Ohm) field, enter the characteristic impedance +(magnitude) for the coaxial cable. +• In the Attenuation (dB/m) field, enter the attenuation of the coaxial cable in dB/m. +• In the Velocity of propagation (%) field, enter a percentage for the velocity of propagation +through the coaxial cable. +4. Under Cable definition, in the Outer radius field, enter the outer radius of the coaxial cable. +Note: If a braided shield is applied to the coaxial cable the outer radius should be +inside the stretching limits for a braided shield. +5. Under Shielding, from the Shield drop-down list, select one of the following: +• To add an outer cable shield consisting of a predefined shield, select a cable shield. +• To add an outer cable shield consisting of a shield, which is not yet defined in the model, click +the + icon to define a new cable shield. +6. Under Insulation layer (coating), specify the following: +• To add a coating, select the Apply coating check box. +1. From the Medium drop-down list, specify the coating medium. +2. +In the Thickness field, specify the coating thickness. +• To remove the coating, clear the Apply coating check box. +7. +In the Label field, add a unique label for the coaxial cable. +8. Click Create to create the coaxial cable and to close the dialog. +Related tasks +Accessing the Cables Tab on the Ribbon +Defining a Coaxial Cable Using Cable Dimensions +Define a coaxial cable consisting of a core with outer insulating layers and a shield. +1. On the Cables tab, in the Definitions group, click the + Coaxial icon. +2. Under Cable definition, from the Definition type drop-down list, select Specify coaxial cable +dimensions. +Figure 169: The Create Coaxial Cable dialog (Specify coaxial cable dimensions). +3. Under Core, from the Metal drop-down list, select one of the following: +• To create a PEC core, select Perfect electric conductor. +• To create a core consisting of a predefined metal, select a metal. +• To create a core consisting of a metal, which is not yet defined in the model, click the + icon +to define a metal or add a metal from the media library. +4. Under Core, in the Radius field, enter the cable radius. +5. Under Core insulating layers, for each layer: +• To add a layer consisting of free space, select Free space. +• To add a coating consisting of a predefined dielectric, select a dielectric. +• To add an insulation layer consisting of a dielectric, which is not yet defined in the model, click +the + icon to define a dielectric or add a dielectric from the media library. +6. Under Core insulating layers, in the Thickness field, enter the layer thickness for each layer. +Note: If a braided shield is applied to the coaxial cable the outer radius (core + core +insulation layer (s) thickness + total shield thickness) should be inside the stretching +limits defined for the braided shield. +7. Under Shielding, from the Shield drop-down list, select one of the following: +• To add an outer cable shield consisting of a predefined shield, select a cable shield. +• To add an outer cable shield consisting of a shield, which is not yet defined in the model, click +the + icon to define a new cable shield. +8. Under Insulation layer (coating), specify the following: +• To add a coating, select the Apply coating check box. +1. From the Medium drop-down list, specify the coating medium. +2. +In the Thickness field, specify the coating thickness. +• To remove the coating, clear the Apply coating check box. +9. +In the Label field, add a unique label for the coaxial cable. +10. Click Create to create the coaxial cable and to close the dialog. +Related tasks +Accessing the Cables Tab on the Ribbon +Defining a Ribbon Cable +Define a ribbon cable consisting of multiple cores with an optional coating for each core. +1. On the Cables tab, in the Definitions group, click the + Ribbon icon. +Figure 170: The Create Ribbon dialog. +2. Under Topology, in the Number of cores field, enter the number of cores in the ribbon cable. +3. Under Topology, in the Core spacing (centre to centre) field, enter the distance between the +adjacent cables. +4. Under Core, from the Metal drop-down list, select one of the following: +• To create a PEC core, select Perfect electric conductor. +• To create a core consisting of a predefined metal, select a metal. +• To create a core consisting of a metal, which is not yet defined in the model, click the + icon +to define a metal or add a metal from the media library. +5. Under Core, in the Radius field, enter the radius of the core. +6. Under Insulation layer (coating), specify the following: +• To remove the coating, clear the With insulation check box. +• To add a coating, select the With insulation check box. +• To add a coating consisting of a predefined dielectric, select a dielectric. +• To add an insulation layer consisting of a dielectric, which is not yet defined in the model, +click the + icon to define a dielectric or add a dielectric from the media library. +7. +In the Label field, add a unique label for the ribbon cable. +8. Click Create to create the ribbon cable and to close the dialog. +Related tasks +Accessing the Cables Tab on the Ribbon +Defining a Twisted Pair +Define a twisted pair consisting of two cores that are twisted together for the purposes of cancelling +electromagnetic interference. Each core can have an optional coating. +1. On the Cables tab, in the Definitions group, click the + Twisted Pair icon. +Figure 171: The Create Twisted Pair dialog. +2. Under Core, from the Metal drop-down list, select one of the following: +• To create a PEC core, select Perfect electric conductor. +• To create a core consisting of a predefined metal, select a metal. +• To create a core consisting of a metal, which is not yet defined in the model, click the + icon +to define a metal or add a metal from the media library. +3. Under Insulation layer (coating), specify the following: +• To remove the coating, clear the With insulation check box. +• To add a coating, select the With insulation check box. +• To add a coating consisting of a predefined dielectric, select a dielectric. +• To add an insulation layer consisting of a dielectric, which is not yet defined in the model, +click the + icon to define a dielectric or add a dielectric from the media library. +4. Under Twisted pair, in the Radius field, enter the outer radius of the twisted pair cable. +5. Under Twisted pair, in the Pitch length field, enter the axial length required to complete one +revolution of the strand around the diameter of the conductor. +6. Under Twisted pair, in the Turn direction drop-down list, select one of the following: +• To define a twisted pair with its strands turning right, leading away from you, select Right. +• To define a twisted pair with its strands turning left, leading away from you, select Left. +7. +In the Label field, add a unique label for the twisted pair. +8. Click Create to create the twisted pair and to close the dialog. +Related tasks +Accessing the Cables Tab on the Ribbon +Defining a Cable Bundle +Define a cable bundle that may consist of multiple defined cables (for example, single conductors, +coaxial cables, ribbon cables, twisted pairs, other cable bundles and non-conducting elements) and that +are embedded in a medium with an optional shield. +Note: The following shield types are supported for cable bundles: +1. +Insulated, embedded in background medium (sheath/jacket) +2. Not shielded, embedded in a dielectric +3. Not shielded, embedded in background medium +4. Shielded, dielectric filled +1. On the Cables tab, in the Definitions group, click the + Cable Bundle icon. +Figure 172: The Create Bundle dialog. +2. On the Bundle tab, bundle the cables using one of the following methods: +• To create a cable bundle where the exact orientation of the cable in the bundle is unknown or +not relevant, select the Auto bundle check box. +• Click the Rearrange button to place the cables in a new random location inside the +bundle. +• To specify the location and orientation of the cables inside the cable bundle, clear the Auto +bundle check box. +• Specify the Offset X, Offset Y and Rotation of each cable contained in the bundle. +3. From the Cable drop-down list, specify the cables contained in the bundle using one of the +following methods: +• To specify a predefined cable, select the cable you want to add. +• To specify a cable, not yet defined in the model, click the + icon to define a cable type. +On the Insulation and Shielding tab, for shield types 1, 2 and 4, specify the Insulation medium. +4. On the Insulation and shielding tab, from the Insulation medium drop-down list, select one +of the following: +• To specify the insulation medium consisting of a predefined dielectric, select the dielectric. +• To specify the insulation medium consisting of dielectric, which is not yet defined in the +model, click the + icon to define a dielectric or add a dielectric from the media library. +For shield types 1, 2 and 4, specify the Outer radius for the cable bundle. +5. On the Insulation and shielding tab, to specify the Outer radius, select one of the following: +• To allow CADFEKO to calculate the outer radius of the cable bundle, select the Compute +automatically check box. +• To manually specify the outer radius of the cable bundle in the Outer radius field, clear the +Compute automatically check box. +For shield type 1, specify the Shield for the cable bundle. +Note: If a braided shield is applied to the cable bundle the outer radius should be inside the +stretching limits defined for the braided shield. +6. On the Insulation and shielding tab, under Shielding, from the Shield drop-down list, select +one of the following: +• To add an outer cable shield consisting of a predefined shield, select a cable shield. +• To add an outer cable shield consisting of a shield, which is not yet defined in the model, click +the + icon to define a new cable shield. +7. Under Insulation layer (coating), specify the following: +• To add a coating, select the Apply coating check box. +1. From the Medium drop-down list, specify the coating medium. +2. +In the Thickness field, specify the coating thickness. +• To remove the coating, clear the Apply coating check box. +8. On the Advanced tab, under Twist, from the Turn direction drop-down list select one of the +following: +• To define a bundle with no twist, select No twist. +• To define a bundle turning right, leading away from you, select Right handed. +• To define a bundle turning left, leading away from you, select Left handed. +9. On the Advanced tab, under Twist, in the Pitch length field, enter the axial length required to +complete one revolution of a cable in the bundle around the diameter of the bundle. +10. In the Label field, add a unique label for the cable bundle. +11. Click Create to create the cable bundle and to close the dialog. +Related concepts +Insulation and Shielding For Cable Bundles +Rearrange Cable Bundle Using CADFEKO_BATCH. +Related tasks +Accessing the Cables Tab on the Ribbon +Insulation and Shielding For Cable Bundles +When defining a cable bundle, you can specify the outer insulation and shielding for the cables +contained in the bundle. +The following shield types are supported for the cable bundle: +1. +Insulated, embedded in background medium (sheath/jacket) +2. Not shielded, embedded in a dielectric +3. Not shielded, embedded in background medium +4. Shielded, dielectric filled +Insulated, Embedded in Background Medium (Sheath / Jacket) +Add an outer sheath / jacket to cables contained in a bundle. The cables are embedded in the +background medium, which is by default free space. +Note: A sheath or jacket is a close-fitting cover that protects the internal conductors of +the cable against moisture, chemicals, and mechanical damage and insulates the cable +electrically. +The sheath/jacket is specified using Insulation medium and Sheath thickness. +Sheath / Jacket +Embedded in background medium +(free space) +Cables contained in bundle +Figure 173: A 3D representation of a cable bundle (two single conductors, each with a coating) embedded in the +background medium (in red), covered by a sheath / jacket (in black). +Not Shielded, Embedded in a Dielectric +Embed a cable bundle inside a dielectric. The bundle is unshielded (no shield). The dielectric is specified +using Insulation medium. +Embedded in a dielectric +Cables contained in bundle +Figure 174: A 3D representation of a cable bundle (two single conductors, each with a coating) embedded in a +dielectric (in blue). Note that the outer cable bundle does not contain a shield. +Not Shielded, Embedded in Background Medium +Embed a cable bundle inside the background medium. By default the background medium is free space. +Embedded in background medium +(free space) +Cables contained in bundle +Figure 175: A 3D representation of a cable bundle routed in the background medium (by default, free space). +Shielded, Dielectric Filled +Add an outer shield to cables contained in a bundle. The inner cable bundle is embedded in a dielectric. +You can also choose to add an insulation layer / coating over the shield. +Insulation layer/ +Coating (Optional) +Shield +Embedded in a dielectric +Cables contained in bundle +Figure 176: A 3D representation of a cable bundle (two single conductors, each with a coating) embedded in a +dielectric (in blue), covered by a shield (in grey) and coated with an insulation medium (in yellow). +Defining a Non-Conducting Element +Define a non-conducting element consisting of a fibre core. +1. On the Cables tab, in the Definitions group, click the + Non-Conducting Element icon. +Figure 177: The Create Non-Conducting Element dialog. +2. Under Fibre parameters, from the Medium drop-down list, select one of the following: +• To specify the medium consisting of a predefined dielectric, select the dielectric. +• To specify the medium consisting of a dielectric, which is not yet defined in the model, click +the + icon to define a dielectric or add a dielectric from the media library. +3. Under Fibre parameters, in the Radius field, enter a value for the cable radius. +4. +In the Label field, add a unique label for the non-conducting element. +5. Click Create to create the coaxial cable and to close the dialog. +Related tasks +Accessing the Cables Tab on the Ribbon +Advanced Settings for Cable Types +Advanced settings are used to specify the accuracy of the cable per-unit-length parameters. +On the Cables tab, in the Definitions group, click any of the cable types. +Figure 178: An example of a cable type dialog - the Create Single Conductor dialog, Advanced tab. +For each cable type definition, the Cable per-unit-length parameters accuracy can be increased +from Normal (default) to High or Very high to allow for increasingly finer meshing of the cable cross +sections. +2.21.5 Cable Shields +A cable shield is a conductive layer that encloses a cable to reduce electromagnetic interference (EMI) +and crosstalk to other cables. +CADFEKO enables you to specify several types of shielding: +• solid shields with a specified material and thickness +◦ Schelkunoff +• braided shields +◦ Kley +◦ Vance +◦ Tyni +◦ Demoulin +• defining the frequency-dependent shield properties +◦ Transfer impedance (Zt) and surface impedance (Zs) +◦ Transfer admittance (Yt) +◦ Transfer capacitance +Cable Shield Layer Combinations +When creating a cable shield, you need to specify the impedance and admittance for each layer. The +following combinations are supported when defining the impedance and admittance for a shield layer. +Table 12: Supported shield layer combinations when specifying the impedance and admittance for a shield layer. +Impedance Definition (Zt + Zs) +Admittance Definition (Yt) +Solid (Schelkunoff) +Not applicable +Braided (Kley) +Braided (Tyni) +Braided (Vance) +Braided (Demoulin) +Define properties +Same as impedance definition +Transfer capacitance +Define properties +Same as impedance definition +Transfer capacitance +Define properties +Same as impedance definition +Transfer capacitance +Define properties +Same as impedance definition +Transfer capacitance +Define properties +Same as impedance definition +Define properties +Transfer capacitance +For example, when selecting a Braided (Kley) impedance definition it can be combined with a braided +(Kley), transfer capacitance or the frequency-dependent (define properties) admittance definition. +Related tasks +Creating a Solid Cable Shield Layer (Schelkunoff) +Creating a Braided Cable Shield Layer (Kley) +Creating a Braided Cable Shield Layer (Vance, Tyni or Demoulin) +Creating a Cable Shield Layer (Shield Properties) +Creating a Cable Shield Layer (Transfer Capacitance) +Creating a Solid Cable Shield Layer (Schelkunoff) +Create a single-layered solid shield with a specified material and thickness. +1. On the Cables tab, in the Definitions group, click the + Cable Shield icon. +2. Under Shield layer(s), click Single to create a single-layered shield. +3. On the Inner layer tab, on the Impedance definition tab, from the Definition method drop- +down list, select Solid (Schelkunoff). +Figure 179: The Create Cable Shield dialog. +4. From the Metal drop-down list, select one of the following: +• To create a PEC shield, select Perfect electric conductor. +• To create a shield consisting of a predefined metal, select the metal. +• To create a shield consisting of a metal, which is not yet defined in the model, click the +icon to define a metal or add a metal from the media library. +5. On the Inner layer tab, in the Layer thickness field, specify the inner layer thickness. +6. +In the Label field, add a unique label for the cable shield. +7. Click Create to create the cable shield and to close the dialog. +Related tasks +Accessing the Cables Tab on the Ribbon +Weave Definitions for a Braided Cable Shield +CADFEKO supports two methods to specify the size of the apertures for a braided shield layer. +The optical coverage for a braid indicates how visible the apertures are, where 0% is completely open +(no shielding) and 100% is a completely filled (approximating a solid shield). The optical coverage and +weave angle are coupled by the fill factor (F) for a braid, which is a quantity between 0 and 1. +Altair Feko 2022.3 +2 CADFEKO +Figure 180: Illustration of the braid parameters for a braided shield layer. +The fill factor (F) is calculated from the optical coverage using the following equation: +where the optical coverage is between 0% and 100%. +The coupled equation for the fill factor from the braid parameters is: +p.271 +(7) +(8) +where D is the mean braid diameter (outer radius of the shield minus half the thickness of the braided +layer). +Optical Coverage +For the optical coverage definition, a minimum optical coverage is specified. The minimum optical +coverage relates to the largest aperture size or minimum shielding that CADFEKO tries to achieve when +optimising the braid for maximum coverage, by varying the weave angle. +Weave Angle +A nominal weave angle and deviation is specified for the weave angle definition. The optical coverage +is calculated for the range of weave angles to represent the size of the apertures (using the braid +parameters defined for a braided layer). +Note: As the weave angle changes, the shield diameter also changes depending on the +weave angle and other braid parameters. +Related concepts +Advanced Settings for a Braided Cable Shield Layer +Related tasks +Creating a Braided Cable Shield Layer (Kley) +Creating a Braided Cable Shield Layer (Vance, Tyni or Demoulin) +Creating a Braided Cable Shield Layer (Kley) +Create a single layer, braided (Kley) cable shield. The relevant braid parameters, weave metal and +braid-fixing materials (optional) are specified and the Solver determines the frequency-dependent +impedance (Zs + Zt) and admittance (Yt) matrix using the Kley formulation. +The Kley formulation models the coupling mechanism accurately due to the field penetration through +the shield apertures. +1. On the Cables tab, in the Definitions group, click the + Cable Shield icon. +2. Under Shield layer(s), click Single to create a single-layered shield. +3. On the Inner layer tab, on the Impedance definition tab, from the Definition method drop- +down list, select Braided (Kley). +Figure 181: The Create Cable Shield dialog. +4. Under Weave, specify the following: +a) From the Definition method drop-down list, select Weave angle to create a braided layer +using the weave angle definition: +• In the Weave angle (degrees) field, enter a value in degrees for the nominal weave +angle. +• In the Deviation (+/-) (degrees) field, enter a value for the deviation of the weave +angle from the nominal weave angle in degrees. +b) From the Definition method drop-down list, select Optical coverage to create a braided +layer using the optical coverage definition: +• In the Minimum optical coverage (%) field, enter a percentage for the minimum +optical coverage for the braided layer. +c) In the Number of carriers (m) field, specify the number of carriers in the braided layer. +5. Under Filaments, specify the following: +a) In the Number of filaments (n) field, enter a value for the number of filaments in a single +carrier. +b) In the Diameter (d) field, enter a value for the filament diameter. +c) In the Filament metal drop-down list, select one of the following: +• To create a filament consisting of PEC, select Perfect electric conductor. +• To create a filament consisting of a predefined metal, select the metal. +• To create a filament consisting of a metal, which is not yet defined in the model, select +the + icon to define a metal or add a metal from the media library. +Note: The Thickness of a Kley shield layer is 2.5 times the filament diameter (d). +6. On the Inner layer tab, on the Admittance definition tab, from the Definition method drop- +down list, select Same as impedance definition to use the Kley formulation for the admittance +matrix. +Figure 182: The Create Cable Shield dialog. +7. Under Braid-fixing materials, select one of the following: +• To apply an inside and outside braid-fixing material, select the Apply braid-fixing material +check box. +• To add an inside and outside braid-fixing material consisting of a predefined dielectric, +select the dielectric. +• To add an inside and outside braid-fixing material consisting of a dielectric, which is not +yet defined in the model, click the + icon to define a dielectric or add a dielectric from +the media library. +• To remove the braid-fixing material, clear the Apply braid-fixing material check box. +Insulation layer / Coating +Braid +Embedded in dielectric or +background medium +Cables contained in bundle +Insulation layer / Coating +Outside braid-fixing material +Braid +Inside braid-fixing material +Embedded in dielectric or +background medium +Cables contained in bundle +Figure 183: A 3D representation of a cable containing a braid (on the left) and a cross-section of the cable +showing the inside braid-fixing material and the outside braid-fixing material (on the right). +8. +In the Label field, add a unique label for the cable shield. +9. Click Create to create the cable shield and close the dialog. +Related concepts +Weave Definitions for a Braided Cable Shield +Related tasks +Accessing the Cables Tab on the Ribbon +Creating a Braided Cable Shield Layer (Vance, Tyni or Demoulin) +Create a single layer, braided (Vance, Tyni, Demoulin) cable shield. For a braided shield layer, the +relevant braid parameters and weave metal are specified and the Solver determines the frequency- +dependent impedance (Zs + Zt) and admittance (Yt) matrix using the Vance, Tyni or Demoulin +formulation. +The Vance, Tyni and Demoulin formulation models the coupling mechanism accurately due to the field +penetration through the shield apertures. +1. On the Cables tab, in the Definitions group, click the + Cable Shield icon. +2. Under Shield layer(s), click Single to create a single-layered shield. +3. On the Inner layer tab, on the Impedance definition tab, from the Definition method drop- +down list, select one of the following: +• Braided (Vance) +• Braided (Tyni) +• Braided (Demoulin) +Figure 184: The Create Cable Shield dialog. +4. Under Weave, specify the following: +a) From the Definition method drop-down list, select Weave angle to create a braided layer +using the weave angle definition: +• In the Weave angle (degrees) field, enter a value in degrees for the nominal weave +angle. +• In the Deviation (+/-) (degrees) field, enter a value for the deviation of the weave +angle from the nominal weave angle in degrees. +b) From the Definition method drop-down list, select Optical coverage to create a braided +layer using the optical coverage definition: +• In the Minimum optical coverage (%) field, enter a percentage for the minimum +optical coverage for the braided layer. +c) In the Number of carriers (m) field, specify the number of carriers in the braided layer. +5. Under Filaments, specify the following: +a) In the Number of filaments (n) field, enter a value for the number of filaments in a single +carrier. +b) In the Diameter (d) field, enter a value for the filament diameter. +c) In the Filament metal drop-down list, select one of the following: +• To create a filament consisting of PEC, select Perfect electric conductor. +• To create a filament consisting of a predefined metal, select the metal. +• To create a filament consisting of a metal, which is not yet defined in the model, select +the + icon to define a metal or add a metal from the media library. +Note: The Thickness of a Vance, Tyni and Demoulin shield layer is two times the filament +diameter (d). +6. On the Inner layer tab, on the Admittance definition tab, select Same as impedance +definition, from the Definition method drop-down list to use the Vance, Tynior Demoulin +formulation for the admittance matrix. +Figure 185: The Create Cable Shield dialog. +Note: +The weave and filaments values are used from the impedance definition to calculate +the admittance matrix. +7. +In the Label field, add a unique label for the cable shield. +8. Click Create to create the cable shield and close the dialog. +Related concepts +Weave Definitions for a Braided Cable Shield +Related tasks +Accessing the Cables Tab on the Ribbon +Advanced Settings for a Braided Cable Shield Layer +Use advanced settings to specify how the weave angle and optical coverage changes when a braided +shield is applied to a cable bundle or coaxial cable. +On the Cables tab, in the Definitions group, click the + Cable Shield icon. The advanced settings +are available on the Advanced tab. +Optimisation Method: Maximise the Optical Coverage +The total shield radius is the outermost radius of the shield and is used as a common reference when +creating double shields. The total shield radius is used to look up the weave angle and optical coverage +for a specific shield size in the stretching table. +Figure 186: Illustration of a single layered shield. +The maximum and minimum stretching radius of the shield is indicated by the top and bottom entry in +the Total shield radius column (outer radius of the shield). +Figure 187: The Maximise optical coverage method for the stretching of a braided shield layer. +Altair Feko 2022.3 +2 CADFEKO +Note: +p.278 +The weave angle and optical coverage range displayed in the stretching table is dependent +on the following weave definition limits. +For the optical coverage definition method: +• The optimal weave angle is in the range of 20° to 70°. +• The optical coverage is limited from the minimum optical coverage defined to 100%. +For the weave angle definition method: +• The optimal weave angle is between the deviation (+/-) limits from the nominal weave +angle defined for the inner layer. +• The optical coverage is limited to a range of 60% to 100%. +Optimisation Method: Specify Manually +Specify the Total shield radius and Inner layer Weave angle manually to define the stretching of +the shield. +Figure 188: The Specify manually method for the stretching of a braided shield layer. +Altair Feko 2022.3 +2 CADFEKO +Note: +p.279 +• Total shield radius must be between the minimum radius (first row, first cell) and +maximum radius (last row, first cell). +• The Inner layer Weave angle values must be between the minimum angle (first row, +second cell) and maximum angle (last row, second cell). +• The Inner layer Optical coverage is calculated automatically from the Inner layer +Weave angle and Total shield radius. +• Table rows can only be added between the first row and last row. +Related concepts +Weave Definitions for a Braided Cable Shield +Creating a Cable Shield Layer (Shield Properties) +Create a cable shield by defining the frequency-dependent surface impedance, transfer impedance and +transfer admittance matrix. +1. On the Cables tab, in the Definitions group, click the + Cable Shield icon. +2. Under Shield layer(s), click Single to create a single-layered shield. +3. On the Inner layer tab, on the Impedance definition tab, in the Definition method drop- +down list, select Define properties. +Figure 189: The Create Cable Shield dialog. +4. Under Transfer impedance, from the Definition method drop-down list, select one of the +following: +• To define the properties manually, select Specify manually. +• In the Frequency (Hz) column, specify the frequency at which the transfer impedance +and admittance are specified. +• In the Zt Magnitude (Ohm/m) column, specify the magnitude of the transfer +impedance. +• In the Zt phase (degrees) column, specify the phase of the transfer impedance in +degrees. +• To define the properties from an .xml file, select Load from file. +• In the Filename field, browse to the file location. +5. Under Transfer impedance, in the Interpolation method drop-down list, select one of the +following: +• To use the default interpolation method between the data points, select Default. +• To use a linear interpolation method between the data points, select Linear. +• To use a cubic spline interpolation method between the data points, select Cubic spline. +• To use a rational (Thiele) interpolation method between the data points, select Rational. +• To use a constant interpolation method between the data points, select Constant. +6. Under Surface impedance, from the Definition method drop-down list, select one of the +following: +• To define the surface impedance (Zs) equal to the transfer impedance (Zt), select Low +frequency braid-approximation (Zs = Zt). +• To define the properties manually, select Specify manually. +• In the Frequency (Hz) column, specify the frequencies at which the surface impedance +are specified. +• In the Zs Magnitude (Ohm/m) column, specify the magnitude of the surface +impedance for each frequency. +• In the Zs Phase (degrees) column, specify the phase of the surface impedance for each +frequency in degrees. +• To define the properties from an .xml file, select Load from file. +• In the Filename field, browse to the file location. +• To define the properties from a metallic material, select Solid (metallic material) +• In the Shield metal drop-down list, select one of the following: +◦ To create a PEC shield, select Perfect electric conductor. +◦ To create a shield consisting of a predefined metal, select the metal. +◦ To create a shield consisting of a metal, which is not yet defined in the model, click +the + icon to define a metal or add a metal from the media library. +7. On the Inner layer tab, on the Admittance definition tab, in the Definition method drop- +down list, select Define properties. +Figure 190: The Create Cable Shield dialog. +8. Under Transfer admittance, from the Definition method drop-down list, select one of the +following: +• To define the properties manually, select Specify manually. +• In the Frequency (Hz) column, specify the frequencies at which the transfer impedance +and admittance are specified. +• In the Yt Magnitude (S/m) column, specify the magnitude of the transfer admittance +for each frequency. +• In the Yt Phase (degrees) column, specify the phase of the transfer admittance for +each frequency in degrees. +• To define the properties from an .xml file, select Load from file. +• In the Filename field, browse to the file location. +9. Under Transfer impedance, from the Interpolation method drop-down list, select one of the +following: +• To use the default interpolation method between the data points, select Default. +• To use a linear interpolation method between the data points, select Linear. +• To use a cubic spline interpolation method between the data points, select Cubic spline. +• To use a rational (Thiele) interpolation method between the data points, select Rational. +• To use a constant interpolation method between the data points, select Constant. +10. On the Inner layer tab, from the Thickness field, enter a value for the thickness of the shield. +11. In the Label field, add a unique label for the cable shield. +12. Click Create to create the cable shield and to close the dialog. +Related tasks +Accessing the Cables Tab on the Ribbon +Load Shield Properties from a .XML File +Defining .xml files for the different impedance and admittance combinations for the define properties +shield layer. +Note: The data containing phase is in degrees. +Example: Cable Shield Data (Version 1) - No Surface Impedance +An XML example containing fictitious measured data to show the file format for importing measured +cable data when no surface impedance is specified. + + + + + + + + + +Example: Cable Shield Data (Version 2) - Same Frequency Range +An XML example containing fictitious measured data to show the file format for importing measured +cable data with surface impedance measured at the same frequencies as the transfer impedance and +admittance. + + + + + + + + + +Example: Cable Shield Data (Version 2) - Different Frequency Ranges +An XML example with different frequencies for surface impedance. The transfer impedance and +admittance can also be specified separately using a divider line if required. + + + + + + + + + + +Creating a Cable Shield Layer (Transfer Capacitance) +The transfer capacitance shield layer is used with a braided and frequency-dependent impedance +definition to represent the transfer admittance matrix of the shield layer. +Specify the transfer admittance (Yt) for a shield layer in Farad per meter. +1. On the Cables tab, in the Definitions group, click the + Cable Shield icon. +2. Under Shield layer(s), click Single to create a single-layered shield. +3. On the Inner layer tab, on the Admittance definition tab, from the Definition method drop- +down list, select Transfer capacitance. +Figure 191: The Create Cable Shield dialog. +4. +In the Capacitance (F/m) field, enter a value for the transfer capacitance in Farad per meter. +Related concepts +Cable Shield Layer Combinations +Creating a Double Layered Cable Shield +A double cable shield consists of two shield layers. CADFEKO supports any combination of the shield +types, solid, braided and frequency-dependent for the inner and outer layer of the shield. +When creating a double cable shield, you need to specify the shield layer impedance and admittance +for the inner layer and outer layer of the shield. A gap size also needs to be specified between the inner +and outer layer of the double shield. +Figure 192: Illustration of double cable shield. +Note: +The total shield radius is the outer radius of the shield. The radius is used as a common +reference point between the inner and outer layer when stretching the shield. +The stretching range is applicable when a braided (Kley, Vance, Tyni and Demoulin) layer +definition is used on the inner layer or outer layer. +1. On the Cables tab, in the Definitions group, click the + Cable Shield icon. +2. Under Shield layer(s), click Double to create a double layered shield. +Figure 193: The Create Cable Shield dialog - Shield layer(s) +3. Under Shield layer(s), in the Gap between layers field, enter a value for the gap between +layers. The gap should be greater than 0. +4. On the Inner layer tab, create a solid, braided or frequency dependent shield layer. +5. On the Outer layer tab, create a solid, braided or frequency dependent shield layer. +6. On the Advanced tab, under Stretching of the shield, for the Optimisation method drop- +down list, select Maximise optical coverage, to automatically calculate the optimal weave angle +and optical coverage for maximum shielding for the braided inner or braided outer layer. +The minimum and maximum radius of the double shield is indicated by the top and bottom entry +in the Total shield radius column. +Figure 194: The Create Cable Shield dialog, setting the optimisation method for the stretching of a braided +shield layer. +Note: For a double braided shield, the stretching of the shield is limited to the +stretching capability of both braided layers. The stretching range (Total shield radius +range) could be smaller for a double braided shield than for a single braided shield, +depending on the braid parameters selected for each shield. +7. On the Advanced tab, under Stretching of the shield, from the Optimisation method drop- +down list, select Specify manually to manually define values in the stretching table: +• In the Total shield radius field, edit an existing radius. +• In the Inner layer or Outer layer Weave angle column, enter a value for the weave angle +in degrees. +Figure 195: The Create Cable Shield dialog, setting the optimisation method for the stretching of a braided +shield layer. +Note: +• Total shield radius must be between the minimum radius (first row, first cell) +and maximum radius (last row, first cell). +• The values in the Inner layer Optical coverage and Outer layer Optical +coverage columns, are calculated automatically from the Total shield radius, +Inner layer Weave angle and Outer layer Weave angle. +• The Inner layer Weave angle or Outer layer Weave angle values must be +between the minimum angle (first row, third cell) and maximum angle (last row, +fifth cell). +8. +In the Label field, add a unique label for the double cable shield. +9. Click Create to create the double cable shield and to close the dialog. +Related concepts +Cable Shield Layer Combinations +2.21.6 Defining a Cable Path +Create a cable path (route) along which cables are installed and specified as a series of straight lines. +Note: A cable path may not consist of overlapping sections. +Altair Feko 2022.3 +2 CADFEKO +p.288 +Figure 196: To create this cable path, five separate cable paths need to be defined namely: AB, BC, CD, EC and FB. +1. On the Cables tab, in the Definitions group, click the + Cable Path icon. +2. Define the cable path using one of the following methods: +• To specify the corner points, use point entry or add the U, V or N values directly for each +point. +• To import the points from a ASCII text file, click the Import points button. +1. Under Source file, click ASCII text file. +2. Under Source file, in the Filename field, browse to the file. +3. Under Delimiter, click the relevant delimiter for your ASCII file. +• To import the points from a NASTRAN file, click the Import points button. +1. Under Source file, in the Filename field, browse to the file. +2. Under Settings, in the Scale factor to metres field, modify the value to scale the +cable path. +3. Under Settings, in the NASTRAN segment ID field, enter the id of the segment to +import. +Note: Points imported from a NASTRAN file are assumed to be in metres. +3. View the cable path in the 3D view. +a) Select the Construct tab in the model tree. +Cable paths are displayed as dotted-blue lines in the 3D view. +Figure 197: Cable paths are visible in the 3D view when the Construct tab is selected. The cable paths are +indicated by dotted-blue lines. +4. +In the Label field, add a unique label for the cable path. +5. Click the Create button to create the cable path and to close the dialog. +Related concepts +Routing a Cable Path at an Offset from the Geometry +Related tasks +Accessing the Cables Tab on the Ribbon +Advanced Settings for Cable Paths +Use advanced settings to specify the sampling point density, mesh refinement close to cable terminals +and the cable cross section orientation along the cable path. +On the Cables tab, in the Definitions group, click the + Cable Path icon. The advanced settings are +available on the Advanced tab. +Figure 198: The Create Cable Path dialog (Advanced tab). +Sampling Point Density +Each cable path is subdivided into segments to compute the induced currents and voltages. At the +centroid of each segment, the electric field strength and magnetic field strength are evaluated. You can +specify the segment length to influence the accuracy of the computed results. +Automatic determination +This option allows CADFEKO to determine the segment lengths. +Specify maximum separation distance +This option allows you to specify the segment lengths. +Mesh Size +Refine mesh close to cable terminals +This option enables automatic mesh refinement near cable terminals. +Cable Reference Direction +Select the Cable reference direction check box to manually orientate the cable cross section along a +cable path. Enter the following fields to change the orientation. +Altair Feko 2022.3 +2 CADFEKO +U, V and N +p.290 +Specify the U coordinate, V coordinate and N coordinate at the start of the cable path for the +cable reference direction. +Twist angle +Enter the angle at the cable path end to twist the cable cross section along the path (in degrees). +Note: +The Cable reference direction may not be parallel to the first cable path segment. +Export Cable Parameters +Export cable parameters to *.out file +This option exports the cable parameters such as inductance/capacitance matrices and transfer +impedance/admittance to the .out file. +Related concepts +Example: Cable Reference Direction - Connected to an Installation +Example: Cable Reference Direction - Disconnected from an Installation +Example: Cable Reference Direction - No Installation +Related tasks +Accessing the Cables Tab on the Ribbon +Example: Cable Reference Direction - Connected to an Installation +Consider an example where a cable path is defined within a distance of + from a ground plane. +The cable cross section orientation is indicated by: +• dotted green line: vector +• blue line: vector +• solid dark green line: cable reference direction +Note: CADFEKO tries to orientate the vector at the start of the cable path to align with +the cable reference direction automatically using the constraint that the and vector must +be perpendicular to the cable path. +The cable reference direction is defined normal to the installation or ground (in the “up” direction) and +is not pointing towards it. In the cable schematic the cable is connected to the installation + and acts +as a return path for the signal. No twist angle is defined along the cable path. +Figure 199: Specify the cable reference direction above a ground plane. +Note: This option can be used with only one signal in the cable harness as the installation +acts as the return path. +Example: Cable Reference Direction - Disconnected from an Installation +Consider an example where a cable is disconnected from the installation / geometry. +The cable cross section orientation is indicated by: +• dotted green line: vector +• dotted blue line: vector +• solid dark blue line: cable reference direction +Note: CADFEKO tries to orientate the vector at the start of the cable path to align with +the cable reference direction automatically using the constraint that the and vector must +be perpendicular to the cable path. +Figure 200: Cable reference direction with an installation present. +When using the cable reference direction where the cable is disconnected from the geometry, the +following is required when connecting circuit elements in the schematic view: +• No bonding impedances are allowed in the harness, for example, no termination / interconnect +circuit connections to the installation. +• All cable paths should at least have two signals in the outermost problem. +• All cable paths in the harness should have an orientation vector defined (if that path does not have +any nearby geometry / installation). +Figure 201: Cable schematic view with cable reference direction set. +Example: Cable Reference Direction - No Installation +Consider an example where a cable path is created, but with no geometry present in the model. +The Cable reference direction is defined normal to a fictitious ground (in the “up” direction). No twist +angle is defined along the cable path. +Figure 202: Specify Cable reference direction with no geometry in the model. +The cable cross section orientation is indicated by: +• dotted green line: vector +• dotted blue line: vector +• solid dark blue line: cable reference direction +Note: CADFEKO tries to orientate the vector at the start of the cable path to align with +the cable reference direction automatically using the constraint that the and vector must +be perpendicular to the cable path. +When using the cable reference direction with no installation present, the following is required in the +cable harness and schematic view: +• No bonding impedances are allowed in the harness, for example, no termination / interconnect +circuit connections to the installation. +• All paths should at least have two signals in the outermost problem to create a return path. +• All paths in the harness should have an orientation vector defined (if that path does not have any +nearby geometry / installation). +Figure 203: Cable harness and schematic view with cable reference direction set. +2.21.7 Defining Cable Connectors +Create a cable connector at the end terminal of a cable. +1. On the Cables tab, in the Create Instance group, click the + Cable Connector icon. +Figure 204: The Create Connector dialog. +Specify the position of the cable connector. +2. Under Position, select one of the following: +• To select the start or end point of a cable path, click Cable path terminal. +• To select the start or end point of a predefined cable path, from the Path terminal drop- +down list, select the cable path you want to use. +• To create a cable path, which is not yet defined in the model, click the + icon to define +a cable path. +• To specify the X, Y and Z coordinates, click 3D coordinate. +Add pins to the cable connector. Pins represent connection points between cables and cable components +(for example, capacitors and inductors). Connections to the pins are made in the cable schematic view. +3. Under Housing, add pins to by clicking the Add button. Remove a pin by clicking the Remove +button. +4. +In the Label field, add a unique label for the cable connector. +5. Click the Create button to create the cable connector and close the dialog. +Related tasks +Accessing the Cables Tab on the Ribbon +2.21.8 Defining a Cable Instance +Create a cable instance consisting of a single cable (for example, ribbon, cable bundle, coaxial cable) +with its cable connectors that is routed along a cable path. +1. On the Cables tab, in the Create Instance group, click the + Cable Instance icon. +Figure 205: The Create Cable Instance dialog. +Specify the cable type. +2. From the Cable type drop-down list, select one of the following options: +• To specify a predefined cable, select the cable you want to use. +• To specify a cable, which is not yet defined in the model, click the + icon to define a cable +path. +3. Specify the start connector and end connector for the cable. +a) Under Terminal connectors, from the Source drop-down list, select the start connector for +the cable. +b) Under Terminal connectors, from the Destination drop-down list, select the end +connector the cable. +Specify the cable path along which the cable instance is routed. +4. Under Routing options, select one of the following: +• To use a specific cable path, clear the Select shortest route check box. From the drop-down +list, select the cable path you want to use. +• To use the cable path with the shortest route between the specified start connector and end +connector, select the Select shortest route check box. +For each conductor (signal) in the cable instance, specify the pins of the cable connector to which the +conductor is connected. +Note: +• Each conductor in the cable instance is a signal. +• A signal is connected to the pins of a cable connector. +5. Under Signals and connections, select the Signal name, Source (start pin) and Destination +(end pin) of the connector (specified in Step 3) to which the signal is connected. +6. +In the Label field, add a unique label for the cable instance. +7. Click Create to create the cable instance and to close the dialog. +Related tasks +Accessing the Cables Tab on the Ribbon +2.21.9 Defining a Cable Harness +Create a cable harness consisting of a collection of cable instances routed along a cable path with a +solution method specified for the outer conductor. +1. On the Cables tab, in the Create Instance group, click the + Cable Harness icon. +Figure 206: The Modify Cable Harness dialog. +Note: An empty cable harness instance is created in the Configuration tab without +launching a dialog. +View the cable instances routed along a specific cable path. +2. Open the right-click context menu for CableHarness1. +3. On the Bundle tab, under Tube cross section, select the cable path you want to view. +View the cable instances routed along the cable path in the preview and under Tube details. +Specify the cable coupling properties for the cable harness. +4. On the Solution tab, under Cable coupling properties, select one of the following: +• To only consider the effect of external fields coupling into the cable harness, click +Irradiating. +• To only consider the effect of currents radiating from the cable harness, click Radiating. +• To consider the combined effect of external fields coupling into the cable harness and currents +radiating from the cable harness, click Radiating (taking irradiation into account). +• To consider the effect of intra coupling between cables in a harness (no external field coupling +into the harness), click Circuit crosstalk. +Note: The wideband Circuit crosstalk solution is active when: +• All cable harnesses have Circuit crosstalk cable coupling properties enabled. +• No requests (except cable probe requests) are defined or the requests for +each configuration is excluded. +• No sources (except cable sources) are defined in the configuration. +Figure 207: The Modify Cable Harness dialog (Solution tab). +Specify the solution method for the harness (outer cable). +5. On the Solution tab, under Solution method for outer cable problem (shielded/external +ground), select one of the following: +• To solve the harness with the MTL, click multiconductor transmission line (MTL). +• To solve a harness containing only shielded cables with the MoM, click Method of moments +(MoM), only for shielded cables. +6. +In the Label field, add a unique label for the cable harness. +7. Click OK to apply the changes and to close the dialog. +Related tasks +Accessing the Cables Tab on the Ribbon +Viewing a Cable Harness in the Cable Schematic View +Excluding a Configuration from the Model +Solution Methods for Cables +Solve a cable harness with either the Multiconductor transmission line (MTL) method or the +Method of moments (MoM), only for shielded cables method. +Multiconductor transmission line (MTL) +• Solve the model with the multiconductor transmission line theory, hybridised with the MoM or +MLFMM. +• +The cable path should ideally be within + of the conducting surface, although distances of up to +are allowed. Alternatively, a cable reference direction can be set on the cable path. +• Connections between the cable and MoM geometry are not allowed. +Method of moments (MoM), only for shielded cables +• Solve the model with the combined MoM/MTL solver. +• Any arbitrary cable path is allowed - the height restriction of the MTL does not apply. +• Cables must be shielded. +• Connections between the cable and MoM geometry are allowed. +Related tasks +Accessing the Cables Tab on the Ribbon +2.21.10 Searching for a Cable Instance in the Model +Use the “Find cable” tool to locate a cable instance contained in a complex cable harness in the 3D view. +1. On the Cables tab, in the Tools group, click the + Find Cable icon. +Figure 208: The Find Cable dialog. +2. Under Filter, from the Cable Harness drop-down list, select the cable harness you want to find. +3. +4. +5. +6. +[Optional] Under Filter, from the Connector drop-down list, narrow down the search by +specifying a connector in the cable harness. +[Optional] Under Filter, from the Path drop-down list, narrow down the search by specifying a +connector in the cable harness. +[Optional] Under Filter, from the Cross section drop-down list, narrow down the search by +specifying a defined cable cross section in the cable harness. +[Optional] Under Filter, from the Cable instance drop-down list, narrow down the search by +specifying a cable instance in the cable harness. +Specify the route along which to search for a cable instance. +7. Under Routes, select one of the following options: +• To specify a cable instance in a specific route, clear the All routes check box. +• To view all routes that satisfy the above criteria, select the All routes check box. +Cable instances which satisfy the search criteria are listed in the table. +8. Click the cable instance in the table to highlight the cable instance in the 3D view and model tree. +Related tasks +Accessing the Cables Tab on the Ribbon +2.21.11 Combining Cable Instances +Convert multiple single conductor cables into a new type of cable after a harness description list is +imported. +Note: +• The target cable cross-section is the new cross section of the cable instance which +replaces or combines the selected cable instances. +• The target cable cross-section must be defined before it can be used to replace the +single conductor. +• The cable instances to be combined must share the same cable path. +1. +In the model tree, multi-select the cable instances to be combined. +2. On the Cables tab, in the Tools group, click the + Combine Cables icon. +Figure 209: The Combine Cables dialog. +Specify the target cross-section (the cable cross section which replaces the selected cable instances). +3. From the Target cross section drop-down list, select the cable cross-section to replace the +selected cable types. +Note: The total number of signals for the cables to be combined must equal the total +number of signals for the new target cable. +For example, a single conductor (one signal) and twisted pair (two signals) may be combined to +create a bundle cable with three signals. +In the Old cable column, the selected cable instances to be combined are displayed. +In the Old signal column, the signals of the selected cable instances are displayed. +4. Click Combine to combine the selected cable instances and to close the dialog. +The selected cable instances in the model tree are replaced with the new target cable instance. +Related tasks +Accessing the Cables Tab on the Ribbon +2.21.12 Rearranging Cables in a Cable Harness +Randomly place all tubes in a cable harness using the “Rearrange cross sections” tool. +1. +In the model tree, select the cable harness for which you want to rearrange the cable instances. +2. On the Cables tab, in the Tools group, click the + Rearrange Cross Section icon. +In the model tree, double-click the cable harness to view the rearranged cross-section. +Note: To rearrange the cables inside the cable bundle, from the Modify bundle +dialog, click Rearrange. +Figure 210: The cross-section of the cable harness +Figure 211: The cross-section of the cable harness +before the rearrange. +after the rearrange. +Related tasks +Accessing the Cables Tab on the Ribbon +2.21.13 Cable Schematic View +The cable schematic view allows you to add cable ports, complex loads, resistors, capacitors, inductors, +external SPICE circuits, general networks (defined using N-port Touchstone files) and probes to a +specific cable harness as well as connecting cables to one another. +Viewing a Cable Harness in the Cable Schematic View +Open the cable schematic view for a specific cable harness to add circuit elements, probes or general +networks to the connector pins or connect cables to one another. +1. On the Cables tab, in the View group, click the + Schematic icon. From the drop-down list, +select the relevant cable harness. +The Schematic contextual tab set containing the Cable schematic contextual tab is displayed on +the ribbon. +A new tab is opened in the 3D view that contains the three-dimensional cable harness projected onto a +two-dimensional plane. The tab label indicates the specific cable harness that is viewed. +2. Click on the tab to view the cable harness in the cable schematic view. +Figure 212: The cable schematic where the 3D cable harness is projected onto a 2D plane. +Note: A cable instance is displayed as a grey line (indicating the cable path) between +its two connectors. A cross-section of the cable instances running along this cable path +is also displayed on the cable path. +Connecting Circuit Elements and Pins in the Schematic View +Connect circuit elements to the cable connector pins in the cable schematic view. +1. On the Schematic contextual tabs set, on the Cable schematic tab, in the Mode group, click the + Wire Mode icon. +A “ + ” at the cursor position indicates that the wire mode is enabled. +2. Click and drag to create a wire connection. +3. Release the mouse button at the position where the end of the wire connection is required. +Note: Cable connectors and circuit elements have connection points indicated by a +dot. +• A white dot indicates no connection between pins and/or circuit elements. +• A black dot indicates a connection between pins and/or circuit elements. +Figure 213: The white dot (to the right of the +Figure 214: The black dot (to the right of the +connector) indicates that no connection is made to +connector) indicates that a connection is made to the +the connector pin. +connector pin. +Cable Schematic Elements +View the circuit elements that can be added to the cable schematic view. +Icon Name +Description +Resistor +Capacitor +Add a resistor to the cable schematic view. +Add a capacitor to the cable schematic view. +Inductor +Add an inductor to the cable schematic view. +Complex load +Add a complex load to the cable schematic view. +SPICE circuit +Import a SPICE circuit from a file to define the circuit. +Cable general +network +Import an N-port Touchstone from file to define a general network. +VCVS +Add a voltage controlled voltage source (VCVS) to the cable schematic view. +Transformer +Add a transformer to the cable schematic view. +Ground +Add a ground to the cable schematic view. +Cable port +Add a cable port to the cable schematic view. Voltage sources and loads can +be applied to cable ports. +Voltage probe +Define a voltage probe to measure the voltage between two points and add +to the cable schematic view. +Altair Feko 2022.3 +2 CADFEKO +Icon Name +Description +p.305 +Current probe +Define a current probe to measure the current at a point and add to the +cable schematic view. +Cable Schematic Display Options +View the display options for the cable schematic view. +Icon Name +Description +Rotate +Rotate the selected item. +Cross sections +Show / Hide the cable-cross section display. +Connector +spacing +Set the spacing factor between connectors on the cable schematic view. +Projection +Projection on the XY plane. +Projection +Projection on the XZ plane. +Projection +Projection on the YZ plane. +2.22 Solution Frequency +For a frequency domain result, the electromagnetic fields and currents are calculated at a single +frequency or frequency range. When the finite difference time domain (FDTD) solver is used, the +frequency must be specified to convert the native time domain results to the frequency domain. +2.22.1 Frequency Options +The supported frequency options are single frequency, continuous range, linearly spaced discrete points, +logarithmically spaced discrete points and list of discrete points. Select the frequency option that is best +suited to the model and the specified requests. +Note: Frequencies can be specified globally or per configuration. +On the Source/Load tab, in the Settings group, click the + Frequency icon. +Figure 215: The Solution frequency dialog (Frequency tab). +Single frequency +The requested results are calculated at a single frequency. +Continuous (interpolated) range +The requested results are calculated using adaptive sampling in the range Start frequency to +End frequency. The sampling algorithm uses finer sampling in areas where the results change +rapidly to ensure that all resonance effects are calculated accurately. +Note: Use this option with as little result requests as possible, since the requested +results are interpolated and increases the run time. +Linearly spaced discrete points +The requested results are calculated at a fixed number of linearly spaced points between the +Start frequency and the End frequency. This option is typically used when the solution is +required at exact frequencies. +Logarithmically spaced discrete points +The requested results are calculated at a fixed number of logarithmically spaced points between +the Start frequency and the End frequency. This is typically used over a wide bandwidth. +List of discrete points +The requested results are calculated at a list of discrete points. This is typically used when the +exact frequencies are known where the solution is required. +Tip: Use point entry (Ctrl+Shift+left click) to set the frequency to a defined variable in the +model tree. +Related concepts +Multiple Configurations +2.22.2 Continuous Frequency (Advanced Settings) +Choose from a number of advanced settings for a continuous (interpolated) simulation frequency to +ensure a computationally efficient solution. +On the Source/Load tab, in the Settings group, click the + Frequency icon. On the Solution +frequency dialog, click the Advanced tab. +Figure 216: The Solution frequency dialog (Advanced tab). +Maximum number of samples +This option limits the number of frequencies solved and as a result, the runtime. +Warning: If the solution is not fully converged, the results may be inaccurate. +Altair Feko 2022.3 +2 CADFEKO +Minimum frequency increment +p.308 +This option limits the minimum frequency increment when refining the frequency. It is useful if +there are small discontinuities in the results. +Convergence accuracy +• High: More samples, highly resonant structure +• Normal: Default +• Low: Fewer samples, smooth frequency response +Quantities to include for adaptive frequency sampling +This option allows you to select the quantities to include for the adaptive frequency sampling. +Quantities that are not selected, are calculated at the discrete solution frequency points. +Tip: The defaults are recommended. For example, including Currents and charges +in a model with many triangles increases the run-time due to interpolation. +2.22.3 Continuous Frequency (Export Settings) +Choose the frequency stepping and number of samples exported to a .isd or .snp file in a solution with +continuous (interpolated) frequency. +On the Source/Load tab, in the Settings group, click the + Frequency icon. On the Solution +frequency dialog, click the Export tab. +Figure 217: The Solution frequency dialog (Export tab). +Specify number of samples for exported data +This option allows you to specify the number of discrete frequency samples to be extracted from +the continuous data when exporting to a .isd file or a .snp file. +Frequency stepping +This option allows you to select either a Linear increment or a Logarithmic increment for the +extracted discrete frequency samples for export to a .isd file or .snp file. +2.22.4 FDTD Frequency Settings +A number of settings related to the time interval are available when using the FDTD solver. +On the Source/Load tab, in the Settings group, click the + Frequency icon. On the Solution +frequency dialog, click the Advanced tab. Click the FDTD tab to show the finite difference time +domainsettings. +Figure 218: The Solution frequency dialog (Advanced tab). +Automatically determine the time interval to be considered +Select this option to automatically determine the time interval[28] based on the time signals +used by configuration sources, the size of the computational domain and the material properties. +An estimate is made for the propagation time required for the time signal to pass through the +domain. +Specify the time interval in number of periods +Select this option to specify the maximum time interval and / or minimum time interval in +sinusoidal periods. A period is defined as +, where + is the average between the upper +and lower frequencies in the requested band. +Specify time interval in seconds +Select this option to specify the absolute maximum time interval and / or minimum time interval +in seconds. +Specify convergence threshold +Select the Specify convergence threshold check box to specify the convergence threshold for +the FDTD simulation. For example, to specify a threshold of -100 dB, enter a value of 1e-5. The +simulation terminates if the threshold is reached and the simulation time is larger or equal to the +minimum simulation time. +28. A time interval is the time duration for which the model is simulated. +Altair Feko 2022.3 +2 CADFEKO +2.23 Power +p.310 +The excitation of an antenna is normally specified as a complex voltage, but it may be useful to specify +the total radiated or source power instead. The result is then scaled to yield the desired source power +level. +Note: Power can be specified globally or per configuration. +Note: +• Feko uses peak magnitude for all complex values. Voltage and current sources must be +specified with peak magnitude (as opposed to root mean square values) if no power +scaling is performed. +• Power settings are specified as time-averaged values. +On the Source/Load tab, in the Settings group, click the + Power icon. +Figure 219: The Power Settings dialog. +No power scaling +Select this option to calculate the results using the specified source magnitudes. +Tip: A plane wave source has an infinite extent and therefore infinite power. If a +model contains plane wave sources, select No power scaling. +Total source power (no mismatch) +Select this option to scale the results such that the total source power (the sum of the power +delivered by all the individual sources in a model with multiple sources) is equal to the amount +specified in the Source power (Watt) field. No mismatch is taken into account. +Note: This option can be used with any source, except plane waves. +Altair Feko 2022.3 +2 CADFEKO +Incident power (transmission line model) +p.311 +Select this option to assume that all structures are fed using transmission lines with a complex +characteristic impedance Z0. The Source power field specifies the sum of the incident power +from all these transmission lines. If there is a mismatch between the transmission line impedance +and the structure input impedance at the excitation point, a fraction of the incident power will be +reflected to the source. This is the mismatch loss. +Feko always calculates the total source power for all solutions. For large models or models with many +sources, the calculation of mutual coupling (which is required for accurate source power calculations), +can be time-consuming. +Select the Decouple all sources when calculating power check box to ignore the mutual coupling +for Hertzian electric / magnetic dipoles or impressed line current elements when calculating the source +power. +This is acceptable in the following cases: +• when sources, which in terms of the wavelength, are relatively far from each other and from other +structures in the model +• when accurate power values are not required +Gain and directivity extraction are based on source power and are in general likely to be inaccurate if +the Decouple all sources when calculating power option is selected. +Related concepts +Multiple Configurations +Altair Feko 2022.3 +2 CADFEKO +2.24 Ports +p.312 +A port is a mathematical representation of where energy can enter (source) or leave a model (sink). +Use a port to add sources and discrete loads to a model. +The following types of ports are supported: +1. wire port +2. edge port +3. microstrip port +4. waveguide port +5. FEM line port +6. FEM modal port +7. cable port +Use an appropriate port for a model to obtain more accurate results. +Generally, ports are created on geometry items and such ports contain only a geometry instance. When +the geometry part (containing a port) is meshed, a mesh port instance is created automatically. If the +mesh is unlinked, the mesh instance of the port is displayed in the model tree. +Ports can be created directly on unlinked meshes, but this option should only be used for imported +meshes or in cases where the geometry is no longer available. +Note: Conventional current is defined as the current that flows through the port from the +negative side to the positive side. +View the geometry and mesh instances of the ports in the model tree (Construct tab). +Figure 220: Example of (1) a geometry part that was meshed and its geometry port instance (port icon in green), +and (2) a mesh part that has a simulation mesh with a mesh port instance (port icon in blue). +Altair Feko 2022.3 +2 CADFEKO +Note: +• The +• The + icon indicates the geometry instance of the port. + icon indicates the mesh instance of the port. +p.313 +2.24.1 Wire Ports +Wire ports can be applied to wires (geometry), mesh segments or on a vertex between segments. +Apply a wire port to a vertex when: +• a wire or mesh segment is connected to a structure and the phase difference from the end point to +the first segment centre results in a significance effect on the input impedance. +• a wire or mesh segment is connected between an infinite ground plane and a UTD plate. +Figure 221: A wire port on a segment (on the left) and a wire port on a vertex (on the right) in the 3D view. +Creating a Wire Port +Apply a wire port to wires (free edges that do not form a face boundary). +1. On the Source/Load tab, in the Ports group, click the + Wire Port icon. +Figure 222: The Create Wire Port dialog. +Specify the wire where the port is to be placed. +2. +In the Edge field, use point entry to specify the wire using one of the following workflows: +• In the 3D view, click on the relevant wire. +• In the details tree, click on the relevant wire. +3. Specify whether the port is to be placed on a segment or a vertex (after the wire is meshed). +• To add the wire port to a segment, select Segment. +• To add the wire port to a vertex between two segments, select Vertex. +Vertex ports are mainly used where wires are connected to other structures and the phase +difference from the end point to the centre of the first segment would have a significant effect +on the input impedance. +Note: Vertex ports can be set on the end of wires that are connected to infinite +ground planes and UTD plates. +4. Specify where the port is located on the wire. Under Location on wire, select one of the +following: +• To specify one of the predefined geometric points on a line, select Start, Middle or End. +• To specify an arbitrary position along the wire in terms of the position as a percentage of the +total wire length, select Other, where 0% is interpreted as the start point and 100% as the +end point. +If the wire is modified after the port was specified, the port maintains the same relative +position along the wire. For example, if the port was one third from the end of a wire and +the wire is shortened for a higher frequency, the port remains one third from the end of the +shortened wire. +Tip: Enter a named point or a “pt” expression in the % field to fix the absolute +position of the port. The port is then located at the projection of the point onto +the wire. If the wire is modified, the point will remain as close as possible to the +absolute position. +5. +6. +[Optional] If the polarity of the port is to be reversed, select the Reverse polarity check box. +In the Label field, add a unique label for the wire port. +7. Click Create to create the wire port and to close the dialog. +Creating a Wire Port (Mesh) +Apply a wire port directly on a mesh segment or vertex (imported mesh or an unlinked mesh). +1. On the Source/Load tab, in the Ports group, click the + Wire Port icon. +Figure 223: The Create Wire Mesh Port dialog. +2. Specify the mesh segment where the port is to be placed. +3. +In the Segment field, use point entry to specify the mesh segment using one of the following +workflows: +• In the 3D view, click on the relevant mesh segment. +• In the details tree, click on the relevant mesh segment. +4. Specify whether the port is to be placed on a mesh segment or a vertex. +• To add the wire port to a segment, select Segment. +• To add the wire port to a vertex between two segments, select Vertex. +5. +[Optional] If the polarity of the port is to be reversed, select the Reverse polarity check box. +6. Click Create to create the wire port and to close the dialog. +7. +In the Label field, add a unique label for the wire port. +8. Click the Create button to create the wire port and close the dialog. +Altair Feko 2022.3 +2 CADFEKO +2.24.2 Edge Ports +p.316 +Apply an edge port to an edge between two sets of faces. +Faces referenced in the port definition must belong to the same part for a valid port definition. +Note: An edge port can be applied to a single UTD face, but the faces on the other side of +the defined port must be standard MoM faces. +Figure 224: The edge port in the 3D view. The side of the positive faces is indicated with a red cylinder and the +negative faces with a blue cylinder. +Creating an Edge Port +Apply an edge port to an edge defining the boundary between two sets of faces. +1. On the Source/Load tab, in the Ports group, click the + Edge Port icon. +Figure 225: The Create Edge Port dialog. +When an infinite ground plane is present in the model, any edges that lie in the plane can be excited +with respect to that ground plane. +2. Connect a side of the port to the infinite ground: +• To connect the positive side of the port, under Positive faces, click the Connect to infinite +ground check box. +• To connect the negative side of the port, under Negative faces, click the Connect to +infinite ground check box. +Specify the positive faces of the edge port. +3. +In the Positive faces table, use point entry to specify the positive faces using one of the +following workflows: +• In the 3D view, click on the relevant face. +• In the details tree, click on the relevant face. +Specify the negative faces of the edge port. +4. +In the Negative faces table, use point entry to specify the negative faces using one of the +following workflows: +• In the 3D view, click on the relevant face. +• In the details tree, click on the relevant face. +5. Click the Create button to create the edge port and to close the dialog. +6. +[Optional] To switch a face between the lists, select one of the following workflows: +• Double-click the face entry. +• Click Move to ... faces. +7. +In the Label field, add a unique label for the edge port. +8. Click the Create button to create the edge port and to close the dialog. +Creating an Edge Port (Mesh) +Apply an edge port to an edge between two sets of mesh faces (imported mesh or an unlinked mesh). +1. On the Source/Load tab, in the Ports group, click the + Edge Port icon. +Figure 226: The Create Edge Mesh Port dialog. +When an infinite ground plane is present in the model, any edges that lie in the plane can be excited +with respect to that ground plane. +2. Connect a side of the port to the infinite ground: +• To connect the positive side of the port, under Positive faces, click the Connect to infinite +ground check box. +• To connect the negative side of the port, under Negative faces, click the Connect to +infinite ground check box. +Specify the positive faces of the mesh edge port. +3. +In the Positive faces table, use point entry to specify the positive faces using one of the +following workflows: +• In the 3D view, click on the relevant face. +• In the details tree, click on the relevant face. +Specify the negative faces of the mesh edge port. +4. +In the Negative faces table, use point entry to specify the negative faces using one of the +following workflows: +• In the 3D view, click on the relevant face. +• In the details tree, click on the relevant face. +5. Click the Create button to create the mesh edge port and to close the dialog. +6. +[Optional] To switch a face between the lists, select one of the following workflows: +• Double-click the face entry. +• Click Move to ... faces. +7. +In the Label field, add a unique label for the mesh edge port. +8. Click the Create button to create the edge port and to close the dialog. +Edge Port on a Thick Dipole +Excite a dipole made from a cylinder and add an edge port. +1. Create a cylinder. +2. Split the cylinder to create two sections. +CADFEKO automatically adds a face on the split plane to keep the two split parts as solid parts. +Figure 227: The preview of the split operation on the thick dipole. +3. Union the two sections to ensure the faces in the edge port belong to the same part. +4. Delete the face on the split plane. +When specifying an edge port, all faces bordering the edge must be specified in the edge port +definition. Delete the extra face created when the two sections were unioned. Deleting the face +results in a single region with only two faces bordering the edge. +Tip: Model the cylinder as Free Space (shell object) to avoid the face. +Figure 228: Cutplane view of the thick dipole with face in the middle to be deleted after Union. +5. Add the edge port. +Specify the outer face of the one section as the positive face. Specify the outer face of the second +section as the negative face. The result is an edge port which is not straight but closes on itself. +Figure 229: An edge port is added to the thick dipole. Note the edge closes on itself. +Using an Edge Port with the FDTD solution method +The following requirements must be met when using an edge port with the FDTD solution method: +• All meshed port faces must lie in the same plane. Port faces which do not lie in the same plane +results in conflicting potentials at a point. +• All meshed port faces must point in the same direction. +Figure 230: Examples of valid edge ports on a triangular mesh. +Figure 231: A valid edge port on a voxel mesh. Note the meshed port faces all lie in the same plane. +Figure 232: If a voxel mesh is applied to the same model as the top example and a similar edge port is specified, +it results in an invalid edge port as displayed in the section views. The black circles indicate an example of a point +with conflicting potentials. +2.24.3 Microstrip Ports +Apply a microstrip port to represent a feed line in a microstrip structure. A microstrip port is specified +on an edge or a set of edges that form a continuous, straight, horizontal (lie in a constant Z plane in the +global coordinates) edge that borders only a single face. +Note: To apply a microstrip port, the model must contain a planar dielectric substrate with +a conducting ground plane at the bottom. +Figure 233: Examples of a microstrip port connected to an edge. The positive side of the microstrip port is indicated +in red (on the left) and the negative side of the port indicated in blue (on the right). +Altair Feko 2022.3 +2 CADFEKO +Creating a Microstrip Port +Apply a microstrip port to a geometry face. +1. On the Source/Load tab, in the Ports group, click the + Microstrip Port icon. +p.322 +Figure 234: The Create Microstrip Port dialog. +2. +3. +4. +In the Port edges table, specify the edges for the microstrip port. +[Optional] If the polarity of the port is to be reversed, select the Reverse polarity check box. +In the Label field, add a unique label for the microstrip port. +5. Click Create to create the microstrip port and to close the dialog. +Creating a Microstrip Port (Mesh) +Apply a microstrip port between vertices of an imported mesh or an unlinked mesh. +1. On the Source/Load tab, in the Ports group, click the + Microstrip Port icon. +Figure 235: The Create Microstrip Mesh Port dialog. +2. +3. +4. +5. +In the Start vertex field, add the start vertex point by using point entry and clicking on the +relevant vertex in the 3D view. +In the End vertex field, add the end vertex point by using point entry and clicking on the relevant +vertex in the 3D view. +[Optional] If the polarity of the port is to be reversed, select the Reverse polarity check box. +In the Label field, add a unique label for the microstrip port. +6. Click Create to create the microstrip port and to close the dialog. +2.24.4 Waveguide Ports +A waveguide port is used to define the planes of excitation for waveguide structures. +Note: Waveguide ports can be applied to: +• a single flat face solved using SEP. +• a single flat face on the boundary of a FEM region. +Three basic waveguide cross-sections are supported: +• Rectangular +• Circular +• Coaxial +Waveguide ports are specified on a single face with the correct shape. To apply a port to a face, the +following requirements must be met: +• the face must be flat or a flat face on the boundary of a FEM region +• the face cannot contain any internal edges +• the face must form the boundary of a PEC or dielectric region +• the face cannot have any special material properties (for example, dielectric coating) +• the face cannot be solved with special solution methods (for example, UTD) +Figure 236: The waveguide port is indicated by a blue border. A waveguide port containing a waveguide source, is +indicated by a red border. +Reference Vector +The reference vector specifies the reference direction for a waveguide port. +The reference vector is indicated by a white line connecting the edge of a waveguide with the centre of +the waveguide port and shows the direction of m, where m corresponds to: +• the number of half-wavelengths across the width of the waveguide (rectangular waveguides). +• the number of radial variations (circular waveguides). +Figure 237: On the left, the reference vector is defined in the direction of the waveguide width. To the right, the +reference vector is defined in the direction of the waveguide height. +For a rectangular waveguide, defining the reference vector in one direction, the dominant mode at a +frequency might be TE10. Rotating the reference vector with 90° and solving the same problem, the +dominant mode will be indicated as TE01. +For a circular waveguide there is no ambiguity with regards to which direction is for m or n. +Note: Information given for the modes in the .out file corresponds to the specified +direction of the reference vector. +If the reference vectors differ between ports, it results in a phase mismatch between the S21 and S11. +Figure 238: Two waveguide ports with equal reference directions (on the left) and two waveguide ports with +opposite reference directions (to the right). For both these cases, the magnitude for S11 and S21 are identical. For +the case where the reference directions differs, the phase for S21 differ by 180° from S11. +Altair Feko 2022.3 +2 CADFEKO +Creating a Waveguide Port +Apply a waveguide port to a face. +1. On the Source/Load tab, in the Ports group, click the + Waveguide Port icon. +p.325 +Figure 239: The Create Waveguide Port dialog (Specification tab). +2. Click the Specification tab. +3. +In the Face field, use point entry to specify the face using one of the following workflows: +• In the 3D view, click on the relevant face. +• In the details tree, click on the relevant face. +A propagation direction and reference direction are automatically defined. +If the propagation direction is not correct, you can change the direction. +4. +[Optional] Clear the Propagation direction opposite to normal check box to change the +propagation direction to be in the same direction as the normal. +If the reference vector is not correct, you can specify the reference vector. +5. +6. +[Optional] Under Reference vector, specify the reference vector. +In the Label field, add a unique label for the waveguide port. +7. Click the Advanced tab. +Figure 240: The Create Waveguide Port dialog (Advanced tab). +When the number of modes to be considered is not specified, Feko calculates the number automatically. +8. +[Optional] To specify the number of modes, select the Manually set the maximum modal +expansion indices check box and specify m and n. +9. Select the Use legacy magnitude convention check box to use the legacy definition of mode- +dependent units (for example, for TE-mode it is A/m; for TM-mode it is V/m). +Note: The default is to use the power-based definition of magnitude which is common +to all mode types. +10. Click Create to create the waveguide port and to close the dialog. +Creating a Waveguide Port (Mesh) +Apply a waveguide port to a mesh face. +1. On the Source/Load tab, in the Ports group, click the + Waveguide Port icon. +Figure 241: The Create Waveguide Mesh Port dialog. +2. Click the Specification tab. +3. +In the Face field, use point entry to specify the face using one of the following workflows: +• In the 3D view, click on the relevant face. +• In the details tree, click on the relevant face. +A propagation direction and reference direction are automatically defined. +If the propagation direction is not correct, you can change the direction. +4. +[Optional] Clear the Propagation direction opposite to normal check box to change the +propagation direction to be in the same direction as the normal. +If the reference vector is not correct, you can specify the reference vector. +5. +6. +[Optional] Under Reference vector, specify the reference vector. +In the Label field, add a unique label for the waveguide port. +7. Click the Advanced tab. +Figure 242: The Create Waveguide Mesh Port dialog (Advanced tab). +When the number of modes to be considered is not specified, Feko calculates the number automatically. +8. +[Optional] To specify the number of modes, click the Manually set the maximum modal +expansion indices check box. +9. Select the Use legacy magnitude convention check box to use the legacy definition of mode- +dependent units (for example, for TE-mode it is A/m; for TM-mode it is V/m). +Note: The default is to use the power-based definition of magnitude which is common +to all mode types. +10. Click Create to create the waveguide port and to close the dialog. +2.24.5 FEM Modal Ports +A finite element method (FEM) modal port is used to apply a port to a flat face on the boundary +of a FEM region. A FEM modal port essentially represents an infinitely long guided wave structure +(transmission line), connected to a dielectric volume modelled with FEM. +The FEM modal port can be excited with the fundamental mode of the associated guided wave +structure, or it can act as a passive port. S-parameters can be computed between the fundamental +mode of the FEM modal port and other sources in the model. +Figure 243: The display of the FEM modal port in the 3D view. +Altair Feko 2022.3 +2 CADFEKO +Creating a FEM Modal Port +Apply a FEM modal port to a flat face on the boundary of a FEM region. +1. On the Source/Load tab, in the Ports group, click the + FEM Modal Port icon. +p.328 +Figure 244: The Create FEM Modal Port dialog. +2. Specify the port position using one of the following workflows: +• Specify the faces. Under Specify port, click as a list of faces and use point-entry to add the +faces. +• Specify the face using three points. Under Specify port, click as points and specify the three +corner points of the rectangular-shaped port. +3. +In the Label field, add a unique label for the FEM modal port. +4. Click Create to create the FEM modal port and to close the dialog. +Creating a FEM Modal Port (Mesh) +Apply a FEM modal port to a flat mesh face on the boundary of a FEM region. +1. On the Source/Load tab, in the Ports group, click the + FEM Modal Port icon. +Figure 245: The Create FEM Modal Port Mesh dialog. +2. Specify the port position using one of the following workflows: +• Specify the vertices. Under Specify port, click using vertices and use point-entry to add the +vertices in the 3D view. +• Specify the points. Under Specify port, click as points and specify the three corner points of +the rectangular-shaped port. +3. +In the Label field, add a unique label for the FEM modal port. +4. Click Create to create the FEM modal port and to close the dialog. +2.24.6 FEM Line Ports +finite element method (FEM) line ports are used to define the location of impressed current sources and +loads in a FEM region. +Figure 246: The display of the FEM line port in the 3D view. +Creating a FEM Line Port +Apply a FEM line port to a FEM region when using the finite element method (FEM) solution method. +1. On the Source/Load tab, in the Ports group, click the + FEM Line Port icon. +Figure 247: The Create FEM Line Port dialog. +2. Specify the port position using one of the following workflows: +• The edges (or a connected set of free edges that form a continuous straight line) of the port. +Under Specify port, click as an edge. +• The start point and end point of the FEM line port (in global coordinates). Under Specify +port, click as points. +3. +4. +[Optional] If the polarity of the port is to be reversed, select the Reverse polarity check box. +In the Label field, add a unique label for the FEM line port. +5. Click Create to create the port and to close the dialog. +Creating a FEM Line Port (Mesh) +Apply a FEM line port between two vertices in a tetrahedral mesh using the finite element method (FEM) +solution method. +1. On the Source/Load tab, in the Ports group, click the + FEM Line Port icon. +Figure 248: The Create FEM Line Port dialog. +2. Specify the port position using one of the following workflows: +• Specify the vertices. Under Specify port, click using vertices. +• The start point and end point of the FEM line port (in global coordinates). Under Specify +port, click as points. +3. +4. +[Optional] If the polarity of the port is to be reversed, select the Reverse polarity check box. +In the Label field, add a unique label for the FEM line port. +5. Click Create to create the line port and to close the dialog. +2.24.7 Cable Ports +Cable ports allow adding sources and loads to cable harnesses. +Apply and define connections to a cable port on the cable harness schematic view. +Figure 249: A cable port in the cable schematic view. +Related tasks +Viewing a Cable Harness in the Cable Schematic View +Creating a Cable Port +Apply a cable port to a cable harness. +1. Open the cable schematic view for the cable harness of interest. +2. On the Source/Load tab, in the Ports group, click the + Cable Port icon. +The cable port symbol is added to the active cable schematic view. +3. Connect the port to other schematic elements. +4. From the right-click context menu, select Properties to change the label for the cable port. +The Modify Cable Port dialog is displayed. +Figure 250: The Modify Cable Port dialog. +5. +In the Label field, add a unique label for the cable port. +6. Click OK to apply the new label and to close the dialog. +Related tasks +Viewing a Cable Harness in the Cable Schematic View +Altair Feko 2022.3 +2 CADFEKO +2.25 Sources +A source is used to excite or illuminate the model and cause current to flow. +Note: Sources can be specified globally or per configuration. +p.333 +The following sources are supported: +• sources on ports +◦ voltage source +◦ +current source +◦ waveguide source +◦ FEM modal source +• ideal sources +◦ plane wave +◦ electric dipole +◦ magnetic dipole +◦ +impressed current +• equivalent sources +◦ near field source +◦ +◦ +spherical modes source +far field source +◦ printed circuit board (PCB) source +◦ +solution coefficient source +Related concepts +Multiple Configurations +2.25.1 Sources on Ports +Apply a source to a port using either a voltage source, current source, waveguide source or a FEM +modal source. +Adding a Voltage Source +Apply a voltage source to any wire, edge, line, network, transmission-line, or cable port. +1. On the Source/Load tab, in the Sources on Ports group, click the + Voltage Source icon. +2. +3. +4. +5. +Figure 251: The Create Voltage Source dialog. +In the Port field, from the drop-down list, select a port. +In the Magnitude field, specify the magnitude of the voltage in Volt. The voltage gives the +potential difference between the positive side of the port relative to the negative side. A positive +voltage results in a positive current flowing out of the positive side and into the negative side of +the port. +In the Phase (degrees) field, specify the phase of the voltage source. +In the Reference impedance field, specify the impedance of the voltage source. +Note: The reference impedance is only used when plotting the input reflection +coefficient and realised gain in POSTFEKO. If this field is empty, the default value is +taken as 50 Ohm. +6. +In the Label field, add a unique label for the voltage source. +7. Click the Create button to create the voltage source and to close the dialog. +Function of Reference Impedance for Voltage and Current Sources +Specify the reference impedance to allow for the plotting of realised gain in POSTFEKO. +When the gain is calculated in Feko, it is calculated according to the IEEE definition where all losses are +included, except for mismatch losses. +To view the realised gain in POSTFEKO with mismatch losses included, you need to specify the reference +impedance. +Note: Specifying the reference impedance does not affect the gain, source power or +radiated power. +Altair Feko 2022.3 +2 CADFEKO +Adding a Current Source +p.335 +Apply a current source to a line port in a dielectric region solved with the finite element method (FEM) +to realise an impressed current source. +Note: An intrinsic limitation of the impressed current source is that no radius is considered. +The field is singular in the vicinity of the filament affecting the accuracy of the computed +input impedance of the source. +1. On the Source/Load tab, in the Sources on Ports group, click the + Current Source icon. +Figure 252: The Create Current Source dialog. +2. +3. +4. +5. +In the Port field, from the drop-down list, select a port. +In the Magnitude (A) field, specify the magnitude of the current in Ampere. +In the Phase (degrees) field, specify the phase of the current source. +In the Reference impedance field, specify the impedance of the current source. +Note: The reference impedance is used when calculating the input reflection +coefficient and realised gain. If this field is empty, default value is taken as 50 Ohm. +6. +In the Label field, add a unique label for the current source. +7. Click the Create button to create the current source and to close the dialog. +Adding a Waveguide Source +Apply a waveguide source to a waveguide port. +1. On the Source/Load tab, in the Sources on Ports group, click the + Waveguide Source icon. +Figure 253: The Create Waveguide Source dialog. +2. +3. +In the Label field, add a unique label for the waveguide source. +In the Port field, from the drop-down list, select any waveguide port. +4. Select one of the following regarding the mode(s) to excite: +• To excite only the fundamental waveguide mode, select Excite fundamental mode only. +When this option is selected, the mode type and its indices cannot be specified since they are +determined automatically. +• To manually specify the modes using their mode indices, select Specify modes manually. +5. +6. +In the Magnitude field, specify the magnitude of the mode. +In the Phase field, specify the phase of the mode. +7. Click the Create button to create the waveguide source and to close the dialog. +Adding a FEM Modal Source +Apply a FEM modal source to a finite element method (FEM) modal port. +Note: A FEM modal source excites the associated long-guided wave structure of the FEM +modal port with the fundamental mode. +Important: When no source is defined, the modal port acts as a passive port (sink) for +fields incident on the port. +1. On the Source/Load tab, in the Sources on Ports group, click the + FEM Modal Source icon. +Figure 254: The Create FEM Modal Source dialog. +2. +3. +4. +5. +In the Port field, from the drop-down list, select any FEM modal port. +In the Magnitude field, specify the magnitude of the fundamental mode. +In the Phase field, specify the phase of the fundamental mode. +In the Label field, add a unique label for the FEM modal source. +6. Click the Create button to create the FEM modal source and to close the dialog. +2.25.2 Ideal Sources +An “ideal” source is a source that applies a field, voltage or current and has no internal impedance. +Adding a Plane Wave Source +Add a plane wave source to illuminate a model with a uniform electric field. +1. On the Source/Load tab, in the Ideal Source group, click the + Plane Wave Source icon. +Figure 255: The Create Plane Wave Source dialog. +2. +3. +In the Magnitude (V/m) field, specify the magnitude of the plane wave. +In the Phase (degrees) field, specify the phase of the plane wave. +4. Specify the operation mode using one of the following: +• To create a single plane wave, click Single incident wave. +Tip: Use multiple single incident plane wave sources to create a specific field +distribution. +• To create a single plane wave that loops over multiple directions, select Loop over multiple +directions. +5. +In the Polarisation angle field, specify the angle, in degrees, measured in a right-handed +sense around the direction of propagation, from to +. +6. Under Polarisation, specify the polarisation type: +• Left hand rotating elliptical +• Linear +• Right hand rotating elliptical +7. +[Optional] Select the Calculate orthogonal polarisations check box to create an additional +orthogonal plane wave (although still a single plane wave source). +Note: Select this option when exporting transmission / reflection coefficients to a +.tr file. +8. +In the Ellipticity (0 to 1) field, specify the polarisation. +Note: +• Ellipticity = 0: linear polarisation +• Ellipticity ≤ 1: elliptical / circular polarisation +9. +In the Label field, add a unique label for the plane wave source. +10. Click the Create button to create the plane wave source and to close the dialog. +Related tasks +Exporting Transmission / Reflection Coefficients to a .TR File +Adding an Electric Dipole Source +Apply an electric dipole source that represents an elementary dipole element with a specified +orientation, magnitude and phase. +1. On the Source/Load tab, in the Ideal Source group, click the + Electric Dipole Source icon. +Figure 256: The Create Electric Dipole Source dialog. +2. +3. +4. +5. +In the Magnitude of Idl (Am) field, specify the magnitude of the current. +In the Phase (degrees) field, specify the phase of the current. +In the Position field, specify where the source is to be placed. +In the Orientation field, specify the orientation of the source. +6. +In the Label field, add a unique label for the electric dipole source. +7. Click the Create button to create the electric dipole source and to close the dialog. +Adding a Magnetic Dipole Source +Apply a magnetic dipole that can be either an electric ring current or a magnetic line current that +represents an elementary dipole element with a specified orientation, magnitude and phase. +1. On the Source/Load tab, in the Ideal Source group, click the + Magnetic Dipole Source +icon. +Figure 257: The Create Magnetic Dipole Source dialog. +2. Specify the magnitude of the source using one of the following: +• To specify the magnitude as the product of the loop current and loop area, click Electric ring +current. +• In the Magnitude of IA (Am^2) field, specify the current in Am2. +• To specify the magnitude as the product of the dipole length and magnetic current, click +Magnetic line current. +• In the Magnitude of Iml (Vm) field, specify the voltage in Vm. +3. +4. +5. +6. +In the Phase (degrees) field, specify the phase of the current. +In the Position field, specify where the source is to be placed. +In the Orientation field, specify the orientation of the source. +In the Label field, add a unique label for the magnetic dipole source. +7. Click the Create button to create the magnetic dipole source and to close the dialog. +Adding an Impressed Current Source +Apply an impressed current source to represent a lightning strike and exit points. +Tip: For lightning strikes, use two impressed current sources to model the strike point and +exit point where the current flows off the structure. The source should either have a current +magnitude of -1 or a phase of 180°. +1. On the Source/Load tab, in the Ideal Source group, click the + Impressed Current Source +icon. +Figure 258: The Create Impressed Current Source dialog. +2. Under Position, specify the start point and end point of the current segment. +3. Under Segment current, specify the magnitude and phase of the segment current at the start +4. +5. +point and end point. +In the Radius field, specify the radius of the current segment. +[Optional] Select the Connect the endpoint to the closest mesh vertex check box to +terminate the current at the closest mesh vertex during the solution. +• To connect to the closest triangle vertex, select On triangle. +• To connect to the closest segment vertex, select On segment. +CAUTION: Visually confirm in POSTFEKO that the source connects at the required +vertex. +6. +In the Label field, add a unique label for the impressed current source. +7. Click the Create button to create the impressed current source and to close the dialog. +2.25.3 Equivalent Sources +An “equivalent” source is a numerically equivalent (simulated or measured) of a complex source. +Significant reductions in computational requirements is achieved when solving a complex problem +through model decomposition and using an equivalent source. +Adding a Near Field Source +Apply an array of electric and magnetic dipoles in the model (in the form of a planar, cylindrical or +spherical aperture) that is equivalent to measured or calculated field values. +1. On the Source/Load tab, in the Equivalent Sources group, click the + Near Field Source +icon. +Figure 259: The Create Near Field Source dialog. +2. +In the Magnitude scale factor field, specify the scaling factor. +Tip: Use the scaling factor when data files have different units (for example, μV/m). +3. +4. +5. +In the Phase offset (degrees) field, specify the phase (in degrees) to be added to the phase of +the fields. +In the Field data field, specify the field data to be used to define the near field source. +In the Label field, add a unique label for the near field source. +6. Click the Create button to create the near field source and to close the dialog. +Adding a Spherical Mode Source +Apply an impressed spherical mode source based on pre-calculated spherical modes. The spherical +modes are either radiating to infinity or incident onto a structure (converging on the coordinate system +origin). +This source can be used for the synthesis of an arbitrary electromagnetic field as well as determining +the response of a receiving antenna due to the incident modes. +1. On the Source/Load tab, in the Equivalent Sources group, click the + Spherical Mode +Source icon. +Figure 260: The Create Spherical Mode Source dialog. +2. +3. +4. +5. +6. +7. +In the Magnitude scale factor field, specify the scaling factor. +In the Phase offset (degrees) field, specify the phase (in degrees) to be added to the phase of +the fields. +In the Field data field, specify the field data to be used to define the spherical modes source. +In the Position field, specify where the source is to be placed. +In the Orientation field, specify the orientation of the source. +In the Label field, add a unique label for the spherical modes source. +8. Click the Create button to create the spherical modes source and to close the dialog. +Adding a Far Field Source +Apply a radiation pattern of an antenna and use as an impressed source at a specified point in space. +1. On the Source/Load tab, in the Equivalent Sources group, click the + Far Field Source icon. +Figure 261: The Create Far Field Source dialog. +2. +3. +4. +5. +6. +7. +In the Magnitude scale factor field, specify the scaling factor. +In the Phase offset (degrees) field, specify the phase (in degrees) to be added to the phase of +the fields. +In the Field data field, specify the field data to be used to define the far field source. The field +data must be a far field specified using the spherical coordinate system. +In the Position field, specify where the source is to be placed. +In the Orientation field, specify the orientation of the source. +In the Label field, add a unique label for the far field point source. +8. Click the Create button to create the far field point source and to close the dialog. +Adding a PCB Source +Apply impressed line currents in the model to represent a printed circuit board (PCB). The impressed +line currents are equivalent to the current values calculated for the traces and vias of a PCB. +1. On the Source/Load tab, in the Equivalent Sources group, click the + PCB Source icon. +Figure 262: The Create PCB source dialog. +A preview of the PCB outline is displayed in green in the 3D view. +In the Magnitude scale factor field, specify the scaling factor. +In the Phase offset (degrees) field, specify the phase (in degrees) to be added to the phase of +the currents. +In the Current data field, specify the PCB current data to be used to define the PCB source. +In the Position field, specify where the source is to be placed. +In the Label field, add a unique label for the PCB source. +2. +3. +4. +5. +6. +7. Click the Create button to create the PCB source and to close the dialog. +The PCB outline is displayed in the 3D view when selecting the Configuration tab in the +model tree. +Adding a Solution Coefficient Source +Apply a solution coefficient data definition and use as an impressed current source at a specified point +in space. +1. On the Source/Load tab, in the Equivalent Sources group, click the + Solution Coefficient +icon. +Figure 263: The Create Solution Coefficient Source dialog. +2. +3. +4. +5. +6. +In the Magnitude scale factor field, specify the scaling factor. +In the Phase offset (degrees) field, specify the phase (in degrees) to be added to the phase of +the currents. +In the Solution coefficient data field, specify the solution coefficient data to be used to define +the solution coefficient source. +In the Position field, specify where the source is to be placed. +In the Label field, add a unique label for the solution coefficient data source. +7. Click the Create button to create the solution coefficient source and to close the dialog. +Related tasks +Defining Solution Coefficient Data from File +Requesting Model Decomposition +2.26 Loads and Non-Radiating Networks +Complex feed networks can be simplified by including them as a circuit representation using general +network blocks. +Note: Loads can be specified globally or per configuration. +Non-radiating networks operate on the principle of connecting networks or “black boxes” using a +connection diagram. The benefit of this scheme is that only a single connection is drawn between +black boxes. However, it may seem less intuitive when working with, for example, S-parameters or Z- +parameters, as graphical representations of these always show a signal pin and a ground pin. +Non-radiating networks are connected to, for example, wire ports in the geometry and these networks +are implicitly seen as being in series with the wire segment. +Related concepts +Multiple Configurations +2.26.1 Adding a Load +Apply an impedance load to a wire port, microstrip port, FEM line port, a general network or an ideal +transmission line. +1. On the Source/Load tab, in the Loads/Networks group, click the + Add Load icon. +Figure 264: The Create Load dialog. +2. From the Port drop-down list, select a port. +3. Under the Load type drop-down list, specify one of the following: +• Complex impedance +• In the Real part field, specify the real part of the complex impedance in Ohm. +• In the Imaginary part field, specify the imaginary part of the complex impedance in +Ohm. +• Series circuit +• To specify a resistor, select the Resistor check box and in the Resistor (Ohm) field, +enter a value in Ohm. +• To specify an inductor, select the Inductor check box and in the Inductor (H) field, +enter a value in Henry. +• To specify a capacitor, select the Capacitor check box and in the Capacitor (F) field, +enter a value in Farad. +If no option is selected, the result is a short circuit. +• Parallel circuit +• To specify a resistor, select the Resistor check box and in the Resistor (Ohm) field, +enter a value in Ohm. +• To specify an inductor, select the Inductor check box and in the Inductor (H) field, +enter a value in Henry. +• To specify a capacitor, select the Capacitor check box and in the Capacitor (F) field, +enter a value in Farad. +If no option is selected, the result is an open circuit. +• SPICE circuit +• In the Filename field, browse for a one-port SPICE circuit file (.cir) to define a load +between two pins. +Note: +◦ Feko supports only a subset of Berkeley SPICE3f5 syntax. +◦ Only linear circuits are supported. +• Specify a subcircuit defined in the .cir file. +◦ Clear the Auto check box. +◦ +In the Circuit name field, specify the subcircuit name. +Note: Circuit name must correspond to the subcircuit name in the .cir file. +• Touchstone file +• In the Filename field, browse for a one-port Touchstone file (.s1p, .z1p, .y1p). +Note: If the load is added to a port that has a voltage source, the load is +placed in series with the voltage source. +4. +In the Label field, add a unique label for the impedance load. +5. Click the Create button to create the load and to close the dialog. +Load Configuration for Networks +When a network port is connected to a wire (segment/vertex) or edge port, a load can be defined in +series or across the terminals of a network. +Note: A network port refers to a port connected to a general network or transmission line. +Load Placed in Series with Network +To place a load in series with the network, define the load on the wire (segment/vertex) or edge port. ++ +Load +Segment/vertex/edge port +Voltage source +- ++ +Network +port +- +General network/transmission line ++ +Network +port +- ++ +Load +Segment/vertex/edge port +Voltage source +Figure 265: The load is placed in series with the network. +Load Placed Across Network +To place the load across the network, define the load on the network port. +General network / transmission line ++ +Voltage source +Segment/vertex/edge port +Load +- ++ +Network +port +- ++ +Network +port +- +Voltage source +Load +Figure 266: The load is placed across the network. +Discrete Loads +- ++ +Segment/vertex/edge port +- +Load a wire port, microstrip port, FEM line port, general networks and a transmission line with a +discrete load such as a complex impedance, series circuit or parallel circuit. +Note: If multiple loads or sources are applied to the same port, they are placed in series. +Complex Impedance +A frequency-independent load consisting of a constant real and imaginary part. This load type can be +applied to wire, edge, network or transmission-line ports. +Series Circuit +A frequency-dependent load consisting of a series-connected resistor (R), capacitor (C) and inductor +(L). This load can only be applied to a wire port and an edge port. The load impedance is given by +Altair Feko 2022.3 +2 CADFEKO +Parallel Circuit +p.350 +(9) +A frequency-dependent load consisting of a resistor (R), a capacitor (C) and inductor (L) connected in +parallel. This load can only be applied to a wire port and an edge port. The load impedance is given by +(10) +where the resistance or inductance is taken as infinite when set to 0 (it does not contribute to the +impedance). +Note: For the parallel circuit the circuit elements are connected in parallel inside the +circuit, but the circuit itself is connected in series with the source. +Waveguide and Modal Port Sinks +When no source is defined for a waveguide port or a FEM modal port, the port acts as a passive port +(sink) for fields incident on the port. +2.26.2 Network Schematic View +The network schematic view is a panel that shows all general networks, transmission lines and ports +(wire and edge ports) in the model. Use this view to connect general networks, transmission lines, ports +and loads. +On the Home tab, in the Create View group, click the + Schematic icon. From the drop-down list +select Network Schematic icon. +Figure 267: An example showing the network schematic view with connections between transmission lines, general +networks and ports. +Connect two elements by clicking on the connector point (indicated by a white dot) and dragging the +connection until the mouse cursor is over the desired second connection point. When clicking on the +second point, a connection between wires is indicated by a black dot. +Selected networks, transmission lines, ports and connections are indicated by a dotted outline. +Delete an element by selecting the respective element and pressing Delete. +2.26.3 Adding a General Network (Data Matrix) +Define a general non-radiating network using network parameter matrices. In the network schematic +view, interconnect the networks (cascading) and excite or load the network ports. +1. On the Source/Load tab, in the Loads/Networks group, click the + Network icon. +Figure 268: The Create General Network dialog. +2. From the Data type drop-down list, select one of the following network parameters: +Altair Feko 2022.3 +2 CADFEKO +• S-matrix +• Z-matrix +• Y-matrix +p.352 +3. From the Source drop-down list, select one of the following: +• To import the network parameters from file, select Touchstone file. +Note: Only Touchstone format v1.1 is supported. +• To specify the coupling parameters, select Specify network manually. +• Specify the coupling parameters and the reference impedance. +4. +5. +In the Number of network terminals field, specify the number of network terminals. +In the Label field, add a unique label for the general network. +6. Click the Create button to create the general network and to close the dialog. +2.26.4 Adding a General Network (SPICE) +Define a general non-radiating network by importing a direct component-based network from a SPICE +.cir file. In the network schematic view, interconnect the networks (cascading) and excite or load the +network ports. +Note: +• Feko supports only a subset of Berkeley SPICE3f5 syntax. +• Only linear circuits are supported. +1. On the Source/Load tab, in the Loads/Networks group, click the + Network icon. +Figure 269: The Create General Network dialog. +2. From the Data type drop-down list, select SPICE network. +3. From the SPICE port reference drop-down list, select one of the following: +• To use a SPICE file with an absolute port reference, select Absolute. +• To use a SPICE file with a relative port reference, select Relative. +4. +In the Number of network terminals field, specify the number of network terminals. +Note: +• The number of network terminals must correspond to the number of ports in the +.cir file for an absolute port reference. +• The number of network terminals must be half the number of ports in the .cir file +for a relative port reference. +5. +6. +In the Filename field, browse to the location of the .cir file. +In the Circuit name field, specify the subcircuit network name in the .cir file. +Note: Circuit name must correspond to the subcircuit name in the .cir file. +7. +In the Label field, add a unique label for the general network. +8. Click the Create button to create the general network and to close the dialog. +Related concepts +SPICE3f5 +Setting Up Different Port References for a SPICE Network +Define SPICE files with an absolute or relative port reference for a SPICE network. +Example of a SPICE file with an absolute port reference +A SPICE example of pi-network using an absolute port reference (each port is referenced to the SPICE +global ground n0). The total number of output nodes is equal to the amount of network terminals when +creating a general network. +Figure 270: Example of a circuit using an absolute reference (node 0). +* Subcircuit PI Network +.SUBCKT PINETWORK n1 n2 +R1 n1 0 290 +R2 n1 n2 18 +R3 n2 0 290 +.ENDS PINETWORK +.SUBCKT NWN1 n1 n2 (absolute port reference) +X1 n1 n2 PINETWORK +.ENDS NWN1 +.END +Example of a SPICE file using an relative port reference +A SPICE example of a pi-network using a relative port reference, exposing the negative and positive +pins of each terminal in the network. The total number of output nodes is double the amount of network +terminals. +Figure 271: Example of a circuit using an relative reference. +* Subcircuit PI Network +.SUBCKT PINETWORK n1 n2 n3 +R1 n1 n3 290 +R2 n1 n2 18 +R3 n2 n3 290 +.ENDS PINETWORK +.SUBCKT NWN1 n1p n1m n2p n2m (relative port reference) +X1 n1p n2p n1m PINETWORK +R1 n1m n2m 0 +.ENDS NWN1 +.END +2.26.5 Adding a Transmission Line +Define an ideal, non-radiating transmission line. In the network schematic view, connect the +transmission line to a port, other transmission lines or general networks. +1. On the Source/Load tab, in the Loads/Networks group, click the + TX Line icon. +Figure 272: The Create Transmission Line dialog. +2. From the Definition method drop-down list, specify one of the following: +• Z0, length, attenuation, VOP +• Z0, length, attenuation +• Z0, length, medium +3. Specify the transmission line length using one of the following: +• To determine the distance between the start point and end point of the transmission line +automatically, select the Determine length from position check box. +• To specify the transmission line length, in the Transmission line length field, enter the +length. +4. +5. +In the Real part of Z0 (Ohm) field, specify the real value. +In the Imaginary part of Z0 (Ohm) field, specify the imaginary value. +6. Specify one of the following, depending on the selection in 2. +• Attenuation (dB/m) +Losses of the transmission line in dB/m. +Note: The propagation constant is taken as the propagation constant of +the medium in which the start and end ports are located. As a result, the +attenuation specified is added to any losses of this medium. +Velocity of propagation +The propagation speed through the transmission line relative to the speed of light. +Medium +The medium used as the background medium for the transmission line. +The positive port voltage is in the direction of the connected segment (from the start to the end point of +the segment). As a result, the input and output ports of the transmission line have unique orientations. +7. +[Optional] Select the Cross input and output ports check box to cross the input and output +ports. +8. +In the Label field, add a unique label for the transmission line. +9. Click the Create button to create the transmission line and to close the dialog. +• View the transmission line definition in the model tree (Configuration tab), under Non-radiating +networks. +• The transmission line is added to the network schematic view where you can connect the +transmission line to a port, other transmission lines or general networks. +2.27 Multiple Configurations +Perform multiple solutions for a single model using multiple configurations. Multiple configurations +remove the requirement to create multiple models with different solution requests. +For example: +• Calculate the input impedance of an antenna over a frequency range (Configuration 1) and the +radiated far field at the centre frequency (Configuration 2). +• Calculate the antenna parameters of a dual-band antenna over two frequency bands +(Configuration 1 and Configuration 2). +• Calculate the current on a wire above ground in three configurations: +◦ Terminated in an open circuit (Configuration 1). +◦ Terminated in short circuit (Configuration 2). +◦ Terminated with a matched load or system impedance (Configuration 3). +• Calculate the two-port S-parameters of a system (Configuration 1) and the radiated currents when +both ports are active at the same time (Configuration 2). +2.27.1 Configuration Types +Three configuration types are supported: standard configurations, S-parameter configurations and +characteristic mode configurations. +Standard Configuration +A standard configuration is the default configuration type. +The following requests are supported in conjunction with a standard configuration: +• far fields +• near fields +• currents +• specific absorption rate (SAR) +• transmission / reflection coefficients +• cable harness +• receiving antennas +• error estimations +• model decomposition +Adding a Standard Configuration +Define a standard configuration and add it to the model. +Add a standard configuration using one of the following workflows: +• On the Request tab, in the Configurations group, click the + Standard Configuration icon. +• In the configuration list, click the +. From the right-click context menu, select Standard +Configuration. +S-Parameter Configuration +Add an S-parameter configuration to calculate S-parameters between an arbitrary number of ports. +The following requests are supported in conjunction with a S-parameter configuration: +• far fields +• near fields +• currents +• specific absorption rate (SAR) +• cable probe +• receiving antennas +• error estimations +• model decomposition +Note: +• Only a single S-parameter request is allowed per configuration. +• No configuration-specific (local) sources or power settings are allowed. +Adding an S-Parameter Configuration +Define an S-parameter configuration and add it to the model. +1. Add an S-parameter configuration using one of the following workflows: +• On the Request tab, in the Configurations group, click the + S-parameter +Configuration icon. +• In the configuration list, click the + icon. Select S-parameter Configuration from the +menu . +Figure 273: The Create S-Parameters dialog. +2. +3. +In the Port column, from the drop-down list, select the port. +In the Properties column, specify the following: +• For waveguide ports, specify the type (TE[29] / TM[30]/ TEM[31]), indices and rotation of the +mode. +• For ports other than waveguide and FEM modal ports, specify the reference impedance. If no +impedance is specified, a default reference impedance of 50 Ohm is used. +4. +In the Active column, select the check box to use the port as a “source” (else the port is only a +“receiving” or “sink” port). +Note: For example, if a Port1 and Port2 is defined, but only Port1 is active, only S11 +and S21 are calculated. +5. +[Optional] Select the Export S-parameters to Touchstone file check box to export the S- +parameters to a .snp file. +For each S-parameter configuration, a separate Touchstone file is created. The file name is in the +form _(k).snp where: +FEKO_base_filename +file name of the model +requestname +request name +29. +transverse electric (TE) +30. +transverse magnetic (TM) +31. +transverse electric and magnetic (TEM) +Altair Feko 2022.3 +2 CADFEKO +number of ports +p.359 +a counter (integer) to distinguish between the results of multiple requests with the same +name and the same number of ports. +Note: +Feko does not normalise the S-parameter values to a global reference impedance when +exporting the S-parameters to a Touchstone file. The values are referenced to the +impedance specified on each port. +CAUTION: Some industry tools that use the Touchstone format often assume that +all values are referenced to a common impedance. When exporting S-parameters for +use in an industry tool that supports only a single reference impedance, specify the +reference impedance for each port to ensure the correct interpretation. +During the calculation of S-parameters, the specified reference impedances are added as loads to the +ports. These loads remain in place after the S-parameter calculation. If the loads are removed once +the S-parameter calculation is complete and there are subsequent output requests, such as near fields, +the full matrix computation and LU decomposition steps will be repeated for the MoM solution method. +This is typically the most time-consuming step in the analysis. It must be noted that should near fields +be requested, and the loads remain, the near fields will be lower in magnitude due to the losses in the +loads. +6. +[Optional] Select the Restore loads after calculation check box to remove the loads once the +S-parameter calculation is complete. +7. +In the Label field, add a unique label for the request. +8. Click Create to request the S-parameter results and to close the dialog. +The port numbers in an S-parameter solution are indexed based on the order of appearance in the port +list on the Create S-parameters dialog, and not according to the label of the selected port. +Adding an S-parameter Configuration to Generate a Multiport Data +Package +Define an S-parameter configuration to export a multiport data package. +1. Add an S-parameter configuration using one of the following workflows: +• On the Request tab, in the Configurations group, click the + S-parameter +Configuration icon. +• In the configuration list, click the + icon. Select S-parameter Configuration from the +menu . +2. Select the Generate multiport data package (*.mdp) +Figure 274: The Create S-Parameters dialog. +Note: All the ports in the S-parameter configuration are activated. +3. Follow Step 2 and Step 3 to select the ports and set the properties. +4. +In the Label field, add a unique label for the request. +5. Click Create to request the S-parameter results and to close the dialog. +6. +[Optional] Add additional requests, for example, far fields, near fields and current requests to the +S-parameter configuration to export the data to the multiport data package. +Characteristic Mode Configuration +A characteristic mode configuration results in a characteristic mode analysis (CMA) request. The +analysis is based on the numerical calculation of a weighted set of orthogonal mode currents. +CMA gives insight into the fundamental resonant behaviour of a structure allowing you to follow a +systematic design approach, making use of the parameters calculated with CMA, the modal current +distribution and the modal weighting coefficients. +Figure 275: The first four modal currents and associated far field of a ring antenna with four slots bridged with edge +ports. +The currents are supported on conducting surfaces as well as dielectric and magnetic materials with +MoM / SEP and apertures with the planar Green’s function. +Key parameters such as the resonance frequency of these modes and their radiating behaviour can be +determined by studying the current distribution of these modes. +Adding a Characteristic Mode Configuration +Define and add a characteristic mode configuration to the model. +1. Add a characteristic mode configuration using one of the following workflows: +• On the Request tab, in the Configurations group, click the + Characteristic Modes +Configuration icon. +• In the configuration list click the +. From the menu select Characteristic Modes +Configuration. +Figure 276: The Request Characteristic Modes Configuration dialog. +2. +In the Number of modes to calculate field, enter the maximum number of modes to calculate. +3. Select the Compute modal excitation coefficients (when sources are present) check box to +(in addition to the characteristic modes) calculate the modal excitation coefficients given a source. +4. Click Create to add the request and to close the dialog. +2.27.2 Modifying the Solution Order of Configurations +The Solver solves the configurations in the order in which the configurations are listed in the +configuration list, but the order can be changed. +As an example, a configuration is moved up in the configuration list. Similar steps are followed to move +the configuration down in the list. +1. +In the configuration list, select the configuration. +2. Move the configuration using one of the following workflows: +• From the right-click context menu, select + Move up. +• Press Ctrl++ to use the keyboard shortcut. +2.27.3 Excluding a Configuration from the Model +A configuration can be excluded from the solution without removing it from the model. +Note: Excluding a configuration does not delete the configuration. +1. +In the configuration list, select the configuration that you want to exclude. +2. From the right-click context menu, select Include/Exclude. +Figure 277: The + icon indicates that the configuration is excluded from the solution. +2.27.4 Deleting a Configuration from the Model +Remove a configuration from the model. +1. +In the configuration list, select the configuration that you want to remove. +2. From the right-click context menu, select + Delete. +2.27.5 Global and Configuration Specific Entities +Entities such as frequency, sources, loads and power can be set globally or specified per configuration. +Global +Global refers to entities that are relevant to all configurations. +Tip: Sources defined globally are applicable to standard configurations since sources +are not applicable to S-parameter configurations. Sources are not required for +characteristic mode configurations, but can be added. +Configuration-specific +Configuration-specific entities are only applicable to a specified configuration. For example, +frequency per configuration and sources per configuration. Configurations inherit all global items. +Note: By default, frequency, sources, loads and power are set globally. +Creating Configuration-Specific Entities +Convert a global entity to a configuration specific entity. +As an example, loads are converted to configuration specific loads, but the steps are similar for +converting frequency, sources and power. +1. +In the model tree, click Loads. +2. From the right-click context menu, select Specify Loads per Configuration. +Figure 278: Convert a globally specified load to a configuration specific load. +All loads are converted from a global item to a configuration specific item and copied to all +configurations. +Tip: Alternatively, in the model tree click + to specify the configuration settings. +Converting Configuration Specific Entities to Global +Convert a configuration specific entity to a global configuration. +As an example, loads from a configuration are converted to global loads, but the steps are similar for +converting frequency, sources and power. +1. +In the model tree, click Loads. +2. From the right-click context menu, select Specify Loads Globally. +3. On the Choose configuration dialog, from the drop-down list, select the configuration for which +the loads are to be converted to global loads (and as a result inherited by all configurations). +4. Click OK to create the loads and to close the dialog. +Copying Entities Between Configurations +Duplicate an entity and send to another configuration. +1. +2. +In the configuration list, select the configuration. +In the model tree, click the entity to be copied. +3. From the right-click context menu select Send copy to and select the destination configuration. +2.28 Requesting Calculations +Before running the Solver, define the output requests and view in the model tree (Configuration tab). +2.28.1 Automatically Calculated Results +When a model contains voltage sources or loads, some results are available by default. +The following results are available without requesting it: +• The input impedance for voltage and current sources. +• The voltages and currents for loads. +2.28.2 Requesting a Far Field +Add a far field request to the model. +1. On the Request tab, in the Solution Requests group, click the + Far Fields icon. +Figure 279: The Request Far Fields dialog. +Altair Feko 2022.3 +2 CADFEKO +2. Select one of the following: +p.366 +• To calculate the general far field pattern or bistatic RCS[32], click Calculate fields as +specified. The Spherical coordinate system is generally used to define far fields. +• To specify a pattern, enter the Start, End and Increment. +• To use a commonly-defined pattern, click one of the following: +◦ Horizontal cut (UV plane) +◦ Vertical cut (UN plane) +◦ Vertical cut (VN plane) +◦ 3D pattern +• To calculate monostatic radar cross section (RCS) or if an RCS optimisation search is based on +this far field request, click Calculate fields in plane wave incident direction. +No additional parameters are required as the scattered fields are only calculated in the +direction that the incident plane wave is coming from. The workplane settings of the incident +plane (rotation or translation of the local coordinate system) are used for the far field +calculation. +Note: For an RCS calculation, the model must contain a plane wave source[33]. +3. +In the Label field, add a unique label for the request. +4. Click Create to request the far field result and to close the dialog. +Advanced Settings for Far Field Requests +Use advanced settings to specify the currents or subset thereof to be taken into account for the +calculation of fields, the export of far field data, ignoring the radiated contribution from impressed +sources, calculating spherical modes and calculating the far field for an array of elements. +On the Request tab, in the Solution Requests group, click the + Far Fields icon. The advanced +settings are available on the Scope tab and Advanced tab. +Specify the Currents Taken Into Account During Field Calculation +Field calculation using all sources +With this option, the currents on all structures are taken into account when calculating the far +field result (default). +Field calculation using only sources on elements with specified labels +With this option, only the currents on structures with specified labels are taken into account when +calculating the far field result. +32. +radar cross section +33. with single or multiple directions of incidence +Export Directivity or Gain +This setting controls what is written to file (either directivity or gain). +Directivity +This option writes out the directivity to the selected output files (.out and .ffe file). +Gain +This option writes out the gain to the selected output files (.out and .ffe file). +Export Far Field Data +Export fields to ASCII file (*.ffe) +This option exports the far fields to a .ffe file. Use this file for further post-processing or, when +using spherical coordinates, as source pattern for a radiation pattern point source or a receiving +antenna. +Export fields to *.out file +This option exports the fields to the .out file. +Only determine radiated far field power by integration +This option calculates the far fields and the total radiated power but the field values are not +written to the .bof or .out output files. +Tip: Use this option if the individual field values are not required and the output files +would otherwise become too large. Far field values will not be available for viewing in +POSTFEKO or for optimisation in OPTFEKO. +Far Field Interpolation +Calculate continuous far field data +This option uses interpolation to display far field data in POSTFEKO. +Figure 280: The result of a 3D pattern far field request with and = 13 points (on the left) and the result of a +3D pattern far field request with = 7 and = 13 points with the Calculate continuous far field data option +selected (to the right). +Ignore Radiated Contribution from Impressed Sources +Calculate only the scattered part of the field +This option ignores the radiated contribution from impressed sources (for example, electric point +source, magnetic point source) as well as contribution from plane wave sources, yielding only the +scattered fields. +Note: The default setting is recommended. +Spherical Mode Options +Calculate spherical expansion mode coefficients +This option calculates the coefficients and exports the data to a .sph (TICRA) file. +Note: Set the radiated power in Feko to 4 Watts to ensure the gain in GRASP will be +correct. +Specify number of modes +This option allows you to specify the maximum mode index. If no value is specified, the maximum +mode index is calculated automatically. +Maximum mode index N +Specify the maximum mode index. +Export spherical expansion coefficients to ASCII file +This option exports the spherical expansion mode coefficients to an ASCII file. +Periodic Boundary Condition Options +Calculate far field for an array of elements +This option allows the far field to be calculated for an array of elements. +2.28.3 Requesting a Near Field +Add a near field request to the model. +1. On the Request tab, in the Solution Requests group, click the + Near Fields icon. +Figure 281: The Request Near Fields dialog. +2. Under Definition methods, select one of the following coordinate systems: +• Cartesian +• Cartesian boundary +• Conical +• Cylindrical +• Cylindrical (X axis) +• Cylindrical (Y axis) +• Spherical +• Specified points +• Tetrahedral mesh +Tip: To define a near field without using a coordinate system, select: +• Specified points to calculate near fields at a list of defined or imported points. +• Tetrahedral mesh to calculate near fields at the vertices and edge mid-points +inside a tetrahedral mesh. +3. +In the drop-down list, select one of the following: +• To specify the start and end points and the number of field points, select Specify number of +points. +• To specify the start and end points and the increment between points, select Specify +increments. +Tip: The actual end point (depends on the start point, the number of field points and +increment) may not coincide with the specified end point. +4. Select the Sample on edges check box to ensure the sample points lie on the edges of the +request. If the check box is cleared, the sample points lie half an increment away from the edge of +the request. +5. +In the Label field, add a unique label for the request. +6. Click Create to request the near field result and to close the dialog. +Requesting a Near Field Boundary +Add a near field boundary request to the model. This type of request allows you to define a cuboidal +near field request where the request points are located on the surface of the cuboid, but you have the +option to exclude specific surfaces (faces). +Figure 282: An example of a Cartesian boundary near field request with only the +N surface and -V surface +included (faces shown in blue). +1. On the Request tab, in the Solution Requests group, click the + Near Fields icon. +Figure 283: The Request Near Fields dialog. +2. Under Definition method, from the drop-down list, select Cartesian boundary. +3. +In the drop-down list, select one of the following: +• To specify the start and end points and the number of field points, select Specify number of +points. +• To specify the start and end points and the increment between points, select Specify +increments. +Tip: The actual end point (depends on the start point, the number of field points and +increment) may not coincide with the specified end point. +4. Under Boundary surface, clear the applicable check box if you want to exclude a surface from +the Cartesian boundary near field request. Click on one or more of the following to exclude: +• +• +• + -U: Exclude the surface in the negative U direction. + +N: Exclude the surface in the positive N direction. + +U: Exclude the surface in the positive U direction. +• +• +• + -V: Exclude the surface in the negative V direction. + -N: Exclude the surface in the negative N direction. + +V: Exclude the surface in the positive V direction. +5. +In the Label field, add a unique label for the request. +6. Click Create to request the near field result and to close the dialog. +Advanced Settings for Near Field Requests +Use advanced settings to specify the currents taken into account for the calculation of fields or +potentials, the export of near field data and ignoring radiated contributions from impressed sources. +On the Request tab, in the Solution Requests group, click the + Near Fields icon. The advanced +settings are available on the Scope tab and Advanced tab. +Specify the Currents Taken Into Account During Field Calculation +Field calculation using all sources +With this option, the currents on all structures are taken into account when calculating the near +field result. +Field calculation using only sources on elements with specified labels +With this option, only the currents on structures with specified labels are taken into account when +calculating the near field result. +Calculate Fields or Potential +Fields +This option calculates the actual near field components and are stored in the .out. The electric +component and / or the magnetic field component can be included. +Potentials +This option allows a single potential type to be included in the near field request. +• Electric vector potential +• Electric scalar potential +• Gradient of the scalar electric potential +• Magnetic vector potential +• Magnetic scalar potential +• Gradient of the scalar magnetic potential +Export Near Field Data (Fields and Potential) +Export fields to ASCII file (*.efe, *.hfe) +This option exports the electric fields to a .efe file and the magnetic fields to a .hfe file. +Altair Feko 2022.3 +2 CADFEKO +Export fields to *.out file +p.373 +This option exports the electric fields / potentials and the magnetic fields / potentials to the .out +file. +Export fields to SEMCAD *.dat file +This option export the electric fields / potentials and the magnetic fields / potentials to the .dat +file. +Export fields to SPARK3D *.fse file +This option exports the electric fields / potentials and magnetic fields / potentials calculated at the +vertices and edge mid-points of the tetrahedra to a .fse file. +Tip: Only valid if the Tetrahedral mesh option was selected (Position tab). +Ignore Radiated Contribution from Impressed Sources +Calculate only the scattered part of the field +This option ignores the radiated contribution from impressed sources (for example electric point +sources and magnetic point sources), yielding only the scattered fields. +Note: The default setting is recommended. +2.28.4 Requesting an Error Estimation +Add an error estimation request. Error estimation is an a-posteriori error indicator which gives feedback +on the mesh quality. The mesh quality is determined by testing the solution against an unconstrained +physical test. +1. On the Request tab, in the Solution Requests group, click the + Error Estimation icon. +Figure 284: The Request Error Estimation dialog. +2. From the drop-down list, select one of the following: +• To request error estimates on all mesh elements in the model, select All mesh elements. +• To request currents only on triangles, select Only error estimates on triangles. +• To request error estimates only on segments, select Only error estimates on segments. +• To request error estimates only on segments, select Only error estimates on tetrahedra. +• To request error estimates only on mesh elements with specified labels, select Only error +estimates on specified labels. +3. +[Optional] Select the Export error estimates to *.out file check box to export the error +estimates to the .out file. +4. +In the Label field, add a unique label for the request. +5. Click Create to request the error estimates results and to close the dialog. +Related tasks +Refining the Mesh Adaptively Using Error Estimates +2.28.5 Requesting Currents +Add a request to calculate the currents in the model to be displayed in POSTFEKO. +Tip: The storage of currents in large models can lead to large output files. When using +adaptive (continuous frequency) sampling, the interpolation of currents could increase the +number of frequencies required for solution convergence as well as the total runtime. In +general it is recommended to calculate the required currents at specific frequencies only. +Tip: If a continuous frequency solution is performed, add a second (standard) configuration +to calculate currents at specific frequencies only. +1. On the Request tab, in the Solution Requests group, click the + Currents icon. +Figure 285: The Request Currents dialog. +2. From the drop-down list, select one of the following: +• To request all currents in the model, select All currents. +• To request currents only on segments and triangles with specified labels, select Only +currents on specified labels. +• To request currents only on wire segments, select Only segment currents. +• To request currents only on triangles, select Only triangle currents. +3. +[Optional] Select the Export currents to ASCII file (*.os/*.ol) check box to export the +currents to a .os file and the charges to a .ol file. +4. +[Optional] Select the Export currents to *.out file check box to export the currents to the .out +file. +5. +In the Label field, add a unique label for the request. +6. Click Create to request the currents and charges result and to close the dialog. +2.28.6 Requesting Model Decomposition +Add a model decomposition request to the model. This request exports the surface currents on selected +faces to a .sol file. Use a .sol file to define a solution coefficient source in another model. +1. On the Request tab, in the Solution Requests group, click the + Model Decomposition icon. +Figure 286: The Request Model Decomposition dialog. +2. From the drop-down list, select one of the following: +• To request model decomposition for all structures, select All structures. +• To request model decomposition only on structures with specified labels, select Only +structures with specified labels. +3. +In the Label field, add a unique label for the request. +4. Click Create to request the model decomposition and to close the dialog. +Related tasks +Defining Solution Coefficient Data from File +Adding a Solution Coefficient Source +2.28.7 Transmission and Reflection Coefficients +Calculate the properties of frequency selective surfaces (FSS) in a multilayer scattering scenario by +using transmission and reflection coefficients for plane waves. Use in conjunction with periodic boundary +conditions (PBC), multilayer planar Green's functions or infinite planes for a more efficient solution. +Note: Only a single plane wave is supported (no additional sources are allowed) when +requesting transmission / reflection coefficients. The plane wave is allowed to have (loop +over) multiple incident angles. +Altair Feko 2022.3 +2 CADFEKO +The model must either contain: +• planar multilayer substrate without any other geometry / mesh in the model +or +• a 2D periodic boundary condition (PBC). +The transmission coefficient is defined as: +and the reflection coefficient: +Incident field E i +Reflected field E +p.376 +(11) +(12) +Transmitted field E +Figure 287: A plane wave interacting with a planar structure. +Requesting Transmission / Reflection Coefficients +Add a request to calculate the transmission / reflection coefficients for a plane wave interacting with a +planar structure. +1. On the Request tab, in the Solution Requests group, click the + Transmission / Reflection +icon. +Figure 288: The Request Transmission / Reflection coefficients dialog. +2. Under Plane position for phase reference, specify the location (origin) of the plane wave in +Cartesian coordinates. +3. +[Optional] Select the Export transmission and reflection coefficients to file (*.tr) check box +to export the transmission / reflection data from infinite surface structures. +Note: To export a valid .tr file, your model must either contain a periodic boundary +condition (PBC) or a planar Green's function. +4. +In the Label field, add a unique label for the request. +5. Click Create to request the transmission / reflection coefficients and to close the dialog. +Related concepts +Periodic Boundary Condition (PBC) +Infinite Planes and Half-Spaces +2.28.8 Ideal Receiving Antennas +An ideal receiving antenna is a tool that calculates the power that would be received by an ideal +antenna. Use this type of antenna for a more computationally efficient solution. +Note: Ideal receiving antennas are supported by all solution methods, except FDTD. +The following types of receiving antennas are available: +RX far field antenna +The antenna is located at a point in space with the spatial receiving properties of a far field +imported from simulated or measured data. +RX near field antenna +The antenna consists of near field apertures that serve as weights for receiving energy via the +specified aperture points. +RX spherical modes antenna +The antenna is located at a point in space with the spatial receiving properties defined by +spherical modes. The combination of the spherical modes effectively defines how energy is +received, incident upon the antenna from any particular direction. +The following assumptions are made regarding ideal receiving antennas: +• The antenna is considered to be matched (no mismatch loss is taken into account). +• The antenna and model geometry are assumed to have no impact on each other during the solution +phase (no coupling is taken into account). +Requesting Ideal Receiving Antenna (Far Field Pattern) +Add an ideal receiving antenna (far field pattern) request to the model. +1. On the Request tab, in the Solution Requests group, click the + Receiving Antenna icon. +From the drop-down list, select the + RX Far Field Antenna icon. +Figure 289: The Request Receiving Antenna (Far Field) dialog. +2. +3. +4. +5. +In the Field data field, specify the field data to be used to define the far field receiving antenna. +The field data must be a far field specified using the spherical coordinate system. +In the Position field, specify where the receiving antenna is to be placed. +In the Orientation field, specify the orientation of the receiving antenna. +[Optional] Click the Advanced tab. Select the Include only the scattering part of the field +check box to ignore the radiated contribution from impressed sources as well as the contribution +from plane wave sources, yielding only the scattered fields. +6. +In the Label field, add a unique label for the request. +7. Click Create to request the receiving antenna result and to close the dialog. +Requesting Ideal Receiving Antenna (Near Field Pattern) +Add an ideal receiving antenna (near field pattern) request to the model. +1. On the Request tab, in the Solution Requests group, click the + Receiving Antenna icon. +From the drop-down list, select the + RX Near Field Antenna icon. +Figure 290: The Request Receiving Antenna (Near Field) dialog. +2. Define the near field aperture using one of the following: +• To create a single near field aperture using individual near field definitions, click Combine +individual faces. +• In the Field data column, specify the field data for each face. +• To create a single near field enclosed region, select Reference an enclosed region of +surfaces. +• Specify the field data and location of the region. +In the Label field, add a unique label for the request. +[Optional] Click the Advanced tab. Select the Include only the scattering part of the field +check box to ignore the radiated contribution from impressed sources as well as the contribution +from plane wave sources, yielding only the scattered fields. +3. +4. +5. Click Create to request the receiving antenna result and to close the dialog. +Requesting Ideal Receiving Antenna (Spherical Modes) +Add an ideal receiving antenna (spherical modes) request to the model. +1. On the Request tab, in the Solution Requests group, click the + Receiving Antenna icon. +From the drop-down list, select the + RX Spherical Mode Antenna icon. +Figure 291: The Request Receiving Antenna (Spherical Modes) dialog. +2. +3. +4. +5. +In the Field data field, specify the field data to be used to define the spherical modes receiving +antenna. +In the Position field, specify where the receiving antenna is to be placed. +In the Orientation field, specify the orientation of the receiving antenna. +[Optional] Click the Advanced tab. Select the Include only the scattering part of the field +check box to ignore the radiated contribution from impressed sources as well as the contribution +from plane wave sources, yielding only the scattered fields. +6. +[Optional] Specify the internal spherical modes approximation method by selecting one of the +following: +• To describe the receiving antenna by the spherical mode expansions of the radiated and +received antenna fields, select Use spherical modes approximation. +• To describe the receiving antenna by an impressed radiation pattern obtained internally from +the spherical mode description, select Use far field approximation. +7. +In the Label field, add a unique label for the request. +8. Click Create to request the receiving antenna result and to close the dialog. +2.28.9 Requesting Specific Absorption Rate (SAR) +Add a request to calculate the average absorption over a volume (volume-average SAR) or the +maximum absorption in a 1 g or 10 g cube in a given volume (spatial-peak SAR). +1. On the Request tab, in the Solution Requests group, click the + SAR icon. +Figure 292: The Request SAR dialog. +2. Under Select calculation, select the type of SAR calculation: +• To calculate the average absorption over a volume, select Volume-average SAR. +• To calculate the maximum absorption in a 1g cube in the model, select Spatial-peak SAR of +a 1g cube. +• To calculate the maximum absorption in a 10g cube in the model, select Spatial-peak SAR +of a 10g cube. +3. Specify the region where the SAR is calculated. Under Specify the search region, select one of +the following: +• To calculate SAR in all the dielectric regions in the model and calculate a single average or +peak SAR value, select Entire model. +• To calculate SAR in all media or a specified medium, select By medium. +• To calculate SAR in a specific layer or in all the layers of a planar substrate, select In a +planar substrate. +Note: +• Layer 0 is the upper free space region. +• Layer 1 is the uppermost dielectric layer. +• To calculate the 1g or 10g cube SAR at a specified location, select At a specified position. +This option is not available for volume average SAR. +4. +In the Label field, add a unique label for the request. +5. Click Create to request the SAR result and to close the dialog. +Related reference +SAR Standards +2.28.10 Requesting Cable Probe Data +Add a request to calculate the voltage or current along a cable path. +1. On the Request tab, in the Solution Requests group, click the + Cable Probe icon. +Figure 293: The Create Cable Probe dialog. +2. Under Probe type, select one of the following: +• To view the current along a cable path, select Current. +• To view the voltage along a cable path, select Voltage. +• To view the current and voltage along a cable path, select Current and voltage. +3. Specify the probe location using one of the following workflows: +• To specify the location as a percentage of the total path length (beginning from the start +connector), under Probe location, select Percentage along cable path. +• In the Position (%) field, specify the percentage of the total path length, where “0%” +translates to the start of the cable path. +• To specify the location as a specified distance from the start connector, under Probe +location, select Distance along cable path. +• In the Position (distance) field, specify the distance along the cable path, where a “0” +distance translates to the start of a cable path. +In the Cable path drop-down list, select the cable path where the cable probe is to be placed. +In the Label field, add a unique label for the request. +4. +5. +6. Click Create to request the cable probe result and to close the dialog. +2.28.11 Requesting S-Parameters +To add an S-parameter request to the model, add an S-parameter configuration. +On the Request tab, in the Configurations group, click the + S-parameter Configuration icon. +Altair Feko 2022.3 +2 CADFEKO +Related tasks +Adding an S-Parameter Configuration +p.383 +2.28.12 Requesting Characteristic Mode Analysis (CMA) +To add a characteristic mode analysis (CMA) request to the model, add a characteristic modes +configuration +On the Request tab, in the Configurations group, click the + Characteristic Modes Configuration +icon. +Related tasks +Adding a Characteristic Mode Configuration +2.29 Infinite Planes and Half-Spaces +Use an infinite plane or half-space to model a ground plane efficiently. The number of triangles in the +model is reduced as the ground plane is not discretised into triangles. +On the Construct tab, in the Structures group, click the + Planes/Arrays icon. From the drop- +down list, select + Plane / Ground. +Figure 294: The Plane / ground dialog. +No Ground (Homogeneous Free Space Medium) [Default] +The model is solved in a homogeneous environment filled with free space medium. Edit the properties +of free space if required. +Perfect Electric (PEC) Ground Plane at Z=0 +Add an infinite PEC ground plane at Z=0 (in the global coordinate system) using the exact reflection +coefficients, where the reflected field is added to get the total field. +Note: For a PEC ground plane, dielectric and metallic faces may connect to the ground +plane and may coincide with ground plane, but may not cross or be below the ground plane. +Perfect Magnetic (PMC) Ground Plane at Z=0 +Add an infinite PMC ground plane at Z=0 (in the global coordinate system) using the exact reflection +coefficients, where the reflected field is added to get the total field. +Note: For a PMC ground plane, only metallic faces may connect to the ground plane, but +may not coincide with the ground plane. +Homogeneous Half Space in Region Z<0 (Reflection Coefficient Approximation) +Add an infinite dielectric or a metallic half space for Z<0 with the boundary at Z=0 (in the global +coordinate system). The half space uses the reflection coefficient ground plane approximation, where +the reflected field is added to get the total field. +Note: +• For the reflection coefficient approximation ground, the structures must be above (Z>0) +and at least + away from the ground plane, where is the free space wavelength. +• This technique is faster and potentially less accurate than the exact Sommerfeld +integrals method. +Homogeneous Half Space in Region Z<0 (Exact Sommerfeld Integrals) +Add an infinite dielectric ground plane for Z<0 with the boundary at Z=0 (in the global coordinate +system). The half space uses the Sommerfeld integrals to solve the exact boundary condition with the +appropriate Green's function. +Note: +• A dielectric face may not coincide with the Z=0 half-space boundary. +• A metallic face may coincide with the Z=0 half-space boundary. +• Structures may cross the Z=0 half-space boundary. +• Structures may be inside (Z<0) the half-space boundary. +Planar Multilayer Substrate +Add a planar multilayer substrate (finite or infinite) orthogonal to the Z axis (in the global coordinate +system). +Note: +• Supports arbitrarily shaped structures inside the substrate. Structures may cross +multiple layers. +• Enclose the substrate in a MoM / SEP region to create a finite planar multilayer +substrate. +Related tasks +Defining an Infinite Planar Multilayer Substrate +Defining a Finite Planar Multilayer Substrate +2.29.1 Defining an Infinite Planar Multilayer Substrate +Define an infinite planar multilayer substrate. +Some applications for infinite planar multilayer substrates are as follows: +• Add a PEC ground plane at the top and bottom layers to model a stripline. +• Add a PEC ground plane at the bottom layer to model a microstrip. +• Use the substrate (without a PEC ground plane) to model real earth. +• Use a finite thickness substrate without any ground plane to model a printed antenna (for example, +a log-periodic antenna). +1. On the Construct tab, in the Structures group, click the + Planes/Arrays icon. From the +drop-down list, select + Plane / Ground. +Figure 295: The Plane / ground dialog. +2. From the Definition method drop-down list, select Planar multilayer substrate. +3. Under Infinite layers, specify the top and bottom infinite layers: +a) In the Top layer medium drop-down list, select the medium for the top layer that extends +into infinity. +b) In the Top layer ground plane drop-down list, specify whether the top layer should have a +ground plane. +• If the top layer has no ground plane, select None. +• To add a ground plane for the top layer, select PEC. +c) In the Bottom layer medium drop-down list, select the medium for the bottom layer that +extends into infinity. +4. Click Add to add an additional layer. Click Remove to remove the selected layer from the +substrate. +5. For each layer: +a) From the Ground plane drop-down list, select one of the following: +• To remove the PEC ground plane located below the current layer, click None. +• To add a PEC ground plane located below the current layer, click PEC. +b) Specify the layer thickness. +c) Specify the medium. +Note: +• The top layer and bottom layer extends into infinity. +• In the CADFEKO GUI, the first layer is indexed as 0. +• In the CADFEKO API, the first layer is indexed as 1. +6. +In the Z-value at the top of layer 1 field, specify where the top of layer 1 is located. +7. Click OK to define the infinite planar multilayer substrate and close the dialog. +2.29.2 Defining a Finite Planar Multilayer Substrate +Enclose an infinite multilayer substrate inside a MoM / SEP region to model a finite-size planar +multilayer substrate. +1. Define an infinite planar multilayer substrate. +2. Create the solid that will contain the substrate (if it does not already exist). +3. +4. +In the model tree, select the solid. +In the details tree, select the region. +5. From the right-click context menu, select Properties. +6. On the Modify Region dialog, click the Properties tab. +7. From the Medium drop-down list, select Plane / ground (finite). +Figure 296: The Region properties dialog. +8. Click OK to enclose the substrate inside the region and close the dialog. +2.30 Meshing the Geometry / Model Mesh +2.30.1 Mesh Overview +A mesh is a discretised representation of a geometry model or mesh model. The geometry model (or +mesh model) is meshed to obtain a simulation mesh which is given as input to the Solver to calculate +the requests. The accuracy of the results depends greatly on generating a mesh that is an accurate +representation of the model. +For preliminary simulations of your model, you are recommended to use a coarse mesh to obtain initial +and fast results that can be used as a rough verification (although the results may be inaccurate). As a +next step, you should do mesh convergence tests[34] before taking the simulated results as truly final +and accurate. +The following terminology is used: +Geometry part / Model geometry +Geometry part or model geometry refers to the computer-aided design (CAD) in the model. The +CAD could be created in CADFEKO or imported from a wide range of CAD formats. +Mesh part / Model mesh +The mesh part or model mesh is similar to CAD parts, but the mesh parts are models created +from mesh elements, not CAD. The mesh is created either in CADFEKO (by unlinking from meshed +CAD or creating mesh elements directly) or importing a mesh. +Simulation mesh +The simulation mesh refers to the final mesh used by the Solver. CAD always has to be meshed. +Models created from mesh parts can either be remeshed to create a simulation mesh, or they can +be used without being remeshed. The simulation mesh is then the same as the model mesh. +View the model mesh and the respective simulation mesh in the model tree (Construct tab). +Figure 297: Example of (1) a geometry part that was meshed and has a simulation mesh, (2) a mesh part without +a simulation mesh (still needs to be meshed) and (3) a mesh part that has a simulation mesh. +34. Rerun the model with 50% more elements and compare the results with that of the original mesh. +Altair Feko 2022.3 +2 CADFEKO +Note: +• The +• The +p.389 + icon indicates a mesh part or model mesh. + icon indicates that a mesh instance has already been created or defined. This +mesh instance is used when simulating the model. +2.30.2 Auto Meshing +The automatic mesh algorithm calculates and creates the mesh automatically once the frequency is set +or local mesh settings are applied. +While the mesh is calculated by the automatic mesh algorithm, you can continue with setting up the +model configuration. When geometry is transformed, no re-meshing is required since transforms are +applied directly to the mesh. The automatic mesh algorithm also takes into account the proximity of +other geometry or mesh to create a finer mesh. +While the mesh is being calculated, its status is indicated by a progress bar in the status bar. +For large models that takes a while to mesh, the automatic meshing may be disabled. +Related concepts +Status Bar +Auto Determine the Mesh Sizes +Related tasks +Disabling/Enabling Auto Meshing +Disabling/Enabling Auto Meshing +For very large models that have millions of mesh elements, auto meshing can be disabled while you +make changes to the model. +Disable the auto meshing using one of the following workflows: +• On the Mesh tab, in the Meshing group, click the + Automatic Meshing icon. +• On the status bar, click the + Automatic Meshing icon. +Tip: Click the + icon again to enable the auto meshing. +2.30.3 Mesh Element Types +CADFEKO supports segments, triangles, tetrahedra and voxels as mesh elements. The type of mesh +element used to create a mesh is directly coupled to the solver method. +CADFEKO supports the following types of mesh elements: +Altair Feko 2022.3 +2 CADFEKO +Segments +p.390 +A line segment consists of two vertices. Segments are the default type of mesh element to +represent wires and are used for all solver methods. +Triangles +A triangle consists of three sides with three corner vertices. A curvilinear triangle consists of three +sides with six vertices. Triangles are the default type of mesh element and is used for all solver +methods, but excluding finite difference time domain (FDTD), finite element method (FEM) and +uniform theory of diffraction (UTD). +Tetrahedra +A tetrahedron consists of four triangular faces, six edges and four corner vertices. Tetrahedral +elements are used for volume equivalence principle (VEP) and finite element method (FEM) solver +methods. +Voxels +A voxel is a cuboid on a grid in three-dimensional space. Voxels are the mesh element type used +in conjunction with the FDTD solver method. +Figure 298: A model with voxel mesh gridlines indicating the size of the voxels. +2.30.4 Auto Determine the Mesh Sizes +A mesh can be created quickly without you having any knowledge of what the ideal mesh size should +be for the model. Use the coarse, standard or fine mesh size to determine the correct mesh size for the +model that takes into account the frequency, solution method, media properties and curvature of the +model. +When the mesh size is determined automatically, the mesh is discretised relative to the wavelength +of an electromagnetic wave in the medium of propagation. Each solution method has different +requirements that influence the mesh size. In most cases, the automatic mesh size using the coarse, +standard or fine option will give a reasonable result, but local mesh refinement may still be necessary. +The following model properties are considered when creating an automatic mesh size using the coarse, +standard or fine option[35]: +35. The coarse, standard or fine mesh option is available on the Modify Mesh dialog. +Altair Feko 2022.3 +2 CADFEKO +Frequency +p.391 +The simulation frequency of the model impacts the automatic mesh generated. The shortest +wavelength corresponds to the highest simulation frequency. +Solver method +The solver method being used to solve the problem impacts the mesh requirements. For example, +a finite element method (FEM) model requires settings for tetrahedra, a method of moments +(MoM) solution requires settings for triangles and wires, while a hybrid solution needs to take into +account the mesh requirements for multiple solution methods. +Dielectric properties +The dielectric properties of the media in the model affects the wavelength. Dielectric media are +taken into account in all cases (except in the case where infinite layers are used). In the case +where infinite layers are used, a local mesh refinement must be applied. +Geometry curvature +In cases where a finer mesh is not paramount for accurate solution results, it may still be required +to accurately model aspects of the geometry. An automatic mesh size will attempt to reasonably +conform to the original geometry. +Tip: Modify the mesh settings on the Create mesh dialog, on the Advanced tab and +note the effect the settings have on the resulting mesh. +Automatic mesh settings are only applied to regions, faces, edges and wires that do not have a mesh +size set (locally or globally). When a local mesh refinement is applied to an individual component in +the model, the local mesh refinement receives higher priority and will never be overwritten by the +automatic meshing sizes. +Related reference +Automatic Meshing for Wires +Automatic Meshing for Faces and Edges +Automatic Meshing for Regions +Automatic Meshing for Voxels +2.30.5 Modifying the Auto-Generated Mesh +Adjust the auto-generated mesh that is generated when the frequency is set or local mesh settings are +applied to the geometry. +Note: +• To generate a tetrahedral mesh, activate the FEM solution method. +• To generate a voxel mesh, activate the FDTD solution method. +1. Open the Modify Mesh dialog using one of the following workflows: +• On the Mesh tab, in the Meshing group, click the + Modify Mesh icon. +• Press Ctrl+M to use the keyboard shortcut. +Figure 299: The Modify Mesh Settings dialog (Options tab). On the left, the dialog for triangles and +tetraheda and to the right, the dialog for voxels. +2. Specify the mesh size. +• To create a mesh using automatic mesh sizes, in the Mesh size field, from the drop-down list +select Coarse, Standard or Fine. +• To create a mesh with a custom mesh size, in the Mesh size field, from the drop-down list +select Custom. Specify the lengths applicable to the model. +1. +2. +3. +4. +In the Triangle edge length field, specify the triangle edge length. +In the Wire segment length field, specify the wire edge length. +In the Tetrahedron segment length field, specify the tetrahedron edge length. +In the Voxel size field, specify the length for the voxel width, depth and height. +3. Specify the global wire radius. +• To specify a wire radius, clear the Use intrinsic wire radius check box and in Wire radius +field, enter a value for the global wire radius. +• To allow the Solver to determine the wire representation, select the Use intrinsic wire +radius check box. +Tip: This option may improve the FDTD convergence. +Note: A local mesh refinement takes precedence over global mesh settings. +4. Click OK to modify the mesh and to close the dialog. +Related tasks +Solving a Model with FDTD +Altair Feko 2022.3 +2 CADFEKO +Solving a Region with FEM +Related reference +Automatic Meshing for Wires +Automatic Meshing for Faces and Edges +Automatic Meshing for Regions +Automatic Meshing for Voxels +Advanced Meshing Options +p.393 +A number of advanced meshing options are available that allows you the flexibility and advanced mesh +control for segments, triangles, tetrahedra and voxels. +On the Mesh tab, in the Meshing group, click the + Modify Mesh icon. On the Create mesh dialog, +click the Advanced tab. +Figure 300: The Modify Mesh Settings dialog (Advanced tab). On the left, the dialog for triangles and tetraheda +and to the right, the dialog for voxels. +Suppression of Small Geometry Features +This option controls how small geometry features are meshed into segments, triangles, tetrahedra or +voxels (where applicable). +Altair Feko 2022.3 +2 CADFEKO +Default +p.394 +This option creates a mesh using the standard mesh size. To create an accurate presentation of +the model, the mesh can potentially contain a number of very small mesh elements. +Optimise +This option creates a mesh with an improved mesh quality for small features (for example, long +narrow slivers or faces that are close together). +Ignore +This option creates a mesh that ignores small details in the model at a possible cost of accurate +model representation. This option may at times allow the meshing of faces that otherwise cannot +be meshed with the default settings. +Geometry smaller than [%] +Specifies the limit to what is considered a small feature. The limit is expressed as a percentage of +the largest mesh size[36]. If the geometry detail is smaller than the limit, it is either optimised or +ignored. +Fraction of voxel size (0,1) +This option limits how small voxels are allowed to become compared to their ideal size, where +ideal size refers to the size determined by electromagnetic properties or the specified value. The +position of gridlines is influenced by points of interests on the geometry. Points of interest that are +closely spaced will result in unnecessarily small voxels. +Select Manual setting to specify a value between 0 and 1, where the value 1 relates to the ideal +voxel size. +Mesh Quality +This option controls the quality of the mesh. +Mesh size growth rate +This option controls how quickly the mesh size changes. Fast allows an abrupt jump from small to +large elements, while for Slow, each adjacent triangle will increase in size with less than twice the +size of its previous neighbour. +Enable mesh smoothing +This option applies an additional smoothing algorithm that results in better quality mesh but will +increase the time to mesh the model. +Tip: This algorithm is usually not time-consuming and it is recommended to use the +additional smoothing. +Curved Geometry Approximation +These options control how curved geometry is approximated when creating the mesh. +36. The mesh size is specified on the Modify Mesh dialog (Options tab). +Altair Feko 2022.3 +2 CADFEKO +Refinement factor +p.395 +This option controls how fast the mesh will refine when it determines that the mesh does not +adequately conform to the model. Fine allows smaller triangles to be used for small details but will +increase the time to mesh the model. +Minimum element size +This option limits the size of the small triangles that are used to conform to the geometry, relative +to the requested mesh size on that part. +Allow elongated triangles +This option allows the use of long, thin triangles and can lead to a reduction in the number of +mesh elements (depending on the geometry that is meshed). +Curvilinear Mesh +Advanced mesh options are available to create a mesh using curvilinear triangles and curvilinear +segments. A curvilinear triangle mesh allows you to use fewer higher order basis functions (HOBF) or +RL-GO triangles. +Curvilinear Mesh Triangles +Auto +This option allows the curvilinear mesh triangles to be used if curvilinear mesh triangles are +likely to result in a more efficient solution using less memory. +Disabled +This option creates flat triangular elements. +Enabled +This option creates curvilinear mesh triangles (if supported by the solution method). +Note: HOBF must be enabled for curvilinear meshing (except for windscreen +reference elements and when using the RL-GO solution method). +Figure 301: A model with flat triangular mesh (on the left) and with curvilinear mesh and higher order basis +functions enabled (to the right). +Altair Feko 2022.3 +2 CADFEKO +Curvilinear Mesh Segments +p.396 +A curvilinear mesh segment is created using second order segments with three vertices. +Auto +This option allows the curvilinear mesh segments to be used if curvilinear mesh segments +will result in a more accurate solution with the selected solution method. +Disabled +This option creates straight mesh segments. +Enabled +This option creates curvilinear mesh segments (if supported by the solver method). +Figure 302: A helical wire meshed with straight segments (on the left) and with curvilinear mesh segments +(to the right). +Note: Curvilinear mesh segments not supported for windscreen solution elements. +Aspect Ratio +This option controls the ratio between the longest and shortest side lengths of a voxel. Specifying the +aspect ratio adds additional grid lines to decrease the side with the greatest length. +Select Manual setting to specify a value between 1 and 100, where: +• the value 1 relates to voxels with equal side lengths. +• the value 100 relates to a 100:1 aspect ratio. +Growth Rate +The option limits the changes in size between adjacent voxels. +Select Manual setting to specify a value between 1 and 100, where a growth rate of unity implies no +growth and will result in a uniform mesh. +Tip: Use the default Growth rate control setting of 1.2. +Ensure Connectivity Through Wire Tracing +This option allows a thin face to be replaced by a wire to ensure connectivity in a voxel mesh. +Select the Ensure connectivity through wire tracing check box to replace a thin PEC face with a +wire. The intrinsic wire radius is determined by the Solver. +When this option is not selected, sections of the model that should be electrically connected might not +be connected in the voxel representation. +Insufficient Memory Protection +This option prevents a large model to mesh if there is not sufficient memory available. Clear the +Insufficient memory protection check box to disable this feature. +2.30.6 Preventing Future Mesh Modification +Lock a part to prevent modification to the simulation mesh (and prevent the part from being edited). +Some parts of a model take long to mesh or for some reason, it may be required to ensure that a part +is not remeshed (remeshing could result in a different mesh). Locking a part allows the mesh to be +locked for modification. If the part does not have a simulation mesh, it is meshed once, but the mesh +will not be remeshed again (until it is unlocked). +Note: Locking a part to prevent mesh modification is not supported for a voxel mesh. +1. Select the geometry or mesh part in the model tree (Construct tab). +2. Lock the part. From the right-click context menu click + Lock/Unlock. +The mesh is now locked and will not be remeshed when the model is meshed. +2.30.7 Viewing the Mesh Information +After the geometry or model mesh was meshed, the quality of the mesh part (or model mesh) or +simulation mesh can be examined. +1. Select the model (or part) in the model tree (Construct tab). +2. View the mesh information using one of the following workflows: +• From the right-click context menu, click Info. +• On the Mesh tab, in the Meshing group, click the + Info icon. +The Mesh information dialog gives a summary of the mesh statistics such as the average edge length +and the standard deviation of the edge lengths. The data gives an indication of the quality of the mesh +and how many edges are longer than the desired length. +You can also view the number of triangles (flat and curvilinear), tetrahedra, voxels and line segments +(straight and curvilinear). +Figure 303: The Mesh Information dialog. +2.30.8 Mesh Refinement +When an accurate solution of the model requires a fine mesh, the mesh can be refined at specific areas +of the model without simply meshing the entire model finer. +There are several mesh refinement options available when it is required to refine specific areas +in the mesh. Although the mesh can be refined globally and this approach is attractive due to its +simplicity, this will lead to an unnecessarily large number of mesh elements that in turn will increase the +simulation time and resource requirements. +A more efficient approach is to only refine the mesh locally where a finer mesh is required. In +CADFEKO, you have the following options to refine a mesh locally: +• Define multiple local mesh settings for a model, each one with a unique label. Apply the local mesh +settings to root-level geometry and mesh parts in the model tree by referencing its label. +• Apply a local mesh size to a wire / edge, face or region. +• Use point refinement to define the local point and its radius where the mesh should be refined. +• Use polyline refinement to define a line and radius where the mesh should be refined along the line. +• Use adaptive mesh refinement in conjunction with an error estimate request to iterate and refine +the mesh at areas with the largest error estimates. +Applying Local Mesh Settings to a Part +Define multiple local mesh settings, each one with a label. Apply the local mesh settings to a root-level +geometry or mesh part by referencing its label. +Note: This feature replaces the functionality where you could select a root-level geometry +or mesh part, set the mesh scope to selection and only mesh the selected part using the +specified mesh settings. +1. Define a local mesh setting. +a) On the Mesh tab, in the Meshing group, click the + Add Mesh Settings icon. +Figure 304: The Create Local Mesh Settings dialog. +b) On the Create Local Mesh Settings dialog, specify the mesh sizes. +c) In the Label field, enter a unique label for the local mesh settings. +d) Click Create to create the mesh settings and to close the dialog. +2. Apply the local mesh settings to a part. +a) In the model tree, double-click on a root level geometry or mesh part. +b) On the Modify … dialog, click the Meshing tab. +Figure 305: The Modify ... dialog. +c) Select the Enable local mesh setting control check box. +d) From the drop-down list, select the local mesh settings to be applied to the part. +e) Click OK to apply the local mesh settings and to close the dialog. +Altair Feko 2022.3 +2 CADFEKO +Local Mesh Refinement +p.400 +A local mesh refinement can be specified on wires / edges, faces and regions to refine the mesh locally. +When a region that has a local mesh size is meshed into tetrahedra, the local mesh size is also +applicable to the bounding faces. Likewise, setting a local mesh size on a face also affects the size on +the bounding edges. If a finer mesh is specified on an edge of a face, then the triangles of that face will +adhere to this length along the specific edge, even though the rest of the face may have much larger +mesh sizes. +Note: The local mesh size that takes precedence on an item is always the minimum of all +applicable local mesh sizes. +If no local mesh size is specified on an item, the global mesh size[37] applies. +A local mesh refinement specified on an entity is indicated by the + icon in the details tree. +Figure 306: An example of face that has a local mesh size specified in the details tree. +Related concepts +Details Tree +Applying a Local Mesh Size to a Wire, Edge, Face or Region +A local mesh size can be set on a wire, edge, face or a region to influence the mesh size. +The steps described below to define a local mesh size are similar for wires, edges and regions. +1. +2. +In the model tree, select the relevant part. +In the details tree select the wire, edge, face or region where you want to apply a local mesh +setting. +Tip: Multiple entities can be selected and edited simultaneously. +3. From the right-click context menu, click Properties. +4. On the Modify Face dialog, click the Meshing tab. +37. As specified on the Create mesh dialog. +Figure 307: The Modify Face dialog (Meshing tab). +Enable local mesh size for the selected item. +5. Under Mesh size, select the Local mesh size check box. +6. +In the Mesh size field, enter a local mesh size. +7. Click OK to set the local mesh size and to close the dialog. +8. Remesh the model to view the local mesh refinement. +Tip: Use a variable to define a local mesh size and simplify mesh convergence +investigations. +Refining the Mesh Around a Point +Define a mesh refinement rule around a specified point. Mesh elements in the vicinity of the point are +refined. Mesh refinement around a point is used when only a subset of a face, edge or wire needs to be +refined. +Figure 308: A plate with no point mesh refinement (on the left) and with point mesh refinement (to the right). The +transparent green sphere is the preview when the Create Point Refinement dialog is open and indicates the area +where the mesh refinement is specified. +1. On the Mesh tab, in the Refinement Rules group, click the + Point Refinement icon. +2. Under Position, specify the origin of the point where the mesh is to be refined. +3. +4. +In the Radius field, enter a value for the radius to specify the mesh area that is to be refined. +In the Mesh size field, enter a value for the mesh element length. +5. Enter a unique label for the point refinement. +6. Click Create to create the point refinement rule and to close the dialog. +The mesh refinement rule is added to the model tree, on the Configuration tab. +[Optional] Hide the display of mesh rules in the 3D view. +7. On the 3D View context tab, on the Display Options tab, in the Entity Display group, click the + Meshing Rules icon. +Refining the Mesh Along a Polyline +Define a mesh refinement rule along a specified polyline. Mesh elements in the vicinity of this polyline +are refined. Polyline mesh refinement is often used to refine the mesh under a cable, wire or a +transmission line. +Figure 309: A plate with no polyline mesh refinement (on the left) and with polyline mesh refinement (to the right). +The transparent green sphere is the preview when the Create Polyline Refinement dialog is open and indicates +the area where the mesh refinement is specified. +1. On the Mesh tab, in the Refinement Rules group, click the + Polyline icon. +2. Specify the polyline. +• To specify the corner points manually, specify the corner points in the table. +• To import the corner points from file, click Import points. +3. +4. +In the Radius field, enter a value for the radius to specify the mesh area that is to be refined. +In the Mesh size field, enter a value for the mesh element length. +5. Enter a unique label for the point refinement. +6. Click Create to create the polyline refinement rule and to close the dialog. +The mesh refinement rule is added to the model tree, on the Configuration tab. +[Optional] Hide the display of mesh rules in the 3D view. +7. On the 3D View context tab, on the Display Options tab, in the Entity Display group, click the + Meshing Rules icon. +Refining the Mesh Adaptively Using Error Estimates +Error estimates can be used to automatically place mesh refinement rules (point refinement) in the +model where the error is estimated to be large. Refining the model in the areas with the largest errors +results in a model where the errors are comparable everywhere in the model and produces a model with +increased accuracy without an excessive increase in mesh elements. +When a model has error estimates calculated, the error estimates can be used to define mesh +refinement rules. The model is then solved again and new mesh refinement rules are added where the +estimated error is large. This process is repeated until the model has sufficiently been refined. It is +recommended that you perform mesh convergence tests to confirm that the model is sufficiently refined +to produce the required level of accuracy. +The steps required to add additive mesh refinement points using error estimates follows: +1. Add an error estimate calculation request. +2. Specify the frequency or apply local mesh settings to allow the automatic mesh algorithm to +calculate and mesh the model. +3. Save the model. +4. Run the Solver to obtain a solution. +Figure 310: The result of the error estimation request viewed in POSTFEKO (with a cutplane) indicating the +areas with the highest errors in red. +Add an adaptive mesh refinement rule. +5. On the Mesh tab, in the Refinement Rules group, click the + Adaptive Mesh Refinement +icon. +The error estimate data (in the .bof file) is then matched with the mesh elements (for example, +triangle, segments) information (from the .fek file) to calculate the areas where the errors are +estimated to be the highest. +The actual point refinement rule is added to the model tree (Configuration tab) and is indicated by +the + icon. +Figure 311: The mesh is refined in the areas where errors are estimated to be the highest. The transparent +green spheres are a display setting and indicate areas where the mesh refinement is applied. Opacity was set +to 20% to highlight the green spheres. +6. +[Optional] Multiple iterations of adaptive mesh refinement can be applied by repeating Step 4 to +Step 5 for each iteration. +For each iteration, an adaptive mesh refinement rule is added to the model tree (Configuration +tab). +[Optional] Hide the display of mesh rules in the 3D view. +7. On the 3D View context tab, on the Display Options tab, in the Entity Display group, click the + Meshing Rules icon. +Related tasks +Requesting an Error Estimation +2.30.9 Mesh Editing +It is not possible to edit a simulation mesh directly, but you can unlink the simulation mesh and edit the +mesh part as though it is an imported mesh. A mesh part can also be replaced with a different mesh. +After the simulation mesh was unlinked, you can edit the mesh and remesh to obtain a new simulation +mesh or use the model mesh as the simulation mesh directly. +Related concepts +Model Mesh / Simulation Mesh +Altair Feko 2022.3 +2 CADFEKO +Related tasks +Unlinking a Mesh +Replacing a Mesh +Unlinking a Mesh +p.405 +When a mesh is unlinked, the simulation mesh is converted to a separate mesh part that can be edited. +1. +In the model tree, select the geometry or mesh part that has a corresponding simulation mesh. +2. Unlink the mesh using one of the following workflows: +• On the Mesh tab, in the Simulation Mesh group, click the + Unlink Mesh icon. +• From the right-click context menu, select + Unlink Mesh. +3. On the Unlink Mesh dialog, two options are available: +Figure 312: The Unlink Mesh dialog. +• Transfer solution entities to new port(s) check box cleared +Unlink the mesh and create a separate mesh part. Mesh ports are created but the +sources, loads and solution entities are not transferred. +• Transfer solution entities to new port(s) check box selected +Unlink the mesh and create a separate mesh part. Mesh ports are created but the +sources, loads and solution entities are transferred to the new ports on the separate +mesh part. S-parameter configurations are updated accordingly. +When the simulation mesh is unlinked, the geometry ports connected to the selected geometry +remain, but equivalent mesh ports are created with new labels. For example, if a geometry port +has the label “Port1”, the mesh port is labelled “Port1_1”. +4. Click OK to unlink the mesh and to close the dialog. +Replacing a Mesh +Replace mesh elements or update the mesh elements in a mesh part while keeping all the settings that +have been applied to the wires, faces and regions. +A typical workflow is to create a model with configurations, ports and mesh elements with applied +solution settings. The mesh is then exported and modified using third-party tools and then re-imported +into CADFEKO. This workflow eliminates the need to reapply solution settings and ports to the mesh +elements, provided that the mesh labels remain largely unchanged. +1. Ensure you have both the old and new mesh available in your model. +2. +In the model tree, select the mesh part to be replaced. +3. Replace the mesh using one of the following workflows: +• From the right-click context menu, click Replace With. +• On the Mesh tab, in the Replace group, click the + Replace With icon. +4. +In the model tree, select the replacement mesh part. +The old mesh is replaced and removed from the model. +When a mesh is replaced, solution settings and ports applied to the old mesh are transferred to the +new mesh. Mesh properties of mesh labels that are new and only present in the new mesh, are set to +the default mesh properties. Default mesh properties include faces set to PEC, wires set to PEC and the +front and back medium of a face set to free space. +Mesh labels that were in the old mesh but no longer present in the new mesh, will not affect the mesh, +but could affect the solution and request items that use labels. For example, ports and requests with +scope options (far fields, near fields, error estimates and currents). +2.30.10 Batch Meshing +A stand-alone batch meshing tool can be called from the command line to mesh a model and modify +variable values in a CADFEKO model file, without launching the CADFEKO GUI. +During the optimisation process, OPTFEKO calls the batch meshing tool to mesh the model for each +optimisation run. +Launch the CADFEKO batch mesher using the command: +cadfeko_batch [options] +filename +The file name of an existing CADFEKO model (with or without the +.cfx file extension). The path may be included in the file name. +The command line options are: +--version +-#var=value +--run-from-gui +--cable-seed +Output only the version information to the command line and then +terminate. No file name is required to use this option. +Allows variables to be assigned new values before re-evaluation +and meshing. Multiple variables may be included. For example, to +set variables “a” and “b” to 1, the options should contain ...-#a=1 +-#b=1... ). +This uses a special execution mode for the GUI. In this mode, +additional information regarding the progress of each phase of the +model re-evaluation and meshing is included in the screen output. +This option rearranges the cables in a cable bundle to a new +random location. +After the model is re-evaluated and meshed, the modified CADFEKO model replaces the existing .cfx +file as well as the .cfm, .pre, .opt and .pfg files. +If new variable values cause an error during re-evaluation or meshing, the batch meshing is aborted +and an error reported. If any suspect entities are found in the model after re-evaluation, the meshing +are completed, the new model is created, but an error will be reported. The error is reported for all +suspect items, even if they were not introduced due to changes made by the batch-mesher. +If the solution configuration is deactivated in the CADFEKO model, or if the .pre file has been edited +outside of CADFEKO, then the .pre file is not overwritten. +Related tasks +Defining a Cable Bundle +Using Batch Meshing to Mesh a Model +A simple example is given to show how to mesh an existing model or modify multiple variables and +remeshing the model. +As an example, Example 1 of the Feko Example Guide will be meshed using the batch meshing tool +(Dipole_Example.cfx). +1. Open the Feko terminal. +2. +[Optional] Change the directory to where the file is located. +Note: If the directory is not changed to where the file is located, the path can be +included in the file name. +3. Launch the batch meshing tool and mesh (without modifying the values of any variables). +cadfeko_batch Dipole_Example.cfx +4. Launch the batch meshing tool, modify the variables h and radius, re-evaluate and remesh the +model. +cadfeko_batch Dipole_Example.cfx -#h=lambda/4 -#radius=1.8e-3 +2.31 Working with CADFEKO Models in EDITFEKO +A CADFEKO.cfm file can be imported into EDITFEKO to make use of more advanced features available +in EDITFEKO and to directly edit the .pre file for more flexible solution configurations. +2.31.1 Modification of the Model in EDITFEKO +Modification of CADFEKO models in EDITFEKO is considered to be an advanced workflow with important +considerations. +CADFEKO writes a .pre file when the model is saved. The .pre file can be modified manually with +EDITFEKO. In EDITFEKO changes can be made such as adding custom frequency loops. When the +model is saved again in CADFEKO, the modified .pre file will trigger a prompt in CADFEKO asking +whether a copy of the .pre file (modified in EDITFEKO) should be saved. Clicking No will overwrite +the changes made in EDITFEKO. Clicking Yes will save a copy of the .pre file. The copy uses the +naming convention, _modified_n.pre, where the part is the original +filename in CADFEKO and the part _modified_n is an extension chosen to ensure that no existing file is +overwritten. Repeated modifications are retained by the counter, n. +2.31.2 Units +When working with a CADFEKO model in EDITFEKO, the units are considered to be in metres. +Use an SF card in the geometry section of the .pre file to specify the units. For example, if the model +was constructed in millimetres, an SF card with a 0.001 scale factor should be added to the .pre file. +Tip: Place the SF card at the beginning of the .pre file. +2.31.3 Reference Elements +In EDITFEKO, properties can be set on specific elements using their full labels. +Segments have the label of the edge (typically called Wire), triangles that of the face (typically Face) +and tetrahedra that of the dielectric region (typically Region). These labels can be modified on the +geometry or the mesh elements. +Since setting sources or loads on wire segments require unique labels, CADFEKO exports the port +segments with unique labels. These labels are created by appending the port name to the wire label. +For example, if Port1 is located on the centre segment of Line1.Wire1, this segment will be written with +the label Line1.Wire1.WirePort1 while the remaining segments will have the label Line1.Wire1. +For vertex ports, the associated segment is the shorter segment connected to the vertex. Use +POSTFEKO to check which segment was relabelled. +2.31.4 Variables and Named Points in EDITFEKO +When exporting a .cfm file, CADFEKO evaluates all named points and variables and writes their +numerical values to the file. +If requested in the IN card settings, these variables and named points are then imported by PREFEKO +and can be referenced in the .pre file at any point after the IN card. +2.31.5 Media +Media can still be defined and applied to regions or mesh elements in CADFEKO, but in the .pre file, the +DI card must reference the name of the medium specified in CADFEKO. +2.32 Validating the CADFEKO Model +During the design process, the development of a model can introduce a range of issues that can lead to +a non-simulation-ready model. Use the validation toolset to verify that the model is simulation-ready or +to search, detect and flag discrepancies. +Use the validation toolset to verify the following: +• Fix the settings of an item in the model that is unresolved or invalid (suspect item). +• Verify that the windscreen is defined correctly by viewing the thickness of the individual layers. +• Verify that the mesh is connected. +• Use display options to colour regions and faces according to their media. +• Use display options to highlight the relevant geometry with a specified solution method. +• Search for clashing geometry. +• Search for distorted, intersecting and oversized mesh elements. +• Use cutplanes to cut through a model to view inside the model. +2.32.1 Suspect Items +An item is marked suspect when changes in the model result in the settings of an item becoming +unresolved or invalid. +A suspect item is indicated by a + icon in the model tree or details tree. Move the mouse cursor over +the + icon to view the tooltip and the reason why it is marked suspect. +Figure 313: An example of a suspect item and its tooltip in the model tree. +Examples of situations where items can become suspect; +• If a lossy conducting surface is set on a face bordered by free space and one of the bordering +regions is set to PEC, the unsupported lossy conducting surface is removed. The face is marked +“suspect” and its medium displayed as PEC in the details tree. +• If a port becomes invalid due to a change in the model, the port is marked “suspect”. +Note: Resolve all suspect items before launching the Solver or OPTFEKO. The loss of +properties on the model geometry may change the electromagnetic problem description and +impact the computed results. +Tip: Set the correct properties on the item and remove the suspect icon. From the right- +click context menu select Set Not Suspect. +Related concepts +Edges and Wires (Geometry) +Faces (Geometry) +Regions (Geometry) +2.32.2 Displaying Windscreen Thickness +When defining a windscreen, the layer thickness is not displayed by default. Enable the windscreen +layer thickness to visually verify that the model is correct. +On the 3D View context tab, on the Display Options tab, in the Style group, click the + Windscreen Layers icon. +Figure 314: An example of a windscreen showing the individual layer thickness. +Altair Feko 2022.3 +2 CADFEKO +2.32.3 Cutplanes +p.412 +A cutplane is a display option that creates a plane at a designated location that cuts through an object +to create a sectional view. Create multiple cutplanes to create a sectional view that exposes inner +details that would otherwise not be visible from outside the model. +On the 3D View context tab, on the Display Options tab, in the Cutplanes group, click the + Create icon. +Three (default) cutplanes coincident with the main axes are accessible from the model tree under the +Cutplanes group. +Figure 315: A simple example of a cutplane preview. The cutplane cuts through a larger sphere revealing a smaller +sphere inside. +To add more cutplanes, click Create. Each cutplane is listed under the Cutplanes group. +The operation of the cutplane can be reversed, hiding the visible region and showing the invisible +region. On the Create/Modify Cutplane dialog, select Flipped, or in the tree, from the right-click +context menu for the cutplane, click Flip cutplane. +To activate/deactivate a cutplane, click the icon for the cutplane. To modify, select the label. +Filter Cutplanes +When more than one 3D view is used, the already active cutplanes can be modified on a per-view basis +using the Filter tool. +On the 3D View context tab, on the Display Options tab, in the Cutplanes group, click the + Filter +icon. +On the Filter Cutplanes dialog, select the checkbox(es) for the cutplane(s) to be disabled. +Note: The filter cutplanes tool is applied to the selected 3D view. +Figure 316: The Filter Cutplanes dialog. +2.32.4 Geometry Highlighting for Applied Solution +Methods +Before running the Solver, you can verify that the correct solution settings are applied to the geometry. +Use the tool to highlight all the relevant geometry in the 3D view with a specific solution method +applied. +The following solution parameters can be highlighted in the 3D view (while the display of all other +geometry is semi-transparent): +• PO faces +• RL-GO faces +• UTD faces +• Faces with thin dielectric sheets +• Faces and wires with coatings +• Impedance sheets +• Windscreen reference +• Windscreen solution elements +• VEP regions +• FEM regions +• Faces containing planar Green's function apertures +• Parts solved with the numerical Green's function +• Characterised surfaces +On the Solve/Run tab, in the Validate group, click the + View by Solution icon. +Figure 317: The View by Solution Parameters dialog. +2.32.5 Colour Display Options +A number of display options are available to colour regions and faces according to their media. +On the 3D View context tab, on the Display Options tab, in the Style group, click the Colour icon. +Table 13: Colour display options. +Icon Icon text +Description +Element normal +All parts display with the same colour. The two sides of faces +are coloured differently to indicate the normal direction of +the faces. +• On the geometry, the normal side of each element is +coloured green, while the reverse side is coloured red. +• On the mesh, the normal side of each element is +coloured blue, while the reverse side is coloured brown. +Region medium +Regions are coloured according their assigned media. +Surface mesh elements are coloured on each side according +to the medium on that side of the face. +For example, when viewing the mesh of a dielectric/metallic +object, the entire object has the colour of free space when +viewed from the outside. When viewed from the inside +(utilising a cutplane or after hiding faces) the colour is +Icon Icon text +Description +consistent with the dielectric/metallic medium of the inside +region. +When viewing the geometry, regions are displayed using the +colour of the internal medium (whether viewed from outside +or inside the region). If the display of the segment radii +and coatings are activated on wire mesh elements, these +are coloured according to the core medium or the layered +medium (coating) for that wire. +The faces are displayed according to the medium of each +face. +When viewing the mesh, the display of segment radii is +automatically activated for wire elements in the mesh +and these are coloured according to the core medium. +(The segment radii display may be manually deactivated if +required, in which case no specific colouring will be shown +for wire elements in the mesh.) +The faces are displayed according to the material colour on +the two sides of the face. For example, an object in free +space will have the colour of free space (red by default) on +the outside of the object. +Face medium +Face normal medium +2.32.6 Mesh Connectivity +After applying union or stitching operations, you can verify that all the intended edges are connected. A +face with unbounded edges could indicate an unconnected mesh. +On the 3D View context tab, on the Display Options tab, in the Style group, click the + Connectivity icon. +Figure 318: An example showing mesh connectivity. Faces with unbounded edges are shown in red. +2.32.7 Geometry and Mesh Consistency Checks +Searching for Clashing Geometry +Parts clash if there is contact between the parts without a mesh connection or if one is completely inside +another. These disconnected mesh elements need to be either connected or removed before running a +simulation to obtain an accurate result. +1. Select the model or geometry part either in the model tree or 3D view. +2. On the Mesh tab, in the Find group, click the + Clashing Geometry icon. +Figure 319: The Find Clashing Geometry Elements dialog. +3. Specify the parts to be searched for clashing geometry elements. +• To search the full model, under Search, click Entire model. +• To search only the selected part of the model, under Search, click Selection. +4. Click OK to search for clashing geometry elements and to close the dialog. +Tip: Create a union where a part is contained in another. +The result of the search is displayed in the Model Status and on the Message Details dialog. Any parts +containing clashing geometry are selected in the model tree and in the 3D view. A hyperlink to the part +containing the clashing geometry is also given in the Model Status and on the Message Details dialog. +Searching for Distorted Mesh Elements +A distorted mesh element is a distorted (high aspect ratio) triangle. Distorted mesh elements can result +in decreased accuracy of the results and could lead to poor convergence for iterative solvers. +The Solver does not directly search for distorted mesh elements, but the consequence of distorted mesh +elements is that the condition number for the method of moments (MoM) matrix increases. +Note: The Solver will give a warning or error if the condition number becomes too high. The +condition number can also be too high for very low frequency problems. +Distorted mesh elements are specified in terms of the minimum internal angle. In an ideal mesh, all +internal angles are 60°, but this rarely possible. If any of the three angles in a mesh element are very +small, the element is considered a sliver element. +Tip: Remove sliver elements by deleting mesh vertices or redundant geometry points. +1. Select the model mesh or mesh part either in the model tree or 3D view. +2. On the Mesh tab, in the Find group, click the + Distorted Elements icon. +Figure 320: The Find Distorted Mesh Elements dialog. +3. Specify the parts to be searched for distorted mesh elements. +• To search the full model, under Search, click Entire model. +• To search only the selected part of the model, under Search, click Selection. +4. Specify the mesh parts to be searched for distorted mesh elements. +• To search only the simulation mesh, under Mesh Scope, click Simulation. +• To search only the model mesh, under Mesh Scope, click Model. +• To search both the model and simulation meshes, under Mesh Scope, click Both. +5. +In the Minimum internal angle field, enter a value for the minimum internal angle of a triangle. +Any internal angles found to be smaller than the minimum angle will be listed. +6. Click OK to search for distorted mesh elements and to close the dialog. +The result of the search is displayed in the Model Status and on the Message Details dialog. A +hyperlink to the mesh part containing the distorted mesh elements is also given in the Model Status and +on the Message Details dialog. +Searching for Intersecting Mesh Elements +Imported meshes often contain intersecting mesh elements. These intersecting mesh elements need to +be either repaired or removed to obtain accurate results. +Intersecting mesh elements can overlap (entirely or partially) or intersect other mesh elements, while +not electrically connected at the point of intersection. +1. Select the model or geometry part either in the model tree or 3D view. +2. On the Mesh tab, in the Find group, click the + Intersecting Triangles icon. +Figure 321: The Find Intersecting Mesh Elements dialog. +3. Specify the parts to be searched for intersecting mesh elements. +• To search the full model, under Search, click Entire model. +• To search only the selected part of the model, under Search, click Selection. +4. Click OK to search for intersecting mesh elements and to close the dialog. +The result of the search is displayed in the Model Status and on the Message Details dialog. Any parts +containing intersecting mesh elements are selected in the model tree and in the 3D view. A hyperlink +to the part containing the intersecting mesh elements is also given in the Model Status and on the +Message Details dialog. +Searching for Oversized Mesh Elements +An oversized mesh element is a triangle with an edge length larger that the specified maximum edge +length. Oversized mesh elements can lead to reduced accuracy in the results. +1. Select the model or geometry part either in the model tree or 3D view. +2. On the Mesh tab, in the Find group, click the + Oversized Elements icon. +Figure 322: The Find Oversized Mesh Elements dialog. +3. Specify the parts to be searched for oversized mesh elements. +• To search the full model, under Search, click Entire model. +• To search only the selected part of the model, under Search, click Selection. +4. Specify the mesh parts to be searched for oversized mesh elements. +• To search only the simulation mesh, under Mesh Scope, click Simulation. +• To search only the model mesh, under Mesh Scope, click Model. +• To search both the model and simulation meshes, under Mesh Scope, click Both. +5. +In the Length field, enter a value that is taken as the upper limit for the triangle edge length. Any +triangle edge length longer than this length will be marked as oversized. +6. Click OK to search for oversized mesh elements and to close the dialog. +The result of the search is displayed in the Model Status and on the Message Details dialog.. A +hyperlink to the part containing the oversized mesh elements is also given in the Model Status and on +the Message Details dialog. +Altair Feko 2022.3 +2 CADFEKO +2.33 Solver Settings +p.420 +The default solver used in Feko is the method of moments (MoM) - surface equivalence principle (SEP). +A solver is specified per model, per face or per region, and depends on the solver in question. +Table 14: The available solvers in Feko and where these solvers are specified. +Solvers +Per model +Per face +Per region +MoM (SEP) +Default solver +Full-wave +MoM (VEP) +MLFMM +FEM +FDTD +ACA +PO & LE-PO +High frequency +RL-GO +UTD +A number of advanced settings are available for each solver, but it is recommended to use the default +settings. The incorrect application of these advanced settings may result in poor result accuracy or +inefficient calculations. +2.33.1 Defining Symmetry in the Model +Define and exploit the symmetry in the model (where applicable). +1. On the Solve/Run tab, in the Solution Settings group, click the + Symmetry icon. +Figure 323: The Symmetry Definition dialog. +2. Under Planes of symmetry, select one of the following for the relevant planes: +• No symmetry +• Geometric symmetry +• Electric symmetry +• Magnetic symmetry +3. Click OK to set the symmetry and to close the dialog. +Figure 324: Example of a horn antenna with magnetic symmetry (in grey) defined at the X=0 plane and +electric symmetry (in brown) defined at the Y=0 plane. +4. +[Optional] Hide the display of the symmetry planes in the 3D view. On the 3D View context tab, +on the Display Options tab, in the Solver Display group, click the + Symmetry icon. +2.33.2 General Solver Settings +General solver settings are available that relate to geometry tests and data storage precision. +On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. +Geometry Tests +Activate normal geometry checking +This option allows geometry elements in the model to be analysed for typical user errors. These +errors could be due to geometry parts that have not been unioned, or poor meshing such as +wrong element sizes or meshing connection issues. +The following checks are performed: +• Verify that triangle elements on connecting surfaces have identical edge lengths. +• Verify that connection points coincide. +• Verify appropriate element sizes. +• Verify appropriate segment length to radius ratios. +Activate mesh element size checking +This option activates the verification of the mesh size in relation to the frequency. +Export to the Feko *.out file +This option allows the geometry data of the mesh elements to be written to the .out file. +Data Storage Precision +Single precision +This option sets certain memory-critical arrays to be stored in single precision. Single precision is +the recommended and the default option. +Double precision +This option sets certain memory-critical arrays to be stored in double precision. Double precision +is to be used when an error or warning message is displayed by the Solver suggesting that +double precision be used. This could happen for example at very low frequencies where increased +accuracy is required. +Thermal Analysis +Export files for thermal analysis (*.epl, *.nas, *.map) +This option allows the export of files for thermal analysis. The EM losses are exported to the +element power loss (.epl) file and the geometry info is exported to a NASTRAN (.nas) file and +label mapping (.map) file. +2.33.3 Advanced Solver Settings +Advanced solver settings are available to reduce the memory footprint or speed up a solution for +specific types of models. +On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. On the +Solver settings dialog, click the Advanced tab. +Factorisation for Parallel Execution +This option allows you to select between using standard full-rank factorisation or block low-rank (BLR) +factorisation when using the parallel solver. Changing the factorisation method can reduce the memory +footprint of the sparse LU-based preconditioners in some models where the solution methods are +MLFMM or FEM. +Default +This option applies the predefined factorisation type adopted by the Solver. +Auto +This option applies automatically the optimum factorisation type based on the model. +Use standard full-rank factorisation +This option applies the standard full-rank factorisation. +Use block low-rank (BLR) factorisation +This option applies the block low-rank (BLR) factorisation. +Tip: In most cases default gives the best performance. +Compression for Looped Plane Wave Sources +This option is an accelerated method that can be used to speed up the solution for a model that +contains a plane wave source that loops over multiple directions (for example, when calculating RCS). +Related concepts +Preconditioners for MLFMM +Preconditioners for FEM +2.33.4 Store and Reuse Solution Files +For large models, the runtime can be reduced if the solution coefficients are saved during the solution +phase and re-used in a subsequent solution. +Note: For smaller models (where the run time is short), storage of the solution coefficients +is typically not required. Storage of solution coefficients creates large files for models with +many mesh elements. +On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. +Altair Feko 2022.3 +2 CADFEKO +Save/read matrix elements +p.424 +This option allows you to save or read from a .mat file. The .mat file is used to store the matrix +elements of a linear equation system (MoM models only.) +Save/read LU decomposed matrix +This option allows you to save or read the .lud file. The .lud file is used to store the elements of +the LU-decomposed MoM matrix. +Save/read currents +This option allows you to save or read the .str file. The .str file is used by default to allow fast +solutions in cases where only the output requests are modified (without changing the rest of the +model). +Save/read cable per-unit-length parameters +This option allows you to read or write a .pul file. The .pul files are used by default to allow the +saving of cable per-unit-length parameters between frequency runs to allow fast solving of cable +harnesses. +Store convergence data (*.cgm file) for iterative solvers +This option allows the residue of the iterative solutions to be written to a .cgm file. Use this option +to inspect convergence behaviour. +Note: The data is saved but not re-used. +Note: +The saving of .mat, .lud, .cgm and .pul (for parallel runs) files is only possible if the model +directory is on a shared location accessible by all processes. +2.33.5 Method of Moments (MoM) +The MoM is a full wave solution of Maxwell’s integral equations in the frequency domain. +Surface Equivalence Principle (SEP) +The default solver in Feko is the method of moments (MoM) using surface equivalence principle (SEP). +The SEP introduces equivalent electric and magnetic currents on the surface of a closed dielectric body. +The surface of such bodies can be arbitrarily shaped and is discretised using triangles. +Volume Equivalence Principle (VEP) +Volume equivalence principle (VEP) is an extension to the method of moments (MoM) for the modelling +of dielectric bodies. The regions of such bodies can be arbitrarily shaped and are discretised into +tetrahedra. +Solving a Model with VEP +To solve a model with the volume equivalence principle (VEP), you must activate VEP for each relevant +region. +1. Select the region (or regions) in the 3D view or in the details tree that you want to solve with VEP. +2. +In the details tree, from the right-click context menu, select Properties. +3. On the Modify Region dialog, click the Solution tab. +4. Under Solution method, from the drop-down list, select MoM/MLFMM with volume +equivalence principle (VEP). +Figure 325: The Modify Region dialog (Solution tab). +5. Click OK to save the region properties and to close the dialog. +Higher Order Basis Functions (HOBF) +Higher order basis functions (HOBF) use higher order polynomial basis functions to model the currents +on any particular mesh element. +HOBF is supported by the following solution methods: +• Method of moments (MoM) (including hybridisation with UTD and RL-GO) +• Multilevel fast multipole method (MLFMM) +Using HOBF allows the geometry to be meshed with larger triangles while obtaining the same solution +accuracy. These larger and coarser mesh elements reduce the total number of mesh elements. In most +cases the total unknowns are reduced. This leads to a reduction in solution time and memory. +Feko uses hierarchical basis functions to increase the basis function order of any triangle as required. +Small geometric details of a model will be meshed with electrically small mesh elements, while larger +details are meshed with coarser mesh elements. When the Solver automatically performs order +selection for the model, higher order basis functions are applied to electrically large mesh elements, +while lower order basis functions are applied to electrically smaller mesh elements. With this adaptive +scheme, the Solver automatically ensures high fidelity MoM solutions, using as little memory as possible +and fastest possible solution times. +Note: HOBF is also supported for curvilinear mesh elements. +Setting HOBF Globally on a Model +Enable higher order basis functions on a model to allow the model to be meshed with larger triangles. +1. On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. +2. On the Solver settings dialog, click the General tab. +3. Under Basis function control, select the Solve MoM with higher order basis functions +(HOBF) check box. +Figure 326: A snippet of the Solver Settings dialog (General tab, Basis function control group). +4. +In the Element order drop-down list, select one of the following options: +• To allow the Solver to select the most appropriate order, select Auto (default). The order is +chosen by the Solver based on the size of the element and neighbouring elements as well as +the specified Range selection. +• To specify the order of the basis function, select one of the predefined orders (0.5, 1.5, 2.5 +and 3.5). +5. +In the Range selection drop-down list, select one of the following options: +• To allow the Solver to select the most appropriate range selection, select Normal +(recommended). +• To allow the use of higher orders that result in a more accurate solution, but at the cost of +an increase in runtime and memory, select Prefer higher orders (more accurate, slower, +more memory). +• To allow the use of lower order basis functions that result in a less accurate solution, but with +a shortened runtime and a decrease in memory, select Prefer lower orders (less accurate, +faster, less memory). +6. Click OK to close the dialog. +Setting HOBF Locally on a Face +Enable higher order basis functions on a face to allow the face to mesh with larger triangles. +Note: Ensure HOBF is enabled globally, else the local HOBF setting will not be applied. +1. Select the part in the model tree (Construct tab). +2. +In the details tree, select the face where you want to apply HOBF. +3. From the right-click context menu, click the Properties tab. +4. On the Modify Face dialog, click Solution tab. +Figure 327: The Modify Face dialog (Solution tab). +5. +In the Element order drop-down list, select one of the following options: +• To allow the Solver to select the most appropriate order, select Auto (default). The order is +chosen by the Solver based on the size of the element and neighbouring elements as well as +the specified Range selection. +• To specify the order of the basis function, select one of the predefined orders (0.5, 1.5, 2.5 +and 3.5). +6. +In the Range selection drop-down list, select one of the following options: +• To allow the Solver to select the most appropriate range selection, select Normal +(recommended). +• To allow the use of higher orders that result in a more accurate solution, but at the cost of +an increase in runtime and memory, select Prefer higher orders (more accurate, slower, +more memory). +• To allow the use of lower order basis functions that result in a less accurate solution, but with +a shortened runtime and a decrease in memory, select Prefer lower orders (less accurate, +faster, less memory). +7. Click OK to close the dialog. +Characteristic Basis Functions Method (CBFM) +Characteristic basis functions are special basis functions for the method of moments defined on large +domains (blocks) that contain large numbers of sub-domains meshed into triangles. +The CBFM reduces the total number of unknowns by discarding a number of insignificant basis functions +based on a certain threshold. This leads to a reduction in solution time and memory. +Note: The usage of CBFM with MLFMM is generally needed to realize the benefits of the +CBFM for most practical problems. +This combination is currently not supported and in many cases, using MLFMM rather than +MoM/CBFM may be preferred. +The combination of CBFM with MLFMM will be added in the following release. +Note: Curvilinear mesh elements are not supported. +Solving a Model with CBFM +To solve a model with the CBFM, you must activate it for the entire model. +1. On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. +2. On the Solver settings dialog, General tab, in the Characteristic basis function method +(CBFM) group, click Enable CBFM for MoM. +3. Click OK to close the dialog. +Low-Frequency Stabilisation +At very low frequencies (frequency range where the largest dimension of the model is much smaller +than a wavelength), the method of moments (MoM) solution can become numerically unstable and +singular. +The default MoM solution uses single precision. When using double precision, the MoM solution is valid +for lower frequencies than for single precision. If the solver gives a warning about the matrix stability +when using double precision, then it is recommended to use low-frequency stabilisation. +Note: Low-frequency stabilisation is not required at higher frequencies and increases the +runtime. Double precision uses double the memory of single precision. +Activating Low-Frequency Stabilisation for MoM +For very low-frequency method of moments (MoM) solutions, enable low-frequency stabilisation to +ensure a valid solution over the full frequency range. +1. On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. +2. On the Solver Settings dialog, click the General tab. +3. Under Low frequency modelling, select the Activate low frequency stabilisation for MoM +check box. From the drop-down list, select one of the following: +Auto +This option allows the Solver to determine automatically if the low frequency stabilisation +should be used for the model. +Altair Feko 2022.3 +2 CADFEKO +Always on +This option enables the low frequency stabilisation for the model. +p.429 +Figure 328: A snippet of the Solver settings dialog (General tab, Low frequency modelling group). +4. Click the OK to close the dialog. +Numerical Green's Function (NGF) +In the solution of large electromagnetic problems solved using the method of moments (MoM), +sometimes a considerable part of the geometry remains unchanged, while only a small part changes. +The unchanged part (static interaction matrix) can be saved to a .ngf file and reused to reduce CPU +time. +Tip: To obtain a reduction in CPU time, domain decomposition is recommended for MoM +models consisting of a large static part and a smaller dynamic part. +A static part is indicated by the + icon in the model tree. +The following restrictions apply with respect to the NGF: +• The NGF can only be activated on a part. Selecting a sub-part and activating the NGF will activate +the NGF for the entire part. +• The NGF is not supported in conjunction with continuous frequency simulations. +• When the NGF is activated for a part, the following cannot be modified: +◦ geometry +◦ +the solution method +◦ media +◦ ports added or deleted +◦ +◦ +loads +transmission lines +◦ general networks +The part is essentially “locked”. It is allowed to add or remove sources from the part. +Using the Numerical Green's Function to Reduce CPU Time +For a method of moments (MoM) model, specify the static part. The part is saved and locked to prevent +modification. Save the static interaction matrix to a .ngf file and reuse the file. +1. On the Solve/Run tab, in the Solution Settings group, click the + NGF icon. +Figure 329: The Numerical Green's Function (NGF) Settings dialog. +2. Ensure the Enable the numerical Green's function check box is selected. +3. To lock the static part, ensure the Lock static parts check box is selected. +Note: A locked part cannot be modified or deleted. If the frequency is changed or face +properties are modified, it is recommended to unlock and remesh the part. +4. Add a part or model mesh to the list of static parts. +a) Click on the relevant part in the 3D view or model tree. +5. Click OK to close the dialog. +The static part is locked and cannot be modified. An active NGF part is indicated by the + icon in +the model tree. +Note: To disable the NGF for a part, clear the Enable the numerical Green's +function check box. +Defining an Aperture in an Infinite PEC Plane +Model a slot or aperture in an infinite plane using the planar Green's function aperture. The aperture is +discretised instead of the surrounding ground plane, reducing the number of triangles and run time. +1. Create the geometry to model the aperture or slot in the infinite PEC plane. For example, create a +rectangle to represent the aperture. +2. Select the “aperture” in the 3D view or in the model tree. +3. +In the details tree, from the right-click context menu, select Properties. +4. On the Modify Face dialog, click the Solution tab. +5. Under Solve with special solution method, from the drop-down list, select Planar Green's +function aperture. +Figure 330: The Modify Face dialog (Solution tab). +6. Click OK to model the aperture as a planar Green's function aperture and to close the dialog. +2.33.6 Multilevel Fast Multipole Method (MLFMM) +The multilevel fast multipole method (MLFMM) is a current-based method applicable to electrically large +structures. +Solving a Model with the MLFMM +To solve a model with the multilevel fast multipole method (MLFMM), you must activate MLFMM for the +model. +1. On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. +2. On the Solver settings dialog, click the MLFMM / ACA tab. +3. Click Solve model with the multilevel fast multipole method (MLFMM). +Figure 331: The Solver Settings dialog (MLFMM / ACA tab). +4. Click OK to close the dialog. +Altair Feko 2022.3 +2 CADFEKO +MLFMM Settings +p.432 +A number of optional settings are available when using multilevel fast multipole method (MLFMM) to +solve a model. +Note: It is recommended to use the default settings. Modifying the advanced settings can +impact accuracy and/or run time. +Activate additional stabilisation for the MLFMM +Select this option to activate additional stabilisation for a model with severe convergence +problems. +Field calculation methods +Near-field +The MLFMM uses a fast near field calculation method (default), but in some cases the +traditional integration method could be used. +Far field +The MLFMM method uses a fast far field calculation method (default), but in some cases the +traditional integration method could be used. +Box size at finest level +The MLFMM is based on a hierarchical tree-based grouping algorithm and depending on the +frequency and the model dimensions, the Solver automatically determines the number of levels +in this tree and the size of the boxes at the finest level. This option allows you to adjust the box +size. Adjusting the box size can improve convergence in some cases. The box size is specified in +terms of the wavelength. The default is 0.23 and the minimum value should be larger than 0.2. +Increasing the box size increases the memory requirement. +Tip: Make incremental changes of 0.03 at a time. +Preconditioners for MLFMM +A few preconditioners are available for the multilevel fast multipole method (MLFMM). +Note: +• It is recommended to use the default settings. Changing the preconditioner is +recommended only for advanced users. +• The number in brackets corresponds to the value of the I3 field at the CG card in the +model .pre file. +On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. On the +Solver Settings dialog, click the Advanced tab. +Figure 332: The Solver Settings dialog (Advanced tab). +Multilevel FEM-MLFMM LU/diagonal decomposition (2010) +Preconditioner for a hybrid MLFMM / FEM solution that uses a multilevel sparse LU decomposition +of the combined and partitioned system. +When using the parallel Solver, the factorisation type, which slightly impacts runtime and +memory, can be specified. +Sparse approximate inverse (SPAI) (8192) +Preconditioner for an MLFMM solution. This preconditioner uses less memory than the default in +most cases, but runtime could be longer. +Sparse LU (8193) +Preconditioner for an MLFMM solution that uses a sparse LU decomposition of the MLFMM near +field matrix. +When using the parallel Solver, the factorisation type, which slightly impacts runtime and +memory, can be specified. +Note: The SPAI (8192) and Sparse LU (8193) are the recommended preconditioners for +MLFMM without FEM. +Related concepts +Factorisation for Parallel Execution +Related reference +CG Card +2.33.7 Modifying the Integral Equation Method +When using the MLFMM, you can specify the integral equation to obtain faster iterative convergence. +1. +If the model will be solved using the multilevel fast multipole method (MLFMM) activate the +MLFMM. +2. Select the face(s) of the enclosed volume in the in the 3D view or in the details tree. +3. +In the details tree, from the right-click context menu, select Properties. +Figure 333: The Modify Face dialog (Solution tab). +4. On the Modify Face dialog, click the Solution tab. +5. From the Integral equation drop-down list, select one of the following options. +• Combined field +Solve the model using a combination of the electric field integral equation (EFIE) and +magnetic field integral equation (MFIE). This is known as the combined field integral +equation (CFIE). +• Electric field +Solve the model using the electric field integral equation (EFIE). +• Magnetic field +Solve the model using the magnetic field integral equation (MFIE). +Note: The electric field integral equation (EFIE) is the default and is valid for all +geometries (open, fully enclosed, metallic and dielectric). +6. Click OK to save the face properties and to close the dialog. +Related concepts +Integral Equation Methods (EFIE, MFIE and CFIE) +Using the CFIE For Closed PEC Regions +When solving an enclosed perfectly conducting metallic region using the MLFMM, the CFIE can be used +to improve the iterative solver convergence. +1. Ensure the multilevel fast multipole method (MLFMM) solver is activated for the model. +2. Select the faces of the enclosed volume in the in the 3D view or in the details tree. +3. +In the details tree, from the right-click context menu, select Properties. +4. On the Modify Face dialog, click the Solution tab. +5. From the Integral equation drop-down list, select Combined field[38]. +6. Click OK to save the face properties and to close the dialog. +Related concepts +Integral Equation Methods (EFIE, MFIE and CFIE) +Modifying the CFIE Factor +Activate the combined field integral equation (CFIE) for the model and specify the factor for the linear +combination of the magnetic field integral equation (MFIE) and the electric field integral equation +(EFIE). +1. On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. +2. On the Solver Settings dialog, click the Advanced tab. +3. Under Integral equation settings, select the CFIE factor check box and in the edit field, enter a +value for the CFIE factor where 0 < CFIE factor < 1. +Note: The default factor is 0.2. This is a ratio of 20% MFIE to 80% EFIE. +Figure 334: The Solver Settings dialog (Advanced tab). +4. Click OK to close the dialog. +Related concepts +Integral Equation Methods (EFIE, MFIE and CFIE) +38. +combined field integral equation (CFIE) +2.33.8 Adaptive Cross-Approximation (ACA) +The adaptive cross-approximation (ACA) is a fast method, similar to multilevel fast multipole method +(MLFMM). The method improves the solution of certain complex method of moments (MoM) problems +using less memory and run-time. +The ACA method does not suffer from low-frequency breakdown and is also applicable to using the +special Green's function. +Solving a Model with Adaptive Cross-Approximation (ACA) +For complex, method of moments (MoM) problems, solve the model with the adaptive cross- +approximation (ACA) to reduce memory and run-time. +1. On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. +2. On the Solver Settings dialog, click the MLFMM / ACA tab. +3. Click Solve model with adaptive cross-approximation (ACA). +Figure 335: The Solver Settings dialog (MLFMM / ACA tab). +4. Click the OK button to close the dialog. +2.33.9 Finite Element Method (FEM) +The finite element method (FEM) is a volume meshing technique used to model electrically complex or +inhomogeneous dielectric bodies. +Solving a Region with FEM +To solve a model with the finite element method (FEM), you must activate the FEM for each relevant +region. +1. Select the region(s) in the 3D view or in the details tree that you want to solve with the FEM. +2. +In the details tree, from the right-click context menu, select Properties. +3. On the Modify Region dialog, click the Solution tab. +4. Under Solution method, from the drop-down list, select Finite Element Method (FEM). +5. +[Optional] Under Element order control, select the Local element order control check box to +specify the element order locally per region. +This setting takes precedence over the element order set globally per model. Use First order +only (reduced accuracy) to reduce the required memory and run-time for regions with fine +details where the geometric details (and resulting mesh) are very fine. +6. Click OK to save the region properties and to close the dialog. +Related concepts +Element Order Per Model +FEM Parameters +Optional parameters can be used with the finite element method (FEM) to save memory and runtime in +specific cases. +On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. On the +Solver Settings dialog, click the FEM tab. +Figure 336: The Solver Settings dialog (FEM tab). +Decouple from MoM (use FEM absorbing boundary condition) +This option removes the influence of the FEM region (the tetrahedral elements and any conducting +surfaces on their boundaries) on the MoM solution. The runtime and memory will be less +compared to a fully coupled (default) solution. Closed FEM problems (for example, completely +confined by PEC and / or modal port boundaries such as waveguides) are highly suitable, +automatically detected and the MoM solver will be deactivated. For other types of problems this +option should be used with caution. For example, the input impedance of a dipole antenna close +to a human head, where the dipole is solved using the MoM and the human head using FEM, will +(incorrectly) be the same as that of the MoM dipole in free space. +Tip: Use this option if the MoM and FEM regions are electrically far apart. +Element order +This option allows you to specify the element order for the model. Use First order only +(reduced accuracy) to reduce the required memory and run-time for regions with fine details +where the geometric details (and resulting mesh) are very fine. +Note: Use First order for very fine meshes to reduce memory and runtime. +Preconditioners for FEM +A few preconditioners are available for the finite element method (FEM). +Note: +• It is recommended to use the default settings. Changing the preconditioner is +recommended only for advanced users. +• The number in brackets corresponds to the value of the I3 field at the CG card in the +model .pre file. +On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. On the +Solver Settings dialog, click the Advanced tab. +Figure 337: The Solver Settings dialog (Advanced tab). +Multilevel ILU/diagonal decomposition (512) +Preconditioner for a hybrid FEM/MoM solution that uses a multilevel sparse incomplete LU- +decomposition with threshold and controlled fill-in. Note, not available for parallel. +Multilevel FEM-MLFMM LU/diagonal decomposition (2010) +Preconditioner for a hybrid FEM/MLFMM solution that uses a multilevel sparse LU decomposition of +the combined and partitioned, FEM/MLFMM system. This is the default for a FEM/MLFMM solution. +When using the parallel Solver, the factorisation type, which slightly impacts runtime and +memory, can be specified. +Multilevel LU/diagonal decomposition (2050) +Preconditioner for a hybrid FEM/MoM solution that uses a multilevel sparse LU decomposition of +the partitioned system. This is the default for a FEM/MoM solution. +When using the parallel Solver, the factorisation type, which slightly impacts runtime and +memory, can be specified. +Related concepts +Factorisation for Parallel Execution +Altair Feko 2022.3 +2 CADFEKO +Related reference +CG Card +p.439 +2.33.10 Physical Optics (PO) and Large Element Physical +Optics (LE-PO) +The physical optics (PO) solver is an asymptotic high-frequency numerical solver based on currents. Use +the method in instances where electrically very large metallic structures are modelled. +The large element physical optics (LE-PO) solution method is similar to the PO method but allows larger +triangular mesh elements to be used. +Solving Faces with Physical Optics (PO) +To solve a model with physical optics (PO), you must activate PO for each relevant face. +1. Select the face(s) in the 3D view or in the details tree that you want to solve with PO. +2. +In the details tree, from the right-click context menu, select Properties. +3. On the Modify Face dialog, click the Solution tab. +4. Under Solve with special solution method, from the drop-down list, select one of the +following: +• To use complete ray tracing, select Physical optics (PO) - full ray-tracing. +• If the assumption can be made that all triangles on which the PO approximation is made, are +illuminated, select Physical optics (PO) - always illuminated. Ray-tracing is switched off +to reduce run time. +• To use full ray tracing when the metallic triangles are only illuminated from the front (normals +side), select Physical optics (PO) - only illuminated from front. +5. Click OK to save the face properties and to close the dialog. +Solving Faces with Large Element Physical Optics (LE-PO) +To solve a model with large element physical optics (LE-PO), you must activate LE-PO for each relevant +face. +1. Select the face(s) in the 3D view or in the details tree that you want to solve with LE-PO. +2. +In the details tree, from the right-click context menu, select Properties. +3. On the Modify Face dialog, click the Solution tab. +4. Under Solve with special solution method, from the drop-down list, select one of the +following: +• To use complete ray tracing, select Large element PO - full ray-tracing. +• If the assumption can be made that all triangles on which the PO approximation is made, are +illuminated, select Large element PO - always illuminated. Ray-tracing is switched off to +reduce run time. +• To use full ray tracing when the metallic triangles are only illuminated from the front (normals +side), select Large element PO - only illuminated from front. +5. Click OK to save the face properties and to close the dialog. +PO and LE-PO Settings +Optional parameters can be used with the physical optics (PO) or large element physical optics (LE-PO) +to save memory and runtime in specific faces. +On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. On the +Solver Settings dialog, click the High frequency tab. +Couple PO and MoM/MLFMM solutions (iterative technique, default) +This option uses a hybrid iterative technique to determine the coupling (interaction) between the +MoM or MLFMM region and the PO region. As a result, the currents in the PO region will have an +effect on the current distribution in the MoM region. +Couple PO and MoM solutions (full coupling) +This option takes into account the coupling between the MoM region and PO regions. This is a +non-iterative technique and uses more memory compared to the iterative technique. The currents +in the PO region will have an effect on the current distribution in the MoM region. +Decouple PO and MoM solutions +This option ignores the PO regions when calculating the MoM currents. The runtime and memory +will be less compared to a fully coupled (default) solution. This option should be used with +caution. For example, the input impedance of a dipole antenna in close proximity to a metallic +plate, where the dipole is solved using the MoM and the plate using PO, will (incorrectly) be the +same as that of the MoM dipole in free space. +Tip: Use this option where the MoM and PO regions are electrically far apart (for +example a reflector antenna). +Maximum number of iterations +This option limits the number of iterations for the iterative coupling technique. +Stopping criterion for residuum +This option specifies the termination criterion for the normalised residue when using the iterative +method. The iterative solution is terminated when the normalised residue is smaller than this +value. +Store / reuse shadowing information +During calculations using the PO formulation, a large amount of the runtime could be spent in +determining which surfaces are illuminated from the source(s). This option saves the shadowing +information to speed up subsequent runs. Re-use is only possible if the mesh remains unchanged. +Note: Storage of the shadowing information could cause large .sha files on disk. +Use symmetry in ray-tracing (where possible) +This options allows symmetry to be used in full ray tracing when determining the shadowing to +reduce runtime. For geometrical symmetry, select this option to utilise symmetry. For electric and +magnetic symmetry, this speed up is always used. +2.33.11 Ray Launching Geometrical Optics (RL-GO) +The ray launching geometrical optics (RL-GO) solver is a ray-based solver that models objects based on +optical propagation, reflection and refraction theory. +Solving a Model with RL-GO +To solve a model with ray launching geometrical optics (RL-GO), you must activate RL-GO for each +relevant face. +1. Select the face (or faces) in the in the 3D view or in the details tree that you want to solve with +RL-GO. +2. +In the details tree, from the right-click context menu, select Properties. +3. On the Modify Face dialog, click the Solution tab. +4. Under Solve with special solution method, from the drop-down list, select Ray launching - +geometrical optics (RL-GO). +5. Click OK to save the face properties and to close the dialog. +RL-GO Settings +A number of optional settings are available when using ray launching geometrical optics (RL-GO) to +solve parts of the model. +On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. On the +Solver Settings dialog, click the High frequency tab. +Decouple from MoM solutions +This option ignores the RL-GO regions when calculating the MoM currents. The runtime and +memory will be less compared to a fully coupled (default) solution. This option should be used +with caution. For example, the input impedance of a dipole antenna close to a dielectric sphere, +where the dipole is solved using the MoM and the sphere using RL-GO, will (incorrectly) be the +same as that of the MoM dipole in free space. +Tip: Use this option where the MoM and RL-GO regions are electrically far apart (for +example an aircraft nose cone radome). +Maximum number of ray interactions +This option limits the number of ray interactions (reflection and diffraction combined). For +example, if this parameter is set to 3, a ray can have three reflections, or two reflections and +a transmission. If left empty, then the maximum number if ray interactions is determined +automatically. +Edge and wedge diffractions +This option takes the diffraction on edges and wedges into account. +Export ray data for post-processing to +*.bof file (default) +This option exports the rays during the RL-GO solution process to the .bof file for +visualisation in POSTFEKO. +*.ray file +This option exports the rays during the RL-GO solution process to a .ray file. This text file +can be used for custom post-processing. +Note: Large .ray files are possible when the MoM and RL-GO solution have not +been decoupled and the MoM region contains a large number of mesh elements. +Adaptive ray launching settings +This option allows you to control the density of the rays launched, as well as when to stop tracing +a ray based on the ray's decay. +• High (more rays): The ray density is high. Results take longer to obtain but with higher +accuracy. +• Normal (default): The default ray density setting. +• Low (fewer rays): The ray density is low. Results are fast to obtain but with lower accuracy. +Tip: Start with Low (fewer rays) which uses the least computational resources. +When the model appears to be performing as expected, use a higher setting. +Fixed grid increments +This option allows you to specify the angular or spatial resolution for ray launching. The resolution +is specified by means of the increments in the U direction and V direction for a parallel ray front +(plane wave source) or in the φ and ϑ directions (sources other than plane waves). Though the +run-time for a problem involving RL-GO may be decreased using this option, it may influence the +accuracy of the solution. +Note: Manual specification of the increments should only be used after the +implications have been carefully considered. +2.33.12 Uniform Theory of Diffraction (UTD) +The uniform theory of diffraction (UTD) is an asymptotic high-frequency numerical solver. The method is +typically used for electrically extremely large PEC structures. +The Solver has two UTD solution methods: +• Faceted uniform theory of diffraction (faceted UTD) +This method is well-suited for antenna placement on electrically large platforms with curved +surfaces (such as aircrafts). It is a frequency independent solver which uses planar mesh +triangles to approximate the structures, including surface curvature. The method takes into +account multiple reflections, edge and wedge diffraction, corner diffraction and creeping +waves. +• Uniform theory of diffraction (UTD) with polygons or cylinder +This method is well-suited for antenna placement of electrically large platforms on flat +surfaces. It is a frequency independent solver which uses polygons to approximate the +structures, but it does not consider surface curvature. This method can also be used to solve +a single canonical circular cylinder. +Solving a Flat Face with UTD +To solve a model with the uniform theory of diffraction (UTD), you must activate UTD for each relevant +flat face. +1. Select the face(s) in the 3D view or in the details tree that you want to solve with UTD. +2. +In the details tree, from the right-click context menu, select Properties. +Figure 338: The Modify Face dialog (Solution tab). +3. On the Modify Face dialog, click the Solution tab. +4. Under Solve with special solution method, from the drop-down list, select Uniform theory of +diffraction (UTD). +5. Click OK to save the face properties and to close the dialog. +Solving a Curved Face with Faceted UTD +To solve a model with the faceted uniform theory of diffraction (faceted UTD), you must activate faceted +UTD for each relevant curved face. +1. Select the face(s) in the 3D view or in the details tree that you want to solve with UTD. +2. +In the details tree, from the right-click context menu, select Properties. +Figure 339: The Modify Face dialog (Solution tab). +3. On the Face properties dialog, click the Solution tab. +4. Under Solve with special solution method, from the drop-down list, select Faceted uniform +theory of diffraction (UTD). +5. Click OK to save the face properties and to close the dialog. +Creating a UTD Cylinder +Solve a cylinder with the uniform theory of diffraction (UTD). The cylinder can either be a finite, semi- +infinite or infinite, depending on the termination type of the start cap and end cap. +1. Create a cylinder. +2. Select the cylinder in the 3D view or in the details tree. +3. +In the details tree, from the right-click context menu, select Properties. +4. On the Modify Region dialog, click the Solution tab. +Figure 340: The Modify Region dialog (Solution tab). +5. Under Solution method, from the drop-down list, select Uniform theory of diffraction (UTD) +cylinder. +6. Under Termination type, specify if the UTD cylinder is infinite or finite sized at the start and/or +end cap. +• To define a finite or semi-finite cylinder, select the Start cap and/or End cap check boxes. +• To define an infinite cylinder, clear the Start cap and End cap check boxes. +7. Click OK to save the region properties and to close the dialog. +Altair Feko 2022.3 +2 CADFEKO +UTD Settings +p.445 +A number of optional settings are available for the uniform theory of diffraction (UTD) to solve a face or +faces. +On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. On the +Solver Settings dialog, click the High frequency tab. +Decouple from MoM solutions +This option ignores the UTD surfaces when calculating the MoM currents. The runtime and +memory will be less compared to a fully coupled (default) solution. For example, the input +impedance of a dipole antenna in close proximity to a PEC plate, where the dipole is solved using +the MoM and the plate using UTD, will (incorrectly) be the same as that of the MoM dipole in free +space. If equivalent sources, such as far field or near field sources, are used, this option will have +no effect. +Tip: Use this option where the MoM and UTD regions are electrically far apart. +Maximum number of ray interactions +This option limits the number of ray interactions (reflection and diffraction combined). For +example, if this parameter is set to 3, a ray can have three reflections, or two reflections and a +diffraction. A value of 0 means that only direct rays are taken into account. +Note: For faceted UTD, this setting only affects the reflected rays and higher-order +effects. +Export ray data for post-processing to +*.bof file (default) +This option exports the rays during the UTD solution process to the .bof file for +visualisation in POSTFEKO. +*.ray file +This option exports the rays during the UTD solution process to a .ray file. This text file can +be used for custom post-processing. +Note: Large .ray files are possible when the MoM and UTD solution have not +been decoupled and the MoM part contains a large number of mesh elements. +Enable acceleration (for faceted UTD) +An acceleration technique for faceted UTD can be used to speed-up the search process for ray +paths significantly but could result in some rays not being found in exceptional cases. +Auto +On +The Solver determines automatically if the acceleration technique should be used for the +model (if the method is likely to speed up the solution). +This option enables the acceleration technique. Runtime decreases but technique could +result in some rays not being found in exceptional cases. +Altair Feko 2022.3 +2 CADFEKO +Off +p.446 +This option disables the acceleration technique at the expense of a runtime increase. +UTD Ray Contributions +A number of optional ray contribution parameters are available for the faceted UTD. +Faceted UTD +Direct field +This option takes into account the direct rays. +Edge and wedge diffraction +This option takes into account the diffraction on edges and wedges. +Surface reflection +This option takes into account the rays reflected by the planar and curved surface. +Creeping waves +This option takes into account the creeping waves on curved surfaces. +Corner and tip diffraction +This option takes into account the diffraction at corners and tips. +Higher-order effects +This option allows for multiple reflections plus one edge/wedge diffraction at any position along +the ray path to be computed. This option is only active if the Surface reflection and Edge and +Wedge diffraction check boxes are selected and the Maximum number of ray interactions is +larger than 1. +UTD (Polygons and Cylinder) +Direct and reflected +This option takes into account both the direct rays and reflected rays. +Double diffraction +This option takes into account the double diffraction on edges and wedges and the combinations +of reflections. Single diffraction rays are not included for this option. +Edge and wedge diffractions +This option takes into account the diffraction on edges and wedges. The ray may include an +arbitrary number of reflections, but only one diffraction. +Note: The total number of interactions (number of reflections) plus one for the +diffraction may not be larger than the value specified in the Maximum number of +UTD ray interactions field. +Creeping waves +This option takes into account the creeping waves on a cylinder. +Corner diffraction +This option takes into account the corner diffraction. +Altair Feko 2022.3 +2 CADFEKO +Cone tip diffraction +This option takes into account the diffraction at the tip of the cone. +p.447 +2.33.13 Finite Difference Time Domain (FDTD) +The finite difference time domain (FDTD) solver is well suited to modelling inhomogeneous materials +and models with wide bandwidths. +Solving a Model with FDTD +To solve a model with the finite difference time domain (FDTD), you must activate the solver for the +model. +1. On the Solve/Run tab, in the Solution Settings group, click the + Solver Settings icon. +2. On the Solver Settings dialog, click the FDTD tab. +Figure 341: The Solver Settings dialog (FDTD tab). +3. Under Time domain solver, select the Activate the finite difference time domain (FDTD) +solver check box. +4. Click the OK to close the dialog. +Specifying the FDTD Boundary Conditions +The boundary conditions define the size and type of boundaries of the volume solved by the finite +difference time domain (FDTD) solver. +1. On the Solve/Run tab, in the Solution Settings group, click the + FDTD Boundary +Conditions icon. +Figure 342: The Boundary Condition Settings dialog (Top (+Z) tab). +2. On the Boundary Condition Settings dialog, click the Top (+Z) tab to specify the boundary in +the positive Z axis. +3. Specify the boundary definition by selecting one of the following from the Boundary definition +drop-down list: +• To specify an open radiating boundary, implemented as a convolutional perfectly matched +layer (CPML), select Open. +• To specify a PEC boundary that allows efficient simulation of infinitely large electrically +conducting planes, select PEC. +• To specify a PMC boundary that allows efficient simulation of infinitely large magnetically +conducting planes, select PMC. +4. Enlarge a volume by adding a free space buffer[39] by selecting one of the following: +• If no free space buffer is required, select Do not add a free space buffer. +• To automatically add a free space buffer (perpendicular to the specific face), select +Automatically add a free space buffer. +• To specify the size of the free space buffer to be added to the specified face, select Specify +the size of the free space buffer. +• In the Free space buffer region size field, enter a value. +• To specify the position of the free space buffer on the respective axis, select Specify the +position of the free space buffer boundary. +• In the Position on the Z axis field, enter a value. +5. Repeat Step 2 to Step 4 for the remaining five faces of the boundary. +6. Click OK to define the boundary condition and to close the dialog. +Note: A free space boundary condition is only displayed in the 3D view when the +Configuration tab is selected. +39. The buffer is the space between the bounding box of the model and the position of the FDTD +boundary. +Figure 343: An example of the display for six free space boundary conditions. +2.33.14 Dielectric Surface Impedance Approximation +The dielectric surface impedance approximation is a solution method that can be applied to +homogeneous, lossy dielectric regions. Use the solution method to compute SAR values for a +homogeneous phantom. +Note: Restrictions apply when solving regions with the dielectric surface impedance +approximation: +• The region must be in free space (cannot be contained inside another region). +• The region may not touch or intersect another region when the media properties differ. +• The boundary surface must be a closed dielectric surface without any metal parts. +• No sources may be located inside the dielectric region. +Solving a Region with the Dielectric Surface Impedance +Approximation +Activate the dielectric surface impedance approximation solution method for an homogeneous, lossy +dielectric region. Use the solution method to compute SAR values for a homogeneous phantom. +1. Select the region (or regions) in the 3D view or in the details tree that you want to solve with the +dielectric surface impedance approximation. +2. +In the details tree, from the right-click context menu, select Properties. +3. On the Modify Region dialog, click the Solution tab. +4. Under Solution method, from the drop-down list, select Dielectric surface impedance +approximation. +5. Click OK to save the region properties and to close the dialog. +2.34 Component Launch Options +Specify the command-line parameters for the Feko components. +On the Solve/Run tab, in the Run/Launch group, click the + dialog launcher. +Figure 344: The Component Launch Options dialog. +2.34.1 PREFEKO Options +Specify PREFEKO command-line parameters using the GUI. +Treat errors as non-fatal, print error message but then continue +This option allows PREFEKO to continue running after encountering an error. +Export of Variables (Names, Values, Comments) +To the screen (stdout) +This option exports variables to the screen (stdout). +To the Feko *.out file +This option exports variables to the .out. +Advanced +The Advanced field allows you to add command-line options similar to when using a command shell. +Related reference +Running PREFEKO +2.34.2 Feko Solver Options +Specify Solver command-line parameters using the GUI. +Only check the geometry +This option allows you to perform geometry checks to check the model validity and exit before the +full solution starts. +Tip: First check the geometry of large models for clusters on a local machine. +Process priority +This option allows you to specify the priority of the Feko processes. If the priority is set to Low, +the solution could take slightly longer, but the CPU will still be responsive to other work. +Note: For parallel runs, all machines in the cluster operate at the speed of the slowest +machine. Starting additional CPU-intensive jobs on a machine(s) in the cluster is +generally not recommended. +Export SPICE MTL circuit files +This option allows you to export SPICE MTL harness files for further processing by a third-party +SPICE simulator. +Graphics Processing Units (GPU) +Accelerate Solver runs using multiple NVIDIA GPUs based on the compute unified architecture (CUDA). +GPU acceleration is only applicable if a compatible NVIDIA GPU device(s) is found. +Note: Minimum requirements for the CUDA device: +• Compute capability of at least 2.0 +• Driver installed on system must support CUDA 7.0. +Use GPU (graphical processing) for NVIDIA CUDA devices +This option allows you to make use of NVIDIA GPUs to accelerate Solver runs. +Note: Not all solvers fully support GPU acceleration. +Number of GPUs (empty = all) +This option allows you to specify the number of GPUs to use (if multiple GPUs are available and +supported by the solver). +List of GPUs (optional comma separated list) +Specify the list of available GPUs using a comma “,” as separation. +Remote Execution +Remote host (hostname or IP address) +Specify the machine to be used as the remote host. +ssh / rsh (must be installed on remote and local machine) +This option uses a remote shell (either RSH or SSH or similar) for launching the process. For +copying of the files, SCP (or similar) is used. The remote machine must be able to serve such +connection attempts (an SSH daemon must be set up and running with public key authentication). +This method can be used between different platforms. +Altair Feko 2022.3 +2 CADFEKO +MPI (Windows only) +p.452 +This option is only supported between Windows machines (both machines must run a Windows +operating system). This method uses native windows file copy methods and a shared network +folder on the remote machine for transferring the model files and results. The launching on the +remote machine is done by the MPI daemon which is already installed during installation for +parallel launching. Authentication is done by Windows internal mechanisms, as a result, the +remote machine must be able to authenticate the current user either against a domain or its local +user database to grant access. +Parallel Execution +Specify number of parallel processes +This option allows you to specify the number of parallel processes to be launched. +Note: If the number of parallel processes is not specified, then the machines (with +their specified number of parallel processes) as stated in the machines file, is used for +launching. +Full CPU report with run times for individual processes +This option enables diagnostic tests and outputs a full CPU report with run times for individual +processes. For normal runs, this option should be disabled to not degrade performance. +Output MFLOPS rate of each process (without network communication time) +This option enables diagnostic tests and outputs the MFLOPS rate of each process (without +network communication time). For normal runs, this option should be disabled to not degrade +performance. +Network latency and bandwidth +This option enables diagnostic tests and outputs the network latency and bandwidth. For normal +runs, this option should be disabled to not degrade performance. +Parallel Authentication Method +Use encrypted credentials in registry (Windows only) +This option uses a previously stored encrypted username and password from the Windows +registry. You have to save these credentials prior to starting a parallel simulation using the Update +parallel credentials tool[40] +Note: This setting is a per-user setting and must be updated after any changes to the +user's credentials. If using remote-parallel launching, this must also be done on the +remote host where the parallel Feko solution is started from. +Use SSPI (Active Directory) integration (Windows only, requires domain) +For this option all the machines must be a member of a Windows Active Directory (AD) domain +and the user accounts must be domain accounts. The authentication is carried out using internal +Windows mechanisms without having to encrypt anything into the registry. +40. The Update parallel credentials tool is available on the Launcher utility. +Note: A one-time configuration of the settings may be required by the domain +administrator to prepare the Windows domain for this kind of authentication. +Local run only (no authentication required) +This option runs the parallel job on the local host only and requires no authentication. +Tip: Use this option for parallel runs on a single local machine. +Default (rsh / ssh for UNIX, registry for Windows) +This option always uses the default authentication method for the target operating system. +Windows +The Use encrypted credentials in registry (Windows only option) is considered the default. +UNIX +Advanced +The public key authentication of rsh / ssh is used. +The Advanced field allows you to add command line options similar to when using a command shell. +2.34.3 ADAPTFEKO Options +Specify ADAPTFEKO command-line parameters using the GUI. +Restart analysis number +This option can be used if the run was discontinued and the temporary files were not deleted. +Restart the solution at the number of the first incomplete analysis number. +Delete temporary files +This option allows you to delete the temporary files created during the ADAPTFEKO run. +Tip: Uncheck this check box to allow resumption of an interrupted run. +2.34.4 OPTFEKO Options +Specify OPTFEKO command-line parameters using the GUI. +Restart from solver run +This option can be used if the optimisation process was terminated or interrupted and temporary +files are available. Restart the optimisation at the number of the last incompleted optimisation +number. No changes may be made to the model before restarting the optimisation process. +Delete all files (except optimum) +This option deletes all temporary files except the files related to the optimum solution. +Tip: Uncheck this check box to allow resumption of an interrupted run. +Altair Feko 2022.3 +2 CADFEKO +Number of processes to farm out +p.454 +This option allows you to specify the number processes to use per optimisation iteration when +farming out the solution. +Configure +Specify the hosts and processes to be used when farming out the kernel solution. +Figure 345: The Machines configuration dialog. +2.34.5 Environment Variables to Control the Solution +Add environment variables to be used during the launching of processes. +Specify an environment variable per single line, for example: +VARIABLE=VALUE +Figure 346: The Component Launch Options dialog. +Altair Feko 2022.3 +2 CADFEKO +2.35 Tools +p.455 +CADFEKO has a collection of tools that allows you to quickly validate the model, for example, perform +calculations using a calculator, measure distances, measure angles and export images. +2.35.1 Measuring a Distance +The measure distance tool allows you to measure or validate the physical distance between two points +in a model. +1. On the Tools tab, in the Tools group, click the + Measure Distance icon. +2. Under Point1, use Ctrl+Shift+left click to snap to points (for example, named points, geometry +points, geometry face centre, geometry edge centre, mesh vertices and grid). +3. Repeat Step 2 for Point 2. +The total distance, as well as the individual X axis, Y axis and Z axis distances, are displayed in +the Distance (D), X distance, Y distance and Z distance fields respectively. +4. Click Close to close the dialog. +Figure 347: The Measure distance tool. +Altair Feko 2022.3 +2 CADFEKO +2.35.2 Measuring an Angle +p.456 +Use the angle measuring tool to measure or validate the angle (in degrees) between three points in a +model. +1. On the Tools tab, in the Tools group, click the + Measure Angle icon. +2. Under Point1, use Ctrl+Shift+left click to snap to points (for example, named points, geometry +points, geometry face centre, geometry edge centre, mesh vertices and grid). +3. Repeat Step 2 for Point 2. +4. Repeat Step 2 for Point 3. +The angle in degrees is displayed in the Angle (degrees) field. +5. Click Close to close the dialog. +Figure 348: The Measure angle dialog. +2.35.3 Performing Calculations +Use the calculator to perform calculations using functions, predefined variables, user-defined variables +and named points. +Tip: Use the tool to evaluate variables and named points without modifying the model. +1. On the Tools tab, in the Tools group, click the + Calculator icon. +Figure 349: The Calculator dialog. +2. +In the Expression field, you can add expressions that consist of functions, predefined variables, +user-defined variables or named points. +3. +[Optional] Change the number format for the result. Under Formats, select one of the following: +• Scientific +• Engineering +• Decimal +4. +[Optional] In the Decimals box, type the value or click the up or down arrows to specify the +number of decimals. +5. Click Calculate or Enter to evaluate the expression and display the result in the Result field. +6. Click Close to close the dialog. +Related reference +Functions in Expressions +Predefined Variables +2.35.4 Exporting an Image +Export an image of the active view to file. +1. On the Tools tab, in the Image Tools group, click the + Export image icon. +Figure 350: The Export image dialog. +2. Select a view to export. +3. From the Image format drop-down list, select one of the following: +• PNG +• BMP +• CUR +• ICNS +• JPG +• PBM +• PGM +• TIF +• WBMP +• WEBP +• PDF +• EPS +• EMF +4. From the Export size drop-down list, select one of the following: +• Same as source +• QQVGA (160x120) +• QVGA (320x240) +• VGA (640x480) +• SVGA (800x600) +• XGA (1024x768) +• SXGA (1280x1024) +• Custom +5. Click OK. +The Image export file name dialog is displayed. +6. +7. +In the File name field, specify the file name of the exported file. +In the Save as type, specify the file type of the exported file. +8. Click Save to export the active view to file and to close the dialogs. +2.36 Model Tree Icons +View the list of icons that may be found in the model tree. +Icon +Definition +Imported CAD body or a part that was converted to a primitive. +Surface body (for example, created with a face copy or explode) +Curve (edge/wire) body (for example, created with an edge copy or explode.) +A mesh part in the model. +The part/region/face/edge/wire contains faults. +The target from which an object was subtracted from. +This part contains a dielectric medium. +This part contains anisotropic regions. +This part is locked. +This part is excluded. +The active optimisation search. +A protected model. +Local mesh settings (that can be applied to a part) is specified. +The default cutplanes. +An adaptive mesh refinement is added to the model. +A point mesh refinement is added to the model or a point refinement that forms part of an +adaptive mesh refinement. +A polyline mesh refinement is added to the model. +Altair Feko 2022.3 +2 CADFEKO +Icon +Definition +Part was repaired. +Part was repaired and faces sewn. +p.460 +2.37 Details Tree Icons +View the list of icons that may be found in the details tree. +Icon +Definition +This face lies on a dielectric region. +This item is suspect — it could not be mapped. +Local mesh properties set on regions, faces or edges. +Local wire radius. +• For wires and surfaces, the core medium. +• For tetrahedra, the medium. +The layered medium applied as a coating. +• For surfaces, the medium on the normal side. +• For wires, the surrounding medium. +Only used for surfaces; the medium on the rear (opposite to normal) side. +The solution method applied to the wire, edge, face or region. +A face of the selected part. +A wire or edge of the selected part. +A mesh triangle of the selected part. +A mesh segment of the selected part. +A mesh tetrahedron of the selected part. +A UTD mesh plate of the selected part. +A UTD mesh cylinder of the selected part. +2.38 Files Generated by CADFEKO +View the files associated and generated by CADFEKO. +Table 15: Files generated by CADFEKO +Argument +Description +.cfx +.cfm +.pre +.fek +.opt +.pfg +Contains the meshed and/or unmeshed CADFEKO model as well as the +calculation requests. If an optimisation was run, a model will be created with +the optimum values with a _optimum suffix. +Contains information regarding the mesh of the CADFEKO model. +A .pre file is created when the CADFEKO model is saved. +The .fek file is created when running PREFEKO and it contains the geometry +(solver mesh) of the CADFEKO model. This file can be opened in POSTFEKO +to view the geometry and the calculation requests (for example, the near +field request points are displayed if a near field calculation was requested). +The mesh from a .fek file may be imported into CADFEKO. +An .opt file is created when optimisation settings have been defined for the +CADFEKO model. +Contains the relevant information used during optimisation (in conjunction +with the .pre and .cfx files). +2.39 Default Shortcut Keys +View the default shortcut keys available for CADFEKO for faster and easier operation of CADFEKO. +Keyboard shortcut keys help you to save time accessing actions that you perform regularly. The +shortcut key or key combination is displayed in the keytip that is displayed when you hover the mouse +over the action on the ribbon. +Shortcut Key +Alt+0 +Alt+1 +Alt+2 +Alt+3 +Alt+4 +Alt+6 +Alt+8 +General Editing +F2 +F9 +Del +Shift+Ins +Ctrl+Ins +Shift+Del +Ctrl+A +Ctrl+Shift+A +Ctrl+C +Description +Run CADFEKO. +Run EDITFEKO. +Run PREFEKO. +Run POSTFEKO. +Run Solver. +Run OPTFEKO. +Open the Feko terminal. +Rename selected item. +Create workplane. +Delete selected item. +Paste clipboard text. +Copy selected text. +Cut selected text. +Select all entities (edge, wire, face or region) of +the same type in the collection[41]. +Select all entities (edge, wire, face or region) of +the same type in the model. +Copy selected text / image. +41. For example, in the model tree, a collection can be geometry, meshes, ports, meshing rules, +cutplanes and solution settings. In the details tree, a collection can be wires, edges, faces and +regions. +Altair Feko 2022.3 +2 CADFEKO +Shortcut Key +Ctrl+E +Ctrl+F +Ctrl+H +Ctrl+K +Ctrl+M +Ctrl+N +Ctrl+L +Ctrl+3 +Ctrl+O +Ctrl+S +Ctrl+V +Ctrl+X +Q+C +Ctrl+Y +Ctrl+Z +# +Ctrl+Shift +Alt+S +Create arcs / curves +V,1 +V,2 +V,3 +Proprietary Information of Altair Engineering +p.464 +Description +Export image. +Edit project tree filter. +Show / Hide selected geometry and requests. +For mesh parts or solution items which allow +multiple instances, create copies of the selected +items. +For geometry items (at any level) create new root- +level parts as copies of the selected items. +Modify global mesh settings. +Create new model. +Open the component library. +Create new 3D view. +Open model. +Save model. +Paste. +Cut selected text. +Select the smallest loop of edges containing the +currently selected edges. +Redo model creation / modification. +Undo model creation / modification. +Create variable. +Point entry. +Search bar. +Create a straight line. +Create a polyline. +Shortcut Key +Description +V,4 +V,5 +A,1 +A,2 +A,3 +A,4 +Create Solids +C,1 +C,2 +C,3 +C,4 +C,5 +Create Surfaces +S,1 +S,2 +S,3 +S,4 +S,5 +Transform / Modify +B,1 +B,2 +B,3 +B,4 +E,1 +E,2 +Proprietary Information of Altair Engineering +Create a Bézier curve. +Create an analytical curve. +Create an elliptic arc. +Create a parabolic arc. +Create a hyberbolic arc. +Create a helix. +Create a cuboid. +Create a flare. +Create a sphere. +Create a cylinder. +Create a cone. +Create a rectangle. +Create a polygon. +Create an ellipse. +Create a paraboloid. +Create a NURBS surface. +Subtract selected object from another object. +Intersect the selected geometries. +Split selected items along a plane. +Stitch selected face parts together. +Spin selected items around a specified axis. +Shortcut Key +Description +E,3 +E,4 +View +F1 +F5 +Ctrl+5 +Sweep selected item along a path. +Connect two profiles to form a loft surface or solid. +Re-evaluate the geometry tree. +Union the selected parts. +Context-sensitive help for the dialog / window that +has focus. +Zoom to extents. +Restore view. +Bottom view. +Left view. +Front view. +Back view. +Right view. +Top view. +3D View / Schematic View Interaction +F5 +Zoom to extents. +Shift & hold while scrolling mouse wheel. +Slow zoom (3D view). +Scroll mouse wheel. +Zoom (3D view). +Click & drag with middle mouse button. +Panning (3D view, schematic view). +Ctrl & click / drag. +Panning (3D view). +Left click & drag the mouse. +Rotation (3D view). ++ +- +Script Editor +Zoom in (3D view, schematic view). +Zoom out (3D view, schematic view). +Rotate element (schematic view). +Altair Feko 2022.3 +2 CADFEKO +Shortcut Key +Ctrl+N +Ctrl+O +Ctrl++ +Ctrl+- +Ctrl+G +p.467 +Description +New empty script. +Open script. +Zoom in. +Zoom out. +Goto line. +POSTFEKO +3 POSTFEKO +POSTFEKO, the Feko post processor, is used to display the model (configuration and mesh), results on +graphs and 3D views. +This chapter covers the following: +• 3.1 Introduction to POSTFEKO (p. 469) +• 3.2 Quick Tour of the POSTFEKO Interface (p. 473) +• 3.3 Preferences (p. 483) +• 3.4 Rendering Options (p. 484) +• 3.5 Model and Project Basics (p. 486) +• 3.6 Data Import (p. 487) +• 3.7 Data Export (p. 491) +• 3.8 Terminology (p. 493) +• 3.9 Graphs (Cartesian, Polar and Smith Charts) (p. 494) +• 3.10 Cartesian Surface Graphs (p. 524) +• 3.11 3D Views (p. 536) +• 3.12 Frequency Domain Results (p. 563) +• 3.13 Time Domain Results (p. 576) +• 3.14 Animation (p. 590) +• 3.15 Generating Reports (p. 595) +• 3.16 Lua Scripting (p. 607) +• 3.17 Tools (p. 609) +• 3.18 Files Generated by POSTFEKO (p. 615) +3.1 Introduction to POSTFEKO +Use POSTFEKO to validate meshed geometry and analyse and post-process results. +POSTFEKO is the component that allows you to verify that your model is constructed and configured +correctly before starting a simulation and analyse the results after the simulation completes. The +POSTFEKO component is particularly useful to verify models created using EDITFEKO, but it is just as +relevant for CADFEKO model verification. +Result post-processing and analysis is the primary function of POSTFEKO. Once a model has been +simulated, POSTFEKO can be used to display and review the results. It is easy to load multiple models +in a single session and compare them on 3D views, Cartesian graphs, Smith charts, polar graphs +and surface graphs. Various measurement and other data formats are supported for comparison to +the simulated results. A powerful scripting interface makes it easy to post-process results, automate +repetitive tasks and create plug-in extensions that customise the interface and experience. +3.1.1 Feko Components and Workflow +View the typical workflow when working with the Feko components. +Use CADFEKO +Create / modify +geometry +Set soluon sengs +or add component +from +component library +Define frequency, +sources and requests +Run Feko Solver +Use POSTFEKO +Create new +graph / display +Add / view results +Post-processing of +results / scripng +Export results / +generate report +POSTFEKO +Create a new graph or 3D view and add results of the requested calculations on a graph or 3D view. +Results from graphs can be exported to data files or images for reporting or external post-processing. +Reports can be created that export all the images to a single document or a custom report can be +created by configuring a report template. +After viewing the results, it is often required to modify the model again in CADFEKO and then repeat the +process until the design is complete. +3.1.2 Launching POSTFEKO (Windows) +There are several options available to launch POSTFEKO in Windows. +Launch POSTFEKO using one of the following workflows: +• Open POSTFEKO using the Launcher utility. +• Open POSTFEKO by double-clicking a .pfs, .fek or .bof file. +• Open POSTFEKO from other components, for example, from inside CADFEKO and EDITFEKO. +Note: If the application icon is used to launch POSTFEKO, no model is loaded and the +start page is shown. Launching POSTFEKO from other Feko components, automatically +loads the model. +Related tasks +Opening the Launcher Utility (Windows) +3.1.3 Launching POSTFEKO (Linux) +There are several options available to launch POSTFEKO in Linux. +Launch POSTFEKO using one of the following workflows: +• Open POSTFEKO using the Launcher utility. +• Open a command terminal. Launch POSTFEKO using the absolute path to the executable in the +installation, for example: +/home/user/2022.3/altair/feko/bin/postfeko +• Open a command terminal. Source the “initfeko” script using the absolute path to it, for example: +. /home/user/2022.3/altair/feko/bin/initfeko +Sourcing initfeko ensures that the correct Feko environment is setup. Type postfeko and press +Enter. +Note: Take note that sourcing a script requires a dot (".") followed by a space (" ") and +then the path to initfeko in order for the changes to be applied to the current shell +and not a sub-shell. +Related tasks +Opening the Launcher Utility (Linux) +3.1.4 Command Line Arguments for Launching POSTFEKO +POSTFEKO can be called via the command line. Use command line arguments to pass configuration +information to POSTFEKO. +If POSTFEKO is launched and a model (or set of models) is specified, the model is added to a new +project (or sessions). Without any models specified, POSTFEKO will start and display the start page. +Command-line options: +postfeko [SESSION] [FILES] [OPTIONS] +SESSION +A single session (.pfs) may be specified that may or may not exist +FILES +Multiple model (.fek) files or result (.bof) files may be specified. Model files result in a 3D view +being created automatically that displays the first configuration of the model. +OPTIONS +-h, --help +Displays the help message. +--version +Print the version information and then exit. +--non-interactive +Special execution mode for running automation scripts without user interaction. +--run-script SCRIPTFILE +Specifies an automation script to load and run. +--configure-script CONFIGSTRING +Executes the string CONFIGSTRING before running the script specified in SCRIPTFILE. This +options is only used with the “non-interactive” option. +--file-info [=OUTPUTFORMAT] SESSION +Display the POSTFEKO version used to create the file. +postfeko startup.pfs --file-info[42] +postfeko startup.pfs --non-interactive --file-info |more[43] +postfeko startup.pfs --non-interactive --file-info > versions.txt[44] +42. Opens a dialog and displays the version information. +43. Writes the version information out to standard output stream (stdout). +44. Redirects the version information to the specified file. +Altair Feko 2022.3 +3 POSTFEKO +=OUTPUTFORMAT +p.472 +Optional argument that is used to specify the output format. If the argument is set +to xml, version information is written out in XML format. XML will only be output to +stdout, and only if --non-interactive was also specified. +postfeko startup.pfs --file-info=xml --non-interactive | more[45] +3.1.5 Start Page +The Feko start page is displayed when starting a new instance (no models are loaded) of CADFEKO, +EDITFEKO or POSTFEKO. +The start page provides quick access to Open a session, Open a model and a list of Recent +projects. +Links to the documentation (in PDF format), introduction videos and website resources are available on +the start page. Click the + icon to launch the Feko help. +Figure 351: The POSTFEKO start page. +45. Writes the version information in XML format in non-interactive mode, displaying the content one + screen at a time. +3.2 Quick Tour of the POSTFEKO Interface +View the main elements and terminology in the POSTFEKO graphical user interface (GUI). +Figure 352: The POSTFEKO window. +1. Quick Access Toolbar +2. Ribbon +3. Project Browser +4. Model Browser +5. Details Browser +6. Status Bar +7. 3D Views and Graphs +8. Result Palette +9. Help +10. Search Bar +11. Application Launcher +12. Application Menu +Altair Feko 2022.3 +3 POSTFEKO +3.2.1 Quick Access Toolbar +p.474 +The quick access toolbar is a small toolbar that gives quick access to actions that are often performed. +The toolbar is located at the top-left corner of the application window, just below the title bar. It allows +you to create a new model, open a model, save a model, undo a model operation or redo a model +operation using fewer mouse clicks for a faster workflow. The actions available on the quick access +toolbar are also available via the ribbon. +3.2.2 Ribbon +The ribbon is a command bar that groups similar actions in a series of tabs. +Figure 353: The ribbon in POSTFEKO. +1. Application menu +The application menu button is the first item on the ribbon. When the application menu drop- +down button is clicked, the application menu is displayed. The menu allows saving and loading +of models, import and export options as well as giving access to application-wide settings and a +recent file list. +2. Core tabs +A tab that is always displayed on the ribbon, for example, the Home tab and Reporting tab. +The Home tab is the first tab on the ribbon and contains the most frequently used commands for +quick access. +3. Contextual tab sets +A tab that is only displayed in a specific context. +For example, the Cartesian contextual tab set contains the Format contextual tab. Contextual +tabs appear and disappear as the selected items such as a view or item on a view, change. +4. Ribbon group +A ribbon tab consists of groups that contain similar actions or commands. +5. Dialog launcher +Click the dialog launcher to launch a dialog with additional and advanced settings that relate to +that group. Most groups don't have dialog launcher buttons. +Keytips +A keytip is the keyboard shortcut for a button or tab that allows navigating the ribbon using a +keyboard (without using a mouse). Press F10 to display the keytips. Type the indicated keytip to +open the tab or perform the selected action. +Figure 354: An example of keytips. +Application Menu +The application menu is similar to a standard file menu of an application. It allows saving and loading of +models, print functionality and gives access to application-wide settings. +When you click on the application menu drop-down button, the application menu, consisting of two +panels, is displayed. +The first panel gives you access to application-wide settings, for example: +• Creating a new model. +• Open models, open a project, saving a project and closing a project. +• Import +• Export +• Print +• Check for updates +• Settings +◦ Preferences +◦ 3D mouse sensitivity setting +◦ Rendering options (for example, rendering mode and transparency mode) +◦ Component launch options +• Feko help +• About +◦ Version information about POSTFEKO +Information about Altair Simulation Products +Information about third-party libraries +◦ +◦ +• Exit +The second panel consists of a recent file list and is replaced by a sub-menu when a menu item is +selected. +Figure 355: The application menu in POSTFEKO. +Home Tab +The Home tab is the first tab on the ribbon and contains the most frequently used operations. +Figure 356: The Home tab in POSTFEKO. +3.2.3 Project Browser +The project browser is a panel that lists the models loaded in the current project, imported data, stored +data and scripted data. +Collapse the project browser to expand the 3D view. On the View tab, in the Show group, click the + Project icon. +Figure 357: Project browser is showing the model file for the current session. +3.2.4 Model Browser +The model browser is a panel that organises the model information of the selected model in the project +browser, into two separate tabs. +The model browser is separated into two tabs. +• The Model tab lists the model information and results for the selected model. +• The Results tab lists the results and solution information. +Figure 358: Model browser is showing the model information for the selected model. +3.2.5 Details Browser +The details browser is a panel that shows in-depth detail for the selected item in the model browser. +Figure 359: Details browser is showing the detail for a selected item in the model browser. +Tip: View the solution information for the selected model. +On the model browser, click Solution information to view: +• memory per process +• total CPU-time +• total runtime +3.2.6 Status Bar +The status bar is a small toolbar that gives quick access to general display settings, tools, and graph +cursor settings. +The status bar is located at the bottom-right of the application window. Options on the status bar are +also available on the ribbon, but since the status bar is always visible, they are easily accessible no +matter which ribbon tab is selected. +3.2.7 3D Views and Graphs +3D views are used to display mesh, solution settings and interact with the model as well as view 3D +results. Graphs are used to display 2D results. +3.2.8 Result Palette +The result palette is a panel that gives access to options that control the data in the 3D view or graph. +Collapse the result palette to expand the 3D view. On the View tab, in the Show group, click the + Palette icon. +If different types of results are loaded, then the result palette layout and options update according to +the selected data. If multiple results are simultaneously selected, settings common to all the results are +available. +3.2.9 Help +The Help icon provides access to the Feko documentation. +Press F1 to access context-sensitive help. The context-sensitive help opens the help on a page that is +relevant to the selected dialog, panel or view. +Tip: When no help context is associated with the current dialog or panel, the help opens +on the main help page that allows you to navigate the documentation or search in the +documentation for relevant information. +Altair Feko 2022.3 +3 POSTFEKO +3.2.10 Search Bar +p.479 +The search bar is a single-line text field that allows you to enter search terms and find relevant +information in the GUI or the documentation. +The search bar is located at the top-right of the application window. +Tip: +• Enter a search term in the search bar to populate a drop-down list of actions as well as +the location of the action on the ribbon or context menu. +• Click an item in the list to execute the action. +• Partial searches are supported. +• Search the documentation. +3.2.11 Application Launcher +The application launcher toolbar is a small toolbar that provides quick access to other Feko components. +3.2.12 Application Menu +The application menu is similar to a standard file menu of an application. It allows saving and loading of +models, print functionality and gives access to application-wide settings. +When you click on the application menu drop-down button, the application menu, consisting of two +panels, is displayed. +The first panel gives you access to application-wide settings, for example: +• Creating a new model. +• Open models, open a project, saving a project and closing a project. +• Import +• Export +• Print +• Check for updates +• Settings +◦ Preferences +◦ 3D mouse sensitivity setting +◦ Rendering options (for example, rendering mode and transparency mode) +◦ Component launch options +• Feko help +• About +◦ Version information about POSTFEKO +◦ +Information about Altair Simulation Products +Altair Feko 2022.3 +3 POSTFEKO +◦ +Information about third-party libraries +• Exit +p.480 +The second panel consists of a recent file list and is replaced by a sub-menu when a menu item is +selected. +Figure 360: The application menu in POSTFEKO. +3.2.13 Scripting +Use the application programming interface (API) to control CADFEKO from an external script. +Scripting allows repetitive or complex tasks to be performed in a script that would have taken a long +time to perform manually. Scripts are created and edited in the script editor or scripts can be recorded +(macro recording) by enabling the recording and then performing the actions in the graphical interface. +The recorded script can be modified to perform a more complex task. Scripts that are used regularly +can be added to the ribbon providing easy access and hiding the complexity of the script. Forms +(dialogs) can be created in the scripting environment that obtain input from the script user without +having to edit the script. +Altair Feko 2022.3 +3 POSTFEKO +Script Editor +p.481 +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. +On the Home tab, in the Scripting group, click the + Script editor icon. +The script editor includes the following IDE (integrated development environment) features: +1. Syntax highlighting. +2. +3. +Intelligent code completion. +Indentation for blocks to convey program structure, for example, loops and decision blocks in +scripts. +4. Use of breakpoints and stepping in scripts to debug code or control its execution. +5. An active console to query variables or execute simple commands. +Figure 361: The script editor 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. +On the Home tab, in the Scripting group, click the + Record Macro icon. +Altair Feko 2022.3 +3 POSTFEKO +Application Macros +p.482 +An application macro is a reference to an automation script, an icon file and associated metadata. +Application macros are available directly or can be added, removed, modified or executed from the +application macro library. +Tip: A large collection of application macros are available in CADFEKO and POSTFEKO. +On the Home tab, in the Scripting group, click the + Application macro icon. +Related concepts +CADFEKO Application Macros +POSTFEKO Application Macros +Altair Feko 2022.3 +3 POSTFEKO +3.3 Preferences +p.483 +POSTFEKO has various default settings that you can configure to customise it to your preference. +On the application menu, click + Settings > Preferences. The settings can be reset to the default +settings at any time, restoring the settings to the state of a new installation. +Many of the settings are applied immediately, but some of the settings such as 3D view font changes +and rendering options require the application to be restarted before the changes take effect. +Figure 362: The Default settings dialog. +3.4 Rendering Options +A number of rendering options are available to ensure that 3D models and graphs (containing a large +number of sample points) are rendered efficiently. +On the application menu, click + Settings > Rendering options. +Figure 363: The Rendering options dialog. +3D Display +Graphics driver +Specify the graphics driver used to render 3D graphics. The following options are available: Auto +select, OpenGL, OpenGL 2.0, DirectX 9, DirectX 11 and Software. +Rendering mode +Z-buffering is an algorithm used in 3D graphics to determine if an object (or part of the object) is +visible or if it is hidden from view and is used to increase rendering efficiency. These calculations +can be done using the GPU (hardware) or using the CPU (software). +Transparency mode +The transparency rendering of objects can be done using the GPU (hardware) or using CPU +(software). +3D view text +Text in the 3D view can be rendered using either Smooth (anti-aliased) or Standard. Anti- +aliasing of text results in a font being displayed with smooth curves and makes it appear less +jagged. +Note: Rendering settings changes are only applied to new views. +Altair Feko 2022.3 +3 POSTFEKO +2D Display +Enable OpenGL rendering +p.485 +Select the Enable OpenGL rendering check box to accelerate the rendering of graphs and graph +manipulation (for example, zooming, restoring a view) for graphs containing thousands of sample +points. +3.5 Model and Project Basics +You can add a model, open an existing project and save the project. +3.5.1 Adding a Model or Project +Load a .fek file (single file or multiple files) or load a single POSTFEKO session file that contains the +settings, views and references to result files that were present at the time of save. +Load a model. +• Open a single or multiple .fek files. On the Home tab, in the File group, click the + Add model +icon. +• Open saved session (saved project). On the Home tab, in the File group, click the + Open +project icon. +Tip: A model or session can also be opened from the start page. +3.5.2 Saving a Project +Store the view settings, views and references to result files to a .pfs file to reopen later. +On the Home tab, in the File group, click the + Save Project icon. +3.5.3 Large Models +When a model containing more than 500 000 elements is opened, it may become difficult to work with +the 3D model due to memory requirements for the 3D rendering and visualisation. +Should such a model be opened, you are prompted to select whether the model is to be displayed in +the 3D view or only load the model into memory. You can still view and process the results in 3D views +or graphs, just without any geometry visualisation. The model can be loaded at a later stage from the +context menu in the project browser. +Figure 364: An information message is stating that the model contains more than 500 000 mesh elements. +Altair Feko 2022.3 +3 POSTFEKO +3.6 Data Import +p.487 +Import text files, native data files and Touchstone format files. +Multiple selected files located in the same folder can be imported in a single import, but only a single +custom data file can be imported at a time. +Data that was imported into POSTFEKO can be added to a graph in the same manner as other any +result. The project browser contains an entry for each import under Imported files. Imports can be +deleted from the project should they no longer be required. +Saving a project with imported results stores it as part of the POSTFEKO session file (.pfs) file. +3.6.1 Supported File Formats for Import +POSTFEKO supports the import of native file formats as well as Touchstone file format. +On the Home tab, in the File group, click the + Import icon. From the drop-down list, select the file +format to import. +The following file formats are supported for import: +Feko far field (*.ffe) +The .ffe file is imported automatically. No further user input is required. +Feko near field (*.efe, *.hfe) +When a near field is imported, specify whether an Electric near field file (*.efe) file or +Magnetic near field (*.hfe) file or both files are to be imported. +Figure 365: The Import data: Feko Solver near field dialog. +Note: The .efe file and the corresponding .hfe file must have identical file names. +Touchstone (*.snp) +The .snp file is imported automatically. No further user input is required. +Report template (*.xml) +A report template in XML format can be imported. +POSTFEKO graph file (*.pfg) +This file format contains the relevant information used during optimisation. This file type works in +conjunction with the .pre and .cfx files. +Altair Feko 2022.3 +3 POSTFEKO +Custom data file +p.488 +When importing custom data, an import template needs to be defined. +Importing Custom Data +Import a single custom data file by defining the import template. +1. On the Home tab, in the File group, click the + Import icon. From the drop-down list, click the + Custom Data File icon. +2. Browse to the location of the file and select a custom data file. +3. Under Delimiter, select one of the following delimiters that separate the columns of data. +• Tab +• Space +• Comma +• Other +The data file may contain lines of text that are not part of the data to be imported. +4. +5. +6. +In the Start reading file at (line number) field, enter the line number at which data should be +imported. +In the Specify number of lines to read field, enter the number of data to read. +If the data contains column title, select the Data contains column titles check box. +7. Click Next to continue with the template. +Figure 366: The Import data: Custom data dialog. +8. +In the Label field, specify a descriptive label for the data. +9. +In the Type drop-down list, select one of the following and then a relevant Quantity for the data +column: +• Axis scalar +Select this option if the column is used as an independent axis on a graph. +Quantity: frequency, position, radius, angle, time or a user-defined quantity. +• Scalar +Select this option if any scalar result type may be used. +Quantity: far field, near field, voltage, current, power, specific absorption rate (SAR), +impedance / admittance, scattering parameters, axial ratios, gain / directivity, radar +cross section (RCS), voltage standing wave ratio, reflection coefficient, Poynting vector +(magnitude) user-defined quantities and several other typical data types. +• Complex pair (Real + Imaginary) +Select this option of two adjacent columns contain the real and imaginary components +of a complex number. +Quantity: far field, near field, voltage, current, impedance / admittance, scattering +parameters, reflection coefficient, or a user-defined quantity. +• Ignore +Select this option if a column is to be ignored during the import process. +10. In the Import scale field, enter a value to scale the data. +11. If the data in the column is in dB, select the Data is in dB (not linear) check box. +12. Repeat 9 to 11 for the remaining columns. +13. Click Done to import the data and to close the dialog. +A new Imported files entry, is created that is accessible from the project browser or the ribbon. +Refresh Imported Data +If after data was imported into POSTFEKO, the external file is modified, the imported data can be +refreshed without the need for reimporting the data. +If changes occur to the external file, a + refresh icon is displayed next to the file name. +Figure 367: Example of an imported FarFieldData.ffe file that shows the refresh icon. +To refresh the external file, from the right-click context menu, select + Refresh. +Altair Feko 2022.3 +3 POSTFEKO +3.7 Data Export +p.491 +POSTFEKO supports the export of native file formats. These files can be exported to use in other +sessions or when further post-processing is required. +3.7.1 Supported File Formats for Export +POSTFEKO supports the export of native file formats and Touchstone file format. +On the Home tab, in the File group, click the + Export icon. From the drop-down list, select the file +format to export. +The following formats are supported for export: +• Feko far field (.ffe) +• Feko near field (.efe, .hfe) +• Touchstone (.snp) +• Currents and charges (.os, .ol) +• Custom data (.txt) +• Graph data to file (.dat) +• Graph data to the clipboard for quick transfer to an external application +Exporting Data +To export data, select the model, its configuration and the specific results to export to a native file +format. +1. On the Home tab, in the File group, click the + Export icon. From the drop-down list, select +the file format to export. +2. +3. +In the Source panel, select the required configuration. +In the Results panel, select a result for the selected configuration. +4. Under Result options, specify the result-specific parameters. +5. Click OK to close the dialog. +6. Specify a file name and click Save. +Figure 368: An example of the export dialog when exporting near field data. +Altair Feko 2022.3 +3 POSTFEKO +3.8 Terminology +p.493 +The terms, dataset, slice, trace and 3D result, are used extensively in the documentation. Review the +definitions to get a better concept of these definitions. +Dataset +A dataset is any multi-dimensional data that can be used to define a full set of quantities over a full set +of axes. +Slice +Slicing gives you control over which section / subset of the data is viewed. +Trace +A trace is a line plotted on a graph that represents a quantity relative to an independent axis. The +styling of the trace as well as the representation of the data can be manipulated. +3D Result +A 3D result is any data that displays in three-dimensional space. +3.9 Graphs (Cartesian, Polar and Smith Charts) +Display result data on a graph to allow visual interpretation of the data in a human-readable format, as +well as to communicate the results in reports and presentations. +When a trace is added to a graph and the Solver is run, POSTFEKO monitors the simulation results and +updates the graphs as the results become available for discrete frequency results. +For adaptive frequency sampling results (continuous frequency), POSTFEKO displays the discrete results +during the simulation and interpolate the results once the simulation is complete. +Related concepts +Trace (Terminology) +Continuous Frequency (CADFEKO) +3.9.1 Graph Types +POSTFEKO supports three types of graphs, namely Cartesian graph, polar graph and Smith chart. Each +graph type represents data in a different way to make it easier to interpret for a given application. +Related concepts +Cartesian Surface Graphs +Creating a Cartesian Graph +A Cartesian graph is the classical line graph and most simple graph type. This graph type is used when +you want to view closely related series of data. Any data can be viewed on a Cartesian graph. +On the Home tab, in the Create new display group, click the + Cartesian icon. +Figure 369: Example of a Cartesian graph with S-parameter results. +Altair Feko 2022.3 +3 POSTFEKO +Creating a Polar Graph +p.495 +A polar graph allows you to plot data that has at least one angular axis. You can either plot a full polar +graph or only display a sector of the polar graph. +On the Home tab, in the Create new display group, click the + Polar icon. +Figure 370: Example of a full polar graph and sector of a polar graph. +Creating a Smith Chart +A Smith chart allows you to view complex impedance, admittance, reflection coefficient and S- +parameters. +On the Home tab, in the Create new display group, click the + Smith icon. +Figure 371: Examples of a Smith chart (impedance and admittance). +Changing the Grid Type to Admittance +Modify the default grid type from impedance to admittance. +Select the Smith chart that you want to modify. +On the Display tab, in the Grid group, click the + Grid type icon. +Overlay Image for New Graphs +For the first five times that POSTFEKO is started after installation, an overlay image is displayed to +guide you on how to add data. The overlay image is removed once data is added to the graph. +Figure 372: Overlay image when creating a new graph. +3.9.2 Graph Settings +A number of settings are available to customise a graph. From changing the font, font size, adding fill, +changing the marker styling, adding shapes and text boxes, editing the graph title, footer and many +more settings to obtain graphs that suits your styling. +Editing a Graph Title, Footer and Axes +Modify the graph title, graph footer, vertical axis label and horizontal axis label. +Select the graph where you want to change the title, footer, or axis labels. +A default title, footer, vertical axis and horizontal axis are assigned to a graph based on its content. +1. On the Display tab, in the Display group, click the + Chart text icon. +Figure 373: The Advanced settings for 2D text entries dialog. +2. Edit the graph title. +a) Under 2D graph settings, next to the Graph title field, clear the Auto check box. +b) In the Graph title field, enter the text you want to add as the title. +Tip: Clear the Graph title field to remove the graph title. +3. Edit the graph footer. +a) Under 2D graph settings, next to the Graph footer field, clear the Auto check box. +b) In the Graph footer field, enter the text you want to add as the title. +Tip: Clear the Graph footer to remove the graph footer. +4. Edit the vertical axis label (or the horizontal axis label). +a) Under 2D axis settings, next to the Vertical axis field, clear the Auto check box. +b) In the Vertical axis field, enter the text you want to add as the title. +c) [Optional] Clear the Include unit in axis caption check box if you do not want a unit to be +assigned automatically to the axis based on the graph content. +5. Click OK to apply the changes and to close the dialog. +Adding Greek Symbols and Character Formatting to Text +Add Greek symbols to any text on a graph. Use rich text formatting on individual characters. +Greek symbols and individual character formatting are available for graph titles, axes titles, legend text, +and text boxes. +1. Click on the + Rich text formatting icon. +2. Modify the text. +3. Click OK to apply the changes and to close the dialog. +Tip: For a complete set of Greek symbols, click on More symbols. +Figure 374: The Rich text formatting dialog. +Changing the Font +Modify the default font and font styling for text on a graph. +Select the graph where you want to change the font. +Change the default font. +1. Select the text you want to change. +Tip: To select multiple objects, press and hold Ctrl while you click the items. +a) On the Format tab, in the Font group, select a font from the Font drop-down list. +2. Underline the text. +a) Select the text you want to underline. +b) On the Format tab, in the Font group, click the + Underline icon. +Adding a Fill to a Text Box or Shape +Add a colour fill to the interior of a text box or shape. +Select the graph where you want to change the look of a text box or shape. +1. Click the text box or shape that you want to fill. +2. On the Format tab, in the Colour group, select the + Flood fill button. +3. Select one of the following: +• To add or modify a fill colour, click the colour you want to use for the fill. +• To add a colour that is not included as one of the basic colours, click More colours. +• To remove the fill colour, click No colour. +Changing the Line Styling +Change the line style, line colour and line weight of a selected trace. +Select the graph where you want to change the line style, line colour and line weight and click the trace. +1. Change the line style of the selected trace. +a) On the Format tab, in the Line group, click the Line style icon. +b) Select one of the following: +• To remove the line style, click None. +• To modify the line style, click the line style you want to use. +2. Change the line colour of the selected trace. +a) On the Format tab, in the Line group, click the + Line colour icon. +b) Select one of the following: +• To modify a colour, click the marker colour you want to use. +• To add a colour that is not included as one of the basic colours, click More colours. +3. Change the line weight for the selected trace. +a) On the Format tab, in the Line group, click the + Line weight icon. +b) Select the line weight you want to use. +Changing the Marker Styling +Change the marker style, marker colour and marker size for a selected trace. +Select the graph where you want to change the marker style, marker colour and marker size and click +the trace. +1. Change the marker style for the selected trace. +a) On the Format tab, in the Marker group, click the + Marker style icon. +b) Select one of the following: +• To remove markers, click +. +• To add markers, select the marker style you want to use. +2. Change the marker colour for the selected trace. +a) On the Format tab, in the Marker group, click the + Marker colour icon. +b) Select the maker colour you want to use. +3. Change the marker size for the selected trace. +a) On the Format tab, in the Marker group, click the + Marker size icon. +b) Select one of the following: +• To select a specified marker size, click the marker size you want to use. +• To specify a marker size that is not included as one of the default sizes, click Custom. +c) Select the maker size you want to use. +Changing the Marker Placement +Change the marker placement for a trace to view the calculated points in a continuous frequency +simulation or for aesthetic reasons. +Select the graph where you want to change the marker placement and click the trace. +1. On the Format tab, in the Marker group, click the + Marker placement icon. +2. Select one of the following: +• To place markers at the calculated points on the trace, select + Calculated points. +• To place markers sparsely-spaced on the trace, select + Sparsely spaced. +• To place markers densely-spaced on the trace, select + Densely spaced. +Note: The Sparsely spaced and Densely spaced trace options are always visible in +a view, irrespective of the zoom level. +Adding a Shadow to Text or a Shape +Add a drop shadow to text or shape. +Select the graph where you want to add a drop shadow to text or a shape. +1. Add a drop shadow to text or a shape. +a) Click the text or shape. +b) On the Format tab, in the Effects group, click the + Drop shadow icon. +2. Change the depth of the drop shadow. +a) Click the text or shape. +b) On the Format tab, in the Effects group, click the + Shadow depth icon. +c) Select the depth you want to use for the drop shadow. +Specifying the Major Axes Range +Specify the range for the major axes. +Select the graph where you want to change the axis range. +1. On the Cartesian context tab, on the Display tab, on the Axes group, click the + Axis +settings icon. +Figure 375: The Axis settings dialog. +2. Select the axis that you want to modify. +• To modify the grid range for the horizontal axis, click Horizontal. +• To modify the grid range for the vertical axis, click Vertical. +3. Under Ranges, select one of the following: +• To automatically determine the grid range, select the Automatically determine the grid +range check box. +• To specify the dynamic range for the vertical axis, under Auto range setting, in the +Maximum dynamic range in dB field, enter a value for the dynamic range in dB. +Note: For the Maximum value the maximum value of the traces is used. +For the Minimum value the minimum value of the traces is used, or the +maximum value of the traces minus the specified dynamic range, whichever is +larger. +• To specify the grid range, clear the Automatically determine the grid range check box. +• In the Maximum value field, enter a value for the upper limit of the graph. +• In the Minimum value field, enter a value for the lower limit of the graph. +4. Click OK to apply the settings and to close the dialog. +Specifying the Grid Spacing +Specify the grid interval for the major (and minor) grid. +Select the graph where you want to change the grid spacing for the major grid (or minor grid). +1. On the Cartesian context tab, on the Display tab, on the Axes group, click the + Axis +settings icon. +2. Select the axis that you want to modify. +• To modify the grid range for the horizontal axis, click Horizontal. +• To modify the grid range for the vertical axis, click Vertical. +Modify the major grid spacing. +3. Under Grid spacing, select one of the following: +• To automatically determine the major grid spacing for the graph, select the Automatically +determine the major grid spacing check box. +• To specify the major grid spacing, clear the Automatically determine the major grid +spacing check box. +• In the Major grid spacing field, enter a value for the major grid spacing. +Modify the minor grid spacing. +4. Under Grid spacing, select one of the following: +a) In the Minor grid subdivisions field, enter a value for the minor grid spacing. +5. Click OK to apply the settings and to close the dialog. +Enable the minor grid to view the grid spacing. +6. On the Cartesian context tab, on the Display tab, on the Minor grid group, click the + Minor +grid icon. +Changing the Axis Scale to Logarithmic +Modify a graph to make use of a logarithmic scale when the data is spread over large range. A +logarithmic (log) scale allows you to view the data on a non-linear scale. +A log scale can be applied to a Cartesian graph for both the horizontal and vertical axes. For a polar +graph, a log scale can only be applied to the radial axis. +As an example, the horizontal axis of a Cartesian graph is changed to a log scale. The steps are similar +for changing the vertical axis of a Cartesian graph or the radial axis of a polar graph. +1. Select the Cartesian graph where you want to enable the log scaling for the horizontal axis. +2. On the Display tab, in the Axes group, click the + Log (horizontal) icon. +Reversing the Axis Order +Change the order in which values are plotted along the axis of a Cartesian graph. +The axis order can be reversed for both the horizontal axis and the vertical axis. +As an example, the vertical axis order of a Cartesian graph is reversed. The steps are similar for +reversing the horizontal axis order. +1. Select the Cartesian graph where you want to reverse the vertical axis order. +2. On the Cartesian contextual tabs set, on the Display tab, in the Axes group, click the + Reversed order (vertical) icon. +Figure 376: An example of a Cartesian graph. +Figure 377: An example of a Cartesian graph where the order of the vertical axis was reversed. +Changing the Unit of an Axis +Modify the axes units to allow data to be plotted in a familiar unit (for example, to change dBmV/m to +dBuV/m) or to shorten the axis text and make it more readable. +As an example, the vertical unit is changed. The step is similar for changing the unit of the horizontal +axis. +1. Select the trace. +2. On the Trace tab, in the Units group, from the Vertical unit drop-down list, select an unit. +Specifying the Number Format for an Axis +Specify the number format for the axes and the number of significant digits that are display on the +axes. +Select the graph where you want to change the major axis (or minor axis). +1. On the Cartesian context tab, on the Display tab, on the Axes group, click the + Axis +settings icon. +2. Select the axis that you want to modify. +• To modify the grid range for the horizontal axis, click Horizontal. +• To modify the grid range for the vertical axis, click Vertical. +Change the number format for the axis. +3. Under Number format, select one of the following: +a) From the Number format drop-down list, select one of the following: +• Decimal +• Scientific +Modify the number of significant digits for the axis. +4. Under Number format, select one of the following: +• To specify the number of significant digits that you want to see on the graph axis, clear the +Automatically determine the number of significant digits check box. +• From the Number of significant digits drop-down list, select the number of digits you +want to view on the graph. +• To determine the number of significant digits for the graph axis automatically, select the +Automatically determine the number of significant digits check box. +5. Click OK to apply the settings and to close the dialog. +3.9.3 Graph Legend +A graph legend is a summary of the trace or traces displayed on the graph. The legend also indicates +which colour represents each trace on the legend +Adding a Legend to a Graph +Add a legend to a graph, modify the legend position and specify the number of columns for the legend +entries. +Select the graph where you want to modify the legend. +Note: When you add a trace to a graph, a legend entry is added automatically. +1. Modify the legend position. +a) On the Display tab, in the Display group, click the + Position icon. +b) From the drop-down list select a position where you want to place the legend. +The graph is automatically resized based on the legend position. +2. Modify the number of columns displayed for the legend. +a) On the Display tab, in the Display group, click the + Number of columns icon. +b) From the drop-down list, select one of the following: +• To create a legend with a specified number of columns in the legend, select the number +you want to use. +• To create a legend where the number of columns is determined automatically, select +Auto. +Editing Legend Text +Modify or remove the legend entry text. +Select the graph where you want to modify the legend text and click the trace. +1. On the Cartesian context tab, on the Display tab, in the Legend group, click the + Trace text +icon. +Figure 378: The Legend entry settings dialog. +2. Specify the trace text for the graph legend. +a) Clear the Auto check box. +b) In the Legend text field, enter the trace text for the graph legend. +Tip: You can also use one of the following workflows: +• In the result palette or 3D view, select the trace. From the right-click context +menu, select Trace text. +• Press Shift+F2. +3. To remove a trace from the legend, select one of the following: +• Clear the Legend entry visible check box. +• Clear the Auto check box and delete the content in the Legend text field. +Use the trace label (displayed in the result palette) as the legend text. +4. Select the Use trace label text check box. +5. Click OK to apply the changes and to close the dialog. +Changing the Order of Legend Entries +Raise or lower a trace in the result palette to change the order of the legend entries (traces). +Related tasks +Raising and Lowering a Trace +3.9.4 Annotations and Cursors +Use annotations and cursors to read and interpret plotted results. +Annotations +Add an annotation to a trace to highlight values of interest. The annotation updates along with the data +and always display the value according to its definition. +Figure 379: An example of an annotation on a Cartesian graph. +Cursors +Cursors are dynamic and allow you to interact and move the cursors. Drag the cursors until they are +placed at the desired positions. Cursors allow data to be read off several traces simultaneously but +suffer from the limitation that it cannot update along with the results. +Figure 380: An example of cursors on a Cartesian graph. +Figure 381: An example of a cursor on a Smith chart. +Note: A Smith chart has a single cursor appearing as a small table. +Related tasks +Adding a Custom Point Annotation +Adding Cursors and a Cursor Table +Adding a Quick Single Point Annotation +Read a point from a graph by adding a quick single point annotation. +1. Select the graph where you want to add the annotation. +2. Position the mouse cursor on the graph trace. +3. Press Ctrl+Shift+left click. +Note: A quick single point annotation is not available for a Smith chart. +Adding a Custom Point Annotation +Add a custom point annotation to read the value and highlight a point of interest on the graph. +Select the trace where you want to read the point. +1. Add a single point annotation to indicate the global maximum of the selected trace. +a) On the Cartesian context tab, on the Measure tab, on the Custom annotations group, +click the + Points icon. From the drop-down list, click + Global maximum. +An annotation is added to the trace to highlight the maximum value. The annotation updates if the +data changes. +2. Add a custom single point annotation to indicate the first local minimum to the left (relative to the +global maximum). +a) On the Cartesian context tab, on the Measure tab, on the Custom annotations group, +click the + Points icon. From the drop-down list, click + Other. +Figure 382: The Configure annotation dialog. +a) In the Definition field, from the drop-down list, select First local maximum to the left. +b) Under Relative to, click Global maximum. +c) [Optional] Under Text, clear the Auto text check box and add the text you want displayed in +the annotation. +3. Click Create to create the annotation and to close the dialog. +Custom Point Annotations +A number of custom point annotations definitions are available for a Cartesian graph that allows you the +flexibility to annotate any point of interest on the graph. +On the Cartesian context tab, on the Measure tab, on the Custom annotations group, click the + Points icon. From the drop-down list, select the type of annotation you want to use. +Table 16: The custom point annotation definitions available in POSTFEKO. +Icon Icon text +Description +Global maximum +Global minimum +Specify independent axis +value +Place an annotation at the global maximum. +Place an annotation at the global minimum. +Place an annotation at a specified independent axis value. +Second maximum +Place an annotation at the second maximum. +Second minimum +Place an annotation at the second minimum. +Other +Opens a dialog where you can specify any of the following +custom point annotations: +• Global maximum +• Global minimum +• First local maximum +• First local maximum to the left +• First local maximum to the right +• Greatest local maximum +• Greatest local maximum to the left +• Greatest local maximum to the right +• First local minimum +• First local minimum to the left +• First local minimum to the right +• Greatest local minimum +• Greatest local minimum to the left +• Greatest local minimum to the right +• Value at given horizontal position +• Define independent value +Adding a Custom Annotation Between Two Points (Delta) +Add an annotation to highlight the difference between two points on a graph. +Add an annotation to the global maximum and the first local maximum to the left on the graph. +1. On the Cartesian context tab, on the Measure tab, on the Custom annotations group, click the + Delta icon. +Figure 383: The Annotation dialog. +2. +In the Definition field, from the drop-down list, select Fist local maximum to the left. +3. Under Relative to the, click Global maximum. +4. +[Optional] Under Text, clear the Auto text check box and add the text you want displayed in the +annotation. +5. Click Create to create the annotation and to close the dialog. +Adding a Custom Annotation to a Point and Its Derived Width +Specify a single point of interest. Add an annotation between adjacent points derived from the single +point. +As an example, add an annotation to indicate the -3 dB transmission bandwidth. +Select the trace where you want to read the derived width. +1. On the Cartesian context tab, on the Measure tab, on the Custom annotations group, click the + Derived width icon. +Figure 384: The Annotation dialog. +2. Under Relative to the, click Global maximum. +3. Under Place the annotation at, from the drop-down list select an offset of. +4. +[Optional] Under Text, clear the Auto text check box and add the text you want displayed in the +annotation. +5. Click Create to create the annotation and to close the dialog. +Adding Result Specific Annotations +For impedance results and far field results, custom annotations are available that allows you to quickly +add annotations relevant to the data types, for example, reflection bandwidth, transmission bandwidth, +beamwidth and sidelobe level. +Tip: Use custom annotations for custom data. +Annotations for Bandwidths +A specialised form of annotations is available for to annotate impedance results and to highlight +bandwidth. +Due to the varying definitions of “bandwidth” between industries and applications, definitions for both +transmission and reflection bandwidths are provided. +Reflection bandwidths are typically used in antenna modelling. Transmission bandwidths are used for +filters and other multi-port problems. +Note: -3 dB bandwidth refers to the frequency point where the power is at 3 dB below the +maximum value or half the maximum power. +Table 17: The reflection bandwidth annotation definitions available in POSTFEKO. +Icon Icon text +Description +-3 dB Reflection bandwidth +Place annotation to indicate the -3 dB half power reflection +bandwidth. +-10 dB Reflection bandwidth +Place annotation to indicate the -10 dB half power reflection +bandwidth. +-15 dB Reflection bandwidth +Place annotation to indicate the -15 dB half power reflection +bandwidth. +Table 18: Transmission bandwidth annotations. +Icon Icon text +Description +-3dB Transmission bandwidth +Place annotation to indicate the -3 dB half power +transmission bandwidth. +-10dB Transmission +bandwidth +Place annotation to indicate the -10 dB half power +transmission bandwidth. +-15dB Transmission +bandwidth +Place annotation to indicate the -15 dB half power +transmission bandwidth. +Highlighting the -3dB Bandwidth +Add an annotation to highlight the -3 dB reflection bandwidth for a source result. +Select the trace where you want to read the -3 dB bandwidth. +Add a Reflection bandwidth annotation. +a) On the Measure tab, in the Source annotations group, click the + Reflection bandwidth +icon. +b) From the drop-down list, select -3 dB. +Annotations for Beamwidth and Sidelobe Level +A specialised form of annotations is available to annotate far field results and to highlight beamwidth +and sidelobe level. +A number of annotations for beamwidth and sidelobe level are provided. The sidelobe level is defined +as the ratio between the maximum beam strength divided by the second largest beam strength. +Annotations for locating the first null and the bandwidth from null to null are also provided. +Table 19: The reflection bandwidth annotation definitions available in POSTFEKO. +Icon Icon text +Description +Half power (-3dB) +The -3 dB half power beamwidth. +First Null +The first null beamwidth. +Null to Null +The null to null beamwidth. +Sidelobe level +The sidelobe level. +Highlighting the Half Power (-3dB) Beamwidth and Sidelobe Level +Add an annotation to highlight the half power (-3dB) beamwidth for the far field result. +Select the graph and trace to which you want to add the annotation. +1. Add an annotation to highlight the half power (-3 dB) for the plotted result. +a) On the Measure tab, in the Far field annotations group, click the + Beamwidth icon. +b) From the drop-down list select Half power (-3dB). +2. Add an annotation to highlight the Sidelobe level. +a) On the Measure tab, in the Far field annotations group, click the + Sidelobe level icon. +Adding Cursors and a Cursor Table +Use cursors and its cursor table to read and interpret information from a graph. Place cursors at +predefined positions. +Select the graph where you want to read the information on the graph. +1. Enable cursors on the graph. +a) On the Measure tab, in the Measurement group, click the + Cursors icon. +2. Add a cursor table to the graph. +a) On the Measure tab, in the Measurement group, click the + Cursor table icon. +Figure 385: A Cartesian graph with cursor table. +Note: The table contains the data for the displayed points as well as the difference +(indicated by B-A). +Tip: If you move the cursor outside of the visible region of a graph, a handle appears +to retrieve the cursor. +3. Set the cursor position to a predefined position. For example, place the cursor at the global +maximum of the selected trace. +a) Select the trace where you want to find the global maximum. +b) On the Measure tab, in the Measurement group, click the + Global maximum icon. +Predefined Cursor Positions +View the available predefined cursor positions. +Table 20: Predefined cursor positions for graphs. +Icon Icon text +Description +Global max +Place the cursor at the global maximum +Global min +Place the cursor at the global minimum. +Local max to the left +Place the cursor at the next local maximum. +Local max to the right +Place the cursor at the next local maximum. +Local min to the left +Place the cursor at the next local minimum to the left. +Local min to the right +Place the cursor at the next local minimum to the right. +Adding Text Boxes and Shapes +Add text boxes and shapes to a graph to add a comment and highlight results. +1. Add a text box to a graph. +a) On the Format tab, in the Drawing group, click the + Text box icon. +b) In the Text field, enter the text you want to add to the graph. +c) Click Create to create the text box and to close the dialog. +2. Change the direction of the text box. +a) On the Format tab, in the Drawing group, click the + Text direction icon. +b) From the drop-down list select one of the following: +• To place the text horizontally, select Horizontal. +• To rotate the text clockwise by 90°, select Top to bottom. +• To rotate the text counter-clockwise by 90°, select Bottom to top. +3. Add a shape to the graph. +a) On the Format tab, in the Drawing group, click the + Shapes icon. +b) From the drop-down list select one of the following: +• To create a line, select Line. +• To create an arrow, select Arrow. +• To create a double-arrow, select Double arrow. +• To create a rectangle, select Rectangle. +• To create a circle, select Circle. +Note: Double-click a rectangle or circle to add text. +3.9.5 Overlaying an Image on a 2D Graph +Add an image to a Cartesian graph, polar graph or Smith chart to better interpret and understand the +results. +Adding a Static Overlay Image +Overlay an image on a graph. The image can either be a 3D view or imported from a file. +Select the graph to which you want to add the image. +1. On the Display tab, in the Image group, click the + Chart image icon. +2. From the drop-down list, select one of the following: an image from the 3D result view (if +available) or select Import file under Existing image. +• To add an image of the 3D view to the graph, select the relevant + 3D view. +• To import an image from a file, select + Import file. +Figure 386: A Cartesian graph with overlay image of the 3D view. The image was moved to the top-left. +Adding Image as Reference to Data Cut Orientation +Add an overlay image to a polar graph as a reference to the data cut orientation. +Data must already be added to the polar graph for this option to be available. +1. Select the polar graph where you want to add the image. +2. On the Display tab, in the Image group, click the + Chart image icon. +3. From the drop-down list select Model reference to data cut orientation. +4. Under Model reference to data cut orientation, select a far field request. +Note: This type of image is automatically updated depending on the selected data cut +for the trace. +Figure 387: The image is added to the polar graph as q reference to the data cut orientation. On the left, +phi was set to 0 degrees. On the right, phi was set to 270 degrees and the overlay image was automatically +updated to reflect the changes. +Customising an Overlay Image +Resize, position and orientate an overlay image. Apply opacity to the image. +1. Position and resize the image +a) Select the overlay image you want to customise. +b) Move the image by dragging the image with your mouse. +c) Resize the image by dragging the resize handles. +d) To center the image, from the right-click context menu, select Center image. +2. Set the opacity of the overlay image. +a) On the Display tab, in the Image group, click the + Opacity icon. +b) From the drop-down list, select a percentage or use Custom to set a custom percentage. +3. Change the orientation of static overlay image. +Note: This option is only available for a static overlay image. +a) On the Display tab, in the Image group, click the + Rotation icon. +b) From the drop-down list, select one of the predefined angles or select Custom to enter a +rotation angle. +3.9.6 Duplicating a Graph +Create a duplicate view of a graph, complete with all settings. +Note: Cursors on the graph are not duplicated. +Create a duplicate view. +a) Select the graph you want to duplicate. +b) On the Display tab, in the Duplicate group, click the + Duplicate view icon. +3.9.7 Copying and Converting to a Different Graph Type +Create a copy of the graph and change the graph type (if the data is compatible with both). For +example, create a polar graph copy from a Cartesian graph. +As an example, a polar graph copy is created from a Cartesian graph, but the steps are similar to derive +any graph type. +1. Select the graph from which you want to create a derived copy. +2. On the Display tab, in the Duplicate group, click the + Polar copy icon. +Note: If the traces on the source graph are incompatible with the derived graph, an +error is given stating the incompatible traces. +3.9.8 Trace Manipulation +A trace is a line plotted on a graph that represents a quantity relative to an independent axis. The +styling of the trace as well as the representation of the data can be manipulated. +Duplicating a Trace +Make a copy of a trace. +1. Select the trace you want to duplicate. +2. On the Trace tab, in the Manage group, click the + Duplicate trace icon. +Tip: You can also use one of the following workflows: +• In the result palette or 3D view, select the trace. From the right-click context +menu, select Duplicate trace. +• Press Ctrl+K. +Storing a Local Copy of a Data Set +Stores a local copy of the underlying data that is represented by the trace. By storing a local copy, you +can modify the existing model and compare the old results to the new results. +1. Select the trace that you want to store a copy of the underlying data. +Note: Most results from a graph can be stored, except for cable probes, error +estimates, imported data, rays, and currents and charges. +A new entry under Stored data is created that is accessible from the project browser or the +ribbon. +Figure 388: Accessing stored data from the ribbon. +2. On the Trace tab, in the Manage group, click the + Store a copy icon. +Math Traces +A math trace is created to perform calculations on existing data or to create mathematically defined +reference curves. These traces inherently contain no data and require other traces or mathematical +equations to present information. +Creating a New Math Trace +Use a math trace to define a mathematical reference curve. A math trace requires other traces or +mathematical equations to present information. +1. On the Trace tab, in the Manage group, click the + New math icon. +2. +In the result palette, under Maths, type an equation in the Maths field. +Figure 389: An example of a math trace created by using the RAMP function in the range 1e9 to 2e9 using +101 points. +Tip: To use the built-in functions, and constants from POSTFEKO, click the Editor +button to open the Expression editor dialog. +Figure 390: The Expression editor dialog. +Performing Calculations on Data Sets +Create a math trace to perform calculations on existing data sets. +1. Select the trace you want to use in the calculation. +2. +In the result palette, under Maths, select the Enable maths check box. +Figure 391: Select the Enable maths check box to perform calculations on a trace. +The text “self” appears in the text box. +3. Enter an equation using the term “self” to refer to the trace data. +Tip: To use the built-in functions, and constants from POSTFEKO, click the Editor +button to open the Expression editor dialog. +Raising and Lowering a Trace +Re-order the trace sequence in the result palette. Raising and lower a trace in the result palette also +changes the order of the legend entries. +Raise a trace. +1. Select the trace that you want to move. +2. On the Trace tab, in the Rendering group, click the + Raise trace icon. +Tip: You can also use one of the following workflows: +• In the result palette, select the trace. From the right-click context menu, select +Raise trace. +• Press Ctrl++. +Lower a trace. +3. Select the trace that you want to move. +4. On the Trace tab, in the Rendering group, click the + Lower trace icon. +Tip: You can also use one of the following workflows: +• In the result palette, select the trace. From the right-click context menu, select +Lower trace. +• Press Ctrl+-. +Related tasks +Changing the Order of Legend Entries +Transforming the Horizontal Axis +Stretch or shrink the independent axis or add an offset. +1. Select the graph for which you want to transform the axis. +2. On the Trace tab, in the Units group, click the + Transform axis (horizontal) icon. +3. +In the Transform horizontal axis dialog enter values for Scale and Offset. +Figure 392: The Transform horizontal axis dialog. +4. Click OK to apply the changes and to close the dialog. +Normalising a Trace or Graph +Normalise a graph or trace to interpret results better. +On the Display tab, in the Axes group, click the + Normalise To icon. Select one of the following: +• To normalise all traces to the maximum value found between all the traces, select the + Normalise to maximum of all traces icon. Only one trace has a maximum value of 1. +• To normalise each trace to its maximum, select the + Normalise to maximum of individual +traces. All traces have a maximum value of 1. +Changing the Sampling Settings +Specify the number of samples for continuous results displayed on graphs. +The default rendering for continuous data on a graph is determined automatically. The sampling can +be adjusted to display either the actual frequency samples or adjusted to display a set number of +frequency points. +1. Select the graph for which you want to modify the sampling. +2. On the Trace tab, in the Units group, click the + Sampling settings icon. +Figure 393: The Continuous sampling settings dialog. +3. From the Sampling method drop-down list, select one of the following: +• To display the default rendering where the sampling is determined based on the data, select +Auto. +• To display only the actual samples, select Discrete. +• To resample the data and display a fixed number of discrete points, select Specify number +of samples. +Tip: To export continuous data, use Specify number of samples or Discrete +samples to limit the number of samples (file size). +4. Click OK to set the sampling settings and to close the dialog. +Exporting Plotted Data to Clipboard or a Text File +Retrieve the plotted trace data and save to file. +1. On the graph, select the trace from which you want to export the plotted data. +2. Export the plotted data using one of the following workflows: +• To export the data to a .dat file, from the right-click context menu select to file (*.dat) and +specify the file name. +• To export the data to clipboard, press Ctrl+X. +3.10 Cartesian Surface Graphs +A Cartesian surface graph is a flat colour plot with results plotted against two independent axes. +Figure 394: Example of a near field displayed on a Cartesian surface graph. +The surface graph allows you to plot quantities like radar cross section (RCS), gain or near fields as a +function of two as a function of two independent parameters, such as angles theta and phi or frequency +and position. +Note: Only a single plot per Cartesian surface graph is supported. +Table 21: Result types that can be viewed on a Cartesian surface graph. +Result type +Far fields (including RCS) +Cartesian surface graph +Near fields +Error estimates +Currents +Rays +Sources +Loads +S-parameters +Power +3 POSTFEKO +Result type +Probes +Transmission / reflection coefficients +Characteristic modes +Imported data +Script data / custom datasets +Optimisation +Receiving antenna +SAR +3.10.1 Creating a Cartesian Surface Graph +Create a new Cartesian surface graph for displaying data. +On the Home tab, in the Create new display group, click the + Surface icon. +3.10.2 Editing a Graph Title, Footer and Axes +Modify the graph title, graph footer, vertical axis label and horizontal axis label. +Select the graph where you want to change the title, footer, or axis labels. +A default title, footer, vertical axis and horizontal axis are assigned to a graph based on its content. +1. On the Display tab, in the Display group, click the + Chart text icon. +Figure 395: The Advanced settings for surface graph text entries dialog. +2. Edit the graph title. +a) Under Title and footer labels, next to the Graph title field, clear the Auto check box. +b) In the Graph title field, enter the text you want to add as the title. +Tip: Clear the Graph title field to remove the graph title. +3. Edit the graph footer. +a) Under Title and footer labels, next to the Graph footer field, clear the Auto check box. +b) In the Graph footer field, enter the text you want to add as the title. +Tip: Clear the Graph footer to remove the graph footer. +4. Edit the vertical axis label (or the horizontal axis label). +a) Under Axes labels, next to the Vertical axis field, clear the Auto check box. +b) In the Vertical axis field, enter the text you want to add as the title. +c) [Optional] Clear the Include unit in axis caption check box if you do not want a unit to be +assigned automatically to the axis based on the graph content. +5. Click OK to apply the changes and to close the dialog. +3.10.3 Enabling Grid Lines and Grid Labels +Enable the major and minor grid lines for surface graphs as well as the grid labels. +Enable major grid lines. +1. Select the surface graph for which you want to enable grid lines. +2. On the Surface contextual tabs set, on the Display tab, in the Grid group, click the + Grid +icon. +Altair Feko 2022.3 +3 POSTFEKO +Enable minor grid lines. +p.527 +3. On the Surface contextual tabs set, on the Display tab, in the Grid group, click the + Minor +grid icon. +Note: Enable the major grid to view the minor grid. +Enable the minor grid labels. +4. On the Surface contextual tabs set, on the Display tab, in the Grid group, click the + Labels +(horizontal) icon. +Note: Enable the minor grid to view the minor grid labels. +3.10.4 Changing the Line Styling +Change the line style, line colour and line weight of the title, footer or axes from a selected surface +graph. +Select the surface graph where you want to change the line style, line colour and line weight and click +the title, footer or axes. +1. Change the line style of the selected title, footer or axes. +a) On the Format tab, in the Line group, click the Line style icon. +b) Select one of the following: +• To remove the line style, click None. +• To modify the line style, click the line style you want to use. +2. Change the line colour of the selected title, footer or axes. +a) On the Format tab, in the Line group, click the + Line colour icon. +b) Select one of the following: +• To modify a colour, click the marker colour you want to use. +• To add a colour that is not included as one of the basic colours, click More colours. +3. Change the line weight for the selected title, footer or axes. +a) On the Format tab, in the Line group, click the + Line weight icon. +b) Select the line weight you want to use. +3.10.5 Locking the Aspect Ratio +Lock the proportional relationship between the independent axes on Cartesian surface graphs to keep +the graph dimensions undistorted and true to the 3D model. +1. On the Surface contextual tabs set, on the Display tab, in the Axes group, click the + Lock +aspect ratio icon. +2. Select one of the following: +• To view the true aspect ratio between the independent axes, click + Enable locked aspect +ratio. The full graph area is not utilised when displaying the surface graph. +Figure 396: An example of a near field request where the aspect ratio is locked. +• To resize the independent axes to allow the full graph area to be utilised, click + Disable +locked aspect ratio. +Figure 397: An example of a near field request where the aspect ratio is not locked. +• To lock the original aspect ratio for the cases where the independent axes have the same +units automatically, click + Auto lock aspect ratio. +3.10.6 Swopping the Independent Axes +The two independent axes on a Cartesian surface graph can be interchanged when required. +In the result palette, click the + icon to interchange the independent axes. +3.10.7 Specifying the Major Axes Range +Specify the range for the major axes. +Select the graph where you want to change the axis range. +1. On the Surface contextual tabs set, on the Display tab, in the Axes group, click the + Axis +settings icon. +Figure 398: The Axis settings dialog. +2. Select the axis that you want to modify. +• To modify the grid range for the horizontal axis, click Horizontal. +• To modify the grid range for the vertical axis, click Vertical. +3. Under Ranges, select one of the following: +• To automatically determine the grid range, select the Automatically determine the grid +range check box. +• To specify the grid range, clear the Automatically determine the grid range check box. +• In the Maximum value field, enter a value for the upper limit of the graph. +• In the Minimum value field, enter a value for the lower limit of the graph. +4. Click OK to apply the settings and to close the dialog. +3.10.8 Reversing the Axis Order +Change the order in which values are plotted along the axis of a Cartesian surface graph. +The axis order can be reversed for both the horizontal axis and the vertical axis. +As an example, the vertical axis order of a Cartesian surface graph is reversed. The steps are similar for +reversing the horizontal axis order. +1. Select the Cartesian surface graph where you want to reverse the vertical axis order. +2. On the Surface contextual tabs set, on the Display tab, in the Axes group, click the + Reversed order (vertical) icon. +Figure 399: An example of a Cartesian surface graph. +Figure 400: An example of a Cartesian surface graph where the order of the vertical axis was reversed. +3.10.9 Storing a Local Copy of a Data Set +Stores a local copy of the underlying data that is represented by the Cartesian surface graph. By storing +a local copy, you can modify the existing model and compare the old results to the new results. +1. Select the surface graph result in the result palette that you want to store. +2. On the Surface contextual tabs set, on the Result tab, select the + Store a copy. +A new entry under Stored data is created that is accessible from the project browser or the +ribbon. +Figure 401: Accessing stored data from the ribbon. +3.10.10 Changing the Sampling Settings +Specify the number of samples for continuous results displayed on surface graphs. +The default rendering for continuous data on a graph is determined automatically. The sampling can +be adjusted to display either the actual frequency samples or adjusted to display a set number of +frequency points. +1. Select the graph for which you want to modify the sampling. +2. On the Surface contextual tabs set, on the Result tab, in the Rendering group, click the + Sampling settings icon. +Figure 402: The Continuous sampling settings dialog. +3. From the Sampling method drop-down list, select one of the following: +• To display the default rendering where the sampling is determined based on the data, select +Auto. +• To display only the actual samples, select Discrete. +• To resample the data and display a fixed number of discrete points, select Specify number +of samples. +4. Click OK to set the sampling settings and to close the dialog. +3.10.11 Adding a Quick Single Point Annotation +Read a single point from a Cartesian surface graph result by adding a quick single point annotation. +1. Select the Cartesian surface graph where you want to add the annotation. +2. Position the mouse cursor on the Cartesian surface graph result. +3. Press Ctrl+Shift+left click. +Figure 403: Press Ctrl+Shift+left click to add an annotation. +3.10.12 Adding a Custom Point Annotation +Add a custom point annotation to a Cartesian surface graph to read the value of a point and highlight +this point of interest on the graph. +Select the Cartesian surface graph where you want to read the point. +1. On the Surface context tab, on the Measure tab, on the Custom annotations group, click the + Point icon. From the drop-down list, select + Specify independent axis value. +Figure 404: The Configure annotation dialog. +2. +3. +In the Horizontal position field, specify a value on the horizontal axis. +In the Vertical position field, specify a value on the horizontal axis. +4. Specify the text displayed in the annotation. +• To specify text, clear the Auto text check box. In the Text field, enter the custom text. +• To add text containing the X value and Y axis, select the Auto text check box. +5. Click Create to add the annotation and to close the dialog. +3.10.13 Duplicating a Cartesian Surface Graph +Make a copy of the current Cartesian surface graph complete with all the settings. +On the Surface contextual tabs set, on the Display tab, in the Duplicate group, click the + Duplicate view icon. +3.10.14 Legend Range Settings +Adjust the legend range for the current active surface graph. +Cartesian surface graph data can be clamped between two values to help reveal changes in a result +that would be missed with the default range. The colouring of the result is changed whereby blue +corresponds to the minimum value and red to the maximum value. +On the Surface contextual tabs set, on the Display tab, in the Legends group, click the + dialog +launcher. +Figure 405: The Legend range settings dialog. +The following settings are available: +Round off legend range and +step size +Data is often represented in a decimal form to represent a value +accurately. The number of digits after the decimal point could +result in a legend range that is difficult to read and interpret. +Select this option for a more legible legend containing rounded off +values. The original data range is contained within the rounded off +range. +3.10.15 Scaling and Display Settings +A number of settings are available that affects how a result is scaled and displayed in a surface graph. +These settings influences the colour scaling of the legend and displayed colour range. +On the Surface contextual tabs set, on the Display tab, in the Legends group, click the + Individual range icon. +Figure 406: The Entity manual limits settings dialog. +Linear Scaling +For linear scaling, the following options are available to control the value range of the result: +Automatically determined from +data range +This option is applicable when you want the value range to clamp +between the maximum and minimum values of the result. +Fixed range +This option is applicable when you want to specify the maximum +and minimum values of the data range. +dB Scale +For dB scaling, the following options are available to control the value range of the result: +Automatically determined from +data range +This option is applicable when you want the value range to clamp +between the maximum and minimum values of the result. +Fixed range +This option is applicable when you want to specify the maximum +and minimum values of the data range. +Specify max dynamic range +This option is applicable when you want the maximum value of +the result data to be used as the upper limit for the legend values. +The minimum value of the result data is the maximum value of +the result data minus the dynamic range value entered or the +minimum value of the result data, whichever is larger. +Note: These settings affect the dynamic range limits. +3.10.16 Exporting Plotted Data to Clipboard or a Text File +Retrieve the plotted data and save to file. +1. Select the Cartesian surface graph that you want to export. +2. Export the plotted data using one of the following workflows: +• To export the data to a .dat file, from the right-click context menu select to file (*.dat) and +specify the file name. +• To export the data to clipboard, press Ctrl+X. +Altair Feko 2022.3 +3 POSTFEKO +3.11 3D Views +p.536 +View the simulation data in a 3D view to allow visual interpretation of the data in a human-readable +format, as well as to communicate the results in reports and presentations. The 3D view can also be +used to verify that the CADFEKO or EDITFEKO model is correct. +When a 3D result is added to a 3D view and the Solver is run, POSTFEKO monitors the simulation +results and updates the 3D view as the results become available for discrete frequency results. +For adaptive frequency sampling results (continuous frequency), POSTFEKO displays the discrete results +during the simulation and interpolate the results once the simulation is complete. +Related concepts +3D Result (Terminology) +Continuous Frequency (CADFEKO) +3.11.1 Creating a New 3D view +Create a new 3D view to verify the model and visualise the results. +1. On the Home tab, in the Create new display group, click the + 3D view icon. +2. From the drop-down list select one of the following: +• To select a configuration to add to a new 3D view, select a configuration from the list. +• To create a new empty view, select 3D view. +Figure 407: The drop-down list when a new 3D view is requested. +Tip: You can create multiple 3D views where each view has different settings. +3.11.2 Adding a Cutplane +Create a sectional view of the model by using a cut plane to show internal details that would otherwise +be hidden. Multiple cutplanes are supported. +1. On the 3D View contextual tabs set, on the Display tab, in the Display group, click the + Cutplanes icon. +2. Click the Plane definition tab. +Figure 408: The Cutplanes dialog, Plane definition tab. +a) [Optional] To create additional, click +. +Note: Click Remove to delete the cutplane. +b) In the Set to plane drop-down list, select one of the following for the orientation of the +cutplane: +• Global YZ +• Global XZ +• Global XY +• Oblique +◦ +◦ +In the Theta field, specify the theta angle in degrees. +In the Phi field, specify the phi angle in degrees. +c) [Optional] Click the Flip to alternate the normal direction of the cutplane, which in turn +determines which side of the plane is hidden. +d) Under Position, use the slider to place the cutplane at a specific location. +By default, everything in the model is affected by the cutplane. Entities that should be left uncut, can be +specified. +3. +[Optional] Click the Visibility filter tab. +Figure 409: The Cutplanes dialog, Visibility filter tab. +a) To prevent an entity from being cut, in the Cut entities panel, select the entity and click >. +4. Click OK to define the cutplane and close the dialog. +3.11.3 Adding Legends to a 3D View +Add up to four legends to a predefined location on the 3D view. Bind the legend to a specific entity (for +example, far field data or mesh display), based on the results displayed in the 3D view. +A legend can be placed top left, top right, bottom left and bottom right on the 3D view. As an example, +the legend is placed top left, although the steps are similar to placing the legend at one of the three +predefined locations. +1. Select the 3D view where you want to add a legend. +2. On the 3D View contextual tabs set, on the Display tab, in the Legends group, click the + Top +left icon. +3. From the drop-down list, select a result to link to legend. +Note: To remove a legend, select None from the drop-down list. +The legend is placed on the 3D view. +Legends Based on Multiple Results +Use a dialog for the active 3D view legend to make a selection if more than 19 results. +An active 3D view can display multiple result items. When a legend is added, a dialog is provided to +select from all the displayed results. +If the number of results exceeds 19 items, click More... at the bottom of the legend drop-down list. +Figure 410: A legend with many result items. +This opens the More... dialog where all the results can be selected from. +Figure 411: The More... dialog. +Altair Feko 2022.3 +3 POSTFEKO +Legend Range Settings +Adjust the legend range for the current active 3D view. +p.540 +3D view data can be clamped between two values to help reveal changes in a result that would be +missed with the default range. The colouring of the result is changed whereby blue corresponds to the +minimum value and red to the maximum value. +On the 3D View contextual tabs set, on the Display tab, in the Legends group, click the + dialog +launcher. +Figure 412: The 3D view legend range settings dialog. +The following settings are available: +Round off legend range and +step size +Scale to peak instantaneous +values +Scale to vector magnitude +Data is often represented in a decimal form to represent a value +accurately. The number of digits after the decimal point could +result in a legend range that is difficult to read and interpret. +Select this option for a more legible legend containing rounded off +values. The original data range is contained within the rounded off +range. +This option is applicable when viewing the magnitude of a result +along with the instantaneous phase. The minimum and maximum +value limits (and therefore the colours) remain constant for +each phase step. This option makes it simpler to see how the +magnitude changes over phase. +Clear the Scale to peak instantaneous values check box when +the magnitudes at the given phase are of interest to synchronise +the range limits with the displayed data. +This option is applicable when comparing two components of +a vector with one another. It is simpler to compare relative +magnitudes of the components if displayed relative to the same +maximum. Use this option to render the components relative to +Scale to visible results of the +same quantity +Scale only to selected +frequency +the total vector magnitude. This option allows a relatively small +component to be distinguished from a larger component. +This option is applicable when a model contains several near field +or far field requests. Each request has its minimum and maximum +value. For multiple results on a view, POSTFEKO display the data +relative to the minimum and maximum found over all the results +added to the view. Deselecting this option renders each result +according to its minimum, and maximum value. +This option is only enabled when discrete frequency data is +available in the model. The range limits are determined by the +minimum and maximum values found over all the calculated +frequency points. For example, it is more convenient to view the +change in far field gain over frequency when the far field is scaled +according to the maximum / minimum found over all calculated +points. +Scale only to selected time step This option is applicable for time domain analysis where the range +limits are determined by the minimum and maximum values of +the displayed data for a selected time signal sample. +Scale to request slice +dimensions +This option is applicable when the range values are to be +determined by the displayed slice[46]. +Note: Each setting is applied independently, meaning that a wide variety of combinations +are possible to help display and interpret the data in the desired manner. +Scaling and Display Settings +A number of settings are available that affects how a result is scaled and displayed in a view. These +settings influences the colour scaling of the legend and displayed colour range. +On the 3D View contextual tabs set, on the Display tab, in the Legends group, click the + Individual range icon. +46. For example, if you have a 3D near field result with data in the X axis, Y axis and Z axis, a slice of +data is a cut at a specific X value and Y value. +Figure 413: The Entity manual limits settings dialog. +Linear Scaling +For linear scaling, the following options are available to control the value range of the result: +Automatically determined from +data range +This option is applicable when you want the value range to clamp +between the maximum and minimum values of the result. +Fixed range +This option is applicable when you want to specify the maximum +and minimum values of the data range. +dB Scale +For dB scaling, the following options are available to control the value range of the result: +Automatically determined from +data range +This option is applicable when you want the value range to clamp +between the maximum and minimum values of the result. +Fixed range +This option is applicable when you want to specify the maximum +and minimum values of the data range. +Specify max dynamic range +This option is applicable when you want the maximum value of +the result data to be used as the upper limit for the legend values. +The minimum value of the result data is the maximum value of +the result data minus the dynamic range value entered or the +minimum value of the result data, whichever is larger. +Note: These settings affect the dynamic range limits. +3.11.4 Adding a Quick Single Point Annotation +Read a single point from a 3D view result by adding a quick single point annotation. +1. Select the 3D view where you want to add the annotation. +2. Position the mouse cursor on the 3D view result. +3. Press Ctrl+Shift+left click. +Figure 414: Press Ctrl+Shift+left click to add an annotation. +3.11.5 Adding Annotations to a 3D View Result +Add a single point annotation to a 3D view result. Multiple annotations can be added to a single +3D view. +1. Select the 3D view where you want to add a single annotation or multiple annotations. +2. On the 3D View contextual tabs set, on the Display tab, in the Display group, click the + Annotation type icon to enable. +3. From the Annotation type list, select one of the following: +• To highlight and add an annotation to an element, select the + Highlight and annotate +icon. +• To only highlight an element, select the + Highlight elements icon. +3.11.6 Duplicating a 3D View +Create a duplicate view of a 3D view, and copy the display settings. +1. Select the 3D view you want to duplicate. +2. On the 3D View contextual tabs set, on the Display tab, in the Duplicate group, click the + Duplicate view icon. +3.11.7 Duplicating a 3D Simulation Result +Make a copy of the 3D simulation result. +1. Select the 3D view and 3D view simulation result (either in the 3D view or the result palette). +2. On the 3D View contextual tabs set, on the Result tab in the Manage group, click the + Duplicate component icon. +Tip: You can also use one of the following workflows: +• In the result palette or 3D view, select the trace. From the right-click context +menu, select Duplicate component. +• Press Ctrl+K. +3.11.8 Storing a Local Copy of a Dataset +Store a local copy of the underlying data that is represented by the 3D simulation result. By storing a +local copy, you can modify the existing model and compare the old results to new results. +1. Select the 3D view and 3D view simulation result (either in the 3D view or the result palette) that +you want to store. +2. On the 3D View contextual tabs set, on the Result tab in the Manage group, click the + Store +a copy icon. +A new entry under Stored data is created that is accessible from the project browser or the +ribbon. +Figure 415: Accessing stored data from the ribbon. +3.11.9 Display Settings for 3D View +A number of display settings are available to customise the display of simulation results in the 3D view. +Visibility of Entities +All 3D entities are visible by default (except for named points), provided the model contains the entity. +The entity display options are available on the 3D view context tab, on the Display tab, in the Entities +group. +Table 22: Display options for 3D entities. +Icon Name +Description +Sources +Loads +Points +Show / hide sources, such as voltage sources, current sources and plane +waves. +Show / hide loads. +Show / hide named points. +Probes +Show / hide probes, such as voltage probes and current probes. +Cables +Show / hide cables. +Networks +Show / hide general non-radiating networks. +TX Line +Show / hide non-radiating ideal transmission lines. +RX antenna +Show / hide receiving antennas, such as far field receiving antennas and +near field receiving antennas. +Display Settings for Sources and Loads +Show or hide specific types of sources or loads in the 3D view. A source type can be displayed while +also coloured and scaled according to magnitude. +On the 3D View contextual tabs set, on the Display tab, in the Entities group, click the + dialog +launcher. +Figure 416: The Advanced entity display settings dialog. +You can use the Show and Hide panels to show or hide sources and loads selectively. Additional +options for sources are Colour by magnitude and Scale by magnitude. These options are often used +in conjunction with aperture sources, electric dipoles, magnetic dipoles and impressed currents. +Note: Sources and loads are only displayed if the visibility for these entities is enabled, +regardless if they are placed in the Show panel. +Visibility of Symmetry, FDTD Boundary, PBC Boundary and Array +Base Element +Show or hide the display of symmetry, the finite difference time domain (FDTD) boundary, the periodic +boundary condition (PBC) boundary and the array base element for finite arrays. +The method display options are available on the 3D view context tab, on the Display tab, in the +Method display group. +Table 23: Display options for symmetry, finite antenna arrays, PBC and FDTD boundary condition. +Icon Icon text +Description +Array Base Element +Show / hide the finite antenna array base element. +Icon Icon text +Description +Figure 417: A blue bounding box indicates the base element of the +finite antenna array. +Symmetry +Show / hide defined symmetry. +Periodic Boundary Conditions Show / hide periodic boundary conditions. +FDTD boundary type +Show / hide the FDTD boundary. +Axes Settings +Show or hide the display of the main axes, mini axes and tick marks. +The axes display options are available on the 3D view context tab, on the Display tab, in the Axes +group. +Table 24: Display options for axes and tick marks. +Icon Icon text +Description +Main axes +Mini axes +Show / hide the main axes. +Show / hide the mini axes. +Tick Marks +Show / hide tick marks on the main axes. +Specifying the Axis Size and Tick Marks +The axis size in relation to the 3D view can be specified as well as the placement of tick marks on the +axes. +Specify the axis size. +1. On the 3D View contextual tabs set, on the Display tab, in the Axes group, click the + dialog +launcher. +Figure 418: The Advanced axis settings dialog. +2. Under Axis size, select one of the following: +• To scale the axis dynamically with the size of the 3D view, select Scale with window. +• To scale the axis along with the model size, select Scale with model. +• To specify the length of the axes, select Specify axes length and specify the axes length. +Specify the axis tick marks. +3. To display the axes tick marks, select the Show tick marks check box. +4. Specify the placement of the tick marks. +• To place the tick marks at the default location on the axis, select Auto tick marks. +• To specify the number of tick marks on the axis, select Number of tick marks. +• To specify the increment between the tick marks on the axis, select Increment between +tick marks. +5. Click OK to close the dialog. +Altair Feko 2022.3 +3 POSTFEKO +Mesh Display Settings +p.549 +A number of mesh display settings are available to give you full control of the mesh rendering in the +3D view. These settings are useful if you want to verify the model (simulation mesh). +Mesh Rendering Options +View the display options for mesh colour, model outline, segment radius, wire coating, anisotropic +media, windscreen layers and mesh normals. +The mesh rendering options are available on the 3D View contextual tabs set, on the Mesh tab in the +Rendering group. +Note: Only the rendering options relevant to the model are available. For example, if the +model does not contain any windscreens, the Windscreen Layers icon is disabled. +Table 25: Display options for mesh colour, model outline, segment radius, wire coating, anisotropic media, +characterised surfaces, windscreen layers and mesh normals. +Icon Icon text +Description +Mesh colour: Element face +media +Mesh colour: Element region +media +The mesh faces are coloured according to their media. +The mesh is coloured according to the surrounding region. +For example, a model in free space is displayed in red to +indicate that the outside region is free space. +Mesh colour: Element label +The mesh is coloured according to mesh labels. +Mesh colour: Element normal +Mesh colour: Element type +An element normal defines the two sides of a triangle face +(normal side and reverse side). The element normal for a +triangle face is determined by order of the triangle vertices +according to the right-hand rule. The normal side is coloured +blue, while the reverse side is coloured brown. +The mesh is coloured according to mesh types contained +in the mesh. For example, different colours are be used for +wire segments, metallic triangles and dielectric triangles. +Model outline +Highlight the edges of the model faces. +Segment radius +Specify the display size for the segment radius. +Coating +Show / hide visibility of coatings on mesh wires and +triangles. +Icon Icon text +Description +Orientation +Display the principal direction (for anisotropic layers), +coordinate system (for 3D anisotropic media) or the +reference vector orientation for characterised surfaces. +Windscreen Layers +Show / Hide the display of the windscreen layer thickness. +Normals +Show / Hide the display of mesh normals. +Viewing Anisotropic Layers +Validate your model that contains multi-layered anisotropic composite media, by viewing the principal +direction. +1. On the 3D View contextual tabs set, on the Mesh tab, in the Rendering group, click the + Orientation icon. From the drop-down list select the + Layer icon. +Figure 419: The Anisotropic layer settings dialog. +Each face that has an anisotropic layer applied to is listed on the Anisotropic layer settings dialog. +Note: An anisotropic layer is applied to a label. +2. For each face, you can select the Show principal direction check box and specify the Layer +number to show the direction in the 3D view. +3. Click OK to close the dialog. +Viewing the Coordinate System for Anisotropic (3D) Media +Validate your model that contains anisotropic (3D) media, by viewing the principal direction for each +medium. +1. On the 3D View contextual tabs set, on the Mesh tab, in the Rendering group, click the +Orientation icon. From the drop-down list select the + Media (3D) icon. +Figure 420: The Anisotropic media (3D) settings dialog. +Each region that has an anisotropic (3D) medium applied to is listed on the Anisotropic media (3D) +settings dialog. +Note: An anisotropic (3D) medium is applied to a label. +2. For each region, you can select the Show coordinate system check box to show the coordinate +system in the 3D view. +3. Click OK to close the dialog. +Viewing the Reference Vector Orientation for Characterised Surface Mesh +Elements +Validate your model that contains characterised surface mesh elements, by viewing the reference vector +orientation. +1. On the 3D View contextual tabs set, on the Mesh tab, in the Rendering group, click the +Orientation icon. From the drop-down list select the + Characterised Surface icon. +Figure 421: The Characterised surface settings dialog. +Each face that has a characterised surface applied to, is listed on the Characterised surface +settings dialog. +2. For each face, you can select the Show U vector check box to show the direction in the 3D view. +3. Click OK to close the dialog. +The start of the vector (the coordinate system origin) is indicated by a yellow dot. The vector is +displayed as a blue line to indicate that it is aligned with the U reference direction. +Mesh Opacity Settings +Specify the mesh opacity as well as the opacity of windscreens triangles and aperture triangles. +The mesh opacity settings are available on the 3D View contextual tabs set, on the Mesh tab in the +Opacity group. +Note: Only the opacity settings relevant are available. For example, if the model does not +contain any windscreens the Windscreen icon is disabled. +Table 26: Display options for mesh opacity, windscreens triangles and aperture triangles. +Icon Icon text +Description +Mesh opacity +Specify the opacity for mesh elements. +Windscreen +Specify the opacity for windscreen elements. +Aperture +Specify the opacity for aperture elements. +Note: For all the opacity settings, a drop-down list is available to specify a custom opacity +level. A level of 100% is equivalent to setting no opacity, and 0% is equivalent to full +transparency. +Figure 422: Mesh opacity: 100% (left) and 20% (right). +Mesh Visibility Settings +View the visibility settings for segments, triangles, apertures, windscreens, tetrahedra, voxels, cuboids +and uniform theory of diffraction (UTD) polygons and cylinders. +The mesh visibility settings are found on the 3D View contextual tabs set, on the Mesh tab in the +Visibility group. +Note: Only the visibility settings relevant to the model will be available. For example, if the +model does not contain any voxels the Voxels icon is disabled. +Table 27: Display options for segments, triangles, apertures, windscreens, tetrahedra, voxels, cuboids and uniform +theory of diffraction (UTD) polygons and cylinders. +Icon Icon text +Description +Segments +Metal +Dielectric +Aperture +Windscreen +Tetrahedra +Voxels +Cuboids +Show / hide the surfaces, lines and vertices of mesh +segments. +Show / hide the faces, edges and vertices of metal triangles. +Show / hide the faces, edges and vertices of dielectric +triangles. +Show / hide the faces, edges and vertices of aperture +triangles. +Show / hide the faces, edges and vertices of windscreen +triangles. +Show / hide the faces, edges, vertices and volumes of +tetrahedra. +Show / hide the faces, edges, wire lines, wire surfaces, +volumes and grid of voxels. +Show / hide the faces, edges and vertices of cuboids.[47] +UTD polygons +Show / hide the faces, edges and vertices of UTD polygons. +UTD cylinders +Show / hide faces and edges of UTD cylinders. +Note: For all of these visibility settings, a drop-down list is available to individually set +the visibility for the faces, edges and vertices of the elements. For volumetric elements, an +additional volume option is provided. +Visibility Filter +The visibility filter provides additional control over the visibility of mesh elements. With this filter, mesh +regions with specific labels or specific media can be filtered out. +47. Cuboidal mesh elements can only be created in EDITFEKO. +On the 3D View contextual tabs set, on the Mesh tab, in the Visibility group, click the + Visibility +filter icon. +Figure 423: The Mesh visibility filter dialog. +Result Settings +A number of display settings are available to customise 3D view results. +Rendering Settings for Results +View the display settings for simulation results of far fields, near fields, currents and error estimates. +The result rendering settings are available on the 3D View contextual tabs set, on the Result tab, in +the Rendering group. +Note: Only the rendering settings relevant to the displayed results are enabled. For +example, if there are no near field iso-surfaces displayed, the Colour icon is disabled. +You can apply the rendering options to far fields, near fields, currents and error estimates. +Table 28: Display options for far fields, near fields, currents and error estimates. +Icon Icon text +Description +Grid +Overlays a mesh grid on the result. Provides a sense of +dimension to the 3D results. +Surface +Show / hide the coloured surface for the result. +Sampling settings +Adjusts the sampling settings for 3D continuous far fields. +Discrete +Removes the interpolated colouring of a surface and uses a +predefined set of colours to represent the surface. +Icon Icon text +Description +Colour +Offset +Opacity +Size +Specify the colour of the 3D near field iso-surfaces. +Opens the Set display offset dialog for moving the display +of the far field origin. +Specify the amount of transparency. +Scale the display of the far field. +Extrusion +Specify the extrusion for near field surfaces. +Sampling Settings for Continuous Far Fields +View the sampling options for sampling 3D continuous far fields. +On the 3D View contextual tabs set, on the Result tab, in the Rendering group, click the + Sampling settings icon. +Figure 424: The Continuous sampling settings dialog. +The following sampling options are available: +Table 29: Sampling settings for continuous far fields. +Sampling Setting +Description +Auto +Request points +The default rendering option automatically determined from +sampled data. +Disables continuous sampling and shows only the requested far +field points. +Specify angular resolution +Specify a custom sampling interval. +Moving the Display of the Far Field Origin +Move the display of the far field origin to be more consistent with the location of the source. +Far fields are displayed in POSTFEKO around the global origin. When the source of the radiator is +located away from the origin, the far field origin can be moved to show a more intuitive result. +1. Select the 3D view and far field result that you want to modify. +2. On the 3D View contextual tabs set, on the Result tab, in the Rendering group, click the + Offset icon. +3. On the Set display offset dialog specify new values for the U, V and N coordinates. +Tip: You can use Ctrl+Shift+left click to click on the new origin for the far field. +Figure 425: A dipole and PEC structure with a far field with no offset (on the left) and a far field with an +offset (to the right). +Extruding Far Fields or Near Fields +Change the extrusion of a field result to view the data in a different way. By adding or removing depth +to a surface, the relative impact of field values can be better understood. +Extrusion applies to far fields and near field surfaces that lie in a flat plane. +1. Select the 3D view and field result that you want to extrude. +2. On the 3D View contextual tabs set, on the Result tab, in the Rendering group, click the + Extrusion icon. +3. From the drop-down list, select one of the following: +• Select a predefined percentage from the list. +• To specify a custom percentage value, select Custom. +• To allow POSTFEKO to decide on an extrusion value automatically, select Auto. +Table 30: The effect of extrusion on far fields and near fields. +Setting Effect on Near fields +Effect on Far fields +0% +Flat surface. +A fixed radius sphere. +100% A surface with a height +dependent on the near field +value. +Auto +Same as 0% setting. +A surface with a radius dependent on the far field +value. +Electric field, gain, realised gain and directivity - +same as 100% setting. +Axial ratio and handedness - same as 100% +setting. +Custom Dependent on user setting. +Dependent on user setting. +Figure 426: Examples of far field extrusion, 0% (on the left) and 100% (to the right). +Figure 427: Example of near field extrusion, 0% (on the left) and 100% (to the right). +Display Options for Requests Points +Before a simulation is run, it is good practice to validate that the data were requested at the correct +locations. Request points and the display of the near field boundary are used to verify that far fields and +near fields requests are correct. +Requests points are displayed automatically if no result data is present. Once data becomes available, +the result data is displayed and the request points are hidden. +The requests display settings are available on the 3D View contextual tabs set, on the Result tab, in +the Requests group. +Table 31: Display options for request points and near field boundary. +Icon Icon text +Description +Auto request points display +Request points are displayed when no result data is present. +Once data is available, the request points are hidden. +Display request points +Request points are always displayed. +Don't display request points +Request points are never displayed. +Settings +Specify the display type (points, lines or surfaces) colour and +marker size for the request point. +Boundary +Show / hide the near field boundary. +Axes +Show / hide the local axes of the selected result. +Changing the Default Request Points Styling +Modify the request point type, colour and marker size. +1. Select the 3D view and the result where you want to change the request points styling. +2. On the 3D View contextual tabs set, on the Result tab, in the Requests group, click the + Settings icon. +Figure 428: The Request points display settings dialog. +3. +In the Type field, select one of the following: +• Points +• Lines +• Surface +4. Next to Colour, click the colour block to specify the colour for the request points. +5. Next to Marker size, move the slider to specify the size. Left to right maps to small to large. +6. Click OK to apply the settings and to close the dialog. +Display Options for Contours +View the display options for contours. Contour lines are curves that connect points where a function has +identical values. +The contour display settings are available on the 3D View contextual tabs set, on the Result tab, in +the Contours group. +Table 32: Display options for contours. +Icon Icon text +Description +Show contours +Show / hide contour lines. +Colour +Set the colour of the contour to any value, or the colour is +linked to the magnitude of the displayed value. +Position +Specify the number of contours or the contour values. +Changing the Default Contour Positions +Specify the number of contours and its location on a 3D result to view points of equal value. +Enable the display of contours. +1. On the 3D View contextual tabs set, on the Result tab, on the Contours group, click the + Show contours icon. +2. On the 3D View contextual tabs set, on the Result tab, in the Contours group, click the + Position icon. +Figure 429: The Contour positions dialog. +3. Select one of the following workflows: +• To specify the number of contours, select Number of contours. The contour values are +evenly distributed over the result range. +• To specify the number of contours coincident with a specific location, select Specify contour +values. The contour location can either be defined by its magnitude value, or by specifying a +percentage of the value range. +4. Click OK to close the dialog. +Display Options for Arrows +Display arrows to indicate the current flow direction or the field direction. +The arrow display settings are available on the 3D View contextual tabs set, on the Result tab, in the +Arrows group. +Note: Arrows can be plotted if the instantaneous magnitude of a current result or a field +result is displayed at a specific phase value. +Table 33: Display options for instantaneous vectors. +Icon Icon text +Description +Show arrows +Show / hide arrows. +Icon Icon text +Description +Colour +Sets the colour of the arrows to a user defined colour or +dependent on the result magnitude. +Fixed size +Enables or disables arrows displayed with a fixed size. +Arrow size +Specify the arrow size as a percentage for the selected result +Display Options for Rays +View the ray display options for ray launching geometrical optics (RL-GO) and uniform theory of +diffraction (UTD). +The UTD ray display settings are available on the 3D View contextual tabs set, on the Result tab, in +the Rays group. +The options are enabled on the POSTFEKO ribbon if a ray result is displayed in the 3D view. To obtain +the ray file, you must select the option to export the ray file in CADFEKO. +Table 34: Display options for UTD rays. +Icon Icon text +Description +Ray lines +Show / hide ray lines. +Ray numbers +Show / hide ray numbers. +Note: A ray number is a unique number or ID +associated with a ray. +Group numbers +Show / hide the ray group numbers. +Note: A ray group number is a unique number +or ID associated with a group of rays which all +belong to the same source, start at the same +location or end at the same observation point. +Intersections +Show / hide ray intersection points. +The following abbreviations are used in the 3D view: +• ·: Creeping wave intermediate point on geometry +surface +• B: Diffraction at an edge +Icon Icon text +Description +• D: Diffraction at a corner or a tip +• K: Diffraction at a wedge +• Q: Source point +• R: Reflection +• S: Observation point +• C: Creeping wave attaching and shedding point on +geometry surface +• V: Reflection at the shadow boundary of a creeping +wave +Threshold +Specify the visibility threshold of the rays as a percentage. +• 0%: All rays are displayed. +• 100%: All rays are hidden. +Colour magnitude +Enables / disables the display of rays in colour according to +its magnitude. +3.12 Frequency Domain Results +The Solver contains a number of frequency domain solution methods, as well as a time domain solution +method. By default, all simulation results are obtained in the frequency domain, unless explicitly using +the time analysis tool in POSTFEKO to convert the results to the time domain. +3.12.1 Result Types +View the result types that can be added to a 3D view or a graph. +The results types are available on the Home tab, in the Add results group. +Table 35: Result types that can be added to a graph or 3D view. +Icon Icon text +Description +Far field +Near field +The far field results, for example, electric field, gain, axial +ratio and RCS. +The near field results, for example, such as electric field, flux +density, SAR and isosurfaces. +Error estimate +Colours the mesh in the 3D view according to the results for +the error estimation. +Currents +Currents +The currents results such as electric currents, magnetic +currents and charges. +The currents results for wire segments such as electric +currents and charges. +Rays +Ray information for a model solved with the RL-GO or UTD. +Source data +Loads / Networks +S-matrix +Power +RX antenna +The source results, for example, input impedance, reflection +coefficient and VSWR. +The results for loads and networks, for example, voltage, +current and power. +The S-parameter results. +The results for source power, for example, power in the far +field and loss power. +The results for the receiving antenna, for example, received +power and phase. +Icon Icon text +Description +RX antenna +RX antenna +RX antenna +Probes +SAR +Optimisation +The results for the far field receiving antenna, for example, +received power and phase. +The results for the near field receiving antenna, for +example,received power and phase. +The results for the spherical modes receiving antenna, for +example, such as received power and phase. +The probe data from a cable schematic such as voltage and +current. +The SAR data such as 1g, 10, and volume average. +The optimisation data, for example, individual and global +goal and parameter data. +Transmission / reflection +The transmission and reflection coefficients. +Characteristic modes +The characteristic modes data, for example, model excitation +coefficient, eigenvalue and modal significance. +Imports + Scripts +Results from imported data and Lua scripts. +POSTFEKO only enable the icons for results available in the current model or project. +Restrictions on the Display of Data +The result types that can be displayed depends on the view type ( or graph). +3D views can display the following: +• far fields +• near fields +• error estimates +• currents +• rays +• SAR (only when calculated at a specific location) +Cartesian graphs can display all data, except for error estimates and currents on triangles (currents on +segments can however be displayed). +Polar graphs can display data that varies according to angle (theta or phi). Only near fields and far +fields meet this requirement. +Smith charts can display complex source data such as impedance and S-parameters. +Data can be imported for all graphs provided the data is consistent with the graph type. +Table 36: Summary of result types that can be plotted on various graphs types. +Cartesian +Smith +Polar +Result type +Characteristic modes +Far fields +Impedances +Loads +Near fields +Networks +Optimisation results +Power +Probes +Sources +Parameters +Transmission / reflection coefficients +Wire segment data (Charges / Currents / Error estimates) +3.12.2 Adding a Result from the Ribbon +Add a result to a 3D view or graph using the ribbon. +1. Select the 3D view or graph where you want to add a simulation result. +2. On the Home tab, in the Add results group, click the relevant icon (if results are available). +3. +If more than one result of the same request type are available, select a result. +Figure 430: Example of adding a far field result from the ribbon and selecting a specific result. +4. +5. +If multiple models are loaded into the same session, POSTFEKO will collapse the panel. +[Optional] Click Show more entries to view all the available results. +3.12.3 Adding a Result from the Project Browser +Add a result to a 3D view or graph using the project browser. +1. Select the 3D view or graph where you want to add a simulation result. +2. +3. +In the project browser, select the model. +In the model browser, click the Results tab. Use one of the following workflows: +• Drag a result onto the 3D view or graph. +• From the right-click context menu and select Add to active window or click Add to new to +create a new 3D view or graph. +Figure 431: Example of adding a far field result from the project browser and selecting a result. +Far Fields +View the quantities and properties that are available for a far field request. +On the Home tab, in the Add results group, click the + Far Field Source icon. +Altair Feko 2022.3 +3 POSTFEKO +Table 37: Properties for far field requests. +Quantity +Electric field +Gain +Realised gain +Directivity +Radar cross section (RCS) +Axial ratio +Handedness +The options available for far fields: +Total +Theta +Phi +Ludwig III (Co) +Ludwig III (Cross) +Proprietary Information of Altair Engineering +p.567 +Properties +Total +Theta +Phi +Ludwig III (Co) +Ludwig III (Cross) +LHC +RHC +Minor / Major +Major / Minor +The total value independent of the polarisation. +The vertical (or ) component. +The horizontal (or ) component. +The reference polarisation as defined by Ludwig for conventional +measurement configurations. An antenna that is Z directed +implied for which the reference polarisation is intended along the + cut. +(13) +The cross polarisation as defined by Ludwig for conventional +measurement configurations. An antenna that is Z directed +implied for which the reference polarisation is intended along the +. +(14) +Conventions for the Ludwig coordinate system are defined by the +and +Rotational angles in the spherical coordinate system as +defined in Feko. +Directional unit vector in the direction. +LHC +RHC +Figure 432: The reference and cross polarisations in 3D space. +The left hand circularly polarised component. The polarisation +vector rotates counter clockwise when viewed from a fixed +position in the direction of propagation. +The left hand circularly polarised component. The polarisation +vector rotates counter clockwise when viewed from a fixed +position in the direction of propagation. +Z (+45°) +When viewed in the direction of propagation, the unit vector +points downwards and the +polarisation vector is then + unit vector to the left. The Z- +which lies along an axis rotated +45 degrees from horizontal (in a +counter clockwise direction) — coinciding with the direction of the +diagonal line of the Z. +(15) +S (-45°) +The S-polarisation unit vector is +Minor/Major +Major/Minor +(16) +which rotated by -45° from horizontal and lies in the direction +approximated by the diagonal of the S. +Displays the magnitude of the axial ratio using the axes +specification, Minor/Major. +Displays the magnitude of the axial ratio using the axes +specification, Major/Minor. +Altair Feko 2022.3 +3 POSTFEKO +Handedness +Near Fields +Displays the sign information for axial ratio on a sphere using +different colours for left hand rotating, linear and right rotating +fields. +p.569 +View the quantities and properties that are available for a near field request. +On the Home tab, in the Add results group, click the + Near Fields icon. +Table 38: Properties for near field requests. +Quantity +Electric field +Magnetic field +Electric flux density +Magnetic flux density +Poynting vector +Properties +Scale near field power +Rho +Phi +Theta +SAR +Scale near field power +When any quantity (with the exception of SAR) and Magnitude is selected, POSTFEKO displays the +vector magnitude of all the selected components. If only one component is selected, POSTFEKO can +display the Phase, Real or Imaginary part of this component. +Currents and Charges +View the quantities and properties that are available for a current request. +On the Home tab, in the Add results group, click the + Currents icon. +Altair Feko 2022.3 +3 POSTFEKO +Table 39: Properties for current requests. +Quantity +Electric currents +Magnetic currents +Charges +p.570 +Properties +Magnitude +Instantaneous magnitude +Note: Magnetic currents are only applicable on dielectric surfaces modelled with the surface +equivalence principle (SEP). +Error Estimation +View the quantities and properties that are available for an error estimation request. +On the Home tab, in the Add results group, click the + Error Estimation icon. +The following quantities are available for error estimation: +• All mesh elements +• Triangles +• Segments +UTD / RL-GO rays +View the quantities and properties that are available when UTD or RL-GO rays are requested. +On the Home tab, in the Add results group, click the + Rays icon. +Note: UTD or RL-GO rays are not stored by default due to possible large file sizes. The rays +must be explicitly requested. +Source Data +View the quantities that are available for voltage, current and waveguide sources as well as FEM modal +ports. +On the Home tab, in the Add results group, click the + Source data icon. +Altair Feko 2022.3 +3 POSTFEKO +Table 40: Source quantities. +p.571 +Quantity +Voltage and Current sources Waveguide sources and FEM +modal ports +Impedance +Admittance +Voltage +Current +Reflection coefficient +VSWR +SWR +Source power +Power loss due to mismatch +Mismatch loss +Note: The quantities listed are only available for sources on ports. For ideal sources, such +as plane waves and electric dipoles, or equivalent sources such as far field and near field +sources, source data is not available since these sources are, per definition, not connected to +any geometry. +Loads and Networks +View the quantities and properties that are available for loads and networks. +On the Home tab, in the Add results group, click the + Loads/Networks icon. +Table 41: Quantities for loads and networks +Quantity +Impedance +Networks +Loads +Altair Feko 2022.3 +3 POSTFEKO +Quantity +Voltage +Current +Power +Power in +Note: The result palette for loads have a similar layout except there is no Port number. +S-parameters +View the settings for S-parameters. +On the Home tab, in the Add results group, click the + S-matrix icon. +The S-parameter is the only quantity for this request. The number of selectable results for S- +parameter will depend on the ports that were selected to be included in this request. +Power +View the quantities and properties that are available for power. +On the Home tab, in the Add results group, click the + Power icon. +The available quantities for power differ substantially based on the selected entity. For example a load +does not have the Active power quantity. +Power +FarField +NearField +Table 42: Quantities for power +Quantity +Active power +Loss power +Efficiency +Total radiated power +Quantity +Power +FarField +NearField +Power transmitted through surface +Note: The result palette for loads has a similar layout except there is no Port number. +Receiving Antennas +A receiving antenna data described by spherical modes can be added to a valid view. +On the Home tab, in the Add results group, click the + RX antenna icon. +The following quantities are available for receiving antennas: +• Active power +• Loss power +• Efficiency +• Received signal phase +Probes +The data for a voltage probe, current probe or a SPICE probe can be added to a graph. +On the Home tab, in the Add results group, click the + Probes icon. +Note: Request probe data from the cable schematic view in CADFEKO. +The following quantities are available for probes: +• Voltage +• Current +SAR (Specific Absorption Rate) +SAR does not have any special quantities or properties. +POSTFEKO can display specific absorption rate (SAR) values from near field calculations, but if spatial +peak SAR of either an 1g or 10g cube is required, a SAR calculation must be requested. +The result of the SAR calculation is displayed in the result palette. For peak SAR calculations, the +position is shown as a cube in the 3D view +Note: The cube for peak SAR calculations is only visible if the geometry is transparent or +cut away. +When viewing SAR results on a graph, the power lost or dissipated per medium is displayed in an info +box in the result palette. +Related reference +SAR Standards +Characteristic Modes +A characteristic mode results can be added to a valid view or graph. The mode can either be untracked +or tracked by correlating modes between frequency runs. +On the Home tab, in the Add results group, click the + Characteristic Modes Configuration icon. +The following quantities are available for characteristic modes: +• Eigenvalue +• Modal significance +• Characteristic angle +• Modal excitation coefficient +• Modal weighting coefficient +Note: For the independent axis you can plot the results versus Frequency, Mode index or +Mode index (untracked). +Imports and Scripts +Imported data or data generated by a script can be added to any view on which the data is valid. +On the Home tab, in the Add results group, click the + Imports + Scripts icon. +The quantities for imports and scripts depend entirely on the imported data or data created by the +script. +Optimisation +Optimisation data such as optimised parameters, goals, global goals and masks can be viewed on a +Cartesian graph after OPTFEKO was used to calculate the results. +On the Home tab, in the Add results group, click the + Optimisation icon. +Figure 433: Example of the result palette for optimisation. The Independent axis (Horizontal) is set as the +Optimisation run number. +Viewing the Mask on a Cartesian Graph +Display the piece-wise linear mask used to define the optimisation goal, on a Cartesian graph. +Note: Access masks from the project browser. +1. +2. +3. +In the project browser, select the model containing the defined mask. +In the model browser, select the Model tab. +In the tree, expand Optimisation. +4. Under Optimisation, expand Masks. +5. Select a mask. From the right-click context menu, select one of the following options: +• To add the mask to the currently selected Cartesian graph, click Add to active window. +• To create a new Cartesian graph and add the mask, click Send to new Cartesian graph. +Figure 434: The project browser containing two mask definitions. +Note: Scale the mask trace to view the mask on the same axis as the goal. +On the Trace tab, in the Units group, click the + Transform axis (horizontal) +icon. +3.13 Time Domain Results +With the time analysis tool in POSTFEKO, electromagnetic scattering problems can be analysed in the +time domain. The time domain results are obtained by applying an inverse fast Fourier transformation +(IFFT) on the frequency domain simulation results. +3.13.1 Guidelines for Defining a Time Signal +The simulated frequency range and frequency sampling affects the time signal that can be created. +Note: +• If part of the time signal does not fall within the same frequency range as the +simulation, it is possible that the windowing effect can introduce numerical artefacts in +the time domain results. +• The time signal repeats due to the application of an inverse fast Fourier transformation +(IFFT) on the frequency domain simulation results. Care should be taken that the +repeating time signal corresponds to the desired time signal. +Follow these basic guidelines when defining a time signal: +Total Signal Duration ( ) +For a given total signal duration of +, the lowest frequency to be simulated is given by: +The total signal duration should allow for the response signal to decay sufficiently before the time signal +repeats. +Note: The duration of the response signal decay is model dependent and only required +when the signal is not intended as a repeating time signal pulse. +(17) +Time Sampling ( ) +The time step + will be given by: +where + is the highest frequency to be simulated. +Number of Time Samples ( +) +The number of time samples is derived from: +Proprietary Information of Altair Engineering +(18) +Altair Feko 2022.3 +3 POSTFEKO +Number of Positive Frequency Samples +The number of frequency samples (positive) excluding zero is given by: +p.577 +(20) +3.13.2 Defining the Input Time Pulse +Create a time signal to analyse frequency domain results in the time domain. A list of predefined time +signals are available. +1. Obtain a frequency domain solution over the required bandwidth for the relevant requests. +2. On the Time analysis tab, in the Time signal group, click the + New time signal icon. +3. On the Create time signal dialog, from the Signal type drop-down list, select one of the +following time signals: +• Define pulse mathematically +• Double exponential difference pulse +• Double exponential piecewise pulse +• Gaussian pulse (normal distribution) +• Ramp +• Specify points manually +• Triangular pulse +Figure 435: The Create time signal dialog. +4. Modify the time signal parameters to adjust the time signal. +5. Click Create to create the time signal and to close the dialog. +Altair Feko 2022.3 +3 POSTFEKO +Define Pulse Mathematically +Define a time pulse using an analytical equation. +f(t) +) +( +Time +ds +p.579 +Figure 436: Define a time signal using an analytical equation. +Time axis unit +Specify the unit to be used for the time axis. +Total signal duration ( ) +The total length of the signal in the specified units. +f(t) +Analytical equation describing the input pulse, where “t” can be +used as the input time variable. +Number of samples +The number of samples taken from the signal’s analytical +equation. +Related concepts +Example: Define a Sine Wave Pulse +Related reference +Functions in Expressions +Define Pulse Mathematically +Double Exponential Difference Pulse +Double Exponential Piecewise Pulse +Gaussian Pulse (Normal Distribution) +Ramp Pulse +Specify Points Manually +Triangular Pulse +Example: Define a Sine Wave Pulse +Define a sine wave pulse with a delay of 0.3 ns and a duration of 0.5 ns. +Define Step(t) = 1 for t > 0.3 ns +On the Create time signal dialog, in the f(t) field, add the following to define a step function with a +delay of 0.3 ns: +(21) +Figure 437: The Signal preview shows the step function with a delay of 0.3 ns. +Define a Rectangular Pulse +In the f(t) field, define a rectangular pulse with a duration of 0.5 ns by extending Equation 21 to: +(22) +(23) +Figure 438: The Signal preview shows the rectangular pulse with a delay of 0.3 ns with a duration of 0.5 ns. +Define a Sine Wave Pulse +• In the f(t) field, define a sine wave pulse with a delay of 0.3 ns and a duration of 0.5 ns by +extending Equation 22 to: +Note: Predefined variables are not supported. Use a value of 3.14 instead of pi. +Figure 439: The Signal preview shows the sine wave pulse with a delay of 0.3 ns and a duration of 0.5 ns. +Note: Equation 23 and Figure 439 correspond to a modulated step signal at 7e9 GHz. +• Add a delay of 0.3 ns to the sine wave by extending Equation 23 to: +(24) +Figure 440: The Signal preview shows the final sine wave pulse. +Functions in Expressions +View the list of available functions in POSTFEKO. +Table 43: Mathematical functions supported in expressions. +Trigonometric functions (arguments expected in radians). +sin +cos +tan +cot +arcsin +Trigonometric inverse functions (results in radians). +arccos +arctan +arccot +atan2 +atan2(y,x) yields arctan(y/x) in the range - ... . +Hyperbolic functions +sinh +cosh +tanh +fmod +fmod(a,b) returns the remainder of the division a/b. +deg +Converts radians to degrees. +rad +log +ln +exp +sqrt +abs +step +Converts degrees to radians. +Logarithm to base 10 +Natural logarithm +Exponential function +Square root +Absolute value +step(x) is 1 when x>0; otherwise it is 0. +ceil +Rounded upwards +floor +Rounded downwards +min +max +min(a,b) gives the minimum of the two arguments. +max(a,b) gives the maximum of the two arguments. +Double Exponential Piecewise Pulse +Define a double exponential piecewise time pulse. +0u +) +( +dc +t0 +Time +ds +Figure 441: Define a double exponential difference time pulse. +Time axis unit +Specify the unit to be used for the time axis. +Total signal duration ( ) +The total length of the signal in the specified units. +Amplitude ( +) +The amplitude of the time signal. +Pulse delay ( ) +The pulse delay is the time until the peak of the time signal envelope. +Charge duration ( +) +The charge duration is the time from the pulse delay has ended until the signal begins to +discharge. +Altair Feko 2022.3 +3 POSTFEKO +Charge time constant ( ) +p.583 +The time that would be required to discharge the signal down to 36.8% of its full potential ( +). +Charge time constant ( ) +The time that would be required to charge the signal up to 63.2% of its full potential ( +). +Number of samples +The number of samples taken from the signal’s analytical equation. +(25) +(26) +(27) +The Fourier transform is as follows: +Double Exponential Difference Pulse +Define a double exponential difference time pulse. +0t +) +( +0t +Time +: +( - ) +ds +Figure 442: Define a double exponential difference time pulse. +Time axis unit +Specify the unit to be used for the time axis. +Total signal duration ( ) +The total length of the signal in the specified units. +Amplitude ( +) +The amplitude of the time signal. +Pulse delay ( ) +The pulse delay is the time until the peak of the time signal envelope. +Altair Feko 2022.3 +3 POSTFEKO +Time constant ( ) +p.584 +The pulse is defined as the difference of two exponentially charging pulses. The value of +describes the time that would be required for the subtracted signal to reach 63.2% of its full +potential ( +). +Time constant ( ) +The value of + describes the time that would be required for the base signal to reach 63.2% of its +full potential ( +). +Number of samples +The number of samples taken from the signal’s analytical equation. +(28) +(29) +The Fourier transform is as follows: +Gaussian Pulse (Normal Distribution) +Define a Gaussian time pulse with a normal distribution. +0u +) +( +wp +0t +Time +ds +Figure 443: Define a Gaussian time pulse with a normal distribution. +Time axis unit +Specify the unit to be used for the time axis. +Total signal duration ( ) +The total length of the signal in the specified units. +Amplitude ( +) +The amplitude of the time signal. +Pulse delay ( ) +The pulse delay is the time until the peak of the time signal envelope. +Pulse width ( +) +This is the half-amplitude pulse width of the signal. The pulse width is the total length of time that +the signal is above 50% of its peak value ( +). +Altair Feko 2022.3 +3 POSTFEKO +Number of samples +The number of samples taken from the signal’s analytical equation. +The Fourier transform is as follows: +Ramp Pulse +Define a ramp time pulse. +0u +) +( +0t +wp +Time +ds +Figure 444: Define a ramp time pulse. +Time axis unit +Specify the unit to be used for the time axis. +Total signal duration ( ) +The total length of the signal in the specified units. +Amplitude ( +) +The amplitude of the time signal. +Pulse delay ( ) +The pulse delay is the time until the peak of the time signal envelope. +Pulse width ( +) +This is the half-amplitude pulse width of the signal. The pulse width is the total length of time that +the signal is above 50% of its peak value ( +). +Rise time ( ) +The time required for the pulse to reach its peak value ( +) from rest. +Fall time ( ) +The time required for the pulse to reach the rest value from its peak ( +). +Note: The discharge time will be determined by the pulse width ( +). +(34) +Altair Feko 2022.3 +3 POSTFEKO +Number of samples +The number of samples taken from the signal’s analytical equation. +The Fourier transform is as follows: +Triangular Pulse +Define a triangular time pulse. +0u +) +( +wp +0t +Time +ds +Figure 445: Define a triangular time pulse. +Time axis unit +Specify the unit to be used for the time axis. +Total signal duration ( ) +The total length of the signal in the specified units. +Amplitude ( +) +The amplitude of the time signal. +Pulse delay ( ) +The pulse delay is the time until the peak of the time signal envelope. +Altair Feko 2022.3 +3 POSTFEKO +Pulse width ( +) +p.587 +This is the half-amplitude pulse width of the signal. The pulse width is the total length of time that +the signal is above 50% of its peak value ( +). +Rise time ( ) +The time required for the pulse to reach its peak value ( +) from rest. +Fall time ( ) +The time required for the pulse to reach the rest value from its peak ( +). +Note: The discharge time will be determined by the pulse width ( +). +Number of samples +The number of samples taken from the signal’s analytical equation. +(35) +(36) +The Fourier transform is as follows: +Specify Points Manually +Define a time pulse by specifying the points manually. +2(X ,Y )2 +n(X ,Y )n +) +( +1(X ,Y )1 +Time +Figure 446: Define a time signal by specifying the points. +Time axis unit +Specify the unit to be used for the time axis. +Scale time axis +A scale factor applied to the time axis values. +Scale amplitude +A scale factor applied to the amplitude axis values. +[Time, Amplitude] +Specify the Time (X) and Amplitude (Y) coordinates of the time signal. The pulse will be +resampled using number of specified samples, where linear interpolation between the defined +points will be used. +Note: The list of points can be imported from any comma separated value file. +Number of samples +The number of samples taken from the signal’s analytical equation. +3.13.3 Adding Time Domain Results to a View +Add the time results to a 3D view or graph. +You must have already solved the model over the required frequency range and defined a suitable time +signal. +1. Select the graph or 3D view to which you want to add time results. +2. On the Time analysis tab, in the Add time domain results group, click the relevant request +type. From the drop-down list select the request. +3.13.4 Time Domain Results +The following time domain results can be added to a valid 3D view or graph. +Table 44: The time result types that can be added to a graph or 3D view. +Icon Icon text +Description +Time signal +Adds the defined time signal to a graph. +Far field +Near field +Sources +Adds a far field time analysis result to a graph or 3D view. +Adds a near field time analysis result to a graph or 3D view. +Adds a source time analysis result to a graph. +Sparameters +Adds an S-parameter time result to a graph. +Loads +Networks +Currents +Adds a load time analysis result to a graph. +Adds a networks time analysis result to a graph. +Adds a currents time analysis result to a 3D view or graph. +SPICE probes +Adds a SPICE probe time analysis result to a graph. +3.13.5 Spectral Extrapolation Techniques +When performing a time analysis where lower frequencies are not simulated and need to be estimated, +different options are available to extrapolate the spectral component of the simulation result to 0 Hz. +On the Time analysis tab, in the Add time domain results group, click the + dialog launcher. +Figure 447: The Time analysis options dialog. +Note: The adaptive sampling technique provides more accurate low frequency extrapolation +than linear interpolation but can be less predictable. +Altair Feko 2022.3 +3 POSTFEKO +3.14 Animation +p.590 +Use animation to obtain a better understanding of results or export the animation to use in a +presentation or report. +Animate the following properties: +• phase (requires a result) +• frequency (requires a result) +• camera angle (requires geometry) +◦ phi +◦ +◦ +theta +theta and phi +Figure 448: An example of animation (not supported in PDF User Guide). +3.14.1 Animating a Result +Gain insight into a result by animating a result. +For this example, the result is animated over time step. A time signal and time result are required to +animate over time. +1. Select the 3D view and the result that you want to animate. +2. On the 3D View contextual tabs set, on the Animate tab, on the Settings group, click the + Type icon. From the drop-down list, select the + Time step icon. +3. On the 3D View contextual tabs set, on the Animate tab, on the Control group, click the + Play icon. +Note: To stop the animation, click the + Play icon. +3.14.2 Exporting an Animation +Export an animation of a model to use in a presentation or report. +1. On the 3D View contextual tabs set, on the Animate tab, on the Animation group, click the + Export animation icon. +Figure 449: The Export animation dialog. +2. From the Save as type drop-down list, select one of the following: +• AVI +• MOV +• GIF +• MKV +3. From the Export quality drop-down list, select one of the following: +• High +• Normal +• Low +Setting the quality affects the compression ratio for the specified screen size. For very high-quality +exports, it is good practice to reduce the screen size to as small as is need and setting the Export +quality to High. +4. From the Export size drop-down list, select one of the following: +• Same as source +• QQVGA (160x120) +• QVGA (320x240) +• VGA (640x480) +• SVGA (800x600) +• XGA (1024x768) +• SXGA (1280x1024) +• Custom +5. +In the Frame rate (frames per second) field, specify the frame rate. Setting the frame rate +affects how “smooth” the animation appears. +6. Click OK. +The Animation export file name dialog is displayed. +7. +8. +In the File name field, specify the name of the exported animation file. +In the Save as type, specify the file type of the exported animation file. +9. Click Save to export the animation to file and to close the dialog. +3.14.3 Animation Controls and Settings +View the controls available to control the animation. +On the 3D View contextual tabs set, on the Animate tab, on the Control group, click the + Play +icon. +Table 45: Animation controls and settings. +Icon Icon text +Description +Play +Faster +Slower +Type +Legend +Settings +Start / stop the animation. +Increases the speed of the animation - more changes per +second of viewing. +Decreases the speed of the animation - less changes per +second of viewing. +Specify the animation type: frequency, phase or camera +angle. +Show / hide the display the animation legend. +Advanced animation settings. +Frequency +Animation over frequency. +Phase +Time step +Animation over phase. +Animation over time step. A time step animation requires a +time signal and a time domain result added to the 3D view. +Phi Rotate +Animation over camera angle phi. +Theta rotate +Animation over camera angle theta. +Theta and Phi rotate +Animation over camera angle theta and phi +3.14.4 Advanced Animation Settings +Specify the speed and resolution with which a variable animates when animating a property. +On the 3D View contextual tabs set, on the Animate tab, on the Settings group, click the + Animation settings icon. +Figure 450: The Advanced animation settings dialog. +Frequency Animation Settings +Frequency (points/s) +Specify the animation speed. +Continuous frequency sampling (# of points) +For continuous frequency models, the frequency range is broken into a number of discrete steps, +thereby specifying the sampling resolution. +Time Animation Settings +Phase (wt/s) for time harmonic signals +Specify the phase increment per second. +For example, setting phase (wt/s) = 30° will result in the phase incrementing by 30° each second +and a complete 360° loop in 12 seconds. +Real time duration of animated time signal(s) +Specify the time duration of the animation before it starts to loop. +Camera Angle Animation Settings +Phi (deg/s) +Specify the phi angle for the camera angle during animation. +Altair Feko 2022.3 +3 POSTFEKO +Theta (deg/s) +Specify the theta angle for the camera angle during animation. +General Settings +Frame rate (frames/s) +Specify the rate at which the consecutive images are displayed. +p.594 +3.15 Generating Reports +POSTFEKO is a useful tool to help analyse and present data in a useful format. It is often required to +use the processed results in a report or presentation. To help make it easier to generate these reports, +several tools are available in POSTFEKO. +Note: For Microsoft PowerPoint and Microsoft Word, you need to have Microsoft Office 2003 +or later installed. +3.15.1 Exporting an Image +Export an image of the active view to file. +1. On the Reporting tab, in the Export images group, click the + Export image icon. +Figure 451: The Export image dialog. +2. Select a view to export. +3. From the Image format drop-down list, select one of the following: +• PNG +• BMP +• CUR +• ICNS +• JPG +• PBM +• PGM +• TIF +• WBMP +• WEBP +• PDF +• EPS +• EMF +4. From the Export size drop-down list, select one of the following: +Altair Feko 2022.3 +3 POSTFEKO +• Same as source +• QQVGA (160x120) +• QVGA (320x240) +• VGA (640x480) +• SVGA (800x600) +• XGA (1024x768) +• SXGA (1280x1024) +• Custom +5. Click OK. +p.596 +The Image export file name dialog is displayed. +6. +7. +In the File name field, specify the file name of the exported file. +In the Save as type, specify the file type of the exported file. +8. Click Save to export the active view to file and to close the dialogs. +3.15.2 Generating a Quick Report +Generate a report with minimal effort using selected images and headers from a POSTFEKO session +using a predefined report template. +1. On the Reporting tab, in the Reports group, click the + Generate quick report icon. +Figure 452: The Generate quick report dialog. +2. From the Document type drop-down list, select one of the following: +• MS PowerPoint (*.pptx) +Altair Feko 2022.3 +3 POSTFEKO +• MS Word (*.docx *.doc) +• PDF (*.pdf) +3. +4. +In the Document heading field, specify the report title. +In the table, specify the page titles, graphs to include and the graph captions. +5. For Microsoft Word and PDF reports, specify the Page orientation. +6. From the Image format drop-down list, select one of the following: +p.597 +• PNG +• BMP +• CUR +• ICNS +• JPG +• PBM +• PGM +• TIF +• WBMP +• WEBP +• PDF +• EPS +• EMF +7. From the Export size drop-down list, select one of the following: +• Same as source +• QQVGA (160x120) +• QVGA (320x240) +• VGA (640x480) +• SVGA (800x600) +• XGA (1024x768) +• SXGA (1280x1024) +• Custom +8. Click Generate to generate the report. +Figure 453: Example showing the Feko template for the quick report (Microsoft Word document). +Figure 454: Example showing the Feko template for the quick report (Microsoft PowerPoint document). +3.15.3 Defining a Microsoft Template +Decide on a Microsoft template to define the theme, company logo and branding to use when creating a +POSTFEKO report template. +These styled templates can be obtained from Microsoft or you can create a template with a specific +theme, company logo and branding. +• For Microsoft Office 2010 and onward, use “content controls”. +Note: “Content controls” only applicable to Microsoft Word. +• For Microsoft Office 2007 and older, use “rectangular shape placeholders”. +Defining a Microsoft Word Template Using Content Controls +Create a report template in Microsoft Word that uses content controls to create structured content that +can be reused each time you generate a report. +1. Create a Microsoft Word (.dotx) template using one of the following workflows: +• Use one of the predefined templates provided by Microsoft. +• Create a template with the required styling. +Figure 455: Example of a Microsoft Word template (.dotx file) with styling. +2. +In POSTFEKO, decide on the graphs and 3D views to be added to the report. +For this example, the startup model is used. The required views are the 3D view and the graphs +are: +• startup1 +• Cartesian graph1 +• Smith chart1 +Figure 456: The startup model with the 3D view (startup1), Cartesian graph (Cartesian graph1) and Smith +chart (Smith chart1) which will be required for the report. +3. +In Microsoft Word, activate the Developer tab. +a) On the application menu, click Options > Customize Ribbon and select the Developer +check box. +Figure 457: The Word Options dialog in Microsoft Word. Select the Developer check box to enable the +Developer tab in Microsoft Word. +4. Add content controls to the Microsoft Word template. +a) In Microsoft Word, on the ribbon click the Developer tab. +b) Add a Picture Content Control (Controls group) to the template at each location in the +template where a graph or 3D view is to be added. +5. Enable Design Mode in Microsoft Word. +On the Developer tab, in the Controls group, click the Design Mode icon. +6. Add tags to the Microsoft Word template. +a) For each content control, on the Developer tab, in the Controls group, click Properties. +b) On the Content Control Properties dialog, add the tag that links to a specific POSTFEKO +graph. +For this example, the tag is TagFor3dView. +Figure 458: The Content Control Properties dialog in Microsoft Word where the tag for the POSTFEKO +graph is specified. +7. Save the Microsoft Word (.dotx) template. +Defining a Microsoft Template Using Rectangular Placeholders +Create a report template in Microsoft PowerPoint or Microsoft Word that uses rectangular placeholders +to create structured content that can be reused each time you generate a report. +1. Create a Microsoft PowerPoint (.potx) or Microsoft Word (.dotx) template using one of the +following workflows: +• Use one of the predefined templates provided by Microsoft. +• Create a template with the required styling. +2. +In POSTFEKO, decide on the graphs and 3D views to be added to the report. For this example, +the startup model will be used. The required views are the 3D view and the graphs are startup1, +Cartesian graph1 and Smith chart1. +3. +In Microsoft Word or Microsoft PowerPoint add “placeholders” to the template. +a) Add a rectangle (Shapes) to the template for each required graph. It acts as a placeholder +for the graph. +b) Select a placeholder and from its right-click context menu select Add text. +c) Add the text , where tag is a unique label linking to a specific graph or +3D view. +For this example, the startup model is used. The required views are the 3D view and the +graphs are: +• startup1 +• Cartesian graph1 +• Smith chart1 +d) [Optional] Add text descriptions and title for the graphs and 3D views. +Figure 459: The template with “rectangular placeholders” at the positions in the template where the 3D view +and graphs will be required and (b) the report that will be generated when using this template. +4. Save the Microsoft PowerPoint (.potx) or Microsoft Word (.dotx) template. +3.15.4 Defining a POSTFEKO Report Template +Create a POSTFEKO report template when it is required to create consistent reports. The reports are +generated from a preconfigured POSTFEKO report template using styling from aMicrosoft PowerPoint or +a Microsoft Word template. +1. On the Reporting tab, in the Reports group, click the + Define template icon. +Figure 460: The Define report template dialog. +2. +In the Document type drop-down list, select one of the following: +Altair Feko 2022.3 +3 POSTFEKO +• MS Word (*.docx *.doc) +• MS PowerPoint (*.pptx) +p.604 +3. +In the Template field, specify the Microsoft template to be used for the report generation. +4. Click Next. +Figure 461: The Define report template dialog. +5. +6. +7. +In the Image format drop-down list specify the image format. +In the Export size drop-down list select the export size of the images used in the report. +In the table specify the POSTFEKO graph or 3D view for each tag used in the Microsoft template. +8. Click Next > Done. +Tip: View the report template in the project browser under Report templates. +9. +[Optional] Modify the report template. +a) On the Reporting tab, in the Reports group, click the + Modify template icon. +3.15.5 Generating a Report From a POSTFEKO Report +Template +After a report template was defined, create a report using the report template. +1. On the Reporting tab, in the Reports group, click the + Generate quick report icon. +2. From the drop-down list, select one of the following workflows: +• Select an existing defined report template from which to create the report. +• To set up a report template, select Define report template. +3.15.6 Exporting a Report Template for Reuse +A report template can be exported to XML format for reuse in another POSTFEKO session. +1. On the Reporting tab, in the Reports group, click the + Import / Export template icon. +From the drop-down list select the + Export report template (*.xml) icon. +Figure 462: The Export report template dialog. +2. From the Report template drop-down list, select a defined report template. +3. +In the File name field enter a file name to be used for the exported template. +4. Click OK to export the report template and to close the dialog. +3.15.7 Importing a Report Template for Reuse +A report template can be imported from an XML file to reuse in the current POSTFEKO session. +1. On the Reporting tab, in the Reports group, click the + Import / Export template icon. +From the drop-down list select the + Import report template (*.xml) icon. +Figure 463: The Import report template dialog. +2. +In the File name field, browse for the XML file to import. +3. Click OK to import the XML file and to close the dialog. +3.15.8 Using LuaCOM to Control Microsoft Word and +Microsoft Excel +Use a Lua script to generate Microsoft Word or Microsoft Excel documents with specified content without +having to open the applications. +Ensure that you are using the Windows operating system and that Microsoft Word and/or Microsoft +Excel is installed on the machine. +1. Open the script editor. +2. Create a new empty script. +3. As an example, load one of the scripts below into the script editor. +4. Run the script. +-- MS WORD +require "luacom" +-- Open Word +local msword = luacom.CreateObject("Word.Application") +assert(msword, "Could not open MS Word") +-- Initialise the document +msword.Visible = true +doc = msword.Documents:Add() +-- Add content +insertionPoint = doc.ActiveWindow.Selection +insertionPoint.Style = "Heading 1" +insertionPoint:TypeText( "Feko Says..." ) +insertionPoint:TypeParagraph() +insertionPoint:TypeText( "Hello world!" ) +-- MS EXCEL +require "luacom" +-- Open Excel +local excel = luacom.CreateObject("Excel.Application") +assert(excel, "Could not open MS Excel") +-- Initialise the worksheet +excel.Visible = true +workbook = excel.Workbooks:Add() +worksheet = workbook.Worksheets:Add() +-- Populate the data and display the contents of cell A3 +worksheet.Range( "A1", "A1" ).Value2 = [[hello]] +worksheet.Range( "A2", "A2" ).Value2 = [[world]] +worksheet.Range( "A3", "A3" ).Value2 = [[=CONCAT(A1," ",A2,"!!")]] +feko.Form.Info( "Excel says...", worksheet.Range( "A3", "A3" ).Value2 ) +-- Change an input value and display A3 once again +worksheet.Range( "A2", "A2" ).Value2 = [[everybody]] +feko.Form.Info( "Excel says...", worksheet.Range( "A3", "A3" ).Value2 ) +Altair Feko 2022.3 +3 POSTFEKO +3.16 Lua Scripting +p.607 +Feko provides a powerful scripting language that allows you to create scripts that control CADFEKO and +POSTFEKO. +3.16.1 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. +On the Home tab, in the Scripting group, click the + Script editor icon. +The script editor includes the following IDE (integrated development environment) features: +1. Syntax highlighting. +2. +3. +Intelligent code completion. +Indentation for blocks to convey program structure, for example, loops and decision blocks in +scripts. +4. Use of breakpoints and stepping in scripts to debug code or control its execution. +5. An active console to query variables or execute simple commands. +Figure 464: The script editor in POSTFEKO. +Altair Feko 2022.3 +3 POSTFEKO +3.16.2 Application Macros +p.608 +An application macro is a reference to an automation script, an icon file and associated metadata. +Application macros are available directly or can be added, removed, modified or executed from the +application macro library. +Tip: A large collection of application macros are available in CADFEKO and POSTFEKO. +On the Home tab, in the Scripting group, click the + Application macro icon. +Related concepts +CADFEKO Application Macros +POSTFEKO Application Macros +Altair Feko 2022.3 +3 POSTFEKO +3.17 Tools +p.609 +POSTFEKO has a collection of tools that allows you to quickly validate the model, for example, measure +distances, measure angles and finding specific mesh elements. +3.17.1 Measuring a Distance +The measure distance tool allows you to measure or validate the physical distance between two points +in a model. +1. On the 3D View contextual tabs set, on the Mesh tab, in the Tools group, click the + Measure +Distance icon. +2. Under Point1, use Ctrl+Shift+left click to snap to points (for example, named points, geometry +points, geometry face centre, geometry edge centre, mesh vertices and grid). +3. Repeat Step 2 for Point 2. +The total distance, as well as the individual X axis, Y axis and Z axis distances, are displayed in +the Distance (D), X distance, Y distance and Z distance fields respectively. +4. Click Close to close the dialog. +Figure 465: The Measure distance tool. +Altair Feko 2022.3 +3 POSTFEKO +3.17.2 Measuring an Angle +p.610 +Use the angle measuring tool to measure or validate the angle (in degrees) between three points in a +model. +1. On the 3D View contextual tabs set, on the Mesh tab, in the Tools group, click the + Measure +Angle icon. +2. Under Point1, use Ctrl+Shift+left click to snap to points (for example, named points, geometry +points, geometry face centre, geometry edge centre, mesh vertices and grid). +3. Repeat Step 2 for Point 2. +4. Repeat Step 2 for Point 3. +The angle in degrees is displayed in the Angle (degrees) field. +5. Click Close to close the dialog. +Figure 466: The Measure angle dialog. +3.17.3 Highlighting the Non-Included Angle +Use the include angle highlighting tool to show the non-included angle between flat mesh triangles. +On the 3D View contextual tabs set, on the Mesh tab, in the Tools group, for the + Include angle +icon, specify the non-included angle + and click the icon. +The non-included angle is highlighted in the 3D view with pink color where applicable. +Figure 467: Example of non-included angle displayed in POSTFEKO. +3.17.4 Finding Elements +Locate specific mesh elements by element number (ID) in the 3D view. +When a warning or error message is obtained during the solution of a model, in some cases the +message is related to a specific mesh element.[48]. With the Find elements tool, you can find and view +the location of the mesh element. +1. On the 3D View contextual tabs set, on the Mesh tab, in the Tools group, click the + Find +Elements icon. +2. From the Element type drop-down list, select the type of mesh element you want to find. +3. +In the Element ID(s) field, enter the element number(s) you want to find. +Tip: Search for multiple elements by separating the element numbers with a comma. +48. The mesh element ID(s) would be given in the .out file +Figure 468: Finding two mesh triangles by ID (number). +4. +[Optional] To retain the annotations, click Add annotation(s). +5. Click Close to close the dialog. +3.17.5 Confirming Mesh Connectivity +The mesh connectivity tool allows you to view free edges in the 3D view. +Free edges can be used to confirm if a mesh is connected. +Note: A free edge is an edge that is only on the boundary of a single face. +On the 3D View contextual tabs set, on the Mesh tab, in the Tools group, click the + Connectivity +icon. +Figure 469: On the left, an example of two unconnected rectangles. To the right, the two rectangles are unioned. +Edges displayed in red indicate free edges. +3.17.6 Highlighting Specific Mesh Elements +The mesh highlight tool allows you to view areas of the mesh where specific model settings are applied. +On the 3D View contextual tabs set, on the Mesh tab, in the Tools group, click the + Highlight icon. +From the drop-down list select one of the following: +• +• +• +• +• +• +• +• +• +• +• +• +None +No mesh elements are highlighted. + Lossy metal +Highlight mesh elements (faces, wires) with a metallic medium and thickness applied to it. + Coating +Highlight mesh elements (faces, wires, edges) with a coating (layered dielectric) applied to it. + CFIE / MFIE +Highlight mesh elements (faces) with either a combined field integral equation (CFIE) or +magnetic field integral equation (MFIE) applied to it. + EFIE +Highlight mesh elements (faces) with the electric field integral equation (EFIE) applied to it. + Impedance sheet +Highlight mesh elements (wires, faces) with an impedance sheet applied to it. + Surface impedance approximation +Highlight faces that bound a region set to the dielectric surface impedance approximation. + Physical Optics +Highlight mesh elements (faces) with the physical optics (PO) solution method applied to it. + Physical Optics (Fock regions) +Highlight mesh elements (faces) with the physical optics (PO) solution method applied to a +Fock region. + Ray Launching GO +Highlight mesh elements (faces) with the ray launching geometrical optics (RL-GO) solution +method applied to it. + Uniform Theory of Diffraction +Highlight mesh elements (faces) with the uniform theory of diffraction (UTD) solution method +applied to it. + Faceted Uniform Theory of Diffraction +Highlight mesh elements (faces) with the faceted uniform theory of diffraction (faceted UTD) +solution method applied to it. +• +• +• +• +• + FEM +Highlight mesh elements (regions) with the finite element method (FEM) solution method +applied to it. + VEP +Highlight mesh elements (regions) with the volume equivalence principle (VEP) solution +method applied to it. + Windscreen solution elements +Highlight mesh elements (faces, wires) that are specified as windscreen solution elements +(windscreen antenna elements). + Aperture +Highlight a slot or aperture in an infinite plane with the planar Green's function aperture +applied to it. + Numerical Green's Function +Highlight mesh elements defined as the static part using the numerical Green's function. +Figure 470: On the left, a 3D view of a horn and a reflector with no highlighting applied. To the right, the reflector +is highlighted in yellow to indicate that PO solution method is applied to the face. +3.18 Files Generated by POSTFEKO +View the files associated and generated by POSTFEKO. +Table 46: Files generated by POSTFEKO +Argument +Description +.fek +.bof +.out +.pfs +.pfg +POSTFEKO reads the .fek to display the geometry and the calculation +requests (for example the near field request points will be displayed if a near +field calculation was requested). +POSTFEKO reads the .bof file to display the results as obtained by the +Solver. Incomplete .bof files can be loaded and the results displayed. +The results for discrete frequency calculations are displayed as they +become available. This allows simulations that terminated due to system +power failure to be loaded and displayed, showing the results which were +calculated prior to the failure. +The .out file may be displayed to view information regarding the Solver +version, date, memory usage and results obtained by the Solver and any +errors and warnings etc. +Contains the POSTFEKO workspace, for example, views, graphs, models, +settings and references to result files which were present at the time of +save. +The .pfg file is used to store optimisation process information used for +graphing in POSTFEKO after / during an optimisation run. +Altair Feko 2022.3 +3 POSTFEKO +3.19 Shortcut Keys +p.616 +View the shortcut keys available for POSTFEKO for faster and easier operation of POSTFEKO. +Keyboard shortcut keys help you to save time accessing actions that you perform regularly. The +shortcut key or key combination is also displayed in the keytip that is displayed when you hover the +mouse over the action on the ribbon. +Shortcut Key +Feko Components +Alt+0 +Alt+1 +Alt+2 +Alt+4 +Alt+6 +Alt+8 +General Editing +F1 +Ctrl+C +Ctrl+X +Ctrl+F +Ctrl+F +Ctrl+E +Ctrl+P +Description +Run CADFEKO. +Run EDITFEKO. +Run PREFEKO. +Run Solver. +Run OPTFEKO. +Open the Feko terminal. +Context-sensitive help for the dialog / window that +has focus. +Copy image to clipboard. +Copy data to clipboard. +Locate geometry (3D view). +Find and replace text (script editor). +Export image. +Print current window. +Ctrl+Shift+O +Open POSTFEKO project file. +Ctrl+N +Ctrl+O +Ctrl+S +Ctrl+Q +Create a new session. +Add a model. +Save POSTFEKO session file. +Quit POSTFEKO. +Ctrl+Z +Ctrl+Y +Alt+B +Alt+B +Ctrl+K +F2 +Ctrl+F2 +Ctrl+Shift+left click +Shift+F2 +Ctrl++ +Ctrl+- +Del +View +F5 +Ctrl+5 +Undo +Redo. +Show / hide the project browser. +Show / hide the visibility the project browser. +Duplicate trace / component. +Rename trace / result. +Change the labels, title and footer of a graph +Add annotation in 3D view or to a Cartesian graph +or polar graph. +Edit trace text. +Raise trace. +Lower trace. +Delete selected items. +Zoom to extents. +Restore view. +Top view. +Bottom view. +Front view. +Back view. +Left view. +Right view. +3D View Interaction +F5 +Zoom to extents. +Shift + hold while scrolling mouse wheel +Slow zoom (3D view). +Scroll mouse wheel +Zoom (3D view). +Click + drag with middle mouse button +Panning (3D view, schematic view). +Ctrl + click / drag +Panning (3D view). +Left click + drag mouse +Rotation (3D view). +Script Editor +Ctrl+N +Ctrl+O +Ctrl++ +Ctrl+- +Ctrl+G +Create a new empty script. +Open script. +Zoom in. +Zoom out. +Goto line. +EDITFEKO +4 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. +This chapter covers the following: +• 4.1 Introduction to EDITFEKO (p. 620) +• 4.2 Quick Tour of the EDITFEKO Interface (p. 624) +• 4.3 PREFEKO Language Concepts (p. 632) +• 4.4 Creating Geometry in EDITFEKO (p. 649) +• 4.5 Preferences (p. 654) +• 4.6 Files Generated by EDITFEKO (p. 655) +4.1 Introduction to EDITFEKO +EDITFEKO is a scripting interface for advanced users to construct models using a high-level scripting +language, which includes FOR loops and conditional IF-ELSE statements. +EDITFEKO can also be used for advanced editing of a model created in CADFEKO. Most models do not +require the use of EDITFEKO, but some advanced options are not available in EDITFEKO and would +require EDITFEKO. +When creating a model in EDITFEKO, the model geometry and calculation requests are entered on +separate lines in the .pre file and are referred to as cards. Each card has a number of parameters +that must be specified in a specific order. The language used in EDITFEKO is known as the PREFEKO +language (the PREFEKO application translates the cards into a format understood by the solver and +saves it to a .fek file). +Important: The order of the cards in the .pre file controls the order of the steps during +the simulation. +4.1.1 EDITFEKO Workflow +View the typical workflow when working with the Feko component - EDITFEKO. +Figure 471: Illustration of the EDITFEKO workflow. +Create the PRE File +Define the .pre file containing the mesh parameters, geometry, excitations, frequency and output +requests. +Altair Feko 2022.3 +4 EDITFEKO +Verify the Model +p.621 +Although PREFEKO is run as part of running Feko, it is recommended to first run PREFEKO to verify the +commands and syntax of the .pre file. The .pre file does not have to be complete, but requires at least +an EG card and EN card. +If no error is given, view the (partial) model mesh, settings and requests in POSTFEKO. +Run the Solver +Run the Feko solver to obtain simulation results for the output requests. Take note of notes and +warnings to ensure that the model setup correctly. Any errors will terminate the simulation and has to +be corrected. +View Model and Results in POSTFEKO +The completed model and results can be viewed in POSTFEKO on a 3D view or 2D graphs. The ASCII +.out file produced during the simulation can also be viewed in POSTFEKO. +Related concepts +Structure of the PRE File +4.1.2 Launching EDITFEKO (Windows) +There are several options available to launch EDITFEKO on Windows. +Launch EDITFEKO using one of the following workflows: +• Open EDITFEKO using the Launcher utility. +• Open EDITFEKO by double-clicking a .pre file. +• Open EDITFEKO from other components, for example, from inside CADFEKO and POSTFEKO. +Note: If the application icon is used to launch EDITFEKO, no model is loaded and the +start page is shown. Launching EDITFEKO from other Feko components, automatically +loads the model into the editor. +Related tasks +Opening the Launcher Utility (Windows) +4.1.3 Launching EDITFEKO (Linux) +There are several options available to launch EDITFEKO on Linux. +Launch EDITFEKO using one of the following workflows: +• Open EDITFEKO using the Launcher utility. +• Open a command terminal. Use the absolute path to the location where the EDITFEKO executable +resides, for example: +/home/user/2022.3/altair/feko/bin/editfeko +• Open a command terminal. Source the “initfeko” 3D view using the absolute path to it, for +example: +. /home/user/2022.3/altair/feko/bin/initfeko +Sourcing initfeko ensures that the correct Feko environment is setup. Type editfeko and press +Enter. +Note: Take note that sourcing a script requires a dot (".") followed by a space (" ") and +then the path to initfeko in order for the changes to be applied to the current shell +and not a sub-shell. +Related tasks +Opening the Launcher Utility (Linux) +4.1.4 Command Line Arguments for Launching EDITFEKO +EDITFEKO can be launched via the command line. Use command line arguments to pass information on +how EDITFEKO is to be launched. +Syntax using the command-line options: +editfeko [FILES] [OPTIONS] +FILES +Loads the specified .pre files. Any number of .pre files can be loaded. +OPTIONS +-h, --help +Displays the help message. +--version +Print the version information and exit. +If EDITFEKO is launched without providing a filename, no model is loaded and the start page is shown. +Launching EDITFEKO with a .pre file, it loads the model into the editor. +4.1.5 Start Page +The Feko start page is displayed when starting a new instance (no models are loaded) of CADFEKO, +EDITFEKO or POSTFEKO. +The start page provides quick access to and a list of Recent models. +Links to the documentation (in PDF format), introduction videos and website resources are available on +the start page. Click the + icon to launch the Feko help. +Figure 472: The EDITFEKO start page. +4.2 Quick Tour of the EDITFEKO Interface +View the main elements and terminology in the EDITFEKO graphical user interface (GUI). +Figure 473: The EDITFEKO window. +1. Quick Access Toolbar +2. Ribbon +3. Script Editor Area +4. Edit Card +5. Status Bar +6. Card Panel +7. Help +8. Search Bar +9. Application Launcher +10. Application Menu +Altair Feko 2022.3 +4 EDITFEKO +4.2.1 Quick Access Toolbar +p.625 +The quick access toolbar is a small toolbar that gives quick access to actions that are often performed. +The toolbar is located at the top-left corner of the application window, just below the title bar. It allows +you to create a new model, open a model, save a model, undo a model operation or redo a model +operation using fewer mouse clicks for a faster workflow. The actions available on the quick access +toolbar are also available via the ribbon. +4.2.2 Ribbon +The ribbon is a command bar that groups similar actions in a series of tabs. +Figure 474: The ribbon in EDITFEKO. +1. Application menu +The application menu button is the first item on the ribbon. When the application menu drop- +down button is clicked, the application menu is displayed. The menu allows saving and loading +of models, import and export options as well as giving access to application-wide settings and a +recent file list. +2. Core tabs +A tab that is always displayed on the ribbon, for example, the Home tab and Construct tab. +The Home tab is the first tab on the ribbon and contains the most frequently used commands for +quick access. +3. Contextual tab sets +A tab that is only displayed in a specific context. +EDITFEKO does not have any contextual tabs. +4. Ribbon group +A ribbon tab consists of groups that contain similar actions or commands. +5. Dialog launcher +Click the dialog launcher to launch a dialog with additional and advanced settings that relate to +that group. Most groups don't have dialog launcher buttons. +Keytips +A keytip is the keyboard shortcut for a button or tab that allows navigating the ribbon using a +keyboard (without using a mouse). Press F10 to display the keytips. Type the indicated keytip to +open the tab or perform the selected action. +Figure 475: An example of keytips. +Application Menu +The application menu is similar to a standard file menu of an application. It allows saving and loading of +models, print functionality and gives access to application-wide settings. +When you click on the application menu drop-down button, the application menu, consisting of two +panels, is displayed. +The first panel gives you access to application-wide settings, for example: +• Creating a new model. +• Opening a model, saving a model and closing a model. +• Print +• Check for updates +• Settings +◦ Preferences +◦ Component launch options +• Feko help +• About +◦ Version information about EDITFEKO +Information about Altair Simulation Products +Information about third-party libraries +◦ +◦ +• Exit +The second panel consists of a recent file list and is replaced by a sub-menu when a menu item is +selected. +Figure 476: The application menu in EDITFEKO. +Home Tab +The Home tab is the first tab on the ribbon and contains the most frequently used operations. +Figure 477: The Home tab in EDITFEKO. +4.2.3 Script Editor Area +The editor area allows you to edit .pre files. The script editor includes syntax highlighting and each file +is contained in its own tab. +Tip: +• Re-order the window tabs by simply dragging the tab to the desired location. +• View the path to the open .pre file by hovering with mouse cursor over the window tab. +• Drag-and-drop functionality is supported. +The editing tools are available on the Home tab, in the Edit group. +Altair Feko 2022.3 +4 EDITFEKO +Table 47: Editing tools. +p.628 +Icon Icon text +Description +Copy +Cut +Paste +Copy the selected text to clipboard. Shortcut: Ctrl+C +Cut the selected text to clipboard. Shortcut: Ctrl+X +Paste the text from clipboard. Shortcut: Ctr+V +Comment +Block comment the selected items. Shortcut: Alt+C +Uncomment +Uncomment the selected items. Shortcut: Alt+U +Find / Replace +Goto line +A find and replace tool with the following text search +functionality: Find next, Find previous, Replace, Replace +all, Close. Shortcut: Ctrl+F +A tool which allows you to find a specific line in the script. +This is useful when PREFEKO reports an error with a +corresponding line number. +4.2.4 Edit Card +Press F1 on a card to highlight the card entry in the editor area and display the full card definition in the +card panel. +Note: A yellow background for a card entry indicates that the selected card is in editing +mode. +4.2.5 Status Bar +The status bar is a small toolbar that shows the line and column number for the current cursor position +as well as the setting for the text editor (insert or overwrite). +The status bar is located at the bottom-right of the application window. Options on the status bar are +also available on the ribbon, but since the status bar is always visible, they are easily accessible no +matter which ribbon tab is selected. +Altair Feko 2022.3 +4 EDITFEKO +4.2.6 Card Panel +p.629 +The card panel contains the full card definition and provides editing of the card parameters. +Press F1 on a card to highlight the card entry in the editor area and display the full card definition in the +card panel. A new card can be created by clicking on the corresponding button on the ribbon. +Card panels make it easy to edit cards and enter data in the correct card fields. The panels support +cards that span multiple lines and they automatically use the correct card format (column or colon +delimited). Once the panel has been populated with the data, click on OK to apply the changes, write +the card and close the panel. +Tip: +• Click the OK button to add the card to the .pre file and close the card panel. +• Click the Add button to add the card to the .pre file, but keep the card panel open. +4.2.7 Help +The Help icon provides access to the Feko documentation. +Press F1 to access context-sensitive help. The context-sensitive help opens the help on a page that is +relevant to the selected dialog, panel or view. +The first time you press F1 on a card, the panel for the card will be opened. Pressing F1 on an open +panel will access context-sensitive help. The documentation for the card will provide information +regarding the different options on the panel and the meaning of the settings. +Tip: When no help context is associated with the current dialog or panel, the help opens +on the main help page that allows you to navigate the documentation or search in the +documentation for relevant information. +4.2.8 Search Bar +The search bar is a single-line text field that allows you to enter search terms and find relevant +information in the GUI or the documentation. +The search bar is located at the top-right of the application window. +Tip: +• Enter a search term in the search bar to populate a drop-down list of actions as well as +the location of the action on the ribbon or context menu. +• Click an item in the list to execute the action. +• Partial searches are supported. +• Search the documentation. +Altair Feko 2022.3 +4 EDITFEKO +4.2.9 Application Launcher +p.630 +The application launcher toolbar is a small toolbar that provides quick access to other Feko components. +4.2.10 Application Menu +The application menu is similar to a standard file menu of an application. It allows saving and loading of +models, print functionality and gives access to application-wide settings. +When you click on the application menu drop-down button, the application menu, consisting of two +panels, is displayed. +The first panel gives you access to application-wide settings, for example: +• Creating a new model. +• Opening a model, saving a model and closing a model. +• Print +• Check for updates +• Settings +◦ Preferences +◦ Component launch options +• Feko help +• About +◦ Version information about EDITFEKO +Information about Altair Simulation Products +Information about third-party libraries +◦ +◦ +• Exit +The second panel consists of a recent file list and is replaced by a sub-menu when a menu item is +selected. +Figure 478: The application menu in EDITFEKO. +4.3 PREFEKO Language Concepts +The language used to create and modify models in EDITFEKO is the PREFEKO language. +EDITFEKO is the editor or integrated development environment (IDE) used to create models in an ASCII +format, but the language is PREFEKO. PREFEKO also refers to the application that translates .pre files +into .fek files that is read by the Feko solver. In order to create models with EDITFEKO, it is vital to +understand the language concepts in the PREFEKO language. +4.3.1 Comments +Comments are descriptive text added to the .pre file to help understand and follow the code execution. +Comments can be added to the script by inserting “**” followed by a space, for example: +** This is a comment +A comment may also be added after the last column of a card, after the comment indicator (“**”). +Note: Some cards use comments at the end of the card to indicate the name of the source, +load or request. Care should be taken not to mistake these for comments. +4.3.2 Structure of the PRE File +The order of the cards in the .pre file specifies the order of the steps during the simulation. +There are two main types of cards in EDITFEKO: +Geometry cards +Cards used to create geometry and affect the meshing. These cards are used above the EG card. +Control cards +Cards used to define sources, loads, request and control the simulation. These cards are generally +below the EG card, but can usually be used above the EG card as well. +The structure of the .pre file consists of the following sections: +1. Specify the mesh parameters. +a. Define the IP card. All cards following the IP card inherit the mesh settings set with this +card. +2. Create the geometry. +a. Use the geometry cards to define the geometry of the model. +b. End with the EG card to indicate that the geometry creation is complete. +3. Specify the excitations, loads, frequency and output requests. +a. Use the control cards to define excitations, specify the frequency and add output requests. +b. End with the EN card to indicate the end of the file. +For control cards that define solution requests, “**” is used often as a label for that card. The label +of a card is used by OPTFEKO to identify specific results. The label is also used by POSTFEKO for the +identification of the solutions and output requests when post-processing simulation results. +For example: +** Comments at the start the input file +... Cards that define the geometry ** Comments +EG End of the geometry +... Control cards that define sources, special solution options + and indicate which quantities to calculate ** Card labels / comments +EG End of the input file +Note: +All input and output parameters are in SI units (for example, lengths are in metres, potential +in volts). All angles are in degrees. +See the SF, TG and IN cards to enter dimensions in different units and scale to metres. +Related concepts +Card Formats +Related reference +IP Card +EG Card +EN Card +SF Card +TG Card +IN Card +4.3.3 Card Formats +Two card formats are supported namely column-based and colon-separated. This is relevant to users +who externally generate Feko input files and can be ignored by users using EDITFEKO to modify the +cards. +Note: The two formats may be mixed in a single input file. +Column Based Format +This format separates the individual integer and real parameters in columns, see Figure 479. The upper +numbers indicate the columns. The name field (“xx”) in columns 1 and 2 specifies the type of the card +(all cards start with a unique two character combination). This is followed by five integer parameters +I1 to I5 (these input fields may also contain text such as node names) containing five digits each, and +eight real-value parameters R1 to R8 containing ten digits each. +Figure 479: Column based card format in EDITFEKO. The numbers above the table (1, 6, 10, 15, 20...110) indicate +the columns. +Colon Separated Format +The colon separated format separates the individual integer and real parameters by a colon character. +It is a less restrictive format than the column-based format. Unlike the column-based format, integer +and real input fields are not restricted to 5 or 10 characters respectively. Note that the card name is still +located in columns 1 and 2. The name is followed by a colon in column 3. The rest of the card has no +spacing limitations. +For example: +DP: S1 : : : : : #x : #y : #z +BP: S2 : S2 : S3 : S4 +4.3.4 Variables +Variables are parameters that help to create easily adjustable models such as the investigation of +structures with varying geometry. +Symbolic Variables +Symbolic variables can contain expressions to calculate specific parameters of the model and have +specific syntax requirements. +Instead of using numerical values in the cards, it is possible to use predefined variables. The name of a +variable always consists of the “#” symbol followed by a string consisting of the characters “a-z”, “A-Z”, +“0-9” and the special character “_”. +The following are examples of valid variable names: +• #height +• #a +• #STARTINGFREQUENCY +• #a_1 +• #P5_7f +The following are examples of invalid variable names: +• #a?1 +• #value2.1 +Note: There is no distinction between upper and lower case characters. +For example, #a and #A are interpreted as the same variable. +It is important to note that in CADFEKO variables are used without the “#” character whereas PREFEKO +requires the “#” character to distinguish between variables and functions (such as cosine). +When CADFEKO writes the variables to the .cfm file, it prepends the “#” character so that the variables +can be used after the IN card in the .pre file. When using OPTFEKO in a model that has no CADFEKO +geometry defined, the .cfm file mesh import command must be removed, or variables that are defined +in the .cfm file must be excluded from the import, as these variable values will override the values +assigned by OPTFEKO if they are included. +Expressions and functions are used when defining variables so that direct calculations can be carried +out. The variables must be defined before they can be used in the respective cards. It is possible to +use expressions such as 2*#radius in the input fields subject to the maximum allowed length for +the column based format (10 characters for real values, 5 characters for integer values). For larger +expressions additional variables must be defined or the colon based format can be used. +Examples of variables: +#2pi = 2*#pi +#vara = 1 + sqrt(2) +#varb = #vara * 2.3e-2 * (sin(#pi/6) + sin(rad(40)) + #vara^2) +#sum = #vara+#varb +Note: The “#” character must appear in the first column to define a variable. +Altair Feko 2022.3 +4 EDITFEKO +Variable Editor +p.636 +The # card presents a list of supported functions and operations. Use this card to calculate the value of +the variable as it would be evaluated by PREFEKO at this point. +Figure 480: The # - Define a variable card. +Arrays +Arrays provide functionality to allocate a series of numbers to a parameter. +Arrays are supported and indexed with the notation such as #a[5]. More complex arrays are supported +where the array is constructed from an expression: +#am_0[3*#i+ceil(#r[2])] +The expression between the square brackets must evaluate to an integer number, which can also be +negative. The implementation of using arrays is such that they do not need to be allocated, however +they need to be initialised. +Consider the following lines of code: +!!for #i = 10 to 20 +#array_a[#i] = 3*#i-10 +#array_b[-#i] = 0 +!!next +It would be possible to use #array_a[10] or #array_a[17] or also #array_b[-12] in other +expressions. But, trying to use for instance #array_a[5] or #array_b[0] results in an error message +that an undefined variable is used. +Altair Feko 2022.3 +4 EDITFEKO +Predefined Variables +p.637 +The PREFEKO language includes a number of predefined variables. Generally, these variables remain +constant but may be overwritten by re-assignments. +Table 48: Predefined variables list +Name +Value +Description +#pi +#esp0 +#mu0 +#c0 +#zf0 +3.14159265358979... +The constant +Dielectric constant + of free space. +Dielectric constant + of free space. +The speed of light in free space. +The intrinsic impedance of free space. +#true +#false +Used for logical true. +Used for logical false. +PREFEKO also supports a logical function DEFINED(#variable) which returns TRUE if the variable +#variable has been defined, and FALSE if not. This is useful in .pre files used for OPTFEKO or +ADAPTFEKO runs. These two components insert variables at the top of the file, but it may be required to +define the variable in the file for preview purposes. +For example, if a .pre file is used for optimisation with respect to the variable #a, this variable could be +defined as follows: +!!if (not(defined(#a))) then +#a = 200.0e-3 +!!endif +Logical and Mathematical Operators +Logical operations are supported and a specific order of precedence is followed. +PREFEKO allows the use of logical operations. It supports the function NOT() that returns TRUE if the +argument is FALSE and FALSE when the argument is TRUE. PREFEKO also supports the delimiters >, <, +>=, <=, =, <>, AND and OR. When boolean operations are applied to variables, a value of 0 is taken as +FALSE and everything else is interpreted as TRUE. Similarly, in the result of a logical operation, FALSE is +mapped to 0 and TRUE to 1. +The order of precedence is as follows: +1. single number, expressions in brackets +2. +function calls +3. + and - (when used as a sign) +4. ^ +5. * and / +6. + and - +7. >, <, >= and <= +8. = and <> +9. AND +10. OR +There are three other special variables #!x, #!y and #!z that are useful for the connection of complex +wire structures. The three variables specify the Cartesian coordinates of the end point of the wire +segment most recently defined. This enables the correct and easy connection of a straight wire to a +curved length of wire, as the next extract from an input file demonstrates: +CL ..... +DP A #!x #!y #!z +#z = #!z + 0.5 +DP B #!x #!y #z +BL A B +The following example demonstrates the use of variables: +** A dielectric sphere in the field of an incident wave +** Define the variables +#r = 1 ** Radius of the sphere +#betrad = 1 ** Electrical size of the sphere +#epsr = 15 ** The relative dielectric constant +#maxlen = 0.7 ** The maximum edge length +** Define segmentation parameters +IP #maxlen +** The corner points +DP A 0 0 0 +DP B 0 0 #r +DP C #r 0 0 +** Select the medium +ME 1 0 +** Generate an eighth of the sphere +KU A B C 0 0 90 90 #maxlen +** Use symmetry in all three coordinate planes +** yz-plane: ideal electrically conducting plane +** xz-plane: ideal magnetically conducting plane +** xy-plane: only geometrically symmetric +SY 1 2 3 1 +** End of the geometry +EG 1 0 0 0 0 +** Assigning the dielectric's properties +DI #epsr 1.0 +** Incident plane wave excitation +#freq = #betrad * #c0/(2*#pi*#r) +FR 1 0 #freq +A0 0 1 1 1.0 0.0 -180.0 +** Near fields along the Z axis +FE 1 1 1 25 0 0.0 0.0 -1.98 0.0 0.0 0.04 +FE 4 1 1 50 0 0.0 0.0 -0.98 0.0 0.0 0.04 +FE 1 1 1 25 0 0.0 0.0 1.02 0.0 0.0 0.04 +** End +EN +The use of variables makes the investigation of structures with varying geometry (such as the variable +distance of the antenna in front of a reflector) an easy process, because only one variable (the distance +parameter) needs to be changed. It also allows FOR loops and IF conditions. +Mathematical Functions +Various trigonometric, Bessel and miscellaneous functions are built into Feko to help construct +geometry, expressions and calculate parameters. +Trigonometric Functions +The following trigonometric functions are supported: +Table 49: Trigonometric functions +SIN +COS +TAN +COT +ARCSIN +ARCCOS +ARCTAN +ATAN2 +ARCCOT +SINH +COSH +sine (argument in radians) +cosine (argument in radians) +tangent (argument in radians) +cotangent (argument in radians) +arcsine (argument in radians) +arccosine (argument in radians) +arctangent (in radians) +This function has two arguments atan2(#y,#x) - it yields +arctan(#y/#x) in the range +arccotangent +hyperbolic sine +hyperbolic cosine +TANH +hyperbolic tangent +Bessel Functions +The following Bessel functions are supported: +BESJ(n,x) +BESY(n,x) +BESI(n,x) +BESK(n,x) +Bessel function Jn(x) of integer order + and real argument x. +Neumann function Yn(x) of integer order + and real argument +Modified Bessel function of the first kind In(x) of integer order + and real argument x +Modified Bessel function of the second kind Kn(x) of integer +order + and real argument x +Miscellaneous Functions +The following miscellaneous functions are supported: +Table 50: Miscellaneous functions +SQRT +LOG +LN +EXP +ABS +DEG +RAD +STEP +CEIL +FLOOR +MAX +Square root +Logarithm to base 10. +Natural logarithm +Exponential function +Absolute value +Convert radians into degrees. +Convert degrees into radians. +Step function, STEP(x) = 0 for + and STEP(x) = 1 for x > 0. +Smallest integer value that is equal to or greater than the +argument. +Largest integer value that is equal to or smaller than the +argument. +Returns the largest of the two arguments — called as +max(#a,#b). +Altair Feko 2022.3 +4 EDITFEKO +MIN +FMOD +RANDOM +p.641 +Returns the smallest of the two arguments — called as +min(#a,#b). +This function has two arguments fmod(#a,#b) and returns the +remainder of the division #a/#b. +This function returns a random value in the range 0 . . . 1. If +the argument X of RANDOM() is -1, then a random number is +returned. +For any other argument X in the range 0 . . . 1 this value is used +to set the seed, and then a random number is created using this +seed. (Using the same seed allows one to create a deterministic +and reproducible random number series). If RANDOM(-1) is called +before any seed is set in the .pre file, then the returned values +are random and not reproducible. (The internal seed is used +based on the time when PREFEKO is executed). +Coordinate functions provide access to the individual X coordinate, Y coordinate and Z coordinate of a +Cartesian coordinate in 3D space. +Coordinate Functions +The following coordinate functions are supported: +Table 51: Coordinate functions +X_COORD +Y_COORD +Z_COORD +This function returns the X coordinate of a point previously +defined by a DP card. +This function returns the Y coordinate of a point previously +defined by a DP card. +This function returns the Z coordinate of a point previously +defined by a DP card. +The X_COORD, Y_COORD and Z_COORD functions are used by passing the name of the point, in quotation +marks, as an argument to the function. For example, the following code sets the parameter #x equal to +1.234. +DP PNT01 1.234 0.4567 #z +#x = x_coord("PNT01") +Altair Feko 2022.3 +4 EDITFEKO +4.3.5 Labels in Feko +p.642 +In the PREFEKO language and Feko in general, items in a model are identified by their labels. +Operations are performed and electromagnetic properties are applied to the items through their labels. +Labels are set either directly in CADFEKO or by preceding geometry cards in EDITFEKO with the LA +card. When importing specific mesh formats by means of the IN card then labels can also be imported +(for instance the NASTRAN property gets converted into an Altair label). +Labels can consist of any or a combination of the following: +• A positive integer number, including zero (for example, 0, 1, 2 ..9). +• Any valid expression (for example, 3*#i+2). The expressions are evaluated, and the resultant +numerical value is used in the label. +• A string of characters (valid are, a..z, A..Z, 0..9 and the underscore “_”), optionally followed by a +variable (which starts with the “#” sign). Such variables at the end are evaluated and replaced by +the corresponding numerical value (rounded to an integer). +Note: String labels are case insensitive. The labels “Roof” and “ROOF” are treated +identically. +For example, the following labels are valid: +23 +5*#k+#j/2 +LeftWing +Front_Door +Part#i +The following labels are invalid: +Left+Wing (invalid character '+') +-23 (negative integer) +Part_#i_#k (two variables) +Figure 481: Example demonstrating the usage of labels (display of labels in colour with legend in POSTFEKO. +You can use the CB card in EDITFEKO to change labels (for example, after having imported geometry). +A powerful wild card algorithm (expanding a non-specific label name containing a wild card character +into a set of specific labels) is supported. Some Feko cards allow you to specify label ranges while +other cards allow labels for created geometry to be derived from other labels (for example when using +symmetry with the SY card). It is therefore important to understand how the label algorithm works. +The labelling algorithm first evaluates expressions or replaces variables, and then the label is split into +the associated number and the remaining base string. The associated number is split off from the back +of the label, and if there are no digits, this is set to zero. +Table 52: Examples of splitting a label into its base string and associated number. +Label +Roof +Part_17 +Base string +Associated number +Roof +Part_ +17 +When incrementing labels, the base string is kept and the associated number is incremented. There is +just one exception: the label zero will always remain zero. +Table 53: Label incrementing example (increment by two). +Label +Incrementing label +Part_19 +Altair Feko 2022.3 +4 EDITFEKO +Label +Roof +Part_17 +Related concepts +Reference Elements +Related reference +LA Card +IN Card +CB Card +SY Card +4.3.6 Conditional Statements +Conditional statements provide functionality for changing parameters inside a loop, or for a +parameter(s) to depend on other parameter(s). +FOR / NEXT Loops +FOR / NEXT loops provide the flexibility of varying parameters inside a loop. +Some cards in EDITFEKO implicitly use loops (such as when an FR card with multiple frequencies is +used). This does not always provide the flexibility which may be required. For example, to change the +material parameters inside the loop. Another example would be the use of a loop to create a complex +geometry object(s). +For general loops, PREFEKO allows the construct: +!!for #var = #start to #end step #delta +!!next +where a simple example would be as follows: +** Loop for the relative permittivity +!!for #eps_r = 1 to 5 step 0.5 +** Set material parameters +GF 0 1 #epsr +** Compute fields etc. +FE +** End of loop +!!next +The syntax requirements of FOR / NEXT loops are as follows: +• The !! characters must be located in the first two columns of the line. This is followed by a +number of optional spaces and the keyword FOR (it is not case sensitive, so also “For” or “for” are +accepted). +• The keyword FOR is followed by the name of the loop variable (starting with “#”). +• Next follows an expression for the initial value of the loop (a constant, variable or formula). +• This is followed by the keyword TO and the terminating value of the loop variable (again a constant, +variable or formula). +• The default increment of the loop variable is 1, but it can be changed by using the keyword STEP +followed by an expression. Negative increments are allowed. +• The loop is terminated by a line of the form !!NEXT (spaces are allowed between !! and NEXT +but not before the !!). All instructions and input cards between !!FOR and !!NEXT are evaluated +repeatedly inside the loop. +• Loops can be nested. +A more complicated example: +#end = 3+sin(4) +!!for #x1 = sqrt(5) + 2*3 to 2*#end step -#end/10 +!! for #x2 = 1.23 to 2*#x1 ** this is the inner loop +#x3 = #x1 + #x2 +DP .... +.... (more commands) +!! next +!!nex +Related concepts +FILEREAD Function +Related reference +Mathematical Functions +IF / ELSE / ENDIF Constructs +The IF, ELSE and ENDIF constructs allow different control cards to be used under certain conditions. +The syntax requirements of IF / ELSE / ENDIF constructs are as follows: +• The !! characters must be in the first two columns of the line. This is followed by an arbitrary +number of spaces, the keyword IF, the expression to be evaluated and the keyword THEN. +Note: Keywords are case insensitive, for example, “Then” or “then” are also valid +• The block is terminated by a line of the form !!ENDIF (again spaces are allowed between !! and +ENDIF but not before the !!). +• An optional line of the form !!ELSE (the !! must be in the first two columns and spaces are allowed +before the keyword, which is not case sensitive). +• All instructions and input cards between !!IF and !!ENDIF (or !!ELSE if it is present) are +processed if the expression is TRUE. If it is present, all lines between !!ELSE and !!ENDIF are +processed if the expression is FALSE. +As an example: +!!if #a > 5 then +... +!!endif +Another example is as follows: +#l = (#a+5 > 21) and (#a < 100) +!!if ( (3*#a+5 >= #x/2) and not(#l) ) then +... +!!else +!! if (sin(#x/10) > 0.5) then +... +!! else +... +!! endif +!!endif +Related concepts +FILEREAD Function +Related reference +Mathematical Functions +EXIT Command +Use the EXIT command to break execution of a loop. +This command is useful for checks such as the following: +!!if #a < 2*#b then +!! exit +!!endif +4.3.7 PRINT Command +The PRINT command prints strings, numbers and other information to screen or the .out file to display +the solution progress and for debugging purposes. +The following print commands are available: +!!print +Prints text to screen. +!!print_warning +Prints the warning messages to the screen. +• For terminal runs, the string “WARNING” precedes the warning message. +• For runs from the GUI, the warning message is displayed in colour. +!!print_error +Prints the warning messages to the screen. To stop execution use the !!EXIT statement. +!!print_to_out +Writes the text to the .out file while the Feko kernel is run. +The print commands accept multiple arguments separated by commas. +Example 1 +Print the error message and exit if the variable #a is < 2*#b: +!!print "2*#b = ", 2*#b +!!if #a < 2*#b then +!! print_error "The value of #a is too small:", #a, " (exiting now)" +!! exit +!!endif +Example 2 +Print the value of #b to the .out file at the location where it appears in the .pre file. +!!print_to_out "This run was done with #b = ", #b +4.3.8 FILEREAD Function +The FILEREAD function reads data from an arbitrary ASCII file. +Read a numerical value using the following general syntax: +fileread("Filename", Line, Column) +The FILEREAD command contains the file name, the line number to read from and the column to read. +The data in the respective columns of any line are separated by one or more spaces or tab characters. +For example, consider a data file containing a list of frequencies and a load impedance for each +frequency: +Frequency in MHz Re(load) in Ohm Im(load in Ohm) +100 22.54 -12.56 +150 25.07 -6.54 +200 27.42 0.23 +The frequency and loading can be imported directly from this file using the following example code: +#numfreq = 3 ** Number of frequencies +!!for #i = 1 to #numfreq +** Define the frequency (conversion from MHz to Hz) +#freq = 1.0e6*fileread("datafile.dat", #i+1, 1) +FR 1 0 #freq +** Define the load +#Zr = fileread("datafile.dat", #i+1, 2) +#Zi = fileread("datafile.dat", #i+1, 3) +LZ 0 #Zr #Zi +** Computations ... +!!next ** End of frequency loop +Altair Feko 2022.3 +4 EDITFEKO +4.3.9 Symbolic Node Names +p.648 +Symbolic node names or named points can be constructed as either single points or as an array of +points. Arrays of points can then be referenced by only specifying the array name. This is useful when a +large number of points are required. +Single Node Names +A node is a point in 3D space. Nodes can be constructed and referenced using variable names. Use a +loop to construct multiple nodes. +When defining or using node names, simple variable names of the form A#i can be used to define the +node. If a hash character (“#”) is found in a node point name, this character and everything that follows +is interpreted as a variable string, evaluated and rounded to the nearest integer. +As an example, #k=15 and a point defined as P#k, is equivalent to using P15 as point name. The length +of the node name string (before and after expansion) is limited to 5 characters. +For example, the points P1 to P20 are defined inside a loop as follows: +!!for #k = 1 to 20 +DP P#k +!!next +These defined points can then be used individually or inside another loop. +Node Name Arrays +Symbolic node names or named points can be constructed as either single points or as an array of +points. An array of nodes is useful when creating a polygonal surface with multiple points. +For example, when creating polygonal surfaces using the PY card and PM card containing many points, +only the node name can be specified instead of each individual point. Expressions such as A[2*#i+3] +can be used to index the array. +A symbolic node name array can be defined in a loop as follows: +!!for #k = 1 to 20 +DP P[2*#k+3] +!!next +When using node names, the nodes can be referenced using only P. Single node names can be +referenced by indexing the array. +4.4 Creating Geometry in EDITFEKO +Create geometry in EDITFEKO according to the guidelines to ensure that different mesh parts are +electrically connected. Meshes can also be imported to create a model. +4.4.1 Importing Meshes +Include a CADFEKO mesh or any other external mesh in the .pre file using the IN card. +4.4.2 Guidelines for Mesh Connectivity +Meshing guidelines are given to ensure electrical connectivity in the mesh. +Elements must be connected at edges or vertices to ensure electrical connectivity. Most of these rules +are automatically complied with when creating Feko models in CADFEKO. However, adherence to these +rules should be maintained when combining CADFEKO models with EDITFEKO scripting (for example +attaching an antenna modelled with geometry cards on an aircraft meshed in CADFEKO), or when +creating the geometry only in EDITFEKO, or when working with imported meshes. +Note: Cuboidal volume elements used to model volume dielectrics (with the DK, DZ and QU +cards), do not need to be connected in this manner. +When creating structures with scripting commands, wires are divided into segments that are equal +to or shorter than the specified segment length. For surfaces the triangle edges along the boundary +of the surface are always equal to or shorter than the specified edge length. Therefore, meshing the +same line with the same mesh size will always give the same number of divisions of equal length. The +internal edges may, however, be longer than the specified edge length. This is not necessarily the case +with CADFEKO meshes where the specified mesh size is the average size and the internal structure +influences the placement of vertices along the surface boundaries. +When creating wire junctions as shown in the figure below, it is important to ensure that the wire AB +have a vertex at point C. The best option is to construct this as two wires, one from A to C and the +other from C to B. +Figure 482: Example of a wire structure. +Similarly, where two surfaces touch, the common edge must be part of both surfaces. For example, +the surface in the figure below should not be created as two rectangles ABFG and CDEF. If done in +this manner, it is highly unlikely that there will be an ohmic connection along the line BF. There are +a number of ways to correctly create this structure. It can be created from the rectangles ABFG, +CDHB and BHEF or the quadrangles ABEG and BCDE. In both cases the contacting edges are common +and will be meshed correctly. The simplest way to mesh this structure is to create a single polygon +ABCD(H)E(F)G. +Figure 483: Example of a wire structure. +A connection point between a segment and one or more triangles is only recognised when the beginning +or the end of the segment is coincident with the vertex or vertices of the triangles. In the figure below +an incorrect connection is depicted on the left and a correct connection on the right (where the segment +is connected to six triangles). +Figure 484: Incorrect (left) and correct (right) connection between a segment and triangles. +When curved structures (such as circles, cylinders, spheres and so forth) are modelled, a finer mesh +may be used along the curved edges to get a more accurate representation of the geometry. In this +case the same edge length should be used on both edges and the reference points should be identical +as depicted in the figure below. +Figure 485: Incorrect (left) and correct (right) connection between a segment and triangles. +Related reference +DK Card +DZ Card +QU Card +4.4.3 Discontinuous Mesh and Geometry Parts +Use domain connectivity (discontinuous Galerkin domain decomposition method) to “connect” a static +mesh to a dynamic parameterised geometry without requiring node connectivity. The parts may be +separated by a small gap. +Note: Mesh connectivity between parts is achieved only when the parts have a common +interface with shared vertices (a continuous mesh). +A simulation model is often assembled from different parts. For example, a car model meshed using +Altair HyperWorks and imported into CADFEKO. An antenna geometry is then placed on the imported +mesh. To avoid re-meshing the full model to align the vertices on the common interface, the domain +connectivity approach can be used to “connect” the discontinuous mesh and geometry parts. +Figure 486: Left: Mesh parts that have no mesh connectivity (triangles do not share vertices on a common +interface); Right: Mesh parts that have mesh connectivity. +Apply the domain connectivity to discontinuous meshes where the gap between the meshes is small in +relation to the wavelength. For high accuracy, choose the gap distance g as g = λ/ 1000. Increasing the +gap distance, the result becomes less accurate and margins g > λ /100 should be avoided. +Figure 487: Left: Mesh parts that have mesh connectivity; Center: Mesh parts that do not have mesh connectivity +but have domain connectivity defined; Right: Mesh parts that have no mesh connectivity. +Related concepts +Workflow for Connecting Discontinuous Mesh and Geometry Parts +Altair Feko 2022.3 +4 EDITFEKO +Related reference +DC Card +p.652 +Workflow for Connecting Discontinuous Mesh and Geometry Parts +View the workflow for domain connectivity (discontinuous Galerkin domain decomposition method) to +connect discontinuous mesh and geometry parts using CADFEKO to set up the model and EDITFEKO to +define the domain connectivity. +Connect discontinuous mesh and geometry parts using the following workflow: +1. Assemble the model in CADFEKO and define all settings and requests. +2. Save the model. CADFEKO creates the .pre file. +3. Open the .pre file in EDITFEKO. +4. Define the domain connectivity using the DC card. +• Specify the number of connections. +• Define for each connection the labels of the corresponding faces. +Tip: To view the label names for the relevant faces, view the model in POSTFEKO +and colour the mesh by label[49]. Add a legend to view the labels per colour[50]. +• Define for each connection a tolerance distance, in order to distinguish between regions, +where a gap in the model is desired (or not desired). +5. Run PREFEKO to create the .fek file for the simulation. +6. Run the Solver to simulate the model. +Related concepts +Discontinuous Mesh and Geometry Parts +Related reference +DC Card +4.4.4 Reducing Mesh Sizes +Mesh subdivision is a method to reduce the number of mesh elements created / rendered, while still +solving the correctly intended mesh. +For very large models (or at very small wavelengths) it is possible that CADFEKO or POSTFEKO cannot +create / display the required mesh. This problem can be alleviated by creating a mesh of larger +elements in CADFEKO and using the RM card in EDITFEKO to subdivide the mesh to obtain the correctly +sized elements. +49. On the 3D View contextual tabs set, on the Mesh tab, in the Rendering group, click the + Mesh colour icon. From the drop-down list, click + Mesh colour. +50. On the 3D View contextual tabs set, on the Display tab, in the Legends group, click the + Top +left icon. +Note: The original mesh should use much larger elements than the desired mesh. If this is +not the case, the subdivision may result in an unnecessary large number of elements. +Altair Feko 2022.3 +4 EDITFEKO +4.5 Preferences +p.654 +EDITFEKO has various default settings that you can configure to customise it to your preference. +On the application menu, click + Settings > Preferences. The settings can be reset to the default +settings at any time, restoring the settings to the state of a new installation. +Figure 488: The Default settings dialog. +4.6 Files Generated by EDITFEKO +View the files associated and generated by EDITFEKO. +Table 54: File type(s) generated by EDITFEKO +Files +.pre +Description +A .pre file is created when the EDITFEKO model is saved. +Note: After saving a model in CADFEKO, CADFEKO generates a .pre file. +Altair Feko 2022.3 +4 EDITFEKO +4.7 Shortcut Keys +p.656 +View the shortcut keys available for EDITFEKO for faster and easier operation of EDITFEKO. +Keyboard shortcut keys help you to save time accessing actions that you perform regularly. The +shortcut key or key combination is also displayed in the tooltip that is displayed when you hover the +mouse over the action on the ribbon. +Table 55: EDITFEKO shortcut keys +Shortcut Key +Feko Components +Alt+0 +Alt+2 +Alt+3 +Alt+4 +Alt+6 +Alt+8 +General Editing and Construction +Description +Run CADFEKO +Run PREFEKO. +Run POSTFEKO. +Run Solver +Run OPTFEKO +Open the Feko terminal. +F1 +Ctrl+A +Ctrl+C or Ctrl Ins +Ctrl+G +Ctrl+N +Ctrl+O +Ctrl+P +Ctrl+Q +Ctrl+S +Ctrl+V or Shift+Ins +Ctrl+X or Shift+Del +Edit card in panel. If a panel is already open, open +contextual help for the card. +Select all (text). +Copy to clipboard. +Goto line. +New .pre file. +Open file. +Print. +Exit. +Save. +Paste from clipboard +Cut to clipboard. +Altair Feko 2022.3 +4 EDITFEKO +Ctrl+Z +Ctrl+Y +Alt+C +Alt+U +Ctrl+F +F3 +Ctrl+Left Arrow +Ctrl+Right Arrow +Home +End +Ctrl+Home +Ctrl+End +p.657 +Undo. +Redo. +Comment line(s). +Uncomment line(s). +Find and replace. +Find next. +Move the cursor to the previous word. +Move the cursor to the next word. +Move to beginning of line. +Move to end of line. +Move to beginning of file. +Move to end of file. +Feko Solution Methods +5 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. +This chapter covers the following: +• 5.1 Basic Concepts (p. 659) +• 5.2 Source Methods and Field Methods (p. 663) +Altair Feko 2022.3 +5 Feko Solution Methods +5.1 Basic Concepts +p.659 +Basic antenna and EM concepts are given that provide a foundation for understanding the different +solver methods in Feko. +What is an Antenna? +An antenna is a conducting structure consisting of surfaces and/or wires designed to be of specific +characteristic dimensions to radiate or receive an electromagnetic wave. +The primary purpose of an antenna is to make an impedance match between a signal (electrical current +or wave) travelling in a coaxial cable (transmission line) or wave guide and waves travelling in free +space. A secondary purpose is to send the signal in a specific direction. [51][52] +Figure 489: A Yagi-Uda antenna. +What is a Far Field? +When calculating fields at a specific point P in space over a great distance from the radiator, the +following assumptions hold: +• Differences in the distances from P to the different points on the radiator have a negligible effect on +the magnitude of the field. +• Differences in the distances from P to the different points on the radiator should be accounted for +when calculating the phase, but certain assumptions could be made. +• +All field components that decay faster than + can be considered negligible compared to those that +decay with +.[53] +The far field of an antenna is the minimum distance from the antenna where the field components do +not contain reactive components, or where these components can be considered negligibly small. This +distance is generally written as: +(37) +where D is the largest dimension of the antenna. +51. Fields and Waves in Communication Electronics, Third Edition, Ramo, Whinnery and Van Duzer, +p. 584-586; 599 +52. Electromagnetic Fields and Energy. Haus and Melcher, p. 547 +53. Fields and Waves in Communication Electronics, Third Edition, Ramo, Whinnery and Van Duzer, +p. 593 +In the far field, the antenna is considered a point source. Equation 37 is derived under the assumption +that the varying distances to the radiator do not contribute to phase errors larger than 22.5°.[54] +What is a Near Field? +The near field of an antenna is the region in close proximity to the antenna where the electric and +magnetic fields are not in phase. The fields are reactive and there is also a strong radial component. +The radial component of the field has no + dependency but does have +, + and even higher +dependencies. Naturally, these field components vanish very quickly with increasing distance.[55] +What is a Transmission Line? +A transmission line is a coaxial cable, microstrip, stripline, waveguide or some specialized structure +designed to conduct a radio frequency signal. The frequency of the signal is high enough, such that the +wave behaviour of the signal cannot be ignored. While there are several purposes, in radio frequency +engineering, transmission lines are typically used to connect transmitters, receivers and antennas. +Figure 490: A basic representation of a transmission line. +From a radio frequency engineering point of view, typical parameters of interest are the input reflection +coefficient and the voltage standing wave ratio (VSWR). +What are S-Parameters? +S-parameters characterize the relationship between the input and output ports of a system in terms of +power waves. While the relationship could also be described in terms of other network parameters such +as ABCD, Z and Y-parameters, calculating these parameters require the termination of the ports in open +or short circuits. Achieving purely open or short circuits, especially over wide bands, are not feasible. In +addition, some devices are not stable if they are open or short-circuited. +However, when calculating S-parameters, it only requires termination of the ports in the system +impedance.[56] +Figure 491: Two-port S-parameters representation. +54. Antenna Engineering Handbook, Fourth Edition, John L. Volakis, p. 1-8 +55. Advanced Engineering Electromagnetics, Second Edition, Constantine A. Balanis, p. 283 +56. High-Frequency Circuit Design and Measurements, Peter C.L. Yip, p. 33-34 +Altair Feko 2022.3 +5 Feko Solution Methods +What is the Reflection Coefficient? +p.661 +The reflection coefficient is a quantity or figure describing how much of an electromagnetic wave +is reflected due to an impedance mismatch (discontinuity) in the transmission line or transmission +medium. The reflection coefficient is calculated as the ratio of the magnitude of the reflected wave +to the incident wave. It can be calculated from the characteristic impedance of the transmission +medium (line), +, and the impedance of the discontinuity (often the load impedance at the end of a +transmission line), +, as follows: +(38) +For the special case of a one-port device, the reflection coefficient is the same as the S-parameter, S11. +In the case of a device with two ports or more, the parameters, Snn (for example S11, S22), is the same +as the reflection coefficient if all the ports are loaded with the port or system impedances. +Note: A Feko model with a single port does not require an S-parameter request. The input +reflection coefficient is the same as the S-parameter request. +What is a Smith Chart? +A Smith chart is a graphical representation of impedance, admittance, phase, wavelength and reflection +coefficient. The Smith chart consists of a family of normalized resistance circles and reactance circles. +The circles represent the value of the input impedance of some system (network, circuit or load) as +measured a certain distance away from the system over a transmission line. [57] The Smith chart +provides a transformation between reflection coefficient and impedance over a transmission line. It +represents wave behaviour on a transmission line.[58] The advantage of the Smith chart is that you can +represent all complex values from positive to zero and negative infinity for the real and imaginary parts. +Figure 492: An empty Smith chart from POSTFEKO. +57. High-Frequency Circuit Design and Measurements. Peter C.L. Yip, p. 15 +58. High-Frequency Amplifiers, Second Edition, Ralph S. Carson, p. 56 +Altair Feko 2022.3 +5 Feko Solution Methods +What is CEM? +p.662 +Computational electromagnetics (CEM) refers to a numerical solution or a computer-based +approximation of the currents or the fields. In the numerical solution the currents or fields are firstly +divided into many small parts. Subsequently the physical equations (typically Maxwell's equations such +as Ampère's law, Faraday's law) that describe the relationships between fields, currents and charges +are then used to obtain the magnitude and phase of each current or field element. Finally the summing +(integration) of these current or field elements yield antenna parameters such as input impedance and +far fields. +Consider the Yagi-Uda antenna shown in Figure 493. Only the current-carrying parts of the antenna are +shown. More specifically, the antenna is represented as an assembly of subdivided sections where each +section (or rather, each junction between sections) carries a small but uniform current. +Figure 493: A Yagi-Uda antenna, current-carrying parts only, divided into small sections with uniform current +elements across the junctions. +It is initially assumed that on each junction between sections, a constant current is flowing, but the +magnitude and phase of these currents are not known. Maxwell's equations are used to find the +magnitude and phase of each small current element. +Once the magnitude and phase of each current element is known, all the currents are added together +(integrated). A transformation of the currents then give the electric and magnetic near and far fields as +well as other antenna parameters. +In post-processing, the fields as seen in Figure 494 can be visualised. +Figure 494: Yagi-Uda antenna near fields visualised in POSTFEKO. +5.2 Source Methods and Field Methods +Solver methods can be categorized as either source-based methods or field-based methods. +Understanding the main differences between these two categories helps to understand and choose an +appropriate solution method for each application. +Discretization +In source methods, only the structure is discretized (meshed) but not the free-space regions between +the structures. In field methods, the whole solution domain is discretized, that is the structure as well +as the free-space region between structures. +Consider a dipole and cuboid in Figure 495. In the source method, only the surfaces of the model are +discretized. Here the cuboid is discretized into triangles and the dipole into wire segments. A surface +mesh could also consist of quadrangles. +Figure 495: A dipole and cuboid discretized for a source-based solution. +In field methods, the whole solution space is discretized into, for example, voxels (small cuboids shown +in Figure 496) or it could be tetrahedra. The field-based mesh is displayed partially transparent to +show that the internal volume of the cuboid is meshed. In addition, the surrounding free-space is also +meshed, but only the mesh of the outer boundary of free-space is displayed (also transparent). +Figure 496: A dipole and cuboid discretized for a field-based solution. +Note: For the source-based mesh displayed in Figure 495 the chosen source-based solution +method is the method of moments and for the field-based in Figure 496 it is the finite +difference time domain. +Boundary Conditions +In field-based methods, the propagating fields, and therefore the fields' associated mesh, requires +a proper termination (truncation). This is not a problem for closed regions such as waveguides or +cavities where the PEC boundary provides a proper termination. However, for open radiating problems +such as shown in Figure 495 and Figure 496, the mesh would be required to extend to infinity. An +artificial absorbing region within the mesh is used to solve this problem. This termination or absorbing +region is denoted a boundary condition. Source-based methods do not require a termination of the +mesh (boundary condition). A special function (denoted the Green's function) built into the method +automatically accounts for the field behaviour at infinity or any point in space.[59] +Solvable Model Size +Field-based methods are generally more limited in terms of the size, specifically the electrical size (in +wavelengths), of models they can solve. This is because a growing model size implies a larger volume +of mesh elements to mesh and solve. For source-based methods it is only a larger surface area of +mesh elements. It is assumed, however, that acceleration techniques for the source-based method is +employed such as the multilevel fast multipole method. In addition it must be noted that increasing +usage of GPU acceleration is increasing the solvable sizes of field-based models. +59. Computational Electromagnetics for RF and Microwave Engineering, Second Edition, David B. +Davidson, p. 14 +5.3 Full Wave and Asymptotic Solution Methods +The Solver includes multiple frequency and time domain solution methods. True hybridisation of some of +these methods enables efficient analysis of a broad spectrum of electromagnetic problems. You can also +use more than one solver method for cross-validation purposes. +Figure 497: Illustration of the numerical analysis techniques in Feko. +The following solution methods are supported: +• Full wave frequency domain solution methods: +◦ MoM (method of moments) +◦ FEM (finite element method) +◦ MLFMM (multilevel fast multipole method) +• Full wave time domain solution methods: +◦ FDTD (finite difference time domain) +• Asymptotic solution methods: +◦ PO (physical optics) +◦ LE-PO (large element physical optics) +◦ RL-GO (ray launching geometrical optics) +◦ UTD (uniform theory of diffraction) +Altair Feko 2022.3 +5 Feko Solution Methods +5.3.1 Full Wave Solutions +p.666 +Full wave solutions rigorously solve Maxwell's equations without making any assumptions regarding the +nature of the electromagnetic problem. The solution can be either in the frequency or the time domain. +Introduction to the Method of Moments +The MoM is the default solver in Feko. A simple electrostatic example is used to convey the basics of the +solver. +The Charge Distribution of a Straight Wire at a Constant Electric Potential of 1 V. +The basic Yagi-Uda antenna shown in Figure 493 consists of a few straight wires. Consider the solution +of the charge distribution of a single straight wire of length and diameter 2a shown in Figure 498. +Figure 498: A segmented straight wire charged to a constant potential. +According to [60], a linear electric charge distribution + will create an electric potential + as follows: +(39) + represents the source coordinates and r denotes the observation coordinates, +where +integration and R is the distance from any point on the source to the observation point which can also +be written as + is the path of +60. Advanced Engineering Electromagnetics, Second Edition, Constantine A. Balanis, p. 680 +(40) +Note: Equation 39 is valid on the wire and in free space. This is the so-called "boundary +condition" for this particular problem. +Even though the charge distribution on arbitrarily shaped objects are not generally known, the straight +wire example is useful for an introduction to the MoM. +Assume the wire is charged to a constant electric potential of 1 V. For convenience, the wire is oriented +parallel to the Z axis. To solve Equation 39 on a computer, the wire is divided into smaller segments and +the charge distribution can be approximated as follows: +(41) +The functions, +, often referred to as basis functions, are chosen to accurately model the unknown +quantity (here the charge on a wire segment) as well as for computational efficiency. For simplicity, +constant functions over each segment are assumed. More specifically, each + function is equal to +1 over one segment only, and zero elsewhere. The assumption of a constant function implies that the +segment length should be short enough for this assumption to hold. +Note: A rule of thumb is to make segments +th of a wavelength. +Therefore Equation 39 can be approximated as follows: +(42) +As shown in Figure 493, the wire is divided into N uniform segments where each segment is of length +. +Figure 499: A segmented straight wire charged to a constant potential. +Since Equation 39 is valid everywhere, z can be chosen to be located at fixed points, zm, on the surface +of the wire segments with radii, a. This choice simplifies Equation 42 to only a function of z', allowing +the calculation of the integral. Furthermore, since the wire was divided into N segments, Equation 42 +can be written as one equation with N unknowns (an) as follows: +(43) +An equation of N unknowns requires N equations where each equation stands linearly independent from +each other. These N equations can be constructed by selecting the observation points zm in the centre of +each segment of length as shown in Figure 499. +Note: The selection of observation points is denoted “testing” or “sampling” +the method is referred to as “point-matching” or “collocation”. + and +Performing the selection of points N times reduces Equation 43 to the following: +Altair Feko 2022.3 +5 Feko Solution Methods +Equation 44 can be more readily written in matrix form as: +In Equation 45 each Zmn term can be written as: +In addition, we can write the remaining two terms: +p.669 +(44) +(45) +(46) +(47) +(48) +The Vm matrix consists of 1 row and N columns and all entries are equal to +unknown coefficients for the charge distribution. To solve Equation 45, the matrix requires inversion +where +. The an values are the +(49) +Note: A well-known and computationally cheaper inversion procedure, LU decomposition, +is followed. The matrix is factored into an upper and lower triangular matrix. Then a process +similar to Gaussian elimination is followed to solve the matrices. +Figure 500 shows the line charge density for a wire of length 1 m discretized into 50 segments. +Figure 500: Line charge density of a straight wire charged to a potential of 1 V. +For more complex problems, the integrals cannot be reduced to approximations such as those made +here. +The MoM for Full-Wave Solutions +For general open-radiating problems for scatterers of arbitrary shape, a procedure similar to the +solution of the charge on the straight wire is followed. +This procedure can be summarized as follows: +1. Specify the relevant integral equation. +2. Apply boundary conditions to manipulate the integral equations into a solvable form. +3. Discretize the unknowns on the scatterer - in this section, we will work with currents. +4. Test the integral equation to create the same number of equations as the number of unknowns. +5. Solve the matrix equation to obtain current coefficients. +6. Sum (integrate) the vector currents to obtain output such as far fields and impedance. +Specifying the Relevant Integral Equation +Specify the integral equation by decomposing the fields into two parts. +Incident and Scattered Fields +Basic laws of physics dictate when an electromagnetic field encounters an object, currents are +excited on the object. These currents will subsequently re-radiate. This behaviour is referred to as +“electromagnetic scattering”. +Maxwell's equations are linear equations which allows them to be decomposed into the sum +(superposition) of the “incident” field and “scattered” field. The total field can, therefore, be written as: +(50) +The incident field is typically a plane wave or it could be a voltage source. The incident field is that field +that exists in the absence of the conducting body. +Figure 501: An arbitrary shaped conducting body. +Finding the Incident Field +In RCS applications, the incident field is a plane wave. For example, a plane wave incident from the +negative X axis with the electric field z-polarized gives the incident field as: +In antenna problems, the incident field, also denoted the “excitation,” is usually a voltage source. A +simple form of excitation is the “delta-gap” feed. For an impressed voltage V at the terminals of an +antenna over a gap of length δ the incident field can be written as: +(51) +(52) +If this feed is applied to a wire, the length of the gap is typically the length of a wire segment. Other +types of incident fields are magnetic frills and elementary Hertzian dipoles. +Finding the Scattered Fields +To find the scattered fields an integral equation is applied to the surface currents. This is written in a +simple notation as follows: +currents to be found. + where + represents the integral operator and + are the unknown +Applying Boundary Conditions +Boundary conditions refer to already known properties of the physics of the problem. These help to +derive the solvable integral equations. +Boundary conditions differ depending on the problem to be solved. A dielectric body would have +different boundary conditions compared to a PEC body. For the arbitrary shaped PEC body shown in +Figure 501 the boundary condition states that the electric field tangential to the surface is zero all over +the surface. In terms of the incident and scattered fields (Equation 50) we can then write: +(53) +This equation is also denoted the electric field integral equation (EFIE). +It was previously shown that an integral operation applied to the surface currents leads to the scattered +fields. Therefore we can write in simple notation: +(54) +where + represents the integral operator and + are the unknown currents to be found. +Discretizing the Currents +Discretizing the object or solution space is commonly referred to as meshing. It is a necessary step to +solve the integral equations. +Similar to the procedure followed to solve the charge distribution on the straight wire, the surface of +the PEC body is discretized into triangles. Therefore the currents on the triangles are approximated as +follows (similar to Equation 41): +(55) +Figure 502: The arbitrary shaped conducting body meshed into triangles. +The equation for the discretized currents can then be substituted into the EFIE (Equation 53) to yield: +(56) +In Equation 56, the current coefficients represented by + are the only unknown quantity. +Before proceeding to the next step, it is necessary to take a closer look at basis functions. +Basis Functions +Basis functions are elementary functions for the modelling of the unknown quantity on a mesh element. +Categories of Basis Functions +There are two main categories of basis functions: +• entire-domain basis functions +• sub-domain (sub-sectional) basis functions +Entire-domain basis functions are defined over the entire surface of the scatterer - they are non-zero +over the entire domain. The formulation of these functions is deemed rather trivial, provided the shape +of the scatterer is regular. For most practical applications, the shape of the scatterer is irregular and +the formulation of such basis functions is near impossible. This requires the usage of sub-domain basis +functions. +In the application of sub-domain basis functions the entire surface of the scatterer is subdivided into +small surfaces. On each subdivided surface a simple function is employed to represent the unknown +quantity (such as charge or current). Sub-domain basis functions are non-zero on only a small part of +the entire domain. +Note: For FEM and VEP, the volume is subdivided and on each volumetric element a +simple function is employed to represent the field. +Types of Sub-Domain Basis Functions +The different types of basis functions are distinguished from each other based on their spatial +variations. A few well-known ones are as follows: +• constant (also known as pulse or stair-step) +• linear +• polynomial +• piecewise sinusoidal +The Rao-Wilton-Glisson (RWG) element +The MoM in Feko is based on a triangular mesh. Triangular meshes can approximate surfaces much +better than for example, rectangular patches. Feko makes use of linear roof-top basis functions +introduced by Rao, Wilton and Glisson in 1982. [61] These basis functions enforces current continuity +over a common edge of a triangle pair. +Figure 503: A triangle pair showing the current flow across the common edge as modelled by the RWG basis +function. +In Figure 503, only two triangles are shown sharing a common edge. Each triangle also has two other +edges. If these edges are connected to triangles, then additional basis functions would be required. +61. S.M. Rao, D.R. Wilton and A.W. Glisson. "Electromagnetic scattering by surfaces of arbitrary +shape," IEEE Trans. Antennas Propagation, 30, 409-418, May 1982. +Therefore for a triangle connected on all three sides, a total of three basis functions would be defined. +Within the triangle element the total current would then be the sum of these three basis functions. +In Figure 493, the Yagi-Uda was modelled with wire segments. Similar to triangle pairs, linear roof-top +basis functions are used across vertices between wire segment pairs. +Figure 504: Linear roof-top basis functions for wires modelling current across the wire vertices. +Testing and Solving the Integral Equation +The testing of the integral equation applies the integral equation over each triangle edge to obtain N +equations with N unknowns which can readily be solved on a computer. +For arbitrarily shaped bodies the integral operation is much more complicated than that for a straight +wire. It involves several mathematically complex derivations and pitfalls to navigate around of which +some are as follows: +• When the integral equations are tested, the so-called self-terms are problematic. The testing of the +integral equation at or very near the same position as the unknown leads to a (near) singularity in +the matrix equation. In Feko, a computationally efficient methodology is adopted to deal with this +problem. +• The testing of the integral equation applies the boundary condition (zero tangential electric field all +over the surface of the conductor) at discrete points. Between these points the boundary conditions +are not satisfied and this deviation is denoted the “residual”. Naturally, this residual introduces +deviations from the exact physical solution. One way to minimize the residual is to minimize the +average residual all over the structure. For this purpose, a set of vector weighting functions are +defined. Different weighting functions were proposed and the implementation in Feko is beyond the +scope of this document. +Note: Minimizing the deviation from the boundary conditions is denoted the “method of +weighted residuals” or more commonly, the method of moments. +The testing of Equation 56 results in a square matrix very similar to Equation 45. +This equation can be solved for the current coefficients by using LU decomposition routines. +Altair Feko 2022.3 +5 Feko Solution Methods +Integrating the Currents +p.675 +Summing or integrating the vector currents is the last step in the MoM procedure. This step leads to +specific output parameters such as far fields and impedance. +The Free Space Green Function +The free space Green's function is essential to the MoM to allow calculation of fields at arbitrary points +in 3D space. Without going into the finer technical details of the equation, it can be stated that the +Green function is contained inside the integral operator + operating on the surface currents, +Consider an infinitesimally small current element J in free space at a point r' radiating an electric field E +and a magnetic field H. +(57) +Figure 505: An infinitesimally small current element in free space at a point r’ radiating an E and H field. Its +potential at the point r is given by the Green Function. +The Green's function (Equation 58) gives the spatial response to a spatially impulsive current source. +This means that for the current element (source) located at the point r', the Green's function gives the +potential of this source at the point r, or any required point in 3D space. +with +(58) +(59) +the distance from the source to the field point. When there are multiple of these sources distributed +in space, such as over the arbitrary PEC body, the response at the point r is given by summing all the +sources (integration over all the sources).[62] +62. Computational Electromagnetics for RF and Microwave Engineering, Second Edition, David B. +Davidson, p.265 +MoM Computational Resources Scaling +The usage of a dense matrix in the MoM implies a limit to the size of the problem that can be solved. +The limit is determined by the available computational resources. +Although the MoM efficiently discretizes the model by only requiring the bounding surface to be +meshed, the method uses a dense matrix. As a result, the memory scaling is proportional to N2 and +CPU-time to N3, where N is the number of unknowns. +This is best illustrated by comparing the asymptotic behaviour of the memory and CPU-time scaling of a +model solved at one frequency and at double the frequency. +• At the higher frequency, the triangle patches are required to have half the edge lengths. The +number of elements increases by a factor of four. The number of unknowns is proportional to the +number of elements and the memory required to solve the problem increases by a factor of 16. +• When solving the problem at double the frequency, the simulation time increases by a factor of 64. +As the frequency and structure size increases, special techniques such as the multilevel fast multipole +method, higher order basis functions and asymptotic techniques are required to obtain a solution +efficiently. +Alternately, higher order basis functions for triangular elements could be used. Higher order basis +functions have more unknowns per element, but they allow larger mesh elements to be used. The net +result is that less memory is required. +Note: Use larger triangular elements provided the larger triangles describe the model +geometry accurately. +Higher order basis function elements can be represented with curvilinear triangle patches that allow +second order descriptions of the triangular patch boundaries. The curvilinear elements allow a further +reduction in the number of elements required for an accurate representation of the model. +Other Methods Based on the MoM +Specific methods, which can also be categorized as MoM methods, are tailor-made for solving dielectric +bodies. +Two methods specifically designed for solving dielectric bodies are as follows: +1. The surface equivalence principle (SEP) which is the default method for solving dielectric materials +in the MoM. +2. The volume equivalence principle (VEP) is an extension to the MoM for modelling finite dielectric +objects using a volume mesh. +Surface Equivalence Principle (SEP) +The surface equivalence principle (SEP) introduces equivalent electric and magnetic currents on +the surface of a closed dielectric body. The surface of such bodies can be arbitrarily shaped and is +discretised using triangles. +The surface equivalence principle (SEP) is the default method for solving dielectric materials when using +the method of moments. The SEP introduces equivalent electric and magnetic currents on the boundary +of the dielectric body (opposed to only using only equivalent electric currents on a perfectly electric +conducting body). +The SEP can model homogeneous dielectric bodies efficiently, but becomes inefficient when the material +is inhomogeneous, as is the case when modelling biological tissue or multiple thin layers of dielectric. +Feko includes other solution methods for efficient treatment of inhomogeneous dielectric structures. +These include volume equivalence principle, the finite element method and support for planar multi- +layered media. +Figure 506: An example of a layered dielectric body consisting of closed bounding surfaces. +Volume Equivalence Principle (VEP) +The volume equivalence principle (VEP) is an extension to the method of moments (MoM) for modelling +finite dielectric objects using a volume mesh (tetrahedra and cuboidal[63] elements). +The volume equivalence principle (VEP) is not used by default and would only be used when the solution +requires an alternative to the default surface equivalence principle (SEP). More basis functions are +usually required compared to the surface equivalence principle (SEP), but neighbouring cuboids or +tetrahedra may have differing electric and magnetic properties. +The VEP is associated with a volume mesh, and general usability is inhibited by the order O(N2..3) +memory and CPU-time scaling with the number of unknowns N. There are however cases where the VEP +is advantageous over the SEP or the FEM/MoM: +• The formulation is stable at low frequencies. +• The formulation is stable when modelling dielectrics with very high permittivity (high dielectric +constant). +• It displays good stability and convergence properties for an iterative solution with the MLFMM. +• It is well-suited to inhomogeneous and thin dielectric bodies. +63. Only supported in EDITFEKO +Note: Tetrahedral VEP is not supported together with other dielectric modelling methods +(SEP, FEM, VEP with cuboids, special Green’s functions) or periodic boundary conditions +(PBC). +Additional Features and Extensions for the Method of Moments +Numerous features and optimised electromagnetic (EM) analysis options for the method of moments +(MoM) are available. +Planar Green's Functions for Multi-Layered Media +Multi-layered dielectric media can be modelled with Green’s functions. Example of structures that +are efficiently modelled with the planar multi-layer substrate method include printed circuit boards +(applications using microstrip and stripline structures). +The special Green’s function formulation implements 2D infinite planes with a finite thickness to model +each layer of the dielectric and optional conducting layers. Conducting surfaces and wires inside the +dielectric layers must be discretised, but not the dielectric layers themselves. Although the layers are +infinite in extent, it is often a good approximation to practical antennas as planar structures. +Metallic surfaces and wires can be arbitrarily oriented in the media and can cross multiple layers if they +are discretised on layer boundaries (vertices have to coincide with the layer boundaries). +The planar multi-layered media can be defined with in a bounded region, allowing models with many +fine layers to be modelled efficiently without requiring the same layers throughout the entire model. +Limiting the Green's function to a specific dielectric region would require a region to be defined to +encapsulate the layered media, increasing the number of unknowns, but it can be much more efficient +when compared to the alternative of modelling each layer individually. +Good performance is achieved since calculations using Green’s functions are accelerated by using +interpolation tables. +Numerical Green's Function +The numerical Green's function can be used for problems containing static and dynamic parts, allowing +re-use of the static part of the solution in subsequent simulations to improve overall performance. +The numerical Green's function, also sometimes referred to as macro basis functions, allows users +to group a subsection of the model as being “static” and the rest of the model is then considered +“dynamic”. During the solution phase, the static part is grouped together during the matrix fill phases +and the matrix elements are stored to file. Any subsequent simulations use the static part instead of re- +calculating it, allowing the simulation to complete faster. An example where this is useful would be when +a rotor blade needs to be simulated in multiple positions or different positions of a source on a large +platform. The structure supporting the rotor blade (helicopter, aeroplane, wind turbine tower) could be +huge, much larger than the rotor blade itself, and reusing the calculations of the static part can be a +tremendous saving. +All the segmentation rules still apply and the mesh elements and vertices need to align where the static +and the dynamic parts touch. Care should be taken to ensure that the meshing is done that allows all +the variations of interest in the dynamic part. +Figure 507: Example of a large platform (static) with source (dynamic) locations that need to be investigated. +Thin Dielectric Sheets +Multiple layers of thin dielectric sheets and anisotropic sheets can be analysed using a single meshed +surface. Typical applications are the analysis of radome covered antennas. +Dielectric Coated Wires +The effect of dielectric-coated wires can be modelled using an equivalent impedance or as an equivalent +volume current. +Feko implements two methods for modelling dielectric and magnetic coatings on wires: +• Popovic’s formulation modifies the radius of the metallic wire core to change the capacitive loading +on the wire, while simultaneously adding a corresponding inductive load. The method requires that +the loss tangent of the layer be identical to the loss tangent of the surrounding medium. +• Pure dielectric layers (for example, the relative permeability of the layer equal to the surrounding +medium) should be modelled with the equivalence theorem where the effect of the dielectric +layering is accounted for by a volume polarisation current. +Note: Layers must be non-magnetic. +Altair Feko 2022.3 +5 Feko Solution Methods +Real Ground +p.680 +A real ground can be modelled with the reflection coefficient approximation or the exact Sommerfeld +formulation. Real grounds are used to model the effect of non-ideal grounds such as the earth (wet or +dry ground). +Multilevel Fast Multipole Method (MLFMM) +The multilevel fast multipole method (MLFMM) is an alternative formulation of the technology behind +the method of moments (MoM) and applies to much larger structures (in terms of the wavelength) than +the MoM, making full-wave current-based solutions of electrically large structures a possibility. +The MLFMM can be applied to large models that were previously treated with the MoM without having to +change the mesh. +The agreement between the MoM and MLFMM is that basis functions model the interaction between +all triangles. The MLFMM differs from the MoM in that it groups basis functions and computes the +interaction between groups of basis functions, rather than between individual basis functions and in so +doing reduces the number of interactions that need to be calculated. The MLFMM never really calculates +the matrix that is used during the method of moments calculation and as a result there is no direct +solution for the MLFMM. An iterative solution utilising a fast matrix-vector product is used during the +MLFMM solution phase. +Feko employs a boxing algorithm that encloses the entire computational space in a single box at the +highest level, dividing this box in three dimensions into a maximum of eight child cubes and repeating +the process iteratively until the side length of each child cube is approximately a quarter wavelength +at the lowest level. Only populated cubes are stored at each level, forming an efficient tree-like data +structure. +Figure 508: MLFMM boxes at the third level. +In the MoM framework, the MLFMM is implemented through a process of aggregation, translation and +disaggregation of the different levels. +Figure 509: MLFMM analysis of a ship (on the left) and antenna placement modelling on a commercial aircraft (on +the right). +Integral Equation Methods (EFIE, MFIE and CFIE) +The relevant integral equation method can be used to solve a model to either obtain faster iterative or +higher numerical accuracy when using the MoM or MLFMM. +When solving a structure that consists of perfectly conducting surfaces (PEC), the solution can be +accelerated using either the electric field integral equation (EFIE) or the magnetic field integral equation +(MFIE). +The EFIE method has a higher numerical accuracy and applicable to open structures, whereas the MFIE +method has much faster iterative convergence and applicable to enclosed, perfectly conducting metallic +regions. +To obtain both accuracy and faster iterative convergence for the solution using less memory, the +combined field integral equation (CFIE) method is used. +Note: The CFIE / MFIE is only applicable to enclosed, perfectly conducting metallic regions. +When specifying the CFIE factor, you are specifying if the solution must be one of the following: +• A pure EFIE solution (CFIE factor = 1) +• A pure MFIE solution (CFIE factor = 0) +• A combination of EFIE and MFIE, which is a CFIE solution (0 < CFIE factor < 1) +Note: The EFIE is the default solution in Feko. +Related tasks +Modifying the Integral Equation Method +Adaptive Cross-Approximation (ACA) +The adaptive cross-approximation (ACA) is a fast method similar to the multilevel fast multipole method +(MLFMM) but is also applicable to low-frequency problems or when using a special Green’s function. +The adaptive cross-approximation (ACA) approximates the impedance matrix by constructing a sparse +H-matrix (only a few selected elements are computed). The ACA is similar to the MLFMM in the sense +that they are both used for large models where the method of moments has become too resource +intensive, but they are quite different in implementation and applications. Models with many unknowns, +where the model is electrically small (less than a wavelength) can be solved with ACA. For electrically +large structures (multiple wavelengths) the multilevel fast multipole method is much better suited. +Finite Element Method (FEM) +The finite element method (FEM) is a solution method that employs tetrahedra to mesh arbitrarily +shaped volumes accurately where the dielectric properties may vary between neighbouring tetrahedra. +The FEM applies to the modelling of inhomogeneous dielectric bodies. It is also well suited to non- +radiating microwave components such as shielded filters. +Figure 510: Examples of MoM / FEM hybrid. +For radiating surfaces as well as wires the hybrid FEM / MoM or FEM / MLFMM is invoked and not a pure +FEM analysis. The FEM / MoM hybridisation features full coupling between metallic wires and surfaces +in the MoM region and heterogeneous dielectric bodies in the FEM region. The MoM part of the solution +is calculated first, which results in equivalent magnetic and electric currents that form the radiation +boundary of the FEM region. This hybrid method incorporates the strengths of both the MoM and the +FEM. +When a structure is bounded only by PEC surfaces and FEM modal ports, Feko recognises that the +problem can be solved by just the FEM (fully sparse matrix solution), resulting in a reduction in memory +and runtime. For electrically large problems, the hybridised FEM / MLFMM can be used where the +MLFMM solves the MoM part of the FEM / MoM problem efficiently. +Finite Difference Time Domain (FDTD) +The finite difference time domain (FDTD) is a full wave time domain solution method, and Fourier +transforms are applied to convert the native time domain results to the frequency domain. +The finite difference time domain (FDTD) solution technique has gained popularity in computational +electromagnetics (CEM). Much of this popularity comes from its relatively straightforward formulation, +where electric and magnetic fields are computed on two offset rectilinear grids and marched in time. +This approach allows for the use of central differencing to approximate Maxwell’s equations. It can +achieve second-order accuracy using first-order numeric differentiation. +The solution method is best suited to problems that include highly inhomogeneous materials and is, +therefore, a popular choice in biomedical applications for the modelling of human phantoms. It is also +a highly efficient solution for wideband problems, and is well suited to analyse broadband antennas. +A single FDTD simulation with a pulsed excitation can be used to characterise a wideband frequency +response of an antenna. +Also, the method lends itself well to various parallelisation techniques, including the use of accelerators +such as GPUs to obtain significant speedups. +Figure 511: The FDTD voxel mesh of a GSM antenna. +Altair Feko 2022.3 +5 Feko Solution Methods +5.3.2 Asymptotic Solutions +p.684 +Asymptotic solution methods solve Maxwell's equations, but make certain assumptions regarding the +nature of the problem. Feko provides various high frequency asymptotic solution methods that assume +the frequency of interest is high enough that the structure is much larger than the wavelength. +Ray Launching Geometrical Optics (RL-GO) +The ray launching geometrical optics (RL-GO) is a ray-based method intended for modelling electrically +large dielectric and perfect electrically conducting structures in applications such as lens antennas and +radar cross section (RCS) analysis. +The RL-GO is formulated for use in instances where electrically very large (> 20λ) metallic or dielectric +structures are modelled. RL-GO is inherently well suited to the solution of large scattering problems +such as radar cross section (RCS) analysis since the “shooting and bouncing rays” approach are highly +efficient for an arbitrary number of multiple reflections. +Figure 512: RCS of an aircraft at 1 GHz in the elevation plane: Comparison between MLFMM and RL-GO. RL-GO +required 33 times less memory. +Feko integrates the RL-GO method with the current-based MoM, by launching rays from each radiating +MoM element. The ray interactions with metallic and dielectric structures are then modelled using +Huygens sources placed on each ray contact point (for reflected, refracted and transmitted rays) on +the material boundaries. The runtime and memory requirements scale almost perfectly for parallel +processing, resulting in multi-core CPUs or cluster computers operating highly efficiently while solving +RL-GO problems. +A typical application of the MoM / RL-GO hybrid method is the analysis of dielectric lenses. The source +structure (for example a metallic antenna under a lens), may be modelled with the MoM and the large +dielectric lens may be modelled with the RL-GO. +Figure 513: Reflector near field calculated with RL-GO. +Physical Optics (PO) +The PO solution method is an asymptotic high-frequency numerical method of the same nature as the +UTD but based on currents and not rays. +The PO solution method is formulated for use in instances where electrically very large metallic or +dielectric structures are modelled. Feko hybridises the current-based accurate MoM with PO including +bidirectional coupling between the MoM and PO regions. It discretises a PO region, as it would for a MoM +solution, making it a simple task to switch between solution methods. In cases where the MoM part of +the problem is electrically large, the PO hybridised with the MLFMM provides an efficient solution. +A practical example for PO would be to calculate the effect on the input impedance of a horn antenna +(treated with the MoM) when placed near a large structure (treated with the PO). +Figure 514: PO modelling of a reflector antenna with MoM modelling of the feed. +Large Element Physical Optics (LE-PO) +The large element physical optics (LE-PO) solution method is similar to the PO method but allows larger +elements to be used. +The large element physical optics (LE-PO) is formulated for use in instances where electrically very +large structures are modelled. This method should only be used when there are no discontinuities in +the incident field (the field incident on the LE-PO face should closely represent a plane wave). LE-PO +is similar to PO in that it is an asymptotic high-frequency numerical method of the same nature as the +UTD. +The high-frequency large element physical optics method is applicable for large smooth areas when +calculating near and far fields. +Uniform Theory of Diffraction (UTD) +The uniform theory of diffraction (UTD) is formulated for modelling electrically extremely large +structures. The UTD is an asymptotic high-frequency numerical method similar to the PO. +Users typically attempt a solution with the MoM, and when they realise that the structure is electrically +too large to solve with their available resources (platform memory and time), they turn to the MLFMM. +If the required resources are still too large, the PO, UTD or ray launching geometrical optics (RL-GO) +can be used. +The Solver contains the following two UTD-based solvers: +Uniform theory of diffraction (UTD) with polygons and cylinders +Feko hybridises the current-based accurate MoM with the UTD. Bidirectional coupling between +the MoM and UTD is maintained in the solution (through modification of the interaction matrix) to +ensure accuracy. Frequency does not affect the memory resources required for solving a structure +with UTD, given that only points of reflection from surfaces and diffraction from edges or corners +are considered without meshing the structure. +Figure 515: UTD modelling of cross-coupling on the superstructure of a modern naval vessel. +Multiple reflections, edge/wedge and corner diffraction and creeping wave effects on curved +surfaces are considered. Insight into the propagation of rays are provided in POSTFEKO during +post-processing. Currently, the numerical formulation of the UTD only allows it to be applied to +flat polygonal plates with minimum edge lengths in the order of a wavelength, where surface +curvature is not considered. A single canonical circular cylinder can be included in the model. +Creeping waves are only considered on the cylinder. The UTD is well suited to the analysis of ships +at radar frequencies but less appropriate for analysing complex objects with curved surfaces (such +as automobiles). +Figure 516: Analysis of the transmission patterns of an X-band radar mounted on a ship. +Faceted uniform theory of diffraction (faceted UTD) +The faceted-UTD solver can be used to calculate fields and radiation patterns for antenna +placement applications at high frequencies. It supports impressed sources and a planar triangular +PEC surface mesh. The resource requirements are independent of frequency, but depend on the +number of mesh elements required to accurately represent the geometry and the number of field +observation points. Multiple reflections, diffraction and creeping wave effects on curved surfaces +are considered. +The faceted-UTD solver is well suited for antenna placement on electrically large platforms with +planar or curved surfaces (such as aircrafts). +5.3.3 Solution Methods per Application +A solution method is selected based on the electrical size of a problem, the geometrical complexity and +available computational resources. +Solution method is ideally suited to the problem. +Solution method could be used, but an alternative method is +better suited to the problem. + +Indication that the respective solution method should not be used. +Table 56: The electromagnetic solution methods suited to the various applications. +Geometrically +complex +Electrically large +Wire antennas +Microstrip +antennas +Aperture +antennas +Reflector +antennas +Windscreen +antennas +Conformal +antennas +Broadband +antennas +Array antennas +Lens antennas +Radomes +Antenna +placement +(radiation +pattern) +Antenna +placement +(coupling) +Biomedical +RADHAZ zones +Geometrically +complex +Electrically large +Periodic +structures FSS, +metamaterials +Scattering with +plane wave +source (RCS) +Scattering with +localised source +EMC/EMI +shielding and +coupling +Propagation +environment +Cable bundle +coupling +Waveguide +components +Connectors +Microstrip +circuits +5.3.4 Cable Coupling +Model complex cable-bundle networks using full-wave simulations. +When modelling cables, two methods are available: +• multiconductor transmission line (MTL) +• combined method of moments / multiconductor transmission line (combined MoM / multiconductor +transmission line) +Results from the above methods may differ due to the effect of the additional combined MoM / MTL +termination segments. Make provision for the non-idealities of the combined MoM / MTL method in the +MTL model by adding equivalent parasitic circuit elements to the MTL cable model. +Multiconductor Transmission Line (MTL) +An arbitrary cable (shielded or unshielded) can be solved using the multiconductor transmission line +(MTL) solution method hybridised with the MoM, MLFMM or FDTD (only irradiation). +MTL theory is used to model the cable problem, while the MoM or MLFMM is used for the solution of the +external fields and currents that couple to or from the cable harness. +MTL theory is limited in application to situations where cables run close to a ground plane. The cable +path should be within + (ideally within +) of the conducting surface. Cables that are solved with the +MTL may not be connected directly to MoM geometry. The connection between the cable circuit and +ground is modelled using non-radiating networks. +Method of Moments (MoM), Only For Shielded Cables +An arbitrary shielded cable can be solved using the combined method of moments and multiconductor +transmission line (MoM / MTL) solution method. +Any arbitrary cable path can be defined, and there is no restriction on the cable path’s proximity to a +ground plane. +For the combined MoM / MTL method, the outer shield is replaced by physical MoM segments. +If a cable is not connected directly to MoM geometry, additional segments are added from the shield +to ground. The inner cable cross-section geometry is solved with the MTL. The shield inner current is +transformed via the shield transfer impedance, resulting in distributed voltage sources that are applied +to the shield segments that are included internally in the MoM part of the solution. +Figure 517: A generic car with a cable harness. +5.3.5 Arrays and Infinite Periodic Structures +Infinite and finite periodic structures are efficiently modelled using special features available in Feko. +Arrays and finite periodic structures can be modelled using any of the full wave solution methods +in Feko, but this can lead to long simulation times and high resource requirements, making these +simulations impractical. +Finite Antenna Arrays +Finite antenna arrays where the elements are identical and the feed magnitude is similar can +be modelled using the domain Green's function method (DGFM). The method is based on +perturbation of the results from a single element and requires the elements to identical and +similar (not identical) in terms of currents flowing on the elements. +Large finite arrays can also be approximated by infinite arrays by calculating the currents for the +infinite structure, but then only taking a finite number of elements into account when calculating +the far and near fields. The larger the array, the more accurate the approximations, since the +error is the greatest at the edges of the array. These edge effects can also be taken into account +(approximately) by modelling a finite array and using the currents of different elements (centre, +edge, corner) to reconstruct the large array using radiating antenna sources. +Infinite Arrays +The periodic boundary conditions in Feko allow infinite 1D and 2D arrays to be modelled very +efficiently. Users can either define the excitation or the phase difference between the elements. +Frequency Selective Surfaces +Frequency selective surfaces are also infinite structures and their properties can be investigated +using the periodic boundary conditions method. Once their properties are known, approximations +to these frequency selective surfaces are used to model complex, large, but finite, structures. +Domain Green's Function Method (DGFM) for Large Finite Arrays +The domain Green's function method (DGFM) is a perturbation approach where the mutual coupling +between array elements is taken into account when calculating the Green’s function for each +element. The current distribution on the entire array geometry is obtained by solving each element +independently, leading to a significant saving in both runtime and memory usage. +The method also takes into account the edge effects attributed to the finite size of the array, complex +excitations with non-linear phase shift and is not limited to periodic array configurations. +Figure 518: An array of non-identical patch antennas to be solved with the DGFM. +Periodic Boundary Conditions (PBC) +Periodic boundary conditions allow for analysing large, uniformly spaced, repetitive linear and planar +structures, for example, frequency selective surfaces (FSS). +Figure 519: Example of applying PBC to a frequency selective surface, for example a Jerusalem cross. +5.3.6 General Non-Radiating Networks +Complex feed networks can be simplified by including them as a circuit representation using general +network blocks. +General networks (defined using network parameter matrices) can be used to model a feed network. +These non-radiating networks may be interconnected (cascaded) and excited or loaded directly at the +ports. +Figure 520: A four-port general non-radiating network. +The voltages and currents at the ports of these ideal representations of networks may interact with +currents and voltages on parts of the model that are solved using other solution methods, though no +radiation-based coupling is taken into account. +5.3.7 Windscreen Modelling +The windscreen antenna solution method reduces the computational requirements by meshing only +metallic elements while analysing the behaviour of the integrated windscreen antennas within their +operating environment. The analysis can take into account the physical features of windscreen antennas +and their surroundings. +The following physical features are taken into account when analysing windscreen antennas: +• Finite sized windscreens +• Arbitrarily curved (no extreme curvature) windscreens +• Multiple dielectric windscreen layers (glass, plastic and other dielectric materials) +• Multiple windscreens in a vehicle (multiple glass definitions supported) +• The vehicle body +• The presence of real ground +The analysis is based on the MoM and can be used in conjunction with the multilevel fast multipole +method (MLFMM). It is an efficient approach due to only including the vehicle body and metallic antenna +elements in the MoM mesh. The windscreen layers are not discretised. +Numerous electromagnetic characteristics of the windscreen antenna can be computed, including: +• Current distribution on the antenna and vehicle +• Input impedance bandwidth and scattering parameters +• Near field distributions and far field radiation patterns +Figure 521: An example of a windscreen antenna (on the left) and an automobile with a far field and near field +result (on the right). +5.3.8 Symmetry Planes +Geometric symmetry, electric symmetry and magnetic planes of symmetry in a model can be exploited +to reduce runtime and memory requirements. +Symmetry in a model applies to the method of moments (MoM) and all hybrid techniques where the +MoM is involved, but not in conjunction with the multilevel fast multipole method (MLFMM). +A symmetric model without geometric symmetry defined is not guaranteed to have a symmetric mesh. +Such a setup leads to non-symmetric current distributions on the structure. +Geometric Symmetry +The structure must be symmetric concerning the symmetry plane, while the sources may be arbitrarily +located. +Electric Symmetry +To define an electric symmetry plane, the following must be true: +• The model must be geometric symmetry at the plane. +• The electric current density must be anti-symmetric. +• The magnetic current density must be symmetric. +For example, a physical interpretation of an electric symmetry plane is a plane which can be replaced by +a perfect electric conductor (PEC) wall without changing the field distribution. The tangential component +of the electric field and the normal component of the magnetic field are zero at such a plane. +Figure 522: Electric symmetry plane +Magnetic Symmetry +To define a magnetic symmetry plane, the following must be true: +• The model must be geometric symmetry at the plane. +• The electric current density must be symmetric. +• The magnetic current density must be anti-symmetric. +For example, a physical interpretation of a magnetic symmetry plane is a plane which can be replaced +by a perfect magnetic conductor (PMC) wall without changing the field distribution. The normal +component of the electric field and the tangential component of the magnetic field are zero at such a +plane. +Figure 523: Magnetic symmetry plane +Computational Benefits of Using Symmetry +Exploiting symmetry in model affects the calculation of the matrix equation, which can lead to a +reduction in runtime and memory requirements. +Geometric Symmetry +The arbitrarily placed sources lead to unsymmetrical current distributions. As a result, all unknown +coefficients on all the mesh must be solved. The matrix equation being solved is, as a result, the same +as it would have been, without symmetry being considered. +The computation time is however reduced for setting up the matrix equation. This reduction is achieved +by exploiting the interaction between any two basis functions is the same as that between their +symmetrical counterparts. +Electric / Magnetic Symmetry +When using electric / magnetic symmetry, less computational time is required to calculate the matrix +equation entries. The major benefit of using symmetry is that the number of unknown coefficients is +reduced by a factor of two. The system of linear equations to be solved has only half of the dimension, +in comparison to a model without electric / magnetic symmetry. +The impact for the method of moments (MoM) is a reduction by a factor four (=2*2) in memory +requirement, as the MoM has fully populated matrices. +The impact for the finite element method (FEM) is a reduction by a factor two in memory requirement, +as the FEM leads to sparsely populated matrices. The reduction in unknowns also leads to a dramatic +lowering of matrix equation solution time. +5.3.9 Media +Provided are the formulations and concepts to define frequency-dependent dielectric media and +anisotropic media (3D). +Dielectric Media (Frequency-Dependent) +The frequency-dependent dielectric media formulations supported in the Solver are Debye relaxation, +Cole-Cole, Havriliak-Negami, Djordjevic-Sarkar and frequency list (linear interpolation). +To define a dielectric, you need to define both the dielectric properties (dielectric modelling) and +magnetic properties (magnetic modelling) of the medium. +Dielectric Modelling +The dielectric properties of the dielectric is defined. +Frequency Independent +The media is defined in terms of the relative permittivity ( ), relative permeability ( +), magnetic loss +tangent ( +), and the dielectric loss tangent ( +) or conductivity ( ). +For example, low loss dielectric substrates are typically specified in terms of the loss tangent, while +human tissue (used in specific absorption rate studies) are specified in terms of conductivity. +The effective permittivity of the dielectric is given by: +or +(60) +(61) +Debye Relaxation +The Debye relaxation[64] describes the relaxation characteristics of gasses and fluids at microwave +frequencies. It has been derived for freely rotating spherical polar molecules in a predominantly non- +64. R.Coelho, Physics of dielectrics for the Engineer, 1st ed. Elsevier Scientific Publishing Company, +1979. +polar background. The method is defined in terms of the relative static permittivity ( ), relative high +frequency permittivity ( +) and the relaxation frequency ( +). +(62) +Cole-Cole +The Cole-Cole[65] model is similar to the Debye model, but uses one additional parameter to describe +the material. The model is defined in terms of the relative static permittivity ( ), relative high +frequency permittivity ( +) and the attenuation factor ( ). +), relaxation frequency ( +(63) +Havriliak-Negami +The Havriliak-Negami[66] is a more general model and should be able to successfully model liquids, +solids and semi-solids. It is defined in terms of the relative static permittivity ( ), relative high +frequency permittivity ( +), attenuation factor ( ) and the phase factor ( ). +), relaxation frequency ( +(64) +Djordjevic-Sarkar +The Djodervic-Sarkar[67] model is particularly well suited as a broadband model for composite +dielectrics. It is defined in terms of the variation of real permittivity ( +), conductivity ( ), lower limit of angular frequency ( +permittivity ( +), relative high frequency +) and the upper limit of angular +frequency ( +). +(65) +65. K.S. Cole and R.H. Cole, “Dispersion and absorption in dielectrics,” Journal of Chemical +Physics,vol.9, pp.341-351, 1941 +66. +J. Baker-Jarvis, M. D. Janezic, J. H. Grosvenor, and R.G. Geyer, “Transmission/reflection and short- +circuit line methods for measuring permittivity and permeability: Technical note 1355-r,” National +Institute of Standards and Technology, Tech. Rep., 1994 +67. Djordjevic, R.M. Biljic, V.D. Likar-Smiljanic, T.K. Sarkar, Wideband frequency-domain +characterization of FR4 and time-domain causality, IEEE Transactions. on Electromagnetic +Compatibility, vol. 43, no.4, 2001, p.662-667 +Frequency List (Linear Interpolation) +Data points at a range of frequencies are specified. Values for the dielectric properties are then linearly +interpolated to obtain the dielectric properties at frequency points other than specified. Parameters +required are frequency, relative permittivity ( ) and either the loss tangent ( +) or conductivity ( ). +Magnetic Modelling +The magnetic properties of the dielectric is defined. +Non-Magnetic +The relative permeability ( +) is set to 1.0 and the magnetic loss tangent ( +) is set to 0.0. +Frequency Independent +The media is defined in terms of the relative permeability ( +) and the magnetic loss tangent ( +). +The effective permeability of the dielectric is given by: +(66) +Frequency List (Linear Interpolation) +The dielectric properties of the material are defined at various frequency points. Values for the dielectric +properties are then linearly interpolated to obtain the dielectric properties at frequency points other +than specified. +Data points at a range of frequencies are specified. Values for the dielectric properties are then linearly +interpolated to obtain the dielectric properties at frequency points other than specified. Parameters +required are frequency, relative permeability ( +) and the magnetic loss tangent ( +). +Anisotropic Media (3D) +The anisotropic media formulations supported in the Solver are diagonalised tensor, full tensor, complex +tensor and Polder tensor (for ferrites). +Note: Only passive media are supported. Passive media can be either lossless or lossy.[68] +Diagonalised Tensor +The permittivity along the UU, VV and NN axes are described by diagonal tensor: +(67) +68. A lossless passive medium allows fields to pass through the medium without attenuation. In a lossy +passive medium, a fraction of the power is transformed to heat, as an example. +Altair Feko 2022.3 +5 Feko Solution Methods +The permeability along the UU, VV and NN axes are described by diagonal tensor: +p.699 +(68) +Full Tensor +The permittivity along the UU, UV, UN, VU, VV, VN, NU, NV and NN axes are described by the dyadic +tensor: +(69) +The permeability along the UU, UV, UN, VU, VV, VN, NU, NV and NN axes are described by the dyadic +tensor: +Complex Tensor +The permittivity along the UU, UV, UN, VU, VV, VN, NU, NV and NN axes are described by the dyadic +tensor: +(70) +(71) +The permeability along the UU, UV, UN, VU, VV, VN, NU, NV and NN axes are described by the dyadic +tensor: +(72) +To create the full permittivity and permeability tensors, create up to nine dielectrics constituting the +medium properties along the UU, UV, UN, VU, VV, NU, NV and NN axes. +If no linear dependencies exist between two axes, add a zero (0) entry. +Important: +• An entry in the tensor must be a complex number, pure real number or a pure +imaginary number. +• An entry may not be 0. +Polder Tensor +The ferrimagnetic[69] material is described by the permittivity tensor (where the static magnetic field is +orientated respectively along the U, V and N axis): +(73) +The ferrimagnetic material is described by the permeability tensors (where the static magnetic field is +orientated respectively along the U, V and N axis): +(74) +(75) +(76) +(77) +(78) +Where and elements of the permeability tensor are given by +and where, +operating frequency: +Lamor (precession) frequency: +forced precession frequency: +gyromagnetic ratio: +magnetic bias field: +DC saturation magnetisation: +. +69. D. M. Pozar, “Theory and Design of Ferrimagnetic Components” in “Microwave Engineering”, 2nd +ed., New York: Wiley, 1997, ch 9, pp. 497-508 +To account for magnetic loss, the resonant frequency can be made complex by introducing a damping +factor ( ) into Equation 77 and Equation 78. The damping factor and the field line width ( +of the imaginary susceptibility curve against the bias field at half its peak value, are related by +), the width +. +(79) +Note: The Polder tensor is defined using CGS[70] units in terms of: +• saturation magnetisation (Gauss): +• line width (Oersted): +• DC bias field (Oersted): +• field direction. +70. CGS is the system of units based on measuring lengths in centimetres, mass in grams and time in +seconds. +Optimisation in Feko +6 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. +This chapter covers the following: +• 6.1 Optimisation Workflow in CADFEKO (p. 703) +• 6.2 Launching OPTFEKO (Windows) (p. 705) +• 6.3 Launching OPTFEKO (Linux) (p. 706) +• 6.4 Command Line Arguments for Launching OPTFEKO (p. 707) +• 6.5 Optimisation Methods and Stopping Criteria (p. 709) +• 6.6 Optimisation Parameters (p. 713) +• 6.7 Optimisation Masks (p. 715) +• 6.8 Defining an Optimisation Goal (p. 718) +• 6.9 Global Goal: Combining and Weighting of Multiple Goals (p. 735) +• 6.10 Optimisation Using .PRE File modifications (p. 737) +• 6.11 Optimisation Solver Settings (p. 739) +The CADFEKO interface supports optimisation searches. Refer to the optimiser OPTFEKO for information +regarding optimisation algorithms and related options. An optimisation example can be found in the +Feko Getting Started Guide. +Note: Continuously sampled results (generated using ADAPTFEKO) cannot be used in an +optimisation. Only single or discretely sampled frequency settings are allowed. +Related concepts +6.1 Optimisation Workflow in CADFEKO +The workflow for setting up an optimisation in CADFEKO is explained. +Figure 524: The workflow for defining an optimisation search in CADFEKO. +Select the Optimisation Method +The following optimisation methods are available:: +• Simplex (Nelder-Mead) +• Particle swarm optimisation (PSO) +• Genetic algorithm (GA) +• Adaptive response surface method (ARSM) +• Global response surface method (GRSM) +• Grid search +Select the Model Parameters +The model parameters are the variables defined by the user with which certain characteristics of the +model can be varied, for example, its length, spacing between parts, and height. In this step of the +workflow, the variables used in the optimisation are selected from a drop-down list. +Altair Feko 2022.3 +6 Optimisation in Feko +Define the Parameter Range +p.704 +Define the range over which each selected parameter varies by specifying the Min value, Max value +and optionally the Start value. +Define an Optimisation Mask +This step is optional. An optimisation mask is a set of user-specified values that form a continuous line +to which the optimal solution is fitted to. The optimised solution is specified to be either less than, equal +or greater than the mask. During the calculation of the optimal solution, the goal values are compared +to the mask. If the mask criterion is satisfied, the values are added to an array of values. +Define the Optimisation Goal +Define the goal(s) that specify the desired state of the model that the optimisation process should +attempt to achieve by varying the specified model parameters. +Run the Optimisation (OPTFEKO) +Run OPTFEKO to calculate the optimum solution for the specified parameters. +View the Optimum Model +After the optimisation completed, a CADFEKO model is created with the optimum parameters. The file is +given a “_optimum” suffix. +Note: Continuously sampled results (generated using ADAPTFEKO) cannot be used in an +optimisation. Only single or discretely sampled frequency settings are allowed. +Related concepts +Optimisation Methods and Stopping Criteria +6.2 Launching OPTFEKO (Windows) +Use the most suitable option for launching OPTFEKO. +Launch OPTFEKO using one of the following options: +• On the Solve/Run tab, in the Run/Launch group, click the + OPTFEKO icon. +• From the command line in a terminal environment. +1. On the desktop, click the Windows Start button. +2. Type Feko + WinProp 2022.3. +3. Select the +Feko + WinProp 2022.3 icon, from the list of filtered options. +4. On the Tools tab, select the Feko Terminal + icon. +5. +In the terminal (assuming the model with file name dipole.cfx is to be optimised) type the +following command +optfeko dipole +and press Enter. +Note: The above steps launches OPTFEKO without any special settings. It is also +possible to use parallel processing for optimisation. +Related reference +Command Line Arguments for Launching OPTFEKO +6.3 Launching OPTFEKO (Linux) +Use the most suitable option for launching OPTFEKO in Linux. +Launch OPTFEKO using one of the following options: +• On the Solve/Run tab, in the Run/Launch group, click the + OPTFEKO icon. +• Launch OPTFEKO from the command line in a terminal environment. +1. Open a command terminal. Source the script “initfeko” using the absolute path to . /home/ +2. +user/2022.3/altair/feko/bin/optfeko +In the terminal (assuming the model with file name dipole.cfx is to be optimised) type the +following command +optfeko dipole +and press Enter. +Note: The above steps will launch OPTFEKO without any special settings. It is also +possible to use parallel processing for optimisation. +6.4 Command Line Arguments for Launching +OPTFEKO +Use the command line arguments to pass additional information to OPTFEKOwhen it is launched. +Table 57: Command line arguments for launching OPTFEKO. +Argument +--version +-r +--restart x +Description +Displays the current version of OPTFEKO. +All interim model files are deleted after each analysis. The +optimum results are, however, not deleted, and are available +with the string (_optimum) appended to the file name. This +saves disk space during and after the optimisation process. +Resumes an optimisation process that has been stopped, +provided that all of the interim optimisation files (.fek, +.bof and .cfx) are still available (for example, the previous +optimisation has been stopped by pressing Ctrl+C or due to +a power failure or a Feko error). +-np x +The number of processors used for farming out of the +individual optimisation steps. +--machines-file machname +--eval-aim-only x +--runfeko-options +The file machname is the machines file with the node names +and the number of CPUs used for farming of the individual +optimisation steps. This machines file is used for both +farming and parallel execution when farming and parallel +execution is used simultaneously. +The value of the goal function is calculated only for one +existing file (x) — no optimisation is done. (This is mostly +used for debugging.) +After this option one can specify additional options which is +used in the launcher RUNFEKO for the Solver. For example, +to use the parallel Solver during the optimisation, the +command +optfeko file --runfeko-options -np 2 +or +optfeko file --runfeko-options -np 2 --machines- +file m +Argument +Description +where m is the machines file. For a remote execution of +the Feko runs during the optimisation on another host, the +suitable command is +optfeko file --runfeko-options --remote-host + hostname +Additional options for ADAPTFEKO and PREFEKO is included +in the OPTFEKO command as part of the RUNFEKO options. +The options are passed to the relevant component by +RUNFEKO as needed. This allows for control of all of the Feko +components during the optimisation process. +6.5 Optimisation Methods and Stopping Criteria +The duration and accuracy of an optimisation depends on the selected optimisation method and +stopping criteria. +On the Request tab, in the Optimisation group, click the + Add Search icon. +After adding the optimisation search it is visible in the model tree . To change the optimisation search +method and settings double-click or open the right-click context menu for the relevant search (the +default label is Search1) in the Optimisation tree. +The following optimisation method types are supported . +Automatic: +A method is automatically chosen by the optimiser. +Simplex (Nelder-Mead): +A gradient-based or “hill-climbing” method. +Particle swarm optimisation +(PSO): +A swarm-based global search method. +Genetic algorithm (GA): +An evolutionary global search method. +Grid search: +This method searches over a predefined grid of parameter sets. +Adaptive response surface +method (ARSM): +This method internally builds a response surface that is updated +as more sample points are added. +Global response surface +method (GRSM): +This method internally builds a response surface that is updated +as more sample points are added and continues to test different +areas of the design space. +Table 58: Optimisation methods overview +Method Description +Number +of +variables +Convergence +Accuracy +Farming +Simplex +local search, optimum +strongly dependent on +starting point +PSO +GA +population-based +stochastic global search +robust, stochastic global +search +ASRM +response surface based +approach +low +fast +locally high, +globally low +initial/ +recreating +simplex +high +slow +medium/high +yes +high +slow/medium +medium/high +yes +medium +fast +low/medium +no +Altair Feko 2022.3 +6 Optimisation in Feko +Method Description +GSRM +response surface based +approach, good balance +between local and global +p.710 +Convergence +Accuracy +Farming +Number +of +variables +high +medium +high +yes +Create Optimisation Search - Options Tab +Figure 525: The Create Optimisation Search dialog, Options tab +Note: The layout of the Options tab depends on the selected optimisation Method type. +Optimisation convergence +accuracy (standard deviation) +Default number of points +This setting controls the level of accuracy required by the search +algorithm to converge. The three options, High (slower), +Normal (default) and Low (faster) modify the conditions under +which the search algorithm converges, and is also dependent +on which optimisation Method type is chosen, since some +techniques have a predetermined number of samples. +Only applicable when the Method type is set to Grid search. +Specify the number of grid points to use for each optimisation +parameter in the predefined grid. This value is used for the Grid +points on the Optimisation parameters dialog if no values are +specified. +Altair Feko 2022.3 +6 Optimisation in Feko +Add Optimisation Search - Advanced Tab +p.711 +Figure 526: The Add optimisation search dialog, Advanced tab. +Note: The layout of the Advanced tab depend on the selected optimisation Method type. +Specify maximum number of solver runs +The optimisation process is terminated when the Feko Solver is launched, the specified number of +times during the optimisation process. +For the PSO and GA methods, should a full swarm or generation not be generated within the +allowable number of allocated runs, the optimisation may terminate before the indicated number +of solver runs. +When an optimisation process terminates due to reaching the value in Specify maximum +number of solver runs, the optimum solution found up to that point and the optimisation +process information are made available. +Random number generation +This group is visible for those methods that make use of randomised sampling and allows setting +the seed value. +Default +The seed value is set equal to a fixed default. +Generate random seed +The seed value is set equal to a random integer number. +Specify seed value +The seed value is entered as a positive integer. +Multiple Searches +If multiple searches are defined in a model, and is represented as individual branches below the +Optimisation heading in the model tree. Only one optimisation search may be activated at a time. +If only one search is defined in the model, then the search is active. The settings for each search are +independent, and only the settings specified in the active search are saved to the .opt and .pfg files +for use during an optimisation run. +To activate a specific search, from the right-click context menu select Activate or select the Request +tab and click the + Activate icon. +The active search is indicated by the + icon in the model tree. +Related concepts +Simplex (Nelder-Mead) +Particle Swarm Optimisation (PSO) +Genetic Algorithm (GA) +Grid Search +Adaptive Response Surface Method (ARSM) +Global Response Surface Method (GRSM) +6.6 Optimisation Parameters +Specify the variables to alter during the optimisation run. +In the model tree (Construction tab), select the relevant search. On the Request tab, in the +Optimisation group, click the + Parameters icon. +Figure 527: The Optimisation parameters (Variables tab) dialog. +The optimisation parameters are local to each optimisation search and a valid search must contain +at least one active parameter. Any variable defined in CADFEKO is available as an optimisation +parameter, for example, physical dimensions, loads and sources (amplitude and phase), provided +that a dependency is not implied between optimisation parameters in the same search. Optimisation +parameters are added or removed from the list by using the Add and Remove buttons. +For each optimisation parameter a Min value and Max value is required. Optionally a Start value +in the variable range can be specified. The starting value effects the optimisation process when +randomised techniques are used, for instance, particle swarm optimisation or genetic algorithm. If +the Start value is not specified by the user, the value at the centre of the range will be taken as the +starting point for the optimisation. +Related concepts +Particle Swarm Optimisation (PSO) +Genetic Algorithm (GA) +6.6.1 Constraints Between Optimisation Parameters +A dynamic boundary is defined for an optimisation parameter by specifying a constraint. +A constraint is defined by specifying two parameters and their dependency on one another, see +Figure 528. The following dependencies are available: !=, <, <=, > and >=. +Figure 528: The Optimisation parameters (Constraints tab) dialog. +Parameter and Constraint Deactivation +For each parameter in the parameter list or constraint in the parameter constraints list, a Use check- +box is used to include or exclude each specific parameter or constraint in the optimisation search +process. If the Use check box for a specific parameter or constraint is not selected then that parameter +or constraint is excluded in the .opt or .pfg files and does not influence the optimisation search. If a +parameter is deactivated, the value of the variable as specified in the CADFEKO variables list is used as +if it is not defined as an optimisation parameter. +Note: All parameter and constraint settings are local to each search. Deactivating a specific +parameter or constraint in the parameter settings of one search does not deactivate that +parameter or constraint in any other search. +6.7 Optimisation Masks +An optimisation mask is a graphical approach to define an optimisation search. More complex scenarios +are handled by a mask, where the goal shape is visually known, for example, the desired bandpass and +bandstop regions of a filter. +6.7.1 Defining an Optimisation Mask +An optimisation mask is a set of values that form a continuous line (or trace). Use a mask for specifying +a specific performance curve for a requested output. +1. On the Request tab, in the Optimisation group, click the + Add Mask icon. +2. Specify the X and Y coordinates of the mask points using one of the following methods: +1. Enter the coordinates in the X and Y text boxes. +2. +Import the values from an external file by clicking the Import points button. +Note: The import starts from the first coordinate point and overwrites any +existing coordinate definitions. Changes in the external file requires a re-import +of the values. +3. Enter a label for referencing the mask in the optimisation objective. +4. Press Create to create and close the dialog or press Add to add another mask. +Note: The same mask can be used in multiple optimisation searches. +Figure 529: The Create Optimisation Mask dialog. +6.7.2 How Masks are Used for Optimisation +Perform complex optimisations with masks by specifying a variable goal. Apply the mask correctly to +avoid undesired results. +See Figure 530 for a graphical representation of the mask. This is useful for validating that the mask +data is correct, particularly when working with a large number of data points imported from an external +file. +Figure 530: The desired frequency response of a Ku-band waveguide filter (indicated in green) with a mask +(indicated in blue) and (b) the Create optimisation mask dialog. +All the calculated points that satisfy the criteria for the goal type and name are added to a long array +of values and then compared to the mask. The following examples illustrate the usage of masks during +optimisation. +Example 1: Optimisation of a Far Field Pattern at a Single Frequency +Create the mask with the required shape and the far field request that is compared to the mask. The +first point (angle) in the far field calculation map to the first point in the mask and the last point (angle) +in the far field calculation map to the last point in the mask. All other points of the far field is compared +to points in the mask (linear interpolation is used to ensure a continuous mask). +Example 2: Optimisation for a Specific Gain Profile over Frequency +Create the far field request containing a single far field point. There after create the mask that contains +the gain profile over frequency. The gain at the first frequency map to the first point in the mask and +the gain at the last frequency map to the last point in the mask. The gain at the frequency values within +the range are compared to the values in the mask using linear interpolation. +Example 3: Optimisation for a Varying Far Field (Gain) Profile Over Frequency +Using a combination of the two examples above create a complex optimisation requiring a predefined +far field/gain pattern that changes as a function of frequency. Create the multi-point far field requests +for each frequency. There after create a mask that the first point of the mask map to the first point in +the far field request at the first frequency. The last point in the mask map to the last point of the far +field request of the last frequency. If the required far field pattern is unchanged over frequency then the +mask contains the same far field pattern repeated N times, where N is the number of frequency points. +Warning: Optimisation does not fail due to an incorrect mask, but the optimum results +could be unexpected. +6.8 Defining an Optimisation Goal +An optimisation goal defines the request type to be optimised and the goal it will attempt to achieve. +To define an optimisation goal, you first need a defined optimisation search. +1. +In the model tree under Optimisation, select a search. +2. On the Request tab, in the Optimisation group, click the + Add Goal Function icon. +3. From the drop-down list, select one of the following: +• +• +• +• +• +• +• +• + Impedance Goal + Near Field Goal + Far Field Goal + Power Goal + Receiving Antenna Goal + S-Parameter Goal + Transmission / Reflection Goal + SAR Goal +6.8.1 Structure of an Optimisation Goal +Each part of the definition in an optimisation goal serves a specific purpose and should be correctly +understood and applied for the desired optimisation outcome. +All optimisation goals (irrespective of type) have the same basic structure. They are divided into four +basic parts. +Goal focus +The part of the Feko solution to be considered for optimisation. The Focus type is based on a +quantity computed by the Feko solver. It is uniquely identified based on the request Label. If the +solution request was defined in CADFEKO, select the request label from the drop-down list. If the +solution request was defined in EDITFEKO, enter the label of the request. +Focus processing steps +A number of conversion steps or mathematical operations to be carried out on the Focus before +the Goal is evaluated. Processing steps may be specific to the focus and goal type, while other +processing steps are generic to all focus and goal types. The number, order and type of processing +steps can be freely chosen by the user to provide flexibility in the goal definition. +Goal operator +The operator indicates the desired relationship between the focus and the objective. +Altair Feko 2022.3 +6 Optimisation in Feko +Goal objective +p.719 +The objective describes a state that the optimisation process should attempt to achieve. The +objective is predefined and assumes the same unit as the focus. +Weight +The weight modifies the contribution of the goal’s error relative to other errors at the same +tree level during the fitness evaluation. The error at each level is computed by multiplying the +evaluated error of each goal with the associated weighting factor and then summing all of the +weighted errors. The global error is the summation of the weighted errors at the highest level of +the tree. +Label +The label for each goal identifies the simulation results to be considered during the evaluation of +the goal. +6.8.2 Optimisation Goal Types +Select an optimisation goal consistent with the requested output. +Impedance Goal +Optimise the impedance or admittance of a voltage/current source, solved as part of the Feko model. +On the Request tab, in the Optimisation group, click the + Add Goal Function icon. From the drop +down list, select + Impedance goal. +Figure 531: The Create Impedance Optimisation Goal dialog. +The Focus source is identified based on the label of a voltage source or current source in CADFEKO. +The Focus source label is identified based on the or a card-defined source, for example, the A1, A2, +A3, AF and AN card in EDITFEKO. +Focus Types +The following focus types are available: +Input impedance/Input admittance +Both of these are complex quantities that represent the load characteristics (based on the +currents and voltages at the source points). As these focus types always consist of complex +values, the focus processing options require that there be at least one general processing step +indicating the selection of one of the complex components. +Reflection coefficient (S11) +The reflection coefficient is computed with respect to the Reference impedance. For the +impedance goal, the reflection coefficient is computed directly from the observed input +impedance. This value is then in effect the “active” reflection coefficient ( ) and may differ from +the S11 computed during an S-parameter calculation in a multi-port model. +Transmission coefficient +The transmission coefficient ( +) is considered with respect to the Reference impedance. +Altair Feko 2022.3 +6 Optimisation in Feko +VSWR +p.721 +The voltage standing wave ratio ( +) for the observed input impedance is considered +with respect to the Reference impedance. +Return losses +The return loss ( +Reference impedance. +Current +) for the observed input impedance is considered with respect to the +The current flowing through the segment on which the selected voltage source is located. In order +to use this optimisation goal, a port with a source or an A1 card must be applied to the segment +of interest. The source should be set to zero magnitude, and a suitable Source name (label) +entered. +Reference Impedance +The impedance to be used during the calculation of the relevant focus types can be specified here. The +impedance must be a single non-complex value and is local to each impedance goal (different reference +impedances may be used for different impedance goals in the same optimisation search). +Related reference +A1 Card +A2 Card +A3 Card +AF Card +AN Card +Near field Goal +Optimise the near fields that are solved as part of the Feko model. +On the Request tab, in the Optimisation group, click the + Add Goal Function icon. From the drop +down list, select + Near Field Goal. +Figure 532: The Create Near Field Optimisation Goal dialog. +The Focus source is identified based on the label of a Near fields request in CADFEKO or the Focus +source label of an FE card in EDITFEKO. +The following focus types can be optimised: +Electric field +The electric field part of the near field is considered. +Magnetic field +The magnetic field part of the near field is considered. +Electric flux density (normalised) +The Electric flux density (normalised) considers the electric field scaled by the relative +permittivity of the medium where the near field is calculated. These are normalised quantities, +with the electric flux densities scaled by the permittivity of free space. The normalisation prevents +the goal function from having values that are small enough for the optimiser to consider them to +be zero. +Magnetic flux density (normalised) +The Magnetic flux density (normalised) considers the magnetic field scaled by the relative +permeability of the medium where the near field is calculated. These are normalised quantities, +with the magnetic flux densities scaled by the permeability of free space. The normalisation +prevents the goal function from having values that are small enough for the optimiser to consider +them to be zero. +Note: If the focus type attempts to access a part of the near field output request that +was not requested (for example only electric fields requested but optimisation is for +magnetic fields) then an error will be returned during the evaluation of the goal in the first +optimisation iteration. +Coordinate System +The coordinate system in which the directional component of the near field is required must be selected. +The available coordinate systems are Cartesian, Cylindrical(X)/(Y)/(Z), Spherical and Conical. This +coordinate system selection defines the options available in the Directional component drop-down +list. +Note: The coordinate system chosen here differs from the coordinate system chosen as +part of the near field computation request. +The coordinate system choice in the near field goal is related to the near field component of interest, +while the coordinate system chosen in the near field output request dialog is related to the positioning +of the sample points for the near field calculation. This distinction makes it possible to consider the near +field component in any direction independently of the physical placement of the near field sampling +points. +Directional Component +The options available in the Directional component drop-down list depends on the choice of +Coordinate system, but are independent of the near field request sampling point positions. +Radial or X/Y/Z/Phi/Theta-directed +In the chosen Coordinate system, the field in any of the 3 coordinate directions may be +requested. Each individual component of the electric or magnetic near field is a complex quantity, +and the selection of a specific field component requires that there be at least one general +processing step which indicates the selection of one of the complex components. +Combined +In addition to the individual components in the coordinate directions, the Combined near field +value may be requested. This value is computed by combining all 3 directional components of the +field at each point as follows (shown for Cartesian components): +The choice of Coordinate system has no effect on the value of the Combined component. +The combined field is always a non-complex value (or an array of non-complex values) and it is +therefore not required that any further processing is performed. +(80) +Related reference +FE Card +Altair Feko 2022.3 +6 Optimisation in Feko +Far Field Goal +p.724 +Optimise the far fields that are solved as part of the Feko model. +On the Request tab, in the Optimisation group, click the + Add Goal Function icon. From the drop +down list, select + Far Field Source. +Figure 533: The Create Far Field Optimisation Goal dialog. +The Focus source is identified based on the label of a Far fields request in CADFEKO or the Focus +source label of an FF card in EDITFEKO. +The following focus types can be optimised: +E-field +The E-field focus type considers the radiated fields associated with a specific far field solution +request directly. The fields are considered according to the settings of the far field request. For +example if only the scattered fields from a single object are requested, then only these will be +taken into account in the goal evaluation. +Directivity, Gain and Realised gain +With this focus type, only the directivity, gain or realised gain of the model is considered. This +option can only be based on a far field request where the Calculate fields as specified option is +chosen and is independent of whether Directivity or Gain is selected in the far field request. +Altair Feko 2022.3 +6 Optimisation in Feko +Radar cross section (RCS): +p.725 +This focus type is only valid for far field solutions that have been computed with a plane wave +source. The RCS focus type delivers non-complex values (or an array of non-complex values) +representing the derived RCS according to the options set in the far field calculation +request. If no valid RCS information is found in the computation output, an error will be generated +during the goal evaluation. +Note: Fields that are requested in invalid directions (for example fields requested below an +infinite ground plane) are ignored during the Goal evaluation. If no valid far field results with +the correct request label are found in the solver output, an error will be generated during +the Goal evaluation phase of the first optimisation iteration. +Polarisation +The Polarisation option allows the specification of the far field component to be considered in the goal. +Total +For the E-field focus type, the Total option provides a magnitude combination of the - and - +components of the far field. The total field is calculated as: +(81) +This value is representative of the power in the far field. +For the Directivity, Gain and Realised gain focus types, the polarisation-independent quantities +are considered. This is the only Polarisation option for RCS. +Horizontal (Phi)/Vertical (Theta) +These options allow specific selection of the - and -directed components of the far field. For +the Directivity, Gain and Realised gain focus types, only the component of the field with the +selected polarisation is used in the calculation of the required quantity, delivering a non-complex +value (or array of non-complex values). +LHC/RHC +These options allow specific selection of the left-hand-circular and right-hand-circular components +of the far field . For the Directivity, Gain and Realised gain focus types, only the +component of the field with the selected polarisation is used in the calculation of the required +quantity, delivering a non-complex value (or array of non-complex values). +S/Z +These options allow specific selection of the S- or Z-polarised components of the far field . For the Directivity, Gain and Realised gain focus types, only the component of the +field with the selected polarisation is used in the calculation of the required quantity, delivering a +non-complex value (or array of non-complex values). +Axial ratio +This option is only available for the E-field focus type. This provides the ratio between the +magnitudes of the - and -directed field components . +For the purposes of optimisation, an additional sign is added to the Axial ratio value considered +by the optimiser. The sign indicates the handedness of the radiated field, with a negative sign +implying left-handedness, and a positive sign implying right-handedness. This makes provision for +the inclusion of the required handedness directly in the Axial ratio optimisation. +Ludwig III (Co and Cross) +These options allow specific selection of the Ludwig III (Co) and Ludwig III (Cross) polarised +components of the far field . +Related reference +FF Card +S-Parameter Goal +Optimise the S-parameters that are solved as part of the Feko model. +On the Request tab, in the Optimisation group, click the + Add Goal Function icon. From the drop +down list, select + S-Matrix Goal. +Figure 534: The Create S-Parameter Optimisation Goal dialog. +The Focus source is identified based on the label of a Multiport S-parameter request in CADFEKO or +the Focus source label of an SP card in EDITFEKO. +Altair Feko 2022.3 +6 Optimisation in Feko +Quantity +Coupling coefficient (Smn) +p.727 +Only the coupling between different ports will be considered in the optimisation (all S-parameter +values where the port indices are not equal). +Note: If Snm and Smn are computed in an S-parameter request, then both of these +values will be considered in the goal evaluation. If the coupling in one direction is +required, the relevant port should be deactivated in the S-parameter calculation +request (CADFEKO) or the source set to zero magnitude (EDITFEKO). +Reflection coefficient (Snn) +Only the reflection at the port(s) will be considered in the optimisation. The reflection coefficient +at all ports that are active for the S-parameter computation will be considered. +Return loss +The return loss at the port(s) will be considered in the optimisation. Return loss is calculated from +the reflection coefficient at each active port as: +(82) +Transmission coefficient +The transmission coefficient at the port(s) will be considered in the optimisation. The transmission +coefficient is calculated from: +(83) +VSWR +The voltage standing wave ratio at the port(s) will be considered in the optimisation. Return loss +is calculated from the reflection coefficient at each active port as: +(84) +Port Selection +Specify input port number (n) +By default all of the active ports will be considered during the goal evaluation. When activated, +this option allows the selection of a single port to be used as the input port. For example, if all of +the S-parameters in a 3-port device are computed and the Focus quantity is chosen as Coupling +coefficient (Smn), then if the input port is specified as 2, only the values of S12 and S32 will be +considered during the goal evaluation. +Specify output port number (m): +In a similar manner to the input port selection option, when this option is selected it allows the +selection of a single port to be used as the output port. For example, if all of the S-parameters in +a 3-port are computed and the Focus quantity is chosen as Coupling coefficient (Smn), then +by specifying the output port as 2, only the values of S21 and S23 will be considered during the +goal evaluation. +Altair Feko 2022.3 +6 Optimisation in Feko +Related reference +SP Card +SAR Goal +p.728 +Optimise the SAR that are solved as part of the Feko model. +On the Request tab, in the Optimisation group, click the + Add Goal Function icon. From the +drop-down list, select + SAR Goal. +Figure 535: The Create SAR Optimisation Goal dialog. +The Focus source is identified based on the label of a SAR request in CADFEKO or the Focus source +label of an SA card in EDITFEKO. The SAR focus delivers a non-complex value (or an array of non- +complex values) based on the Feko solution. +Related reference +SA Card +Altair Feko 2022.3 +6 Optimisation in Feko +Power Goal +p.729 +Optimise the power that is solved as part of the Feko model. +On the Request tab, in the Optimisation group, click the + Add Goal Function icon. From the +drop-down list, select + Power Goal. +Figure 536: The Create Power Optimisation Goal dialog. +The Power goal allows optimisation of the total antenna efficiency, total power and power loss. The +power goal does not accept any request name since it operates on the total power in the model. +Receiving Antenna Goal +Optimise the receiving antenna that is solved as part of the Feko model. +On the Request tab, in the Optimisation group, click the + Add Goal Function icon. From the +drop-down list, select + Receiving Antenna Goal. +Figure 537: The Create Receiving Antenna Optimisation Goal dialog. +The Focus source is identified based on the label of a Receiving antenna request in CADFEKO or the +Focus source label of a RA card in EDITFEKO. +Related reference +RA Card +Transmission / Reflection Goal +Optimise the transmission and reflection quantities that are solved as part of the Feko model. +On the Request tab, in the Optimisation group, click the + Add Goal Function icon. From the drop +down list, select + Transmission / Reflection Goal. +Figure 538: The Create Transmission Reflection Optimisation Goal dialog. +The Focus source is identified based on the label of a Transmission/Reflection coefficient request +in CADFEKO or the Focus source label of a TR card in EDITFEKO. +Focus Type +Transmission +The transmission coefficient is calculated as +Reflection +The reflection coefficient is calculated as +Polarisation +Choose to optimise Co-polarisation or Cross-polarisation. +Related reference +TR Card +Proprietary Information of Altair Engineering +(85) +6.8.3 Focus Processing Options +Specify what operation should be performed on the selected goal. +The following processing steps are common to all goals. +No processing +Where the focus is non-complex, no processing steps are required. In order to consider the focus +directly, the No processing option is provided. +(87) +Real/Imaginary/Magnitude/Phase +Selects a specific component of a complex focus type. For an array, the complex component of +each array element is taken, delivering a non-complex array. +Unwrap +Unwraps a phase component. For a phase array, the whole array is considered in the unwrap +process. This operator is applied directly after selecting Phase. +Absolute value +Takes the absolute value. For an array, the absolute value of each element is taken. +(88) +(89) +(90) +Average/Minimum/Maximum +Finds the average, minimum or maximum value of an array. This has no effect on a single value. +Normalise +Normalises to the largest value in an array. For a single value, “1” will be returned. +(91) +(92) +Log +Offset +Takes the base-10 logarithm. For an array, the base-10 logarithm of each element of the array is +taken. This operator is only available for non-complex values or arrays. +(93) +Adds a specified non-complex value. For an array, the value is added to each element of the array. +This operator is only available for non-complex values or arrays. +(94) +Altair Feko 2022.3 +6 Optimisation in Feko +Scale +p.733 +Multiplies by a specified scale factor. For an array, each element of the array is multiplied by the +scaling factor. +Exponent +Applies an exponent. For an array of values, the exponent of each value in the array is taken. +(95) +(96) +Undefined +When a processing step is modified and the step becomes invalid, the processing step reverts to +an Undefined state. Delete or redefine all Undefined steps before applying the changes to the +goal. +6.8.4 Goal Operator +Specify how the focus is compared with the goal objective and the goal operator. +There are five operator types that are common to all goals. +Equal +Indicates that the processed focus should be equal to the object. +Greater than +Indicates that the processed focus should be greater than the objective. +Less than +Indicates that the processed focus should be less than the objective. +(97) +(98) +(99) +Maximise +Indicates that the processed focus should be maximised (no objective is required for this +operator). +Minimise +Indicates that the processed focus should be minimised (no objective is required for this +operator). +When a goal is evaluated, a single value error representation of the goal is extracted according to the +operator type. When the focus remains an array after the processing steps, an error is evaluated at +each point in the array, and the cumulative error is taken. For the comparative operator types (Equal, +Greater than and Less than), where the relationship between the focus and objective satisfies the +operator, the contribution to the error representation is zero. +6.8.5 Goal Objective +Choose between a single value or range of values defined by a mask to which the required output is +compared with. +Single Value Objective +This objective is defined in the Value text-box. The optimisation error (convergence accuracy) is +evaluated by comparing this value to the processed focus value according to the defined operator. +Where the focus remains an array after the processing steps are applied, the objective value is +compared to each of the array values separately, and the cumulative error is extracted according to the +operator type by a summation of all of the errors. +Mask Objective +A 2D mask may be predefined and used as the objective of an optimisation goal. This allows for the +comparison of an array of calculated data with a predefined array in the evaluation of the fitness of +the optimisation step. This type of objective is typically used when a quantity varies with position, +observation angle or frequency within one optimised simulation result. The length of the mask array is +not required to be the same length as the computed data array it is compared to. The optimiser uses +a piece-wise linear fitting on the mask array to determine the values for comparison with the correct +points (output points as calculated according to the solution setup). +6.9 Global Goal: Combining and Weighting of +Multiple Goals +Specify the method for combining multiple goals. A weight or importance factor is assigned to the +combined goal and optimised according to the combination type, for example, the average of the goals +combined for the specified data. +6.9.1 Combining Goals +Use the goal combination tool to extract a single error value from a set of goals. +On the Request tab, in the Optimisation group, click the + Combine Goals icon. +Figure 539: The Combine goal dialog. +The extraction type can be chosen as Maximum, Minimum or Average. When a set of goals are +combined using this tool, only the minimum, maximum or average value of all of the errors of all of the +goals in the set is taken. +In order to combine goals using the combination tool, goals in the same search in the same tree level +should be selected. The Combine goals dialog is launched in which the Combination +type is chosen. Goals are added to an existing combination by right-clicking on the combination in the +tree, and selecting the type of goal to add. Goals are removed from the combination by deleting them. +If all goals in a combination are deleted, then the combination is automatically removed. Goals can be +copied out of a combination to the root of the goals tree by opening the right-click context menu for the +particular goal and selecting Copy. +The Average, Minimum and Maximum options define how the evaluated errors of the goals in the +combination should be reduced to one error value. For example, if Average is chosen, then the average +error of the goals in the combination are returned, while Maximum returns the maximum error. Each +combination is assigned a weighting that indicates how the error should be combined with other goals +and combinations in the same level of the tree during the global fitness evaluation. The combination +tools may be nested to as many levels as required. +6.9.2 Goal Weighting +Specify a weighting for the combination of multiple goals. +This weighting is used to modify the contribution of the combination goals error to the global error +during the fitness evaluation. The global error in each level of the tree is computed by taking the +evaluated error of each goal, multiplying it by the indicated weighting factor, and then summing all of +the resultant weighted errors in each branch-level of the tree. +Note: The weighting of each goal is shown in brackets in the model tree. +6.10 Optimisation Using .PRE File modifications +Use optimisation with modifications made in the .pre file in EDITFEKO. +The optimiser operates on solution requests specified in CADFEKO. However, for advanced users, it is +possible to make use of the optimiser after making modifications to the .pre file in EDITFEKO. +The optimiser operates on the labels of the solution requests. These labels are usually created in +CADFEKO, but are copied to the .pre file. The optimiser reads the labels from the .pre file. +Consider the patch antenna on a finite substrate in Figure 540. +Figure 540: A patch antenna on a finite substrate fed with a voltage source on a wire port. +The antenna is fed with a voltage source on a wire port. Unless edited by the user, the voltage source +is created with a default label of VoltageSource1 in CADFEKO. When the CADFEKO model is saved, a +.pre file is created by CADFEKO. +To open the .pre file, run EDITFEKO from within CADFEKO. +In EDITFEKO the .pre file contains an A1 card with the label, “MyCustomVoltageSource1” (label +following after “**”), see Figure 541. +Figure 541: Screenshot of the A1 card (voltage source on a wire segment) in the .pre file. +New sources and output requests can be added to the .pre file. For each request that will be used for +optimisation, a unique label must be specified. After the .pre file is edited and saved, the optimisation +setup is completed in CADFEKO by manually entering the label of the parameter to be optimised in the +Focus source label text box in the Goal focus group. +Figure 542: A snippet of the impedance optimisation goal dialog using a custom label. +Related reference +A1 Card +6.11 Optimisation Solver Settings +Make adjustments to the optimisation settings for a more computationally efficient solution. +On the Solve/Run tab, in the Run/Launch group, click the + dialog launcher. +Figure 543: The Component Launch Options (Utilities tab) dialog. +Special options related to OPTFEKO are set on the Utilities tab, OPTFEKO group. These settings are as +follows: +Restart from solver run +This option may be used if a previous optimisation was interrupted. If this option is selected, then +OPTFEKO will attempt to restart the optimisation process from the iteration number provided in +the Restart analysis number text box. The optimisation can only be restarted if the temporary +files have been kept during a previous optimisation run, see Delete all files (except optimum) +below. If solution files are missing for a specific optimisation iteration, OPTFEKO runs the Feko +solver to recreate the missing files. If any changes have been made to the model, solution or +optimisation settings, OPTFEKO ignores all existing results, and re-compute all results as required. +Delete all files (except optimum) +If this option is selected, then all of the temporary files are deleted during the optimisation +process. When the optimisation process is completed (or if the optimisation process is +interrupted), the original model, as well as the optimum are available along with all related +simulation results. The optimum model and results are indicated by the addition of the string +(_optimum) at the end of the file names. If this option is unchecked then no model or result files +are deleted during the optimisation process. +Note: This option must be unselected in order to use the Restart from solver run +option (above). +Number of processes to farm out +This option allows the specification of the distributed computing system when farming out the +solutions during an optimisation. The Configure button launches the Machines configuration +dialog where the machines in the cluster as well as the number of processes to be launched on +each machine is specified. This dialog is identical to cluster configuration for parallel launching. +Feko Utilities +7 Feko Utilities +The Feko utilities consist of PREFEKO, OPTFEKO, ADAPTFEKO, the Launcher utility, Updater and the +crash reporter. +This chapter covers the following: +• 7.1 The Preprocessor PREFEKO (p. 741) +• 7.2 Running PREFEKO (p. 742) +• 7.3 The Solver (p. 743) +• 7.4 OPTFEKO (p. 754) +• 7.5 ADAPTFEKO (p. 770) +• 7.6 Environment Initialisation Script - initfeko (p. 772) +• 7.7 Launcher Utility (p. 773) +• 7.8 Updater (p. 775) +• 7.9 The Multiport Processor (p. 786) +• 7.10 Crash Report Utility (p. 789) +7.1 The Preprocessor PREFEKO +Use PREFEKO to perform meshing and to prepare the input files for the Feko solver. +The component PREFEKO performs three tasks: +1. PREFEKO creates the mesh for the Feko solver based on geometry input from the user. +2. PREFEKO imports meshed geometry, usually constructed in CADFEKO. +3. All the mesh and requested control and output requests specified by the user is integrated by +PREFEKO into the final Feko input file. +With regards to meshing PREFEKO subdivides surfaces into elementary surfaces (usually triangles) +while wires are subdivided into segments. The mesh size (density) is dependent on the wavelength and +medium parameters, which should be specified by the user. +This section describes the principal workings of the PREFEKO component. Assuming the user is +specifying the geometry in a .pre file (usually with EDITFEKO), the user first defines the location of +points in space with the DP card. Structures are then defined in terms of these points. For example, two +points may be joined to form a line (BL card), or four points for a parallelogram (BP card). +7.2 Running PREFEKO +Use PREFEKO with the correct syntax and optional parameters for advanced control. +PREFEKO creates a .fek file ready for solving by the Feko solver from a .pre input file. PREFEKO is +started using the following command: +prefeko example +where example is the .pre input file. +The component PREFEKO allows a number of options, which are mainly used for debugging purposes. +Entering PREFEKO without arguments will give an overview of the syntax and supported options. +The options available for PREFEKO are as follows: +--version +Print the version information and then exit. +--fek-format x +-#var=value +--ignore-errors +--print-variables +--print-variables-to-out +Write the .fek file in the xth file format. +Set a variable #var to the value value. +Treat error messages as non-fatal. PREFEKO will continue with +the processing after encountering errors. This can result in more +errors as a consequence of the first one, but it could also be +useful to see all geometry modelling errors at once, and not only +the first one. +Print a list of all variables (name, value, comment) to stdout. The +output also includes info whether the variable is set for the first +time or whether the value of an existing variable is changed. +Print a list of all variables (name, value, comment) to the Feko +output file (.out). The output also includes info whether the +variable is set for the first time or whether the value of an existing +variable is changed. +When defining variables from the command line, for example calling PREFEKO with +prefeko filename -#variable1=value1 -#variable2=value2 ... +it is recommended to use the !!print_to_out command to write these variables to the output file in +order to keep a record of their values. +Related concepts +!!print_to_out +Altair Feko 2022.3 +7 Feko Utilities +7.3 The Solver +p.743 +The Solver is the electromagnetic solver component that calculates the specified output requests. +7.3.1 Running the Sequential Version +Run the sequential version of Feko with optional parameters. +It is recommended to run the Feko kernel directly from the GUI components CADFEKO, EDITFEKO or +POSTFEKO. Once a session or model has been loaded, the sequential Feko solver can be started from +the Solve/Run tab, by selecting Feko (the shortcut key Alt+4 can also be used). +While the Feko kernel is running, the status of the calculation phases is indicated on the Executing +runfeko dialog, see Figure 544. The output generated by the Feko kernel is hidden by default. The +Feko kernel output may be viewed by clicking on the Details button and selecting the Output tab. +Similarly, notices, warnings and errors can be viewed by selecting the Notices, Warnings and Errors +tabs respectively. +Figure 544: The Executing runfeko dialogs. Output generated by the kernel is hidden by default. Solver output +may be viewed by clicking on the Details button. +When the Feko kernel is not executed from within the GUI, it can be started in a command window (on +a Windows PC) or a shell (in UNIX) by executing the command: +runfeko example08 +where example08 must be a valid Feko input file (either .cfx or .pre/.cfm or .fek etc., there are +internal time checks to run cadfeko_batch and/or PREFEKO as required to generate missing files or +replace older ones). +RUNFEKO accepts the optional parameters listed below. More information regarding additional options +for launching and controlling the parallel version of the solver can be found in Running the Parallel +Version. Additional options for the remote launching of Feko are found in Running on a Remote Host. +In CADFEKO these settings are available by selecting the Solve/Run tab and clicking on the dialog +launcher button on the Run/launch group. For POSTFEKO, select the Home tab and click on the dialog +launcher button on the Run/launch group. +--version +--priority x +Print the version information and then exit. +The value x specifies the CPU usage priority of the Feko run: +--use-gpu +0 = idle +1 = below normal +2 = normal +3 = above normal +4 = high. +If not specified, the default is 2. This option might not be available +for specific systems or for specific Feko versions. In this case it is +just ignored. +[NUM_GPUS][:GPU_1[,GPU_N]] Execute Feko using GPU +acceleration. The optional parameters are: +NUM_GPUS: The number of devices to use. +GPU_1 ,GPU_N: A comma separated list of specific devices to +use. If the option is specified without the optional parameters, all +available GPU resources are used. If NUM_GPUS is specified, the +first NUM_GPUS devices in the system will be selected. Specifying +--use-gpu 0 will completely disable GPU detection and prevent +NOTE 35179 from being printed. +Example usage is as follows: +--use-gpu 2:0,2 which uses the first (device 0) and third (device +2) GPU in the system. +This is equivalent to --use-gpu :0,2. +--remote-use-mpi +Activates the MPI method on Windows. +--execute-cadfeko_batch +Always execute CADFEKO_BATCH first (by-pass automatic checks +based on file existence and date stamps.) +--no--execute-cadfeko_batch +CADFEKO_BATCH will not be run to create a new .cfm and .pre +file. +--execute-prefeko +Always execute PREFEKO even if the existing .fek file is newer +than the .pre. +Altair Feko 2022.3 +7 Feko Utilities +--no--execute-prefeko +--use-job-scheduler +p.745 +PREFEKO will not be run to generate a new .fek file before the +Feko solver is launched, even if the .fek and/or .cfm files are +older than the existing .fek file. +Run the parallel Feko kernel within a queuing system and obtain +the number of parallel processes as well as the host list directly +from the respective job scheduler. +Note: +The Intel MPI library supports the following job +schedulers: +Microsoft Windows +• Altair PBS Professional +• Microsoft HPC Pack +Linux +• Altair PBS Professional +• Torque +• OpenPBS +• IBM Platform LSF +• Parallelnavi NQS +• SLURM +• Univa Grid Engine +-d +--prefeko-options +--feko-options +Debug mode with extra output (can be used to troubleshoot +errors). +All options following, up to the next –xxx-options, are passed to +PREFEKO. +All options following, up to the next –xxx-options, are passed to +Feko. +--adaptfeko-options +All options following, up to the next –xxx-options, are passed to +ADAPTFEKO. +The optional command line parameters for Feko (specified after --feko-options) are listed below. +--check-only +Feko processes and checks the model, but does not start a +solution. This is useful to, for example, check an input file on a +local computer before submitting it to a cluster. +--estimate-resource- +requirements-only +Feko processes the model and provides an estimate for the +memory consumption. The estimated value is provided at the end +of the .out file. +Note: An estimate is only available for: +• MoM +• MLFMM +• PO (not hybridised with any other solution +methods). +Tip: For a more accurate estimate, run the estimation +with the intended number of processes on the +intended host(s). +-e ENV=value +--data-export-format n +This has the same effect as starting Feko with the environment +variable ENV set to value. More than one -e … argument is +allowed. +Use the nth version format for the data export files (.efe, hfe, +.ffe, .os, .ol). Allowed values for n are 1 and 2 where 2 is the +latest version (since Feko 6.1). If not specified, the default is to +use the latest supported version. +--mtl-circuit-export +Special execution mode to export SPICE MTL circuit files. +Related concepts +How to Estimate Memory Requirements for the MLFMM +7.3.2 Running the Parallel Version +Run the parallel version of Feko with optional parameters for an efficient solution. +The parallel version of Feko may be used on any system that is licensed to run multiple Feko processes +concurrently. If a system has a multi-core CPU (for example a quad-core CPU) then a sequential Feko +licence will allow a parallel solution with up to 4 parallel processes to be launched. For systems with +multiple CPUs (for example, a system with 2 separate dual-core CPUs) a 2-CPU parallel Feko licence will +be required in order to run parallel solutions using all 4 of the available cores. +In order to use the parallel version of Feko from the GUI, it is required to configure the host names and +number of processes that will be used for each node. (This is initially be set up during installation of +Feko, meaning that reconfiguration is only necessary if changes are made.) +On the Solve/Run tab, in the Run/Launch group, click the + dialog launcher. +On the Feko Solver tab, under Parallel execution, click the Configure button. In the dialog , the host names and number of processes to be started on each host must be entered. +Usually one process per available core on each machine should be chosen, for example 4 processes for +a quad-core machine. It is also possible to use this option to implement a crude load balancing system: +running more processes on hosts with faster CPUs or more memory. Nodes may be added or removed +from the current cluster setup using the Add and Remove buttons respectively. +Figure 545: The Machines configuration dialog for the parallel host configuration. +Notice: For parallel Windows PC clusters, Feko must be installed at the same location on +each host. +It is recommended that the parallel job is started from a PC that forms part of the cluster and that this +host is listed first.[71] +After clicking OK the hosts are saved to a machines.feko file in the directory specified by the +environment variable FEKO_USER_HOME. This file is then used in the actual parallel process launching. +71. +It is possible to launch the job without including the local machine. The .fek input file must be +located on the first PC in the list and the .out and .bof output files are created on this PC in +the same directory as the project directory on the local machine. It is the user’s responsibility to +transfer the files between the local machine and the first machine in the list if these are not the +same. Alternately remote parallel launching can be used where Feko does this copying explicitly. +Figure 546: The Component launch options dialog. +On the Feko tab of the Component launch options dialog (shown in Figure 546), further settings with +regards to the Feko solution can be made. +Tip: Use the Output MFLOPS rate . . . and Network latency and bandwidth options to +ensure an optimum configuration for the nodes. +Feko will print a table giving the performance of the various nodes. These checks are repeated each +time Feko calculates the solution. +CAUTION: A significant amount of time may be required if the test file contains multiple +frequencies. These options should therefore not be kept selected after the initial setup, +except for debugging purposes. +The target priority of the Feko run may also be set on this tab. Setting the priority below normal will +allow other interactive work on the same computer. However, all machines in the cluster operate at +the speed of the slowest node - starting other CPU-intensive jobs on one of the nodes in a cluster is +generally not recommended. +In order to use parallel solving after it has been set up, do the following: On the Solve/Run tab, in +the Run/Launch group, click the + Parallel icon. A check mark will be displayed next to the menu +option. Any Feko solver runs that are launched while this option is checked will use the parallel version +of Feko. +From the command line (for example on a UNIX workstation), the parallel Feko version is started as +follows: +runfeko example1 -np x +where the parameter x following -np indicates the required number of processes to be used in the +parallel solution. In addition to the arguments listed in Running the Sequential Version, the parallel +version accepts the following optional parameters: +-np x +Start the parallel Feko version with x processes. The -np all +option is also supported when all available processors in the +machines file should be used. +--machines-file machname +The file machname is the machines file with the node names and +the number of CPUs . +--mpi-options ... +Unless another --xxx-options parameter is used, all options +following this are passed to the MPI launcher (for example mpirun +or mpiexec). +--parallel-authenticate + +Sets the authentication method to be used for parallel Feko runs. +The following authentication methods are available: +default: Platform dependent default (same as if option not +specified). +localonly: Run the parallel job on local host only and thus no +authentication is required +sspi: Windows Active Directory (SSPI) authentication is used. This +option is available on Windows only. +registry: Encrypt the credentials (username and password) into +the registry. This option is available on Windows only. +72. For more details refer to the Intel MPI and MPICH documentation in mpi\\\doc directory of the Feko installation. +73. Note that additional (one time) configuration settings might be required by the domain +administrator to prepare the Windows domain for this kind of authentication requests. +The number of processes to launch on each available host is specified in a machines file with the +following general syntax: +Hostname:Number of processes +For example assume that host1 has 4 processors and host2 has 8, then the machines file will be as +follows: +host1:4 +host2:8 +With this machines file, if 6 parallel processes are requested then Fekowill use 4 processes on host1 and +2 processes on host2. +If only one process is to be started on any host, then instead of the entry host3:1 in the machines file, +the shorter form host3 may be used. +The machines file (machines.feko) is located in %FEKO_HOME%\shared\mpi and is automatically created +during the installation of the parallel version of Feko. This file is the default machines file used by Feko. +If a different distribution of the processes is required, this file can be manually edited (however this +action is strongly discouraged). +Tip: Create a separate machines file with the syntax described above if a different number +of parallel processes are required than what was specified during the installation. +The environment variable FEKO_MACHFILE can be used to force RUNFEKO to use this file instead of the +default. The required commands assuming the desired machines file is, for example machname, are as +follows (for the sh shell): +FEKO_MACHFILE=./machname +export FEKO_MACHFILE +runfeko example1 -np 6 +Alternatively the name of the machines file can be passed as an argument to RUNFEKO on the +command line as follows: +runfeko example1 -np 6 --machines-file ../../machname +Using RUNFEKO is independent of the respective platforms and MPI implementations (the discussion +of the environment variable FEKO_WHICH_MPI contains more information). For certain applications or +experienced users it may be necessary to pass additional options to MPI73. These options are added +after the argument --mpi-options. For example on a ScaMPI cluster (assuming FEKO_WHICH_MPI=6), +the call +runfeko example_08 -np 6 --mpi-options -immediate_handling \ +threaded -smtrace 5-6 +(all on one line) is interpreted internally and Feko is executed with the command +/opt/scali/bin/mpimon -export env -immediate_handling threaded \ +-smtrace 5-6 /opt/feko/bin/feko.csv example_08 -- host1 4 \ +host2 2 +Note: host1 and host2 are examples only—the actual information is taken from the +machines file. +In addition to using the --mpi-options command line option, the MPI environment can be controlled +by setting certain environment variables. For instance, when using Intel MPI the environment variable +I_MPI_DEVICE[74] is quite important to control which device should be used (sockets or shared memory, +or RDMA device). Such environment variables is set up internally by means of Lua initialisation scripts. +See the Feko Installation Guide for more information. +Feko employs shared memory extensively for parallel runs. On Linux shared memory uses a bind mount +to the /dev/shm partition and its size is set to 50% of the physical memory by default. The exact size +can be queried using the df -h command. +If the shared memory size limit is exceeded during a parallel Feko solver run, it could lead to an error +message: +Bus error. +Tip: Adjust the shared memory size temporarily using the mount command, or permanently +by editing the /etc/fstab file. +7.3.3 Running on a Remote Host +Run Feko remotely with automatic file transfer between the local machine and host. +Remote launching allows for example the user to run the Feko GUI on a local Windows PC, but start +a sequential or parallel Feko job directly from one of the GUI components or a terminal on a remote +workstation or cluster. There are two main mechanisms for remote launching: The SSH/RSH based +method and the MPI based method. +The SSH/RSH method +This remote launching method is cross platform capable, for example, it is possible to launch a +remote job from a Windows PC on a UNIX workstation or vice-versa. In order to use the remote +launching facility, SSH must be available with public key authentication. +The MPI method +This method is currently only available between Windows hosts. It is based purely on Windows +commands and relies on a network share for copying files and uses the MPI daemon (as shipped +with Feko) for starting the remote process. Also for this method to work properly, the related +option must have been selected during installation of Feko on the remote machine. This consists +of creating a shared network directory. +For more information regarding the setup requirements for remote launching using either method, +please see the detailed installation and setup instructions in the Feko Installation Guide. +74. For more details refer to the Intel MPI and MPICH documentation in mpi\\\doc directory of the Feko installation. +Altair Feko 2022.3 +7 Feko Utilities +General settings and usage +p.752 +On Windows and Linux, this remote launching facility can be used directly from within the GUI +components, CADFEKO, EDITFEKO or POSTFEKO. As described for parallel launching, open the +Component launch options dialog.This dialog is shown in Figure 546. Enter the hostname or IP +address of the remote host in the Remote host input field under Remote execution and select the +appropriate Remote execution method. In order to use remote launching after it has been set up, do +the following: On the Solve/Run tab, in the Run/Launch group, click the + Remote icon. A check +mark will be displayed next to the menu option. Runs of the Feko solver (either sequential or parallel +if Parallel is also checked) will employ Remote Feko execution on the remote host while this option +remains checked. +In order to use the remote launching facility from the command line, the following command can be +used: +runfeko example1 --remote-host h +The parameter h following --remote-host gives the host name or the IP address of the remote host. +This will automatically use the SSH based remote launching method. +In order to use the MPI based method, the following command can be used: +runfeko example1 --remote-host h --remote-use-mpi +This command line option of RUNFEKO may be combined with other options, for example using the +following command: +runfeko example1 --remote-host h -np 4 --machines-file m +The above command would launch a parallel job with 4 processes using the nodes as listed in the +machines file m, and the parallel job is then launched from the remote host h (typically the control node +of a cluster). +As previously mentioned, the remote launching facility has an automatic file transfer feature included, +negating the requirement to work on a shared network drive. On the remote host, Feko will create a +temporary sub-directory in the user’s home directory with the name remote_FEKO_job_xxx (xxx is a +unique number) and all the Feko files will be placed there for the duration of the Feko solution. After +the completion of the remote execution, all files will be copied back to the client and this temporary +subdirectory on the remote machine will be removed. +Important notes regarding remote launching of parallel Feko jobs +• If a machines file is specified while launching the job locally, this will also be used on the remote +host (it will be copied to the remote host). In this way a parallel job can be configured on the +local client (on for example, two hosts node1 and node2) but the Feko solution can be launched +remotely on another computer - which will then be the control node of the parallel solution. This +makes sense when launching a parallel Feko job from a Windows PC on a Linux cluster. +• If no local machines file is specified when launching a remote solution it is important to note that +default options as set on the remote host will be used. Therefore Feko will read the machines.feko +file on the remote host, and not on the local host where jobs are launched. +In addition note that when launching a remote job from the GUI the machines file will always be +present, but not from the command line unless explicitly included in the command. If the machines +file is omitted the remote parallel hosts are then found using the default mechanism (from the +environment variable FEKO_MACHFILE, default location for the file machines.feko and so forth). +More information can be found in Running the Parallel Version). +Altair Feko 2022.3 +7 Feko Utilities +7.4 OPTFEKO +p.754 +OPTFEKO is the component that controls the optimisation process. The optimisation parameters are +usually associated with geometric dimensions, material properties, excitations and loadings. For +example, the gain of a horn antenna is maximised by varying the size of the horn aperture. +OPTFEKO requires two components for successful execution: +1. A parametric model that consists of at least a .pre file, or a .cfx file (or possibly both). +2. An .opt file that specifies how the model is optimised. +All options relating to optimisation are specified through the CADFEKO interface and is stored in the .opt +file. The parametric model is prepared using CADFEKO and or EDITFEKO. +Optimisation is based on, comprising a number of parts: +• Method to be used for the search (including method settings regarding accuracy and stopping +criteria). +• Parameters define the range in which the search will be performed. +• Goals specify the desired result of the optimisation process. +Note: Multiple Parameters and Goals may be defined as part of a single Search. The goals +are combined into a single representative function that is minimised or maximised. +7.4.1 Optimisation Methods +OPTFEKO provides various optimisation methods, each one with different characteristics. +Selecting the appropriate optimisation search method to apply to a given problem is not a trivial task. It +is a function of the number and range of the parameters, the required outcome of the optimisation, the +model size and the resources available. +Simplex (Nelder-Mead) +The Simplex Nelder-Mead Algorithm can be categorised as a local or hill-climbing search method, where +the final optimum relies strongly on the specified starting point. +The geometric figure formed by a set of N+1 points in an N-dimensional space is called a simplex. The +basic idea in the simplex method is to compare the values of the combined goals at the N +1 points +of a general simplex (where each point represents a single set of parameter values) and move the +simplex gradually toward the optimum point during an iterative process. The movement of the simplex +is achieved using three operations: reflection, contraction and expansion. +The initial simplex in a 2-dimensional search-space is represented by the points X1, X2 and X3. +Figure 547: Reflection, expansion and contraction for the Simplex method. +Reflection +Consider the diagram in Figure 547. If Xh is the point corresponding to the poorest fitness value +among the points of the initial simplex, it may be expected that the point Xr obtained by reflecting the +point Xh around the axis defined by the other points in the simplex (X1 and X2) may (when evaluated +according to the optimisation goals) provide a better fitness value. If this is the case, a new simplex +can be constructed by rejecting the point Xh from the simplex and including the new point Xr. This +process is illustrated in Figure 547 where the points X1, X2 and Xr form the new simplex. Since the +direction of movement of the simplex is always away from the worst result, movement will always be in +a favourable direction. If the global goal function does not have steep valleys within the space defined +by the parameter ranges, repetitive application of the reflection process will lead to a zigzag path in the +general direction of the optimum. +Expansion +If a reflection process finds a point Xr which is a better fitness than any point in the simplex (a new +optimum point), it may be expected that the best fitness value may be improved even further by +moving along the direction pointing from X0 to Xr. An expansion is therefore performed from Xr to Xe. +If the evaluated fitness at Xe is better than the fitness at Xr, the expansion was successful; Xh his then +replaced with Xe and the reflection process is restarted. If the evaluated fitness at Xe is poorer, the +expansion attempt has failed; Xh is replaced by Xr (as identified in the previous reflection operation) +and the reflection process is continued. +Contraction +If the reflection process finds a point Xr with a better fitness than the second-best point in the current +simplex (Xnh), a contraction operation will be performed. +If the contraction process produces a point Xc which has a better fitness than a point in the simplex, +the contraction was successful and Xh is replaced with Xc before continuing with the reflection process. +If the contraction process produces a point Xc which has a poorer fitness, the contraction process has +failed and the simplex base is reduced by scaling all the points in the simplex by an internal factor +before restarting with the reflection process. +Table 59: A summary of the Simplex operations. The F(X) operator represents the evaluation of the fitness at the +point X in the parameter space. +Objective Function +F(Xr) < F(Xl) +F(Xl) ≤ F(Xr) < F(Xnh) +F(Xnh) ≤ F(Xr) < F(Xh) +F(Xh) ≤ F(Xr) +Operation +Expansion +Reflection +Positive contraction +Negative contraction +Error treatment and termination +The Simplex Nelder-Mead terminates naturally when: +• The maximum number of Feko solver runs has been reached +• The standard deviation between the simplex vertices is small enough +• The simplex base is small enough +• The optimisation goal has been reached +Text log +During an optimisation, OPTFEKO maintains a text log of the optimisation process in the project .log +file. The structure of this file is primarily determined by the optimisation method. +Section 1: General information regarding the optimisation setup. +========================= L O G - FILE - OPTFEKO ========================= +Version: 13.22 of 2007-05-08 +Date: 2007-06-06 16:45:43 +File: test +OPTIMISATION WITH ALtair Feko +=============== Optimisation variables =============== +No. Name Beg.value Minimum + Maximum + 1 sigma 3.503500000e+07 1.000000000e+07 5.000000000e ++08 +=============== Optimisation goals =============== +No. Name Expression + 1 search1.goals.nearfieldgoal1 nearfieldgoal1 +Section 2: Information regarding the Simplex method parameters. +=============== Optimisation method: SIMPLEX NELDER-MEAD =============== +Maximum number of iterations: 1000 +Base of the simplex: 1.500000000e-01 +Reduction factor of the base: 5.000000000e-01 +Termination at minimal base: 1.000000000e-03 +Termination at standard deviation: 1.000000000e-04 +Standard reflection coefficient (R): 1.000000000e+00 +Contraction coefficient (-C, +C): 5.000000000e-01 +Expansion coefficient (E): 2.000000000e+00 +Section 3: Information regarding the parameter values, goal values and Simplex operations at each +iteration. +=============== SIMPLEX NELDER-MEAD: Intermediate results =============== + No. sigma nearfieldgoal1 global goal operation global best aim + 1 3.503500000e+07 6.488107157e-02 3.488107157e-02 ----- 3.488107157e-02 + 2 3.774988237e+07 5.929294284e-02 2.929294284e-02 ----- 2.929294284e-02 + 3 4.516707895e+07 6.328463622e-02 3.328463622e-02 ----- + 4 4.788196133e+07 5.795280540e-02 2.795280540e-02 R 2.795280540e-02 + 5 5.430544199e+07 5.500882669e-02 2.500882669e-02 E success 2.500882669e-02 + 6 4.153550651e+08 3.036429062e-02 3.642906239e-04 R 3.642906239e-04 + 7 4.356175335e+08 2.964433899e-02 3.556610122e-04 E success 3.556610122e-04 + 8 4.457496125e+08 2.929870383e-02 7.012961666e-04 R + 9 4.356179559e+08 2.964446921e-02 3.555307926e-04 +C success 3.555307926e-04 +Section 4: Information regarding the termination reason and optimisation results. If sufficient +information was available for a sensitivity analysis to be completed, the results of the sensitivity +analysis are also given. +=============== SIMPLEX NELDER-MEAD: Finished =============== +Optimisation finished (Standard deviation small enough: 5.020322005e-06) +Optimum found for these parameters: + sigma = 4.356179559e+08 +Optimum aim function value (at no. 9): 3.555307926e-04 +No. of the last analysis: 9 +Sensitivity of optimum value with respect to each optimisation parameter, +i.e. the gradient of the aim function at 1% variation from the optimum: +Parameter Sensitivity + sigma 8.344260771e-01 +Particle Swarm Optimisation (PSO) +Particle swarm optimisation (PSO) is a population-based stochastic evolutionary computation technique +based on the movement and intelligence of swarms. As a global search algorithm, the technique has, in +certain instances, outperform other methods of optimisation like genetic algorithms (GA). +PSO can be best understood through an analogy similar to the one that led to the development of the +PSO. Imagine a swarm of bees in a field. Their goal is to find in the field the location with the highest +density of flowers. Without any a priori knowledge of the field, the bees begin in random locations with +random velocities (direction and speed) looking for flowers. Each bee can remember the location at +which it found the most flowers, and is aware of the locations at which each of the other bees has found +an abundance of flowers. +Based on its own experience (local best, pbest) and the known best position (global best, gbest) found +so far, each bee in turn adjusts its trajectory (position and velocity) to fly somewhere between the two +points depending on whether nostalgia or social influence dominates its decision. When each bee is +done flying, it communicates its new-found information to the rest of the swarm who in turn adjust their +positions and velocities accordingly. +Along the way, a bee might find a place with a higher concentration of flowers than it had found +previously. It would then be attracted to this new location as well as the location of the most flowers +found by any bee in the whole swarm. Occasionally, one bee may fly over a place with more flowers +than have thus far been encountered by any bee in the swarm. The whole swarm would then be drawn +toward that location in addition to the location of own personal best discovery. In this way the bees +explore the field: overflying locations of greatest concentration, then being attracted back toward them. +Eventually, the bees’ flight leads them to the one place in the whole field with the highest concentration +of flowers. +Population size and number of iterations +The default swarm / population size is set to 20 and the number of iterations to 50, resulting in a +default maximum allowed number of Feko solver runs of 1000. While too small a swarm size prevents +the search algorithm from properly traversing the parameter space, larger swarm sizes require more +computational time. Compared to GA, the PSO technique tends to converge more quickly with smaller +population sizes. +When the maximum number of solver runs, (C), is specified by the user, this needs to be converted +into a population size (A) and number of iterations (B), with A*B ≤ C. A is selected as a function of +the number of parameters (Np), with an internal upper limit, while the requirement that B ≥ 5 must be +satisfied. +Error treatment and termination +PSO terminates naturally when: +• The maximum number of Feko solver runs has been reached +• The standard deviation between the best positions of the swarm is small enough +• The optimisation goal has been reached +Failure during re-evaluation and meshing (in the CADFEKO batch meshing tool or in PREFEKO) for a +specific set of parameters is treated by writing an appropriate error message to the .log file before +computing a new parameter set to replace the failed one. If too many consecutive parameter set +failures occur, then the optimisation will terminate with a message indicating this. The .log file for the +optimisation can be consulted for further information. +Due to the nature of the technique, the parameters naturally adhere to boundaries defined in the +parameter space. +The text log of the PSO method +During an optimisation, OPTFEKO maintains a text log of the optimisation process in the project .log +file. The structure of this file is primarily determined by the optimisation method. +Section 1: General information regarding the optimisation setup. +========================= L O G - FILE - OPTFEKO ========================= +Version: 13.22 of 2007-05-08 +Date: 2007-06-06 16:32:51 +File: test +OPTIMISATION WITH Feko +=============== Optimisation variables =============== +No. Name Beg.value Minimum + Maximum + 1 zf0 2.000000000e+00 1.000000000e+00 1.000000000e ++01 +=============== Optimisation goals =============== +No. Name Expression + 1 search1.goals.farfieldgoal1 farfieldgoal1 +Section 2: +=============== Optimisation method: PSO =============== +Maximum number of iterations: 3 +Population size: 1 +Acceleration constant 1: 2.800000000e+00 +Acceleration constant 2: 1.300000000e+00 +Termination at standard deviation: 1.000000000e-04 +Pseudorandom number generator seed: 1 +Section 3: +=============== PSO: Intermediate results =============== + No. zf0 search1.goals.f global goal local best aim global best + aim + 1 2.000000000e+00 2.267123373e-01 7.732876627e-01 7.732876627e-01 + 7.732876627e-01 + 2 2.000000000e+00 2.267123373e-01 7.732876627e-01 + 3 2.000000000e+00 2.267123373e-01 7.732876627e-01 +Section 4: +=============== PSO: Finished =============== +Optimisation finished (Maximum number of analyses reached: 3) +Optimum found for these parameters: + zf0 = 2.000000000e+00 +Optimum aim function value (at no. 1): 7.732876627e-01 +No. of the last analysis: 3 +Sensitivity of optimum value with respect to each optimisation parameter, +i.e. the gradient of the aim function at 1% variation from the optimum: +Parameter Sensitivity +zf0 8.344260771e-01 +Genetic Algorithm (GA) +Genetic algorithm (GA) optimisers are robust, stochastic search methods modelled on the Darvinian +principles and concepts of natural selection and evolution. Like the particle swarm optimisation (PSO) +method, GA’s are classified as global optimisers. Feko employs a real genetic algorithm (RGA). +GA optimisation borrows from the natural world in a number of ways. Conceptually, during a GA +optimisation, a set of trial solutions (a generation) is chosen. This generation is assigned the role of +“parents”, from which a new generation of “children” are derived. In an evolutionary “survival-of-the- +fittest process”, each consecutive generation moves toward an optimal solution under the selective +pressure of the fitness/goal function criteria. +Population size and number of iterations +As a default, the generation size for the GA method is set to 20 and the maximum number of iterations +to 50, resulting in a maximum allowed number of Feko solver runs of 1000. +If the user specifies the maximum number of solver runs (), this needs to be converted into a +generation size () and number of iterations (), with A*B ≥ C. A is selected as a function of the number +of parameters in the optimisation problem (Np), with an internal upper limit. It is also internally +required that B be chosen such that B ≥ 5. +Error treatment and termination +The GA algorithm terminates naturally when: +• The maximum number of Feko solver runs has been reached +• The standard deviation between the current generation chromosomes is small enough +• The optimisation goal has been reached +Failure during re-evaluation and meshing (in the CADFEKO batch meshing tool or in PREFEKO) for a +specific set of parameters is treated by writing an appropriate error message to the .log file before +computing a new random parameter set to replace the failed one. Due to the nature of the technique, +the parameters naturally adhere to boundaries defined in the parameter space. +The text log of the GA method +During an optimisation, OPTFEKO maintains a text log of the optimisation process in the project .log +file. The structure of this file is primarily determined by the optimisation method. +Section 1: General information regarding the optimisation setup. +========================= L O G - FILE - OPTFEKO ========================= +Version: 13.22 of 2007-05-08 +Date: 2007-06-06 16:32:51 +File: test +OPTIMISATION WITH Feko +=============== Optimisation variables =============== +No. Name Beg.value Minimum + Maximum + 1 zf0 2.000000000e+00 1.000000000e+00 1.000000000e ++01 +=============== Optimisation goals =============== +No. Name Expression + 1 search1.goals.farfieldgoal1 farfieldgoal1 +Section 2: Information regarding the GA method parameters. +=============== Optimisation method: RGA =============== +Maximum number of iterations: 3 +Population size: 1 +Creep mutation with probability: 5.000000000e-01 +Elitism, i.e. best individual replicated into next generation +Enforce niching +Uniform crossover with probability: 5.000000000e-01 +Termination at standard deviation: 1.000000000e-04 +Pseudorandom number generator seed: 1\ +Section 3: Information regarding the parameter values, goal values and GA aims at each iteration. +=============== RGA: Intermediate results =============== + No. zf0 search1.goals.f global goal global best aim + 1 2.000000000e+00 2.267123373e-01 7.732876627e-01 7.732876627e-01 + 2 1.357202892e+00 2.267123373e-01 7.732876627e-01 + 3 1.095988516e+00 2.267123373e-01 7.732876627e-01 +Section 4: Information regarding the termination reason and optimisation results. If sufficient +information was available for a sensitivity analysis to be completed, the results of the sensitivity +analysis are also given. +=============== RGA: Finished =============== +Optimisation finished (Maximum number of analyses reached: 3) +Optimum found for these parameters: + zf0 = 2.000000000e+00 +Optimum aim function value (at no. 1): 7.732876627e-01 +No. of the last analysis: 3 +Sensitivity of optimum value with respect to each optimisation parameter, +i.e. the gradient of the aim function at 1% variation from the optimum: +Parameter Sensitivity + zf0 8.344260771e-01 +Altair Feko 2022.3 +7 Feko Utilities +Grid Search +p.762 +The optimisation parameters are linearly varied between their minimum and the maximum values in a +predefined number of steps. +This method is strictly speaking not an optimisation method. This can be useful to investigate the +parameter space before beginning an optimisation. Due to the required computational time, it is +not generally recommended that this method be applied for problems containing more than two +parameters. +During application of the grid search method, optimisation goals are evaluated at each of the specified +grid points, and a fitness is assigned to each evaluation. Though this fitness has no effect on the +selection of the ensuing parameter set, an optimum result on the predefined grid will be identified and +the solutions at each of the grid points can be compared to evaluate their performance based on fitness. +Error treatment and termination +Failure during re-evaluation and meshing (in the CADFEKO batch meshing tool or in PREFEKO) for a +specific set of parameters is treated by writing an appropriate error message to the .log file before +continuing with the next set of parameters in the grid. +The grid search method terminates naturally only when the maximum number of Feko solver runs has +been reached. The number of solver runs can be computed based on the number of parameters and the +number of steps per parameter. +(100) +Internally, a limit of 10 000 is placed on the maximum number of allowed solver runs. For 4 parameters +this would mean a maximum of only 10 points per parameter (this indicates how quickly the algorithm +can scale in terms of the number of required solver runs for multi-parameter problems.) +The text log of the Grid search method +During an optimisation, OPTFEKO maintains a text log of the optimisation process in the project .log +file. The structure of this file is primarily determined by the optimisation method. +Section 1: General information regarding the optimisation setup. +========================= L O G - FILE - OPTFEKO ========================= +Version: 13.22 of 2007-05-08 +Date: 2007-06-06 16:32:51 +File: test +OPTIMISATION WITH Feko +=============== Optimisation variables =============== +No. Name Beg.value Minimum + Maximum + 1 zf0 2.000000000e+00 1.000000000e+00 1.000000000e ++01 +=============== Optimisation goals =============== +No. Name Expression + 1 search1.goals.farfieldgoal1 farfieldgoal1 +Section 2: Information regarding the grid search parameters. +=============== Optimisation method: GRID SEARCH =============== +No. Name Quantity Minimum Maximum + Step + 0 zf0 3 1.000000000e+00 1.000000000e+01 + 4.500000000e+00 +Section 3: Information regarding the parameter values and goal values at each step. +=============== GRID SEARCH: Intermediate results =============== + No. zf0 search1.goals.f global goal + 1 1.000000000e+00 2.267123373e-01 7.732876627e-01 + 2 5.500000000e+00 2.267123373e-01 7.732876627e-01 + 3 1.000000000e+01 2.267123373e-01 7.732876627e-01 +Section 4: Information regarding the termination reason and best results found on the search grid. +=============== GRID SEARCH: Finished =============== +Optimisation finished (Maximum number of analyses reached: 3) +Optimum found for these parameters: + zf0 = 1.000000000e+01 +Optimum aim function value (at no. 3): 7.732876627e-01 +No. of the last analysis: 3 +Adaptive Response Surface Method (ARSM) +The adaptive response surface method (ARSM) works by internally building response surfaces and +adaptively updating them as new evaluations become available. +The first response surface it builds is a linear regression polynomial, then it finds the optimum on this +surface and validates it with the exact simulation. If the response values from the response surface and +the exact simulation are not close; ARSM updates the surface with the new evaluation and finds the +optimum in this updated surface. ARSM repeats this loop until it meets one of the convergence criteria. +Error treatment and termination +The ARSM terminates when one of the following conditions is met: +• One of the convergence criteria is satisfied. +• The maximum number of allowable analyses is reached. +The text log of the ARSM method +Section 1: General information regarding the optimisation setup. +================ L O G - FILE - OPTFEKO ================ +Version: 14.0.430-24 of 2016-08-22 +Date: 2016-08-30 11:34:29 +File: dipole_arsm +OPTIMISATION WITH Feko +================= Optimisation variables ================= +No. Name Beg.value Minimum + Maximum + 1 h 2.000000000e+00 1.600000000e+00 2.400000000e ++00 + 2 radius 2.000000000e-03 5.000000000e-04 + 5.000000000e-03 +=================== Optimisation goals =================== +No. Name Expression + 1 arsm.goals.impedance_mag73ohm mag(inputimp(impedance(source))) +Section 2: Information regarding the ARSM parameters. +=== Optimisation method: ADAPTIVE RESPONSE SURFACE METHOD (HyperOpt) === +On failed analysis: Ignore failed analysis (=1) +Initial linear move: By DV initial (=1) +Maximum iterations: 22 +Response surface: SORS (=0) +Number of sample points: 3 +ARSM solver: SQP (=1) +Use SVD: No; terminate at soft convergence (=0) +ARSM algorithm version: A; normal (=0) +Absolute convergence: 1.0000000000e-04 +Constraint screening (%): 5.0000000000e+01 +Constraint violation tol. (%): 2.5000000000e-01 +Design variable convergence: 1.0000000000e-03 +Initial DV perturbation: 1.1000000000e+00 +Move limit fraction: 1.5000000000e-01 +Relative convergence (%): 5.0000000000e-01 +Minimal move factor: 1.0000000000e-01 +Constraint threshold 1.0000000000e-04 +Section 3: Information regarding the parameter values and goal values at each step. +=========== ADAPTIVE RESPONSE SURFACE METHOD (HyperOpt): Intermediate results + =========== + No. h radius arsm.goals.impe Global goal Global + best aim + 1 2.000000000e+00 2.000000000e-03 8.223708649e+01 9.237086490e+00 + 9.237086490e+00 + 2 2.330000000e+00 2.000000000e-03 2.584129574e+02 1.854129574e+02 +3 2.000000000e+00 2.495000000e-03 8.276434015e+01 9.764340145e+00 + 4 1.700000000e+00 1.550000000e-03 1.362858864e+02 6.328588642e+01 + 5 1.930006139e+00 1.550000000e-03 6.806363939e+01 4.936360614e+00 + 4.936360614e+00 + 6 1.927744177e+00 2.000000000e-03 6.805981842e+01 4.940181579e+00 + 7 1.931082122e+00 1.788235587e-03 6.821262088e+01 4.787379122e+00 + 4.787379122e+00 + 8 1.931204660e+00 1.791996361e-03 6.822294926e+01 4.777050742e+00 + 4.777050742e+00 + 9 1.931283820e+00 1.793912982e-03 6.822946010e+01 4.770539896e+00 + 4.770539896e+00 +Section 4: Information regarding the termination reason and best results found on the search grid. +================= ADAPTIVE RESPONSE SURFACE METHOD (HyperOpt): Finished + ================= +Optimisation finished (ARSM optimizer achieved convergence. Relative change in + objective function over +two last iterations is smaller than 0.500E-02 and max. constraint violation is below + permitted level.) +Optimum found for these parameters: + h = 1.931283820e+00 + radius = 1.793912982e-03 +Optimum aim function value (at no. 9): 4.770539896e+00 +No. of the last analysis: 9 +Global Response Surface Method (GRSM) +The global response surface method (GRSM) is a response surface based approach. During each +iteration, the response surface based optimisation generates a few designs. Additional designs are +generated globally to ensure a good balance on local search capability and global search capability. +Error treatment and termination +The response surface is adaptively updated with the newly generated designs to have a better fit of the +model. +The text log of the GRSM method +Section 1: General information regarding the optimisation setup. +================ L O G - FILE - OPTFEKO ================ +Version: 14.0.430-24 of 2016-08-22 +Date: 2016-08-30 11:36:21 +File: dipole_grsm +OPTIMISATION WITH Feko +================= Optimisation variables ================= +No. Name Beg.value Minimum + Maximum + 1 h 2.000000000e+00 1.600000000e+00 2.400000000e ++00 + 2 radius 2.000000000e-03 5.000000000e-04 + 5.000000000e-03 +=================== Optimisation goals =================== +No. Name Expression + 1 grsm.goals.impedance_mag73ohm mag(inputimp(impedance(source))) +Section 2: Information regarding the GRSM parameters. +=== Optimisation method: GLOBAL RESPONSE SURFACE METHOD (HyperOpt) === +On failed analysis: Ignore failed analysis (=1) +Maximum iterations: 50 +Random seed: 1 +Initial sample points: 4 +Points per iteration: 2 +Constraint violation tol. (%): 5.0000000000e-01 +Constraint threshold 1.0000000000e-04 +Section 3: Information regarding the parameter values and goal values at each step. +=========== GLOBAL RESPONSE SURFACE METHOD (HyperOpt): Intermediate results + =========== + No. h radius grsm.goals.impe Global goal Global + best aim + 1 2.000000000e+00 2.000000000e-03 8.223708649e+01 9.237086490e+00 + 9.237086490e+00 + 2 2.348800000e+00 4.964000000e-03 2.488655725e+02 1.758655725e+02 + 3 1.678080000e+00 4.942400000e-03 1.120701608e+02 3.907016075e+01 + 4 2.394880000e+00 9.464000000e-04 3.227940059e+02 2.497940059e+02 + 5 1.928320000e+00 2.401760000e-03 6.825584105e+01 4.744158945e+00 + 4.744158945e+00 + ... +Section 4: Information regarding the termination reason and best results found on the search grid. +================= GLOBAL RESPONSE SURFACE METHOD (HyperOpt): Finished + ================= +Optimisation finished (GRSM optimiser stopped. Number of analysis reached the maximum + allowed number of +50) +Optimum found for these parameters: + h = 1.957379988e+00 + radius = 3.243705368e-03 +Optimum aim function value (at no. 47): 4.087626847e-02 +No. of the last analysis: 50 +Altair Feko 2022.3 +7 Feko Utilities +7.4.2 Sensitivity Analysis +p.767 +OPTFEKO calculates upon termination of an optimisation, a sensitivity analysis of the goal function with +relation to each parameter. +The sensitivity analysis is calculated using the particle swarm optimisation (PSO), generic algorithm +(GA) or Simplex method, if sufficient information is available. The calculated sensitivity values are +indicated on the screen output, and stored in the text .log file. If no sensitivity analysis is performed, +the reason is indicated on the screen output, but no indication is written to the text .log file. +Figure 548: Sensitivity analysis of the goal function f with relation to the parameter x. +Figure 548 shows an example goal function f that varies as a function of the parameter x. The +sensitivity with relation to the parameter x can be described by the following equation: +with + equal to 1 +(101) +(102) +Solving the equation, however, gives a near zero value when the solution space is well converged. We +therefore rather compute the second derivative from which the sensitivity parameter can be computed +through integration +to finally give the sensitivity with relation to x as +(103) +(104) +A sensitivity analysis will only be performed if at least 2N +1 samples are available for a problem with +N parameters and these samples should all be within a 5% radius of the optimum. If the samples +under consideration are scattered outside of a 5% radius of the optimum, the stored data is considered +insufficient for proper sensitivity analysis. It should also be realised that as this computation makes use +of already computed samples only, the accuracy of the reported sensitivity number depends on how well +the algorithm has converged. +7.4.3 Farming +Farming out of the steps of an optimisation involves the concurrent solution of various optimisation +steps on a number of available processors or hosts. +Note: Farming not supported with the Simplex method. +When farming out the individual optimisation steps, the number of processes to start on each available +host is specified in the machines file. This machines file has a syntax identical to that used for parallel +runs. The basic syntax is: +Hostname:Number of processes +using a new line for each host. +During optimisation, new model files are continuously created by adding the string _opt_ and a +sequentially incremented number to the file name of each relevant component file of the parametric +model. +Example +Two hosts are available with names host1 and host2[75], with 4 and 8 processors respectively. +The machines file: +host1:4 +host2:8 +Launch an optimisation run with 12 processors for farming, results in the first 4 optimisation steps to be +launched on host1 and the next 8 steps to be launched on host2. +optfeko -np --machines-file +where: + +File name of the model + +Number of farming processes + +File name of the machines file +75. +this is the output of the UNIX command hostname) +Farming in Conjunction with Parallel Computing +Large problems may require that Feko be run in parallel (simulation spread over more than one host or +processor - not the same as farming.) +Example +Run the Solver in parallel, while farming out the optimisation steps using a specified number of +processes. For example: +optfeko -np --machines-file --runfeko-options -np +where: + +File name of the model + +Number of farming processes + +Number of parallel processes + +File name of the machines file +Note: For optimisation using the Solver in parallel, but not farming: +optfeko --runfeko-options -np --machines-file +7.4.4 Optimisation Output +Information on the optimisation process is stored in a .log file. +Note: Using the remote launching facility or farming out of optimisation steps, the actual +optimisation is done on the local machine, only the Solver runs (which are the time and +memory consuming part) are done on the remote machine(s). +The optimisation process may be interrupted at any time by clicking the Stop in the GUI process +information window, or Ctrl+C in a command line. If an optimisation is interrupted, all of the interim +files created during the optimisation will be kept, except if the Delete all files option was selected +when running from the GUI, or if the -r option was added when running from a command line. If the +files were kept, the optimisation can be restarted at a later stage using the –restart x option. +Altair Feko 2022.3 +7 Feko Utilities +7.5 ADAPTFEKO +p.770 +ADAPTFEKO is the adaptive frequency utility used to automatically select smaller frequency steps near +narrow resonances and larger steps where the results are relatively smooth. +For each frequency, ADAPTFEKO creates a .pre file and calls PREFEKO and the Solver. The file +names are derived from the original name plus _fr_n_ada_m where n and m are incremental +numerical values (for example, the new files associated with test.pre are test_fr1_ada_1.pre, +test_fr1_ada_2.pre, ...). +7.5.1 Command Line Arguments for Launching +ADAPTFEKO +ADAPTFEKO is started automatically by RUNFEKO if a continuous (interpolated) frequency range is +specified. +The syntax is: +runfeko filename +or +runfeko filename --adaptfeko-options [options] +where the optional argument options in the second line may be: +--version +Output only the version information to the command line and terminate. +--keep-files +All solution files (for example, .pre, .fek, .out) are preserved. +--restart x +Restart an adaptive frequency analysis using results for the frequency points 1...(x-1) obtained in +a previous run. (Then the previous run must have used –keepfiles.) +Related concepts +Setting a Continuous (Interpolated) Frequency Range +Related reference +FR Card +7.5.2 The PRE File for Adaptive Sampling +During solution, the variable #adaptfreq is defined automatically at the start of the single frequency +input files generated by the ADAPTFEKO utility. This variable may be used to allow for frequency-based +variation (for example, adaptive meshing). +You should not directly assign this name to a variable inside the .pre file or in CADFEKO as this will +overwrite the value specified by ADAPTFEKO. If this variable is needed (for example to run PREFEKO +during model setup when using adaptive meshing), the DEFINED function should be used in the .pre file, +for example: +** define a frequency variable if it is not already defined by an ADAPTFEKO run +!!if (not(defined(#adaptfreq))) then +#adaptfreq = 250.0E6 +!!endif +Note: Care must be taken when using adaptive meshing with ADAPTFEKO. Small +discontinuities may result from changes in the mesh can have a dramatic effect on the +convergence and accuracy of the adaptive sampled results. +7.6 Environment Initialisation Script - initfeko +The initfeko.bat (batch file on Windows) and initfeko (bash shell script on Unix / Linux) scripts +are executed from a terminal to configure the Feko environment. From this environment, the Feko +applications can be launched without using their full path. +The scripts are provided for convenience and it is not required to use them. All Feko applications can +be launched directly by using the full path to the application and the environment will be configured +correctly. +The command line parameters for initfeko are as follows: +-v +Verbose mode (prints some information output). +-d +-t +Shows additional debug output while setting the environment. +Timeout on error (default is to wait for user). +-terminal +Mode to setup a complete standalone Feko terminal.[76] +Note: View the Environment Settings Overview for more information on how to set up the +Feko environment using Lua commands and internal functions. +76. Note that -console is also supported +Altair Feko 2022.3 +7 Feko Utilities +7.7 Launcher Utility +p.773 +The Launcher utility is a single application that allows you quick access to the shortcuts for the Feko +components, WinProp components, newFASANT, WRAP components, documentation, Altair license +utility and updating parallel credentials. Pin the application to the taskbar for quick launching. +Figure 549: The Launcher utility allows quick access to Feko, WinProp, newFASANT, WRAP components, +documentation and utilities. +Note: When WRAP is installed in an existing Altair Feko installation, the WRAP components +are enabled on the Launcher utility. +7.7.1 Opening the Launcher Utility (Windows) +There are several options available to open the Launcher utility in Windows. +Open the Launcher utility using one of the following workflows: +• Open the Launcher utility from the Windows start menu: +1. On the desktop, click the Windows Start button. +2. Type Feko or WinProp. +3. Select Feko 2022.3 from the list of filtered options. +• Open the Launcher utility using the desktop shortcut (if you selected the option to install shortcuts +during installation). +7.7.2 Opening the Launcher Utility (Linux) +There are several options available to open the Launcher utility in Linux. +Open the Launcher utility using one of the following workflows: +• Open a command terminal. Use the absolute path to the location where the Launcher utility +executable resides (for example, /home/user/2022.3/altair/feko/bin/feko_launcher). +• Open a command terminal. Source the script “initfeko” using the absolute path to . /home/ +user/2022.3/altair/feko/bin/feko_launcher. Type feko_launcher and press Enter. +Note: Take note that sourcing a script requires a dot (".") followed by a space (" ") and +then the path to initfeko in order for the changes to be applied to the current shell +and not a sub-shell. +Altair Feko 2022.3 +7 Feko Utilities +7.8 Updater +p.775 +The feko_update_gui utility and the feko_update utility allows you the flexibility to install an update +containing features, minor software enhancements and bug fixes on top of an existing base installation +for Altair Feko (which includes Feko, newFASANT and WinProp). +7.8.1 Version Numbers +Each major release, upgrade or update is assigned a version number. A version number contains a +unique set of numbers assigned to a specific software release for identification purposes. You can +determine from the version number if its an initial release, update or upgrade. +The following terminology is used to define a version number: +Feko .. +for example: +Feko 2019.1.2 +2019 +Indicates the major release version. A major release is made available roughly once a year and +has a minor and patch version of “0”. +Note: +• The update utility does not support upgrades between major versions. +• A major release requires a new installer. +Indicates the minor release version and is referred to as an upgrade. Large feature enhancements +and bug fixes are included in the upgrade. Minor upgrades are released quarterly, for example “1” +indicates the first minor upgrade after the initial release. Use the update utility to upgrade to a +newer minor version (when available). +Indicates the patch version and is referred to as an update or “hot fix”. Minor feature +enhancements and bug fixes are included in the update. Patch updates are released between +minor upgrades, for example “2” indicates the second patch update after an upgrade. +Altair Feko 2022.3 +7 Feko Utilities +7.8.2 GUI Update Utility +p.776 +Use the feko_update_gui to check for new versions of the software and install an update using a +graphical user interface (GUI). +Click on Application menu > Check for updates to do a forced check for updates[77]. +When either CADFEKO, EDITFEKO or POSTFEKO is launched and the scheduled interval time has +elapsed, the update utility (GUI mode) automatically checks for updates. By default the schedule is set +to check for updates once a week. If updates are available, the update utility displays a notification alert +as well as giving you the option to select and install updates. +The GUI update utility can be started from the command line using: +feko_update_gui +Updates can be installed from a web repository[78] or a local repository. During an update a list +containing the latest software is retrieved and compared to installed components. +Note: No information is collected during an update. +Viewing the Installed Component Versions +View the version numbers of the installed Feko components. +1. Open the Updater using the Launcher utility. +2. On the Altair Feko update dialog, click the Installed versions tab. +3. View the Component, Version and Date information for the current installation. +77. A forced update can also be done from the application menu in CADFEKO, POSTFEKO and +EDITFEKO. +78. Requires internet access. +Figure 550: The Altair Feko update dialog - Installed versions tab. +4. Click the Update tab and click Close to exit the Altair Feko update dialog. +Updating or Upgrading to a New Version +Updating and upgrading refers to the process of installing a new version containing features, minor +software enhancements and bug fixes on top of an existing base installation. +1. Open the Updater using the Launcher utility. +2. On the Altair Feko update dialog, click the Update tab. +3. Click the Refresh button to view the available Feko versions for download. +4. Select a version to view the available components and their individual file size in the table. +Tip: Click Details to view the release notes in the message window. +Figure 551: The Altair Feko update dialog - Update tab. +5. Click Update to update or upgrade to the selected version. +a) Before an upgrade is started, you will be asked to confirm the upgrade from the current +version to the selected version. Click Continue with upgrade to allow the update/upgrade +process to proceed. +b) During the update process, click Details to expand the message window and view detailed +information regarding the update process. +6. When the update or upgrade is complete, click Close. +Updating From a Local Repository (GUI) +Update (or upgrade) from a local repository using the graphical user interface. +1. Open the Updater using the Launcher utility. +2. On the Altair Feko update dialog, click the Settings tab. +3. Under Update from, click Local repository to update from a local repository. +Figure 552: The Altair Feko update dialog - Settings tab. +4. Under Local repository, select one of the following: +• If the local repository contains extracted archives or multiple zipped archives, select Folder +(with extracted or zipped archives) and specify the folder. +The path for the local Feko update repository must be an absolute file path which can point to +an unmapped network share (Windows), mapped (mounted) network share or a directory on +a local drive. +Warning: Point the local repository path to the root folder of the updates. +Example: The Feko updates for the Windows and Linux platforms were extracted +and merged to C:\Updates. The path to the local repository points to C:\Updates. +C:\Updates + └─FEKO_2022.3.x + └─WIN64_X86_64 + └─LINUX_X86_64 +• If the local repository contains a single zipped archive, select File (zipped archive) and +specify the zip file. +5. Click Save to save the local repository settings. +6. Update or upgrade to a new version. +Troubleshooting: Error 16700: Unable to find the file 'XX/YY/manifest.xml.gz' +in the local repository. +Error 16700 indicates that the path to the local repository is incorrect. The path must point +to the root folder of the local update repository and the folders should not be modified. +Scheduling Automatic Updates +Schedule and configure an automatic Feko update. +1. Open the Updater using the Launcher utility. +2. On the Altair Feko update dialog, click the Settings tab. +Figure 553: The Altair Feko update dialog - Settings tab. +3. Select the Check for updates automatically check box to automatically check for updates. +Select one of the following options: +• every week +• every month +• every N days +4. Select the download location under Update from group box. +Altair Feko 2022.3 +7 Feko Utilities +Web +p.781 +The updates are downloaded from the web repository. +Local repository +This option is recommended when the computer network or cluster has no internet +access due to security reasons or only limited available bandwidth. The updates may be +downloaded from the Connect website by the system administrator and placed at a location +accessible for the computer network or cluster. +5. Optional: Specify the proxy server and authentication when the web is specified as the repository +under Proxy group box. +6. Click Save to save the new settings. +7.8.3 Command Line Update Utility +Use the feko_update utility for scripted updates or updates from a Feko terminal. +The command line update utility is called from the command line using: +feko_update +-h,--help +Displays the help message. +--version +Output only the version information to the command line and terminate. +UPGRADE_OPTION +Argument that allows a specific major patch version to be specified. This option is used to view +the Feko component changes for a specific major patch version, their respective download size +and the release notes. UPGRADE_OPTION can be any of the following: +1-9 +latest +Indicates the major patch version. +This option selects the largest valid major patch version that has a repository. +--check [UPGRADE_OPTION] [[USER:PASSWORD@]PROXY[:PORT]] +The update utility checks if new versions are available. If UPGRADE_OPTION was not specified and +new versions are available, it will list the version and its associated UPGRADE_OPTION value. For +example: +Update/upgrade options are available (UPGRADE_OPTION): +0: Minor update to version 2022.3.0.1 +If the computer is behind a proxy server, the proxy server address and the login details can be +supplied as required. +--check-from LOCATION [UPGRADE_OPTION] +The update utility checks if new versions are available. Here the update source is the local +repository specified by LOCATION. If UPGRADE_OPTION was not specified and new versions are +available, it will list the version and its associated UPGRADE_OPTION value. +--update [USER:PASSWORD@]PROXY[:PORT]] +The update utility checks if new versions are available within the current patch major version +from the web repository. If an update is available, download and install the new version. If the +computer is behind a proxy server, the proxy server address and the login details can be supplied +as required. If updates are available, the following information is printed to the screen: +• Print each file which is being downloaded (only available when the update does not contain +many files). +• Print each file which is being updated (only available when the update does not contain many +files). +• Print a message stating that the update was successful and exit. +--update-from LOCATION +The update utility checks if new versions are available within the current patch major version +and installs the new version. Here the update source is the local repository specified by +LOCATION. The path must be an absolute file path which can point to an unmapped network +share (Windows), mapped (mounted) network share or a directory on a local drive that can +contain either extracted archives, multiple zipped archives or a single zipped archive. +--upgrade UPGRADE_OPTION [[USER:PASSWORD@]PROXY[:PORT]] +The update utility checks if new patch major versions are available from the web repository. If an +upgrade is available, download and install the new version. +--upgrade-from LOCATION UPGRADE_OPTION +The update utility checks if new patch major versions are available from the web repository. If an +upgrade is available, it will download and install the new version. Here the update source is the +local repository specified by LOCATION. The path must be an absolute file path which can point +to an unmapped network share (Windows), mapped (mounted) network share or a directory on a +local drive that can contain either extracted archives, multiple zipped archives or a single zipped +archive. +--no-progress +Suppress the download progress when updating from a web repository. +--no-proxy +Suppress the use of a proxy (including the system proxy). +Updating From a Local Repository (Command Line) +Download a new software update (or upgrade) from a local repository using the command line utility. +1. Open a command terminal using the Launcher utility. +2. Download the latest version using one of the following workflows: +• To update (if an update is available) within the current minor version, type: +feko_update --update-from LOCATION +• To upgrade to a new minor version, type: +feko_update --upgrade-from LOCATION VERSION +where LOCATION is either an absolute file path which can point to an unmapped network share +(Windows), mapped (mounted) network share or a directory on a local drive that can contain +either extracted archives, multiple zipped archives or a single zipped archive. +The version is the minor version that you would like to upgrade to and would usually be 1, 2 or 3, +but it is possible to use latest to upgrade to the latest version. +The command line updater has many options to check for updates without updating or update to +the latest version. Use the following command to see a list of options: +feko_update --help +7.8.4 Proxy Settings Overview +The feko_update_gui utility and feko_update utility (GUI and command line) use the system proxy by +default, although it may be changed or the use of a proxy suppressed. +Windows +The proxy used is the same as is used by Internet Explorer. The proxy can be specified or by using a +proxy auto-config (PAC) file. +Linux +The system proxy is defined by the environment variable http_proxy. If the environment variable +http_proxy is not defined, then no proxy will be used. +Suppressing the Use of a Proxy +The parameter --no-proxy bypasses the system settings and use a direct connection. +Figure 554: The Altair Feko update dialog - Settings tab. +7.8.5 Creating a Local Update Repository +Create a local Feko update repository to allow users to update without internet access or to limit the +list of update versions that users can use. Local update repositories can also be used to reduce the +amount of data being downloaded by downloading a repository once and making it available to many +local machines or compute clusters. +A local repository folder can be set up using: +• downloaded and extracted archives +• downloaded, zipped archives +1. Create the local repository folder, for example, C:\Updates. +2. +If you already have an update repository for the same version, delete previous updates located in +this local repository folder. +3. Download the updates for the required platforms from Altair Connect. +For example, if both the Windows and Linux platforms are required, download the following: +• FEKO_2022.3_WIN64_X86_64.zip +• FEKO_2022.3_LINUX_X86_64.zip +4. Create the repository using one of the following workflows: +• Unzip the downloaded archives to the local repository folder. The zip file contains a folder +structure which must be kept intact. Below is an example of the directory structure for the +two platforms after extracting the zip archives to C:\Updates: +C:\Updates + └─FEKO_2022.3 + └─WIN64_X86_64 + └─LINUX_X86_64 +Note: If multiple platforms are downloaded, the platform updates must be +located at the same folder (grouped by version) and “merged” as seen in the +example. +• Copy the zipped archives to the local repository without extracting the files. +7.9 The Multiport Processor +The multiport processor allows you to calculate results for changes in the port excitations and loading +without rerunning the Solver. +Through the multiport combinations configuration (.mcc) file, define the new excitations and loading for +each port in the multiport data package (.mdp). Results supported are the scaled far fields and specific +port parameters, for example, the scaling coefficients, the voltage, current and impedance of each port. +7.9.1 Multiport Processor Workflow +The basic workflow using the multiport processor is described. +Generate data package .mdp file +using an S-parameter configuration. +Set up multiport combinations +configuration file using a text editor. +(A template is generated when +creating a data package.) +Call Multiport processor calculation +from the command line: +1. Extract S-parameters and field +data from the .mdp file. +2. Calculates new port parameters +and field data. +Generates a multiport combinations +result (.mcr) file that contains the +scaled field results and new port +parameters. +Figure 555: Basic workflow for the multiport processor calculator. +1. Generate a multiport data package using an S-parameter configuration. A template .mcc file is +generated with creating a multiport data package .mdp file. +2. Set up the multiport combinations configuration file using a text editor[79]. +3. Launch a calculation using the command line arguments[80]. +Note: The .mcr file is a HDF5 file. +4. Process the results using other Altair tools, for example, Altair Compose to read the results from +the .mcr file. +79. See Multiport Combinations Configuration (.MCC) +80. See Using the Multiport Processor Calculator +7.9.2 Command Line Arguments for the Multiport +Processor +The multiport processor is called via the command line to do a multiport calculation or to archive and +extract data from a multiport data package .mdp file. +Using the Multiport Processor Calculator +Use the following command line parameters to launch the multiport processor as a calculator: +multiport_processor filename [OPTIONS] +FILENAME +The name of the multiport combinations configuration .mcc file. +OPTIONS +--version +Output only the version information to the command line and terminate. +--scale-factors-only +Only compute the scale-factor coefficients and terminate. +Note: No scaling of quantities are performed, for example, far fields. +--combination name +Only process the results for a specified combination in the .mcc file. +--quantities [quantity_1{,quantity_i}] +Specify the quantities that should be processed by the computed scale-factor coefficients. + can be one of the following: +• FarFields +Note: If no quantities are specified, then all quantities are processed. +--resultsfile fname +Specify the name of the multiport combinations result .mcr file. +Using the Multiport Processing Archiver +Use the following command line parameters to use the multiport processor as a archiver: +multiport_processor [OPTIONS] +OPTIONS +--create-package fname +Create a multiport data package .mdp file and terminate. +Altair Feko 2022.3 +7 Feko Utilities +fname +p.788 +The name of the multiport data manifest .mdm file which lists all the files to be added +to the archive. +--expand-package fname [dirname] +Expand a multiport data package .mdp file and then terminate. +fname +Name of the multiport data package .mdp file. +dirname +The destination directory where to expand the files from the .mdp file. +7.10 Crash Report Utility +In the event of a crash occurring in CADFEKO, POSTFEKO or EDITFEKO, the crash report utility +generates a crash report. +The crash report gives you the option to provide the Altair Feko development team with details +regarding the location where the crash occurred. This information is not always enough to identify +and correct the problem. Providing a model and the steps that reproduce the crash is more useful to +determine and correct the problem. +Important: +• To send a crash report to the Altair Feko development team is voluntary. +• No model files are attached without your consent. +Related tasks +Sending a Crash Report While Connected to the Internet +Exporting a Crash Report When Not Connected to the Internet +7.10.1 Sending a Crash Report While Connected to the +Internet +You have the option to send the crash report to the Altair Feko development team with a description +of the steps leading up to the crash. Crash reports can help the development team locate and correct +problems faster. +In the event of a crash occurring in CADFEKO, POSTFEKO or EDITFEKO, the crash report utility +generates a crash report. +Figure 556: The POSTFEKO has crashed unexpectedly dialog. +1. Select one of the following options: +• To attach the model files and any related files to the crash report, click Attach model files +before sending. +• If you are working on a confidential model and do not want to send the model files, click +Send report without model. +• If you do not want to generate a report nor attach model files, click Do not generate +report, and the crash report utility will exit. +The POSTFEKO has stopped working dialog is displayed while the details regarding the location +where the crash occurred are collected. +Figure 557: The POSTFEKO has stopped working dialog. +When the crash report is generated, the Error Report dialog is displayed. +Figure 558: The Error Report dialog. +Note: The file size of the report is indicated at the top of the dialog. +2. +3. +[Optional] Click What does this report contain? to view the list of files in the crash report. +[Optional] In the Your E-mail field, enter your email if you would like feedback when the crash +has been resolved. +4. +5. +[Optional] In the Describe in a few words... field, give a description of the steps that you +followed at the time of the crash to help the Altair Feko development team resolve the issue. +[Optional] Select the Restart after this window is closed check box to restart the software +after the window is closed. +6. Close the crash report utility by selecting one of the following workflows: +• To send the report immediately and close the dialog, click Send report. +• The report is sent by e-mail using a built-in SMTP client. If the network that the +computer is on does not allow this, an attempt will be made to send the report using the +default e-mail client installed on the computer. +• To close the dialog and send the report later, click Other actions > Close the program and +send report later. +• To close the dialog and not send the report, click Other actions > Close the program. +This option should be used when the computer is temporarily disconnected from the internet. +Note: Refer to the Privacy policy[81] for more information regarding how we use the +information obtained from the crash report. +7.10.2 Exporting a Crash Report When Not Connected to +the Internet +A crash report can be exported to a .zip file and emailed to Altair Technical Support. Use this workflow +when the machine where the crash occurred is not connected to the internet. +In the event of a crash occurring in CADFEKO, POSTFEKO or EDITFEKO, the crash report utility +generates a crash report. +Figure 559: The POSTFEKO has crashed unexpectedly dialog. +1. Select one of the following options: +81. https://www.altair.com/privacy-shield/ +• To attach the model files and any related files to the crash report, click Attach model files +before sending. +• If you are working on a confidential model and do not want to send the model files, click +Send report without model. +The POSTFEKO has stopped working dialog is displayed while the details regarding the location +where the crash occurred are collected. +Figure 560: The POSTFEKO has stopped working dialog. +When the crash report is generated, the Error Report dialog is displayed. +Figure 561: The Error Report dialog. +Note: The file size of the report is indicated at the top of the dialog. +2. On the Error Report dialog, click What does this report contain to view the files contained in +the crash report. +The Error Report Details dialog is displayed. +Figure 562: The Error report details dialog. +3. On the Error report details dialog, view the list of files and export to a .zip file. +a) To view the data contained in a file, delete a file or add more files, click the file and from the +right-click context menu, select the relevant option. +b) Click Export to export the files listed on the Error Report Details dialog to a .zip file. +Browse to the desired file location and specify a file name. +c) Click Close to close the Error Report Details dialog. +4. On the Error Report dialog, click Other actions > Close the program. +5. Copy the exported .zip file to a machine that is connected to the internet and email the file to +Altair Technical Support. +Note: Refer to the Privacy policy[82] for more information regarding how we use the +information obtained from the crash report. +Related reference +Technical Support +82. https://www.altair.com/privacy-shield/ +Altair Feko 2022.3 +7 Feko Utilities +7.11 QUEUEFEKO +p.794 +QUEUEFEKO is a graphical user interface (GUI) application that can create a package which you can +transport to a remote queuing system. Created packages can be extracted once the simulation on the +queuing system has been completed. +7.11.1 QUEUEFEKO Overview +The QUEUEFEKO graphical interface is used on the local machine to create the package that is then +transferred to the compute cluster. On the compute cluster, use the queuefeko script to add a package +to an execution queue. +These packages are placed by the queuefeko script (called queuefeko) in an execution queue (such as +PBS) and executed when time and other resources become available. All information required to run +Feko on the cluster is included in the package. The package is extracted on the remote machine and +repackaged once the simulation is complete. Results can be viewed by copying the correct package back +from the cluster and extracting the contents. +Note: The queuefeko script is not a queuing system. The script handles the task of +extracting, adding the job to the queue and packaging the results. A compatible queuing +system must be set up separately. +QUEUEFEKO +QUEUEFEKO[83] is a graphical interface that allows users to create and extract packages. Use +QUEUEFEKO on the local machine to configure the resource requirements and create a package +for simulation and afterwards, to extract the package. +queuefeko script +The queuefeko script is a console application (editable script) that adds a package to an execution +queue and takes care of all the management tasks required for the successful execution of +the simulation. The queuefeko script runs on the remote cluster and oversees the simulation +described in the package. Modifications to the script may be required to accommodate difference +queueing systems. +83. The name of the binary is queuefeko_gui. +Local machine +Cluster machine + Create Altair Feko + model +QUEUEFEKO + Create +configuration file +Create package +Transfer *.pkg to + remote cluster +QUEUEFEKO script +Extract package + Place model in +execution queue +Run Altair Feko + simulation + View simulation + results + Extract package +Package results +Transfer *.output.pkg +to user's local machine +Figure 563: Remote execution scenario highlighting the role of QUEUEFEKO. +7.11.2 Creating and Extracting Packages +The steps for creating and extracting a package for remote execution, are explained. +1. Create a new configuration file (or edit an existing configuration file). +2. Set the configuration options. +3. Generate the package. +4. Add the package to the execution queue. +5. Extract the package containing the simulation results. +Package Configuration Files +A package configuration file is not the package itself but includes the settings to create a package. The +file can be reused to create packages with similar settings. +QUEUEFEKO provides access to all the settings required to control the simulation and the queueing +process. Once all the settings have been configured, package creation is as simple as choosing a name +for the package. +Creating a Package Configuration File +Specify the settings to control the simulation and queueing process. +1. Launch QUEUEFEKO. +Figure 564: The component, QUEUEFEKO. +2. Click File > New configuration. +Figure 565: The New package configuration dialog. +3. +4. +In the Base file field, select the base .pre file or .cfx file. +In the Launch component field, select one of the following: +• To run the Solver, select Solver. +• To do an optimisation, select OPTFEKO. +5. +6. +7. +In the Number of parallel processes field, enter the number of parallel processes allocated on +the local machine. +In the Maximum RAM per process field, enter the maximum number of allowed RAM to be used +on the cluster machine. +In the Maximum wall clock time field, enter the maximum allocated time to run the simulation +on the cluster machine. +8. Click OK to close the dialog. +Adding Additional Files to the Package +The .pre file is read to determine the required files to perform the simulation. Files that form part of +the Feko project (but not required for the simulation) can be added manually. +To add files to a package, create or open a package configuration file. +1. Click Package > File list. +2. Select one of the following options: +• To replace the base file that was specified in the package configuration file, select + Replace base file. +• To add additional files to the package configuration file, select + Add file(s). +• To remove a file from the package configuration file, click the Package files tab and select +the file that you want to remove. Click Package > File list > + Remove file. +Figure 566: QUEUEFEKO is showing the list of files included in the package. +Specifying the Solver Options +For the remote cluster, you can specify the Solver options used. +1. Click the Solver tab. +2. +In the Launch component field, select one of the following: +• To run the Solver, select Solver. +• To do an optimisation, select OPTFEKO. +1. Click the OPTFEKO tab. +2. Select the Restart analysis number check box if the run was discontinued and the +temporary files are present. The solution can be restarted at the number of the first +interrupted model. +3. Select the Delete temporary files check box to delete the temporary files once +optimisation is complete. +Note: The optimum model and solution files are not considered as +temporary files and are not deleted. +4. +In the Number of processes to be farmed out field, specify the number of processes +allocated to farming. +5. +In the Advanced field, you can specify additional command line parameters. +3. +In the Number of parallel processes, enter the number of parallel processes that will be used +on the local machine. +4. +In the Advanced field, specify additional command line parameters. +Figure 567: The Solver component dialog. +Specifying the Cluster Options +For the remote cluster, you can specify the specific job queue that is to be used and set up email +notifications when the job starts or completes. +1. Under Batch options, specify the following: +a) In the Maximum RAM per process field, enter the maximum number of RAM allocated on +the cluster machine. +b) In the Maximum wallclock time field, enter the maximum allocated time to simulate on +the cluster machine. +c) [Optional] In the Queue field, specify the job queue. +2. +[Optional] Under Notifications, specify the following: +a) To receive email notifications when the job starts and completes, select the Send job status +information check box. +b) In the Email address field, specify the email address for the notifications. +c) Under Notifications events, select one or more of the following options: +• Start +• Abort +• End +Figure 568: The Cluster component dialog. +Generating a Package +Create the package that is to be added to the execution queue. +1. Click Package > + Generate package. +2. On the Generate package file dialog, enter the destination path of the newly created package. +A package is created with a .pkg extension. +Adding the Package to the Execution Queue +Transfer the package to the remote cluster where it is placed in an execution queue. +If you are using the CrunchYard website, you can upload the package to the website and mark the +package for execution. For other clusters, copy the file and manually add it to the PBS queue. +Add the package to the cluster machine using the command: +queuefeko mypackage.pkg +Simulation of the model in the package will commence as specified in the package configuration file. +Extracting the Package +After the simulation has completed, a new output package (.output.pkg) is available for download +from the remote cluster machine to the local machine. Extract the package using QUEUEFEKO. +1. +Click Package > + Extract package. +2. On the Extract package file dialog, browse to the location of the package file. +3. On the Extract package to dialog, browse to the location where the contents of the package +should be extracted to. +The package is extracted. The directory contents as it was on the remote machine is made +available on the local machine. +View Results +Results obtained from the remote cluster machine can be viewed in POSTFEKO on a local machine as if +the simulation was run locally. +7.11.3 Setting Preferences +Specify the PDF viewer used when opening the Feko documentation. +1. Click Options > Preferences. +Figure 569: The Preferences dialog. +2. Under PDF viewer, browse to the PDF viewer of choice. +3. Click OK to close the dialog. +Description of the Output File +of Feko +8 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. +This chapter covers the following: +• 8.1 Geometric Data (p. 802) +• 8.2 Excitation (p. 809) +• 8.3 Currents and Charges (p. 813) +• 8.4 Finite Conductivity (p. 815) +• 8.5 Near Fields and SAR (p. 816) +• 8.6 Far Fields and Receiving Antennas (p. 818) +• 8.7 S-parameters (p. 824) +Altair Feko 2022.3 +8 Description of the Output File of Feko +8.1 Geometric Data +p.802 +Geometric data consist of mesh data for triangles, segments, connections between triangles and +segments, dielectric cuboids as well tetrahedra for the FEM and VEP methods. +Note: Geometric data is given in the .out file if it has been requested in CADFEKO or in the +EG card. +8.1.1 Data For Triangles +Data for triangles consist of metallic triangles, edges, symmetry, dielectric triangles as well as advanced +information for corner and end points. +Metallic Triangles +For the metallic triangles the following extract is written: + DATA OF THE METALLIC TRIANGLES + no. label x1 in m y1 in m z1 in m edges + medium x2 in m y2 in m z2 in m + medium x3 in m y3 in m z3 in m + nx ny nz area in m*m + 1 0 0.0000E+00 0.0000E+00 0.0000E+00 1 + Free s 0.0000E+00 2.0000E-01 0.0000E+00 + Free s 3.3333E-02 0.0000E+00 0.0000E+00 + 0.0000E+00 0.0000E+00 -1.0000E+00 3.3333E-03 + 2 0 3.3333E-02 2.0000E-01 0.0000E+00 -1 2 3 + Free s 3.3333E-02 0.0000E+00 0.0000E+00 + Free s 0.0000E+00 2.0000E-01 0.0000E+00 + 0.0000E+00 0.0000E+00 -1.0000E+00 3.3333E-03 +The first column gives the number of the triangle. The second column gives the label followed by the +medium in which the triangle is situated. A 0 means that the triangle is in free space. The next three +columns are the X coordinate, Y coordinate and Z coordinate of the three corner points of the triangles. +In the first row of each triangle follows another list of the numbers of the edges of the adjacent +triangles. A positive sign indicates that the positive current direction is away from the triangle. A +negative sign indicates that the positive current direction is towards the triangle. The area of the +triangle is given below the edges in m2. +Metallic Triangle Edges +The data for the metallic triangle edges is given after the metallic triangles. Such an edge is generated +wherever two triangles have two common vertices. An additional line (or row) gives the components +(nx, ny, nz) of the normal vector of each triangle. + DATA OF THE METALLIC EDGES (with MoM) + triangle no. points of tr. information on symmetry + no. type length/m media KORP KORM POIP POIM yz xz xy status + 1 1 2.0276E-01 Free s -1 1 2 1 1 0 0 0 unknown + 2 1 2.0000E-01 Free s -1 2 3 3 3 0 0 0 unknown +3 1 3.3333E-02 Free s -1 2 7 2 2 0 0 0 unknown +Note: In the above table the spacing between columns was reduced to facilitate rendering +the rows as single lines of data. +Each edge is assigned a consecutive number, which appears in the first column. The second column +indicates the type of the edge. The third column gives the length of the edge and the fourth column +gives the medium in which the edge is found. On an edge there are exactly two triangles. The columns +KORP and KORM give the numbers of these two triangles and the positive current direction is from the +triangle KORP to the triangle KORM . The column POIP gives the number of the corner point of the +triangle KORP which is opposite to the edge. The same applies to the column POIM. +The next four columns contain information regarding the symmetry. The column yz gives the number +of the edge corresponding to the X=0 plane (YZ plane) of symmetry. A positive sign indicates that the +currents are symmetric and a negative sign indicates that the currents are anti-symmetric. If there is a +0 present in this column then a symmetric edge does not exist. The same applies to the next columns +xz and xy concerning the Y=0 plane and the Z=0 plane. +If the last column with the heading status displays unknown then the edge has an unknown status. +This means that the applicable coefficient of the current basis function cannot be determined from the +symmetry, but has to be determined form the solution of the matrix equation. If a 0 is displayed instead +then the coefficient of the current basis function is 0 due to electric or magnetic symmetry and does not +have to be determined. +If there is any other number in the status column then this number indicates another edge for which +the coefficient is equal to (positive sign in the status column) or the negative of (negative sign in the +status column) the coefficient of the current basis function. From symmetry the coefficient of the +current triangle does not have to be determined. +Dielectric Triangles +The data of the dielectric triangles (SEP method) is very similar to that of metallic triangles. + DATA OF THE DIELECTRIC TRIANGLES + no. label x1 in m y1 in m z1 in m edges + medium x2 in m y2 in m z2 in m + medium x3 in m y3 in m z3 in m + nx ny nz area in m*m + 1 0 7.1978E-01 0.0000E+00 7.1978E-01 1 2 3 + 1 9.4044E-01 0.0000E+00 3.8954E-01 + Free s 8.6886E-01 3.5989E-01 3.8954E-01 + 8.2033E-01 1.6317E-01 5.4812E-01 7.2441E-02 + 2 0 9.4044E-01 0.0000E+00 3.8954E-01 4 5 6 + 1 1.0179E+00 0.0000E+00 0.0000E+00 + Free s 9.4044E-01 3.8954E-01 0.0000E+00 + 9.6264E-01 1.9148E-01 1.9148E-01 7.8817E-02 +Dielectric Edges +For the dielectric edges the extract is as follows: + DATA OF THE DIELECTRIC EDGES (with MoM) + triangle no. points of tr. electr. info on symmetry ... + no. type length/m media KORP KORM POIP POIM yz xz xy status ... +1 3 3.6694E-01 Free s 1 1 3 1 3 40 75 141 unknown ... + 2 3 5.1069E-01 Free s 1 1 4 2 1 41 76 142 unknown ... + 3 3 3.9718E-01 Free s 1 1 45 3 2 42 -3 143 0 ... + magnet. info on symmetry + yz xz xy status + 40 75 141 unknown + 41 76 142 unknown + 42 -3 143 unknown +Note: In the above table the spacing between columns was reduced to facilitate convenient +rendering of line breaks in the rows of data. +The symmetry information is shown for the basis functions for both the equivalent electric and magnetic +current densities. +8.1.2 Data for Wire Segments +Data for wire segments consist of data for segments and data for nodes between segments. +Wire Segments +The data for the segments follow the data for the triangles. + DATA OF THE SEGMENTS + No. label x1 in m y1 in m z1 in m nodes + medium x2 in m y2 in m z2 in m length in m radius in m + 1 0 0.0000E+00 0.0000E+00 0.0000E+00 1 + Free s 0.0000E+00 0.0000E+00 1.4286E-01 1.4286E-01 2.0000E-02 + 2 0 0.0000E+00 0.0000E+00 1.4286E-01 -1 2 + Free s 0.0000E+00 0.0000E+00 2.8571E-01 1.4286E-01 2.0000E-02 + 3 0 0.0000E+00 0.0000E+00 2.8571E-01 -2 3 + Free s 0.0000E+00 0.0000E+00 4.2857E-01 1.4286E-01 2.0000E-02 +A consecutive number is assigned to each segment. +Note: This number assignment differs from the numbering from the CADFEKO .cfm file +generated by CADFEKO. +The label of the segment is given in the second column and below that the number of the medium in +which the segment is located. A zero 0 means free space (vacuum). The next columns provide the +coordinates of the start and end points. The numbers of the adjacent nodes are given next to the +start and the end point columns in the first row for the segments. A positive sign for the node number +indicates that the positive current direction is defined away from the segment and vice versa for the +negative number. The length of the segment appears in the second row, followed by the radius. +Nodes between Segments +The data of the nodes between the segments is given in a data table in the output file. +DATA OF THE NODES BETWEEN THE SEGMENTS + no. of segment points of segm. info of symmetry + No. ISEGP ISEGM KNOP KNOM yz xz xy status + 1 1 2 2 1 0 0 0 unknown + 2 2 3 2 1 0 0 0 unknown + 3 3 4 2 1 0 0 0 unknown +Note: In the above table the spacing between columns was reduced to facilitate rendering +the rows as single lines of data. +The first column gives the consecutive numbers of the nodes. Next the numbers ISEGP and ISEGM are +for the two connected segments indicating the direction of current flow: a positive current direction +is defined from the segment ISEGP to the segment ISEGM. The column KNOP indicates whether the +starting point (KNOP=1) of the segment ISEGP connects to the node or whether it is the end point +(KNOP=2). Similarly, the column KNOM indicates whether the starting point (KNOM=1) of the segment +ISEGM connects to the node or whether it is the end point (KNOM=2). The case ISEGM=0 and KNOM=0 +is for half basis function connections over a single wire segment only (typically applicable to wire +connections to PEC ground or to UTD faces and so forth). The following four columns contain the data +for the symmetry and are the same as for the metallic triangles. +8.1.3 Connections Between Triangles and Segments +Data for connections between triangles and segments are given for triangles and segments that share +connection points. +Note: The below data is only given if there are connections between triangles and +segments. + GEOMETRIC DATA OF CONNECTIONS SEGMENTS - TRIANGLES + Data of triang.data of segm. info of symmetry + no. DRENUM DREPOI SEGNUM SEGPOI angle yz xz xy status + 1 11 1 360.0000 0 0 0 unknown + 15 1 45.0000 + 33 1 45.0000 + 55 1 45.0000 +Each connection point is assigned a consecutive number which is given in the first column. The column +DRENUM gives the number of the triangle at the connection point, while the connecting vertex (1 +to 3) is listed in the column DREPOI. Likewise the column SEGNUM gives the connecting segment’s +number and the connecting end in the SEGPOI column. If the start point of the segment is connected, +SEGPOI=1, else the end point is connected and SEGPOI=2. The column angle gives the angle that is +formed by the triangle at the connection point (in degrees). The meaning of the symmetry information +in the last four columns is the same as that of the metallic triangles. +Altair Feko 2022.3 +8 Description of the Output File of Feko +8.1.4 Dielectric Cuboids +p.806 +Data for dielectric cuboids consist of the geometry information such as the medium, label and corner +points as well as the basis functions. +If dielectric volume elements (cuboids) are used, then the following data block is given in the output: + DATA OF THE DIELECTRIC CUBOIDS + No. x1 in m y1 in m z1 in m + label x2 in m y2 in m z2 in m + medium x3 in m y3 in m z3 in m + x4 in m y4 in m z4 in m + 1 0.0000E+00 0.0000E+00 0.0000E+00 + Cube 1.0000E-01 0.0000E+00 0.0000E+00 + wood 0.0000E+00 1.0000E-01 0.0000E+00 + 0.0000E+00 0.0000E+00 1.0000E-01 + 2 0.0000E+00 0.0000E+00 1.0000E-01 + Cube 1.0000E-01 0.0000E+00 1.0000E-01 + wood 0.0000E+00 1.0000E-01 1.0000E-01 + 0.0000E+00 0.0000E+00 2.0000E-01 + 3 0.0000E+00 0.0000E+00 2.0000E-01 + Cube 1.0000E-01 0.0000E+00 2.0000E-01 + wood 0.0000E+00 1.0000E-01 2.0000E-01 + 0.0000E+00 0.0000E+00 3.0000E-01 +Note: In the above data the cuboids are assigned the label “Cube” and the dielectric +medium with label “wood.” +Each cuboid is given a consecutive number. The x , y and z corner point coordinates are given in the +first three columns. The first row is the reference point. The second row is the corner point which gives +the direction of the first basis function (defined from the reference point). Similarly, the third and fourth +rows define the next two basis functions with respect to the reference point. +Each dielectric cuboid contains three basis functions, one in each coordinate direction. The data of these +basis functions are given in the following format: + DATA OF THE BASIS FUNCTIONS FOR DIELECTRIC CUBOIDS + Symmetry information + No. cuboidno. direc. yz xz xy status + 1 1 1 0 0 0 unknown + 2 2 1 0 0 0 unknown + 3 3 1 0 0 0 unknown + 4 4 1 0 0 0 unknown + 5 5 1 0 0 0 unknown +The first column gives the number of the basis function in consecutive numbers. The next column +indicates the number of the cuboid. The column direc. indicates the direction of the basis function in +the respective cuboid: the number 1 indicates that the basis function is defined from the reference +point to the second corner point. The last four columns contain information regarding the symmetry +properties of the cuboid where the structure and the meaning is the same as with the other basis +functions. +Altair Feko 2022.3 +8 Description of the Output File of Feko +8.1.5 Tetrahedra +p.807 +Data for tetrahedra solved with the FEM or VEP methods consist of the label, medium, coordinates and +solution method. +The data for the tetrahedral volume elements are printed in a table as follows: + DATA OF THE TETRAHEDRAL VOLUME ELEMENTS + no. label x1 in m y1 in m z1 in m nodes + medium x2 in m y2 in m z2 in m faces + type x3 in m y3 in m z3 in m edges + x4 in m y4 in m z4 in m volume in m*m*m + 1 DRA1 1.0000E+00 0.0000E+00 0.0000E+00 1 2 3 4 + air 2.0000E+00 0.0000E+00 0.0000E+00 1 2 3 4 + 0 2.0000E+00 1.0000E+00 0.0000E+00 1 2 3 4 5 6 + 2.0000E+00 0.0000E+00 7.5000E-01 1.2500E-01 + 2 DRA1 1.0000E+00 0.0000E+00 0.0000E+00 1 4 5 6 + air 2.0000E+00 0.0000E+00 7.5000E-01 5 6 7 8 + 0 1.0000E+00 0.0000E+00 7.5000E-01 3 7 8 9 10 11 + 1.0000E+00 1.0000E+00 7.5000E-01 1.2500E-01 + 3 DRA1 2.0000E+00 1.0000E+00 0.0000E+00 3 4 6 7 + air 2.0000E+00 0.0000E+00 7.5000E-01 9 10 11 12 + 0 1.0000E+00 1.0000E+00 7.5000E-01 6 12 13 10 14 15 + 2.0000E+00 1.0000E+00 7.5000E-01 1.2500E-01 +Note: In the above table the spacing between columns was reduced to facilitate rendering +the rows as single lines of data. +The consecutive numbers of the elements are given in the first column. Column two contains 3 entries +in the following order: +1. The label of the element. +2. The medium name of the element. +3. The type of tetrahedra. +The type of tetrahedra makes the distinction between the solution method and whether the element is a +dielectric and/or a magnetic element as follows: +Table 60: Types of Tetrahedral Volume Elements +Type +Description/Method +FEM element (dielectric and/or magnetic) +VEP dielectric element +VEP magnetic element +VEP dielectric and magnetic element +Metallic FEM element +Columns 3, 4 and 5 provide the X coordinate, Y coordinate and Z coordinate of the vertices of the +element. The numbers of each node, face and edge bounding the tetrahedral element follow in the last +columns. +8.1.6 Data for Memory Usage +The data for the memory usage shows the number of mesh elements and basis functions which can be +an indication of the memory usage. +In the table below it is also indicated how many basis functions have the status “unknown”, that is, how +many basis functions have to be determined by solving the matrix equation. + DATA FOR MEMORY USAGE + Number of metallic triangles: 0 max. triangles: MAXNDR = 176 + Number of dielectric triangles: 176 + Number of aperture triangles: 0 + Number of RL-GO triangles: 0 + Number of windscreen triangles: 0 + Number of FEM surface triangles: 0 + Number of modal port triangles: 0 + Number of metallic segments: 0 max. segments: MAXNSEG = 0 + Number of combined MoM/MTL segments: 0 + Number of dielectr./magnet. cuboids: 0 max. cuboids: MAXNQUA = 0 + Number of tetrahedra: 0 max. tetrahedra: MAXNTETRA = 0 + Number of edges in PO region: 0 max. edges: MAXPOKA = 0 + Number of wedges in PO region: 0 max. wedges: MAXPOKL = 0 + Number of Fock regions: 0 max. Fock regions: MAXFOGE = 0 + Number of polygonal surfaces: 0 max. surfaces: MAXPOLYF = 0 + max. corner pts.: MAXPOLYP = 0 + Number of UTD cylinders: 0 + Number of metallic edges (MoM): 0 unknown: 0 (electr.) max. edges: MAXNKA=264 + 0 unknown: 0 (magnet.) + Number of metallic edges (PO): 0 unknown: 0 (electr.) + unknown: 0 (magnet.) + Number of dielectric edges (MoM): 264 unknown: 66 (electr.) + 264 66 (magnet.) + Number of dielectric edges (PO): 0 unknown: 0 (electr.) + unknown: 0 (magnet.) + Number of aperture edges (MoM): 0 unknown: 0 (magnet.) + Number of edges FEM/MoM surface: 0 unknown: 0 (electr.) + 0 0 (magnet.) + Number of nodes between segments: 0 unknown: 0 max. nodes: MAXNKNO = 0 + Number of connection points: 0 unknown: 0 max. conn.: MAXNV = 0 + Number of dielectric cuboids: 0 unknown: 0 max. cuboids: MAXNQUA = 0 + Number of magnetic cuboids: 0 unknown: 0 + Number of dielectric faces (VEP): 0 unknown: 0 + Number of magnetic faces (VEP): 0 unknown: 0 + Number of basis funct. for MoM: 528 unknown: 132 max. basisf. MAXNZEILE = 528 + Number of basis funct. for PO: 0 unknown: 0 max. basisf. MAXNKAPO = 0 +Note: In the above table the spacing between characters and entries was reduced to +facilitate rendering the rows as single lines of data. +Altair Feko 2022.3 +8 Description of the Output File of Feko +8.2 Excitation +p.809 +Excitation data consist of voltage sources, plane waves, waveguide sources, equivalent sources and +Hertzian dipoles. +Voltage Sources on Segments +A voltage source on a segment generates the following data block: + EXCITATION BY VOLTAGE SOURCE AT A SEGMENT + Name: + Excitation index: 1 + Frequency in Hz: FREQ = 7.49481E+07 + Wavelength in m: LAMBDA = 4.00000E+00 + Open circuit voltage in V: |U0| = 1.00000E+00 + Phase in degrees: ARG(U0) = 0.00 + Attached to port: Segment port + Port at segment with label: 1 + Absolute number of segment: 11 + Radius of segment in m: 2.00000E-03 + Location of the port in m: x = 0.00000E+00, y = 0.00000E+00, z = 0.00000E+00 + Positive direction: x = 0.00000E+00, y = 0.00000E+00, z = 1.00000E+00 +Similar information is provided for other voltage sources (such as a voltage source on an edge port and +on a microstrip port and a voltage source connected to a general network). +Waveguide Ports and Waveguide Sources +Data for the port and the source are split into three blocks. The geometrical data for the port is given +first: + DATA FOR WAVEGUIDE PORTS + Waveguide port label: Port + Port type: Rectangular + Port dimensions + Width: 1.29600E-01 m + Height: 6.48000E-02 m + Port reference points in m: + Point S1: x = -2.37927E-01, y = -6.48000E-02, z = -3.24000E-02 + Point S2: x = -2.37927E-01, y = 6.48000E-02, z = -3.24000E-02 + Direction of propagation: x = 1.00000E+00, y = 0.00000E+00, z = 0.00000E+00 +Subsequently follows the data for the modes. + MODE EXPANSION DATA OF A WAVEGUIDE PORT + Waveguide port label: Port + Frequency: 1.64500E+09 Hz + Mode indices Cutoff freq. Transverse wave impedance Propagation factor Description + m n in Hz real part imag. part real part imag. part + TE 0 1 2.3132E+09 0.0000E+00 3.8105E+02 3.4085E+01 0.0000E+00 Evanescent + TE 0 2 4.6264E+09 0.0000E+00 1.4331E+02 9.0626E+01 0.0000E+00 Evanescent + TE 1 0 1.1566E+09 5.2979E+02 0.0000E+00 0.0000E+00 2.4515E+01 Propagating + TE 1 1 2.5862E+09 0.0000E+00 3.1053E+02 4.1826E+01 0.0000E+00 Evanescent + TE 1 2 4.7688E+09 0.0000E+00 1.3845E+02 9.3812E+01 0.0000E+00 Evanescent + TE 2 0 2.3132E+09 0.0000E+00 3.8105E+02 3.4085E+01 0.0000E+00 Evanescent + TE 2 1 3.2713E+09 0.0000E+00 2.1916E+02 5.9264E+01 0.0000E+00 Evanescent + TE 2 2 5.1725E+09 0.0000E+00 1.2637E+02 1.0277E+02 0.0000E+00 Evanescent +TM 1 1 2.5862E+09 0.0000E+00 4.5703E+02 4.1826E+01 0.0000E+00 Evanescent + TM 1 2 4.7688E+09 0.0000E+00 1.0251E+03 9.3812E+01 0.0000E+00 Evanescent + TM 2 1 3.2713E+09 0.0000E+00 6.4758E+02 5.9264E+01 0.0000E+00 Evanescent + TM 2 2 5.1725E+09 0.0000E+00 1.1230E+03 1.0277E+02 0.0000E+00 Evanescent +Lastly the data for the impressed waveguide mode is provided: + EXCITATION BY IMPRESSED WAVEGUIDE MODE + Name: + Excitation index: 1 + Frequency in Hz: FREQ = 1.64500E+09 + Wavelength in m: LAMBDA = 1.82245E-01 + Impressed mode: TE 1 0 + Amplitude in A/m: 1.00000E+00 * PWFAKTOR + Phase in degrees: 0.00 + Transmitted power in W: 1.13772E+00 * PWFAKTOR^2 + Attached to port label: Port +FEM Current Source +For a FEM excitation (impressed current source) the following information is provided: + EXCITATION BY IMPRESSED CURRENT ELEMENT (FEM) + Name: CurrentSource1 + Excitation index: 1 + Frequency in Hz: FREQ = 3.00000E+09 + Wavelength in m: LAMBDA = 6.54669E-02 + Amplitude in A: |I| = 1.00000E+00 + Phase in degrees: ARG(I) = 0.00 + Attached to port: FEM line port + Start point of the port in m: x = 0.00000E+00, y = 6.50000E-03, z = -1.00000E-03 + End point of the port in m: x = 0.00000E+00, y = 6.50000E-03, z = 0.00000E+00 + Port length in m: 1.00000E-03 +FEM Modal Source +The data for this source is split into two blocks of data. The mode expansion for the port is given first: + MODE EXPANSION DATA OF A MODAL PORT + FEM modal port: Port1 + Frequency: 3.00000E+09 Hz + Eigenvalues computed with ARPACK [Z] + Mode Propagation factor Description + counter real part imaginary part + 1 0.00000E+00 9.59751E+01 Propagating (fundamental mode) +Next follows the data for the source: + EXCITATION BY IMPRESSED MODAL PORT MODE + Name: FEMModalSource1 + Excitation index: 1 + Frequency in Hz: FREQ = 3.00000E+09 + Impressed mode: Fundamental + Amplitude in V/m: 1.00000E+00 + Phase in degrees: 0.00 + Transmitted power in W: 5.00000E-01 + Attached to port: Port1 +Altair Feko 2022.3 +8 Description of the Output File of Feko +Plane Wave Source +p.811 +If an incident plane wave is used then the output file has the following format: + EXCITATION BY INCIDENT PLANE ELECTROMAGNETIC WAVE + Name: + Excitation index: 1 + Frequency in Hz: FREQ = 1.49896E+07 + Wavelength in m: LAMBDA = 2.00000E+01 + Direction of incidence: THETA = -180.00 PHI = 0.00 + Polarisation: LINEAR + Axial ratio: V = 0.0000 + Polarisation angle: ETA = 0.00 + Direction of propag.: BETA0X = 0.00000E+00 + (unit vector) BETA0Y = 0.00000E+00 + BETA0Z = 1.00000E+00 + Wave number: BETA0 = ( 3.14159E-01 +j 0.00000E+00) + Phase reference point in m: x = 0.00000E+00, y = 0.00000E+00, z = 0.00000E+00 + Field strength in V/m: |E0X| = 1.00000E+00 ARG(E0X) = 0.00 + (Phase in degrees) |E0Y| = 0.00000E+00 ARG(E0Y) = 0.00 + |E0Z| = 0.00000E+00 ARG(E0Z) = 0.00 +The vector , whose components are given, is the vector which points in the direction of propagation. +The vector + represents the direction of the electric field. +Near Field Source +For an impressed near field (aperture) source, the following information is given: + EXCITATION BY NEAR FIELD SOURCE + Name: NearFieldSource1 + Aperture number: 1 + Frequency in Hz: FREQ = 1.64500E+09 + Wavelength in m: LAMBDA = 1.82245E-01 + Number of electric dipoles: 90 (of which 20 suppressed) + Number of magnetic dipoles: 90 (of which 32 suppressed) + Extent of the source: X = -5.83200E-02 ... 5.83200E-02 m + Y = -2.59200E-02 ... 2.59200E-02 m + Z = -2.56439E-01 ... -2.56439E-01 m +Note: No specific information regarding the magnitude and phase of the dipole elements +that make up the excitation is given in the output. +Impressed Radiation Pattern +Excitation by an impressed radiation pattern point source is shown in the output as follows: + EXCITATION BY A FAR FIELD POINT SOURCE + Name: RadiationPattern1 + Excitation index: 1 + Frequency in Hz: FREQ = 1.60000E+09 + Wavelength in m: LAMBDA = 1.87370E-01 + Max. field strength * dist. in V: 5.91419E+01 * PWFAKTOR + Radiated power in W: 1.12755E+00 * PWFAKTOR^2 + Directivity of the antenna in dB: 17.138 + Distance for far field cond. in m: 1.96442E+00 + Source position in m: x = 0.00000E+00, y = 0.00000E+00, z = 0.00000E+00 + Number of grid points NTHETA = 37 + NPHI = 73 +Angular range THETA in degrees: 0.00 ... 180.00 + PHI in degrees: 0.00 ... 360.00 +Note: No specific information regarding the magnitude and phase of the impressed pattern +that make up the excitation is given in the output. +Spherical Mode Source +For an impressed spherical mode source, the following information is written to the output: + EXCITATION BY AN IMPRESSED SPHERICAL MODE + Name: SphericalModesSource1 + Excitation index: 1 + Frequency in Hz: FREQ = 6.25000E+09 + Wavelength in m: LAMBDA = 4.79668E-02 + Source position in m: x = 0.00000E+00, y = 0.00000E+00, z = 2.54000E-01 + Rotation about the axes: X = -180.00 + Y = 48.46 + Z = 0.00 + Number of modes: 880 (of which 38 suppressed) + Propagation direction: C = 4 (outwards) + mode indices coefficient in sqrt(Watt) rad. power(Watt) + J S M N magn. phase power + 1 1 -1 1 2.54050E-05 -25.23 3.22706E-10 + 2 2 -1 1 4.50632E-05 1.04 1.01535E-09 + 3 1 0 1 5.41621E-07 40.48 1.46677E-13 +Hertzian Dipoles +Point source type (Hertzian dipole) excitations result in the following information output: + EXCITATION BY ELECTRIC DIPOLE + Name: ElectricPointSource1 + Excitation index: 1 + Frequency in Hz: FREQ = 3.00000E+08 + Wavelength in m: LAMBDA = 9.99308E-01 + Amplitude in Am: |IL| = 1.00000E+00 + Phase in degrees: ARG(IL) = 0.00 + Dipole position in m: x = 0.00000E+00, y = 0.00000E+00, z = 0.00000E+00 + Orientation of dipole: THETA = 0.00 + PHI = 0.00 +The above output is for an electric dipole. The magnetic dipole will have similar output. +8.3 Currents and Charges +Currents and charges data are supported for triangles and wire segments and can be requested from +CADFEKO or with the OS card. +Currents on Triangles +The currents and charges data for triangles are provided as follows: + VALUES OF THE CURRENT DENSITY VECTOR ON TRIANGLES in A/m (no averaging) +Triangle centre JX JY ... +number x/m y/m z/m magn. phase magn. phase ... + 1 1.11111E-01 1.11111E-01 0.00000E+00 1.099E-02 147.51 1.099E-02 147.51 ... + 2 1.01903E-01 8.28341E-01 0.00000E+00 1.955E-04 62.22 4.668E-03 121.95 ... + 3 1.99385E-01 6.49031E-01 0.00000E+00 2.036E-03 131.69 5.377E-03 128.94 ... + 4 9.40494E-02 1.16528E+00 0.00000E+00 1.019E-04 29.26 3.685E-03 109.98 ... + 5 8.89886E-02 1.49041E+00 0.00000E+00 8.437E-05 -33.65 2.744E-03 100.59 ... + JZ Current magnitude in the + magn. phase 3 corner points + 1.099E-02 147.51 1.495E-02 3.067E+00 1.495E-02 + 4.668E-03 121.95 4.520E-03 4.695E-03 4.842E-03 + 5.377E-03 128.94 5.591E-03 6.001E-03 5.709E-03 + 3.685E-03 109.98 3.697E-03 3.718E-03 3.660E-03 + 2.744E-03 100.59 2.768E-03 2.630E-03 2.850E-03 +The current density vector in the complex form is given at the position (X, Y, Z). The last three +columns indicate the value for the surface current density in the three vertices of the triangles. +Note: The value of the current written in the .out file will be affected if averaging of the +currents is de-activated in the OS card. If averaging is requested, the average of the current +at the vertices of all three adjacent triangles is shown. +Charges on Triangles +If the current is requested, the charge on each triangle is also written to the output file. Only the charge +is given as the position of each triangle is the same as written for the currents. + VALUES OF THE SURFACE CHARGE DENSITY ON TRIANGLES in As/m^2 +Triangle SIGMA +number magn. phase + 1 2.03115E-11 165.31 + 2 8.14289E-12 152.22 + 3 1.00211E-11 160.36 + 4 4.59629E-12 119.26 + 5 4.02388E-12 56.35 +Currents on Wire Segments +The current on the segments is written as follows: + VALUES OF THE CURRENT IN THE SEGMENTS in A +Segment centre IX IY IZ +number x/m y/m z/m magn. phase magn. phase magn. phase +1 0.000E+00 0.000E+00 1.66551E-01 0.00E+00 0.00 0.00E+00 0.00 1.837E-02 -31.39 +2 0.000E+00 0.000E+00 4.99654E-01 0.00E+00 0.00 0.00E+00 0.00 1.410E-02 -33.86 +3 0.000E+00 0.000E+00 8.32757E-01 0.00E+00 0.00 0.00E+00 0.00 5.366E-03 -35.06 +Note: In the above table the spacing between columns and the number of significant digits +were reduced to facilitate rendering the rows as single lines of data. +Charges on Wire Segments +If the currents on segments are requested, the charges are also written to the output file as follows: + VALUES OF THE LINE CHARGE DENSITY ON SEGMENTS in As/m +Segment Q +number magn. phase + 1 1.32488E-11 -90.69 + 2 4.30863E-11 -120.06 + 3 6.83730E-11 -125.06 +Currents and Associated Data for Voltage Sources +For every voltage source the current at the feed point is determined and therefore the impedance and +other related parameters as follows: + DATA OF THE VOLTAGE SOURCE NO. 1 + real part imag. part magnitude phase + Current in A 1.6718E-02 -9.5781E-03 1.9268E-02 -29.81 + Admitt. in A/V 1.6718E-02 -9.5781E-03 1.9268E-02 -29.81 + Impedance in Ohm 4.5034E+01 2.5800E+01 5.1901E+01 29.81 + Inductance in H 5.4750E-08 +8.4 Finite Conductivity +Finite conductivity data consists of the material parameters and associated data such as skin effect +penetration depth, conductor impedance as well as the power losses per label. +The block with the set of characteristics for the single labels is displayed first as follows: + DATA FOR LABELS + Label Cuboid1.Face3: + Metallic conductor (skin effect) + Surface thickness: 5.00000E-03 m + Sigma = 1.000E+02 S/m Mue_r = 1.000E+00 tan(delta_mue) = 0.000E+00 + Penetration depth of the skin effect: 5.81365E-03 m + Conductor impedance due to the skin effect: ( 2.098E+00 +j 9.799E-01) Ohm +After the calculation of the currents the losses that result from finite conductivity are displayed as +follows: + POWER LOSS METAL (in Watt) + Results for labels | in the segments | in the + Label | skineffect conc.load distr.load coating | triangles + Cuboid1.Face3 | 0.0000E+00 0.0000E+00 0.0000E+00 0.0000E+00 | 8.9357E-06 + Cuboid1.Face4 | 0.0000E+00 0.0000E+00 0.0000E+00 0.0000E+00 | 1.2433E-06 + Cuboid1.Face1 | 0.0000E+00 0.0000E+00 0.0000E+00 0.0000E+00 | 1.4940E-06 + Cuboid1.Face6 | 0.0000E+00 0.0000E+00 0.0000E+00 0.0000E+00 | 4.0082E-07 + Cuboid1.Face2 | 0.0000E+00 0.0000E+00 0.0000E+00 0.0000E+00 | 1.2433E-06 + Cuboid1.Face5 | 0.0000E+00 0.0000E+00 0.0000E+00 0.0000E+00 | 1.4940E-06 + Sum: | 0.0000E+00 0.0000E+00 0.0000E+00 0.0000E+00 | 1.4811E-05 + Total loss in segments: 0.0000E+00 W + Total loss in triangles: 1.4811E-05 W + Sum of losses in metallic elements: 1.4811E-05 W + SUMMARY OF LOSSES + Metallic elements: 1.4811E-05 W + Dielectric: 0.0000E+00 W + Mismatch at feed: 0.0000E+00 W + Non-radiating networks: 0.0000E+00 W + Cables: 0.0000E+00 W + Backward power at passive waveguide ports: 0.0000E+00 W + Backward power at passive modal ports: 0.0000E+00 W + ------------- + Sum of all losses: 1.4811E-05 W + Efficiency of the antenna: 99.7162 % + (based on a total active power: 5.2196E-03 W) +For the power losses, in the first column the label is displayed while the lowest row displays the sum of +the losses over all labels. +8.5 Near Fields and SAR +Near fields and SAR data consist of values for the electric and magnetic field strength as well as specific +absorbtion rate (SAR) data. +Electric Field Strength +The position as well as the individual components of the electric and the magnetic field strength are +given. Unless otherwise requested in the request, the total value of the field, that is the sum of the +incident wave and the scattered field, is given. + VALUES OF THE ELECTRIC FIELD STRENGTH in V/m + (total field, incident and scattered) + LOCATION EX EY ... +medium X/m Y/m Z/m magn. phase magn. phase ... + 0 -1.00000E-01 0.0000E+00 1.25600E-01 2.0790E+01 -136.15 1.5550E+02 3.60 ... + 0 -8.87711E-02 0.0000E+00 1.25600E-01 2.1755E+01 -144.07 1.6368E+02 -5.91 ... + 0 -7.75422E-02 0.0000E+00 1.25600E-01 2.2504E+01 -150.94 1.6937E+02 -14.44 ... + EZ + magn. phase + 1.46636E+02 -155.96 + 1.53094E+02 -165.59 + 1.57508E+02 -174.30 +Note: In the above table the spacing between columns was reduced to facilitate convenient +rendering of line breaks in the rows of data. +The magnetic field strength data will have very similar contents. +Electric Fields inside Dielectric Cuboids +If the electric fields inside dielectric cuboids are requested (Electric field and SAR values request in +the FE card) then the value for the SAR and the cuboid number are also given as follows: + VALUES OF THE ELECTRIC FIELD STRENGTH in V/m + inside the dielectric cuboids + LOCATION EX EY EZ SAR cuboid no. + X/m Y/m Z/m magn. phase magn. phase magn. phase in W/kg + 0.128 0.128 0.128 6.129E-01 -5.68 3.481E-04 -1.66 3.623E-02 87.60 0.0E+00 1 + 0.128 0.128 -0.128 6.127E-01 4.80 3.479E-04 -0.42 3.622E-02 91.27 0.0E+00 2 + 0.128 0.128 0.383 6.046E-01 -16.07 3.582E-04 16.84 3.651E-02 85.05 0.0E+00 3 + 0.128 0.128 -0.383 6.042E-01 15.19 3.594E-04 -18.87 3.648E-02 93.84 0.0E+00 4 + 0.128 0.128 0.637 5.851E-01 -26.50 2.032E-03 156.46 3.657E-02 79.21 0.0E+00 5 +Note: In the above table the spacing between columns and the number of significant digits +were reduced to facilitate convenient rendering of line breaks in the rows of data. +Altair Feko 2022.3 +8 Description of the Output File of Feko +SAR +p.817 +For specific SAR solution requests, the following output is shown (note that the extract shown below is +representative for a spatial peak SAR calculation. The output for other options like volume average SAR +calculations will differ.) + SPATIAL-PEAK SPECIFIC ABSORPTION RATE in W/kg + for 10.0 g tissue in the shape of a cube + Search includes entire domain + Maximum volume fraction of air allowed in a SAR averaging cube: 20.0 % + cube centre cube edge mass AR tissue content + x in m y in m z in m in m in g in W/kg in % + 1.0255E-01 3.3344E-02 1.0833E-02 2.1728E-02 9.9082E+00 2.82865E+00 93.07 + orientation unit vectors of the SAR cube + x in m y in m z in m + 5.98050E-01 1.03718E-01 -7.94719E-01 + 8.00460E-01 -2.78161E-02 5.98740E-01 + 3.99940E-02 -9.94218E-01 -9.96574E-02 +Note: In the above table the spacing between columns and the number of significant digits +were reduced to facilitate convenient rendering of the data. +8.6 Far Fields and Receiving Antennas +Far fields and receiving antennas data consist of the electric far field data, RCS, gain, directivity and +radiated power. +Far Fields and Polarisation Types +If the far field is calculated, the following block in this form is displayed: + VALUES OF THE SCATTERED ELECTRIC FIELD STRENGTH IN THE FAR FIELD in V + Factor e^(-j*Re{BETA}*R)/R not considered + LOCATION ETHETA EPHI directivity in dB ... + THETA PHI magn. phase magn. phase vert. horiz. total ... + 0.00 0.00 2.626E-16 -178.03 2.321E-16 22.06 -308.6129 -309.6881 -306.1070 ... + 2.00 0.00 7.271E-02 104.04 0.000E+00 0.00 -19.7678 -999.9999 -19.7678 ... + 4.00 0.00 1.449E-01 104.02 0.000E+00 0.00 -13.7772 -999.9999 -13.7772 ... + POLARISATION + axial r. angle direction + 0.1758 138.76 RIGHT + 0.0000 180.00 LINEAR + 0.0000 180.00 LINEAR + Gain is a factor of 1.00000E+00 ( 0.00 dB) larger than directivity + The directivity/gain is based on an active power of 8.35911E-03 W + and on a power loss of 0.00000E+00 W +Note: In the above table the spacing between columns and the number of significant digits +were reduced to facilitate convenient line breaks and rendering of the data. +For incident plane waves, the displayed values are the values of the scattered field, that is the incident +field is not taken into account. However, for any other sources (such as elementary Hertzian dipoles or +impressed radiation patterns), the fields radiated by the source are included. +In the far field a complex field strength + is defined using the relation +(105) +with a large distance +infinity). + which tends to infinity (and which in the Feko calculations is identical to +Note: The dimension of + is voltage due to this extra distance factor R. +In the .out file the (vertical) and (horizontal) components of +phase, that is + and +. + are tabulated by magnitude and +Using POSTFEKO results for other polarizations can be extracted. The corresponding formulas are as +follows: +S-polarisation: +Altair Feko 2022.3 +8 Description of the Output File of Feko +Z-polarisation: +left-hand circular polarisation: +right-hand circular polarisation: +p.819 +(106) +(107) +(108) +(109) +If a plane wave is included, the results will include the radar cross section. In the case of other sources +without a plane wave source, the gain or directivity is included. +Note: If a plane wave is combined with, for example, a voltage source, the active RCS is +obtained, but the gain/directivity will not be computed. +Radar Cross Section +For the radar cross section, the incident plane wave with complex amplitude + carries a power density +of +where ZF0 denotes the wave impedance of the surrounding medium. The incident wave gets scattered +on the object and a wave is reflected with the scattered power density +(110) +The radar cross section (RCS) is then defined as follows: +Proprietary Information of Altair Engineering +(111) +(112) +(114) +Gain and Directivity +For antenna and general radiation problems Feko computes either the gain or the directivity depending +far field request setting. +Note: The gain/directivity setting applies to the values tabulated in the .out file only. Any +quantity can be selected in POSTFEKO. +Assume that +a power of +defined as follows: + is the source power and + are losses in the structure (such as dielectric losses), then + will be radiated. The directivity (relative to an isotropic point source) is then +(115) +(116) +(117) +For the gain a similar definition is used, except that the source power +is acting as reference as follows: + and not the radiated power +(118) +(119) +(120) +(121) +Between gain and directivity the following relation holds: +where represents the antenna efficiency. +Altair Feko 2022.3 +8 Description of the Output File of Feko +Polarisation and Axial Ratio +p.821 +The last three columns of the far field output give the polarisation information of the scattered wave. In +general the polarisation is elliptical as shown in the figure. +Figure 570: Elliptic polarisation in the far field. +The coordinates are +, + and +, and the view is in the direction of the propagation of the wave ( +). +To evaluate these quantities, the magnitude and phase of the far field components are defined as +follows: +Using the abbreviation + the temporal field strength vector in space can be written as: +(122) +(123) +This equation describes the polarisation ellipse depicted in the figure. +The minimum and maximum values of the field strength magnitude can be found at following times: +and +Let + and + and assume that +, then according to the figure + and +. +The axial ratio (Minor/Major) is defined as +Proprietary Information of Altair Engineering +(124) +Altair Feko 2022.3 +8 Description of the Output File of Feko +The axial ratio (Major/Minor) is defined as +p.822 +(126) +(127) +A ratio (Minor/Major) of 0 means that the wave is a linearly polarised wave, but if the ratio (Minor/ +Major) has a value of 1 then it is a circularly polarised wave. The direction of rotation is right hand +circular (RHC) for + and left hand circular (LHC) for +. +Feko also computes and prints the polarisation angle . It is the angle between the major axis of the +polarisation ellipse and the unit vector + and can be computed using +(128) +Poynting Vector and Radiated Power +If the far field request is set to request 2 or more points for both the theta and phi directions, then the +Poynting vector is integrated over the specified sector . This +integration provides the radiated power and is given below the field values. +When analyzing an antenna the source power (calculated from the input impedance) should equal the +integral of the radiated power over the surface of a sphere minus any losses such as dielectric losses +and finite conductivity. +Tip: Use the power integration as a partial validation of the result. +It is also possible to set the far field request to only integrate the far field power without writing the +field values to the output file. +The output file will produce the following output (a full 3D far field request was set to generate the +below output): + VALUES OF THE SCATTERED ELECTRIC FIELD STRENGTH IN THE FAR FIELD in V + Factor e^(-j*Re{BETA}*R)/R not considered + Integration of the normal component of the Poynting vector in the angular + grid DTHETA = 5.00 deg. and DPHI = 5.00 deg. (2701 sample points) + angular range THETA angular range PHI radiated power + -2.50 .. 182.50 deg. -2.50 .. 362.50 deg. 8.19957E-03 Watt + 0.00 .. 180.00 deg. 0.00 .. 360.00 deg. 8.08720E-03 Watt + Polarisation dependent radiated power: + horizontal polarisation: 4.81599E-09 Watt ( 0.00 %) + vertical polarisation: 8.08719E-03 Watt (100.00 %) + S polarisation: 4.04360E-03 Watt ( 50.00 %) + Z polarisation: 4.04360E-03 Watt ( 50.00 %) + left hand circular pol.: 4.04360E-03 Watt ( 50.00 %) + right hand circular pol.: 4.04360E-03 Watt ( 50.00 %) +Feko gives two values for the total power: +1. The first line gives the total power assuming that each specified point is located at the center +of an incremental integration area. The effective area is therefore slightly larger than the area +defined by the start and end angles. +2. The second line gives the total power integrated over an area defined by the start and end angles. +For example, assuming a far field integration from + to + and + and + both in + increments then the first total will give the total power through the sphere. It is also possible to set + in which case the second total will give the + and + to +the request from +correct power through the sphere. + to +The polarisation dependent power displayed in the second block of data is calculated according to the +effective area of the second line. +Receiving Antenna +When using a receiving antenna, the received power and phase of the received signal is given as +follows: + Receiving antenna (far field pattern) with name: FarFieldReceivingAntenna1 + RECEIVED POWER FOR IDEAL RECEIVING ANTENNA (FAR FIELD PATTERN) + Received power (ideal match assumed): 2.6019E-03 W + Relative phase of received signal: -8.6549E+01 deg. +Altair Feko 2022.3 +8 Description of the Output File of Feko +8.7 S-parameters +p.824 +S-parameters data consist of the S-parameters for all active ports as well as a table of reference +impedances used at each port. +S-parameters are requested with the SP card or with an S-parameter configuration in CADFEKO. Two +tables of data are printed to the output file. The first lists the impedance at each port. + S-PARAMETER REFERENCE IMPEDANCES AT PORTS + port impedance in Ohm + 1 5.00000E+01 + 2 1.00000E+02 +Further into the output file the S-parameters are listed for each source as shown below. Note that +inactive ports are only used as sink ports, that is, they are not excited and no data block is created for +these. +Note: Ports are set to inactive in CADFEKO in the Request S-parameters dialog and in +EDITFEKO the source (such as the A1 or AE card) must be set to zero amplitude. +All the ports are loaded and Feko therefore also writes the loading information to the output file. For +example, for an S-parameter request using edge ports, the following data will be written to the output +file: + DATA FOR EDGE LOADS + Name: + Load index: 1 + Load type: Resistor + Complex impedance: ( 5.00000E+01 +j 0.00000E+00) Ohm (freq. dep.) + Attached to port: Edge port + Port between triangle labels: + Union1.Face53_1 Union1.Face53_2 + Port edge length in m: 4.60000E-03 + Number of edges: 2 + Indices of the edges: 809 814 +For the S-parameter data, the second data line below gives S21 or the coupling to port 2 when port 1 is +excited. + SCATTERING PARAMETERS + ports magnitude phase + sink source real part imag. part linear in dB in deg. + S 1 1 8.20232E-01 -3.08302E-01 8.76260E-01 -1.1473 -20.60 + S 2 1 -1.09955E-02 -5.19575E-03 1.21613E-02 -38.3004 -154.71 + Sum |S|^2 of these S-parameters: 7.67979E-01 -1.1465 +8.8 Computation Time and Peak Memory +Computation time and memory data consist of the computation time for the different stages of the +solution such as checking the geometry and matrix calculation time. The peak memory and memory per +process is also provided. +The final section in the output file gives an overview of the computation time, in seconds, in a +tabular format: + SUMMARY OF REQUIRED TIMES IN SECONDS + CPU-time runtime + Reading and constructing the geometry 0.184 0.184 + Checking the geometry 0.095 0.095 + Initialisation of the Green's function 0.000 0.000 + Calcul. of coupling for PO/Fock 0.000 0.000 + Transformation to equivalent sources 0.000 0.000 + Ray launching/tracing phase of RL-GO 0.000 0.000 + Calcul. of matrix elements 18.036 18.037 + Calcul. of right-hand side vector 0.001 0.000 + Preconditioning system of linear eqns. 0.437 0.439 + Solution of the system of linear eqns. 3.367 3.365 + Eigensolution for characteristic modes 0.000 0.000 + Determination of surface currents 0.000 0.000 + Calcul. of impedances/powers/losses 0.045 0.045 + Calcul. of averaged SAR values 0.000 0.000 + Calcul. of power receiving antenna 0.000 0.000 + Calcul. of cable coupling 0.000 0.000 + Calcul. of error estimates 0.000 0.000 + Calcul. of electric near field 0.000 0.000 + Calcul. of magnetic near field 0.000 0.000 + Calcul. of far field 0.000 0.000 + other 0.127 0.128 + ------------ ------------ + total times: 22.292 22.293 + (total times in hours: 0.006 0.006) +This table is followed by an output of the peak memory usage (main memory, excluding possible out- +of-core files) which Feko encountered during any solution phase: +Specified CPU-times are referring to the master process only + Sum of the CPU-times of all processes: 89.173 seconds ( 0.025 hours) + On average per process: 22.293 seconds ( 0.006 hours) + Peak memory usage during the whole solution: 60.218 MByte + (refers to the master process only) + Sum of the peak memory of all processes: 233.845 MByte + On average per process: 58.461 MByte +Feko Application Macros +9 Feko Application Macros +A large collection of application macros are available for CADFEKO and POSTFEKO. +This chapter covers the following: +• 9.1 Application Macros (p. 827) +• 9.2 Application Macro Library (p. 828) +• 9.3 CADFEKO Application Macros (p. 830) +• 9.4 POSTFEKO Application Macros (p. 845) +9.1 Application Macros +An application macro is a reference to an automation script, an icon file and associated metadata. +Application macros are available directly or can be added, removed, modified or executed from the +application macro library. +Tip: A large collection of application macros are available in CADFEKO and POSTFEKO. +On the Home tab, in the Scripting group, click the + Application macro icon. +9.2 Application Macro Library +The application macro library allows commonly used application macros to be stored in a repository. +The application macro library are stored at the following locations: +• Feko home directory for global access: \installedapplicationmacrolibrary +• Feko user directory for local access: \applicationmacrolibrary +Note: +• User defined application macros are stored and managed in the . +• Only application macros stored locally in may be modified or +removed. +Related reference +Environment Variables: FEKO_SHARED_HOME, FEKO_USER_HOME +9.2.1 Adding a Macro to the Application Macro Library +Extend the application macro library by adding an application macro. +1. On the Home tab, in the Scripting group, click the + Application macro icon. From the drop- +down list, select the + Macro Library icon. +Figure 571: The Application macro library dialog. +2. On the Application macro library dialog, click Add. +3. +In the Script location field, browse to the location of the application macro that you want to add +to the library. +4. Under Description, add a comment to describe the purpose of the macro. +5. +In the Label field, specify the macro name. +6. From the Icon drop-down list select one of the following: +• Select a standard icon. +• Browse to the location of a custom image. +Note: +• The image may be any size as it is scaled +• Multiple image file formats are supported. +7. Click Create to add the application macro to the library and to close the dialog. +Figure 572: The Add application macro dialog. +9.2.2 Running a Macro from the Application Macro Library +Run a script that is located in the application macro library. +1. On the Home tab, in the Scripting group, click the + Application macro icon. From the drop- +down list, select the + Macro Library icon. +2. Select the application macro that you want to run by using one of the following workflows: +• In the Filter field, enter the macro name to narrow down the search. +• In the table select the relevant macro. +3. Run the script by selecting one of the following workflows: +• Click the + button. +• From the right-click context menu, click Run. +9.3 CADFEKO Application Macros +A collection of Lua application macros are available to automate repetitive tasks in CADFEKO. +9.3.1 Transfer User Configurations +This application macro transfers settings and application macros between different versions of Feko. +This may be useful if you have customised one installation of Feko and want to use the same settings in +a concurrent installation. +Using the Application Macro +Execute the application macro in CADFEKO to transfer user-defined settings to another Feko version. +1. Open CADFEKO and run the macro. +The Transfer user configurations dialog is shown. +Figure 573: The Transfer user configurations dialog. +2. From the Source list, select the version to copy settings from. +3. From the Destination list, select the version to copy settings to. +Note: Only Feko versions installed in the same directory as the current running +version, for example, C:/Program Files/Altair, are displayed in the Source and +Destination lists. +4. +[Optional] Clear the check boxes for the settings that are not required for transfer. +Note: If Application Macro Library is selected, the application macro locations are +transferred. (The application macro files are not copied to a new location.) +Altair Feko 2022.3 +9 Feko Application Macros +5. Click Copy. +6. Finish the process by clicking OK to acknowledge the messages. +p.831 +Figure 574: The Settings transferred dialog. +• If the Destination is the current running version, a new CADFEKO session is started with the +transferred settings. +Figure 575: The Transfer info dialog. +After the new session is started, click OK to close the old CADFEKO session. +Figure 576: The Transfer complete dialog. +• If the Destination is not the current running version, click Close to dismiss the Transfer +user configurations dialog. +The new settings are now available. +Altair Feko 2022.3 +9 Feko Application Macros +9.3.2 Generate Antenna Array +p.832 +The application macro allows you to create an array of elements. Specify the number of elements and +offset between the elements, or import the coordinates from file to create an irregular-spaced array. +For the array amplitude distribution, select a mathematical distribution (such as cosine) or import the +magnitude and phase for each element from file. +The array tool application macro has additional functionality when comparing to the Finite array tool[84] +in CADFEKO that allows you to create custom and complex antenna arrays with ease. Create a .cfx file +that contains the base element (antenna). Then use the application macro to copy the base elements +(including all its ports, sources and loads) to create the array. Each source and load are given a unique +name, allowing you to modify any source or load for an array element after the application macro was +run. You can also specify the configuration to which the sources and loads should be copied. +Figure 577: The antenna array created by copying the base element. Each element has a unique label for the port, +source and load. +Tip: Find the examples in the directory: +/installedapplicationmacrolibrary/CADFEKO/ArrayTool/ +examples. +84. The Finite antenna array tool in CADFEKO copies the base element, but the same sources and loads +as used for the base element, are used for all antenna array elements. For the array amplitude +distributions, you can either specify the uniform amplitude distribution or specify the magnitude +and phase per element. +Defining a Linear or Planar Antenna Array +Use the application macro to create a linear or planar antenna array from a specified base element. +1. Open vivaldi_base_element.cfx or any other .cfx file in CADFEKO. +Figure 578: The base element in vivaldi_base_element.cfx. +2. Run the Generate antenna array application macro from the application macro library. +The Generate array dialog is displayed. +Figure 579: The Generate array dialog. +3. From the Base element drop-down list, select the geometry part[85] or model mesh part that is +the antenna. +4. From the Destination configuration drop-down list, select the configuration where to the +duplicated sources and loads are added. +5. From the Array type drop-down list, select Linear/planar array. +6. Under Operations on array after generation, select any of the following options: +a) [Optional] Select the Union array check box to apply the union operation to the array +automatically after the array is created. +b) [Optional] Select the Simplify union check box to apply the simplify operation to the array +automatically after the antenna array is created. +85. The highest-level items in the model tree are referred to as “parts”. +c) [Optional] Select the Mesh array check box to mesh the array automatically after the +antenna array is created. +d) [Optional] Select the Calculate embedded element patterns check box to create N +configurations (where N is the number of antenna elements in the array) with all requests +duplicated for each configuration. Each configuration has an active port while the other ports +are terminated with 50 ohm load. +e) [Optional] Select the Add an S-parameter configuration check box to add an S-parameter +configuration automatically with all ports included and set active for the array. +7. Click OK to close the Generate array dialog. +The Array layout dialog is displayed. +Specifying the Array Layout +Specify the number of elements and offset between the elements. +Figure 580: The Array layout dialog. +1. +2. +3. +4. +In the Number of elements in X direction field, enter a value for the number of elements. +In the Number of elements in Y direction field, enter a value for the number of elements. +In the Offset along X axis field, enter a value for the offset between the elements. +In the Offset along Y axis field, enter a value for the offset between the elements. +5. Click OK to close the Array layout dialog. +The Import excitation values dialog is displayed. +Specifying the Amplitude Distribution +Define the amplitude distribution for the antenna array. +Figure 581: The Import excitation values dialog. +1. Under Amplitude type, select one of the following: +• Uniform +• Triangular +• Cosine +• Cosine-squared +• Custom (import from file) +Note: If you have selected Custom (import from file), continue to Importing Array +Parameters From File. +2. From the Apply amplitude type to drop-down list, select one of the following: +• X axis +• Y axis +• X and Y axes +Note: If only a single axis is specified[86], a uniform distribution is applied to the +second axis. +3. +4. +[Optional] In the X direction field, specify the phase difference in degrees between the elements. +[Optional] In the Y direction field, specify the phase difference in degrees between the elements. +5. Click OK to close the dialog. +86. For example, if a cosine distribution is applied to the X axis, a uniform amplitude is applied to the Y +axis. +Altair Feko 2022.3 +9 Feko Application Macros +The application macro creates an array as specified. +p.836 +Figure 582: An example of a planar antenna array created from a single base element. +Defining an Irregular-Spaced Array +Use the application macro to create an irregular-spaced antenna array from a specified base element. +1. Open vivaldi_base_element.cfx or any other .cfx file in CADFEKO. +Figure 583: The base element in vivaldi_base_element.cfx. +2. Run the Generate antenna array application macro from the application macro library. +The Generate array dialog is displayed. +Figure 584: The Generate array dialog. +3. From the Base element drop-down list, select the geometry part[87] or model mesh part that is +the antenna. +4. From the Destination configuration drop-down list, select the configuration where to the +duplicated sources and loads are added. +5. From the Array type drop-down list, select Custom array. +6. Under Operations on array after generation, select any of the following options: +a) [Optional] Select the Union array check box to apply the union operation to the array +automatically after the array is created. +b) [Optional] Select the Simplify union check box to apply the simplify operation to the array +automatically after the antenna array is created. +c) [Optional] Select the Mesh array check box to mesh the array automatically after the +antenna array is created. +d) [Optional] Select the Calculate embedded element patterns check box to create N +configurations (where N is the number of antenna elements in the array) with all requests +duplicated for each configuration. Each configuration has an active port while the other ports +are terminated with 50 ohm load. +e) [Optional] Select the Add an S-parameter configuration check box to add an S-parameter +configuration automatically with all ports included and set active for the array. +7. Click OK to close the Generate array dialog. +The Import array parameters dialog is displayed. +Importing Array Parameters From File +Specify a file to import an array with a user-defined distribution, or to import an irregular-spaced array +or both. +Figure 585: The Import array parameters dialog. +1. +In the Filename field, browse for the file you want to import. The number of antenna array +elements is determined from the specified file. +87. The highest-level items in the model tree are referred to as “parts”. +Altair Feko 2022.3 +9 Feko Application Macros +Note: +p.838 +• If you have selected Custom array in Step 5, the file that you import must +contain the X, Y and Z coordinates, amplitude, and phase (in degrees). +For example (if you use comma-separated values): +20, 30, 40, 1, 0 +25, 30, 40, 2, 20 +28, 30, 40, 5, 30 +• If you have selected Custom (import from file) in Step 1, the file that you +import must contain the magnitude, and phase (in degrees), where the base +element is the last element in the file. +For example (if you use comma-separated values): +1, 0 +2, 20 +5, 30 +Figure 586 illustrates the element order when importing the magnitude and phase +from a file. +Base element +Figure 586: An example showing the element order for a 3x2 planar antenna array where the magnitude and +phase are imported from a file. The base element is the last element specified in the file. +2. Under Delimiter, select the delimiter type used in the file to be imported from the following list: +• Comma +• Tab +• Space +3. Click OK to close the dialog. +The application macro creates an array as specified. +Figure 587: An example of a custom antenna array created from a single base element. +Limitations of Generate Antenna Array Macro +The Generate antenna array application macro has several limitations on how the base element is +defined and the amplitude distribution. +The following limitations should be noted: +• The base element consists only of the antenna. Geometry that does not form part of the array can +be added after generating the array. +• The base element must be either a geometry part or model mesh part (the highest-level item in +the model tree). +• When a mathematical distribution is only applied to a single axis, a uniform distribution is applied +to the second axis. +• When defining an irregular-spaced array by importing from file, the number of elements is +determined by the imported file. +9.3.3 Compare CADFEKO Models +The application macro allows you to compare two CADFEKO models to find the differences between the +two models. +The results of the comparison are displayed on the dialog or can be exported to file. +Using the Application Macro +Use the Compare CADFEKO models application macro to compare two CADFEKO models. +Restriction: Keep the order of collections the same between models as indexes are used to +compare objects. +1. Run the Compare CADFEKO models from the application macro library in CADFEKO +The Compare CADFEKO Models dialog is displayed. +Figure 588: The Compare CADFEKO Models dialog. +2. +3. +In the Model 1 field, browse to the first CADFEKO model. +In the Model 2 field, browse to the second CADFEKO model. +4. Under Object properties, select the object[88] properties to compare: +• Labels +Compare the labels of objects. +• Names +Compare the names of objects (variables and objects). +• Values +Compare the values of objects (variables). +• Descriptions +Compare the description of objects (variables). +• Expressions +Compare the expressions of objects (variables). +• Paths +Compare file paths of objects. +• Solution settings +Compare the model solution settings of objects. +• Solver settings +Compare the solution solver settings of objects. +• Visibility +Compare the visibility of objects. +• Locked +Compare the locked[89] state of objects. +• Included +Compare the included[90] state of objects. +• Ground plane +Compare ground planes (objects). +88. An object is an entity within an object oriented programming language with two main +characteristics: a state and a behaviour. The settings of the object are stored in its properties and +its abilities are accessed through methods. +89. +Lock a part to prevent modification to the simulation mesh (and prevent the part from being +edited). +90. A geometry part (or mesh part) that does not contain any ports, sources or loads can be +temporarily excluded from the model without having to delete the part. +5. Under Collections, select the collections[91] to compare: +• Geometry +Compare the collections of geometry. +• Meshes +Compare the collections of editable meshes. +• Media +Compare the collections of media. +• Named points +Compare the collections of named points in the model. +• Variables +Compare the collections of variables in the model. +• Workplanes +Compare the collections of workplanes in the model. +• Children +Compare the operator's collection of child operators. +• Edges +• Faces +Compare the operator's collection of edges. +Compare the operator's collection of faces. +• Regions +Compare the operator's collection of regions. +• Transforms +Compare the operator's collection of transforms. +• Wires +Compare the operator's collection of wires. +6. Click Compare to evaluate the models and start the comparison between model 1 and model 2. +Under Results of model comparison, the results of the comparison are displayed. +7. +[Optional] In the Output file field, specify the text file to export the results for the model +comparison. +91. A collection is a special object that contains objects of which there can be more than one. +For example, there can be multiple sources, far fields, geometry parts and so on. When +referencing an item in a collection, an index must always be specified, for example farfield[1] or +farfield[“FarField”]. +9.3.4 Other CADFEKO Application Macros +A collection of smaller CADFEKO application macros are available, but these macros do not include step- +by-step instructions. +Pre-Process PollEx REI File +This application macro imports a .rei file from Altair PollEx and creates the associated geometry in +CADFEKO. +Automatic Mesh Refinement +This application macro performs an automatic mesh refinement process based on error estimates +using the Adaptive refinement tool available in CADFEKO in an itterative fashion. The progress and +feedback is shown in the CADFEKO message window. +During the mesh refinement process, request, configurations, frequency and other settings may be +adjusted. +Once the mesh refinement completes, a full simulation (including all configurations. requests, +frequencies and setting in the original model) will be run. This simulated model named +_refined (where is the name of the original model) will remain open in +CADFEKO at the same folder location as the original model. The original model will remain unmodified. +The Meshing rules added during automatic mesh refinement can be viewed in the model tree. +Variables are added in the refined model that may be used to adjust the automatic refinement +thresholds and refine the meshing further if needed. +Automated mesh refinement may also be launched from a Feko terminal using the following command +syntax: +cadfeko --non-interactive '' --run-script %FEKO_SHARED_HOME% +\installedapplicationmacrolibrary\CADFEKO\AutoAdaptiveMeshing\AutoAdaptiveMeshing.lua + | more +Create Frequency Ranges +This application macro creates a separate model for each frequency range specified. The following +solvers MoM, MLFMM, and ACA, can be specified for each range to improve simulation time. +Note: Run the Combine Results application macro in POSTFEKO to combine the result for +each frequency range. +Create Rough Sea Surface +This application macro creates a CADFEKO model of a rough sea surface. +Create Inductive Charging Coils +This application macro creates a CADFEKO model of two inductive charging coils. +Altair Feko 2022.3 +9 Feko Application Macros +Ideal Power Divider +p.844 +This application macro generates a network model of an ideal n-port power divider with unequal +division, a 2-port Wilkinson power divider with unequal division, and an n-port Wilkinson power divider +with equal division. +Create Far Field Equivalent Sources Split Over Frequency +This application macro creates a far field equivalent source for each frequency split over multiple +configurations. The application macro also adds a receiving antenna request with each configuration. +Note: Run the Combine Far Field Equivalent Sources application macro in POSTFEKO to +combine the result for each configuration. +Optenni Lab: Port Matching +This application macro uses Optenni Lab to generate matching networks for all desired ports. +Parameter Sweep: Create Models +This application macro generates different permutations of a parametric model based on varying the +value of the model variables. +Create Impedance Sheet for Layered Metals +This application macro creates an effective surface impedance from a stacked metal definition. The +application macro requires a metal to be defined in the model. +Create Wireless Communication Measurement Configuration +This application macro creates a standard configuration with a far field request with a pre-defined +frequency and angular definition. The application macro can also suggest the required increment to use +for the far field request given the frequency range and largest dimension of the device under test. +Note: Use the Calculate Wireless Communication Performance application macro to +calculate EIRP,EIS,TRP and TIS quantities with the far field data from this macro. +9.4 POSTFEKO Application Macros +A collection of Lua application macros are available to automate repetitive tasks in POSTFEKO. +9.4.1 Characteristic Mode Plotter +This POSTFEKO application macro can be used to plot all the standard parameters that are available +after a characteristic mode analysis simulation was performed. +Characteristic Mode Analysis +Characteristic mode analysis (CMA) is the numerical calculation of a weighted set of orthogonal current +modes that are supported on a conducting surface. The sets of characteristic near fields and far +fields associated with these characteristic currents can provide insight into the radiating properties of +structures, allowing for a systematic approach to antenna design and placement. +Characteristic modes are obtained by solving a particular weighted eigenvalue equation that is derived +from the method of moments impedance matrix. Feko has a built-in solver that calculates these modes, +with no need for post-processing by the user. The eigen values, modal significance, characteristic +angles, currents, near fields, and far fields can be visualised in POSTFEKO. +Characteristic Mode Plotter +Characteristic mode analysis calculates various parameters of interest. The characteristic mode plotter +was developed to plot these parameters, since it can be a tedious task to do this manually for multiple +modes. +Select the data to analyse, and which quantities to plot: eigen value, modal significance, characteristic +angle and, if available, modal excitation and weighting coefficients. Each selected quantity is plotted on +a new graph. +Either frequency or mode index have to be selected to define the independent axis. If both are selected, +two graphs will be created for each quantity. The number of modes to be plotted is specified. By default, +both tracked and untracked modes are plotted on each graph. +Example for Using the Characteristic Mode Plotter +The characteristic mode analysis plotter application macro is used to plot the various CMA parameters +for a simple dipole antenna. +The example model is a half-wavelength wire dipole at 74.9 MHz. The dipole length is 2 m, and it has a +wire radius of 2 mm. It is excited by a voltage source at the centre of the wire. +Figure 589: Simple dipole model. +Tip: Find the example in the directory: +/installedapplicationmacrolibrary/POSTFEKO/ +CharacteristicModeAnalysis/CMAPlotter/examples. +Using the Application Macro +Execute the application macro in POSTFEKO to plot characteristic mode quantities on Cartesian graphs. +1. Start with a POSTFEKO session containing at least one model with characteristic mode analysis +results. +The results from a single characteristic mode analysis request will be used as input to the macro. +2. Execute the Plot characteristic modes application macro in POSTFEKO to plot the characteristic +modes. +Figure 590: The Characteristic Mode Plotter dialog. +A dialog shows the available characteristic mode results. +3. Select the result and quantities of interest. +Restriction: The Modal Excitation Coefficient and Modal Weighting Coefficient +can only be plotted when the model contains a source and the modal excitation +coefficient calculation is enabled in the request. +4. Select Frequency, Mode Index, or both as the independent axis. +A new graph for each selected independent axis will be created for each quantity of interest. +5. Enter the highest mode index to be considered. This determines the number of modes that are +plotted on each graph. +A trace is added to each graph for each calculated mode with an index lower or equal than the +entered value. +6. Select to plot either the Tracked Modes, the Untracked Modes, or both. +7. Select Plot to start the plotting on a Cartesian graph. +8. View the graphs generated by the macro. +Figure 591: Modal significance graph for a simple dipole antenna. +Figure 592: Characteristic angle graph for a simple dipole antenna. +Figure 593: Modal weighting coefficient graph for a simple dipole antenna. +9.4.2 MIMO Performance Evaluation +This application macro is used for calculating mean effective gain (MEG) and envelope correlation +coefficient (ECC) for a MIMO antenna configuration. The MEG ratio can also be plotted. +The application macro is used for calculating mean effective gain (MEG), envelope correlation coefficient +(ECC)[92]. Using the Maths option for the 2D graph, the MEG ratio can also be plotted. +Currently, the application macro only supports two channel MIMO: the two channels are simulated +as two separate configurations, each with its far field request. You can choose to sweep the cross +polarization ratio (XPR), sweep the frequency or both. The propagation environment can also be +defined. The default is uniform, with + . +Figure 594: The Evaluate MIMO performance dialog. +Plots of ECC against XPR or MEG against frequency are plotted depending on the selected options. +92. M.P. Karaboikis, V.C. Papamichael, G.F. Tsachtsiris., C.F. Soras and V.T. Makios, Integrating +Compact Printed Antennas Onto Small Diversity/MIMO Terminals, IEEE Transactions on Antennas & +Propagation, Vol. 56, No. 7, July 2008. +9.4.3 Multiport Post-Processing +The Multiport post-processing application macro allows you to calculate results for changes in the port +loading without rerunning the Solver. Results that are supported are far fields, near fields, currents and +specific port parameters, for example, the voltage, current and S-parameters of each port. +Overview +The Multiport post-processing application macro calculates the port reflections and field values for +changes in port loading, without rerunning the Solver. Through scripting in POSTFEKO, loads can be +modified as a post-processing step. +Requirements for performing the post-processing for a given model, are the availability of the scattering +matrix for the model and the field requests for each configuration in the scattering parameter solution. +The application macro uses the extracted S-parameters and the field values for all configurations to +calculate (and export) near field data, far field data (including gain), and the new S-parameter matrix +(taking the loading into account) without requiring further Feko simulations. +The following application macros are provided: +Generate multiport configurations +A CADFEKO application macro that creates the model for post-processing with the Multiport post- +processing macro. +Multiport post-processing +A POSTFEKO application macro that performs multiport post-processing. +Base Multiport Feko Simulation +A base multiport Feko simulation is required to generate the required input data for the Multiport post- +processing application macro. +S-parameters are calculated in Feko by loading all ports with the port reference impedance and then, +in turn, exciting each port in the model. The voltages and currents calculated at all the ports can be +combined to determine the S-parameter matrix. For multiport post-processing, the field values (near +and far fields) also need to be determined for each configuration in the S-parameter calculation. This +requires that m+1 simulation solutions need to be performed by default, where m is the number of +ports in the model. +Reduce the calculations to m simulations for a model consisting of m configurations: +• The loads for all configurations must be identical and set to the reference impedance for the +multiport system. +• Each configuration has a single source and for all the configurations, each port is excited once. +• Requests in all configurations must be identical. +• All other configurations settings (except for the excitations) are identical. +Tip: Use Generate multiport configurations application macro to simplify the model +creation process. +Since the loads are identical for all configurations and only the source is modified between +configurations, the simulation is performed efficiently when using the method of moments (MoM) since +the expensive matrix fill and LU-decomposition is only performed once at each frequency. +For all subsequent configurations, only the right-hand side vector (sources) is updated and a backward +substitution is performed before calculating the output for the requests. +Multiport Post-Processing Workflow +The basic workflow of the Multiport post-processing application macro (MultiportPostProcessing.lua) +is described. +Specify input file(s) for +MultiportPostProcessing.lua +Script extracts S-parameters and +field data +Specify processing options +Specify non-active ports and its load +impedances +Use a settings file to define the +loading and excitation for each port +Specify excitations for active ports +and its load impedances +Script calculates new port parameters +and field data +View the multiport results under +Stored data +Figure 595: Post-processing workflow for the Multiport post-processing macro. +1. Specify the input file (or files) that will be used to extract the port information[93] using one of the +following options: +• Feko model (.fek file) +• Measurement data +2. The application macro extracts the S-parameters and the field data (far field and near field). +3. Specify the processing options. +93. For example, voltage, currents and field data for each port. +4. Specify the non-active ports as well as what the load impedance is at these ports. The following +load types are available: +• Point loads that do not connect to other ports. These ports can be loaded with any of the +following: +◦ Complex loads +◦ Series RLC circuit +◦ Parallel RLC circuit +◦ Short circuit +◦ Open circuit +◦ One-port Touchstone (.s1p) file +• A single multiport Touchstone file that contains all the port terminations (ports can be +connected through the S-parameter matrix). +• Multiple one-port Touchstone files (one at each port). This option is equivalent to selecting the +first option above (point loads) and specifying all point loads via one-port Touchstone files. +• Specify the excitations for the active ports as well as the load impedance at these ports. +The ports can be loaded with any of the following: +◦ Direct connection +◦ Complex load +◦ One-port Touchstone (.s1p) file +◦ Two-port Touchstone (.s2p) file +Note: Ports not specified as non-active are assumed to be sources. +5. The application macro calculates the new port parameters and field data. +6. View the multiport results in POSTFEKO, under Stored data. +Alternatively, you can specify the loading and excitations for each port using a settings file. +Create a Multiport Lua Settings File +The Multiport post-processing application macro can be configured to use a Lua settings file to define +the loading and excitation for each port. This simplifies the procedure for frequent calculations or large +multiport setups with many ports. +The Multiport post-processing application macro is dependent on the order in which the configurations +are returned from the Lua settings file. It is expected that the configuration tables are in the following +order: +1. Active ports configuration +2. Non-active ports configuration +3. Field data configuration +4. Processing options +The following command should be defined at the end of the Lua settings file. +return {activePortsConfiguration,nonActivePortsConfiguration,fieldDataConfiguration,processingOptions} +Note: +• The fieldDataConfiguration table is only required for the measurement method of the +Multiport post-processing application macro to map the field data to the correct ports. +Active Port Configuration +Set up the Lua settings file for the active ports in a multiport active ports configuration. Each active port +in the configuration requires an excitation and a load specification. +Port Excitation Specification +The magnitude and phase for each active ports in the active port configuration are specified as follows: +-- create table to store the source data in +activePortsConfiguration = {} +-- Source Port1 +source = {} +source.Label = "Port1" +source.Index = 1 +source.Value = pf.Complex(1,0) +table.insert(activePortsConfiguration,source) +Port Loading Specification +A load table that groups the loading for each port, is added to the active ports configuration. The four +loading types for an active port are: +• Direct connection (no additional loading) +• Complex load +• One-port Touchstone network (.s1p) +• Two-port Touchstone network (.s2p) +-- Load options to attach to active port. +-- Create load table and load data table +activePortsConfiguration.Load ={} +activePortsConfiguration.Load.Data ={} +-- Type = 1 (direct connection or no loading), +load = {} +load.Type = 1 +table.insert(activePortsConfiguration.Load.Data,load) +-- Type = 2 (complex) +load ={} +load.Type = 2 +load.Value = pf.Complex(50,0) +table.insert(activePortsConfiguration.Load.Data,load) +-- Type = 3 (One port Touchstone network) +load = {} +load.Type = 3 +-- Relative path from settings file location on drive +load.Filename = "test.s1p" +table.insert(activePortsConfiguration.Load.Data,load) +-- Type = 4 (Two port Touchstone network) +load = {} +load.Type = 4 +-- Relative path from settings file location on drive +load.Filename = "example.s2p" +table.insert(activePortsConfiguration.Load.Data,load) +Note: Measurement data includes the reference impedance when determining the port +loading. +Non-Active Port Configuration +Set up the load configuration to modify the load attached to a non-active port. There are three load +configuration types: individual (single port definition), multiport single Touchstone (one Touchstone +file for all the ports), and multiple single port Touchstone files (one file for each port). Only one +configuration type can be used per calculation. +Specifying Individual Loading for Non-Active Ports +A load configuration table is used to store the individual port loading in for the non-active ports and +the type property of the table is set to Individual. Each load is inserted in the Data table of the load +configuration. An individual port load is defined as one of the following types: +• Complex +• Series RLC +• Parallel RLC +• Short or Open circuit +• One-port Touchstone (.s1p) file +Below is an example of how the load types can be defined +nonActivePortsConfiguration = {} +nonActivePortsConfiguration.Type = "Individual" +nonActivePortsConfiguration.Data = {} +-- Load specification for complex series load +load = {} +load.Label = "Port_1" +load.Index = 1 +load.Type = "Complex" +load.Value = pf.Complex(150,20) +table.insert(nonActivePortsConfiguration.Data,load) +-- Load specification for series RLC load +load = {} +load.Label = "Port_2" +load.Index = 2 +load.Type = "SeriesRLC" -- or "ParallelRLC" +load.R = 30 +load.L = 20e-9 +load.C = 5e-12 +table.insert(nonActivePortsConfiguration.Data,load) +-- Load specification for short or open circuit +load = {} +load.Label = "Port_3" +load.Index = 3 +load.Type = "Open" -- or "Short" +table.insert(nonActivePortsConfiguration.Data,load) +load = {} +load.Label = "Port_3" +load.Index = 4 -- index should match port number +load.Type = "Touchstone1port" +-- Relative path from Lua settings file location on drive +load.Filename = "test_file.s1p" +table.insert(nonActivePortsConfiguration.Load.Data,load) +Note: Filename (property) is the relative path from the settings file to the Touchstone file. +Specifying Loading with Individual Touchstone Files +A nonActivePortsConfiguration table is used to store the individual port loading in for the non-active +ports and the type property of the table is set to Individual_Touchstone_files. Each load is inserted +in the Data table of the load configuration. For the individual Touchstone files type configuration, it is +assumed that each load is a single .s1p file. +nonActivePortsConfiguration = {} +nonActivePortsConfiguration.Type = "Individual_Touchstone_files" +nonActivePortsConfiguration.Data = {} +load = {} +load.Label = "Port_1" +load.Index = 1 +-- Relative path from Lua settings file location on drive +load.FileName = "test_file.s1p" +table.insert(nonActivePortsConfiguration.Data,load) +load = {} +load.Label = "Port_2" +load.Index = 2 +-- Relative path from Lua settings file location on drive +load.FileName = "test_file.s1p" +table.insert(nonActivePortsConfiguration.Data,load) +Note: Filename (property) is the relative path from the settings file to the Touchstone file. +Specifying Loading with a Single Touchstone File +A nonActivePortsConfiguration table is used to store the port loading for the non-active ports and the +type property of the table is set to Touchstone. For the Touchstone configuration type, it is assumed +that all the loads are defined in a single Touchstone file. +nonActivePortsConfiguration = {} +nonActivePortsConfiguration.Type = "Touchstone" +-- Relative path from Lua settings file location on drive +nonActivePortsConfiguration.FileName = "4_port_load.s4p" +Altair Feko 2022.3 +9 Feko Application Macros +Field Data Configuration +p.858 +Set up the field data configuration table to be used with the measurement method to map to the correct +near field or far field data (available under Stored data in the .pfs file). +A fieldDataConfiguration table is used with a FarFields or NearFields attribute. It is only required to +specify the label of the stored field and the index of the item in the table maps to the port number in +the multiport configuration. +fieldDataConfiguration = {} +-- Specify the Far field data +-- Note the label should match the stored data in the .pfs file. +fieldDataConfiguration["FarFields"] = {} +fieldDataConfiguration["FarFields"][1].Label = "FarField_1" +fieldDataConfiguration["FarFields"][2].Label = "FarField_2" +fieldDataConfiguration["FarFields"][3].Label = "FarField_3" +fieldDataConfiguration["FarFields"][4].Label = "FarField_4" +-- Specify the Near field data +-- Note the label should match the stored data in the .pfs file. +fieldDataConfiguration["NearFields"] = {} +fieldDataConfiguration["NearFields"][1].Label = "NearField_1" +fieldDataConfiguration["NearFields"][2].Label = "NearField_2" +fieldDataConfiguration["NearFields"][3].Label = "NearField_3" +fieldDataConfiguration["NearFields"][4].Label = "NearField_4" +Processing Options +Set up the processingOptions table to be used with the command-line interface. The processingOptions +table defines which data is exported as well as setting non-default values. +A processingOptions table is used with the following attributes to set the processing options for the +multiport script. +deembedToAntenna +Set this option to move the reference plane to where the port parameters were calculated before +the source loading definition (if the sources are loaded). This variable maps to the Subtract +source loading option on the GUI. +referenceImpedance +Set the system reference impedance for the measurement method. +storeDataSets +Set this option to store the data sets in the .pfs session. +includeSourceReferenceImpedance +Set this option to include the source reference impedance in the multiport calculations. +mergeWithExistingStoredData +Set this option to merge the new multiport calculation with existing stored data. +calculateScaledRequests +Set this option to calculate the scaled far fields and near fields, and currents if available. +Altair Feko 2022.3 +9 Feko Application Macros +exportDataSets +p.859 +Set this option to export the far fields and near fields and save a POSTFEKO session with the port +parameters. +prefix +Add a result prefix for the stored data items. +exportScallingCoefficients +Set this option to export the scaling coefficients to a .xml and .mat files. +validateModel +Set this option when using the Feko model method to validate the model setup. +Note: +• The processingOptions table is only required if the Lua settings file is used with the +command-line interface. +• Select the Save settings to file (*.lua) check box on the Processing options dialog +to save the processingOptions table. +local processingOptions={ + ["deembedToAntenna"] = "false", + ["referenceImpedance"] = "50", + ["storeDataSets"] = "true", + ["includeSourceReferenceImpedance"] = "false", + ["mergeWithExistingStoredData"] = "false", + ["calculateScaledRequests"] = "false", + ["exportDataSets"] = "false", + ["prefix"] = "SNP", + ["exportScallingCoefficients"] = "false", + ["validateModel"] = "false" +} +Command Line Arguments for Launching the Multiport Post- +Processing Macro +The Multiport application macro can be called via the command line through POSTFEKO. Use the -- +configure-script argument to pass configuration information to the multiport post-processing script. +Use the following command-line parameters to launch the multiport script: +postfeko [SESSION] --non-interactive --run-script=[SCRIPT] --configure-script="[OPTIONS]" +Note: The --configure-script parameter requires that the input variables are wrapped in +quotes with an empty space separating each variable. +SESSION +A single session (.pfs) may be specified that may or may not exist. +Altair Feko 2022.3 +9 Feko Application Macros +SCRIPT +Specify the path to the MultiportPostProcessing.lua file. +OPTIONS +mppSettings +The path to a multiport settings file. +outputDirectory +Specify the path for the exported result files. +fekoModel +p.860 +Specify the path to the .fek file, which contains the pre-processed multiport configuration +data. +snpFile +Specify the path to the .snp file for the multiport system using measurements. +outputDirectory +Specify the path for the exported result files. +referenceImpedance +[Optional] The real part of the system reference impedance used in the measurements. +prefix +[Optional] Specify a result prefix. +pfsFile +[Optional] Specify the path to .pfs file containing additional field measurements. +Note: The mapping from the stored data to each port is required in the +multiport settings file. +Output File Format for Scaling Coefficients +The file format and data structure for the output files (.xml and .mat) are described. These files are +generated for storing the scaling coefficients for a multiport calculation. +XML File Format +The .xml file has the following structure. The scaling coefficient, voltage, impedance, current and the +reference impedance data for each port are grouped in the result element, and the frequency data is +grouped in the frequencies element. + + modelname.fek + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Result Data Format in .mat File +The scaling coefficient data is stored in a .mat file in the following result structure +ResultData_. The frequency data can be accessed as follows using GNU Octave +or Altair Compose: +ResultData_.Frequencies +The scaling coefficients and some additional port results voltage, current, impedance and the reference +impedance can be accessed as follows using GNU Octave or Altair Compose: +ResultData_..scalingcoefficient +ResultData_..voltage +ResultData_..current +ResultData_..impedance +ResultData_..referenceimpedance +Multiport Post-Processing Limitations +The Multiport post-processing application macro has several limitations. +The following options are not supported by the Multiport post-processing application macro: +• The application macro requires a specific label for the ports and loads when using the Feko model +as input. The label mapping should be consistent between ports and loads. The recommended +naming convention for the loads and ports are