# PLaSK User Manual

#### Page Contents

- HeatReceiverCyl Class
  - `HeatReceiverCyl`
  - Methods
  - Descriptions
    - Method Details
      - `HeatReceiverCyl.__call__()`
      - `HeatReceiverCyl.add_watch()`
      - `HeatReceiverCyl.attach()`
      - `HeatReceiverCyl.reset()`

# HeatReceiverCyl Class

class plask.flow.HeatReceiverCyl

  Receiver of the heat sources density in Cylindrical geometry (W/m³).

  You may connect a provider to this receiver using either the connect method or an assignment operator. Then, you can read the provided value by calling this receiver with arguments identical as the ones of the corresponding provider `HeatProviderCyl`.

  Example

  Connect the receiver to a provider from some other solver:

      >>> solver.inHeat = other_solver.outHeat

  See also

  Provider of heat sources density: `plask.flow.HeatProviderCyl`

  Data filter for heat sources density: `plask.flow.HeatFilterCyl`

## Methods

`__call__`(mesh[, interpolation]) | Get value from the connected provider
`add_watch`(callable) | Connect callable to watch receiver changes.
`attach`(source) | Attach some provider or constant value to the receiver.
`reset`() | Disconnect any provider of value from the receiver.

## Descriptions

### Method Details

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

  Get value from the connected provider

HeatReceiverCyl.add_watch(callable)

  Connect callable to watch receiver changes.

  The callable will be called each time the value received by this receiver changes.

  The callable should accept two arguments: the first one will be the receiver and the second one gives information what is changed.

HeatReceiverCyl.attach(source)

  Attach some provider or constant value to the receiver.

  Parameters:

    source – source provider or value.

  Example

      >>> solver.inHeat.attach(300.)
      >>> solver.inHeat(any_mesh)[0]
      300.
      >>> solver.inHeat(any_mesh)[-1]
      300.

      >>> solver.inHeat.attach(other_solver.outHeat)

  Note

  You may achieve the same effect by using the asignmnent operator if you put an existing provider at the right side of this operator:

      >>> solver.inHeat = other_solver.outHeat

HeatReceiverCyl.reset()

  Disconnect any provider of value from the receiver.