====== Transfer ======

|Note|In Ecolego 6, transfer coefficients and transfers are merged into one block. You now define that a transfer should be multiplied by the source compartment by selecting the **TC** checkbox in the value page.|

Represents the transfer of quantities of [[Material|materials]] between [[Compartment|compartments]]. It defines the quantity of the [[Material|materials]] that is subtracted from a [[Source_Sink|source/sink]] or [[Compartment|compartment]] block and added to a destination [[Compartment|compartment]] or [[Source_Sink|source/sink]] block.

Transfers can be made discrete (instantaneous).

Discrete transfers are used to instantly move quantities of materials to, from or between compartments.
To make a [[Transfer|transfer]] discrete, select an [[Discrete_event|event]] from the drop-down list which should trigger the transfer.

===== Creating a transfer =====

From the [[Projects_window|Projects window]]

  * Expand the Project to which you wish to add the expression by clicking the + symbol next to it. Right-click on ‘Blocks’, or a [[Sub-system|sub-system]] in ‘Blocks’, and select **Transfer** from the pop-up menu, //or//
  * Right click a [[Compartment|compartment]] or [[Source_Sink|source/sink]] in the project tree and select **Connect to | …** from the popup menu.

From the [[Matrix_window|Matrix window]]

  * Right click the off-diagonal cell in the same row as the source and in the same column as the target and select **Transfer** from the the pop-up menu, //or//
  * Right click a [[Compartment|compartment]] or [[Source_Sink|source/sink]] in the matrix and select **Connect to | …** from the popup menu.

From the [[Blocks_window|Blocks window]]

  * Place the mouse cursor over the table and right-click on it. Select **New | Transfer** from the pop-up menu, //or//
  * In the title bar, select **Transfer** from the **Type** drop-down list and click on the {{:New24.png|New}} button, //or//
  * Right click a [[Compartment|compartment]] or [[Source_Sink|source/sink]] in the table and select **Connect to | …** from the popup menu.

===== Editing a transfer =====

|Note|Most block properties can be edited directly in the [[Blocks_window|Blocks window]].|

The block editor is shown by right-clicking the block in a window and selecting **Edit**. In the [[Blocks_window|Blocks window]], you can also show the block editor by selecting the block and clicking the {{:Edit24.png|Edit}} button, or by double-clicking the right-most “validation” column of the block.

The block editor has three tabs:

==== Properties ====

This page lets you edit basic properties such as name, sub-system and base unit. See [[Editing_properties|editing properties]] for more information.

==== Appearance ====

This page lets you edit the visual properties of the block in the [[Matrix_window|matrix window]] and [[Graph_window|graph window]]. See [[Editing_appearance|editing appearance]] for more information.

==== Values ====

|Note|When entering an expression, you can also enter names of objects that are not yet created and let Ecolego use [[Automatic_object_creation|automatic object creation]] to define them.|

Note that the dimension and index list of a transfer block is derived from the dimension and index lists of it’s source and target compartments. The transfer will only have the indices that are shared by the source and target.

  * **Equation** - The equation can contain any number of [[Parameter|parameters]], [[Block|blocks]] and [[Function|functions]], or even [[Expression|expressions]]. The [[Expression_editing_tool|Expression editing tool]] can be used to quickly find available functions and objects to use in the expression. Also refer to [[Expression_syntax|expression syntax]] for details on mathematical format and how to specify conditions.
  * **TC** - Transfer coefficient. Check this box if the expression given should be multiplied by the source [[Compartment|compartment]].
  * **Event** - Select a [[Discrete_Event|discrete event]] to make the transfer discrete (instantaneous). Note that you must first create a [[Discrete_Event|discrete event]] block.
  * **Author** User can provide information about the author.
  * **Reference** If available, reference field can be used to provide the insight to where the methods or data comes from.
  * **Comment** If necessary, comments can be assigned to blocks in Ecolego.
  * **Information** - By using the [[Table_control_button|Table control button]] {{:tablecontrol.png}} you can display more columns that will help you document your model.

===== See also =====

  * [[Block|Blocks]]
  * [[Blocks_window|Blocks window]]
  * [[Matrix_window|Matrix window]]
  * [[Graph_window|Graph window]]