Develop sticky merge

[emolinab]

Purpose of this PR

This pull request has two main purposes. The first one is to add the Sticky realization to the Factor costs module. Here, the capital relocation flexibility is reduced to improve crop production dynamics at different spatial scales. The second purpose is to modify how costs are calculated in the modules where investment decisions are taken.

Performance loss/gain from the current default behavior

• Default: 1 hour 13 minutes
• Sticky: 1 hour 43 minutes

• runtime plot not available due to issues with "output.R"

• %performance loss/gain = 143%

Type of change

• Bug fix (Change which fixes an issue).
• New feature (Change which adds functionality).
• Minor change (Change which does not modify core model code i.e., in /modules).
• Major change (fix or feature that would change current model behavior).

How Has This Been Tested?

• Runs using starting script which tests current defaults (using test_runs.R).
• Runs using starting script which successfully runs the same scenarios as in test_runs.R but with the changes from PR.
• (If applicable) Runs using different scenarios/mappings which are not the default (12 regions/c200 clusters).

Additions or Changes to default configuration (default.cfg):

The new Sticky realization was listed in the module_38 section of the default.cgf.

Changes are deletion or updates to the existing model components in default config

• Realizations:
• Scenario switches:
• Scalars/Constants:
• Model interfaces:
• Others:

Checklist:

• Self-review of my own code.
• Added changes to CHANGELOG.md
• No hard coded numbers and cluster/country/region names.
• The code doesn't contain declared but unused parameters or variables.
• In-code comments added including documentation comments.
• Compiled and checked resulting documentation with goxygen::goxygen() for the new/updated parts.
• Changes to magpie4 R library for post processing of model output (ideally backward compatible).

Special comments/warnings

We are still learning about the "sticky" effects and limitations. Please be cautious when using it for different region settings.

[abhimishr]

This PR would need to solve pending merge conflicts before it can be reviewed. Its just one file CHANGELOG.md, maybe pull from magpiemodel/develop and check the conflicts.

[emolinab]

This PR would need to solve pending merge conflicts before it can be reviewed. Its just one file CHANGELOG.md, maybe pull from magpiemodel/develop and check the conflicts.

Yes, I am working on it.

[emolinab]

*Bugs from merging the last develop branch need to be solved first