`AnisotropicDielectricCollection`

A collection of anisotropic dielectric media.

Example

application = cf.Application.GetInstance()
project = application:NewProject()

    -- Define media to be used in 3D anisotropic definition

dielUU = project.Definitions.Media.Dielectric:AddDielectric()
dielUV = project.Definitions.Media.Dielectric:AddDielectric()
dielUN = project.Definitions.Media.Dielectric:AddDielectric()
dielVU = project.Definitions.Media.Dielectric:AddDielectric()
dielVV = project.Definitions.Media.Dielectric:AddDielectric()
dielVN = project.Definitions.Media.Dielectric:AddDielectric()
dielNU = project.Definitions.Media.Dielectric:AddDielectric()
dielNV = project.Definitions.Media.Dielectric:AddDielectric()
dielNN = project.Definitions.Media.Dielectric:AddDielectric()

    -- Create an anisotropic 3D medium

properties = cf.AnisotropicDielectric.GetDefaultProperties()
properties.MassDensity = "1000.0"
properties.FullTensor[1][1] = dielUU
properties.FullTensor[1][2] = dielUV
properties.FullTensor[1][3] = dielUN
properties.FullTensor[2][1] = dielVU
properties.FullTensor[2][2] = dielVV
properties.FullTensor[2][3] = dielVN
properties.FullTensor[3][1] = dielNU
properties.FullTensor[3][2] = dielNV
properties.FullTensor[3][3] = dielNN
properties.TensorDescription = cf.Enums.TensorDescriptionMethodEnum.FullTensor
AnisotropicDielectric = project.Definitions.Media.AnisotropicDielectric:AddAnisotropicDielectric(properties)

Inheritance

The AnisotropicDielectricCollection object is derived from the Object object.

Usage locations

The AnisotropicDielectricCollection object can be accessed from the following locations:

Collection lists
- Media object has collection AnisotropicDielectric.

Property List

Count: The number of AnisotropicDielectric items in the collection. (Read only number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

AddAnisotropicDielectric (properties table): Create a 3D anisotropic medium from a table defining the properties. (Returns a AnisotropicDielectric object.)
AddAnisotropicDielectric (mediumuu Dielectric, mediumvv Dielectric, mediumnn Dielectric): Create a 3D anisotropic medium. (Returns a AnisotropicDielectric object.)
Contains (label string): Checks if the collection contains an item with the given label. (Returns a boolean object.)
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.)
Item (index number): Returns the AnisotropicDielectric for the given index in the collection. (Returns a AnisotropicDielectric object.)
Item (label string): Returns the AnisotropicDielectric for the given label in the collection. (Returns a AnisotropicDielectric object.)
Items (): Returns a table of AnisotropicDielectric items. (Returns a UnsupportedType(List of AnisotropicDielectric) 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.
UniqueName (label string): Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a string object.)

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Count

The number of AnisotropicDielectric items in the collection.

Type: number
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

AddAnisotropicDielectric (properties table)

Create a 3D anisotropic medium from a table defining the properties.

Input Parameters

properties(table): A table of properties defining the new 3D anisotropic medium.

Return

AnisotropicDielectric: The 3D anisotropic medium.

AddAnisotropicDielectric (mediumuu Dielectric, mediumvv Dielectric, mediumnn Dielectric)

Create a 3D anisotropic medium.

Input Parameters

mediumuu(Dielectric): The dielectric media making up the U entry of the diagonal matrix.
mediumvv(Dielectric): The dielectric media making up the V entry of the diagonal matrix.
mediumnn(Dielectric): The dielectric media making up the N entry of the diagonal matrix.

Return

AnisotropicDielectric: The 3D anisotropic medium.

Contains (label string)

Checks if the collection contains an item with the given label.

Input Parameters

label(string): The label of the item.

Return

boolean: The success of the check.

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.

Item (index number)

Returns the AnisotropicDielectric for the given index in the collection.

Input Parameters

index(number): The index of the AnisotropicDielectric.

Return

AnisotropicDielectric: The item in the collection

Item (label string)

Returns the AnisotropicDielectric for the given label in the collection.

Input Parameters

label(string): The label of the AnisotropicDielectric.

Return

AnisotropicDielectric: The item in the collection

Items ()

Returns a table of AnisotropicDielectric items.

Return

UnsupportedType(List of AnisotropicDielectric): The list of items in the collection

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.

UniqueName (label string)

Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated.

Input Parameters

label(string): The base name.

Return

string: The generated unique name label for the item.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.