Metal

A metallic medium.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Create a metallic medium

metallic = project.Media: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.

Property List

Colour
The medium colour. (Read/Write Colour)
Conductivity
Medium's conductivity (S/m). Only applicable if DefinitionMethod is FrequencyIndependent. (Read/Write Expression)
DefinitionMethod
Metallic definition method. (Read/Write MediumMetallicDefinitionMethodEnum)
Filename
The file describing the medium properties in XML format. (Read/Write string)
Label
The object label. (Read/Write string)
LossTangent
Medium's magnetic loss tangent. Only applicable if DefinitionMethod is FrequencyIndependent. (Read/Write Expression)
RelativePermeability
Medium's relative permeability. Only applicable if DefinitionMethod is FrequencyIndependent. (Read/Write Expression)
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 Expression)
SurfaceRoughnessEnabled
Specifies if the surface roughness should be used for the metallic medium. (Read/Write boolean)
Suspect
Indicates whether the medium is suspect. (Read only boolean)
Type
The object type string. (Read only string)

Collection List

FrequencyPoints
The collection of linear interpolated frequency points of metallic properties. Only applicable if DefinitionMethod is FrequencyList. (MetallicFrequencyCollection of MetallicFrequencyPoint.)

Method List

AddToLibrary ()
Add the medium to the media library.
Delete ()
Delete the medium.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetNotSuspect ()
Reset the suspect setting on the medium.
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.

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
Colour
Access
Read/Write
Conductivity
Medium's conductivity (S/m). Only applicable if DefinitionMethod is FrequencyIndependent.
Type
Expression
Access
Read/Write
DefinitionMethod
Metallic definition method.
Type
MediumMetallicDefinitionMethodEnum
Access
Read/Write
Filename
The file describing the medium properties in XML format.
Type
string
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
Expression
Access
Read/Write
RelativePermeability
Medium's relative permeability. Only applicable if DefinitionMethod is FrequencyIndependent.
Type
Expression
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
Expression
Access
Read/Write
SurfaceRoughnessEnabled
Specifies if the surface roughness should be used for the metallic medium.
Type
boolean
Access
Read/Write
Suspect
Indicates whether the medium is suspect.
Type
boolean
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Collection Details

FrequencyPoints
The collection of linear interpolated frequency points of metallic properties. Only applicable if DefinitionMethod is FrequencyList.
Type
MetallicFrequencyCollection

Method Details

AddToLibrary ()
Add the medium to the media library.
Delete ()
Delete the medium.
GetProperties ()
Returns a table of properties representing the state of the 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.
SetNotSuspect ()
Reset the suspect setting on the medium.
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.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
The default properties table.