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
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)
- Label
- The object label. (Read/Write string)
- LossTangent
- 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.
- 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.