RWTH-EBC · Philipp-Schmitz · Feb 15, 2023 · Mar 2, 2023 · Nov 19, 2024 · Nov 19, 2024
diff --git a/BESMod/Examples/BAUSimStudy/BESParameters.mo b/BESMod/Examples/BAUSimStudy/BESParameters.mo
@@ -12,4 +12,8 @@ record BESParameters
     final nZones=1,
     final use_ventilation=false);
 
+  annotation (Documentation(info="<html>
+<h4>Information</h4>
+<p>This record contains basic parameters for building energy system simulations in the BauSIM case study.</p>
+</html>"));
 end BESParameters;
diff --git a/BESMod/Examples/BAUSimStudy/Case1Standard.mo b/BESMod/Examples/BAUSimStudy/Case1Standard.mo
@@ -13,4 +13,12 @@ model Case1Standard
       __Dymola_Algorithm="Dassl"),
    __Dymola_Commands(file="modelica://BESMod/Resources/Scripts/Dymola/Examples/BAUSimStudy/Case1Standard.mos"
         "Simulate and plot"));
+  annotation (Documentation(info="<html>
+<h4>Information</h4>
+<p>
+This model represents the standard case (Case 1) of a building energy simulation study. It extends from 
+<a href=\"modelica://BESMod.Examples.BAUSimStudy.PartialCase\">BESMod.Examples.BAUSimStudy.PartialCase</a> 
+and uses parameters for a non-retrofitted single dwelling house from 1918.
+</p>
+</html>"));
 end Case1Standard;
diff --git a/BESMod/Examples/BAUSimStudy/PartialCase.mo b/BESMod/Examples/BAUSimStudy/PartialCase.mo
@@ -92,8 +92,36 @@ partial model PartialCase
 
   parameter Modelica.Units.SI.Temperature TBiv=271.15
     "Nominal bivalence temperature. = TOda_nominal for monovalent systems.";
+
   annotation (experiment(
       StopTime=172800,
       Interval=600,
-      __Dymola_Algorithm="Dassl"));
+      __Dymola_Algorithm="Dassl"), Documentation(info="<html>
+<h4>Information</h4>
+<p>This is a partial case model for building energy system simulations. It extends a partial building energy system with specific subsystems for electrical, thermal, hydraulic and control components. The model includes:</p>
+<ul>
+  <li>Direct grid connection for electrical system</li>
+  <li>TEASER thermal zone building model</li>
+  <li>No control system</li>
+  <li>Hydraulic system with:
+    <ul>
+      <li>Bivalent parallel heat pump and electric heater</li>
+      <li>Two storage system with detailed loading</li>
+      <li>Radiator-based heat transfer</li>
+    </ul>
+  </li>
+  <li>DHW system with standard profiles</li>
+  <li>TEASER user profiles</li>
+  <li>No ventilation system</li>
+</ul>
+
+<h4>Related Models</h4>
+<ul>
+  <li><a href=\"modelica://BESMod.Systems.BaseClasses.PartialBuildingEnergySystem\">BESMod.Systems.BaseClasses.PartialBuildingEnergySystem</a></li>
+  <li><a href=\"modelica://BESMod.Systems.Electrical.DirectGridConnectionSystem\">BESMod.Systems.Electrical.DirectGridConnectionSystem</a></li>
+  <li><a href=\"modelica://BESMod.Systems.Demand.Building.TEASERThermalZone\">BESMod.Systems.Demand.Building.TEASERThermalZone</a></li>
+  <li><a href=\"modelica://BESMod.Systems.Hydraulical.HydraulicSystem\">BESMod.Systems.Hydraulical.HydraulicSystem</a></li>
+  <li><a href=\"modelica://BESMod.Systems.Demand.DHW.StandardProfiles\">BESMod.Systems.Demand.DHW.StandardProfiles</a></li>
+</ul>
+</html>"));
 end PartialCase;
diff --git a/BESMod/Examples/DesignOptimization/AachenSystem.mo b/BESMod/Examples/DesignOptimization/AachenSystem.mo
@@ -10,4 +10,8 @@ record AachenSystem
     THydSup_nominal={328.15},
     TOda_nominal=265.35);
 
+  annotation (Documentation(info="<html>
+<h4>Information</h4>
+<p>This record extends <a href=\"modelica://BESMod.Systems.RecordsCollection.SystemParametersBaseDataDefinition\">BESMod.Systems.RecordsCollection.SystemParametersBaseDataDefinition</a> and defines parameters for a building energy system in Aachen, Germany. The model represents a single-zone building without ventilation and electric heating.</p>
+</html>"));
 end AachenSystem;
diff --git a/BESMod/Examples/DesignOptimization/BES.mo b/BESMod/Examples/DesignOptimization/BES.mo
@@ -99,7 +99,34 @@ model BES
 
   extends Modelica.Icons.Example;
 
-  annotation (experiment(StopTime=172800,
+  annotation (Documentation(info="<html>
+<h4>Information</h4>
+<p>This model represents a complete building energy system (BES) setup for design optimization. It extends the PartialBuildingEnergySystem base class and includes an electrical system with direct grid connection, a thermal zone building model based on TEASER, and a hydraulic system with heat pump and electric heater.</p>
+
+<h4>System Components</h4>
+<ul>
+  <li>Electrical: <a href=\"modelica://BESMod.Systems.Electrical.DirectGridConnectionSystem\">DirectGridConnectionSystem</a></li>
+  <li>Building: <a href=\"modelica://BESMod.Systems.Demand.Building.TEASERThermalZone\">TEASERThermalZone</a> with reference parameters for Aachen</li>
+  <li>Control: <a href=\"modelica://BESMod.Systems.Control.NoControl\">NoControl</a></li>
+  <li>Hydraulic: <a href=\"modelica://BESMod.Systems.Hydraulical.HydraulicSystem\">HydraulicSystem</a>
+    <ul>
+      <li>Generation: Bivalent heat pump with electric heater</li>
+      <li>Distribution: Two storage system in parallel (buffer and DHW)</li>
+      <li>Transfer: Ideal valve radiator system</li>
+    </ul>
+  </li>
+  <li>DHW: Standard domestic hot water system with M-Profile</li>
+  <li>Ventilation: No ventilation system</li>
+</ul>
+
+<h4>Important Parameters</h4>
+<ul>
+  <li>TBiv: Bivalent temperature point for heat pump operation</li>
+  <li>TCutOff: Cut-off temperature for heat pump</li>
+  <li>QHP_flow_cutOff: Heat pump power at cut-off temperature</li>
+  <li>VPerQFlow: Storage volume per nominal heat flow rate</li>
+</ul>
+</html>"),experiment(StopTime=172800,
      Interval=600,
      Tolerance=1e-06),
    __Dymola_Commands(file="modelica://BESMod/Resources/Scripts/Dymola/Examples/DesignOptimization/BES.mos"

diff --git a/BESMod/Examples/DesignOptimization/BESNoDHW.mo b/BESMod/Examples/DesignOptimization/BESNoDHW.mo
@@ -91,4 +91,13 @@ model BESNoDHW "Example to demonstrate usage without DHW"
      Tolerance=1e-06),
    __Dymola_Commands(file="modelica://BESMod/Resources/Scripts/Dymola/Examples/DesignOptimization/BESNoDHW.mos"
         "Simulate and plot"));
+  annotation (Documentation(info="<html>
+  <h4>Information</h4>
+  <p>
+    This model demonstrates a building energy system without domestic hot water (DHW).
+    It uses a bivalent parallel heat pump system with an electric heater as backup.
+    The heat distribution is building-only with ideal valve radiators. 
+    The control system is monoergetic with thermostatically controlled valves.
+  </p>
+</html>"));
 end BESNoDHW;
diff --git a/BESMod/Examples/DesignOptimization/ParametersToChange.mo b/BESMod/Examples/DesignOptimization/ParametersToChange.mo
@@ -15,4 +15,8 @@ record ParametersToChange
     annotation(Evaluate=false);
   parameter Modelica.Units.SI.HeatFlowRate QHP_flow_cutOff=3000
     annotation (Evaluate=false);
+  annotation (Documentation(info="<html>
+<h4>Information</h4>
+<p>This record defines parameters for design optimization of building energy systems.</p>
+</html>"));
 end ParametersToChange;
diff --git a/BESMod/Examples/GasBoilerBuildingOnly.mo b/BESMod/Examples/GasBoilerBuildingOnly.mo
@@ -61,5 +61,18 @@ model GasBoilerBuildingOnly
      Interval=600,
      Tolerance=1e-06),
    __Dymola_Commands(file="modelica://BESMod/Resources/Scripts/Dymola/Examples/GasBoilerBuildingOnly.mos"
-        "Simulate and plot"));
+        "Simulate and plot"), Documentation(info="<html>
+  <h4>Information</h4>
+  <p>
+    This model represents a building energy system featuring a gas boiler for space heating. The building model uses the TEASER thermal zone representation of a building located in Aachen, Germany. The system only models space heating without ventilation, domestic hot water or electrical heating.
+  </p>
+
+  <h4>Key Components</h4>
+  <ul>
+    <li>Generation: <a href=\"modelica://BESMod.Systems.Hydraulical.Generation.GasBoiler\">Gas Boiler</a></li>
+    <li>Distribution: <a href=\"modelica://BESMod.Systems.Hydraulical.Distribution.BuildingOnly\">Building Only Distribution</a></li>
+    <li>Heat Transfer: <a href=\"modelica://BESMod.Systems.Hydraulical.Transfer.RadiatorPressureBased\">Pressure-based Radiator</a></li>
+    <li>Building Model: <a href=\"modelica://BESMod.Systems.Demand.Building.TEASERThermalZone\">TEASER Thermal Zone</a></li>
+  </ul>
+</html>"));
 end GasBoilerBuildingOnly;
diff --git a/BESMod/Examples/HeatPumpAndBoiler/AachenSystem.mo b/BESMod/Examples/HeatPumpAndBoiler/AachenSystem.mo
@@ -10,4 +10,8 @@ record AachenSystem
     THydSup_nominal={328.15},
     TOda_nominal=265.35);
 
+  annotation (Documentation(info="<html>
+<h4>Information</h4>
+<p>Define parameters for a heating system model of a building in Aachen, Germany.</p>
+</html>"));
 end AachenSystem;
diff --git a/BESMod/Examples/HeatPumpAndBoiler/AfterBufferWithDHW.mo b/BESMod/Examples/HeatPumpAndBoiler/AfterBufferWithDHW.mo
@@ -46,5 +46,45 @@ model AfterBufferWithDHW
      Interval=600,
      Tolerance=1e-06),
    __Dymola_Commands(file="modelica://BESMod/Resources/Scripts/Dymola/Examples/HeatPumpAndBoiler/AfterBufferWithDHW.mos"
-        "Simulate and plot"));
+        "Simulate and plot"), Documentation(info="<html><h4>
+  Information
+</h4>
+<p>
+  This model represents a bivalent heat pump system with boiler
+  integration after the buffer tank including domestic hot water (DHW)
+  support. It extends the <a href=
+  \"modelica://BESMod.Examples.HeatPumpAndBoiler.BaseClasses.PartialHybridSystem\">
+  PartialHybridSystem</a> base class.
+</p>
+<h4>
+  System Description
+</h4>
+<p>
+  Key components:
+</p>
+<ul>
+  <li>Heat pump with vapor injection phase separator using propane
+  refrigerant
+  </li>
+  <li>Boiler integrated after buffer storage tank
+  </li>
+  <li>Two storage system with buffer tank and DHW storage
+  </li>
+  <li>Bivalent-parallel configuration for heat generation
+  </li>
+</ul>
+<h4>
+  Important Parameters
+</h4>
+<ul>
+  <li>TBiv: Bivalence temperature for heat pump operation
+  </li>
+  <li>VPerQFlow: Buffer storage volume per nominal heat flow rate
+  </li>
+  <li>dTLoadingHC1: Temperature difference for DHW loading (10K)
+  </li>
+  <li>dTBoiDHWLoa: Temperature difference for boiler DHW loading (10K)
+  </li>
+</ul>
+</html>"));
 end AfterBufferWithDHW;
diff --git a/BESMod/Examples/HeatPumpAndBoiler/AfterBufferWithoutDHW.mo b/BESMod/Examples/HeatPumpAndBoiler/AfterBufferWithoutDHW.mo
@@ -36,9 +36,38 @@ model AfterBufferWithoutDHW
 
   extends Modelica.Icons.Example;
 
+
   annotation (experiment(StopTime=172800,
      Interval=600,
      Tolerance=1e-06),
    __Dymola_Commands(file="modelica://BESMod/Resources/Scripts/Dymola/Examples/HeatPumpAndBoiler/AfterBufferWithoutDHW.mos"
-        "Simulate and plot"));
+        "Simulate and plot"), Documentation(info="<html>
+<h4>Information</h4>
+<p>This model represents a bivalent heat pump system with a boiler integration after the buffer tank. The system does not include domestic hot water (DHW) support by the boiler. It extends from a partial hybrid system base class.</p>
+
+<h4>System Configuration</h4>
+<p>The hydraulic system consists of:</p>
+<ul>
+  <li>Heat pump generation system with:
+    <ul>
+      <li>Bivalent parallel operation with boiler</li>
+      <li>Vapor injection heat pump using propane refrigerant</li>
+      <li>Performance based on 3D table data</li>
+    </ul>
+  </li>
+  <li>Distribution system with:
+    <ul>
+      <li>Detailed buffer storage with direct loading</li>
+      <li>Three-way valve control</li>
+      <li>Boiler integration after buffer storage</li>
+    </ul>
+  </li>
+</ul>
+
+<h4>Important Parameters</h4>
+<ul>
+  <li><code>TBiv</code>: Bivalent temperature point</li>
+  <li><code>VPerQFlow</code>: Storage volume per heat flow rate</li>
+</ul>
+</html>"));
 end AfterBufferWithoutDHW;
diff --git a/BESMod/Examples/HeatPumpAndBoiler/BaseClasses.mo b/BESMod/Examples/HeatPumpAndBoiler/BaseClasses.mo
@@ -59,9 +59,34 @@ package BaseClasses "Contains partial example case"
       redeclare final package MediumHyd = AixLib.Media.Water,
       redeclare BESMod.Systems.Ventilation.NoVentilation ventilation);
 
-    annotation (experiment(
-        StopTime=172800,
-        Interval=600,
-        __Dymola_Algorithm="Dassl"));
+
   end PartialHybridSystem;
+  annotation (Documentation(info="<html>
+<h4>Information</h4>
+<p>This package contains a partial example case for a hybrid building energy system. The main model <code>PartialHybridSystem</code> defines a bivalent heat pump system that combines a heat pump with a backup boiler. The model extends <a href=\"modelica://BESMod.Systems.BaseClasses.PartialBuildingEnergySystem\">BESMod.Systems.BaseClasses.PartialBuildingEnergySystem</a> and includes:</p>
+
+<ul>
+  <li>Direct grid connection for electrical system</li>
+  <li>TEASER thermal zone building model with Aachen reference parameters</li>
+  <li>Hybrid heat pump hydraulic system with PI-controlled thermostatic valves</li>
+  <li>Standard DHW profile system</li>
+  <li>TEASER user profiles</li>
+  <li>No ventilation system</li>
+</ul>
+
+<h4>Important Parameters</h4>
+<ul>
+  <li><code>TBiv</code> - Bivalent temperature point for heat pump operation</li>
+  <li><code>TCutOff</code> - Heat pump cut-off temperature</li>
+  <li><code>dTHysBui</code> - Building temperature hysteresis (5K)</li>
+  <li><code>dTHysDHW</code> - DHW temperature hysteresis (5K)</li>
+</ul>
+
+<h4>Related Models</h4>
+<ul>
+  <li><a href=\"modelica://BESMod.Systems.Hydraulical.HydraulicSystem\">BESMod.Systems.Hydraulical.HydraulicSystem</a></li>
+  <li><a href=\"modelica://BESMod.Systems.Demand.Building.TEASERThermalZone\">BESMod.Systems.Demand.Building.TEASERThermalZone</a></li>
+  <li><a href=\"modelica://BESMod.Systems.Hydraulical.Control.HybridHeatPumpSystem\">BESMod.Systems.Hydraulical.Control.HybridHeatPumpSystem</a></li>
+</ul>
+</html>"));
 end BaseClasses;
diff --git a/BESMod/Examples/HeatPumpAndBoiler/Parallel.mo b/BESMod/Examples/HeatPumpAndBoiler/Parallel.mo
@@ -36,5 +36,29 @@ model Parallel
      Interval=600,
      Tolerance=1e-06),
    __Dymola_Commands(file="modelica://BESMod/Resources/Scripts/Dymola/Examples/HeatPumpAndBoiler/Parallel.mos"
-        "Simulate and plot"));
+        "Simulate and plot"), Documentation(info="<html>
+<h4>Information</h4>
+<p>
+This model implements a bivalent heating system with parallel heat generation using a heat pump and gas boiler. The system includes two storage tanks - one buffer storage for heating and one for domestic hot water (DHW).
+</p>
+
+<h4>Important Parameters</h4>
+<ul>
+  <li>TBiv: Bivalence temperature for heat pump operation</li>
+  <li>VPerQFlow: Specific storage volume per heat flow rate</li>
+  <li>dTLoadingHC1: Temperature difference for loading heating circuit 1
+    <ul>
+      <li>Buffer storage: 0K</li>
+      <li>DHW storage: 10K</li>
+    </ul>
+  </li>
+</ul>
+
+<p>Key components:</p>
+<ul>
+  <li>Generation: <a href=\"modelica://BESMod.Systems.Hydraulical.Generation.HeatPumpAndGasBoilerParallel\">HeatPumpAndGasBoilerParallel</a></li>
+  <li>Distribution: <a href=\"modelica://BESMod.Systems.Hydraulical.Distribution.DistributionTwoStorageParallel\">DistributionTwoStorageParallel</a></li>
+  <li>Heat Pump: Uses table-based heat pump model with vapor injection and phase separator using propane as refrigerant</li>
+</ul>
+</html>"));
 end Parallel;
diff --git a/BESMod/Examples/HeatPumpAndBoiler/ParametersToChange.mo b/BESMod/Examples/HeatPumpAndBoiler/ParametersToChange.mo
@@ -16,4 +16,13 @@ record ParametersToChange
     annotation (Evaluate=false);
   parameter Modelica.Units.SI.HeatFlowRate QHP_flow_biv=4000
     annotation (Evaluate=false);
+  annotation (Documentation(info="<html>
+<h4>Information</h4>
+<p>
+Record that contains parameters related to the heat pump and boiler system design.
+</p>
+<p>
+All parameters have <code>Evaluate=false</code> since they are meant to be changed during parameter studies.
+</p>
+</html>"));
 end ParametersToChange;
diff --git a/BESMod/Examples/HeatPumpAndBoiler/Serial.mo b/BESMod/Examples/HeatPumpAndBoiler/Serial.mo
@@ -33,5 +33,24 @@ model Serial "Bivalent Heat Pump Systems with serial heat generation"
      Interval=600,
      Tolerance=1e-06),
    __Dymola_Commands(file="modelica://BESMod/Resources/Scripts/Dymola/Examples/HeatPumpAndBoiler/Serial.mos"
-        "Simulate and plot"));
+        "Simulate and plot"), Documentation(info="<html>
+<h4>Information</h4>
+<p>
+This model represents a bivalent heating system with serial arrangement of a heat pump and gas boiler. The system uses modular components for modeling the heating supply system with two storages in parallel arrangement for both buffer and domestic hot water storage.
+</p>
+
+<h4>Important Parameters</h4>
+<ul>
+<li>TBiv: Bivalence temperature for heat pump operation</li>
+<li>VPerQFlow: Storage volume per nominal heat flow for buffer storage dimensioning</li>
+<li>dTLoadingHC1: Temperature difference for DHW loading (10K)</li>
+</ul>
+
+<p>Key components:</p>
+<ul>
+<li>Heat pump model using <a href=\"modelica://AixLib.Fluid.HeatPumps.ModularReversible.RefrigerantCycle.TableData3D\">AixLib table-based heat pump</a> with vapor injection</li>
+<li>Two storage system: Buffer storage and DHW storage arranged in parallel</li>
+
+</ul>
+</html>"));
 end Serial;
diff --git a/BESMod/Examples/HighOrderModel/BES_HOM.mo b/BESMod/Examples/HighOrderModel/BES_HOM.mo
@@ -91,5 +91,11 @@ model BES_HOM
      Interval=600,
      Tolerance=1e-06),
    __Dymola_Commands(file="modelica://BESMod/Resources/Scripts/Dymola/Examples/HighOrderModel/BES_HOM.mos"
-        "Simulate and plot"));
+        "Simulate and plot"), Documentation(info="<html>
+  <h4>Information</h4>
+  <p>High order building energy system model extending <a href=\"modelica://BESMod.Systems.BaseClasses.PartialBuildingEnergySystem\">BESMod.Systems.BaseClasses.PartialBuildingEnergySystem</a>. The model consists of an electrical, building, control, hydraulic, DHW and ventilation system.</p>
+
+  <p>The building is modeled using AixLib high order approach with EnEV2009 heavy walls and simple window model. The hydraulic system features a heat pump with electric heater backup in a monoenergetic configuration, two storage tanks in parallel (buffer and DHW), and radiator heating system.</p>
+
+</html>"));
 end BES_HOM;
diff --git a/BESMod/Examples/HighOrderModel/HOMSystem.mo b/BESMod/Examples/HighOrderModel/HOMSystem.mo
@@ -10,4 +10,8 @@ record HOMSystem
     THydSup_nominal=fill(328.15,nZones),
     TOda_nominal=265.35);
 
+  annotation (Documentation(info="<html>
+<h4>Information</h4>
+<p>Record for a high-order building model consisting of 10 thermal zones.</p>
+</html>"));
 end HOMSystem;
diff --git a/BESMod/Examples/ModelicaConferencePaper/BESModSystemParas.mo b/BESMod/Examples/ModelicaConferencePaper/BESModSystemParas.mo
@@ -9,4 +9,9 @@ record BESModSystemParas "Case studies system parameters"
     THydSup_nominal={328.15},
     TOda_nominal=265.35);
 
+  annotation (Documentation(info="<html>
+<h4>Information</h4>
+<p>BESModSystemParas is a record containing system parameters for building energy system case studies.</p>
+
+</html>"));
 end BESModSystemParas;