Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wrap AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl and AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR #4778

Merged
merged 100 commits into from Feb 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
100 commits
Select commit Hold shift + click to select a range
b41740e
Stub additions to idd.
joseph-robertson Dec 21, 2022
ef743a8
Stub new model files.
joseph-robertson Dec 21, 2022
da24b34
Stub new energyplus files.
joseph-robertson Dec 21, 2022
31754d1
Formatting.
joseph-robertson Dec 21, 2022
35efe16
Fix copy errors on model files.
joseph-robertson Dec 21, 2022
2707bfb
Fix copy errors on ft files.
joseph-robertson Dec 21, 2022
d7d9704
Formatting.
joseph-robertson Dec 21, 2022
78722e6
Typo in class name.
joseph-robertson Dec 22, 2022
740b878
Minor edits.
joseph-robertson Jan 3, 2023
af567f2
Merge branch 'develop' into vrf-temp-ctrl
joseph-robertson Jan 3, 2023
cc182c2
Create model and ft files using generateclass.
joseph-robertson Jan 4, 2023
8d12b0d
Formatting.
joseph-robertson Jan 4, 2023
80c11f4
Uncomment ft tests.
joseph-robertson Jan 4, 2023
95eeec1
Begin process of cleaning up after generateclass.
joseph-robertson Jan 4, 2023
b70f485
Updates for curves.
joseph-robertson Jan 4, 2023
054a202
Merge branch 'develop' into vrf-temp-ctrl
joseph-robertson Jan 4, 2023
4bbf836
Update os idd.
joseph-robertson Jan 5, 2023
9c92737
Clear out tests.
joseph-robertson Jan 5, 2023
0131343
Stub loading index extensible group class.
joseph-robertson Jan 5, 2023
022ca7d
Finish loading index class implementation.
joseph-robertson Jan 5, 2023
277340d
Add loading index methods to HR.
joseph-robertson Jan 5, 2023
bce2f1c
Add ft of loading indexes.
joseph-robertson Jan 6, 2023
6ba4d18
Stub model and ft test files.
joseph-robertson Jan 6, 2023
6fe0196
Got a pretty good handle on model tests.
joseph-robertson Jan 6, 2023
24aaa8e
Delete curve removes and add tests.
joseph-robertson Jan 6, 2023
5031a56
Finish ft test for first vrf object.
joseph-robertson Jan 9, 2023
b7a6def
Ubuntu build error: typo
jmarrec Jan 11, 2023
1d4fb49
Model tests for HR object.
joseph-robertson Jan 11, 2023
c7ee235
FT tests for HR object.
joseph-robertson Jan 11, 2023
ec160aa
Update HR model and ft tests.
joseph-robertson Jan 11, 2023
71ac8d2
Fix case of idd field and all methods downstream.
joseph-robertson Jan 13, 2023
cf0d70b
Minor updates to tests.
joseph-robertson Jan 17, 2023
06b8e25
Fix fluid default string.
joseph-robertson Jan 18, 2023
f70fb10
Support variable volume fan in zone hvac terminal unit vrf ft.
joseph-robertson Jan 19, 2023
e982c63
Test ft of variable volume fan.
joseph-robertson Jan 19, 2023
ed8a257
Updates for new vrf fluid temp ctrl coils.
joseph-robertson Jan 19, 2023
8e63abd
Add new dx vrf from generateclass.
joseph-robertson Jan 20, 2023
6ca2661
Update zonehvac vrf for hvaccomponent change.
joseph-robertson Jan 20, 2023
bcc59fb
Update cmakelists, other source files, formatting.
joseph-robertson Jan 20, 2023
aa2e469
Update new model and ft files.
joseph-robertson Jan 20, 2023
ffb158b
Stub new coil model tests.
joseph-robertson Jan 20, 2023
032dae6
Update new coil ft.
joseph-robertson Jan 20, 2023
6a72e51
Clean up in cooling coil.
joseph-robertson Jan 20, 2023
39182f8
Typo in coil heating ft.
joseph-robertson Jan 20, 2023
3042592
Fix typos in model file.
joseph-robertson Jan 21, 2023
2cc55e6
Fix typos and missing includes in ft.
joseph-robertson Jan 21, 2023
23f80f2
Model tests for cooling coil fluid temp ctrl.
joseph-robertson Jan 23, 2023
724f5d8
Update model and ft tests for vrf hr.
joseph-robertson Jan 23, 2023
0b96ed3
Update ctors to set all loading index fields.
joseph-robertson Jan 23, 2023
7dc98d3
Include extensible curves in remove override.
joseph-robertson Jan 24, 2023
5584949
Update remove model tests.
joseph-robertson Jan 24, 2023
c4f75b3
Forgot to change test value.
joseph-robertson Jan 24, 2023
002b76c
Add loading index model object to idd.
joseph-robertson Jan 24, 2023
5b0e7e1
Start updating for new model object lists approach.
joseph-robertson Jan 24, 2023
9b3d5ac
Update new loading index methods to mimic existing vrf terminal methods.
joseph-robertson Jan 25, 2023
3033a19
Progress on update of methods to use modelobjectlist.
joseph-robertson Jan 26, 2023
da88011
Add loading index model files.
joseph-robertson Jan 26, 2023
0c9cd95
Update other model files for new loading index.
joseph-robertson Jan 26, 2023
077c04e
Get all loading index methods updated.
joseph-robertson Jan 26, 2023
bcc5709
Update cpp and model tests.
joseph-robertson Jan 26, 2023
1d7fa70
Override children for loading index.
joseph-robertson Jan 26, 2023
0c46c2f
Fix remove and children and update model tests.
joseph-robertson Jan 26, 2023
ad27cd2
Merge pull request #4787 from NREL/vrf-temp-ctrl2
joseph-robertson Jan 27, 2023
2885910
Merge branch 'develop' into vrf-temp-ctrl
joseph-robertson Jan 27, 2023
cab41f0
Switch from straightcomponent to hvaccomponent.
joseph-robertson Jan 27, 2023
c3db80a
Fix cpp and update model tests.
joseph-robertson Jan 27, 2023
26a3b73
Update output var names and autosized metods.
joseph-robertson Jan 27, 2023
ffc5539
Remove optional in curve setters.
joseph-robertson Feb 2, 2023
06b0e63
Add convenience valid methods.
joseph-robertson Feb 2, 2023
6d52aad
Move autosized methods to correct location.
joseph-robertson Feb 2, 2023
916133a
Update loading index ctor.
joseph-robertson Feb 2, 2023
3ec06cf
Update remove model tests.
joseph-robertson Feb 2, 2023
2e89300
Updates in ft for performance.
joseph-robertson Feb 2, 2023
2583cc3
Add type for result.
joseph-robertson Feb 2, 2023
f501f89
Introduce new TBD release notes with API breaking changes.
joseph-robertson Feb 3, 2023
886a084
Minor typos.
joseph-robertson Feb 3, 2023
710bb9c
Better checks in ft tests.
joseph-robertson Feb 3, 2023
067c125
Update some syntax in ft.
joseph-robertson Feb 3, 2023
1e789c6
Create a ft no op for coil cooling water panel radiant.
joseph-robertson Feb 3, 2023
d0919b9
Clang format
jmarrec Feb 6, 2023
72d4837
Merge remote-tracking branch 'origin/develop' into vrf-temp-ctrl
jmarrec Feb 6, 2023
018132d
getConcreteModelObjects, part 2
jmarrec Feb 6, 2023
ff3124f
Fixup SWIG: order matters. They need to be defined after HVACComponen…
jmarrec Feb 6, 2023
c908557
Fixup includes and name the VRF Curves
jmarrec Feb 6, 2023
37bfda5
addLoadingIndex should return bool
jmarrec Feb 6, 2023
6e508ac
Adjust Unit tests for wanted behavior of clone / remove (for FluidCtr…
jmarrec Feb 6, 2023
01a4ed5
Adjust methods in FluidCtrl and FluidCtrlHR so that the clone / remov…
jmarrec Feb 6, 2023
746ef30
Add a **failing** (badly) clone + remove test for the existing AirCon…
jmarrec Feb 6, 2023
4fea937
`AirConditionerVariableRefrigerantFlow::clone` was changed to stop cl…
jmarrec Feb 6, 2023
973c385
Use createregisterandname in ft.
joseph-robertson Feb 6, 2023
3f09f6f
Avoid ft if no terminals, and add tests.
joseph-robertson Feb 6, 2023
06aafbb
Few typos.
joseph-robertson Feb 6, 2023
e297cbb
Fix new ft tests.
joseph-robertson Feb 6, 2023
1c8318e
Update ft tests for vrf object names.
joseph-robertson Feb 8, 2023
955c1cc
Formatting.
joseph-robertson Feb 8, 2023
80a8ec0
Update name field in proposed idd.
joseph-robertson Feb 8, 2023
5d460c0
Typo in idd field name.
joseph-robertson Feb 9, 2023
bea9275
Rename "Heat Pump Name" for AirCondVRF (existing one) + don't transla…
jmarrec Feb 10, 2023
8411966
Enforce matching Coil Types (FluidCtrl or not), Fan type based on coi…
jmarrec Feb 10, 2023
755c992
Misc unrelated cppcheck + extra non char in docstring
jmarrec Feb 14, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
96 changes: 96 additions & 0 deletions developer/doc/ReleaseNotes/OpenStudio_Release_Notes_3_6_0_TBD.md
@@ -0,0 +1,96 @@
# OpenStudio Version 3.6.0

_Release Notes_ - _TBD_

These release notes describe version 3.6.0 of the OpenStudio SDK developed by the National Renewable Energy Laboratory (NREL), Buildings and Thermal Sciences Center, Commercial Buildings Research Group, Tools Development Section, and associated collaborators. The notes are organized into the following sections:

- Overview
- Where to Find OpenStudio Documentation
- Installation Notes
- OpenStudio SDK: Changelog

# Overview

As of April 2020, development and distribution of the OpenStudioApplication and the SketchUp plugin have transitioned to the OpenStudio Coalition, who is independently managing and distributing the software through its own [openstudiocoalition/OpenStudioApplication](https://github.com/openstudiocoalition/OpenStudioApplication) repository. The OpenStudio SDK is continuing to be actively developed and distributed by NREL and is released two times per year, through a spring and a fall release.

Below is the list of components that is included in this SDK installer:

__**OpenStudio SDK 3.6.0**__
- EnergyPlus
- Command Line Interface (CLI)
- Radiance
- Ruby API
- C++ SDK

**Note** that [PAT](https://github.com/NREL/OpenStudio-PAT) is not included in either the SDK or the OpenStudio Coalition's Application installers. You will need to install PAT separately which is distributed on the [OpenStudio-PAT](https://github.com/NREL/OpenStudio-PAT) GitHub page.

# Where to Find OpenStudio SDK Documentation

- OpenStudio SDK release documentation, including these release notes, tutorials, and other user documentation, is available at [https://www.openstudio.net/](https://www.openstudio.net/.)
- C++ API documentation is available at [https://openstudio-sdk-documentation.s3.amazonaws.com/index.html](https://openstudio-sdk-documentation.s3.amazonaws.com/index.html)
- Measure development documentation is available at [http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/](http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/ )
- A roadmap for planned features is available at http://nrel.github.io/OpenStudio-user-documentation/getting_started/roadmap/.

# Installation Notes

OpenStudio SDK 3.6.0 is supported on 64-bit Windows 7 – 11, OS X 10.15, Ubuntu 18.04, 20.04 and Centos7

OpenStudio SDK 3.6.0 supports [EnergyPlus Release 22.1.0](https://github.com/NREL/EnergyPlus/releases/tag/v22.1.0), which is bundled with the OpenStudio installer. It is no longer necessary to download and install EnergyPlus separately. Other builds of EnergyPlus are not supported by OpenStudio SDK 3.6.0.

OpenStudio SDK 3.6.0 supports Radiance 5.0.a.12, which is bundled with the OpenStudio installer; users no longer must install Radiance separately, and OpenStudio will use the included Radiance version regardless of any other versions that may be installed on the system. Other builds of Radiance are not supported by OpenStudio SDK 3.6.0.

As usual, you can refer to the **[OpenStudio SDK Compatibility Matrix](https://github.com/NREL/OpenStudio/wiki/OpenStudio-SDK-Version-Compatibility-Matrix)** for more information.


## Installation Steps

- Download and install [OpenStudio SDK](https://github.com/NREL/openstudio) and/or [openstudiocoalition/OpenStudioApplication](https://github.com/openstudiocoalition/OpenStudioApplication) depending on your needs. Select components for installation. Note that OpenStudio Application is a standalone app and does not require you to install OpenStudio SDK.
- Setup a Building Component Library (BCL) account to access online building components and measures. View instructions on how to setup your account and configure the key in OpenStudio.
- The OpenStudio Application SketchUp Plug-in requires SketchUp 2021-2022 (not available for Linux). The OpenStudio Application SketchUp Plug-in does not support older versions of SketchUp. SketchUp must be installed before OpenStudio Application to automatically activate the plugin. If you install SketchUp after OpenStudio Application, simply re-run the OpenStudio Application installer.

For help with common installation problems please visit, http://nrel.github.io/OpenStudio-user-documentation/getting_started/getting_started/.

# OpenStudio SDK: Changelog

The 3.6.0 is a major release. This update includes several new features, performance improvements, and bug fixes.
You can find the list of Pull Requests that got into this release [here](https://github.com/NREL/OpenStudio/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aclosed+created%3A2021-04-27..2022-09-26+).


## Python Bindings

As of OpenStudio SDK 3.2.0, Python bindings are officially supported and distributed through Python Package Index (PyPI). To install, users will need to have Python3 installed along with pip and simply run the following command in a terminal window.

`pip install openstudio==3.6.0`

Please see [openstudio on PyPi](https://pypi.org/project/openstudio/) for further instructions on how to install. Users can also visit the test channel at [openstudio on TestPyPi](https://test.pypi.org/project/openstudio/) to install development bindings.

You can also refer to the [OpenStudio SDK Python Binding Version Compatibility Matrix](https://github.com/NREL/OpenStudio/wiki/OpenStudio-SDK-Python-Binding-Version-Compatibility-Matrix) to see the list of supported platforms and python versions.

## New Features, Major Fixes and API-breaking changes

* [#4778](https://github.com/NREL/OpenStudio/pull/4778) - Wrap AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl and AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR
* `ZoneHVAC:TerminalUnit:VariableRefrigerantFlow` has API-breaking changes related to setters and getters for its heating and cooling coils. They now use `HVACComponent` instead of the more restrictive `CoilHeatingDXVariableRefrigerantFlow` and `CoilCoolingDXVariableRefrigerantFlow`.
joseph-robertson marked this conversation as resolved.
Show resolved Hide resolved
* `AirConditionerVariableRefrigerantFlow::clone` was changed to stop cloning the child `Curve` objects (20 of them)

## Minor changes and bug fixes



**Deprecated methods removed**:

**Developer changes**:

**Full Changelog**: https://github.com/NREL/OpenStudio/compare/v3.5.1...v3.6.0

**New Contributors**:


### OpenStudio Standards v0.3.0



### OpenStudio Server 3.6.0



## Issue Statistics Since Previous Release
4 changes: 2 additions & 2 deletions resources/energyplus/ProposedEnergy+.idd
Expand Up @@ -38452,7 +38452,7 @@ AirConditioner:VariableRefrigerantFlow,
\memo or more electric compressors and outdoor fan). Serves one or more VRF zone terminal
\memo units. See ZoneHVAC:TerminalUnit:VariableRefrigerantFlow and ZoneTerminalUnitList.
\min-fields 37
A1 , \field Heat Pump Name
A1 , \field Name
\required-field
\type alpha
\reference-class-name validBranchEquipmentTypes
Expand Down Expand Up @@ -39015,7 +39015,7 @@ AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl,
\memo Indoor units are modeled separately, see ZoneHVAC:TerminalUnit:VariableRefrigerantFlow
\extensible:3 - repeat last three fields, remembering to remove ; from "inner" fields.
\min-fields 41
A1 , \field Heat Pump Name
A1 , \field Name
\required-field
\type alpha
\note Enter a unique name for this variable refrigerant flow heat pump
Expand Down