Material Library

Overview

The material library is an object that holds a dictionary of Material objects. Internaly, each material is stored using a unique material number that gets assigned whenever a material is instantiated.

This library is stored internaly in a LayerStack to be usedby multiple LayerInfo objects when determining properties of substrate, background, base and cladding materials.

Alternatively the user can use this object to collect and organize multiple material objects. You can check examples down below on how to add and retrieve the material objects. However, most solvers will rely on a LayerStack object that itself controls its own instance of the MaterialLibrary.

Material Models

Following is a list of material models that can be used to define material properties. Cehck them out for details and usage examples.

• Material Base Class
  • Overview
  • Examples
• Constant Material Model
  • Overview
  • Examples
  • Usage Notes
• Sellmeier Material Model
  • Overview
  • Typical Use Case
  • Examples
• Experimental Material Model
  • Overview
  • Examples

Example

This main example covers the instantiation of a library plus ways of adding and getting material from it. for more deatail please check the API documentation.

from pyOptiShared.Material import MaterialLibrary
from pyOptiShared.Material import ConstMaterial

# Instantiates the Library
library = MaterialLibrary()

# Creates a constant material
material = ConstMaterial("my_material", epsReal=3.45, epsImag=0.001)

# Adds the material to the library
library.addMaterial(material)

# Get the material library as a dictionary
mat_dict = library.getMatDict()
print(mat_dict)

# Get 'my_material' from the library
my_material = library.getMaterialFromName("my_material")

# Get 'Air' a default const material number 2 from the library
air_material = library.getMaterialFromNum(2)

API Documentation

pyOptiShared.Material.MaterialLibrary()	Material library class holds a list of materials
pyOptiShared.Material.Material(mat_name)	Material base class.
pyOptiShared.Material.ConstMaterial(mat_name)	Material object for constant permittivity.
pyOptiShared.Material.SellmeierMaterial(mat_name)	A Sellmeier material class.
pyOptiShared.Material.ExperimentalMaterial(...)	A material defined by experimental data.