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).
Property List
- Colour
- The medium colour. (Read/Write string)
- ComplexTensor
- 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.