# PLaSK User Manual

#### Page Contents

- MaterialsDB Class
  - `MaterialsDB`
  - Methods
  - Descriptions
    - Method Details
      - `MaterialsDB.__call__()`
      - `MaterialsDB.clear()`
      - `MaterialsDB.get()`
      - `MaterialsDB.info()`
      - `MaterialsDB.is_alloy()`
      - `MaterialsDB.material_with_params()`
      - `MaterialsDB.remove()`
      - `MaterialsDB.update()`

# MaterialsDB Class

class plask.material.MaterialsDB

  Container of all materials

## Methods

`__call__`(*args, **kwargs) | rtype: Material
`clear`() | Clear the database.
`get`(*args, **kwargs) | Get material of given name and doping.
`info`(name) | Get information dictionary on built-in material.
`is_alloy`(name) | Return `True` if the specified material is an alloy one.
`material_with_params`(*args, **kwargs) | Get material with constant parameters specified as kwargs
`remove`(name) | Remove material of given name and doping from database.
`update`(src) | Update the database from a different one.

## Descriptions

### Method Details

MaterialsDB.__call__(*args, **kwargs)
  Return type:

    Material

MaterialsDB.clear()

  Clear the database.

MaterialsDB.get(*args, **kwargs)

  Get material of given name and doping.

  Return type:

    Material

MaterialsDB.info(name)

  Get information dictionary on built-in material.

  Parameters:

    name (str) – material name without doping amount and composition. (e.g. ‘GaAs:Si’, ‘AlGaAs’).

MaterialsDB.is_alloy(name)

  Return `True` if the specified material is an alloy one.

  Parameters:

    name (str) – material name without doping amount and composition. (e.g. ‘GaAs:Si’, ‘AlGaAs’).

MaterialsDB.material_with_params(*args, **kwargs)

  Get material with constant parameters specified as kwargs

  Return type:

    Material

MaterialsDB.remove(name)

  Remove material of given name and doping from database.

  Parameters:

    name (str) – material name without doping amount and composition. (e.g. ‘GaAs:Si’, ‘AlGaAs’).

MaterialsDB.update(src)

  Update the database from a different one.

  Parameters:

    src – Source database.