diff --git a/Buildings/Resources/Documentation/userGuide/build/html/_sources/bestPractice.rst.txt b/Buildings/Resources/Documentation/userGuide/build/html/_sources/bestPractice.rst.txt index 1b1dd86cc57..a2218f71d63 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/_sources/bestPractice.rst.txt +++ b/Buildings/Resources/Documentation/userGuide/build/html/_sources/bestPractice.rst.txt @@ -231,7 +231,7 @@ In some situation, such as the configuration below, connecting multiple connecto Connection of three components without explicitly introducing a mixer or splitter model. However, in more complex flow configurations, one may want to explicitly control what branches of a piping or duct network mix. This may be achieved by using an instance of the model -`SplitterFixedResistanceDpM `_ as shown in the left figure below, which is the test model +`PressureDrop `_ as shown in the left figure below, which is the test model `BoilerPolynomialClosedLoop `_ .. figure:: img/fluidJunctionMixingSplitter.png @@ -363,7 +363,7 @@ parameters in various model to help the user understand how they are used. | ``m_flow_nominal`` | | Flow resistance models. | These parameters may be used to define a point on the flow rate | | ``dp_nominal`` | | versus pressure drop curve. For other mass flow rates, the pressure drop | | | | is typically adjusted using similarity laws. | -| | | See FixedResistanceDpM_. | +| | | See PressureDrop_. | +---------------------+---------------------------+--------------------------------------------------------------------------+ | ``m_flow_nominal`` | | Sensors. | Some of these models set ``m_flow_small=1E-4*abs(m_flow_nominal)`` | | ``m_flow_small`` | | Volumes. | as the default value. Then, m_flow_small is used to regularize, or | @@ -749,5 +749,5 @@ As an extreme case, if a system is chaotic and uncontrolled, then the global integration error will grow rapidly. -.. _FixedResistanceDpM: http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_FixedResistances.html#Buildings.Fluid.FixedResistances.FixedResistanceDpM +.. _PressureDrop: http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_FixedResistances.html#Buildings.Fluid.FixedResistances.PressureDrop .. _WetCoilDiscretized: http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_HeatExchangers.html#Buildings.Fluid.HeatExchangers.WetCoilDiscretized diff --git a/Buildings/Resources/Documentation/userGuide/build/html/_sources/gettingStarted.rst.txt b/Buildings/Resources/Documentation/userGuide/build/html/_sources/gettingStarted.rst.txt index 75cc5b28f43..92d0bc44d2e 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/_sources/gettingStarted.rst.txt +++ b/Buildings/Resources/Documentation/userGuide/build/html/_sources/gettingStarted.rst.txt @@ -19,6 +19,14 @@ Although the `Modelica Language Tutorial `_ final report +summarizes the development of Modelica models, approaches and tools +for co-simulation based on the Functional Mockup Interface standard, +Building Information Modeling technologies based on the Industry Foundation Classes, +as well as tools for workflow automation. +It also contains numerous examples that apply these technologies to the +design and operation of building and community energy systems. + Literature for Developers ------------------------- diff --git a/Buildings/Resources/Documentation/userGuide/build/html/_sources/help.rst.txt b/Buildings/Resources/Documentation/userGuide/build/html/_sources/help.rst.txt index 40faa1d8bfb..a48bb3dbcb6 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/_sources/help.rst.txt +++ b/Buildings/Resources/Documentation/userGuide/build/html/_sources/help.rst.txt @@ -16,4 +16,4 @@ 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 +For questions that are specific to Modelica but not the `Buildings` libray, see https://stackoverflow.com/search?q=modelica diff --git a/Buildings/Resources/Documentation/userGuide/build/html/_sources/workArounds.rst.txt b/Buildings/Resources/Documentation/userGuide/build/html/_sources/workArounds.rst.txt index 9a26b9a6193..e14bd23b136 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/_sources/workArounds.rst.txt +++ b/Buildings/Resources/Documentation/userGuide/build/html/_sources/workArounds.rst.txt @@ -55,7 +55,7 @@ Breaking algebraic loops ------------------------ In fluid flow systems, flow junctions where mass flow rates separate and mix can couple non-linear systems of equations. This leads to larger systems of coupled equations that need to be solved, which often causes larger computing time and can sometimes cause convergence problems. -To decouple these systems of equations, in the model of a flow splitter or mixer (model `Buildings.Fluid.FixedResistances.SplitterFixedResistanceDpM `_), or in models for fans or pumps (such as the model `Buildings.Fluid.Movers.SpeedControlled_y `_), the parameter ``dynamicBalance`` can be set to ``true``. This adds a control volume at the fluid junction that can decouple the system of equations. +To decouple these systems of equations, in the model of a flow splitter or mixer (model `Buildings.Fluid.FixedResistances.PressureDrop `_), or in models for fans or pumps (such as the model `Buildings.Fluid.Movers.SpeedControlled_y `_), the parameter ``dynamicBalance`` can be set to ``true``. This adds a control volume at the fluid junction that can decouple the system of equations. Reducing nonlinear equations of serially connected flow resistances ------------------------------------------------------------------- @@ -90,7 +90,7 @@ Suppose the parameters are .. code-block:: modelica - Buildings.Fluid.FixedResistances.FixedResistanceDpM res( + Buildings.Fluid.FixedResistances.PressureDrop res( redeclare package Medium = Medium, m_flow_nominal=0.2, dp_nominal=10000); diff --git a/Buildings/Resources/Documentation/userGuide/build/html/bestPractice.html b/Buildings/Resources/Documentation/userGuide/build/html/bestPractice.html index fc6ec831813..f90f086b28c 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/bestPractice.html +++ b/Buildings/Resources/Documentation/userGuide/build/html/bestPractice.html @@ -256,7 +256,7 @@

2.4.1. Overdetermined initialization problem and inconsistent equationsWe will now explain how state variables, such as temperature and pressure, can be initialized.

Consider a model consisting of a mass flow source Modelica.Fluid.Sources.MassFlowSource_T, a fluid volume Buildings.Fluid.MixingVolumes.MixingVolume and a fixed boundary condition Buildings.Fluid.Sources.FixedBoundary, connected in series as shown in the figure below. Note that the instance bou implements an equation that sets the medium pressure at its port, i.e., the port pressure bou.ports.p is fixed.

-
+
_images/MixingVolumeInitialization.png

Fig. 2.1 Schematic diagram of a flow source, a fluid volume, and a pressure source.

@@ -458,14 +458,14 @@

2.4.1. Overdetermined initialization problem and inconsistent equations2.4.2. Modeling of fluid junctions

In Modelica, connecting fluid ports as shown below leads to ideal mixing at the junction. In some situation, such as the configuration below, connecting multiple connectors to a fluid port represents the physical phenomena that was intended to model.

-
+
_images/fluidJunctionMixing.png

Fig. 2.2 Connection of three components without explicitly introducing a mixer or splitter model.

However, in more complex flow configurations, one may want to explicitly control what branches of a piping or duct network mix. This may be achieved by using an instance of the model -SplitterFixedResistanceDpM as shown in the left figure below, which is the test model +PressureDrop as shown in the left figure below, which is the test model BoilerPolynomialClosedLoop

-
+
_images/fluidJunctionMixingSplitter.png

Fig. 2.3 Correct (left) and wrong (right) connection of components with use of a mixer or splitter model.

@@ -484,7 +484,7 @@

2.4.3. Use of sensors in fluid flow systems

2.4.4. Reference pressure for incompressible fluids such as water

This section explains how to set a reference pressure for incompressible fluids. For fluids that model density as a function of temperature, the section also shows how to account for the thermal expansion of the fluid.

Consider the flow circuit shown below that consists of a pump or fan, a flow resistance and a volume.

-
+
_images/flowCircuitNoExpansion.png

Fig. 2.4 Schematic diagram of a flow circuit without means to set a reference pressure, or to account for @@ -521,7 +521,7 @@

2.4.3. Use of sensors in fluid flow systemsBuildings.Fluid.Storage.ExpansionVessel to form the system model shown below.

-
+
_images/flowCircuitWithExpansionVessel.png

Fig. 2.5 Schematic diagram of a flow circuit with expansion vessel that adds a pressure source and accounts for the thermal expansion @@ -537,7 +537,7 @@

2.4.3. Use of sensors in fluid flow systemsBuildings.Fluid.Storage.ExpansionVessel conserves energy. However, since the thermal expansion of the fluid is usually small, this effect can be neglected in most building HVAC applications.

-
+
_images/flowCircuitWithBoundary.png

Fig. 2.6 Schematic diagram of a flow circuit with a boundary model that adds a fixed pressure source and accounts for any thermal expansion @@ -588,7 +588,7 @@

2.4.5. Nominal ValuesFixedResistanceDpM. +See PressureDrop. m_flow_nominal m_flow_small @@ -730,7 +730,7 @@

2.6. Avoiding events

2.7. Controls

-
+
_images/controlHysteresis.png

Fig. 2.7 Schematic diagram of a controller that switches a coil on and off. In the top configuration, the hysteresis avoids numerical problems @@ -805,7 +805,7 @@

2.8.1. State events\(t=0.95e7\) seconds, there was a spike as shown in the figure below.

-
+
_images/DualFanDualDuct-cpu-events.png

Fig. 2.8 Computing time and number of events.

@@ -844,7 +844,7 @@

2.8.1. State events +
_images/EconomizerTemperatureControl-bad.svg

Fig. 2.9 Block diagram of part of the economizer control that computes the outside air damper control signal. This implementation triggers many events.

@@ -860,7 +860,7 @@

2.8.1. State events\(0.2\) Kelvin, and now the model runs fine for the whole year.

-
+
_images/EconomizerTemperatureControl-revised.svg

Fig. 2.10 Block diagram of part of the revised economizer control that computes the outside air damper control signal.

@@ -873,7 +873,7 @@

2.8.2. State variables that dominate the error controlef410ee), the simulation time was very slow during part of the simulation, as shown in Fig. 2.11.

-
+
_images/DualFanDualDuctWithFilteredSpeed.svg

Fig. 2.11 Computing time and number of events.

diff --git a/Buildings/Resources/Documentation/userGuide/build/html/gettingStarted.html b/Buildings/Resources/Documentation/userGuide/build/html/gettingStarted.html index 7fc92211eaf..a30c78e84de 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/gettingStarted.html +++ b/Buildings/Resources/Documentation/userGuide/build/html/gettingStarted.html @@ -196,6 +196,13 @@

1.1. Literature for UsersAlthough the Modelica Language Tutorial is for an older version (Modelica 1.4), it is still instructive and relevant to understand the concepts of the language.

Links to papers that describe or used the Buildings library are available at http://simulationresearch.lbl.gov/modelica/publications.html. The model documentation from the download page contains user guides that describe the individual packages of the Buildings library.

+

The IEA EBC Annex 60 final report +summarizes the development of Modelica models, approaches and tools +for co-simulation based on the Functional Mockup Interface standard, +Building Information Modeling technologies based on the Industry Foundation Classes, +as well as tools for workflow automation. +It also contains numerous examples that apply these technologies to the +design and operation of building and community energy systems.

1.2. Literature for Developers

diff --git a/Buildings/Resources/Documentation/userGuide/build/html/help.html b/Buildings/Resources/Documentation/userGuide/build/html/help.html index b96cd8369ae..84f7a77d82f 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/help.html +++ b/Buildings/Resources/Documentation/userGuide/build/html/help.html @@ -197,7 +197,7 @@

6. HelpFor 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

+

For questions that are specific to Modelica but not the Buildings libray, see https://stackoverflow.com/search?q=modelica

diff --git a/Buildings/Resources/Documentation/userGuide/build/html/searchindex.js b/Buildings/Resources/Documentation/userGuide/build/html/searchindex.js index a785c75aa21..d8015d864fb 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/searchindex.js +++ b/Buildings/Resources/Documentation/userGuide/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["acknowledgments","bestPractice","development","disclaimer","gettingStarted","glossary","help","index","legal","prePostProcessing","workArounds"],envversion:50,filenames:["acknowledgments.rst","bestPractice.rst","development.rst","disclaimer.rst","gettingStarted.rst","glossary.rst","help.rst","index.rst","legal.rst","prePostProcessing.rst","workArounds.rst"],objects:{},objnames:{},objtypes:{},terms:{"05ch11231":0,"2nd":[5,10],"66e":1,"94406e":1,"94407e":1,"94411e":1,"9441e":1,"boolean":10,"break":7,"case":[1,2],"class":[4,7],"default":[1,2,10],"function":[1,2,5,8,9,10],"import":1,"new":[1,4,6,7],"public":[0,4],"return":1,"short":1,"static":1,"switch":1,"transient":1,"true":[1,10],"try":1,"while":[1,3,10],AND:8,ARE:8,Adding:[1,7],BUT:8,FOR:8,For:[1,2,5,6,10],NOT:8,SUCH:8,Such:1,THE:8,The:[0,1,2,3,4,5,6,7,8,9,10],Then:1,These:1,USE:8,Use:[0,7],Using:[1,10],_nomin:1,about:[4,6],abov:[1,10],abruptli:1,abs:1,absolut:1,ac02:0,academ:4,access:2,account:[1,3],accuraci:3,achiev:1,acknowledg:7,across:[1,5],actual:1,actuat:10,adapt:5,add:[1,2,4,10],added:[1,5,8],adding:1,addit:[1,6,9],adequaci:3,adher:2,adjust:1,advanc:1,advic:7,advis:8,affect:1,after:[1,2],again:1,agenc:3,agreement:8,air:[1,4],algebra:7,algorithm:1,all:[1,2,6,8,10],allow:[1,2,10],alreadi:[1,2,6],also:[1,2,4,10],altern:[1,2],although:4,alwai:1,amb:1,ambient:1,amount:2,ani:[1,3,8,10],annot:1,anoth:[1,5],anyon:8,anywai:1,apparatu:3,appear:1,appli:10,applic:1,approv:3,approxim:[1,5,10],argument:1,aris:8,around:[1,5,7],assist:0,assum:3,assumpt:[1,7],attempt:1,author:[1,3,5,10],autom:[7,9],avail:[1,2,4,7,8],avoid:[2,7],award:0,back:1,bad:1,balanc:[1,2],base:[1,2,4,5,7],baseclass:[1,2],basic:2,basicflowfunction_dp:2,basicflowfunction_m_flow:2,becam:1,becaus:[1,4,10],becom:2,been:[1,3,8],befor:6,behav:1,behavior:1,believ:3,below:[1,2,10],berkelei:8,best:7,between:[1,2,10],binari:8,block:[1,5],boiler:1,boilerpolynomialclosedloop:1,book:4,both:[1,2,10],bottom:1,bou:1,bound:5,boundari:1,branch:1,bsd:8,bug:[6,8],build:[0,2,4,6,7,10],buildingspi:9,busi:8,california:[0,3,8],call:1,can:[1,2,4,6,7,9,10],carbon:1,carnot_i:2,carri:1,casella:4,caus:[1,2,5,6,8,10],caution:1,chanc:6,chang:[1,4,5,7],chaotic:1,check:[1,4,6],chiller:[1,2],chillerpl:1,choicesallmatch:1,choos:8,circuit:1,circumv:1,claus:8,close:[1,10],closedloop:1,co2:4,code:[1,2,8,10],coeffici:10,coil:[1,2,10],com:[2,4,6],combin:5,command:1,commerci:3,commiss:[0,3],commit:1,common:[2,7],como:4,comparison:1,complet:3,complex:[1,4],compon:[1,2,4,10],composit:[1,10],compress:[1,5],comput:[1,2,5,8,9,10],concentr:1,concept:4,concis:4,condit:[1,2,5,8],confer:4,configur:[1,10],connect:[1,2,7],connector:[1,4],consequ:1,consequenti:8,conserv:1,consid:[1,10],consist:1,constant:[1,5],constanteffect:2,constitut:3,construct:1,consult:1,contain:[1,2,3,4,10],continu:[1,5,10],contract:[0,8],contractor:3,contribut:[1,7],contributor:8,control:[5,7,9,10],convect:4,convent:2,converg:[1,5,10],convert:5,coocoi:1,cool:[1,2,10],copi:2,copyright:7,cor:1,correct:[3,7,10],correctli:1,correspond:8,cost:9,could:[1,10],coupl:10,cours:1,cover:7,creat:[1,6,7,9],cross:1,curv:[1,10],cycl:1,dae:1,damag:8,damper:1,dassl:1,data:[1,8],debug:7,declar:1,decoupl:[2,10],defin:[1,4,5],definit:[1,4],delai:1,delet:10,densiti:[1,2,5],depart:[0,8],depend:[1,2,10],dept:8,der:1,deriv:[5,8],describ:[1,2,4,10],descript:[2,6],design:[1,5],detail:[1,4,10],determin:1,develop:[0,1,7,9],devic:[1,4,7],diagram:[1,10],did:1,differ:[1,4],differenti:[1,5],difficult:2,dioxid:1,direct:[1,4,8],directli:8,directori:9,disabl:2,disapprov:3,disclaim:[7,8],disclos:3,distinct:1,distinguish:1,distribut:[1,2,8],document:[0,1,2,3,4,7,8,9],doe:[1,3,9],domain:1,domin:7,done:1,down:1,download:4,dp_nomin:[1,2,10],dpfixed_nomin:10,dpvalve_nomin:10,drastic:1,drop:[1,5,7,10],dry:4,dslog:1,dualfandualduct:1,dualfandualductclosedloop:1,duct:[1,10],due:[1,4,10],dure:[1,10],dymola:[1,6,9,10],dynam:[1,10],dynamicbal:10,dynamicsfreeiniti:[1,10],each:1,earlier:1,easier:[1,4,10],easiest:2,econom:1,editor:4,ef410e:1,effect:[1,10],effici:[0,1],effort:1,either:8,ele:1,element:[1,10],elementari:1,elimin:10,elmqvist:4,els:1,employe:3,enabl:1,encount:1,end:[0,1],endors:[3,8],energi:[0,1,2,3,5,8],energydynam:[1,10],engin:1,enhanc:8,ensur:[2,10],enter:[1,6],enthalpi:1,entri:1,environ:6,equal:[1,2,10],equat:[2,5,7],equilibrium:1,equip:7,equival:1,error:[6,7,10],essenti:4,estim:1,evalu:1,even:[1,8],event:[7,8],everi:1,everyon:6,exact:1,exampl:[2,4,5,7,9],exce:1,exchang:[1,2,5],exclus:8,exemplari:8,exhibit:1,exist:[2,4],expand:2,expans:1,expansionvessel:1,expect:[1,6],experi:1,experienc:1,explain:[1,4],explan:4,explicitli:1,expos:1,express:[1,3,8],extend:[1,2],extens:4,extrem:1,fail:10,fals:[1,10],fan:[1,10],fanc:10,fanret:1,fansupcol:1,fansuphot:1,fast:[1,5],faster:[1,10],favor:3,fd01:1,featur:8,few:1,fig:1,figur:1,file:[1,6,7,9],filter:[1,5,10],filteredopen:10,filteredspe:[1,10],find:[1,6],fine:1,first:7,fit:8,fix:[1,2,6,7,8,10],fixedboundari:1,fixediniti:1,fixedresist:10,fixedresistancedpm:[1,10],flow:[4,5,7],flowcircuit:1,flowcontrolled_m_flow:10,flowmodel:2,fluid:[2,4,5,7,10],follow:[1,2,4,7,8],form:[1,2,8],format:9,formul:[1,10],found:[4,7],four:1,fra2009a:4,fra2009b:4,fraction:1,frank:4,free:[7,8],fri2004:4,fri2011:4,friction:10,fritzson:4,from:[1,2,4,8,10],from_dp:10,full:1,fulli:5,further:[1,2,4,10],gain:[1,10],gas:1,gave:1,gener:[1,2,6,9,10],genopt:9,geometri:1,get:7,github:[2,6],give:[1,2,4],global:1,glossari:7,good:[1,8],gov:[4,9],govern:[2,3],grant:8,group:6,grow:1,gui:1,guid:[1,2,4,10],guidanc:2,guidelin:2,had:1,halt:1,handl:[1,4],happen:1,has:[1,3,5,8,10],have:[1,10],heat:[1,2,4,5,10],heater:1,heatercooler_u:2,heatexchang:2,heattransf:4,help:[1,7,10],henc:[1,4,6],here:1,herebi:8,herein:3,high:10,higher:[1,5,6,10],holder:8,homotopi:2,how:[2,4,7,9],howev:[1,8],html:4,http:[2,4,6,9],humid:[1,2],humidifi:1,humidifier_u:2,hvac:1,hysteresi:1,ideal:[1,10],ident:1,ieee:4,illustr:[1,10],implement:[1,2,10],impli:[3,8],impos:[1,8],improv:[1,2,10],incident:8,includ:[1,5,8],incompress:[5,7,10],inconsist:7,incorpor:8,increas:1,index:7,indirect:8,individu:[1,4,10],inequ:1,inertia:10,infin:2,inform:[3,6,7,9,10],infring:3,initi:7,inlet:10,input:[1,5,7,10],inspect:1,instal:8,instanc:[1,10],instant:1,instantli:10,instead:1,instruct:[4,7],integr:[1,2],intend:1,interact:[1,4],interest:[0,1,2],interfac:[1,2],intern:4,interrupt:8,intersect:10,interv:1,introduc:[1,2,10],introduct:4,invit:6,isbn:4,isol:1,issu:6,itali:4,iter:[5,7,10],its:[1,3,4,8],john:4,join:6,junction:[7,10],just:1,kelvin:1,kluwer:4,knowledg:2,known:[2,6,10],laboratori:8,languag:[4,9],larg:[7,10],larger:[1,10],last:1,later:1,law:1,lawrenc:8,lbl:[2,4,6,9],lbnl:9,lead:[1,10],leav:1,left:1,leg:5,legal:3,length:5,let:1,level:1,liabil:[3,8],liabl:8,librai:6,librari:[1,2,4,6,7,9],licens:[2,7],lift:10,like:[1,10],limit:[1,2,8],linear:[2,10],link:4,list:[4,8],literatur:7,load:1,local:1,locat:1,log:1,logstartvaluesforiterationvari:1,longer:1,loop:7,loss:8,low:[5,10],lump:[1,2,10],m_flow:1,m_flow_nomin:[1,2,10],m_flow_smal:1,machin:10,made:[1,2],magnitud:[1,5],mai:[1,2,4,6,7,8,10],maintain:[1,2],make:[2,3,4,6,8,10],mani:[1,2],manufactur:[1,3],mas:1,mass:[1,2,4,5,7],massdynam:[1,10],massexchang:2,massflowr:1,massflowsource_t:[1,10],mat:9,materi:8,math:1,matlab:9,mattsson:4,mayb:1,mean:[1,2,5],measur:[1,10],mechan:5,media:7,medium:[1,4,5,10],menu:1,merchant:8,messag:[1,10],met:8,method:1,michael:4,millisecond:1,mix:[1,10],mixer:[1,10],mixingvolum:1,model:[2,4,6,7,9,10],modelica:[1,2,4,6,7,9,10],modif:8,modifi:[2,8],modul:7,moist:4,moistair:1,more:[1,4,10],most:1,move:5,mover:10,much:[1,6],multipl:[1,4,7,10],must:[1,8],name:[1,3,8],nation:8,necessari:5,necessarili:3,need:[1,2,4,6,10],neglect:1,neglig:[1,8],neighborhood:1,neither:[3,8],network:[1,10],never:1,newton:[1,2,5],next:2,nois:[1,5],nomin:[2,7],non:[5,8,10],nonlinear:[1,2,5,7],nor:[3,8],note:[1,4,8],notic:8,now:1,number:[0,1,5],numer:[2,5,7],object:4,oblig:8,observ:[1,6],obtain:1,occur:1,off:1,offic:0,often:[1,2,10],older:4,olsson:4,one:[1,2],ones:4,onli:[1,2],onlin:4,open:[5,6,7],openmodelica:9,oper:[1,6,8],opinion:3,opposit:5,optim:9,option:1,order:[1,5,10],ordinari:[1,5],org:4,organ:7,orient:4,oscil:1,oscillatori:1,other:[1,2,4,8,10],otherwis:[1,2,3,8,10],otter:4,our:1,out:[1,8],outlet:10,output:[1,5,7,9,10],outsid:1,overdetermin:7,overspecifi:[1,7],overview:4,overwritten:1,own:3,owner:8,p_default:1,packag:[2,4,7,10],page:[4,7],pai:1,paper:4,paragraph:8,paramet:[2,4,7,10],part:[1,6,9,10],parti:3,partialabsolutesensor:2,partialmedium:1,partialresist:2,particular:8,particularli:[1,10],pass:[3,5,10],patch:8,per:1,perfectgas:1,perform:[8,10],permiss:8,permit:8,perpetu:8,peter:4,phenomena:[1,4,7],physic:[1,4,7],pipe:[1,10],pleas:6,plot:[1,5],point:[1,2],port:[1,2],port_a:1,port_b:1,posit:5,possibl:[1,6,8],post:7,practic:7,pre:[7,10],prepar:[3,8],prescrib:7,present:1,press:4,pressur:[5,7,10],principl:[1,4],prior:8,privat:3,problem:[6,7,9],problemat:1,proc:4,process:[3,7],procur:8,produc:1,product:[1,3,8],proelss:4,profit:8,progess:1,program:[0,9],promot:8,propag:7,proper:1,properti:1,provid:[1,2,6,7,8,9],publicli:8,publish:[1,4],pum:1,pump:[1,10],purpos:8,python:9,quadrat:2,quantiti:1,question:6,quickli:6,radau:1,rais:[1,10],raisetim:10,rang:1,rapidli:1,rate:[1,2,4,5,7],rather:[1,7],ratio:10,read:4,real:[1,5,10],realiz:6,reason:1,recommend:[1,2,3,4],redeclar:[1,10],redistribut:8,reduc:[1,2,7],refer:[3,5,7,10],reflect:3,regard:6,regardless:1,regent:[3,8],region:1,regstep:1,regular:[1,2,5,10],rel:1,relat:1,relev:4,remain:1,remov:[1,10],renew:0,replac:[1,2,4],report:[3,6],repres:[1,3],reproduc:[1,6,8],requir:[1,2,7,10],res1:[1,10],res2:10,res3:1,res:10,research:0,reserv:8,residu:10,resist:[1,2,7],respect:1,respons:[1,3,5,10],restart:1,result:[1,3,6,9],resultfil:1,retain:8,retun:10,revers:[1,4],revis:[1,8],rho:1,right:[1,3,8],robust:[1,2,10],room:1,root:[1,6],rotat:10,rotor:10,royalti:8,rule:1,run:[1,7,9],same:[1,4,10],satisfactori:10,satisfi:5,save:[1,6],scalar:1,schemat:[1,10],script:9,search:[6,7],second:[1,5,10],secretari:0,section:[1,2,10],see:[1,2,5,6,9,10],seem:1,select:[1,6],sen:1,sensor:[2,7],sent:10,separ:[8,9,10],sept:4,seri:[1,2,10],serial:7,servic:[3,8],set:[1,2,10],setup:1,shall:8,share:2,should:[1,2,5],show:1,shown:[1,10],sielemann:4,sign:1,signal:[1,5,10],signific:2,significantli:1,similar:[1,2,4,7],similarli:1,simpl:[2,10],simpler:1,simplifi:1,simul:[6,7,9,10],simulatemodel:1,simulationresearch:[4,9],sinc:1,singular:1,situat:[1,2,10],siunit:1,size:[1,2],skip:1,slight:1,slightli:1,slow:7,small:[1,5,6,10],smaller:[1,5],smooth:[1,10],softwar:[7,8],solut:[1,5,10],solv:[1,2,5,6,10],solver:[2,5,7,10],some:[1,2,10],sometim:10,son:4,sooner:6,sourc:[1,7,8,10],speci:[1,4],special:[1,8],specif:[1,2,3,6,8,9],specifi:[1,9],speed:10,speedcontrolled_i:10,spike:1,split:1,splitter:[1,10],splitterfixedresistancedpm:[1,10],sponsor:3,sqrt:10,srg:[2,6],stabil:1,stackoverflow:6,stage:1,stall:[1,2],standard:[2,4,9],start:[2,7],state:[3,5,7],steadi:1,steadyst:1,steadystateiniti:1,step:[1,4,5,7],stepsiz:1,still:[4,6],stop:1,stoptim:1,storag:1,store:1,stream:[2,4],strict:8,structur:1,style:2,subcontractor:3,sublicens:8,submit:6,substanc:[1,4],substitut:8,subsystem:1,success:1,successfulli:1,suffici:1,suggest:2,support:0,suppos:[1,10],sure:6,system:[2,4,5,6,7,10],t_a_inflow:1,t_b_inflow:1,t_default:1,t_in:1,tab:1,tabl:1,take:1,tau:1,tcoicoo:1,technic:4,technolog:0,temperatur:[1,2],temperaturedependentdens:1,temperaturesensor:1,temperaturetwoport:1,temsen_1:1,temsen_2:1,tend:2,termin:1,test:[1,2,5,6,9],than:[1,4,5,7],thei:[1,2],them:[1,2],theori:8,therebi:[1,10],therefor:[1,10],thereof:[3,8],thermal:1,thermo:[4,5,7],thermofluid:[7,10],thi:[0,1,2,3,5,6,7,8,9,10],thing:1,those:3,thought:10,three:1,threshold:1,through:[1,5],thu:[1,10],thumb:1,til2001:4,tiller:4,time:[1,5,10],tmed:1,tmix:1,toler:[1,5],tool:1,top:1,topic:1,tort:8,total:6,tpreheacoi:1,trace:[1,4],trade:3,trademark:3,transfer:4,translat:[1,7,10],translatemodel:1,transport:[1,4],travel:10,tret:1,trigger:1,turn:1,tutori:4,two:[1,2,10],twowaylinear:10,txt:1,type:[1,10],typic:[1,2,5,10],uncontrol:1,under:[0,1,2,8],understand:[1,4],understood:1,unit:[1,3,9],univers:[3,8],unknown:1,unlik:1,unmethour:6,unrealist:1,unspecifi:1,unstabl:1,until:5,upgrad:8,upon:3,use:[1,2,3,4,6,7,8,9,10],used:[1,2,4,6,7,8,9],useful:4,usefulness:3,user:[1,2,10],usersguid:2,uses:[3,4,10],using:[1,4,9,10],usual:[1,2],util:1,val:[1,10],valu:[4,7,10],valv:[1,5,10],vapor:[1,4],vari:10,variabl:[5,7,10],variat:4,variou:1,vavhot:1,veri:1,version:[1,4],versu:1,vessel:1,view:3,vol:1,volum:[1,2,5,10],wai:[1,8],want:1,warrant:3,warranti:[3,8],water:[4,7,10],web:4,websit:2,weight:1,welcom:2,well:[1,2,4],were:9,wetcoildiscret:1,wetter:4,what:1,whatsoev:8,when:[1,2,6,7,10],whenev:1,where:[1,2,5,10],whether:[1,8],which:[1,2,4,5,7,10],who:4,whole:[1,5],whose:[1,5],why:1,wide:1,wilei:4,within:5,without:[1,8],work:[3,7,8],would:[1,2,3],written:8,wrong:1,www:4,x_ptphi:1,xogeni:4,year:1,you:[1,8,10],your:[6,8],yourself:6,zero:[1,2,10]},titles:["8. Acknowledgments","2. Best Practice","5. Development","9. Disclaimers","1. Getting Started","7. Glossary","6. Help","User Guide","10. Copyright and License","4. Pre- and Post-Processing","3. Work-Arounds"],titleterms:{"break":10,"class":2,"new":2,Adding:2,Use:1,acknowledg:0,algebra:10,around:10,avoid:[1,10],best:1,build:1,chang:10,connect:10,content:7,contribut:2,control:1,copyright:8,correct:1,debug:1,develop:[2,4],devic:2,disclaim:3,domin:1,drop:2,equat:[1,10],error:1,event:1,exampl:1,first:4,flow:[1,2,10],fluid:1,get:4,glossari:5,guid:7,help:6,how:1,incompress:1,inconsist:1,indic:7,initi:[1,10],iter:1,junction:1,larg:1,licens:8,literatur:4,loop:10,mass:10,media:1,model:1,nomin:1,nonlinear:10,numer:1,organ:1,overdetermin:1,overspecifi:10,packag:1,paramet:1,post:9,practic:1,pre:9,prescrib:10,pressur:[1,2],problem:[1,10],process:9,propag:1,rate:10,reduc:10,refer:[1,4],requir:4,resist:10,run:4,sensor:1,serial:10,simul:[1,4],slow:1,softwar:4,solver:1,start:[1,4],state:1,step:10,system:1,tabl:7,thermo:1,thermofluid:2,user:[4,7],valu:1,variabl:1,water:1,work:10}}) \ No newline at end of file +Search.setIndex({docnames:["gettingStarted","index"],envversion:50,filenames:["gettingStarted.rst","index.rst"],objects:{},objnames:{},objtypes:{},terms:{"05ch11231":[],"2nd":[],"66e":[],"94406e":[],"94407e":[],"94411e":[],"9441e":[],"boolean":[],"break":1,"case":[],"class":[0,1],"default":[],"final":0,"function":0,"import":[],"new":[0,1],"public":0,"return":[],"short":[],"static":[],"switch":[],"transient":[],"true":[],"try":[],"while":[],AND:[],ARE:[],Adding:1,BUT:[],FOR:[],For:[],NOT:[],PressureDrop:[],SUCH:[],Such:[],THE:[],The:[0,1],Then:[],These:[],USE:[],Use:1,Using:[],_nomin:[],about:0,abov:[],abruptli:[],abs:[],absolut:[],ac02:[],academ:0,access:[],account:[],accuraci:[],achiev:[],acknowledg:1,across:[],actual:[],actuat:[],adapt:[],add:0,added:[],adding:[],addit:[],adequaci:[],adher:[],adjust:[],advanc:[],advic:1,advis:[],affect:[],after:[],again:[],agenc:[],agreement:[],air:0,algebra:1,algorithm:[],all:[],allow:[],alreadi:[],also:0,altern:[],although:0,alwai:[],amb:[],ambient:[],amount:[],ani:[],annex:0,annot:[],anoth:[],anyon:[],anywai:[],apparatu:[],appear:[],appli:0,applic:[],approach:0,approv:[],approxim:[],argument:[],aris:[],around:1,assist:[],assum:[],assumpt:1,attempt:[],author:[],autom:[0,1],avail:[0,1],avoid:1,award:[],back:[],bad:[],balanc:[],base:[0,1],baseclass:[],basic:[],basicflowfunction_dp:[],basicflowfunction_m_flow:[],becam:[],becaus:0,becom:[],been:[],befor:[],behav:[],behavior:[],believ:[],below:[],berkelei:[],best:1,between:[],binari:[],block:[],boiler:[],boilerpolynomialclosedloop:[],book:0,both:[],bottom:[],bou:[],bound:[],boundari:[],branch:[],bsd:[],bug:[],build:[0,1],buildingspi:[],busi:[],california:[],call:[],can:[0,1],carbon:[],carnot_i:[],carri:[],casella:0,caus:[],caution:[],chanc:[],chang:[0,1],chaotic:[],check:0,chiller:[],chillerpl:[],choicesallmatch:[],choos:[],circuit:[],circumv:[],claus:[],close:[],closedloop:[],co2:0,code:[],coeffici:[],coil:[],com:0,combin:[],command:[],commerci:[],commiss:[],commit:[],common:1,commun:0,como:0,comparison:[],complet:[],complex:0,compon:0,composit:[],compress:[],comput:[],concentr:[],concept:0,concis:0,condit:[],confer:0,configur:[],connect:1,connector:0,consequ:[],consequenti:[],conserv:[],consid:[],consist:[],constant:[],constanteffect:[],constitut:[],construct:[],consult:[],contain:0,continu:[],contract:[],contractor:[],contribut:1,contributor:[],control:1,convect:0,convent:[],converg:[],convert:[],coocoi:[],cool:[],copi:[],copyright:1,cor:[],correct:1,correctli:[],correspond:[],cost:[],could:[],coupl:[],cours:[],cover:1,creat:1,cross:[],curv:[],cycl:[],dae:[],damag:[],damper:[],dassl:[],data:[],debug:1,declar:[],decoupl:[],defin:0,definit:0,delai:[],delet:[],densiti:[],depart:[],depend:[],dept:[],der:[],deriv:[],describ:0,descript:[],design:0,detail:0,determin:[],develop:1,devic:[0,1],diagram:[],did:[],differ:0,differenti:[],difficult:[],dioxid:[],direct:0,directli:[],directori:[],disabl:[],disapprov:[],disclaim:1,disclos:[],distinct:[],distinguish:[],distribut:[],document:[0,1],doe:[],domain:[],domin:1,done:[],down:[],download:0,dp_nomin:[],dpfixed_nomin:[],dpvalve_nomin:[],drastic:[],drop:1,dry:0,dslog:[],dualfandualduct:[],dualfandualductclosedloop:[],duct:[],due:0,dure:[],dymola:[],dynam:[],dynamicbal:[],dynamicsfreeiniti:[],each:[],earlier:[],easier:0,easiest:[],ebc:0,econom:[],editor:0,ef410e:[],effect:[],effici:[],effort:[],either:[],ele:[],element:[],elementari:[],elimin:[],elmqvist:0,els:[],employe:[],enabl:[],encount:[],end:[],endors:[],energi:0,energydynam:[],engin:[],enhanc:[],ensur:[],enter:[],enthalpi:[],entri:[],environ:[],equal:[],equat:1,equilibrium:[],equip:1,equival:[],error:1,essenti:0,estim:[],evalu:[],even:[],event:1,everi:[],everyon:[],exact:[],exampl:[0,1],exce:[],exchang:[],exclus:[],exemplari:[],exhibit:[],exist:0,expand:[],expans:[],expansionvessel:[],expect:[],experi:[],experienc:[],explain:0,explan:0,explicitli:[],expos:[],express:[],extend:[],extens:0,extrem:[],fail:[],fals:[],fan:[],fanc:[],fanret:[],fansupcol:[],fansuphot:[],fast:[],faster:[],favor:[],fd01:[],featur:[],few:[],fig:[],figur:[],file:1,filter:[],filteredopen:[],filteredspe:[],find:[],fine:[],first:1,fit:[],fix:1,fixedboundari:[],fixediniti:[],fixedresist:[],fixedresistancedpm:[],flow:[0,1],flowcircuit:[],flowcontrolled_m_flow:[],flowmodel:[],fluid:[0,1],follow:[0,1],form:[],format:[],formul:[],found:[0,1],foundat:0,four:[],fra2009a:0,fra2009b:0,fraction:[],frank:0,free:1,fri2004:0,fri2011:0,friction:[],fritzson:0,from:0,from_dp:[],full:[],fulli:[],further:0,gain:[],gas:[],gave:[],gener:[],genopt:[],geometri:[],get:1,github:[],give:0,global:[],glossari:1,good:[],gov:0,govern:[],grant:[],group:[],grow:[],gui:[],guid:0,guidanc:[],guidelin:[],had:[],halt:[],handl:0,happen:[],has:[],have:[],heat:0,heater:[],heatercooler_u:[],heatexchang:[],heattransf:0,help:1,henc:0,here:[],herebi:[],herein:[],high:[],higher:[],holder:[],homotopi:[],how:[0,1],howev:[],html:0,http:0,humid:[],humidifi:[],humidifier_u:[],hvac:[],hysteresi:[],ideal:[],ident:[],iea:0,ieee:0,illustr:[],implement:[],impli:[],impos:[],improv:[],incident:[],includ:[],incompress:1,inconsist:1,incorpor:[],increas:[],index:1,indirect:[],individu:0,industri:0,inequ:[],inertia:[],infin:[],inform:[0,1],infring:[],initi:1,inlet:[],input:1,inspect:[],instal:[],instanc:[],instant:[],instantli:[],instead:[],instruct:[0,1],integr:[],intend:[],interact:0,interest:[],interfac:0,intern:0,interrupt:[],intersect:[],interv:[],introduc:[],introduct:0,invit:[],isbn:0,isol:[],issu:[],itali:0,iter:1,its:0,john:0,join:[],junction:1,just:[],kelvin:[],kluwer:0,knowledg:[],known:[],laboratori:[],languag:0,larg:1,larger:[],last:[],later:[],law:[],lawrenc:[],lbl:0,lbnl:[],lead:[],leav:[],left:[],leg:[],legal:[],length:[],let:[],level:[],liabil:[],liabl:[],librai:[],librari:[0,1],licens:1,lift:[],like:[],limit:[],linear:[],link:0,list:0,literatur:1,load:[],local:[],locat:[],log:[],logstartvaluesforiterationvari:[],longer:[],loop:1,loss:[],low:[],lump:[],m_flow:[],m_flow_nomin:[],m_flow_smal:[],machin:[],made:[],magnitud:[],mai:[0,1],maintain:[],make:0,mani:[],manufactur:[],mas:[],mass:[0,1],massdynam:[],massexchang:[],massflowr:[],massflowsource_t:[],mat:[],materi:[],math:[],matlab:[],mattsson:0,mayb:[],mean:[],measur:[],mechan:[],media:1,medium:0,menu:[],merchant:[],messag:[],met:[],method:[],michael:0,millisecond:[],mix:[],mixer:[],mixingvolum:[],mockup:0,model:[0,1],modelica:[0,1],modif:[],modifi:[],modul:1,moist:0,moistair:[],more:0,most:[],move:[],mover:[],much:[],multipl:[0,1],must:[],name:[],nation:[],necessari:[],necessarili:[],need:0,neglect:[],neglig:[],neighborhood:[],neither:[],network:[],never:[],newton:[],next:[],nois:[],nomin:1,non:[],nonlinear:1,nor:[],note:0,notic:[],now:[],number:[],numer:[0,1],object:0,oblig:[],observ:[],obtain:[],occur:[],off:[],offic:[],often:[],older:0,olsson:0,one:[],ones:0,onli:[],onlin:0,open:1,openmodelica:[],oper:0,opinion:[],opposit:[],optim:[],option:[],order:[],ordinari:[],org:0,organ:1,orient:0,oscil:[],oscillatori:[],other:0,otherwis:[],otter:0,our:[],out:[],outlet:[],output:1,outsid:[],overdetermin:1,overspecifi:1,overview:0,overwritten:[],own:[],owner:[],p_default:[],packag:[0,1],page:[0,1],pai:[],paper:0,paragraph:[],paramet:[0,1],part:[],parti:[],partialabsolutesensor:[],partialmedium:[],partialresist:[],particular:[],particularli:[],pass:[],patch:[],per:[],perfectgas:[],perform:[],permiss:[],permit:[],perpetu:[],peter:0,phenomena:[0,1],physic:[0,1],pipe:[],pleas:[],plot:[],point:[],port:[],port_a:[],port_b:[],posit:[],possibl:[],post:1,practic:1,pre:1,prepar:[],prescrib:1,present:[],press:0,pressur:1,pressuredrop:[],principl:0,prior:[],privat:[],problem:1,problemat:[],proc:0,process:1,procur:[],produc:[],product:[],proelss:0,profit:[],progess:[],program:[],promot:[],propag:1,proper:[],properti:[],provid:1,publicli:[],publish:0,pum:[],pump:[],purpos:[],python:[],quadrat:[],quantiti:[],question:[],quickli:[],radau:[],rais:[],raisetim:[],rang:[],rapidli:[],rate:[0,1],rather:1,ratio:[],read:0,real:[],realiz:[],reason:[],recommend:0,redeclar:[],redistribut:[],reduc:1,refer:1,reflect:[],regard:[],regardless:[],regent:[],region:[],regstep:[],regular:[],rel:[],relat:[],relev:0,remain:[],remov:[],renew:[],replac:0,report:0,repres:[],reproduc:[],requir:1,res1:[],res2:[],res3:[],res:[],research:[],reserv:[],residu:[],resist:1,respect:[],respons:[],restart:[],result:[],resultfil:[],retain:[],retun:[],revers:0,revis:[],rho:[],right:[],robust:[],room:[],root:[],rotat:[],rotor:[],royalti:[],rule:[],run:1,same:0,satisfactori:[],satisfi:[],save:[],scalar:[],schemat:[],script:[],search:1,second:[],secretari:[],section:[],see:[],seem:[],select:[],sen:[],sensor:1,sent:[],separ:[],sept:0,seri:[],serial:1,servic:[],set:[],setup:[],shall:[],share:[],should:[],show:[],shown:[],sielemann:0,sign:[],signal:[],signific:[],significantli:[],similar:[0,1],similarli:[],simpl:[],simpler:[],simplifi:[],simul:1,simulatemodel:[],simulationresearch:0,sinc:[],singular:[],situat:[],siunit:[],size:[],skip:[],slight:[],slightli:[],slow:1,small:[],smaller:[],smooth:[],softwar:1,solut:[],solv:[],solver:1,some:[],sometim:[],son:0,sooner:[],sourc:1,speci:0,special:[],specif:[],specifi:[],speed:[],speedcontrolled_i:[],spike:[],split:[],splitter:[],sponsor:[],sqrt:[],srg:[],stabil:[],stackoverflow:[],stage:[],stall:[],standard:0,start:1,state:1,steadi:[],steadyst:[],steadystateiniti:[],step:[0,1],stepsiz:[],still:0,stop:[],stoptim:[],storag:[],store:[],stream:0,strict:[],structur:[],style:[],subcontractor:[],sublicens:[],submit:[],substanc:0,substitut:[],subsystem:[],success:[],successfulli:[],suffici:[],suggest:[],summar:0,support:[],suppos:[],sure:[],system:[0,1],t_a_inflow:[],t_b_inflow:[],t_default:[],t_in:[],tab:[],tabl:[],take:[],tau:[],tcoicoo:[],technic:0,technolog:0,temperatur:[],temperaturedependentdens:[],temperaturesensor:[],temperaturetwoport:[],temsen_1:[],temsen_2:[],tend:[],termin:[],test:[],than:[0,1],thei:[],them:[],theori:[],therebi:[],therefor:[],thereof:[],thermal:[],thermo:[0,1],thermofluid:1,thi:1,thing:[],those:[],thought:[],three:[],threshold:[],through:[],thu:[],thumb:[],til2001:0,tiller:0,time:[],tmed:[],tmix:[],toler:[],tool:0,top:[],topic:[],tort:[],total:[],tpreheacoi:[],trace:0,trade:[],trademark:[],transfer:0,translat:1,translatemodel:[],transport:0,travel:[],tret:[],trigger:[],turn:[],tutori:0,two:[],twowaylinear:[],txt:[],type:[],typic:[],uncontrol:[],under:[],understand:0,understood:[],unit:[],univers:[],unknown:[],unlik:[],unmethour:[],unrealist:[],unspecifi:[],unstabl:[],until:[],upgrad:[],upon:[],use:[0,1],used:[0,1],useful:0,usefulness:[],user:[],usersguid:[],uses:0,using:0,usual:[],util:[],val:[],valu:[0,1],valv:[],vapor:0,vari:[],variabl:1,variat:0,variou:[],vavhot:[],veri:[],version:0,versu:[],vessel:[],view:[],vol:[],volum:[],wai:[],want:[],warrant:[],warranti:[],water:[0,1],web:0,websit:[],weight:[],welcom:[],well:0,were:[],wetcoildiscret:[],wetter:0,what:[],whatsoev:[],when:1,whenev:[],where:[],whether:[],which:[0,1],who:0,whole:[],whose:[],why:[],wide:[],wilei:0,within:[],without:[],work:1,workflow:0,would:[],written:[],wrong:[],www:0,x_ptphi:[],xogeni:0,year:[],you:[],your:[],yourself:[],zero:[]},titles:["1. Getting Started","User Guide"],titleterms:{"break":[],"class":[],"new":[],Adding:[],Use:[],acknowledg:[],algebra:[],around:[],avoid:[],best:[],build:[],chang:[],connect:[],content:1,contribut:[],control:[],copyright:[],correct:[],debug:[],develop:0,devic:[],disclaim:[],domin:[],drop:[],equat:[],error:[],event:[],exampl:[],first:0,flow:[],fluid:[],get:0,glossari:[],guid:1,help:[],how:[],incompress:[],inconsist:[],indic:1,initi:[],iter:[],junction:[],larg:[],licens:[],literatur:0,loop:[],mass:[],media:[],model:[],nomin:[],nonlinear:[],numer:[],organ:[],overdetermin:[],overspecifi:[],packag:[],paramet:[],post:[],practic:[],pre:[],prescrib:[],pressur:[],problem:[],process:[],propag:[],rate:[],reduc:[],refer:0,requir:0,resist:[],run:0,sensor:[],serial:[],simul:0,slow:[],softwar:0,solver:[],start:0,state:[],step:[],system:[],tabl:1,thermo:[],thermofluid:[],user:[0,1],valu:[],variabl:[],water:[],work:[]}}) \ No newline at end of file diff --git a/Buildings/Resources/Documentation/userGuide/build/html/workArounds.html b/Buildings/Resources/Documentation/userGuide/build/html/workArounds.html index 1f7c7d493e7..807dc63893d 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/workArounds.html +++ b/Buildings/Resources/Documentation/userGuide/build/html/workArounds.html @@ -229,7 +229,7 @@

3.1. Avoiding step changes

3.2. Breaking algebraic loops

In fluid flow systems, flow junctions where mass flow rates separate and mix can couple non-linear systems of equations. This leads to larger systems of coupled equations that need to be solved, which often causes larger computing time and can sometimes cause convergence problems. -To decouple these systems of equations, in the model of a flow splitter or mixer (model Buildings.Fluid.FixedResistances.SplitterFixedResistanceDpM), or in models for fans or pumps (such as the model Buildings.Fluid.Movers.SpeedControlled_y), the parameter dynamicBalance can be set to true. This adds a control volume at the fluid junction that can decouple the system of equations.

+To decouple these systems of equations, in the model of a flow splitter or mixer (model Buildings.Fluid.FixedResistances.PressureDrop), or in models for fans or pumps (such as the model Buildings.Fluid.Movers.SpeedControlled_y), the parameter dynamicBalance can be set to true. This adds a control volume at the fluid junction that can decouple the system of equations.

3.3. Reducing nonlinear equations of serially connected flow resistances

@@ -258,7 +258,7 @@

3.3. Reducing nonlinear equations of serially connected flow resistancesFig. 3.4 Schematic diagram of a fixed flow resistance and a valve in series that connect a source and a volume.

Suppose the parameters are

-
Buildings.Fluid.FixedResistances.FixedResistanceDpM res(
+
Buildings.Fluid.FixedResistances.PressureDrop res(
   redeclare package Medium = Medium,
   m_flow_nominal=0.2,
   dp_nominal=10000);
diff --git a/Buildings/Resources/Documentation/userGuide/source/bestPractice.rst b/Buildings/Resources/Documentation/userGuide/source/bestPractice.rst
index 1b1dd86cc57..a2218f71d63 100644
--- a/Buildings/Resources/Documentation/userGuide/source/bestPractice.rst
+++ b/Buildings/Resources/Documentation/userGuide/source/bestPractice.rst
@@ -231,7 +231,7 @@ In some situation, such as the configuration below, connecting multiple connecto
    Connection of three components without explicitly introducing a mixer or splitter model.
 
 However, in more complex flow configurations, one may want to explicitly control what branches of a piping or duct network mix. This may be achieved by using an instance of the model
-`SplitterFixedResistanceDpM `_ as shown in the left figure below, which is the test model
+`PressureDrop `_ as shown in the left figure below, which is the test model
 `BoilerPolynomialClosedLoop `_
 
 .. figure:: img/fluidJunctionMixingSplitter.png
@@ -363,7 +363,7 @@ parameters in various model to help the user understand how they are used.
 | ``m_flow_nominal``  | | Flow resistance models. | These parameters may be used to define a point on the flow rate          |
 | ``dp_nominal``      |                           | versus pressure drop curve. For other mass flow rates, the pressure drop |
 |                     |                           | is typically adjusted using similarity laws.                             |
-|                     |                           | See FixedResistanceDpM_.                                                 |
+|                     |                           | See PressureDrop_.                                                       |
 +---------------------+---------------------------+--------------------------------------------------------------------------+
 | ``m_flow_nominal``  | | Sensors.                | Some of these models set ``m_flow_small=1E-4*abs(m_flow_nominal)``       |
 | ``m_flow_small``    | | Volumes.                | as the default value. Then, m_flow_small is used to regularize, or       |
@@ -749,5 +749,5 @@ As an extreme case, if a system is chaotic
 and uncontrolled, then the global integration error will grow rapidly.
 
 
-.. _FixedResistanceDpM: http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_FixedResistances.html#Buildings.Fluid.FixedResistances.FixedResistanceDpM
+.. _PressureDrop: http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_FixedResistances.html#Buildings.Fluid.FixedResistances.PressureDrop
 .. _WetCoilDiscretized: http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_HeatExchangers.html#Buildings.Fluid.HeatExchangers.WetCoilDiscretized
diff --git a/Buildings/Resources/Documentation/userGuide/source/gettingStarted.rst b/Buildings/Resources/Documentation/userGuide/source/gettingStarted.rst
index 75cc5b28f43..92d0bc44d2e 100644
--- a/Buildings/Resources/Documentation/userGuide/source/gettingStarted.rst
+++ b/Buildings/Resources/Documentation/userGuide/source/gettingStarted.rst
@@ -19,6 +19,14 @@ Although the `Modelica Language Tutorial `_ final report
+summarizes the development of Modelica models, approaches and tools
+for co-simulation based on the Functional Mockup Interface standard,
+Building Information Modeling technologies based on the Industry Foundation Classes,
+as well as tools for workflow automation.
+It also contains numerous examples that apply these technologies to the
+design and operation of building and community energy systems.
+
 
 Literature for Developers
 -------------------------
diff --git a/Buildings/Resources/Documentation/userGuide/source/help.rst b/Buildings/Resources/Documentation/userGuide/source/help.rst
index 40faa1d8bfb..a48bb3dbcb6 100644
--- a/Buildings/Resources/Documentation/userGuide/source/help.rst
+++ b/Buildings/Resources/Documentation/userGuide/source/help.rst
@@ -16,4 +16,4 @@ 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
+For questions that are specific to Modelica but not the `Buildings` libray, see https://stackoverflow.com/search?q=modelica
diff --git a/Buildings/Resources/Documentation/userGuide/source/workArounds.rst b/Buildings/Resources/Documentation/userGuide/source/workArounds.rst
index 9a26b9a6193..e14bd23b136 100644
--- a/Buildings/Resources/Documentation/userGuide/source/workArounds.rst
+++ b/Buildings/Resources/Documentation/userGuide/source/workArounds.rst
@@ -55,7 +55,7 @@ Breaking algebraic loops
 ------------------------
 
 In fluid flow systems, flow junctions where mass flow rates separate and mix can couple non-linear systems of equations. This leads to larger systems of coupled equations that need to be solved, which often causes larger computing time and can sometimes cause convergence problems.
-To decouple these systems of equations, in the model of a flow splitter or mixer (model `Buildings.Fluid.FixedResistances.SplitterFixedResistanceDpM `_), or in models for fans or pumps (such as the model `Buildings.Fluid.Movers.SpeedControlled_y `_), the parameter ``dynamicBalance`` can be set to ``true``. This adds a control volume at the fluid junction that can decouple the system of equations.
+To decouple these systems of equations, in the model of a flow splitter or mixer (model `Buildings.Fluid.FixedResistances.PressureDrop `_), or in models for fans or pumps (such as the model `Buildings.Fluid.Movers.SpeedControlled_y `_), the parameter ``dynamicBalance`` can be set to ``true``. This adds a control volume at the fluid junction that can decouple the system of equations.
 
 Reducing nonlinear equations of serially connected flow resistances
 -------------------------------------------------------------------
@@ -90,7 +90,7 @@ Suppose the parameters are
 
 .. code-block:: modelica
 
-   Buildings.Fluid.FixedResistances.FixedResistanceDpM res(
+   Buildings.Fluid.FixedResistances.PressureDrop res(
      redeclare package Medium = Medium,
      m_flow_nominal=0.2,
      dp_nominal=10000);