From 3635e7fc231301bd3e6efb701727e76af3d0b25f Mon Sep 17 00:00:00 2001 From: Michael Wetter Date: Tue, 5 Sep 2023 07:48:42 -0700 Subject: [PATCH] Updated users guide --- .../userGuide/build/html/_sources/development.rst.txt | 2 +- .../userGuide/build/html/_sources/gettingStarted.rst.txt | 2 +- .../userGuide/build/html/_sources/performance.rst.txt | 2 +- .../Documentation/userGuide/build/html/development.html | 2 +- .../Documentation/userGuide/build/html/gettingStarted.html | 2 +- .../Documentation/userGuide/build/html/performance.html | 2 +- .../Resources/Documentation/userGuide/build/html/searchindex.js | 2 +- .../Resources/Documentation/userGuide/source/development.rst | 2 +- .../Resources/Documentation/userGuide/source/gettingStarted.rst | 2 +- .../Resources/Documentation/userGuide/source/performance.rst | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/Buildings/Resources/Documentation/userGuide/build/html/_sources/development.rst.txt b/Buildings/Resources/Documentation/userGuide/build/html/_sources/development.rst.txt index 07d595e8c3e..3e5c7be5e58 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/_sources/development.rst.txt +++ b/Buildings/Resources/Documentation/userGuide/build/html/_sources/development.rst.txt @@ -537,7 +537,7 @@ The following rules need to be followed, in addition to the guidelines described but prioritize groupings based on model specific similarities. #. Each block must have a ``defaultComponentName`` annotation and a ``%name`` label placed above the icon. - See for example the `CDL.Logical.Sources.Constant `_ + See for example line 13 in the `CDL.Logical.Sources.Constant `_ block. #. To aid readability, the formatting of the Modelica source code file must be consistent with other 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 ceb6a04d94a..586a6a60e4d 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/_sources/gettingStarted.rst.txt +++ b/Buildings/Resources/Documentation/userGuide/build/html/_sources/gettingStarted.rst.txt @@ -19,7 +19,7 @@ Although the `Modelica Language Tutorial `_ final report +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, diff --git a/Buildings/Resources/Documentation/userGuide/build/html/_sources/performance.rst.txt b/Buildings/Resources/Documentation/userGuide/build/html/_sources/performance.rst.txt index b661bb02a0a..a079469114e 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/_sources/performance.rst.txt +++ b/Buildings/Resources/Documentation/userGuide/build/html/_sources/performance.rst.txt @@ -27,7 +27,7 @@ helpful to log which state variables dominate the integration error or the integrator time step control. This usually points to the control loop that is unstable. There are various methods for tuning a controller, and the documentation of -`Buildings.Controls.OBC.CDL.Reals.PIDWithReset `_ +`Buildings.Controls.OBC.CDL.Reals.PIDWithReset `_ outlines one approach for tuning the gains of a PI-controller. diff --git a/Buildings/Resources/Documentation/userGuide/build/html/development.html b/Buildings/Resources/Documentation/userGuide/build/html/development.html index 2cebad6912f..422eba1d75f 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/development.html +++ b/Buildings/Resources/Documentation/userGuide/build/html/development.html @@ -669,7 +669,7 @@

5.4.3. Control sequences using the Contr

  • Each block must have a defaultComponentName annotation and a %name label placed above the icon. -See for example the CDL.Logical.Sources.Constant +See for example line 13 in the CDL.Logical.Sources.Constant block.

  • To aid readability, the formatting of the Modelica source code file must be consistent with other implemented blocks, e.g., use two spaces for indentation (no tabulators), diff --git a/Buildings/Resources/Documentation/userGuide/build/html/gettingStarted.html b/Buildings/Resources/Documentation/userGuide/build/html/gettingStarted.html index ce46def16d4..ef1359c38e2 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/gettingStarted.html +++ b/Buildings/Resources/Documentation/userGuide/build/html/gettingStarted.html @@ -181,7 +181,7 @@

    1.1. Literature for UsersModelica 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 https://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 +

    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, diff --git a/Buildings/Resources/Documentation/userGuide/build/html/performance.html b/Buildings/Resources/Documentation/userGuide/build/html/performance.html index 565346a6595..b12666c6d56 100644 --- a/Buildings/Resources/Documentation/userGuide/build/html/performance.html +++ b/Buildings/Resources/Documentation/userGuide/build/html/performance.html @@ -202,7 +202,7 @@

    3.1. Unstable control loopsBuildings.Controls.OBC.CDL.Reals.PIDWithReset +Buildings.Controls.OBC.CDL.Reals.PIDWithReset outlines one approach for tuning the gains of a PI-controller.

    diff --git a/Buildings/Resources/Documentation/userGuide/build/html/searchindex.js b/Buildings/Resources/Documentation/userGuide/build/html/searchindex.js index 74749a44384..666af67c022 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","performance","prePostProcessing"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["acknowledgments.rst","bestPractice.rst","development.rst","disclaimer.rst","gettingStarted.rst","glossary.rst","help.rst","index.rst","legal.rst","performance.rst","prePostProcessing.rst"],objects:{},objnames:{},objtypes:{},terms:{"0":[1,2,5,9],"01":1,"052":0,"05ch11231":0,"06":9,"07":9,"08":9,"0e7":9,"1":[1,2,4,5,8,9],"10":[0,2,9],"100":2,"10000":9,"1068":4,"11":9,"1180":4,"11905":9,"12":9,"120":9,"12394":9,"13":9,"13201":9,"13555":9,"14":9,"140":9,"15":[1,9],"150":1,"151":1,"16":9,"18":9,"19064":9,"1979":9,"1e":[1,2,9],"2":[1,2,4,8,9],"20":1,"2001":4,"2004":4,"2009":4,"2011":4,"2012":8,"2013":1,"2016":9,"2021":9,"2022":8,"2170":9,"22":9,"25":9,"2736":9,"275":9,"293":1,"2nd":[5,9],"3":[1,2,4,8,9],"30":9,"3000":1,"305":9,"31536000":9,"36":9,"37":9,"38":9,"4":[1,2,4,9],"40":1,"400":9,"419":9,"420":9,"45":9,"47":9,"4974":9,"5":[1,2,4,5,9],"500":0,"5000":9,"5082":9,"51":9,"521":9,"53":9,"58":1,"6":[2,4,9],"60":[2,4],"66e":9,"6732":9,"7":[1,4,9],"71":9,"775":2,"8":[2,9],"80":[2,9],"854873843":9,"855016639":9,"855208419":9,"855351238":9,"9":9,"9267949":9,"94406e":9,"94407e":9,"94411e":9,"9441e":9,"95e7":9,"978":4,"9e7":9,"boolean":[2,9],"break":7,"case":[1,2,9],"class":[4,7],"default":[1,2,9],"do":[2,3],"final":[2,4],"function":[1,4,5,7,8,9,10],"import":2,"long":2,"new":[1,4,6,7],"public":[0,2,4],"return":[1,9],"short":[1,2],"static":1,"switch":[1,9],"transient":1,"true":[1,2,9],"try":1,"while":[1,3,9],A:[2,5,6,8],AND:8,AS:8,And:2,As:[2,9],At:1,BE:8,BUT:8,BY:8,Be:2,But:2,By:5,FOR:8,For:[1,2,5,6,9],IF:8,IN:8,IS:8,If:[1,2,9],In:[1,2,4,5,6,9,10],It:[1,2,3,4,9],NO:8,NOT:8,No:[0,6],OF:8,ON:8,OR:8,On:2,SUCH:8,Such:1,THE:8,TO:8,That:2,The:[0,1,2,3,4,5,6,7,8,9,10],Then:[1,2],There:9,These:1,To:[1,2,4,6,9,10],_nomin:1,_sort_package_ord:2,ab:[1,2],abl:2,about:[4,6],abov:[1,2,4,9],abruptli:9,ac02:0,academ:4,access:2,account:[1,3],accur:9,accuraci:3,achiev:[1,9],acknowledg:7,across:[1,5],actual:[1,2,9],actuat:9,ad:[1,5,7,8,9],adapt:[5,9],add:[1,2,4,9],addit:[1,2,6,10],adequaci:3,adher:2,adjust:[1,9],advanc:[1,2],advic:7,advis:8,affect:1,after:[2,9],again:[2,9],against:2,agenc:3,agreement:8,ahu:2,aid:2,air:[1,2,4,9],al:4,algebra:7,algorithm:[1,7],align:2,all:[1,2,6,8,9],allow:[1,2,9],alphabet:2,alreadi:[1,2,6],also:[1,2,4,9],alt:2,altern:[1,2],although:4,alwai:[1,2],amb:9,ambient:9,among:9,amount:2,an:[1,2,3,4,5,6,9,10],analyt:2,ani:[2,3,8,9],annex:4,annot:[1,2],anoth:[1,2,5,9],antifreez:1,anyon:8,anywai:1,apart:2,app:2,apparatu:3,appear:[2,9],appli:[2,4,9],applic:[1,2],approach:[4,9],approv:3,approxim:[1,2,5,9],ar:[1,2,4,5,6,7,8,9,10],argument:9,aris:8,around:[1,2,5,9],arrai:2,ashra:2,assert:2,assertallinsideminmax:2,assign:2,assist:0,assum:3,assumpt:[1,2,7,9],attempt:[1,9],attribut:2,author:[2,3,5,9],autom:[2,4,7,10],automat:2,avail:[1,2,4,7,8],avoid:[1,2,7],awar:2,award:0,b:1,back:9,bad:9,balanc:[1,2],bar:[1,2,9],base:[1,2,4,5,7],baseclass:[1,2],bash:2,basic:2,basicflowfunction_dp:2,basicflowfunction_m_flow:2,becam:9,becaus:[1,2,4,9],becom:2,been:[1,3,8],befor:[2,6],begin:[2,5],beginn:4,behav:1,behavior:9,believ:3,below:[1,2,9],benchmark:2,berkelei:8,best:7,better:2,between:[1,2,9],binari:8,block:[1,2,5,9],boi:2,boiler:[1,2],boilerpolynomialclosedloop:1,book:4,border:2,both:[1,2,9],bottom:1,bou:1,bound:[2,5],boundari:1,boundary_pt:1,branch:[1,2],bsd:8,bug:[2,6,8],build:[0,2,4,6,7,9],buildings_usersguid:7,buildingspi:[2,10],busi:8,c:[1,8],c_i:1,calcul:2,california:[0,3,8],call:[1,2],can:[1,2,4,6,7,9,10],cannot:2,capabl:9,carbon:1,carnot_i:2,carri:1,casella:4,caus:[1,2,5,6,8,9],caution:1,cdl:[1,2,9],cdot:[1,5],cellpad:2,cellspac:2,celsiu:2,center:2,certainli:1,chanc:6,chang:[1,2,4,5,9],chaotic:9,charact:2,check:[1,2,4,6],chiller:[1,2],chillerpl:1,choicesallmatch:1,choos:8,circ:1,circuit:1,circumv:1,claus:8,close:[1,2,9],closedloop:9,co2:4,co:4,code:[1,2,8,9],coeffici:9,coil:[1,2,9],collaps:2,com:[2,6],combin:5,command:[1,2],comment:2,commerci:3,commiss:[0,3],commit:9,common:[2,7],commun:4,como:4,compact:2,compar:2,comparison:[1,2,9],complet:3,complex:[1,2,4],compli:2,compon:[1,2,4,9],composit:[1,9],compress:[1,5],comput:[1,2,5,8,9,10],concentr:1,concept:4,concis:[2,4],condit:[1,2,5,8,9],conduct:2,confer:4,configur:[1,2,9],connect:[1,2,7],connector:[1,4],consequ:1,consequenti:8,conserv:1,consid:[1,2,9],consist:[1,2,9],constant:[1,2,5,9],constanteffect:2,constitut:3,construct:[1,2],consult:1,contact:9,contain:[1,2,3,4,7,9],continu:[1,2,5,9],contract:[0,8],contractor:3,contribut:[1,7],contributor:8,control:[5,7,10],convect:4,convent:[2,4],converg:[1,5,9],convers:2,convert:[2,5],coocoi:9,cool:[2,9],coolingtow:2,coordinatesystem:2,copi:2,copyright:7,cor:9,correct:[1,2,3,7],correctli:1,correspond:8,cost:10,could:[2,9],coupl:[2,9],cours:1,cover:[2,7],creat:[1,2,6,7,10],cross:[1,9],curv:[1,9],cycl:1,d:2,dae:1,dai:2,damag:8,damper:[2,9],dassl:[1,9],data:[1,2,8],de:0,debug:[1,7],declar:[1,7],decoupl:[2,9],defaultcomponentnam:2,defin:[1,4,5],definit:[1,4],degc:2,degre:2,delai:[1,2],delet:9,delta:[2,5,9],denot:2,densiti:[1,2,5],depart:[0,8],depend:[1,2,9],dept:8,der:[1,9],deriv:[1,2,5,8],describ:[1,2,4,9],descript:[6,7],design:[1,4,5],detail:[1,4,9],detect:[2,9],determin:9,develop:[0,1,7,9,10],devic:[1,4,7],diagram:[1,2,9],dialog:2,did:9,differ:[1,2,4,9],differenti:[1,2,5,9],difficult:2,dioxid:1,direct:[1,2,4,8],directli:8,directori:[2,10],disabl:2,disapprov:3,disclaim:[7,8],disclos:3,discontinu:2,displayunit:2,distinct:1,distinguish:1,distribut:[1,2,8],divid:2,dm:1,document:[0,1,3,4,7,8,9,10],doe:[1,2,3,9,10],domain:1,domin:7,done:[1,2],dot:[1,2,5,9],down:1,download:4,dp:[1,2],dp_nomin:[1,2,9],dpfixed_nomin:9,dpvalve_nomin:9,drag:2,drastic:9,draw:2,drop:[1,5,7,9],dry:4,dslog:9,dt:1,dtsup:2,du:1,dual:2,dualfandualduct:9,dualfandualductclosedloop:9,duct:[1,9],due:[1,2,4,9],duplic:2,dure:[1,2,9],dv_flow:2,dx:1,dymola:[1,2,6,9,10],dynam:[1,2,9],dynamicbal:9,dynamicsfreeiniti:1,e:[1,2,4,5],each:[1,2],earlier:9,easier:[1,4,9],easiest:2,ebc:4,econom:9,editor:[2,4],ef410e:9,effect:[1,2,9],effici:[0,1,2,9],effort:1,either:[2,8],el:9,element:[1,2,9],elementari:9,elimin:9,elmqvist:4,els:[1,2,9],empir:2,employe:3,empti:2,enabl:9,encount:9,end:[0,1,2,5,9],endors:[3,8],energi:[0,1,2,3,4,5,8,9],energydynam:[1,2],energyplu:[2,4],enforc:2,engin:1,english:4,enhanc:8,enlarg:2,ensur:[2,9],enter:[1,2,6],enthalpi:[1,9],entri:9,environ:[6,9],ep:2,epsilon:1,equal:[1,2,9],equat:[5,7],equilibrium:1,equip:[2,7],equival:9,error:[1,2,6,7],essenti:4,estim:1,et:4,evalu:2,even:[1,8],event:[1,2,7,8],everi:9,everyon:6,exact:9,exactli:1,exampl:[1,2,4,5,7,10],exce:9,except:[1,2],exchang:[1,2,5],exclus:8,execut:2,exemplari:8,exhaust:2,exhaustdamp:2,exhibit:1,exist:[2,4],expand:2,expans:1,expansionvessel:1,expect:[1,6],experi:1,experienc:1,experiment:2,explain:[1,2,4,7,9],explan:4,explicitli:1,express:[3,8,9],extend:[1,2],extens:4,extent:2,extrem:9,f:[2,4],fail:[1,2],fals:9,familiar:4,fan:[1,9],fanc:9,fanret:9,fansupcol:9,fansuphot:9,far:2,fast:[1,5],faster:9,favor:3,fd01:9,featur:[8,9],feedback:9,few:9,fig:[1,2,9],figur:[1,2,9],file:[2,6,9,10],filter:[5,9],filteredopen:9,filteredspe:9,find:[6,9],fine:9,finit:2,first:[2,7],fit:[2,8],fix:[1,2,6,7,8,9],fixediniti:1,fixedresist:[2,9],fixedresistancedpm:2,fixm:2,flow:[4,5,7],flowcircuit:1,flowcontrolled_m_flow:9,flowmodel:2,fluid:[2,4,5,7],follow:[1,2,4,7,8,9],font:2,forc:9,forget:2,form:[1,2,8],format:[2,10],formul:[2,9],found:[4,7],foundat:4,four:1,fra2009a:4,fra2009b:4,frac:[2,5,9],fraction:1,frank:4,free:[7,8],frequenc:9,fri2004:4,fri2011:4,friction:9,fritzson:4,from:[1,2,4,8,9],from_dp:9,front:2,full:[1,2,9],fulli:5,further:[2,4,9],g36_pr1:2,g:[1,2],ga:1,gain:[2,9],gave:9,gener:[1,6,7,9,10],genopt:10,geometri:1,get:7,getinstancenam:2,github:[2,6],give:[1,2,4,9],global:9,glossari:7,go:9,good:[1,2,8],gov:[4,7,10],govern:[2,3],grant:8,graphic:2,greaterthreshold:1,grid:2,group:[2,6],grow:9,gui:1,guid:[1,4,9],guidanc:2,guidelin:[4,7],h4:2,h:[4,9],h_1:1,h_a:9,h_i:1,h_outflow:9,ha:[1,2,3,5,8,9],had:9,halt:9,hand:2,handl:[4,9],handler:2,happen:1,hard:2,have:[1,2,9],head:2,header:2,heat:[1,2,4,5,9],heater:1,heatercooler_u:2,heatexchang:2,heattransf:4,help:[1,7,9],henc:[1,2,4,6,9],here:1,herebi:8,herein:3,hidden:2,hierarchi:2,high:9,higher:[1,5,6,9],highlight:9,hmed:9,holder:8,homotopi:2,how:[1,2,4,7,10],howev:[1,2,8,9],href:2,html:[2,4,7],http:[2,4,6,7,10],humid:[1,2],humidifi:[1,2],humidifier_u:2,hvac:[1,2,9],hyperlink:2,hysteresi:[1,2,9],i:[1,2,4,5],icon:2,ideal:[1,2,9],ident:1,iea:4,ieee:4,illustr:[1,9],imag:2,img:2,implement:[1,2,9],impli:[3,8],impos:[1,8],improv:[1,2,9],incident:8,inclin:2,includ:[1,2,5,8],incompress:[5,7],inconsist:7,incorpor:8,incorrect:2,increas:[1,2,9],indent:2,index:7,indic:2,indirect:8,individu:[1,4,7,9],industri:4,inequ:[1,2,9],inertia:9,infin:2,influenc:2,info:2,inform:[2,3,4,6,7,9,10],infring:3,inherit:2,initi:7,inkscap:2,inlet:[2,9],input:[1,2,5,7],insert:2,insight:9,inspect:9,instabl:2,instal:8,instanc:[1,2],instant:[1,2,9],instanti:2,instantli:9,instead:[1,2],instream:9,instruct:[4,7],integ:2,integr:[1,2,9],intend:1,intent:[1,2],interact:[1,4],interest:[0,1,2],interfac:[1,2,4],intern:[2,4],interrupt:8,intersect:9,interv:9,introduc:[1,2,9],introduct:[2,4],invalid:2,invers:2,invert:2,invit:6,invok:2,involv:2,isbn:4,isol:[1,9],issu:[2,6],ital:2,itali:4,item:2,iter:[2,5,7,9],its:[1,2,3,4,8,9],jacobian:2,john:4,join:6,js:2,json:2,junction:[7,9],just:9,k:[2,4,9],k_f:9,k_v:9,keep:2,kelvin:[1,2,9],keyword:2,kg:2,kluwer:4,know:2,knowledg:2,known:[1,2,6],label:2,laboratori:8,languag:[4,7,10],larg:[2,7,9],larger:9,last:9,later:9,latest:7,law:1,lawrenc:8,lbl:[2,4,6,7,10],lbnl:10,le:2,lead:[1,2,9],least:2,left:1,leg:5,legal:3,length:[2,5],let:1,level:[1,2],liabil:[3,8],liabl:8,librai:6,librari:[1,2,4,6,7,10],licens:[2,7],lift:9,like:[1,9],limit:[1,2,8,9],line:[2,9],linear:[2,9],link:4,linux:2,list:[2,4,8],literatur:7,load:[1,2,9],local:9,locat:1,log:[2,9],logic:[1,2],logstartvaluesforiterationvari:1,longer:1,look:2,loop:[2,7],loss:8,low:[5,9],lower:2,lump:[1,2,9],m3:2,m:[1,2,4,9],m_0:2,m_1:1,m_2:1,m_flow:9,m_flow_nomin:[1,2,9],m_flow_smal:[1,2],m_i:1,ma:9,machin:9,made:[1,2],magnitud:[1,5,9],mai:[1,2,4,6,7,8,9],main:2,maintain:2,make:[2,3,4,6,8,9],mani:[1,2,9],manufactur:[1,3],mark:2,mass:[1,2,4,5,7],massdynam:1,massexchang:2,massflowr:[1,2],massflowsource_t:[1,9],master:2,mat:10,materi:8,math:[2,9],mathbb:1,mathrm:1,matlab:10,mattsson:4,max:2,mayb:9,mbe:4,mean:[1,2,5],measur:[1,2,9],mechan:5,media:[2,7],medium:[1,2,4,5,9],menu:1,merchant:8,merg:2,merkel:2,merkelenergyplu:2,messag:[1,2],met:8,method:9,michael:4,millisecond:9,min:2,minimum:2,minu:2,miss:2,mix:[1,9],mixingvolum:1,mockup:4,mode:2,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,2,4,9],most:[1,9],move:[2,5],mover:9,much:[6,9],multipl:[1,2,4,7,9],must:[1,2,8,9],mwat_flow:2,mylibrari:1,n:[1,5],name:[1,2,3,8,9],nation:8,necessari:5,necessarili:3,need:[1,2,4,6,9],neg:2,neglect:1,neglig:[1,8,9],neighborhood:9,neither:[3,8],network:[1,9],never:[1,2],newton:[1,2,5],next:[1,2,4],node:2,nois:[1,2,5,9],nomin:[2,7],non:[2,5,8,9],nonlinear:[1,2,5,7],nor:[3,8],normal:2,note:[1,2,4,8,9],notic:[2,8],now:[1,9],number:[0,1,2,5,9],numer:[1,2,4,5,7],o:2,obc:[1,2,9],object:[2,4],oblig:8,observ:[1,6],obsolet:2,obtain:[1,2],obviou:2,occur:[1,9],off:1,offer:9,offic:0,often:[1,2,9],older:4,olsson:4,omit:2,one:[1,2,9],ones:[2,4],onli:[1,2,9],onlin:4,open:[2,5,6,7],openbuildingcontrol:2,openmodelica:[4,10],oper:[1,2,4,6,8,9],opinion:3,opportun:9,oppos:2,opposit:5,optim:10,optimica:2,option:[1,2,9],order:[5,7,9],ordinari:[5,9],org:[2,4],organ:7,orient:4,origin:2,oscil:9,oscillatori:9,other:[1,2,4,8,9],otherwis:[2,3,8,9],otter:4,our:9,out:[1,8,9],outlet:9,outlin:9,output:[1,2,5,7,9,10],outsid:[1,2,9],over:2,overdetermin:7,overhead:1,overspecifi:1,overview:4,overwrit:2,overwritten:1,own:3,owner:8,p:[1,2,9],p_0:[1,2,5],p_default:1,p_v:5,pa:2,packag:[4,7,9],page:[2,4,7],pai:1,pane:2,paper:4,paragraph:8,paramet:[2,4,7,9],part:[2,6,9,10],parti:3,partial:2,partialabsolutesensor:2,partialmedium:1,partialresist:2,particular:8,particularli:9,pascal:2,pass:[3,5,9],passag:2,patch:8,path:2,per:[1,2],perfectgas:1,perform:[2,7,8],permiss:8,permit:8,perpetu:8,peter:4,phenomena:[1,4,7],phi:2,physic:[1,2,4,7],pi:[2,9],pidwithreset:9,pipe:[1,9],place:2,placement:2,pleas:[2,6],plot:[5,9],pmatrix:5,png:2,point:[1,2,4,9],polynomi:2,port:[1,2],port_a:9,posit:[2,5],possibl:[1,2,6,8,9],post:7,practic:7,pre:[7,9],precomput:2,prefer:2,prepar:[3,8],prescrib:7,present:[1,2],preserveaspectratio:2,press:4,presssur:1,pressur:[5,7,9],pressuredrop:[1,2,9],primarysystem:2,principl:[4,9],printfailuretodifferenti:2,prior:8,priorit:2,privat:3,problem:[2,6,7,9,10],problemat:9,proc:4,process:[2,3,7],processor:2,procur:8,produc:[1,2],product:[1,3,8],proelss:4,profil:9,profit:8,progess:9,program:[0,10],programmat:2,project:2,promot:8,propag:7,proper:1,properti:1,propyleneglycolwat:1,protect:2,provid:[1,2,4,6,7,8,9,10],publicli:8,publish:[1,4],pull:2,pum:1,pump:[1,9],purpos:8,put:2,python:[2,10],q:[1,6],quadrat:2,quantiti:[1,2],question:[6,9],quickli:6,r:[2,4,5],radau:[1,9],radiat:1,rais:[2,9],raisetim:9,rang:[2,9],rapidli:[1,9],rate:[1,2,4,5,7],rather:[1,2,7],ratio:9,re:[1,9],read:[2,4,9],readabl:2,reader:2,real:[1,2,5,9],realinput:2,realist:2,realiz:6,realoutput:2,reason:[1,2],receiv:1,recommend:[1,2,3,4,9],record:2,redeclar:[1,9],redistribut:8,reduc:[1,2,7],redund:2,refactor:2,refer:[2,3,5,7],referenc:2,reflect:3,regard:6,regardless:9,regent:[3,8],region:[1,2],regress:2,regstep:9,regular:[1,2,5,9],rel:[1,2],relat:[1,2,9],releas:[2,7],relev:4,remain:[1,2],remov:[1,2,9],renew:0,replac:[1,2,4,9],report:[3,4,6],repositori:2,repres:[1,2,3],reproduc:[6,8,9],request:[2,9],requir:[1,2,7,9],res1:[1,9],res2:9,res3:1,research:0,resembl:2,reserv:8,residu:9,resist:[1,2,7],resolv:9,resourc:2,respect:[1,2,7,9],respond:2,respons:[1,3,5,9],restart:9,result:[1,2,3,6,10],resultfil:9,retain:8,retun:9,reusabl:2,revers:[1,4],revis:[2,8,9],rho:1,right:[3,8,9],robust:[1,2,9],room:[1,2],root:[6,9],rotat:9,rotor:9,royalti:8,rule:[2,9],run:[1,2,7,9,10],s:[0,1,2,4,8,9,10],safe:2,same:[1,2,4,9],sampl:[1,2],sampler:[1,2],satisfactori:9,satisfi:5,save:[1,6],scalar:[1,2],schemat:[1,2,9],script:[2,10],search:[4,6,7],search_foss:4,search_languag:4,second:[2,5,9],secretari:0,section:[1,2,4,9],see:[1,2,4,5,6,7,9,10],seem:9,select:[1,6,9],sen:1,senden:2,sensor:[2,7,9],sent:9,separ:[2,8,9,10],sept:4,sequenc:7,seri:[1,2,9],serial:7,serv:2,servic:[3,8],set:[1,2,9],setpoint:2,setup:9,sh:2,shall:[2,8],share:2,should:[1,2,5],shoulder:2,show:[1,2,9],shown:[1,2,9],si:[1,2],sielemann:4,sign:[2,9],signal:[1,2,5,7],signific:2,significantli:[2,9],similar:[1,2,4,7],similarli:1,simpl:[2,9],simpler:1,simul:[1,2,6,7,10],simulatemodel:9,simulationresearch:[4,7,10],sinc:1,singl:2,singlezon:2,singular:[1,2],situat:[1,2,9],size:[1,2,9],skip:1,slight:9,slightli:1,slow:[1,7],small:[1,2,5,6,9],smaller:[1,2,5],smooth:[2,9],smoothord:2,snippet:2,so:2,softwar:[7,8],solut:[1,2,5,9],solv:[1,2,5,6,9],solver:[1,2,5,7],some:[1,2,4,9],sometim:9,son:4,sooner:6,sort:2,sourc:[1,2,7,8,9],space:2,spacecool:2,spawn:4,speci:[1,4],special:[1,8],specif:[1,2,3,6,8,10],specifi:[1,10],specificenthalpytwoport:9,speed:9,speedcontrolled_i:9,spell:2,spent:9,spike:9,spl2:1,spoken:4,sponsor:3,sqrt:[2,9],src:2,srg:[2,6],stabil:9,stackoverflow:6,stage:1,stall:[1,2,9],standard:[4,10],start:[2,7,9],state:[1,2,3,5,7],statement:2,steadi:1,steadyst:1,steadystateiniti:1,step:[1,4,5,9],stepsiz:9,still:[2,4,6],stop:[1,9],stoptim:9,storag:1,store:[1,2],stream:[2,4,9],strict:8,string:2,structur:1,studi:4,style:7,sub:2,subcontractor:3,subdirectori:2,sublicens:8,submit:6,subsect:2,substanc:[1,2,4],substancedynam:2,substitut:8,subsystem:1,success:1,successfulli:9,suffici:9,suggest:2,sum_:1,summar:4,summari:2,summer:2,sup:2,suppli:2,support:[0,9],suppos:[1,9],suppress:2,sure:[2,6,9],svg:2,symbol:2,symmetr:2,system:[2,4,5,6,7],t:[1,5,9],t_0:1,t_a:9,t_default:1,tab:[1,2,9],tabl:[1,2],tabul:2,tag:2,tair:2,take:[1,2,9],tau:[1,2,9],tcoicoo:9,td:2,technic:4,technolog:[0,4],temperatur:[1,2,9],temperaturedependentdens:1,temperaturesensor:1,templat:2,temsen_1:9,temsen_2:9,tend:2,termin:9,terminalunit:2,test:[1,5,6,7,10],text:2,textual:2,th:[1,2,4],than:[1,2,4,5,7,9],thei:[1,2],them:[1,2],theori:[2,8],therebi:[1,9],therefor:[1,9],thereof:[3,8],thermal:1,thermo:[4,5,7,9],thermodynam:2,thermofluid:7,thi:[0,1,2,3,5,6,7,8,9,10],thing:9,those:[2,3],thought:9,thousand:2,three:1,threshold:1,through:[1,5,9],thu:[1,9],thumb:9,til2001:4,tiller:4,time:[1,2,5,9],tip:9,tmix:9,togeth:2,toler:[1,5,9],tool:[2,4,9],top:[1,2],topic:1,tort:8,total:6,tower:2,tpreheacoi:9,tr:2,trace:[1,4],track:2,trade:3,trademark:3,train:9,trajectori:9,transfer:4,transform:2,translat:[1,2,7,9],translatemodel:1,transport:[1,4,9],travel:9,tret:9,trigger:[1,9],trim:2,tune:[2,9],turn:[1,9],tutori:[2,4],twatin:2,two:[1,2,9],twowaylinear:9,txt:9,type:[1,7,9],typic:[1,2,5,7,9],tzon:2,u:[0,1,2,5,8],unambigu:2,uncontrol:9,under:[0,2,8,9],understand:[1,2,4],understood:1,unit:[1,3,7,10],univers:[3,4,8],unknown:1,unless:2,unlik:1,unmethour:6,unspecifi:1,unstabl:[1,7],unsuit:2,until:[1,2,5],up:9,upgrad:8,upon:3,us:[0,3,4,6,7,8,9,10],user:[1,2,9],usersguid:2,usual:[1,2,9],util:[2,9],v:1,v_flow:2,val:[1,9],valid:7,valu:[2,4,7,9],valv:[1,2,5,9],vapor:[1,4],vari:[2,9],variabl:[2,5,7],variat:4,variou:[1,2,4,9],vav:2,vavhot:9,veri:[1,9],verifi:2,version:[1,2,4,9],versu:1,vertic:2,view:[2,3],violat:2,vol:1,volum:[1,2,5,9],wa:[0,1,2,3,9],wai:[1,8],want:1,warn:2,warrant:3,warranti:[3,8],water:[2,4,7],we:[1,4,5,9],weather:2,web:4,weight:1,welcom:2,well:[1,2,4],were:[2,10],wetcoildiscret:1,wetter:4,what:[1,2],whatsoev:8,when:[1,2,6,7,9],whenev:[1,2,9],where:[1,2,5,9],whether:[1,2,8],which:[1,2,4,5,7,9],who:4,whole:[5,9],whose:[5,9],why:[1,9],wide:1,wiki:2,wilei:4,winter:2,within:[1,2,5],without:[1,2,8,9],work:[2,3,8,9],workflow:4,would:[1,2,3,9],write:2,write_package_ord:2,written:8,wrong:[1,2],x:[1,2,5,9],x_0:1,x_i:1,x_ptphi:9,xxx:2,y:[2,5,9],ydam:2,year:9,you:[1,8,9],your:[1,2,6,8],yourself:[4,6],zero:[1,2,9],zone:2},titles:["8. Acknowledgments","2. Best Practice","5. Development","9. Disclaimers","1. Getting Started","7. Glossary","6. Help","User Guide","10. Copyright and License","3. Simulation Performance","4. Pre- and Post-Processing"],titleterms:{"break":9,"class":2,"function":2,"new":2,acknowledg:0,ad:2,algebra:9,algorithm:2,avoid:9,best:1,build:1,connect:9,content:7,contribut:2,control:[1,2,9],copyright:8,correct:9,debug:9,declar:2,descript:2,develop:[2,4],devic:2,disclaim:3,document:2,domin:9,drop:2,equat:[1,2,9],equip:9,error:9,event:9,exampl:9,first:4,flow:[1,2,9],fluid:[1,9],gener:2,get:4,glossari:5,guid:[2,7],guidelin:2,help:6,how:9,incompress:1,inconsist:1,indic:7,initi:1,input:9,iter:1,junction:1,languag:2,larg:1,licens:8,literatur:4,loop:9,mass:9,media:1,model:1,nomin:1,nonlinear:9,numer:9,order:2,organ:1,overdetermin:1,packag:[1,2],paramet:1,perform:9,post:10,practic:1,pre:10,prescrib:9,pressur:[1,2],problem:1,process:10,propag:1,rate:9,reduc:9,refer:[1,4],requir:4,resist:9,run:4,sensor:1,sequenc:2,serial:9,signal:9,simul:[4,9],slow:9,softwar:4,solver:9,start:[1,4],state:9,style:2,system:[1,9],tabl:7,test:2,thermo:1,thermofluid:2,type:2,unit:2,unstabl:9,us:[1,2],user:[4,7],valid:2,valu:1,variabl:[1,9],water:1}}) \ No newline at end of file +Search.setIndex({docnames:["acknowledgments","bestPractice","development","disclaimer","gettingStarted","glossary","help","index","legal","performance","prePostProcessing"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["acknowledgments.rst","bestPractice.rst","development.rst","disclaimer.rst","gettingStarted.rst","glossary.rst","help.rst","index.rst","legal.rst","performance.rst","prePostProcessing.rst"],objects:{},objnames:{},objtypes:{},terms:{"0":[1,2,5,9],"01":1,"052":0,"05ch11231":0,"06":9,"07":9,"08":9,"0e7":9,"1":[1,2,4,5,8,9],"10":[0,2,9],"100":2,"10000":9,"1068":4,"11":9,"1180":4,"11905":9,"12":9,"120":9,"12394":9,"13":[2,9],"13201":9,"13555":9,"14":9,"140":9,"15":[1,9],"150":1,"151":1,"16":9,"18":9,"19064":9,"1979":9,"1e":[1,2,9],"2":[1,2,4,8,9],"20":1,"2001":4,"2004":4,"2009":4,"2011":4,"2012":8,"2013":1,"2016":9,"2021":9,"2022":8,"2170":9,"22":9,"25":9,"2736":9,"275":9,"293":1,"2nd":[5,9],"3":[1,2,4,8,9],"30":9,"3000":1,"305":9,"31536000":9,"36":9,"37":9,"38":9,"4":[1,2,4,9],"40":1,"400":9,"419":9,"420":9,"45":9,"47":9,"4974":9,"5":[1,2,4,5,9],"500":0,"5000":9,"5082":9,"51":9,"521":9,"53":9,"58":1,"6":[2,4,9],"60":[2,4],"66e":9,"6732":9,"7":[1,4,9],"71":9,"775":2,"8":[2,9],"80":[2,9],"854873843":9,"855016639":9,"855208419":9,"855351238":9,"9":9,"9267949":9,"94406e":9,"94407e":9,"94411e":9,"9441e":9,"95e7":9,"978":4,"9e7":9,"boolean":[2,9],"break":7,"case":[1,2,9],"class":[4,7],"default":[1,2,9],"do":[2,3],"final":[2,4],"function":[1,4,5,7,8,9,10],"import":2,"long":2,"new":[1,4,6,7],"public":[0,2,4],"return":[1,9],"short":[1,2],"static":1,"switch":[1,9],"transient":1,"true":[1,2,9],"try":1,"while":[1,3,9],A:[2,5,6,8],AND:8,AS:8,And:2,As:[2,9],At:1,BE:8,BUT:8,BY:8,Be:2,But:2,By:5,FOR:8,For:[1,2,5,6,9],IF:8,IN:8,IS:8,If:[1,2,9],In:[1,2,4,5,6,9,10],It:[1,2,3,4,9],NO:8,NOT:8,No:[0,6],OF:8,ON:8,OR:8,On:2,SUCH:8,Such:1,THE:8,TO:8,That:2,The:[0,1,2,3,4,5,6,7,8,9,10],Then:[1,2],There:9,These:1,To:[1,2,4,6,9,10],_nomin:1,_sort_package_ord:2,ab:[1,2],abl:2,about:[4,6],abov:[1,2,4,9],abruptli:9,ac02:0,academ:4,access:2,account:[1,3],accur:9,accuraci:3,achiev:[1,9],acknowledg:7,across:[1,5],actual:[1,2,9],actuat:9,ad:[1,5,7,8,9],adapt:[5,9],add:[1,2,4,9],addit:[1,2,6,10],adequaci:3,adher:2,adjust:[1,9],advanc:[1,2],advic:7,advis:8,affect:1,after:[2,9],again:[2,9],against:2,agenc:3,agreement:8,ahu:2,aid:2,air:[1,2,4,9],al:4,algebra:7,algorithm:[1,7],align:2,all:[1,2,6,8,9],allow:[1,2,9],alphabet:2,alreadi:[1,2,6],also:[1,2,4,9],alt:2,altern:[1,2],although:4,alwai:[1,2],amb:9,ambient:9,among:9,amount:2,an:[1,2,3,4,5,6,9,10],analyt:2,ani:[2,3,8,9],annex:4,annot:[1,2],anoth:[1,2,5,9],antifreez:1,anyon:8,anywai:1,apart:2,app:2,apparatu:3,appear:[2,9],appli:[2,4,9],applic:[1,2],approach:[4,9],approv:3,approxim:[1,2,5,9],ar:[1,2,4,5,6,7,8,9,10],argument:9,aris:8,around:[1,2,5,9],arrai:2,ashra:2,assert:2,assertallinsideminmax:2,assign:2,assist:0,assum:3,assumpt:[1,2,7,9],attempt:[1,9],attribut:2,author:[2,3,5,9],autom:[2,4,7,10],automat:2,avail:[1,2,4,7,8],avoid:[1,2,7],awar:2,award:0,b:1,back:9,bad:9,balanc:[1,2],bar:[1,2,9],base:[1,2,4,5,7],baseclass:[1,2],bash:2,basic:2,basicflowfunction_dp:2,basicflowfunction_m_flow:2,becam:9,becaus:[1,2,4,9],becom:2,been:[1,3,8],befor:[2,6],begin:[2,5],beginn:4,behav:1,behavior:9,believ:3,below:[1,2,9],benchmark:2,berkelei:8,best:7,better:2,between:[1,2,9],binari:8,block:[1,2,5,9],boi:2,boiler:[1,2],boilerpolynomialclosedloop:1,book:4,border:2,both:[1,2,9],bottom:1,bou:1,bound:[2,5],boundari:1,boundary_pt:1,branch:[1,2],bsd:8,bug:[2,6,8],build:[0,2,4,6,7,9],buildings_usersguid:7,buildingspi:[2,10],busi:8,c:[1,8],c_i:1,calcul:2,california:[0,3,8],call:[1,2],can:[1,2,4,6,7,9,10],cannot:2,capabl:9,carbon:1,carnot_i:2,carri:1,casella:4,caus:[1,2,5,6,8,9],caution:1,cdl:[1,2,9],cdot:[1,5],cellpad:2,cellspac:2,celsiu:2,center:2,certainli:1,chanc:6,chang:[1,2,4,5,9],chaotic:9,charact:2,check:[1,2,4,6],chiller:[1,2],chillerpl:1,choicesallmatch:1,choos:8,circ:1,circuit:1,circumv:1,claus:8,close:[1,2,9],closedloop:9,co2:4,co:4,code:[1,2,8,9],coeffici:9,coil:[1,2,9],collaps:2,com:[2,6],combin:5,command:[1,2],comment:2,commerci:3,commiss:[0,3],commit:9,common:[2,7],commun:4,como:4,compact:2,compar:2,comparison:[1,2,9],complet:3,complex:[1,2,4],compli:2,compon:[1,2,4,9],composit:[1,9],compress:[1,5],comput:[1,2,5,8,9,10],concentr:1,concept:4,concis:[2,4],condit:[1,2,5,8,9],conduct:2,confer:4,configur:[1,2,9],connect:[1,2,7],connector:[1,4],consequ:1,consequenti:8,conserv:1,consid:[1,2,9],consist:[1,2,9],constant:[1,2,5,9],constanteffect:2,constitut:3,construct:[1,2],consult:1,contact:9,contain:[1,2,3,4,7,9],continu:[1,2,5,9],contract:[0,8],contractor:3,contribut:[1,7],contributor:8,control:[5,7,10],convect:4,convent:[2,4],converg:[1,5,9],convers:2,convert:[2,5],coocoi:9,cool:[2,9],coolingtow:2,coordinatesystem:2,copi:2,copyright:7,cor:9,correct:[1,2,3,7],correctli:1,correspond:8,cost:10,could:[2,9],coupl:[2,9],cours:1,cover:[2,7],creat:[1,2,6,7,10],cross:[1,9],curv:[1,9],cycl:1,d:2,dae:1,dai:2,damag:8,damper:[2,9],dassl:[1,9],data:[1,2,8],de:0,debug:[1,7],declar:[1,7],decoupl:[2,9],defaultcomponentnam:2,defin:[1,4,5],definit:[1,4],degc:2,degre:2,delai:[1,2],delet:9,delta:[2,5,9],denot:2,densiti:[1,2,5],depart:[0,8],depend:[1,2,9],dept:8,der:[1,9],deriv:[1,2,5,8],describ:[1,2,4,9],descript:[6,7],design:[1,4,5],detail:[1,4,9],detect:[2,9],determin:9,develop:[0,1,7,9,10],devic:[1,4,7],diagram:[1,2,9],dialog:2,did:9,differ:[1,2,4,9],differenti:[1,2,5,9],difficult:2,dioxid:1,direct:[1,2,4,8],directli:8,directori:[2,10],disabl:2,disapprov:3,disclaim:[7,8],disclos:3,discontinu:2,displayunit:2,distinct:1,distinguish:1,distribut:[1,2,8],divid:2,dm:1,document:[0,1,3,4,7,8,9,10],doe:[1,2,3,9,10],domain:1,domin:7,done:[1,2],dot:[1,2,5,9],down:1,download:4,dp:[1,2],dp_nomin:[1,2,9],dpfixed_nomin:9,dpvalve_nomin:9,drag:2,drastic:9,draw:2,drop:[1,5,7,9],dry:4,dslog:9,dt:1,dtsup:2,du:1,dual:2,dualfandualduct:9,dualfandualductclosedloop:9,duct:[1,9],due:[1,2,4,9],duplic:2,dure:[1,2,9],dv_flow:2,dx:1,dymola:[1,2,6,9,10],dynam:[1,2,9],dynamicbal:9,dynamicsfreeiniti:1,e:[1,2,4,5],each:[1,2],earlier:9,easier:[1,4,9],easiest:2,ebc:4,econom:9,editor:[2,4],ef410e:9,effect:[1,2,9],effici:[0,1,2,9],effort:1,either:[2,8],el:9,element:[1,2,9],elementari:9,elimin:9,elmqvist:4,els:[1,2,9],empir:2,employe:3,empti:2,enabl:9,encount:9,end:[0,1,2,5,9],endors:[3,8],energi:[0,1,2,3,4,5,8,9],energydynam:[1,2],energyplu:[2,4],enforc:2,engin:1,english:4,enhanc:8,enlarg:2,ensur:[2,9],enter:[1,2,6],enthalpi:[1,9],entri:9,environ:[6,9],ep:2,epsilon:1,equal:[1,2,9],equat:[5,7],equilibrium:1,equip:[2,7],equival:9,error:[1,2,6,7],essenti:4,estim:1,et:4,evalu:2,even:[1,8],event:[1,2,7,8],everi:9,everyon:6,exact:9,exactli:1,exampl:[1,2,4,5,7,10],exce:9,except:[1,2],exchang:[1,2,5],exclus:8,execut:2,exemplari:8,exhaust:2,exhaustdamp:2,exhibit:1,exist:[2,4],expand:2,expans:1,expansionvessel:1,expect:[1,6],experi:1,experienc:1,experiment:2,explain:[1,2,4,7,9],explan:4,explicitli:1,express:[3,8,9],extend:[1,2],extens:4,extent:2,extrem:9,f:[2,4],fail:[1,2],fals:9,familiar:4,fan:[1,9],fanc:9,fanret:9,fansupcol:9,fansuphot:9,far:2,fast:[1,5],faster:9,favor:3,fd01:9,featur:[8,9],feedback:9,few:9,fig:[1,2,9],figur:[1,2,9],file:[2,6,9,10],filter:[5,9],filteredopen:9,filteredspe:9,find:[6,9],fine:9,finit:2,first:[2,7],fit:[2,8],fix:[1,2,6,7,8,9],fixediniti:1,fixedresist:[2,9],fixedresistancedpm:2,fixm:2,flow:[4,5,7],flowcircuit:1,flowcontrolled_m_flow:9,flowmodel:2,fluid:[2,4,5,7],follow:[1,2,4,7,8,9],font:2,forc:9,forget:2,form:[1,2,8],format:[2,10],formul:[2,9],found:[4,7],foundat:4,four:1,fra2009a:4,fra2009b:4,frac:[2,5,9],fraction:1,frank:4,free:[7,8],frequenc:9,fri2004:4,fri2011:4,friction:9,fritzson:4,from:[1,2,4,8,9],from_dp:9,front:2,full:[1,2,9],fulli:5,further:[2,4,9],g36_pr1:2,g:[1,2],ga:1,gain:[2,9],gave:9,gener:[1,6,7,9,10],genopt:10,geometri:1,get:7,getinstancenam:2,github:[2,6],give:[1,2,4,9],global:9,glossari:7,go:9,good:[1,2,8],gov:[4,7,10],govern:[2,3],grant:8,graphic:2,greaterthreshold:1,grid:2,group:[2,6],grow:9,gui:1,guid:[1,4,9],guidanc:2,guidelin:[4,7],h4:2,h:[4,9],h_1:1,h_a:9,h_i:1,h_outflow:9,ha:[1,2,3,5,8,9],had:9,halt:9,hand:2,handl:[4,9],handler:2,happen:1,hard:2,have:[1,2,9],head:2,header:2,heat:[1,2,4,5,9],heater:1,heatercooler_u:2,heatexchang:2,heattransf:4,help:[1,7,9],henc:[1,2,4,6,9],here:1,herebi:8,herein:3,hidden:2,hierarchi:2,high:9,higher:[1,5,6,9],highlight:9,hmed:9,holder:8,homotopi:2,how:[1,2,4,7,10],howev:[1,2,8,9],href:2,html:[2,4,7],http:[2,4,6,7,10],humid:[1,2],humidifi:[1,2],humidifier_u:2,hvac:[1,2,9],hyperlink:2,hysteresi:[1,2,9],i:[1,2,4,5],icon:2,ideal:[1,2,9],ident:1,iea:4,ieee:4,illustr:[1,9],imag:2,img:2,implement:[1,2,9],impli:[3,8],impos:[1,8],improv:[1,2,9],incident:8,inclin:2,includ:[1,2,5,8],incompress:[5,7],inconsist:7,incorpor:8,incorrect:2,increas:[1,2,9],indent:2,index:7,indic:2,indirect:8,individu:[1,4,7,9],industri:4,inequ:[1,2,9],inertia:9,infin:2,influenc:2,info:2,inform:[2,3,4,6,7,9,10],infring:3,inherit:2,initi:7,inkscap:2,inlet:[2,9],input:[1,2,5,7],insert:2,insight:9,inspect:9,instabl:2,instal:8,instanc:[1,2],instant:[1,2,9],instanti:2,instantli:9,instead:[1,2],instream:9,instruct:[4,7],integ:2,integr:[1,2,9],intend:1,intent:[1,2],interact:[1,4],interest:[0,1,2],interfac:[1,2,4],intern:[2,4],interrupt:8,intersect:9,interv:9,introduc:[1,2,9],introduct:[2,4],invalid:2,invers:2,invert:2,invit:6,invok:2,involv:2,isbn:4,isol:[1,9],issu:[2,6],ital:2,itali:4,item:2,iter:[2,5,7,9],its:[1,2,3,4,8,9],jacobian:2,john:4,join:6,js:2,json:2,junction:[7,9],just:9,k:[2,4,9],k_f:9,k_v:9,keep:2,kelvin:[1,2,9],keyword:2,kg:2,kluwer:4,know:2,knowledg:2,known:[1,2,6],label:2,laboratori:8,languag:[4,7,10],larg:[2,7,9],larger:9,last:9,later:9,latest:7,law:1,lawrenc:8,lbl:[2,4,6,7,10],lbnl:10,le:2,lead:[1,2,9],least:2,left:1,leg:5,legal:3,length:[2,5],let:1,level:[1,2],liabil:[3,8],liabl:8,librai:6,librari:[1,2,4,6,7,10],licens:[2,7],lift:9,like:[1,9],limit:[1,2,8,9],line:[2,9],linear:[2,9],link:4,linux:2,list:[2,4,8],literatur:7,load:[1,2,9],local:9,locat:1,log:[2,9],logic:[1,2],logstartvaluesforiterationvari:1,longer:1,look:2,loop:[2,7],loss:8,low:[5,9],lower:2,lump:[1,2,9],m3:2,m:[1,2,4,9],m_0:2,m_1:1,m_2:1,m_flow:9,m_flow_nomin:[1,2,9],m_flow_smal:[1,2],m_i:1,ma:9,machin:9,made:[1,2],magnitud:[1,5,9],mai:[1,2,4,6,7,8,9],main:2,maintain:2,make:[2,3,4,6,8,9],mani:[1,2,9],manufactur:[1,3],mark:2,mass:[1,2,4,5,7],massdynam:1,massexchang:2,massflowr:[1,2],massflowsource_t:[1,9],master:2,mat:10,materi:8,math:[2,9],mathbb:1,mathrm:1,matlab:10,mattsson:4,max:2,mayb:9,mbe:4,mean:[1,2,5],measur:[1,2,9],mechan:5,media:[2,7],medium:[1,2,4,5,9],menu:1,merchant:8,merg:2,merkel:2,merkelenergyplu:2,messag:[1,2],met:8,method:9,michael:4,millisecond:9,min:2,minimum:2,minu:2,miss:2,mix:[1,9],mixingvolum:1,mockup:4,mode:2,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,2,4,9],most:[1,9],move:[2,5],mover:9,much:[6,9],multipl:[1,2,4,7,9],must:[1,2,8,9],mwat_flow:2,mylibrari:1,n:[1,5],name:[1,2,3,8,9],nation:8,necessari:5,necessarili:3,need:[1,2,4,6,9],neg:2,neglect:1,neglig:[1,8,9],neighborhood:9,neither:[3,8],network:[1,9],never:[1,2],newton:[1,2,5],next:[1,2,4],node:2,nois:[1,2,5,9],nomin:[2,7],non:[2,5,8,9],nonlinear:[1,2,5,7],nor:[3,8],normal:2,note:[1,2,4,8,9],notic:[2,8],now:[1,9],number:[0,1,2,5,9],numer:[1,2,4,5,7],o:2,obc:[1,2,9],object:[2,4],oblig:8,observ:[1,6],obsolet:2,obtain:[1,2],obviou:2,occur:[1,9],off:1,offer:9,offic:0,often:[1,2,9],older:4,olsson:4,omit:2,one:[1,2,9],ones:[2,4],onli:[1,2,9],onlin:4,open:[2,5,6,7],openbuildingcontrol:2,openmodelica:[4,10],oper:[1,2,4,6,8,9],opinion:3,opportun:9,oppos:2,opposit:5,optim:10,optimica:2,option:[1,2,9],order:[5,7,9],ordinari:[5,9],org:[2,4],organ:7,orient:4,origin:2,oscil:9,oscillatori:9,other:[1,2,4,8,9],otherwis:[2,3,8,9],otter:4,our:9,out:[1,8,9],outlet:9,outlin:9,output:[1,2,5,7,9,10],outsid:[1,2,9],over:2,overdetermin:7,overhead:1,overspecifi:1,overview:4,overwrit:2,overwritten:1,own:3,owner:8,p:[1,2,9],p_0:[1,2,5],p_default:1,p_v:5,pa:2,packag:[4,7,9],page:[2,4,7],pai:1,pane:2,paper:4,paragraph:8,paramet:[2,4,7,9],part:[2,6,9,10],parti:3,partial:2,partialabsolutesensor:2,partialmedium:1,partialresist:2,particular:8,particularli:9,pascal:2,pass:[3,5,9],passag:2,patch:8,path:2,per:[1,2],perfectgas:1,perform:[2,7,8],permiss:8,permit:8,perpetu:8,peter:4,phenomena:[1,4,7],phi:2,physic:[1,2,4,7],pi:[2,9],pidwithreset:9,pipe:[1,9],place:2,placement:2,pleas:[2,6],plot:[5,9],pmatrix:5,png:2,point:[1,2,4,9],polynomi:2,port:[1,2],port_a:9,posit:[2,5],possibl:[1,2,6,8,9],post:7,practic:7,pre:[7,9],precomput:2,prefer:2,prepar:[3,8],prescrib:7,present:[1,2],preserveaspectratio:2,press:4,presssur:1,pressur:[5,7,9],pressuredrop:[1,2,9],primarysystem:2,principl:[4,9],printfailuretodifferenti:2,prior:8,priorit:2,privat:3,problem:[2,6,7,9,10],problemat:9,proc:4,process:[2,3,7],processor:2,procur:8,produc:[1,2],product:[1,3,8],proelss:4,profil:9,profit:8,progess:9,program:[0,10],programmat:2,project:2,promot:8,propag:7,proper:1,properti:1,propyleneglycolwat:1,protect:2,provid:[1,2,4,6,7,8,9,10],publicli:8,publish:[1,4],pull:2,pum:1,pump:[1,9],purpos:8,put:2,python:[2,10],q:[1,6],quadrat:2,quantiti:[1,2],question:[6,9],quickli:6,r:[2,4,5],radau:[1,9],radiat:1,rais:[2,9],raisetim:9,rang:[2,9],rapidli:[1,9],rate:[1,2,4,5,7],rather:[1,2,7],ratio:9,re:[1,9],read:[2,4,9],readabl:2,reader:2,real:[1,2,5,9],realinput:2,realist:2,realiz:6,realoutput:2,reason:[1,2],receiv:1,recommend:[1,2,3,4,9],record:2,redeclar:[1,9],redistribut:8,reduc:[1,2,7],redund:2,refactor:2,refer:[2,3,5,7],referenc:2,reflect:3,regard:6,regardless:9,regent:[3,8],region:[1,2],regress:2,regstep:9,regular:[1,2,5,9],rel:[1,2],relat:[1,2,9],releas:[2,7],relev:4,remain:[1,2],remov:[1,2,9],renew:0,replac:[1,2,4,9],report:[3,4,6],repositori:2,repres:[1,2,3],reproduc:[6,8,9],request:[2,9],requir:[1,2,7,9],res1:[1,9],res2:9,res3:1,research:0,resembl:2,reserv:8,residu:9,resist:[1,2,7],resolv:9,resourc:2,respect:[1,2,7,9],respond:2,respons:[1,3,5,9],restart:9,result:[1,2,3,6,10],resultfil:9,retain:8,retun:9,reusabl:2,revers:[1,4],revis:[2,8,9],rho:1,right:[3,8,9],robust:[1,2,9],room:[1,2],root:[6,9],rotat:9,rotor:9,royalti:8,rule:[2,9],run:[1,2,7,9,10],s:[0,1,2,4,8,9,10],safe:2,same:[1,2,4,9],sampl:[1,2],sampler:[1,2],satisfactori:9,satisfi:5,save:[1,6],scalar:[1,2],schemat:[1,2,9],script:[2,10],search:[4,6,7],search_foss:4,search_languag:4,second:[2,5,9],secretari:0,section:[1,2,4,9],see:[1,2,4,5,6,7,9,10],seem:9,select:[1,6,9],sen:1,senden:2,sensor:[2,7,9],sent:9,separ:[2,8,9,10],sept:4,sequenc:7,seri:[1,2,9],serial:7,serv:2,servic:[3,8],set:[1,2,9],setpoint:2,setup:9,sh:2,shall:[2,8],share:2,should:[1,2,5],shoulder:2,show:[1,2,9],shown:[1,2,9],si:[1,2],sielemann:4,sign:[2,9],signal:[1,2,5,7],signific:2,significantli:[2,9],similar:[1,2,4,7],similarli:1,simpl:[2,9],simpler:1,simul:[1,2,6,7,10],simulatemodel:9,simulationresearch:[4,7,10],sinc:1,singl:2,singlezon:2,singular:[1,2],situat:[1,2,9],size:[1,2,9],skip:1,slight:9,slightli:1,slow:[1,7],small:[1,2,5,6,9],smaller:[1,2,5],smooth:[2,9],smoothord:2,snippet:2,so:2,softwar:[7,8],solut:[1,2,5,9],solv:[1,2,5,6,9],solver:[1,2,5,7],some:[1,2,4,9],sometim:9,son:4,sooner:6,sort:2,sourc:[1,2,7,8,9],space:2,spacecool:2,spawn:4,speci:[1,4],special:[1,8],specif:[1,2,3,6,8,10],specifi:[1,10],specificenthalpytwoport:9,speed:9,speedcontrolled_i:9,spell:2,spent:9,spike:9,spl2:1,spoken:4,sponsor:3,sqrt:[2,9],src:2,srg:[2,6],stabil:9,stackoverflow:6,stage:1,stall:[1,2,9],standard:[4,10],start:[2,7,9],state:[1,2,3,5,7],statement:2,steadi:1,steadyst:1,steadystateiniti:1,step:[1,4,5,9],stepsiz:9,still:[2,4,6],stop:[1,9],stoptim:9,storag:1,store:[1,2],stream:[2,4,9],strict:8,string:2,structur:1,studi:4,style:7,sub:2,subcontractor:3,subdirectori:2,sublicens:8,submit:6,subsect:2,substanc:[1,2,4],substancedynam:2,substitut:8,subsystem:1,success:1,successfulli:9,suffici:9,suggest:2,sum_:1,summar:4,summari:2,summer:2,sup:2,suppli:2,support:[0,9],suppos:[1,9],suppress:2,sure:[2,6,9],svg:2,symbol:2,symmetr:2,system:[2,4,5,6,7],t:[1,5,9],t_0:1,t_a:9,t_default:1,tab:[1,2,9],tabl:[1,2],tabul:2,tag:2,tair:2,take:[1,2,9],tau:[1,2,9],tcoicoo:9,td:2,technic:4,technolog:[0,4],temperatur:[1,2,9],temperaturedependentdens:1,temperaturesensor:1,templat:2,temsen_1:9,temsen_2:9,tend:2,termin:9,terminalunit:2,test:[1,5,6,7,10],text:2,textual:2,th:[1,2,4],than:[1,2,4,5,7,9],thei:[1,2],them:[1,2],theori:[2,8],therebi:[1,9],therefor:[1,9],thereof:[3,8],thermal:1,thermo:[4,5,7,9],thermodynam:2,thermofluid:7,thi:[0,1,2,3,5,6,7,8,9,10],thing:9,those:[2,3],thought:9,thousand:2,three:1,threshold:1,through:[1,5,9],thu:[1,9],thumb:9,til2001:4,tiller:4,time:[1,2,5,9],tip:9,tmix:9,togeth:2,toler:[1,5,9],tool:[2,4,9],top:[1,2],topic:1,tort:8,total:6,tower:2,tpreheacoi:9,tr:2,trace:[1,4],track:2,trade:3,trademark:3,train:9,trajectori:9,transfer:4,transform:2,translat:[1,2,7,9],translatemodel:1,transport:[1,4,9],travel:9,tret:9,trigger:[1,9],trim:2,tune:[2,9],turn:[1,9],tutori:[2,4],twatin:2,two:[1,2,9],twowaylinear:9,txt:9,type:[1,7,9],typic:[1,2,5,7,9],tzon:2,u:[0,1,2,5,8],unambigu:2,uncontrol:9,under:[0,2,8,9],understand:[1,2,4],understood:1,unit:[1,3,7,10],univers:[3,4,8],unknown:1,unless:2,unlik:1,unmethour:6,unspecifi:1,unstabl:[1,7],unsuit:2,until:[1,2,5],up:9,upgrad:8,upon:3,us:[0,3,4,6,7,8,9,10],user:[1,2,9],usersguid:2,usual:[1,2,9],util:[2,9],v:1,v_flow:2,val:[1,9],valid:7,valu:[2,4,7,9],valv:[1,2,5,9],vapor:[1,4],vari:[2,9],variabl:[2,5,7],variat:4,variou:[1,2,4,9],vav:2,vavhot:9,veri:[1,9],verifi:2,version:[1,2,4,9],versu:1,vertic:2,view:[2,3],violat:2,vol:1,volum:[1,2,5,9],wa:[0,1,2,3,9],wai:[1,8],want:1,warn:2,warrant:3,warranti:[3,8],water:[2,4,7],we:[1,4,5,9],weather:2,web:4,weight:1,welcom:2,well:[1,2,4],were:[2,10],wetcoildiscret:1,wetter:4,what:[1,2],whatsoev:8,when:[1,2,6,7,9],whenev:[1,2,9],where:[1,2,5,9],whether:[1,2,8],which:[1,2,4,5,7,9],who:4,whole:[5,9],whose:[5,9],why:[1,9],wide:1,wiki:2,wilei:4,winter:2,within:[1,2,5],without:[1,2,8,9],work:[2,3,8,9],workflow:4,would:[1,2,3,9],write:2,write_package_ord:2,written:8,wrong:[1,2],x:[1,2,5,9],x_0:1,x_i:1,x_ptphi:9,xxx:2,y:[2,5,9],ydam:2,year:9,you:[1,8,9],your:[1,2,6,8],yourself:[4,6],zero:[1,2,9],zone:2},titles:["8. Acknowledgments","2. Best Practice","5. Development","9. Disclaimers","1. Getting Started","7. Glossary","6. Help","User Guide","10. Copyright and License","3. Simulation Performance","4. Pre- and Post-Processing"],titleterms:{"break":9,"class":2,"function":2,"new":2,acknowledg:0,ad:2,algebra:9,algorithm:2,avoid:9,best:1,build:1,connect:9,content:7,contribut:2,control:[1,2,9],copyright:8,correct:9,debug:9,declar:2,descript:2,develop:[2,4],devic:2,disclaim:3,document:2,domin:9,drop:2,equat:[1,2,9],equip:9,error:9,event:9,exampl:9,first:4,flow:[1,2,9],fluid:[1,9],gener:2,get:4,glossari:5,guid:[2,7],guidelin:2,help:6,how:9,incompress:1,inconsist:1,indic:7,initi:1,input:9,iter:1,junction:1,languag:2,larg:1,licens:8,literatur:4,loop:9,mass:9,media:1,model:1,nomin:1,nonlinear:9,numer:9,order:2,organ:1,overdetermin:1,packag:[1,2],paramet:1,perform:9,post:10,practic:1,pre:10,prescrib:9,pressur:[1,2],problem:1,process:10,propag:1,rate:9,reduc:9,refer:[1,4],requir:4,resist:9,run:4,sensor:1,sequenc:2,serial:9,signal:9,simul:[4,9],slow:9,softwar:4,solver:9,start:[1,4],state:9,style:2,system:[1,9],tabl:7,test:2,thermo:1,thermofluid:2,type:2,unit:2,unstabl:9,us:[1,2],user:[4,7],valid:2,valu:1,variabl:[1,9],water:1}}) \ No newline at end of file diff --git a/Buildings/Resources/Documentation/userGuide/source/development.rst b/Buildings/Resources/Documentation/userGuide/source/development.rst index 07d595e8c3e..3e5c7be5e58 100644 --- a/Buildings/Resources/Documentation/userGuide/source/development.rst +++ b/Buildings/Resources/Documentation/userGuide/source/development.rst @@ -537,7 +537,7 @@ The following rules need to be followed, in addition to the guidelines described but prioritize groupings based on model specific similarities. #. Each block must have a ``defaultComponentName`` annotation and a ``%name`` label placed above the icon. - See for example the `CDL.Logical.Sources.Constant `_ + See for example line 13 in the `CDL.Logical.Sources.Constant `_ block. #. To aid readability, the formatting of the Modelica source code file must be consistent with other diff --git a/Buildings/Resources/Documentation/userGuide/source/gettingStarted.rst b/Buildings/Resources/Documentation/userGuide/source/gettingStarted.rst index ceb6a04d94a..586a6a60e4d 100644 --- a/Buildings/Resources/Documentation/userGuide/source/gettingStarted.rst +++ b/Buildings/Resources/Documentation/userGuide/source/gettingStarted.rst @@ -19,7 +19,7 @@ Although the `Modelica Language Tutorial `_ final report +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, diff --git a/Buildings/Resources/Documentation/userGuide/source/performance.rst b/Buildings/Resources/Documentation/userGuide/source/performance.rst index b661bb02a0a..a079469114e 100644 --- a/Buildings/Resources/Documentation/userGuide/source/performance.rst +++ b/Buildings/Resources/Documentation/userGuide/source/performance.rst @@ -27,7 +27,7 @@ helpful to log which state variables dominate the integration error or the integrator time step control. This usually points to the control loop that is unstable. There are various methods for tuning a controller, and the documentation of -`Buildings.Controls.OBC.CDL.Reals.PIDWithReset `_ +`Buildings.Controls.OBC.CDL.Reals.PIDWithReset `_ outlines one approach for tuning the gains of a PI-controller.