Package comsolbuilder

Class ComsolBuilder

  • public class ComsolBuilder
extends java.lang.Object
    An instance of the ComsolBuilder class is an object which can build a COMSOL model. The purpose of This class is to abstract away the nasty COMSOL API calls.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.Double currentHeight
      Height (in nm) along the z direction.
      com.comsol.model.Model model
      COMSOL model that will be saved as a .mph file.
      java.lang.String xDim
      Length (in nm) along the x direction.
      java.lang.String yDim
      Length (in nm) along the y direction.

    • Constructor Summary

      Constructors 
      Constructor Description
      ComsolBuilder​(java.lang.Double xDimInput, java.lang.Double yDimInput)
      The constructor for the ComsolBuilder object.

    • Method Summary

      Modifier and Type Method Description
      void addElectrodesDXF​(java.lang.String dxfFile, java.lang.String[] dxfLayers, java.lang.Double[] dxfLayerHeights)
      Imports and extrudes DXF File (without scale factor)
      void addElectrodesDXF​(java.lang.String dxfFile, java.lang.String[] dxfLayers, java.lang.Double[] dxfLayerHeights, java.lang.Double scale)
      Imports and extrudes DXF File
      void addElectrodesSTL​(java.lang.String stlFolder, java.lang.Double startHeight)
      Imports and extrudes STL File (without scale factor)
      void addElectrodesSTL​(java.lang.String stlFolder, java.lang.Double startHeight, int scale)
      Imports stl files.
      void addHeterostructure​(java.lang.String[] layerLabels, java.lang.String[] layerHeights)
      Adds layers to comsol model.
      void addMaterial​(ComsolMaterial mat, java.lang.String domain)
      Associates a material with a domain within the model
      void selectVoltages​(java.lang.String totalDomain)
      Creates a potential node in COMSOL for each domain in the domain group.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • model

        public com.comsol.model.Model model
        COMSOL model that will be saved as a .mph file.

      • xDim

        public java.lang.String xDim
        Length (in nm) along the x direction.

      • yDim

        public java.lang.String yDim
        Length (in nm) along the y direction.

      • currentHeight

        public java.lang.Double currentHeight
        Height (in nm) along the z direction.

    • Constructor Detail

      • ComsolBuilder

        public ComsolBuilder​(java.lang.Double xDimInput,
                     java.lang.Double yDimInput)
        The constructor for the ComsolBuilder object.
        Parameters:
        xDimInput - Length (in nm) along the x direction.
        yDimInput - Length (in nm) along the y direction.

    • Method Detail

      • addHeterostructure

        public void addHeterostructure​(java.lang.String[] layerLabels,
                               java.lang.String[] layerHeights)
        Adds layers to comsol model.
        Parameters:
        layerLabels - Labels of layers used.
        layerHeights - Height (in nm) of each layer.

      • addElectrodesDXF

        public void addElectrodesDXF​(java.lang.String dxfFile,
                             java.lang.String[] dxfLayers,
                             java.lang.Double[] dxfLayerHeights,
                             java.lang.Double scale)
        Imports and extrudes DXF File
        Parameters:
        dxfFile - Path to dxf file (cannot be a relative path).
        dxfLayers - Names of layers in dxf file, in the order that they should be built.
        dxfLayerHeights - Height of each layer.
        scale - Factor to scale DXF file (e.g. 1000 to transfer from um to nm).

      • addElectrodesDXF

        public void addElectrodesDXF​(java.lang.String dxfFile,
                             java.lang.String[] dxfLayers,
                             java.lang.Double[] dxfLayerHeights)
        Imports and extrudes DXF File (without scale factor)
        Parameters:
        dxfFile - Path to dxf file (cannot be a relative path).
        dxfLayers - Names of layers in dxf file, in the order that they should be built.
        dxfLayerHeights - Height of each layer.

      • addElectrodesSTL

        public void addElectrodesSTL​(java.lang.String stlFolder,
                             java.lang.Double startHeight,
                             int scale)
        Imports stl files.
        Parameters:
        stlFolder - Path to folder containing stl files (cannot be a relative path).
        startHeight - Height (in nm) at which the electrodes start.
        scale - Factor to scale STL file (e.g. 1000 to transfer from um to nm).

      • addElectrodesSTL

        public void addElectrodesSTL​(java.lang.String stlFolder,
                             java.lang.Double startHeight)
        Imports and extrudes STL File (without scale factor)
        Parameters:
        stlFolder - Path to folder containing stl files (cannot be a relative path).
        startHeight - Height (in nm) at which the electrodes start.

      • addMaterial

        public void addMaterial​(ComsolMaterial mat,
                        java.lang.String domain)
        Associates a material with a domain within the model
        Parameters:
        mat - Material.
        domain - Domain.

      • selectVoltages

        public void selectVoltages​(java.lang.String totalDomain)
        Creates a potential node in COMSOL for each domain in the domain group.
        Parameters:
        totalDomain - Domain group of electrodes.