# PLaSK User Manual

#### Page Contents

- `thermal`
  - Solver classes
  - Functions
  - Descriptions
    - Function Details
      - `Dynamic2D()`
      - `Dynamic3D()`
      - `DynamicCyl()`
      - `Static2D()`
      - `Static3D()`
      - `StaticCyl()`

# `thermal`

Thermal solvers.

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

Example

    >>> import thermal
    >>> thermal.Dynamic3D('mysolver')
    <thermal.dynamic.Dynamic3D at 0x42ac2b8>

## Solver classes

`static.Static2D`([name]) | Finite element thermal solver for 2D Cartesian Geometry.
`static.StaticCyl`([name]) | Finite element thermal solver for 2D cylindrical Geometry.
`static.Static3D`([name]) | Finite element thermal solver for 3D Geometry.
`dynamic.Dynamic2D`([name]) | Finite element thermal solver for 2D Cartesian geometry.
`dynamic.DynamicCyl`([name]) | Finite element thermal solver for 2D cylindrical geometry.
`dynamic.Dynamic3D`([name]) | Finite element thermal solver for 3D Cartesian geometry.

## Functions

`Dynamic2D`([name]) | Create Dynamic2D solver.
`Dynamic3D`([name]) | Create Dynamic3D solver.
`DynamicCyl`([name]) | Create DynamicCyl solver.
`Static2D`([name]) | Create Static2D solver.
`Static3D`([name]) | Create Static3D solver.
`StaticCyl`([name]) | Create StaticCyl solver.

## Descriptions

### Function Details

thermal.Dynamic2D(name='')

  Create Dynamic2D solver.

  This function automatically loads `dynamic` submodule and creates `Dynamic2D` class.

  Parameters:

    name (str) – Solver name.

thermal.Dynamic3D(name='')

  Create Dynamic3D solver.

  This function automatically loads `dynamic` submodule and creates `Dynamic3D` class.

  Parameters:

    name (str) – Solver name.

thermal.DynamicCyl(name='')

  Create DynamicCyl solver.

  This function automatically loads `dynamic` submodule and creates `DynamicCyl` class.

  Parameters:

    name (str) – Solver name.

thermal.Static2D(name='')

  Create Static2D solver.

  This function automatically loads `static` submodule and creates `Static2D` class.

  Parameters:

    name (str) – Solver name.

thermal.Static3D(name='')

  Create Static3D solver.

  This function automatically loads `static` submodule and creates `Static3D` class.

  Parameters:

    name (str) – Solver name.

thermal.StaticCyl(name='')

  Create StaticCyl solver.

  This function automatically loads `static` submodule and creates `StaticCyl` class.

  Parameters:

    name (str) – Solver name.