addmaterial - Script command
Adds a new material to the material database given the material model or type and returns the name of the new material. For details on available material models see: Material permittivity models and Material conductivity models .
| Syntax | Description |
|---|---|
| ?addmaterial; | Lists all available material models that can be added into the material database. |
| out = addmaterial("materialtype"); | Adds a new material and returns the name of the new material. The argument "materialtype" has to match correct string exactly. |
Example
These commands add a new Conductive material, set the name to "aluminum", anisotropy to "Diagonal", and set the permittivity as well as conductivity properties for the material.
A=[4;5;6];
B=[1;2;3];
mymaterial = addmaterial("Conductive");
setmaterial(mymaterial,"name","Aluminum");
setmaterial("Aluminum", "Anisotropy", 1); # enable diagonal anisotropy
setmaterial("Aluminum","Permittivity", A);
setmaterial("Aluminum","Conductivity", B);
copymaterial - Script command
Makes a copy of a material in the material database.
| Syntax | Description |
|---|---|
| out = copymaterial("materialname"); | Creates a copy of the material "materialname". The new name is returned. |
setmaterial - Script command
Sets properties of a material in the material database. This command can only edit the properties of the materials that are NOT write protected.
| Syntax | Description |
|---|---|
| ?setmaterial("materialname"); | Displays the property names of the specified material that can be modified. |
| setmaterial( "materialname", "propertyname", newvalue); | Sets the property named "propertyname" of the material with the name "materialname" to newvalue. The argument newvalue can be a number or a string. The arguments "propertyname" and "materialname" have to match correct string exactly. For example, setmaterial("Si","Mesh order",4); will set the property "mesh order" of the materials "Si" to 4. |
| setmaterial( "materialname", struct); | Update multiple material properties at the same time using a struct of associated properties. Keys are given the respective "propertyname", and values assigned to the new value. |
Example using struct
# create a material
setmaterial(addmaterial("(n,k) Material"), "name", "myMaterial");
# set the material properties
setmaterial("myMaterial", {"Refractive Index": 1.3, "Imaginary Refractive Index": 1.5});
Conductive material example
This example adds a new Conductive material, sets the name to "myMaterial", anisotropy to "Diagonal", and sets the permittivity and conductivity properties for the material.
A=[4;5;6];
B=[1;2;3];
temp = addmaterial("Conductive");
setmaterial(temp,"name","myMaterial");
setmaterial("myMaterial", "Anisotropy", 1); # enable diagonal anisotropy
setmaterial("myMaterial","Permittivity", A);
setmaterial("myMaterial","Conductivity", B);
Sampled data material example
This example shows how to create a new Sampled data material.
The sampled data matrix must have 2 or 4 columns, for isotropic or anisotropic materials. The first column is the frequency vector, in Hz. The next column(s) are the complex valued permittivity.
If you have refractive index data (rather than permittivity), remember that permittivity is simply the square of the refractive index.
f = linspace(1000e12,300e12,30); # frequency vector
eps = 2 + 1i*(1e6 / (2*pi*f*eps0)); # create example permittivity vector
sampledData = [f,eps]; # collect f and eps in one matrix
matName = "My material";
temp = addmaterial("Sampled data");
setmaterial(temp,"name",matName); # rename material
setmaterial(matName,"max coefficients",2); # set the number of coefficients
setmaterial(matName,"sampled data",sampledData); # load the sampled data matrix
Index perturbation material example
This example shows how to create a new Index perturbation material.
The Index perturbation material can define index perturbation for "np Density" and/or "Temperature". For a "np Density" index perturbation:
- "np density model": takes an integer or string values of [0, 1, 2], 'Drude', 'Soref and Bennet' or 'Custom'
- for model type "Custom": "n sensitivity table" and "p sensitivity table" take a matrix argument
For a "Temperature" index perturbation:
- for model type "Linear sensitivity": users need to set individual values for 'Tref', 'dn/dt' and 'dk/dt'
- for model type "Table of values": "temperature sensitivity table" takes a matrix argument
nSensitivity = [1.5, 1.5e-3, 1.5e-3; 1.6, 1.6e-3, 1.6e-3; 1.7, 1.7e-3, 1.7e-3];
pSensitivity = [1, 1e-3, 1e-3; 1.2, 1.2e-3, 1.2e-3; 1.4, 1.4e-3, 1.4e-3];
matName = "May material";
temp = addmaterial("Index perturbation");
setmaterial(temp, "name", matName);
setmaterial(matName, "np density model", "Custom"); # use "Custom" model type
setmaterial(matName, "n sensitivity table", nSensitivity); # set n sensitivity table
setmaterial(matName, "p sensitivity table", pSensitivity); # set p sensitivity table
It is possible to define the color of the material using command lines. Here is an example, open a brand new project file, enter these command lines and it will create a material, define the color and assign that material to a rectangle to show you the color change. The 4 elements are for red, green, blue, alpha channel. These elements can be set between 0 to 1, which represents a minimum of 0 and maximum of 255 . Alpha defines the opacity, setting ti to 0 means transparent, 1 means a solid color. Note that the opacity can be also defined in the structure object, by overriding the material properties.
mymaterial = addmaterial("PEC");
setmaterial(mymaterial,"name", "test_material");
setmaterial("test_material", "color", [1; 0.6; 0.4; 0.3] ); # R, G, B, alpha channel
addrect;
set("material", "test_material");
set("override color opacity from material database", 0);
getmaterial - Script command
Returns properties of a material in the material database.
| Syntax | Description |
|---|---|
| ?getmaterial( "materialname"); | Displays the property names of the specified material that can be modified. |
| out = getmaterial( "materialname", "propertyname"); | Returns the property named "propertyname" of the material with the name "materialname". The returned variable is either a matrix or a string, depending on the property in the query. |
| out = getmaterial( "materialname", cell); | Return multiple properties, by passing a cell with entries equal to "propertyname". In this case out will be a struct with keys equal to the "propertyname" entries in the cell. |
Examples
These commands add a new Conductive material, set the name to "aluminum", anisotropy to "Diagonal", and set the permittivity as well as conductivity properties for the material. The command getmaterial() is then used to find the permittivity of the material.
A=[4;5;6];
B=[1;2;3];
mymaterial = addmaterial("Conductive");
setmaterial(mymaterial,"name","Aluminium");
setmaterial("Aluminum", "Anisotropy", 1); # enable diagonal anisotropy
setmaterial("Aluminum","Permittivity", A);
setmaterial("Aluminum","Conductivity", B);
?getmaterial("Aluminum","Permittivity");
result:
4 5 6
#Using cell array
props = cell(2);
props{1} = "Permittivity"; props{2} = "Conductivity";
Al_vals = getmaterial("Aluminum",props);
?Al_vals.Conductivity;
result:
1 2 3
This example shows how to access raw data from a Sampled data material.
| Note: Sampled data matrix format The sampled data matrix has 2 or 4 columns, for isotropic or anisotropic materials - The first column is the frequency vector, in Hz. - The next column(s) are the complex valued permittivity. If you want refractive index data (rather than permittivity), remember that permittivity is simply the square of the refractive index. |
matName = "Ag (Silver) - CRC";
?getmaterial(matName);
maxCoeff = getmaterial(matName,"max coefficient");
sampledData = getmaterial(matName,"sampled data");
# convert sampledData matrix to refractive index
f1 = pinch(sampledData,2,1); # first column
eps = pinch(sampledData,2,2); # second column
nk1 = sqrt(eps);
# use getindex command for comparison
f2 = linspace(100e12,1000e12,100);
nk2 = getindex(matName,f2);
plotxy(c/f1*1e6,real(nk1),
c/f1*1e6,imag(nk1),
c/f2*1e6,real(nk2),
c/f2*1e6,imag(nk2),
"wavelength (um)","refractive index");
legend("n - getmaterial",
"k - getmaterial",
"n - getindex",
"k - getindex");
importmaterialdb - Script command
Imports the material database from a .mdf file.
| Syntax | Description |
|---|---|
| importmaterialdb("filename.mdf"); | Imports the material database from a file named "filename.mdf". |
exportmaterialdb - Script command
Exports the material database to a .mdf file.
| Syntax | Description |
|---|---|
| exportmaterialdb("filename.mdf"); | Exports the entire material database to a file named "filename.mdf". |
| exportmaterialdb("filename.mdf","material_name"); | Exports single material. The "material_name" argument defines the name of the material in the material database whose properties will be exported. |
| exportmaterialdb("filename.mdf, {"material_name1","material_name2",..."material_namen"}); | Exports multiple materials. The array (cell) of strings defines the names of the materials in the material database whose properties will be exported. |
getindex - Script command
FDTD MODE DGTD CHARGE HEAT FEEM
Returns the complex refractive index of a material in the material database. The refractive index at the specified frequency is linearly interpolated from the neighboring frequencies where the data is available.
| Syntax | Description |
|---|---|
| out = getindex("materialname", f); | Returns the complex index of the material with the given name. The index is returned for the specified frequency f. Frequency f is in Hz. |
| getindex("materialname", f, component); | Optional argument component can be 1, 2 or 3 to specify the x, y or z component for anisotropic materials. The default is 1. |
Example
This example shows how to get material (n,k) data with the getindex and getfdtdindex functions. In this case, we compare the experimental data to the fit of the that data that will be used in the simulation.
material="Au (Gold) - CRC"; # material
source_min_f=c/700e-9; # source min frequency
source_max_f=c/400e-9; # source max frequency
f_vector=linspace(source_max_f,source_min_f,100);
# get experimental data
n_exp=getindex(material,f_vector);
# get FDTD fit of experimental data
n_fdtd=getfdtdindex(material,f_vector,source_min_f,source_max_f);
# plot results
plot(c/f_vector*1e9,real(n_exp),real(n_fdtd),"wavelenth (nm)","n",material);
legend("experimental data","FDTD fit");
plot(c/f_vector*1e9,imag(n_exp),imag(n_fdtd),"wavelenth (nm)","k",material);
legend("experimental data","FDTD fit");
# output index data to text file
data=matrix(100,5);
data(1:100,1)=c/f_vector*1e9;
data(1:100,2)=real(n_exp);
data(1:100,3)=imag(n_exp);
data(1:100,4)=real(n_fdtd);
data(1:100,5)=imag(n_fdtd);
write(material+".txt","wavelength_nm exp_n exp_k fdtd_n fdtd_k");
write(material+".txt",num2str(data));
getfdtdindex - Script command
Returns the complex refractive index of a material in the database with material fit that will be used in a simulation in FDTD.
Many materials (such as Sampled materials) have properties that depend on frequency. Using getfdtdindex, you can specify frequency range, and the fitting routine will find a best fit of the material data over that range. The refractive index evaluated at the specified frequencies is then returned.
Note that the fit result depends on the fit parameters, Max coefficients and Tolerance set for the material, thus getfdtdindex result depends on those parameters as well. Tips for setting these parameters can be found at Modifying the material fits .
| Syntax | Description |
|---|---|
| out = getfdtdindex( "materialname", f, fmin, fmax); | Returns the complex index of the material with the given name. The index is returned for the specified frequency f. Similar to getindex, but you also specify fmin and fmax, the span of frequency of the FDTD simulation. All frequency units are in Hz. |
| getfdtdindex("materialname", f,fmin, fmax, component); | Optional argument component can be 1, 2 or 3 to specify the x, y or z component for anisotropic materials. The default is 1. |
Examples
This example shows how to get material (n,k) data with the getindex and getfdtdindex functions. In this case, we compare the experimental data to the FDTD fit of the that data that will be used in the simulation.
material="Au (Gold) - CRC"; # material
source_min_f=c/700e-9; # source min frequency
source_max_f=c/400e-9; # source max frequency
f_vector=linspace(source_max_f,source_min_f,100);
# get experimental data
n_exp=getindex(material,f_vector);
# get FDTD fit of experimental data
n_fdtd=getfdtdindex(material,f_vector,source_min_f,source_max_f);
# plot results
plot(c/f_vector*1e9,real(n_exp),real(n_fdtd),"wavelenth (nm)","n",material);
legend("experimental data","FDTD fit");
plot(c/f_vector*1e9,imag(n_exp),imag(n_fdtd),"wavelenth (nm)","k",material);
legend("experimental data","FDTD fit");
# output index data to text file
data=matrix(100,5);
data(1:100,1)=c/f_vector*1e9;
data(1:100,2)=real(n_exp);
data(1:100,3)=imag(n_exp);
data(1:100,4)=real(n_fdtd);
data(1:100,5)=imag(n_fdtd);
write(material+".txt","wavelength_nm exp_n exp_k fdtd_n fdtd_k");
write(material+".txt",num2str(data));
This example shows how to get the permittivity of a material. The getfdtdindex and getindex functions always return the material index, so we must apply eps = n^2 to get the permittivity.
material="Au (Gold) - CRC"; # material source_min_f=c/700e-9; # source min frequency source_max_f=c/400e-9; # source max frequency f_vector=linspace(source_max_f,source_min_f,100); # get (n,k) data n_fdtd=getfdtdindex(material,f_vector,source_min_f,source_max_f); # get permittivity data eps_fdtd=n_fdtd^2;
getdgtdindex - Script command
Returns the complex refractive index of a material in the Materials Group with material fit that will be used in a DGTD simulation.
Many materials (such as sampled materials) have properties that depend on frequency. Using getdgtdindex, you can specify frequency range, and the fitting routine will find a best fit of the material data over that range. The refractive index evaluated at the specified frequencies is then returned.
Note that the fit result depends on the fit parameters, Max coefficients and Tolerance set for the material, thus getdgtdindex result depends on those parameters as well. Tips for setting these parameters can be found at Modifying the material fits .
| Syntax | Description |
|---|---|
| out = getdgtdindex( "materialname", f, fmin, fmax); | Returns the complex index of the material with the given name. The index is returned for the specified frequency f. Similar to getindex, but you also specify fmin and fmax, the span of frequency of the DGTD simulation. All frequency units are in Hz. |
Examples
This example shows how to get material (n,k) data with the getindex and getdgtdindex functions. In this case, we compare the experimental data to the DGTD fit of the that data that will be used in the simulation.
Note that the material "Au (Gold) - CRC" with optical material properties must already exist in the Materials Group before running the script.
material="Au (Gold) - CRC"; # material
source_min_f=c/700e-9; # source min frequency
source_max_f=c/400e-9; # source max frequency
f_vector=linspace(source_max_f,source_min_f,100);
# get experimental data
n_exp=getindex(material,f_vector);
# get DGTD fit of experimental data
n_dgtd=getdgtdindex(material,f_vector,source_min_f,source_max_f);
# plot results
plot(c/f_vector*1e9,real(n_exp),real(n_dgtd),"wavelenth (nm)","n",material);
legend("experimental data","DGTD fit");
plot(c/f_vector*1e9,imag(n_exp),imag(n_dgtd),"wavelenth (nm)","k",material);
legend("experimental data","DGTD fit");
# output index data to text file
data=matrix(100,5);
data(1:100,1)=c/f_vector*1e9;
data(1:100,2)=real(n_exp);
data(1:100,3)=imag(n_exp);
data(1:100,4)=real(n_dgtd);
data(1:100,5)=imag(n_dgtd);
write(material+".txt","wavelength_nm exp_n exp_k dgtd_n dgtd_k");
write(material+".txt",num2str(data));
getmodeindex - Script command
This function returns the material index of a material in the database as it will be used in an actual MODE simulation.
Many materials (such as Sampled Materials) have properties that depend on frequency. Using getmodeindex, you can obtain the refractive index as a function of the specified frequency, f, as it will be used in MODE calculations.
Note that the fit result depends on the fit parameters, Max coefficients and Tolerance set for the material, thus getfdtdindex result depends on those parameters as well. Tips for setting these parameters can be found at Modifying the material fits .
| Syntax | Description |
|---|---|
| out = getmodeindex( "materialname", f); | Returns the complex index of the material with the given name. The index is returned for the specified frequency f. This result is identical to getindex unless the optional arguments fitsampled and fitanalytic are used. All frequency units are in Hz. |
| getmodeindex("materialname", f,component); | Optional argument component can be 1, 2 or 3 to specify the x, y or z component for anisotropic materials. The default is 1. |
| getmodeindex("materialname", f,component, fitsampled, fitanalytic, fmin, fmax); | Optional arguments to specify if Sampled Materials or Analytic Materials should be fitted using Lumerical's multi-coefficient model (MCM), which is commonly used in FDTD simulations. If either of these options are set to 1 (true) then you must supply a minimum and maximum frequency for fitting. The MCM is typically used in MODE for
The default values are 0 (false) for fitsampled and fitanalytic. |
Example
This example shows how to get material (n,k) data with the getindex and getmodeindex functions. In this case, we compare the experimental data to the MODE multi-coefficient fit of the that data that would be used in the simulation.
material="Si (Silicon) - Palik"; # material
source_min_f=c/700e-9; # source min frequency
source_max_f=c/400e-9; # source max frequency
f_vector=linspace(source_max_f,source_min_f,100);
# get experimental data
n_exp=getindex(material,f_vector);
# get MODE multi-coefficient fit of experimental data
n_mode=getmodeindex(material,f_vector,1,1,0,source_min_f,source_max_f);
# plot results
plot(c/f_vector*1e9,real(n_exp),real(n_mode),"wavelenth (nm)","n",material);
legend("experimental data","MODE fit");
plot(c/f_vector*1e9,imag(n_exp),imag(n_mode),"wavelenth (nm)","k",material);
legend("experimental data","MODE fit");
getnumericalpermittivity - Script command
This advanced function returns the permittivity of a material in the database as it will be used in an actual FDTD simulation, including the effects of a finite time step, dt. In FDTD, the relationship between the displacement field, D, and the electric field, E, is given by
→D(ω)=ε0εγ(ω,dt)→E(ω)
In the limit where dt tends to zero, we have
limdt→0εr(ω,dt)=n2(ω)
where n( ω ) is the refractive index returned by the script function getfdtdindex, or shown in the Materials Explorer. If you set dt to zero when calling this function, it will return exactly the same result as the square of getfdtdindex.
The name of the function is a reminder that it returns the numerical permittivity, i.e., the ratio of D and E, which is different from the refractive index, i.e. the ratio of the speed of light in a vacuum to the phase velocity of light in the medium. To understand the relationship between them, we must consider the full, numerical dispersion relation between ω and k, which is given by
εr(ω,dt)[1cdtsin(ωdt2)]2=[1dxsin(kxdx2)]2+[1dysin(kydy2)]2+[1dzsin(kzdz2)]2
In the limit where dt, dx, dy and dz tend to zero, it is easy to show that we have the expected result
ω=ck√εr(ω,dt=0)=ckn(ω)
The spatial FDTD mesh and time step are generally chosen to obtain a desired level of simulation accuracy, essentially by ensuring that the arguments of the sine functions are sufficiently small that sin(x)~x and that the simulation is stable. For some materials, it may be desired to further reduce the value of the time step, dt, without modifying the spatial FDTD mesh, in order to obtain a higher level of accuracy for ε r ( ω ,dt). This script function makes it possible to calculate, in advance, the value of dt required to obtain the desired accuracy for the permittivity.
The results from getnumericalpermittivity will be different if the Broadband Fixed Angle Source Technique (BFAST) is used. Since the script function does not require a calculation being performed beforehand, the user needs to specify if the computation uses BFAST or not. See the BFAST page for more details about this technique.
| Syntax | Description |
|---|---|
| out = getnumericalpermittivity ( "materialname", f, fmin, fmax, dt); | Returns the complex permittivity of the material with the given name. The permittivity is returned for the specified frequency f. This is similar to getfdtdindex except for the additional parameter dt. All frequency units are in Hz. |
| getnumericalpermittivity("materialname", f,fmin, fmax, dt, component); | Optional argument component can be 1, 2 or 3 to specify the x, y or z component for anisotropic materials. The default is 1. |
| getnumericalpermittivity("materialname", f,fmin, fmax, dt, component, use_bfast); | Optional argument use_bfast can be 0 or 1. It indicates whether the simulation is performed using the Broadband Fixed Angle Source Technique (BFAST) or not. The default is 0. |
Examples
This example shows how to get the material permittivity with the getindex, getfdtdindex and getnumerical permittivity functions. In this case, we compare the experimental permittivity data to the theoretical FDTD fit of the that data as well as to the numerical permittivity that will result using a finite value of dt.
material="Si (Silicon) - Palik"; # material
source_min_f=c/800e-9; # source min frequency
source_max_f=c/200e-9; # source max frequency
f_vector=linspace(source_max_f,source_min_f,100);
component = 1; # desired permittivity component x (1), y (2) or z (3). Relevant for anisotropic materials, default 1
use_bfast = 0; # Change to 1 if using BFAST, default 0
# get experimental data
eps_exp=(getindex(material,f_vector))^2;
# get FDTD fit of experimental data
eps_fit=(getfdtdindex(material,f_vector,source_min_f,source_max_f))^2;
# get the numerical FDTD result for 3 different values of dt
Tmin = 1/max(f_vector);
dt = Tmin * [ 0.1; 0.05; 0.01 ];
# alternate way to get dt values: 100%, 10%, 1% of current dt value
# dt = getnamed("FDTD","dt");
# dt = [dt; dt*0.1; dt*0.01];
eps_numerical1=getnumericalpermittivity(material,f_vector,source_min_f,source_max_f,dt(1),component,use_bfast);
eps_numerical2=getnumericalpermittivity(material,f_vector,source_min_f,source_max_f,dt(2),component,use_bfast);
eps_numerical3=getnumericalpermittivity(material,f_vector,source_min_f,source_max_f,dt(3),component,use_bfast);
# plot results
if (use_bfast==1){fdtd_method = "FDTD - BFAST";}
else{fdtd_method = "FDTD";}
plot(c/f_vector*1e9,real(eps_exp),real(eps_fit),
real(eps_numerical1),
real(eps_numerical2),
real(eps_numerical3),
"wavelenth (nm)","Re(eps)",material);
legend("experimental data","FDTD fit",
fdtd_method+", dt="+num2str(dt(1)*1e15)+"fs",
fdtd_method+", dt="+num2str(dt(2)*1e15)+"fs",
fdtd_method+", dt="+num2str(dt(3)*1e15)+"fs");
plot(c/f_vector*1e9,imag(eps_exp),imag(eps_fit),
imag(eps_numerical1),
imag(eps_numerical2),
imag(eps_numerical3),"wavelenth (nm)","Im(eps)",material);
legend("experimental data","FDTD fit",
fdtd_method+", dt="+num2str(dt(1)*1e15)+"fs",
fdtd_method+", dt="+num2str(dt(2)*1e15)+"fs",
fdtd_method+", dt="+num2str(dt(3)*1e15)+"fs");
deletematerial - Script command
Deletes a material from the material database.
| Syntax | Description |
|---|---|
| deletematerial("materialname"); | Deletes a material named "materialname" from the material database. |
materialexists - Script command
FDTD MODE DGTD CHARGE HEAT FEEM
Returns a boolean indicating whether or not a material exists in the material database.
| Syntax | Description |
|---|---|
| materialexists("materialname"); | Returns 1 if the material named "materialname" is present in the material database. Otherwise return 0. |
getsurfaceconductivity - Script command
For materials which use a surface conductivity material model (such as Graphene), this function returns the complex index of any material that is in the material database. The surface conductivity at the specified frequency is interpolated from the neighboring frequencies where the conductivity data is available. For a list of materials which use the surface conductivity model, see Material conductivity models .
| Syntax | Description |
|---|---|
| out = getsurfaceconductivity( "materialname", f); | Returns the surface conductivity (in units of S) of the material with the given name. The surface conductivity is returned for the specified frequency f where f is in units of Hz. |
| getsurfaceconductivity( "materialname", f, component); | Optional argument component can be 1, 2 or 3 to specify the x, y or z component for anisotropic materials. The default is 1. |
getfdtdsurfaceconductivity - Script command
For materials which use a surface conductivity material model (such as Graphene), this function returns the surface conductivity of the material in the database as it will be used in an actual simulation. For a list of materials which use the surface conductivity model, see Material conductivity models .
The conductivity evaluated at the specified frequencies is returned. Note that the fit result depends on the fit parameters, Max coefficients and Tolerance set for the material, thus getfdtdsurfaceconductivity result depends on those parameters as well.
| Syntax | Description |
|---|---|
| out = getfdtdsurfaceconductivity( "materialname", f, fmin, fmax); | Returns the surface conductivity (in units of S) of the material with the given name. The surface conductivity is returned for the specified frequency f. Similar to getsurfaceconductivity, but you also specify fmin and fmax, the span of frequency range of the simulation. All frequency units are in Hz. |
| getfdtdsurfaceconductivity("materialname", f,fmin, fmax, component); | Optional argument component can be 1, 2 or 3 to specify the x, y or z component for anisotropic materials. The default is 1. |
874
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
