From 531bd627892af54200a9a2c212c12a8c2ca25520 Mon Sep 17 00:00:00 2001 From: DamonHD Date: Wed, 13 Dec 2023 13:18:04 +0000 Subject: [PATCH] V0.9.6 --- RELEASES.txt | 153 ++- build.xml | 2 +- javadoc/allclasses-index.html | 8 +- javadoc/allpackages-index.html | 8 +- javadoc/constant-values.html | 26 +- javadoc/help-doc.html | 8 +- javadoc/index-all.html | 42 +- javadoc/index.html | 8 +- javadoc/member-search-index.js | 2 +- javadoc/org/hd/d/TRVmodel/Main.html | 8 +- .../TRVmodel/data/DDNTemperatureDataCSV.html | 8 +- .../data/HourlyTemperatureDataDescriptor.html | 8 +- .../hd/d/TRVmodel/data/package-summary.html | 8 +- .../org/hd/d/TRVmodel/data/package-tree.html | 8 +- .../org/hd/d/TRVmodel/hg/HGTRVHPMModel.html | 114 +- .../HGTRVHPMModelByHour.ScenarioResult.html | 8 +- .../hd/d/TRVmodel/hg/HGTRVHPMModelByHour.html | 8 +- .../TRVmodel/hg/HGTRVHPMModelExtensions.html | 8 +- ...meterised.DemandWithoutAndWithSetback.html | 8 +- ...arameterised.HeatAndElectricityDemand.html | 8 +- ...HPMModelParameterised.ModelParameters.html | 8 +- .../hg/HGTRVHPMModelParameterised.html | 34 +- .../hd/d/TRVmodel/hg/ShowComputations.html | 8 +- .../org/hd/d/TRVmodel/hg/package-summary.html | 8 +- .../org/hd/d/TRVmodel/hg/package-tree.html | 8 +- .../org/hd/d/TRVmodel/package-summary.html | 8 +- javadoc/org/hd/d/TRVmodel/package-tree.html | 8 +- javadoc/overview-summary.html | 6 +- javadoc/overview-tree.html | 8 +- javadoc/search.html | 8 +- .../org/hd/d/TRVmodel/hg/HGTRVHPMModel.html | 52 +- ...meterised.DemandWithoutAndWithSetback.html | 1107 ++++++++--------- ...arameterised.HeatAndElectricityDemand.html | 1107 ++++++++--------- ...HPMModelParameterised.ModelParameters.html | 1107 ++++++++--------- .../hg/HGTRVHPMModelParameterised.html | 1107 ++++++++--------- 35 files changed, 2610 insertions(+), 2425 deletions(-) diff --git a/RELEASES.txt b/RELEASES.txt index 05e941b..bfebbd2 100644 --- a/RELEASES.txt +++ b/RELEASES.txt @@ -15,9 +15,144 @@ SIGNIFICANT CHANGES SINCE LAST RELEASE PENDING: - DHD20231203: adjustment of soft temperature step from 0.1K to 0.01K. - DHD20231208: improving variable/parameter names. - DHD20231211: added Locations (URLs/DOIs) for this project to top-level README. + Javadoc warnings to clean up: + [javadoc] Building tree for all the packages and classes... + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/data/DDNTemperatureDataCSV.java:47: error: unknown tag: B0 + [javadoc] Datetime,Timezone,Date,Time,Temp (C),% Estimated + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/data/DDNTemperatureDataCSV.java:54: warning: no @param for data + [javadoc] public record DDNTemperatureDataCSV(List> data) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModel.java:21: error: no caption for table + [javadoc] * + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModel.java:45: warning: empty

tag + [javadoc] *

+ [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:130: warning: no @param for noSetback + [javadoc] public record DemandWithoutAndWithSetback(HeatAndElectricityDemand noSetback, HeatAndElectricityDemand withSetback) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:130: warning: no @param for withSetback + [javadoc] public record DemandWithoutAndWithSetback(HeatAndElectricityDemand noSetback, HeatAndElectricityDemand withSetback) + [javadoc] ^ + [javadoc] Generating /Users/dhd/git/out_C/javadoc/org/hd/d/TRVmodel/data/DDNTemperatureDataCSV.html... + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/data/DDNTemperatureDataCSV.java:56: warning: no comment + [javadoc] public DDNTemperatureDataCSV { Objects.requireNonNull(data); } + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/data/DDNTemperatureDataCSV.java:171: warning: no @param for gzippedCSV + [javadoc] public static DDNTemperatureDataCSV loadDDNTemperatureDataCSV(final File gzippedCSV) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/data/DDNTemperatureDataCSV.java:171: warning: no @return + [javadoc] public static DDNTemperatureDataCSV loadDDNTemperatureDataCSV(final File gzippedCSV) + [javadoc] ^ + [javadoc] Generating /Users/dhd/git/out_C/javadoc/org/hd/d/TRVmodel/hg/HGTRVHPMModel.html... + [javadoc] Generating /Users/dhd/git/out_C/javadoc/org/hd/d/TRVmodel/hg/HGTRVHPMModelByHour.html... + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelByHour.java:18: warning: no comment + [javadoc] public HGTRVHPMModelByHour + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelByHour.java:53: warning: no @return + [javadoc] public ScenarioResult runScenario(final boolean modelDetached, + [javadoc] ^ + [javadoc] Generating /Users/dhd/git/out_C/javadoc/org/hd/d/TRVmodel/hg/HGTRVHPMModelByHour.ScenarioResult.html... + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelByHour.java:35: warning: no comment + [javadoc] public ScenarioResult + [javadoc] ^ + [javadoc] Generating /Users/dhd/git/out_C/javadoc/org/hd/d/TRVmodel/hg/HGTRVHPMModelExtensions.html... + [javadoc] Generating /Users/dhd/git/out_C/javadoc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.html... + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:145: warning: no @param for flowC + [javadoc] public static double computeFlowCoP(final double flowC) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:145: warning: no @return + [javadoc] public static double computeFlowCoP(final double flowC) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:178: error: @param name not found + [javadoc] * @param IWFAabHLW internal wall/floor heat loss/transfer per A room (W) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:181: warning: no @param for IWAabHLW + [javadoc] public static double sbAMW(final double HHLsb, final double radWnsb, final double IWAabHLW) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:213: warning: no @return + [javadoc] private static double iwHeatLossPerA(final ModelParameters params) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:225: warning: no @return + [javadoc] private static double iwHeatLossPerA(final ModelParameters params, final double tempA) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:277: warning: no @return + [javadoc] private static double ifHeatLossPerA2Storey(final ModelParameters params) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:292: warning: no @return + [javadoc] private static double ifHeatLossPerA2Storey(final ModelParameters params, final double tempA) + [javadoc] ^ + [javadoc] Generating /Users/dhd/git/out_C/javadoc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.DemandWithoutAndWithSetback.html... + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:132: warning: no comment + [javadoc] public DemandWithoutAndWithSetback + [javadoc] ^ + [javadoc] Generating /Users/dhd/git/out_C/javadoc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.HeatAndElectricityDemand.html... + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:119: warning: no comment + [javadoc] public HeatAndElectricityDemand + [javadoc] ^ + [javadoc] Generating /Users/dhd/git/out_C/javadoc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.ModelParameters.html... + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:46: warning: no comment + [javadoc] public ModelParameters + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:74: warning: no @param for newExternalTemperature + [javadoc] public ModelParameters cloneWithAdjustedExternalTemperature(final double newExternalTemperature) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:74: warning: no @return + [javadoc] public ModelParameters cloneWithAdjustedExternalTemperature(final double newExternalTemperature) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:65: warning: no @param for doorsPerInternalWall + [javadoc] public ModelParameters(final double doorsPerInternalWall, final boolean correctCoPForFlowVsMW) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:65: warning: no @param for correctCoPForFlowVsMW + [javadoc] public ModelParameters(final double doorsPerInternalWall, final boolean correctCoPForFlowVsMW) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModelParameterised.java:69: warning: no @param for doorsPerInternalWall + [javadoc] public ModelParameters(final double doorsPerInternalWall) + [javadoc] ^ + [javadoc] Generating /Users/dhd/git/out_C/javadoc/org/hd/d/TRVmodel/data/HourlyTemperatureDataDescriptor.html... + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/data/HourlyTemperatureDataDescriptor.java:34: warning: no comment + [javadoc] public HourlyTemperatureDataDescriptor + [javadoc] ^ + [javadoc] Generating /Users/dhd/git/out_C/javadoc/org/hd/d/TRVmodel/Main.html... + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/Main.java:55: warning: no @param for args + [javadoc] public static void main(final String[] args) + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/Main.java:28: warning: use of default constructor, which does not provide a comment + [javadoc] public final class Main + [javadoc] ^ + [javadoc] Generating /Users/dhd/git/out_C/javadoc/org/hd/d/TRVmodel/hg/ShowComputations.html... + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/ShowComputations.java:20: warning: no description for @throws + [javadoc] * @throws IOException + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/ShowComputations.java:253: warning: no @param for stiff + [javadoc] public static String generateHTMLMainSummaryTable(final boolean stiff) throws IOException + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/ShowComputations.java:253: warning: no @return + [javadoc] public static String generateHTMLMainSummaryTable(final boolean stiff) throws IOException + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/ShowComputations.java:253: warning: no @throws for java.io.IOException + [javadoc] public static String generateHTMLMainSummaryTable(final boolean stiff) throws IOException + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/ShowComputations.java:340: warning: no @param for stiff + [javadoc] public static String generateLaTeXMainSummaryTable(final boolean stiff) throws IOException + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/ShowComputations.java:340: warning: no @return + [javadoc] public static String generateLaTeXMainSummaryTable(final boolean stiff) throws IOException + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/ShowComputations.java:340: warning: no @throws for java.io.IOException + [javadoc] public static String generateLaTeXMainSummaryTable(final boolean stiff) throws IOException + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/ShowComputations.java:435: warning: no @return + [javadoc] public static String generateHTMLSagTable() throws IOException + [javadoc] ^ + [javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/ShowComputations.java:435: warning: no @throws for java.io.IOException + [javadoc] public static String generateHTMLSagTable() throws IOException + + + + + @@ -28,6 +163,18 @@ PENDING: SIGNIFICANT RELEASES (newest first) =================================== +20231213: + freezepoint name: V0.9.6 + branch name: HEAD + Deployed where: (pre-release only) + Changes since last freezepoint (developer/mgr initials and brief description): + Previous significant freezepoint: V0.9.5 + DHD20231203: adjustment of soft temperature step from 0.1K to 0.01K. + DHD20231208: improving variable/parameter names. + DHD20231211: added Locations (URLs/DOIs) for this project to top-level README. + DHD20231213: freezing prior to code review(s). + + 20231203: freezepoint name: V0.9.5 branch name: HEAD diff --git a/build.xml b/build.xml index b3bd0e9..f9437a2 100644 --- a/build.xml +++ b/build.xml @@ -34,7 +34,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); - + diff --git a/javadoc/allclasses-index.html b/javadoc/allclasses-index.html index c473c21..6dd9cef 100644 --- a/javadoc/allclasses-index.html +++ b/javadoc/allclasses-index.html @@ -1,11 +1,11 @@ - -All Classes and Interfaces (TRVmodel V0.9.5 Javadoc) + +All Classes and Interfaces (TRVmodel V0.9.6 Javadoc) - + @@ -28,7 +28,7 @@