.. image:: figures/code.png

|

Model Code
==========

This section is a technical documentation of the microWELT 2.0 LTC model, including the model code. It is organised module by module. Each module documentation contains a text description followed by the code. The modules are grouped as follows:

- Model Overview
- The actors
- The socio-demographic core
- Long Term Care (LTC)
- The simulation engine and associated modules
- Table output

This documentation is automatically generated from the latest version of the model code.

**Last update:** 2025-02-08

Model Overview
--------------

.. include:: code/_Documentation.mpp
   :start-after: NOTE(model, EN)
   :end-before: */

Model Actors
------------

ActorObservation.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/ActorObservation.mpp
   :start-after: NOTE(ActorObservation, EN)
   :end-before: */

.. include:: code/ActorObservation.mpp
   :start-after: */
   :code:

ActorPerson.mpp
^^^^^^^^^^^^^^^

.. include:: code/ActorPerson.mpp
   :start-after: NOTE(ActorPerson, EN)
   :end-before: */

.. include:: code/ActorPerson.mpp
   :start-after: */
   :code:

ActorObserver.mpp
^^^^^^^^^^^^^^^^^

.. include:: code/ActorObserver.mpp
   :start-after: NOTE(ActorObserver, EN)
   :end-before: */

.. include:: code/ActorObserver.mpp
   :start-after: */
   :code:

The Socio-Demographic Core
--------------------------

Fertility.mpp
^^^^^^^^^^^^^

.. include:: code/Fertility.mpp
   :start-after: NOTE(Fertility, EN)
   :end-before: */

.. include:: code/Fertility.mpp
   :start-after: */
   :code:

Mortality.mpp
^^^^^^^^^^^^^

.. include:: code/Mortality.mpp
   :start-after: NOTE(Mortality, EN)
   :end-before: */

.. include:: code/Mortality.mpp
   :start-after: */
   :code:

Migration.mpp
^^^^^^^^^^^^^

.. include:: code/Migration.mpp
   :start-after: NOTE(Migration, EN)
   :end-before: */

.. include:: code/Migration.mpp
   :start-after: */
   :code:

Partnerships.mpp
^^^^^^^^^^^^^^^^

.. include:: code/Partnerships.mpp
   :start-after: NOTE(Partnerships, EN)
   :end-before: */

.. include:: code/Partnerships.mpp
   :start-after: */
   :code:

Family.mpp
^^^^^^^^^^

.. include:: code/Family.mpp
   :start-after: NOTE(Family, EN)
   :end-before: */

.. include:: code/Family.mpp
   :start-after: */
   :code:

MaleFamily.mpp
^^^^^^^^^^^^^^

.. include:: code/MaleFamily.mpp
   :start-after: NOTE(MaleFamily, EN)
   :end-before: */

.. include:: code/MaleFamily.mpp
   :start-after: */
   :code:

LeavingHome.mpp
^^^^^^^^^^^^^^^

.. include:: code/LeavingHome.mpp
   :start-after: NOTE(LeavingHome, EN)
   :end-before: */

.. include:: code/LeavingHome.mpp
   :start-after: */
   :code:

ParentsEducation.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/ParentsEducation.mpp
   :start-after: NOTE(ParentsEducation, EN)
   :end-before: */

.. include:: code/ParentsEducation.mpp
   :start-after: */
   :code:

Education.mpp
^^^^^^^^^^^^^

.. include:: code/Education.mpp
   :start-after: NOTE(Education, EN)
   :end-before: */

.. include:: code/Education.mpp
   :start-after: */
   :code:

Long-Term Care (LTC)
--------------------

LongtermCare.mpp
^^^^^^^^^^^^^^^^

.. include:: code/LongtermCare.mpp
   :start-after: NOTE(LongtermCare, EN)
   :end-before: */

.. image:: figures/ltc.png

.. include:: code/LongtermCare.mpp
   :start-after: */
   :code:


The Simulation Engine and related modules
-----------------------------------------

SimulationEngine.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/SimulationEngine.mpp
   :start-after: NOTE(SimulationEngine, EN)
   :end-before: */

.. include:: code/SimulationEngine.mpp
   :start-after: */
   :code:

_Context.mpp
^^^^^^^^^^^^

.. include:: code/_Context.mpp
   :start-after: NOTE(_Context, EN)
   :end-before: */

.. include:: code/_Context.mpp
   :start-after: */
   :code:

ClockEvents.mpp
^^^^^^^^^^^^^^^

.. include:: code/ClockEvents.mpp
   :start-after: NOTE(ClockEvents, EN)
   :end-before: */

.. include:: code/ClockEvents.mpp
   :start-after: */
   :code:

ompp_framework.ompp
^^^^^^^^^^^^^^^^^^^

.. include:: code/ompp_framework.ompp
   :start-after: NOTE(ompp_framework, EN)
   :end-before: */

.. include:: code/ompp_framework.ompp
   :start-after: */
   :code:

modgen_framework.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/modgen_framework.mpp
   :start-after: NOTE(modgen_framework, EN)
   :end-before: */

.. include:: code/modgen_framework.mpp
   :start-after: */
   :code:

Model Output
------------

TablesDemography.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/TablesDemography.mpp
   :start-after: NOTE(TablesDemography, EN)
   :end-before: */

.. include:: code/TablesDemography.mpp
   :start-after: */
   :code:

TablesEducation.mpp
^^^^^^^^^^^^^^^^^^^

.. include:: code/TablesEducation.mpp
   :start-after: NOTE(TablesEducation, EN)
   :end-before: */

.. include:: code/TablesEducation.mpp
   :start-after: */
   :code:

TablesFamily.mpp
^^^^^^^^^^^^^^^^

.. include:: code/TablesFamily.mpp
   :start-after: NOTE(TablesFamily, EN)
   :end-before: */

.. include:: code/TablesFamily.mpp
   :start-after: */
   :code:

TablesLongtermCare.mpp
^^^^^^^^^^^^^^^^^^^^^^

.. include:: code/TablesLongtermCare.mpp
   :start-after: NOTE(TablesLongtermCare, EN)
   :end-before: */

.. include:: code/TablesLongtermCare.mpp
   :start-after: */
   :code:

TablesValidation.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/TablesValidation.mpp
   :start-after: NOTE(TablesValidation, EN)
   :end-before: */

.. include:: code/TablesValidation.mpp
   :start-after: */
   :code: