Skip to content

Commit

Permalink
V0.9.6
Browse files Browse the repository at this point in the history
  • Loading branch information
@DamonHD
DamonHD committed Dec 13, 2023
1 parent e4c6c58 commit 531bd62
Show file tree
Hide file tree
Showing 35 changed files with 2,610 additions and 2,425 deletions.
153 changes: 150 additions & 3 deletions RELEASES.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 (<B0>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<List<String>> data)
[javadoc] ^
[javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModel.java:21: error: no caption for table
[javadoc] * </table>
[javadoc] ^
[javadoc] /Users/dhd/git/TRVmodel/javasrc/org/hd/d/TRVmodel/hg/HGTRVHPMModel.java:45: warning: empty <p> tag
[javadoc] * <p>
[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








Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion build.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
<property name="app.name" value="TRVmodel"/>
<property name="app.version.major" value="0"/>
<property name="app.version.minor" value="9"/>
<property name="app.version.micro" value="5"/>
<property name="app.version.micro" value="6"/>
<property name="app.version" value="${app.version.major}.${app.version.minor}.${app.version.micro}"/>
<!-- Version excluding the "micro" portion, thus reflecting only significant API/functionality changes. -->
<property name="app.version.notmicro" value="${app.version.major}.${app.version.minor}"/>
Expand Down
8 changes: 4 additions & 4 deletions javadoc/allclasses-index.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) on Sun Dec 03 11:35:58 GMT 2023 -->
<title>All Classes and Interfaces (TRVmodel V0.9.5 Javadoc)</title>
<!-- Generated by javadoc (19) on Wed Dec 13 13:14:37 GMT 2023 -->
<title>All Classes and Interfaces (TRVmodel V0.9.6 Javadoc)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-12-03">
<meta name="dc.created" content="2023-12-13">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand All @@ -28,7 +28,7 @@
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language">
<a href="http://d.hd.org/" target="_top">TRVmodel</a> V0.9.5<br />
<a href="http://d.hd.org/" target="_top">TRVmodel</a> V0.9.6<br />
</div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
Expand Down
8 changes: 4 additions & 4 deletions javadoc/allpackages-index.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) on Sun Dec 03 11:35:58 GMT 2023 -->
<title>All Packages (TRVmodel V0.9.5 Javadoc)</title>
<!-- Generated by javadoc (19) on Wed Dec 13 13:14:37 GMT 2023 -->
<title>All Packages (TRVmodel V0.9.6 Javadoc)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-12-03">
<meta name="dc.created" content="2023-12-13">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand All @@ -28,7 +28,7 @@
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language">
<a href="http://d.hd.org/" target="_top">TRVmodel</a> V0.9.5<br />
<a href="http://d.hd.org/" target="_top">TRVmodel</a> V0.9.6<br />
</div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
Expand Down
26 changes: 16 additions & 10 deletions javadoc/constant-values.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) on Sun Dec 03 11:35:58 GMT 2023 -->
<title>Constant Field Values (TRVmodel V0.9.5 Javadoc)</title>
<!-- Generated by javadoc (19) on Wed Dec 13 13:14:37 GMT 2023 -->
<title>Constant Field Values (TRVmodel V0.9.6 Javadoc)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-12-03">
<meta name="dc.created" content="2023-12-13">
<meta name="description" content="summary of constants">
<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand All @@ -28,7 +28,7 @@
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language">
<a href="http://d.hd.org/" target="_top">TRVmodel</a> V0.9.5<br />
<a href="http://d.hd.org/" target="_top">TRVmodel</a> V0.9.6<br />
</div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
Expand Down Expand Up @@ -91,15 +91,21 @@ <h2 title="org.hd.*">org.hd.*</h2>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Constant Field</div>
<div class="table-header col-last">Value</div>
<div class="col-first even-row-color"><code id="org.hd.d.TRVmodel.hg.HGTRVHPMModel.COP_AT_46p0C">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second even-row-color"><code><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModel.html#COP_AT_46p0C">COP_AT_46p0C</a></code></div>
<div class="col-last even-row-color"><code>2.6</code></div>
<div class="col-first odd-row-color"><code id="org.hd.d.TRVmodel.hg.HGTRVHPMModel.COP_AT_51p5C">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second odd-row-color"><code><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModel.html#COP_AT_51p5C">COP_AT_51p5C</a></code></div>
<div class="col-last odd-row-color"><code>2.3</code></div>
<div class="col-first even-row-color"><code id="org.hd.d.TRVmodel.hg.HGTRVHPMModel.COP_DROP_pK">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second even-row-color"><code><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModel.html#COP_DROP_pK">COP_DROP_pK</a></code></div>
<div class="col-last even-row-color"><code>0.025</code></div>
<div class="col-first odd-row-color"><code id="org.hd.d.TRVmodel.hg.HGTRVHPMModel.CoPH">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second odd-row-color"><code><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModel.html#CoPH">CoPH</a></code></div>
<div class="col-last odd-row-color"><code>2.3</code></div>
<div class="col-first even-row-color"><code id="org.hd.d.TRVmodel.hg.HGTRVHPMModel.CoPHt">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second even-row-color"><code><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModel.html#CoPHt">CoPHt</a></code></div>
<div class="col-last even-row-color"><code>51.5</code></div>
<div class="col-first odd-row-color"><code id="org.hd.d.TRVmodel.hg.HGTRVHPMModel.CoPL">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second odd-row-color"><code><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModel.html#CoPL">CoPL</a></code></div>
<div class="col-last odd-row-color"><code>2.6</code></div>
<div class="col-first even-row-color"><code id="org.hd.d.TRVmodel.hg.HGTRVHPMModel.CoPLt">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second even-row-color"><code><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModel.html#CoPLt">CoPLt</a></code></div>
<div class="col-last even-row-color"><code>46.0</code></div>
<div class="col-first odd-row-color"><code id="org.hd.d.TRVmodel.hg.HGTRVHPMModel.EXTERNAL_AIR_TEMPERATURE_C">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second odd-row-color"><code><a href="org/hd/d/TRVmodel/hg/HGTRVHPMModel.html#EXTERNAL_AIR_TEMPERATURE_C">EXTERNAL_AIR_TEMPERATURE_C</a></code></div>
<div class="col-last odd-row-color"><code>-3.0</code></div>
Expand Down
Loading

0 comments on commit 531bd62

Please sign in to comment.