.. _area:

Areas
-------

The **area** object is a key object used to define the areas of the LTM. The area parameters are listed below. The parameters in **bold** are required and the others are optional.

.. list-table:: Area Parameters
   :header-rows: 1
   :widths: 30 30 60

   * - Parameter
     - Datatype
     - Unit
   * - **name**
     - string
     - Object/area name
   * - id
     - int
     - Output
   * - water_value_weights
     - :ref:`water_value_weights`
     - Used to change the default scenario weights in the :ref:`water_value_method`.
   * - spill_cost
     - double_optional
     - Spill cost price. **Default value = 0.01**. This value must be the system's lowest price.
   * - load_penalty
     - double_optional
     - Load penalty price. **Default value = 3000**. The value must be the system's highest price.
   * - max_iterations
     - int_optional
     - Max number of iterations for the water value calculation. **Default value = 40**. :ref:`water_value_method`.
   * - precision
     - double_optional
     - Convergence criterion for the water value calculation. **Default value = 0.001**. :ref:`water_value_method`.
   * - feedback_factors
     - :ref:`feedback_factors`
     - Used in the :ref:`calibration`. Default feedback factors are generated automatically by the EMPS. **Feedback factors are very important for the results!**
   * - has_detailed_grid
     - bool
     - Use in Samnett to sort the list of areas with detailed grid.
   * - #comment
     - string_optional
     - Optional comment
   * - metadata
     - json
     - Output

A minimal example is show below (collapsed).

.. collapse:: Burbars examples

    .. code-block:: json

        "areas": [
            {
                "name": "numedal",
                "spill_cost": 0.001,    // optional
                "max_iterations": 500,  // optional
                "precision": 0.0001     // optional
            },
            {
                "name": "tev"
            },
            {
                "name": "otra"
            }
        ]