# PLaSK User Manual

#### Page Contents

- HeatFluxProviderCyl Class
  - `HeatFluxProviderCyl`
  - `HeatFluxProviderCyl.solver.outHeatFlux()`
  - Methods
  - Descriptions
    - Method Details
      - `HeatFluxProviderCyl.__call__()`
      - `HeatFluxProviderCyl.set_changed()`

# HeatFluxProviderCyl Class

class plask.flow.HeatFluxProviderCyl(data)

  Provider of the heat flux in Cylindrical geometry (W/m²).

  This class is used for heat flux provider in binary solvers. You can also create a custom provider for your Python solver.

  Parameters:

    data – `Data` object to interpolate or callable returning it for given mesh. The callable must accept the same arguments as the provider `__call__` method (see below).

  To obtain the value from the provider simply call it. The call signature is as follows:

  solver.outHeatFlux(mesh, interpolation='default')
    Parameters:

      - mesh (mesh) – Target mesh to get the field at.

      - interpolation (str) – Requested interpolation method.

    Returns:

      Data with the heat flux on the specified mesh (W/m²).

  Example

  Connect the provider to a receiver in some other solver:

      >>> other_solver.inHeatFlux = solver.outHeatFlux

  Obtain the provided field:

      >>> solver.outHeatFlux(mesh)
      <plask.Data at 0x1234567>

  See also

  Receiver of heat flux: `plask.flow.HeatFluxReceiverCyl` Data filter for heat flux: `plask.flow.HeatFluxFilterCyl`

## Methods

`__call__`(mesh[, interpolation]) | Get value from the provider.
`set_changed`() | Inform all connected receivers that the provided value has changed.

## Descriptions

### Method Details

HeatFluxProviderCyl.__call__(mesh, interpolation='DEFAULT')

  Get value from the provider.

  Parameters:

    - mesh (mesh) – Target mesh to get the field at.

    - interpolation (str) – Requested interpolation method.

HeatFluxProviderCyl.set_changed()

  Inform all connected receivers that the provided value has changed.

  The receivers will have its changed attribute set to True and solvers will call the provider again if they need its value (otherwise they might take it from the cache.