AnisotropicDielectric
A 3D anisotropic medium.
Example
app = cf.GetApplication() project = app:NewProject() -- Define media to be used in 3D anisotropic definition dielUU = project.Media:AddDielectric() dielUV = project.Media:AddDielectric() dielUN = project.Media:AddDielectric() dielVU = project.Media:AddDielectric() dielVV = project.Media:AddDielectric() dielVN = project.Media:AddDielectric() dielNU = project.Media:AddDielectric() dielNV = project.Media:AddDielectric() dielNN = project.Media:AddDielectric() -- Create an anisotropic 3D medium properties = cf.AnisotropicDielectric.GetDefaultProperties() properties.MassDensity = "1000.0" properties.FullTensor.RowU.ColumnU = dielUU properties.FullTensor.RowU.ColumnV = dielUV properties.FullTensor.RowU.ColumnN = dielUN properties.FullTensor.RowV.ColumnU = dielVU properties.FullTensor.RowV.ColumnV = dielVV properties.FullTensor.RowV.ColumnN = dielVN properties.FullTensor.RowN.ColumnU = dielNU properties.FullTensor.RowN.ColumnV = dielNV properties.FullTensor.RowN.ColumnN = dielNN properties.TensorDescription = cf.Enums.TensorDescriptionMethodEnum.FullTensor AnisotropicDielectric = project.Media:AddAnisotropicDielectric(properties) -- Change the colour to Cyan AnisotropicDielectric.Colour = "#00FFFF"
Inheritance
The AnisotropicDielectric object is derived from the Medium object.
Property List
- Colour
- The medium colour. (Read/Write Colour)
- ComplexTensor
- Defines the complex permittivity and permeability tensors. (Read only ComplexTensor)
- DiagonalTensor
- Defines the media of the diagonal tensor definition. (Read only MediumTensor)
- FullTensor
- Defines the media of the full tensor definition. (Read only MediumTensor)
- Label
- The object label. (Read/Write string)
- MassDensity
- Medium's mass density (kg/m^3). (Read/Write Expression)
- PolderTensor
- Defines the parameters used to create a Polder tensor. (Read only PolderTensor)
- Suspect
- Indicates whether the medium is suspect. (Read only boolean)
- 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
- 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
- ComplexTensor
- Defines the complex permittivity and permeability tensors.
- Type
- ComplexTensor
- Access
- Read only
- DiagonalTensor
- Defines the media of the diagonal tensor definition.
- Type
- MediumTensor
- Access
- Read only
- FullTensor
- Defines the media of the full tensor definition.
- Type
- MediumTensor
- Access
- Read only
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- MassDensity
- Medium's mass density (kg/m^3).
- Type
- Expression
- Access
- Read/Write
- PolderTensor
- Defines the parameters used to create a Polder tensor.
- Type
- PolderTensor
- Access
- Read only
- Suspect
- Indicates whether the medium is suspect.
- Type
- boolean
- Access
- Read only
- 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
- 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.