Skip to content

Commit

Permalink
Updated user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mwetter committed Mar 23, 2016
1 parent d7fac39 commit 150d7d1
Show file tree
Hide file tree
Showing 34 changed files with 11,748 additions and 10,980 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: f6195d180470600d4136a7b79dbae646
config: bf3767e4a7282a2fc86baca3ccf4402f
tags: 645f666f9bcd5a90fca523b33c5a78b7
Original file line number Diff line number Diff line change
Expand Up @@ -266,16 +266,15 @@ Consider the flow circuit shown below that consists of a pump or fan, a flow res

When this model is used with a medium model that models
:term:`compressible flow`, such as
the medium model `Buildings.Media.IdealGases.SimpleAir <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Media_IdealGases_SimpleAir.html#Buildings.Media.IdealGases.SimpleAir>`_,
the medium model `Buildings.Media.Air <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Media_Air.html#Buildings.Media.Air>`_,
then the model is well defined because the gas medium implements the
equation :math:`p=\rho \, R \, T`,
where :math:`p` is the static pressure, :math:`\rho` is the mass density,
:math:`R` is the gas constant and :math:`T` is the absolute temperature.

However, when the medium model is changed to a model that models
:term:`incompressible flow`, such as
`Buildings.Media.GasesConstantDensity.SimpleAir <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Media_GasesConstantDensity_SimpleAir.html#Buildings.Media.GasesConstantDensity.SimpleAir>`_ or
`Buildings.Media.ConstantPropertyLiquidWater <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Media_ConstantPropertyLiquidWater.html#Buildings.Media.ConstantPropertyLiquidWater>`_,
`Buildings.Media.Water <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Media_Water.html#Buildings.Media.Water>`_,
then the density is constant. Consequently, there is no equation that
can be used to compute the pressure based on the volume.
In this situation, attempting to translate the model leads, in Dymola, to the following error message:
Expand All @@ -288,7 +287,7 @@ In this situation, attempting to translate the model leads, in Dymola, to the fo
The number of scalar Real unknown elements are 58.
The number of scalar Real equation elements are 58.

Similarly, if the medium model `Modelica.Media.Water.WaterIF97OnePhase_ph <http://simulationresearch.lbl.gov/modelica/releases/msl/3.2/help/Modelica_Media_Water_WaterIF97OnePhase_ph.html#Modelica.Media.Water.WaterIF97OnePhase_ph>`_,
Similarly, if the medium model `Buildings.Media.Specialized.Water.TemperatureDependentDensity <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Media_Specialized_Water_TemperatureDependentDensity.html#Buildings.Media.Specialized.Water.TemperatureDependentDensity>`_,
which models density as a function of pressure and enthalpy, is used, then
the model is well-defined, but the pressure increases the longer the pump runs.
The reason is that the pump adds heat to the water. When the water temperature
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ To add a component of a thermofluid flow device, the package
See `Buildings.Fluid.Interface.UsersGuide <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_Interfaces_UsersGuide.html#Buildings.Fluid.Interfaces.UsersGuide>`_ for a description of these classes.
Alternatively, simple models such as the models below may be used as a starting point for implementing new models for thermofluid flow devices:

`Buildings.Fluid.HeatExchangers.HeaterCoolerPrescribed <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_HeatExchangers.html#Buildings.Fluid.HeatExchangers.HeaterCoolerPrescribed>`_
`Buildings.Fluid.HeatExchangers.HeaterCooler_u <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_HeatExchangers.html#Buildings.Fluid.HeatExchangers.HeaterCooler_u>`_
For a device that adds heat to a fluid stream.

`Buildings.Fluid.MassExchangers.HumidifierPrescribed <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_MassExchangers.html#Buildings.Fluid.MassExchangers.HumidifierPrescribed>`_
`Buildings.Fluid.MassExchangers.Humidifier_u <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_MassExchangers.html#Buildings.Fluid.MassExchangers.Humidifier_u>`_
For a device that adds humidity to a fluid stream.

`Buildings.Fluid.Chillers.Carnot <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_Chillers.html#Buildings.Fluid.Chillers.Carnot>`_
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ When submitting a bug report, please provide:

To report the bug, enter a new issue at https://github.com/lbl-srg/modelica-buildings/issues

For general questions regarding the `Buildings` library, send email to https://groups.google.com/group/modelica-buildings. This is an open group and everyone can join it. No invitation is needed.
For general questions regarding the `Buildings` library, use
https://unmethours.com/questions/.
This is an open group and everyone can join it. No invitation is needed.

For questions that are specific to Modelica but not the `Buildings` libray, see http://stackoverflow.com/search?q=modelica
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Copyright and License
=====================

Copyright (c) 2012-2013, The Regents of the University of California, Department
Copyright (c) 2012-2015, The Regents of the University of California, Department
of Energy contract-operators of the Lawrence Berkeley National Laboratory.
All rights reserved.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -91,6 +91,30 @@ jQuery.fn.highlightText = function(text, className) {
});
};

/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();

var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];

return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}

/**
* Small JavaScript module for the documentation.
*/
Expand Down Expand Up @@ -152,9 +176,10 @@ var Documentation = {

/**
* workaround a firefox stupidity
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
*/
fixFirefoxAnchorBug : function() {
if (document.location.hash && $.browser.mozilla)
if (document.location.hash)
window.setTimeout(function() {
document.location.href += '';
}, 10);
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 150d7d1

Please sign in to comment.