# PLaSK User Manual

#### Page Contents

- `meta`
  - Solver classes
  - Functions
  - Descriptions
    - Function Details
      - `ThermoElectric2D()`
      - `ThermoElectric3D()`
      - `ThermoElectricCyl()`
      - `ThresholdSearch2D()`
      - `ThresholdSearchBesselCyl()`
      - `ThresholdSearchCyl()`
      - `ThresholdSearchFourier2D()`

# `meta`

Meta solvers.

This package combines all meta solvers and helper functions that can create solver classes without a need to explicitly import the proper binary module.

Example

    >>> import meta
    >>> meta.ThresholdSearchFourier2D('mysolver')
    <meta.shockley.ThresholdSearchFourier2D at 0x42ac2b8>

## Solver classes

`shockley.ThermoElectric2D`(name) | Thermo-electric calculations solver without the optical part.
`shockley.ThermoElectricCyl`(name) | Thermo-electric calculations solver without the optical part.
`shockley.ThermoElectric3D`(name) | Thermo-electric calculations solver without the optical part.
`shockley.ThresholdSearchCyl`([name]) | Solver for threshold search of semiconductor laser.
`shockley.ThresholdSearchBesselCyl`([name]) | Solver for threshold search of semiconductor laser with vector optical solver.
`shockley.ThresholdSearch2D`([name]) | Solver for threshold search of semiconductor laser.
`shockley.ThresholdSearchFourier2D`([name]) | Solver for threshold search of semiconductor laser.

## Functions

`ThermoElectric2D`([name]) | Create ThermoElectric2D solver.
`ThermoElectric3D`([name]) | Create ThermoElectric3D solver.
`ThermoElectricCyl`([name]) | Create ThermoElectricCyl solver.
`ThresholdSearch2D`([name]) | Create ThresholdSearch2D solver.
`ThresholdSearchBesselCyl`([name]) | Create ThresholdSearchBesselCyl solver.
`ThresholdSearchCyl`([name]) | Create ThresholdSearchCyl solver.
`ThresholdSearchFourier2D`([name]) | Create ThresholdSearchFourier2D solver.

## Descriptions

### Function Details

meta.ThermoElectric2D(name='')

  Create ThermoElectric2D solver.

  This function automatically loads `shockley` submodule and creates `ThermoElectric2D` class.

  Parameters:

    name (str) – Solver name.

meta.ThermoElectric3D(name='')

  Create ThermoElectric3D solver.

  This function automatically loads `shockley` submodule and creates `ThermoElectric3D` class.

  Parameters:

    name (str) – Solver name.

meta.ThermoElectricCyl(name='')

  Create ThermoElectricCyl solver.

  This function automatically loads `shockley` submodule and creates `ThermoElectricCyl` class.

  Parameters:

    name (str) – Solver name.

meta.ThresholdSearch2D(name='')

  Create ThresholdSearch2D solver.

  This function automatically loads `shockley` submodule and creates `ThresholdSearch2D` class.

  Parameters:

    name (str) – Solver name.

meta.ThresholdSearchBesselCyl(name='')

  Create ThresholdSearchBesselCyl solver.

  This function automatically loads `shockley` submodule and creates `ThresholdSearchBesselCyl` class.

  Parameters:

    name (str) – Solver name.

meta.ThresholdSearchCyl(name='')

  Create ThresholdSearchCyl solver.

  This function automatically loads `shockley` submodule and creates `ThresholdSearchCyl` class.

  Parameters:

    name (str) – Solver name.

meta.ThresholdSearchFourier2D(name='')

  Create ThresholdSearchFourier2D solver.

  This function automatically loads `shockley` submodule and creates `ThresholdSearchFourier2D` class.

  Parameters:

    name (str) – Solver name.