Skip to content

Commit

Permalink
deploy: f0bb7dd
Browse files Browse the repository at this point in the history
  • Loading branch information
steveraysteveray committed Oct 16, 2024
1 parent b1f455e commit 60ea5b5
Show file tree
Hide file tree
Showing 31 changed files with 73 additions and 97 deletions.
Binary file removed _images/explanation-GroundLoopExample.png
Binary file not shown.
Binary file removed _images/explanation-HeatExchangers-constraints.png
Binary file not shown.
Binary file removed _images/explanation-HeatExchangers-examples.png
Binary file not shown.
Binary file added _images/glycol_example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/mixed_medium.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions _sources/explanation/mixed_media.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Modeling Mixtures of medium

The 223 standard includes a large set of enumerations, defined as a hierarchy of subclasses under the class s223:EnumerationKind.
One important piece of this hierarchy is the class s223:EnumerationKind-Substance and its direct subclass Substance-Medium.
It is this branch of the hierarchy where you can find what you would expect to be flowing in a building, such as water, air and electricity. It is important to understand how a medium is modeled, especially when that medium is a mixture. The diagram below sketches the structure of the hierarchy. The names of the classes are abbreviated for clarity, so Substance-Medium is shown as Medium for example. In the standard, each of the names follows the hyphenated naming convention of \<parent class>-\<local class>.
![MixedMedium](_static/images/mixed_medium.png)
Note in the figure that there is a division of the Medium class into Mix and Constituent. The Mix class is further divided into Fluid and Power&Signal. Fluid means what you might think - a liquid or gas that typically flows inside some sort of conduit like a duct or a pipe. You can find Water and Air here. To capture the description of what is in a mixture, the model contains the class Constituent and its subclasses. These subclasses are intended to identify the constituents of a mixture. So, for example, a water-glycol mixture would be defined as Water-GlycolSolution, with two Properties via the relation s223:composedOf. Each of these Properties has a relation s223:ofConstituent that identifies one of the constituents from the Medium-Constituent hierarchy. Each Property also captures any other defining information. This is illustrated in the following figure for a 30% Water-Glycol mixture.
![GlycolExample](_static/images/glycol_example.png)
Mixtures (s223:Medium-Mix) and constituents (s223:Medium-Constituent) are modeled this way to allow for compatibility validation among ConnectionPoints and Connections. Two mediums are deemed compatible if they share at least one common constituent.
24 changes: 0 additions & 24 deletions _sources/explanation/model_heat_transfer.md

This file was deleted.

16 changes: 8 additions & 8 deletions _sources/tutorials/model_exploration.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"cells": [
{
"cell_type": "markdown",
"id": "6a4d4331",
"id": "4aaa6ba0",
"metadata": {},
"source": [
"# Model Exploration\n",
Expand All @@ -23,7 +23,7 @@
{
"cell_type": "code",
"execution_count": 1,
"id": "c28da84f",
"id": "6be3a102",
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -61,7 +61,7 @@
},
{
"cell_type": "markdown",
"id": "a3160412",
"id": "8b149128",
"metadata": {},
"source": [
"Next, we'll explore the model's size by printing the number of triples in it."
Expand All @@ -70,7 +70,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "8b7801b3",
"id": "bdec0e4c",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -80,7 +80,7 @@
},
{
"cell_type": "markdown",
"id": "94f91ad7",
"id": "4296745d",
"metadata": {},
"source": [
"Finally, we'll print the contents of the model since it's not that large."
Expand All @@ -89,7 +89,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "f0db218f",
"id": "d942adf1",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -99,7 +99,7 @@
},
{
"cell_type": "markdown",
"id": "a7282981",
"id": "2f861749",
"metadata": {},
"source": [
"## Model Querying\n",
Expand All @@ -114,7 +114,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "966bbd15",
"id": "2cb4781c",
"metadata": {},
"outputs": [],
"source": [
Expand Down
28 changes: 14 additions & 14 deletions _sources/tutorials/model_inference.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"cells": [
{
"cell_type": "markdown",
"id": "85600779",
"id": "af252565",
"metadata": {},
"source": [
"(model-inference)=\n",
Expand Down Expand Up @@ -35,7 +35,7 @@
{
"cell_type": "code",
"execution_count": 1,
"id": "cb2aaa92",
"id": "143d2379",
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -72,7 +72,7 @@
},
{
"cell_type": "markdown",
"id": "c064807c",
"id": "55753249",
"metadata": {},
"source": [
"<details>\n",
Expand All @@ -82,7 +82,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "beafdeed",
"id": "e0bd8189",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -91,7 +91,7 @@
},
{
"cell_type": "markdown",
"id": "913f5c48",
"id": "fbd3121d",
"metadata": {},
"source": [
"</details>\n",
Expand All @@ -105,7 +105,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "00ac05cb",
"id": "741d71ad",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -123,7 +123,7 @@
},
{
"cell_type": "markdown",
"id": "679d9231",
"id": "e1a9e0a9",
"metadata": {},
"source": [
"## Loading the 223 Ontology\n",
Expand All @@ -137,7 +137,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "4c37915d",
"id": "7c53b159",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -150,7 +150,7 @@
},
{
"cell_type": "markdown",
"id": "6d54cb19",
"id": "2996155d",
"metadata": {},
"source": [
"## Applying Inference Rules\n",
Expand All @@ -167,7 +167,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "52a80e51",
"id": "d778c1b9",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -194,7 +194,7 @@
},
{
"cell_type": "markdown",
"id": "b548ae2d",
"id": "45186fe4",
"metadata": {},
"source": [
"This may take a few minutes to run, depending on the size of your model.\n",
Expand All @@ -216,7 +216,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "04ff91a8",
"id": "7b5b7c57",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -225,7 +225,7 @@
},
{
"cell_type": "markdown",
"id": "21d31f0d",
"id": "69bf81f9",
"metadata": {},
"source": [
"</details>\n",
Expand All @@ -239,7 +239,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "7faa1509",
"id": "0f05f84b",
"metadata": {},
"outputs": [],
"source": [
Expand Down
2 changes: 1 addition & 1 deletion explanation/223_overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@
<li class="toctree-l1 current active"><a class="current reference internal" href="#">223 Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="graph_structure.html">223 Graph Structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="closed_world_assumption.html">Closed World Assumption</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_heat_transfer.html">Modeling Heat Transfer Equipment</a></li>
<li class="toctree-l1"><a class="reference internal" href="mixed_media.html">Modeling Mixtures of medium</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul class="nav bd-sidenav">
Expand Down
8 changes: 4 additions & 4 deletions explanation/closed_world_assumption.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'explanation/closed_world_assumption';</script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Modeling Heat Transfer Equipment" href="model_heat_transfer.html" />
<link rel="next" title="Modeling Mixtures of medium" href="mixed_media.html" />
<link rel="prev" title="223 Graph Structure" href="graph_structure.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
Expand Down Expand Up @@ -183,7 +183,7 @@
<li class="toctree-l1"><a class="reference internal" href="223_overview.html">223 Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="graph_structure.html">223 Graph Structure</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Closed World Assumption</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_heat_transfer.html">Modeling Heat Transfer Equipment</a></li>
<li class="toctree-l1"><a class="reference internal" href="mixed_media.html">Modeling Mixtures of medium</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -446,11 +446,11 @@ <h1>Closed World Assumption</h1>
</div>
</a>
<a class="right-next"
href="model_heat_transfer.html"
href="mixed_media.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Modeling Heat Transfer Equipment</p>
<p class="prev-next-title">Modeling Mixtures of medium</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
2 changes: 1 addition & 1 deletion explanation/definitions.html
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@
<li class="toctree-l1"><a class="reference internal" href="223_overview.html">223 Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="graph_structure.html">223 Graph Structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="closed_world_assumption.html">Closed World Assumption</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_heat_transfer.html">Modeling Heat Transfer Equipment</a></li>
<li class="toctree-l1"><a class="reference internal" href="mixed_media.html">Modeling Mixtures of medium</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul class="nav bd-sidenav">
Expand Down
2 changes: 1 addition & 1 deletion explanation/graph_structure.html
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@
<li class="toctree-l1"><a class="reference internal" href="223_overview.html">223 Overview</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">223 Graph Structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="closed_world_assumption.html">Closed World Assumption</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_heat_transfer.html">Modeling Heat Transfer Equipment</a></li>
<li class="toctree-l1"><a class="reference internal" href="mixed_media.html">Modeling Mixtures of medium</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul class="nav bd-sidenav">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Modeling Heat Transfer Equipment &#8212; ASHRAE Standard 223P User Documentation</title>
<title>Modeling Mixtures of medium &#8212; ASHRAE Standard 223P User Documentation</title>



Expand Down Expand Up @@ -57,7 +57,7 @@
<script async="async" src="../_static/sphinx-thebe.js?v=c100c467"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script>const THEBE_JS_URL = "https://unpkg.com/thebe@0.8.2/lib/index.js"; const thebe_selector = ".thebe,.cell"; const thebe_selector_input = "pre"; const thebe_selector_output = ".output, .cell_output"</script>
<script>DOCUMENTATION_OPTIONS.pagename = 'explanation/model_heat_transfer';</script>
<script>DOCUMENTATION_OPTIONS.pagename = 'explanation/mixed_media';</script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Model Exploration" href="../tutorials/model_exploration.html" />
Expand Down Expand Up @@ -183,7 +183,7 @@
<li class="toctree-l1"><a class="reference internal" href="223_overview.html">223 Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="graph_structure.html">223 Graph Structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="closed_world_assumption.html">Closed World Assumption</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Modeling Heat Transfer Equipment</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Modeling Mixtures of medium</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -271,7 +271,7 @@



<li><a href="https://github.com/open223/docs.open223.info/issues/new?title=Issue%20on%20page%20%2Fexplanation/model_heat_transfer.html&body=Your%20issue%20content%20here." target="_blank"
<li><a href="https://github.com/open223/docs.open223.info/issues/new?title=Issue%20on%20page%20%2Fexplanation/mixed_media.html&body=Your%20issue%20content%20here." target="_blank"
class="btn btn-sm btn-source-issues-button dropdown-item"
title="Open an issue"
data-bs-placement="left" data-bs-toggle="tooltip"
Expand Down Expand Up @@ -301,7 +301,7 @@



<li><a href="../_sources/explanation/model_heat_transfer.md" target="_blank"
<li><a href="../_sources/explanation/mixed_media.md" target="_blank"
class="btn btn-sm btn-download-source-button dropdown-item"
title="Download source file"
data-bs-placement="left" data-bs-toggle="tooltip"
Expand Down Expand Up @@ -383,7 +383,7 @@


<div id="jb-print-docs-body" class="onlyprint">
<h1>Modeling Heat Transfer Equipment</h1>
<h1>Modeling Mixtures of medium</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
Expand All @@ -397,24 +397,15 @@ <h1>Modeling Heat Transfer Equipment</h1>
<div id="searchbox"></div>
<article class="bd-article">

<section class="tex2jax_ignore mathjax_ignore" id="modeling-heat-transfer-equipment">
<h1>Modeling Heat Transfer Equipment<a class="headerlink" href="#modeling-heat-transfer-equipment" title="Link to this heading">#</a></h1>
<p>A variety of Equipment subclasses are defined in the 223 standard. The names of the classes are
intended to align with common names in the field as much as possible, but the technical distinctions
among them are defined in terms of the constraints they must satisfy. These constraints primarily
concern the patterns of allowed ConnectionPoints, both in terms of the Medium flowing and in terms of
the directionality and number of ConnectionPoints. A diagram summarizing all Equipment subclasses that
are involved in the transfer of heat is shown below. Note that instances of all of the classes shown
will have a role of Role-HeatTransfer in addition to other possible roles. Role-HeatTransfer is added
automatically using an inference rule.</p>
<p><img alt="HeatExchangeConstraints" src="../_images/explanation-HeatExchangers-constraints.png" /></p>
<p>While the constraints indicated in the figure are the defining characteristics of each of the classes,
it is easier to see how they are used by consulting the second figure that shows examples of
equipment commonly found in the field.</p>
<p><img alt="HeatExchangeExamples" src="../_images/explanation-HeatExchangers-examples.png" /></p>
<p>The figure below shows a ground loop from <a class="reference external" href="https://models.open223.info/examples/nist-bdg1-1.html#">NIST Example Building 1 Model 1</a>. The ground loop is modeled as
a Coil matching Pattern 2 of the constraints listed in the first figure above.</p>
<p><img alt="GroundLoopCoil" src="../_images/explanation-GroundLoopExample.png" /></p>
<section class="tex2jax_ignore mathjax_ignore" id="modeling-mixtures-of-medium">
<h1>Modeling Mixtures of medium<a class="headerlink" href="#modeling-mixtures-of-medium" title="Link to this heading">#</a></h1>
<p>The 223 standard includes a large set of enumerations, defined as a hierarchy of subclasses under the class s223:EnumerationKind.
One important piece of this hierarchy is the class s223:EnumerationKind-Substance and its direct subclass Substance-Medium.
It is this branch of the hierarchy where you can find what you would expect to be flowing in a building, such as water, air and electricity. It is important to understand how a medium is modeled, especially when that medium is a mixture. The diagram below sketches the structure of the hierarchy. The names of the classes are abbreviated for clarity, so Substance-Medium is shown as Medium for example. In the standard, each of the names follows the hyphenated naming convention of &lt;parent class&gt;-&lt;local class&gt;.
<img alt="MixedMedium" src="../_images/mixed_medium.png" />
Note in the figure that there is a division of the Medium class into Mix and Constituent. The Mix class is further divided into Fluid and Power&amp;Signal. Fluid means what you might think - a liquid or gas that typically flows inside some sort of conduit like a duct or a pipe. You can find Water and Air here. To capture the description of what is in a mixture, the model contains the class Constituent and its subclasses. These subclasses are intended to identify the constituents of a mixture. So, for example, a water-glycol mixture would be defined as Water-GlycolSolution, with two Properties via the relation s223:composedOf. Each of these Properties has a relation s223:ofConstituent that identifies one of the constituents from the Medium-Constituent hierarchy. Each Property also captures any other defining information. This is illustrated in the following figure for a 30% Water-Glycol mixture.
<img alt="GlycolExample" src="../_images/glycol_example.png" />
Mixtures (s223:Medium-Mix) and constituents (s223:Medium-Constituent) are modeled this way to allow for compatibility validation among ConnectionPoints and Connections. Two mediums are deemed compatible if they share at least one common constituent.</p>
</section>

<script type="text/x-thebe-config">
Expand Down
2 changes: 1 addition & 1 deletion explanation/purpose_scope.html
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@
<li class="toctree-l1"><a class="reference internal" href="223_overview.html">223 Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="graph_structure.html">223 Graph Structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="closed_world_assumption.html">Closed World Assumption</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_heat_transfer.html">Modeling Heat Transfer Equipment</a></li>
<li class="toctree-l1"><a class="reference internal" href="mixed_media.html">Modeling Mixtures of medium</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul class="nav bd-sidenav">
Expand Down
Loading

0 comments on commit 60ea5b5

Please sign in to comment.