CondFD Surface Heat Source Actuators #9151

mitchute · 2021-10-26T18:58:59Z

Pull request overview

Adds actuator for EMS-controlled heat source loads for CondFD surfaces.

Myoldmopar · 2021-11-02T19:33:10Z

design/FY2022/NFP-CondFDHeatSinkActuators.md

+
+## Testing
+
+The "PythonPlugin1ZoneUncontrolledCondFD" test files will be modified to include usage of the new actuator. This file will be used to validate the model to ensure that energy is conserved and that the actuators are working as expected.


This all seems reasonable. Adding an actuator for adding heat gain to a layer should be fine as long as the energy is tracked in the right meters. My only caution would be to keep the code changes as minimal as possible to avoid interfering with other changes in the cond-fd module.

mitchute

The basic functionality for this work is in place. I can still add some unit testing, but it would be good to get some reviewer eyes on this whenever possible.

mitchute · 2021-11-18T17:49:53Z

src/EnergyPlus/HeatBalFiniteDiffManager.cc

-            SurfaceFD(Surf).condMaterialActuators.allocate(state.dataConstruction->Construct(ConstrNum).TotLayers);
-            SurfaceFD(Surf).specHeatMaterialActuators.allocate(state.dataConstruction->Construct(ConstrNum).TotLayers);
+            SurfaceFD(Surf).condMaterialActuators.allocate(TotLayers);
+            SurfaceFD(Surf).specHeatMaterialActuators.allocate(TotLayers);
            SurfaceFD(Surf).condNodeReport.allocate(TotNodes + 1);
            SurfaceFD(Surf).specHeatNodeReport.allocate(TotNodes + 1);
+            SurfaceFD(Surf).heatSourceFluxMaterialActuators.allocate(TotLayers - 1);
+            SurfaceFD(Surf).heatSourceFluxLayerReport.allocate(TotLayers - 1);
+            SurfaceFD(Surf).heatSourceFluxEnergyLayerReport.allocate(TotLayers - 1);


Adding the new actuator, along with minor shuffling/refactoring.

This has nothing to do with this PR, but (to me) the only acceptable use of auto is right here.

auto & surfFD(SurfaceFD(Surf)); surf.condMaterialActuators.allocate(TotLayers); surf.condMaterialActuators.allocate(TotLayers); ...

This is probably the number one thing we can do for line-shortening and code readability in EnergyPlus. This is not a great example of that, but just imagine if SurfaceFD(Surf) were actually state.dataCondFD->SurfaceFD(Surf).

I started making another pass back through with this in mind after The Great State Refactor of 2020, but then pplz got grumpy. Maybe we can do some targeted application for the worst offenders.

Really? I would have thought people would have gotten grumpy because of the #GreatStateRefactor2020 #MakeEnergyPlusStateAgain and that would be a way to ungrumpify them!

mitchute · 2021-11-18T17:50:17Z

src/EnergyPlus/HeatBalFiniteDiffManager.cc

+                // only setup for heat source actuator for layers 1 to N-1
+                if (lay != TotLayers) {
+                    SurfaceFD(Surf).heatSourceFluxMaterialActuators(lay).actuatorName = actName;
+                }


Setup new actuator for layer 1 to N-1.

mitchute · 2021-11-18T17:50:47Z

src/EnergyPlus/HeatBalFiniteDiffManager.cc

+            // Setup EMS Actuator and Output Variables for Heat Flux
+            // Only setup for layers 1 to N-1
+            for (int lay = 1; lay < state.dataConstruction->Construct(ConstrNum).TotLayers; ++lay) {
+                EnergyPlus::SetupEMSActuator(state,
+                                             "CondFD Surface Material Layer",
+                                             SurfaceFD(SurfNum).heatSourceFluxMaterialActuators(lay).actuatorName,
+                                             "Heat Flux",
+                                             "[W/m2]",
+                                             SurfaceFD(SurfNum).heatSourceFluxMaterialActuators(lay).isActuated,
+                                             SurfaceFD(SurfNum).heatSourceFluxMaterialActuators(lay).actuatedValue);
+                SetupOutputVariable(state,
+                                    format("CondFD Heat Source Power After Layer {}", lay),
+                                    OutputProcessor::Unit::W,
+                                    SurfaceFD(SurfNum).heatSourceFluxLayerReport(lay),
+                                    OutputProcessor::SOVTimeStepType::Zone,
+                                    OutputProcessor::SOVStoreType::State,
+                                    state.dataSurface->Surface(SurfNum).Name);
+                SetupOutputVariable(state,
+                                    format("CondFD Heat Source Energy After Layer {}", lay),
+                                    OutputProcessor::Unit::J,
+                                    SurfaceFD(SurfNum).heatSourceFluxEnergyLayerReport(lay),
+                                    OutputProcessor::SOVTimeStepType::Zone,
+                                    OutputProcessor::SOVStoreType::Summed,
+                                    state.dataSurface->Surface(SurfNum).Name,
+                                    _,
+                                    "Electricity",
+                                    "Heating",
+                                    _,
+                                    "Building");


New EMS actuator and output variables.

mitchute · 2021-11-18T17:51:37Z

src/EnergyPlus/HeatBalFiniteDiffManager.cc

-            for (Lay = 1; Lay <= TotNodes + 1; ++Lay) {                                        // include inside face node
+            for (int node = 1; node <= TotNodes + 1; ++node) {                                        // include inside face node


Minor refactoring. These outputs are at the node level, not the "layer" level. Just changing the indexer here to reflect that.

mitchute · 2021-11-18T17:52:36Z

src/EnergyPlus/HeatBalFiniteDiffManager.cc

-                Real64 const QSSFlux((surface.Area > 0.0) && (construct.SourceSinkPresent && Lay == construct.SourceAfterLayer)
-                                         ? (state.dataHeatBalFanSys->QRadSysSource(Surf) + state.dataHeatBalFanSys->QPVSysSource(Surf)) / surface.Area
-                                         : 0.0); // Source/Sink flux value at a layer interface // Includes QPV Source
+                Real64 QSSFlux = 0.0;
+                if ((surface.Area > 0.0) && (construct.SourceSinkPresent && Lay == construct.SourceAfterLayer)) {
+                    // Source/Sink flux value at a layer interface // Includes QPV Source
+                    QSSFlux = (state.dataHeatBalFanSys->QRadSysSource(Surf) + state.dataHeatBalFanSys->QPVSysSource(Surf)) / surface.Area;
+                }
+
+                // Add EMS actuated value
+                if (heatFluxActuator.isActuated) {
+                    Real64 actuatedVal = heatFluxActuator.actuatedValue;
+                    if (actuatedVal >= 0) {
+                        QSSFlux += heatFluxActuator.actuatedValue;
+                    } else {
+                        ShowSevereError(state, fmt::format("Surface: {}, Material: {}", surface.Name, mat.Name));
+                        ShowContinueError(state, "EMS Actuator does not support negative values");
+                        ShowFatalError(state, "Program terminates due to preceding conditions.");
+                    }
+
+                    // Update report variables
+                    auto &surfFD = state.dataHeatBalFiniteDiffMgr->SurfaceFD(Surf);
+                    surfFD.heatSourceFluxLayerReport(Lay) = QSSFlux * surface.Area;
+                    surfFD.heatSourceFluxEnergyLayerReport(Lay) = QSSFlux * surface.Area * state.dataGlobal->TimeStepZoneSec;
+                }


Acuating here, which is an addition to whatever is also occurring due to the InternalHeatSource object.

mitchute · 2021-11-18T17:53:01Z

testfiles/PythonPlugin1ZoneUncontrolledCondFD.idf

+  Output:Variable,*,CondFD Heat Source Power After Layer 1,hourly;
+
+  Output:Variable,*,CondFD Heat Source Power After Layer 2,hourly;
+
+  Output:Variable,*,CondFD Heat Source Power After Layer 3,hourly;
+
+  Output:Variable,*,CondFD Heat Source Power After Layer 4,hourly;
+
+  Output:Variable,*,CondFD Heat Source Power After Layer 5,hourly;
+
+  Output:Variable,*,CondFD Heat Source Power After Layer 6,hourly;
+
+  Output:Variable,*,CondFD Heat Source Energy After Layer 1,hourly;
+
+  Output:Variable,*,CondFD Heat Source Energy After Layer 2,hourly;
+
+  Output:Variable,*,CondFD Heat Source Energy After Layer 3,hourly;
+
+  Output:Variable,*,CondFD Heat Source Energy After Layer 4,hourly;
+
+  Output:Variable,*,CondFD Heat Source Energy After Layer 5,hourly;
+
+  Output:Variable,*,CondFD Heat Source Energy After Layer 6,hourly;


New output variables.

mitchute · 2021-11-18T17:53:21Z

testfiles/PythonPlugin1ZoneUncontrolledCondFD.idf

-    12,                      !- End Month
+    1,                       !- End Month


No need to run this file for a full year.

mitchute · 2021-11-18T17:53:43Z

testfiles/PythonPlugin1ZoneUncontrolledCondFD.py

+        for surface_name in surfaces_names:
+            constr = Construction(surface_name)
+            constr.set_material_layers(wall_materials)
+            self.surfaces.append(constr)
+
+        # test surface for heat flux actuators
+        wall_materials = ["Drywall 0.25 in. lay-1"]
+        surfaces_names = ["Zn001:Wall004"]
+


Updating this file to actuate the heat source for one surface.

nrel-bot · 2021-12-22T00:23:45Z

@mitchute @Myoldmopar it has been 28 days since this pull request was last updated.

mjwitte

A few initial comments.

mjwitte · 2021-12-22T23:03:48Z

src/EnergyPlus/HeatBalFiniteDiffManager.cc

                // Actuator name format: "{SurfName}:{MaterialLayerName}"
                std::string actName = fmt::format("{}:{}", state.dataSurface->Surface(Surf).Name, state.dataMaterial->Material(matLay).Name);


All of this EMS setup here and below should be inside an if (state.dataGlobal->AnyEnergyManagementSystemInModel) (well, as much of it as possible).

mjwitte · 2021-12-22T23:17:15Z

src/EnergyPlus/HeatBalFiniteDiffManager.cc

+                SetupOutputVariable(state,
+                                    format("CondFD Heat Source Energy After Layer {}", lay),
+                                    OutputProcessor::Unit::J,
+                                    SurfaceFD(SurfNum).heatSourceFluxEnergyLayerReport(lay),


Looks like this is the total QSSFlux which may include energy from Construction:InternalSource along with the actuator energy. This is fine as an output variable, but shouldn't be on the electric meter. You'll need a separate output variable for the meter, like "CondFD EMS Actuator Heat Source Energy After Layer {}"?

…update docs

mitchute · 2021-12-28T03:20:46Z

src/EnergyPlus/HeatBalFiniteDiffManager.cc

-                                             "[J/kg-C]",
-                                             SurfaceFD(SurfNum).specHeatMaterialActuators(mat).isActuated,
-                                             SurfaceFD(SurfNum).specHeatMaterialActuators(mat).actuatedValue);
+


@mjwitte I rearranged this to break out the internal source and EMS source values on separate output variables. The EMS value is now the only one on the meter.

I'm also only protecting the setup of the actuators and output variables here with AnyEnergyManagementSystemInModel - it would be too big of a refactor to protect the rest of it with that flag.

mitchute · 2021-12-28T03:21:19Z

doc/ems-application-guide/src/ems-actuators/thermal-envelope.tex

@@ -107,4 +107,35 @@ \subsection{Surface Boundary Conditions}\label{surface-boundary-conditions}

 \subsection{Conduction Finite Difference}\label{conduction-finite-difference}

-Two actuators, called ``CondFD Surface Material Layer,'' are available with actuated component control types called ``Thermal Conductivity'' in [W/m-K] and ``Specific Heat'' in [J/kg-C]. These actuators are available in models that use the Conduction Finite Difference solution for conduction through surfaces.
+Several actuators, called ``CondFD Surface Material Layer,'' are available with actuated component control types for models that use the Conduction Finite Difference solution for conduction through surfaces. These are described below.


Updated EMS docs.

mitchute · 2021-12-28T03:22:17Z

doc/input-output-reference/src/overview/group-surface-construction-elements.tex

+\paragraph{CondFD Internal Heat Source Power After Layer}
+
+This output is the heat power added after material layer N from the \hyperref[constructioninternalsource]{ConstructionProperty:InternalHeatSource} object. Only valid for the CondFD solution algorithm.
+
+\paragraph{CondFD Internal Heat Source Energy After Layer}
+
+This output is the heat energy added after material layer N from the \hyperref[constructioninternalsource]{ConstructionProperty:InternalHeatSource} object. Only valid for the CondFD solution algorithm.
+


Doc updates in the InternalSource object reflecting the new, conditionally-available output variables.

mitchute · 2021-12-28T18:54:15Z

Diffs look reasonable here given the changes, and the clang-format error looks like a GHA error. @Myoldmopar do you need me to take a look at that?

Ign:1 https://security.ubuntu.com/ubuntu groovy-security InRelease
Err:2 https://security.ubuntu.com/ubuntu groovy-security Release
  404  Not Found [IP: 91.189.91.38 80]
Ign:3 https://archive.ubuntu.com/ubuntu groovy InRelease
Ign:4 https://archive.ubuntu.com/ubuntu groovy-updates InRelease
Ign:5 https://archive.ubuntu.com/ubuntu groovy-backports InRelease
Err:6 https://archive.ubuntu.com/ubuntu groovy Release
  404  Not Found [IP: 91.189.88.142 80]
Err:7 https://archive.ubuntu.com/ubuntu groovy-updates Release
  404  Not Found [IP: 91.189.88.142 80]
Err:8 https://archive.ubuntu.com/ubuntu groovy-backports Release
  404  Not Found [IP: 91.189.88.142 80]
Reading package lists...
E: The repository 'https://security.ubuntu.com/ubuntu groovy-security Release' does not have a Release file.
E: The repository 'https://archive.ubuntu.com/ubuntu groovy Release' does not have a Release file.
E: The repository 'https://archive.ubuntu.com/ubuntu groovy-updates Release' does not have a Release file.
E: The repository 'https://archive.ubuntu.com/ubuntu groovy-backports Release' does not have a Release file.
/entrypoint.sh: line 22: /usr/bin/clang-format-10: No such file or directory

/entrypoint.sh: line 22: /usr/bin/clang-format-10: No such file or directory

Feel free to let me know if you see anything else here.

Myoldmopar · 2021-12-28T22:59:14Z

That was really confusing. It's because the Clang-Format Github Action that we used was based specifically on Ubuntu Groovy, which is now out of support. We need to update to a newer version of that action. It looks like if we use 3.5.2 it will use Ubuntu Focal. (https://github.com/jidicula/clang-format-action/blob/v3.5.2/Dockerfile). We just need to change this line to use 3.5.2 and try it out.

mitchute · 2021-12-29T01:09:33Z

@Myoldmopar 3.5.2 works here.

Myoldmopar · 2021-12-29T16:14:14Z

@mjwitte this is looking ready except for your outstanding review. Can you confirm whether or not @mitchute addressed your request? Thanks!

mitchute · 2021-12-29T21:08:13Z

There's a branch with a bug fix (which will cause diffs) over here: https://github.com/NREL/EnergyPlus/tree/condfd-actuator-bug. That branch is downstream of this one, so once we merge this I'll file a new issue and PR for that one so the diffs and changes can be reviewed separately.

mjwitte

Unit tests run serially, modified idf/py runs to completion with a psych warning (didn't really check to see if the actuator actually actuates anything, but I'll assume it does).

So this is good to go. Merging.

mjwitte · 2021-12-30T16:46:51Z

doc/ems-application-guide/src/ems-actuators/thermal-envelope.tex

+Several actuators, called ``CondFD Surface Material Layer,'' are available with actuated component control types for models that use the Conduction Finite Difference solution for conduction through surfaces. These are described below.
+
+\begin{itemize}
+    \item ``Thermal Conductivity''. Has units of [W/m-K]. Controls the thermal conductivity of the specified material layer within a given surface. Actuator is named from the surface name and material layer name combined with a colon ":". E.g. "SURFNAME:MATERIALLAYERNAME"


This line has some incorrect quotation marks, but that can be fixed in the next CondFD PR.

mjwitte · 2021-12-30T17:42:44Z

doc/input-output-reference/src/overview/group-surface-construction-elements.tex

+
+This output is the heat power added after material layer N from the \hyperref[constructioninternalsource]{ConstructionProperty:InternalHeatSource} object. Only valid for the CondFD solution algorithm.
+
+\paragraph{CondFD Internal Heat Source Energy After Layer}


The two new "CondFD EMS Heat Source ..." outputs should be here also. Again, in the next PR.

CondFD Surface Heat Source Actuators

add NFP [decent_ci_skip] [actions_skip]

8439fe1

mitchute added the NewFeature Includes code to add a new feature to EnergyPlus label Oct 26, 2021

mitchute added this to the EnergyPlus 2022.1 milestone Oct 26, 2021

mitchute self-assigned this Oct 26, 2021

Myoldmopar reviewed Nov 2, 2021

View reviewed changes

mitchute added 8 commits November 9, 2021 18:00

Merge branch 'develop' into condfd-heat-sink-actuator

21401e2

Merge branch 'develop' into condfd-heat-sink-actuator

d67b1e8

Merge branch 'develop' into condfd-heat-sink-actuator

da88f0b

add basic functionality for ems actuators for CondFD heat flux

e2ef761

add report variables for new actuator

e213f42

Merge branch 'develop' into condfd-heat-sink-actuator

050f4e9

update NFP

fc02cc8

Merge branch 'develop' into condfd-heat-sink-actuator

1d63f38

mitchute commented Nov 18, 2021

View reviewed changes

mitchute changed the title ~~CondFD Surface Heat Sink Actuators~~ CondFD Surface Heat Source Actuators Nov 18, 2021

mitchute added 4 commits November 23, 2021 10:56

Merge branch 'develop' into condfd-heat-sink-actuator

3d4f7f5

fix error file warnings, update docs

df09215

clang-format

f3b4b9a

Merge branch 'develop' into condfd-heat-sink-actuator

26e66c7

mjwitte requested changes Dec 22, 2021

View reviewed changes

mitchute added 2 commits December 27, 2021 18:41

Merge branch 'develop' into condfd-heat-sink-actuator

67cda39

add/rearange output vars for internal source and ems source objects, …

4f7c055

…update docs

mitchute commented Dec 28, 2021

View reviewed changes

Update clang-format-check.yml

ebb16ca

mjwitte approved these changes Dec 30, 2021

View reviewed changes

mjwitte merged commit 050eb08 into develop Dec 30, 2021

mjwitte deleted the condfd-heat-sink-actuator branch December 30, 2021 17:46

yujiex pushed a commit that referenced this pull request Jan 27, 2022

Merge pull request #9151 from NREL/condfd-heat-sink-actuator

7387c5f

CondFD Surface Heat Source Actuators

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CondFD Surface Heat Source Actuators #9151

CondFD Surface Heat Source Actuators #9151

mitchute commented Oct 26, 2021 •

edited

Loading

Myoldmopar Nov 2, 2021

mitchute left a comment

mitchute Nov 18, 2021

amirroth Nov 18, 2021

mitchute Nov 18, 2021

amirroth Nov 18, 2021

mitchute Nov 18, 2021

mitchute Nov 18, 2021

mitchute Nov 18, 2021

mitchute Nov 18, 2021

mitchute Nov 18, 2021

mitchute Nov 18, 2021

mitchute Nov 18, 2021

nrel-bot commented Dec 22, 2021

mjwitte left a comment

mjwitte Dec 22, 2021

mjwitte Dec 22, 2021

mitchute Dec 28, 2021

mitchute Dec 28, 2021

mitchute Dec 28, 2021

mitchute commented Dec 28, 2021

Myoldmopar commented Dec 28, 2021

mitchute commented Dec 29, 2021

Myoldmopar commented Dec 29, 2021

mitchute commented Dec 29, 2021

mjwitte left a comment

mjwitte Dec 30, 2021

mjwitte Dec 30, 2021


		## Testing

		The "PythonPlugin1ZoneUncontrolledCondFD" test files will be modified to include usage of the new actuator. This file will be used to validate the model to ensure that energy is conserved and that the actuators are working as expected.

		for (Lay = 1; Lay <= TotNodes + 1; ++Lay) { // include inside face node
		for (int node = 1; node <= TotNodes + 1; ++node) { // include inside face node

		// Actuator name format: "{SurfName}:{MaterialLayerName}"
		std::string actName = fmt::format("{}:{}", state.dataSurface->Surface(Surf).Name, state.dataMaterial->Material(matLay).Name);


		This output is the heat power added after material layer N from the \hyperref[constructioninternalsource]{ConstructionProperty:InternalHeatSource} object. Only valid for the CondFD solution algorithm.

		\paragraph{CondFD Internal Heat Source Energy After Layer}

CondFD Surface Heat Source Actuators #9151

CondFD Surface Heat Source Actuators #9151

Conversation

mitchute commented Oct 26, 2021 • edited Loading

Pull request overview

Choose a reason for hiding this comment

mitchute left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nrel-bot commented Dec 22, 2021

mjwitte left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mitchute commented Dec 28, 2021

Myoldmopar commented Dec 28, 2021

mitchute commented Dec 29, 2021

Myoldmopar commented Dec 29, 2021

mitchute commented Dec 29, 2021

mjwitte left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mitchute commented Oct 26, 2021 •

edited

Loading