Project

The application project.

Example

app = cf.GetApplication() 
    
    -- Open an existing project

app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.cfx]])

    -- Set the model extents to 5e3
    
app.Project.ModelAttributes.ExtentsExponent = 3

    -- Create a new project and set the model unit to feet

project = app:NewProject()
project.ModelAttributes.Unit = cf.Enums.ModelUnitEnum.Feet

Usage locations (object properties)

The following objects have properties using the Project object:

Property List

CEMValidator
The computational electromagnetic (CEM) validator. (Read only CEMValidator)
Cables
A grouping of cable functionality. (Read only Cables)
Exporter
The model (geometry and mesh) exporter. (Read only Exporter)
GroundPlane
Planar Green's functions and ground planes in the model. (Read only GroundPlane)
Importer
The model (geometry and mesh) importer. (Read only Importer)
Label
The label of the project if it has one. (Read only string)
Launcher
The application process runner. (Read only Launcher)
Mesher
The model mesher. (Read only Mesher)
ModelAttributes
The model attributes. (Read only ModelAttributes)
Modified
True if the project is modified and needs to be saved. (Read only boolean)
Optimisation
The optimisation configuration. (Read only Optimisation)
Path
The path of the project file if it has one or the current working directory path. (Read only string)
PeriodicBoundary
The periodic boundary condition (PBC) for the model. (Read only PeriodicBoundary)
SolutionSettings
The model solution settings. (Read only SolutionSettings)
Type
The object type string. (Read only string)

Collection List

FieldDataList
The collection of field data definitions in the model. (FieldDataCollection of FieldData.)
Geometry
The collection of geometry in the model. (GeometryCollection of Geometry.)
Media
The collection of media in the model. (MediaCollection of Medium.)
MeshRefinementRules
The collection of mesh refinement rules in the model. (MeshRefinementRulesCollection of MeshRefinementRule.)
Meshes
The collection of editable (unlinked/imported) meshes in the model. (MeshCollection of Mesh.)
NamedPoints
The collection of named points in the model. (NamedPointCollection of NamedPoint.)
Ports
The collection of ports in the model. (PortCollection of Port.)
SolutionConfigurations
The collection of solution configurations in the model. (SolutionConfigurationCollection of SolutionConfiguration.)
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

GetProperties ()
Returns a table of properties representing the state of the object. 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.

Property Details

CEMValidator
The computational electromagnetic (CEM) validator.
Type
CEMValidator
Access
Read only
Cables
A grouping of cable functionality.
Type
Cables
Access
Read only
Exporter
The model (geometry and mesh) exporter.
Type
Exporter
Access
Read only
GroundPlane
Planar Green's functions and ground planes in the model.
Type
GroundPlane
Access
Read only
Importer
The model (geometry and mesh) importer.
Type
Importer
Access
Read only
Label
The label of the project if it has one.
Type
string
Access
Read only
Launcher
The application process runner.
Type
Launcher
Access
Read only
Mesher
The model mesher.
Type
Mesher
Access
Read only
ModelAttributes
The model attributes.
Type
ModelAttributes
Access
Read only
Modified
True if the project is modified and needs to be saved.
Type
boolean
Access
Read only
Optimisation
The optimisation configuration.
Type
Optimisation
Access
Read only
Path
The path of the project file if it has one or the current working directory path.
Type
string
Access
Read only
PeriodicBoundary
The periodic boundary condition (PBC) for the model.
Type
PeriodicBoundary
Access
Read only
SolutionSettings
The model solution settings.
Type
SolutionSettings
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
Geometry
The collection of geometry in the model.
Type
GeometryCollection
Media
The collection of media in the model.
Type
MediaCollection
MeshRefinementRules
The collection of mesh refinement rules in the model.
Type
MeshRefinementRulesCollection
Meshes
The collection of editable (unlinked/imported) meshes in the model.
Type
MeshCollection
NamedPoints
The collection of named points in the model.
Type
NamedPointCollection
Ports
The collection of ports in the model.
Type
PortCollection
SolutionConfigurations
The collection of solution configurations in the model.
Type
SolutionConfigurationCollection
Variables
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

GetProperties ()
Returns a table of properties representing the state of the 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.