FATES-HLM parameter file plant functional types map
---------------------------------------------------

When FATES is run in fixed biogeography mode, the model will reference the `fates_hlm_pft_map` parameter in the FATES parameter file which provides a mapping between the host land model and FATES plant functional types.  This default mapping for the table is provided below.

FATES-HLM plant functional types mapping table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
|                                     | FATES plant functional type                                                                                                                                                  |
+=====================================+===========+===============+================+===============+================+================+===============+================+================+===========+=========+=======+
|                                     | Broadleaf | Needleleaf    | Needleleaf     | Broadleaf     | Broadleaf      | Broadleaf      | Broadleaf     | Broadleaf      | Broadleaf      |           |         |       |
|                                     |           |               |                |               |                |                |               |                |                |           |         |       |
|                                     | evergreen | evergreen     | cold deciduous | evergreen     | hydrodeciduous | cold deciduous | evergreen     | hydrodeciduous | cold deciduous |           |         |       |
|                                     |           |               |                |               |                |                |               |                |                |           |         |       |
|                                     | tropical  | extratropical | extratropical  | extratropical | tropical       | extratropical  | extratropical | extratropical  | extratropical  | Arctic C3 | Cool C4 | C4    |
|                                     |           |               |                |               |                |                |               |                |                |           |         |       |
| **HLM plant functional type**       | tree      | tree          | tree           | tree          | tree           | tree           | shrub         | shrub          | shrub          | grass     | grass   | grass |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
| Needleleaf evergreen temperate tree |     0     |   **1**       |     0          |     0         |     0          |     0          |     0         |     0          |     0          |     0     |     0   |   0   |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
| Needleleaf evergreen boreal tree    |     0     |   **1**       |     0          |     0         |     0          |     0          |     0         |     0          |     0          |     0     |     0   |   0   |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
| Needleleaf deciduous boreal tree    |     0     |     0         |   **1**        |     0         |     0          |     0          |     0         |     0          |     0          |     0     |     0   |   0   |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
| Broadleaf evergreen tropical tree   |   **1**   |     0         |     0          |     0         |     0          |     0          |     0         |     0          |     0          |     0     |     0   |   0   |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
| Broadleaf evergreen temperate tree  |     0     |     0         |     0          |   **1**       |     0          |     0          |     0         |     0          |     0          |     0     |     0   |   0   |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
| Broadleaf deciduous tropical tree   |     0     |     0         |     0          |     0         |   **1**        |     0          |     0         |     0          |     0          |     0     |     0   |   0   |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
| Broadleaf deciduous temperate tree  |     0     |     0         |     0          |     0         |     0          |   **1**        |     0         |     0          |     0          |     0     |     0   |   0   |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
| Broadleaf deciduous boreal tree     |     0     |     0         |     0          |     0         |     0          |   **1**        |     0         |     0          |     0          |     0     |     0   |   0   |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
| Broadleaf evergreen shrub           |     0     |     0         |     0          |     0         |     0          |     0          |   **1**       |     0          |     0          |     0     |     0   |   0   |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
| Broadleaf deciduous temperate shrub |     0     |     0         |     0          |     0         |     0          |     0          |     0         |     0          |   **1**        |     0     |     0   |   0   |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
| Broadleaf deciduous boreal shrub    |     0     |     0         |     0          |     0         |     0          |     0          |     0         |     0          |   **1**        |     0     |     0   |   0   |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
| C3 arctic grass                     |     0     |     0         |     0          |     0         |     0          |     0          |     0         |     0          |     0          |   **1**   |     0   |   0   |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
| C3 non-arctic grass                 |     0     |     0         |     0          |     0         |     0          |     0          |     0         |     0          |     0          |     0     |  **1**  |   0   |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+
| C4 grass                            |     0     |     0         |     0          |     0         |     0          |     0          |     0         |     0          |     0          |     0     |     0   | **1** |
+-------------------------------------+-----------+---------------+----------------+---------------+----------------+----------------+---------------+----------------+----------------+-----------+---------+-------+

References
^^^^^^^^^^
- `CTSM plant functional type table <https://escomp.github.io/ctsm-docs/versions/master/html/tech_note/Ecosystem/CLM50_Tech_Note_Ecosystem.html#id15>`_
- `FATES default parameter file <https://github.com/NGEET/fates/blob/main/parameter_files/fates_params_default.cdl>`_