diff --git a/doc/make_docs.sh b/doc/make_docs.sh index 14b522ae..d40b135f 100755 --- a/doc/make_docs.sh +++ b/doc/make_docs.sh @@ -26,6 +26,7 @@ #COMPLETENESS, OR USEFULNESS OR ANY INFORMATION, APPARATUS, PRODUCT, OR #PROCESS DISCLOSED, OR REPRESENTS THAT ITS USE WOULD NOT INFRINGE PRIVATELY #OWNED RIGHTS. + SCRIPT_NAME=`readlink $0` if test -x "$SCRIPT_NAME"; then @@ -48,6 +49,22 @@ done rm -Rvf pdfs +# add custom, collective inputs to TEXINPUTS +# +# Since on Windows we use MikTeX (which is a native Windows program), the TEXTINPUTS variable used i +# to tell the LaTeX processor where to look for .sty files must be set using Windows-style paths +# (not the Unix-style ones used on other platforms). This also means semi-colons need to be used +# to separate terms instead of the Unix colon. +# +if [ "$(uname)" == "Darwin" ] || [ "$(expr substr $(uname -s) 1 5)" == "Linux" ] +then + export TEXINPUTS=.:$SCRIPT_DIR/tex_inputs/:$TEXINPUTS +elif [ "$(expr substr $(uname -s) 1 5)" == "MINGW" ] || [ "$(expr substr $(uname -s) 1 4)" == "MSYS" ] +then + export TEXINPUTS=.\;`cygpath -w $SCRIPT_DIR/tex_inputs`\;$TEXINPUTS +fi + + if git describe then git describe | sed 's/_/\\_/g' > new_version.tex @@ -90,12 +107,12 @@ for DIR in user_manual; do cd $SCRIPT_DIR done -#cd sqa -#./make_docs.sh -#cd .. +cd sqa +./make_docs.sh +cd .. mkdir pdfs -for DOC in user_manual/hybrid_user_manual.pdf; do - cp $DOC pdfs/ +for DOC in user_manual/hybrid_user_manual.pdf sqa/sqa_built_documents/; do + cp $DOC* pdfs/ done diff --git a/doc/pdfs/hybrid_user_manual.pdf b/doc/pdfs/hybrid_user_manual.pdf index 30c54315..df467892 100644 Binary files a/doc/pdfs/hybrid_user_manual.pdf and b/doc/pdfs/hybrid_user_manual.pdf differ diff --git a/doc/sqa/sqa_built_documents/HYBRID_SQA_Status_Dashboard.pptx b/doc/sqa/sqa_built_documents/HYBRID_SQA_Status_Dashboard.pptx index 6743c104..30f249d8 100644 Binary files a/doc/sqa/sqa_built_documents/HYBRID_SQA_Status_Dashboard.pptx and b/doc/sqa/sqa_built_documents/HYBRID_SQA_Status_Dashboard.pptx differ diff --git a/doc/sqa/srs/requirements_list.xml b/doc/sqa/srs/requirements_list.xml new file mode 100644 index 00000000..ea4c7a2e --- /dev/null +++ b/doc/sqa/srs/requirements_list.xml @@ -0,0 +1,64 @@ + + + + + + + + Dymola 2020x or higher + K. Frick, A. Alfonsi, C. Rabiti, ``HYBRID User Manual'', INL/MIS-20-60624 + + + Visual Studio 2017 or higher with associated 64-bit Intel Compiler + K. Frick, A. Alfonsi, C. Rabiti, ``HYBRID User Manual'', INL/MIS-20-60624 + + + Python 3 or higher to be able to execute RAVEN-based workflows + K. Frick, A. Alfonsi, C. Rabiti, ``HYBRID User Manual'', INL/MIS-20-60624 + + + + + + + + + + HYBRID shall allow the user the leverage and use compoment models developed in Modelica language + + + HYBRID shall provide models to simulate component/system control in Modelica language + + + + + + HYBRID shall allow the user the ability to interact with modelica models via the Dymola GUI. + https://github.com/idaholab/hybrid/wiki + + + + + + + + + HYBRID shall have regression tests to perform checks on modelica models. + + + + + + + + HYBRID-based models shall be able to be coupled with external applications via input files + + + HYBRID-based models shall be able to be coupled with standardized interface (FMI and FMU) + + + + + + + diff --git a/doc/user_manual/hybrid_user_manual.aux b/doc/user_manual/hybrid_user_manual.aux index b2c7f1f4..c71e2b82 100644 --- a/doc/user_manual/hybrid_user_manual.aux +++ b/doc/user_manual/hybrid_user_manual.aux @@ -22,120 +22,120 @@ \citation{2019NuScaleM4} \citation{ModelicaAssociation} \citation{TRANSFORM} -\@writefile{toc}{\contentsline {section}{\numberline {1}Introduction}{1}{section.1}\protected@file@percent } -\@writefile{toc}{\contentsline {subsection}{\numberline {1.1}Modelica Models}{1}{subsection.1.1}\protected@file@percent } -\@writefile{toc}{\contentsline {subsection}{\numberline {1.2}Individual Components}{1}{subsection.1.2}\protected@file@percent } -\@writefile{toc}{\contentsline {subsection}{\numberline {1.3}Hybrid Requirements}{2}{subsection.1.3}\protected@file@percent } -\@writefile{toc}{\contentsline {section}{\numberline {2}HYBRID Installation Procedure}{3}{section.2}\protected@file@percent } -\@writefile{toc}{\contentsline {subsection}{\numberline {2.1}Overview}{3}{subsection.2.1}\protected@file@percent } -\@writefile{toc}{\contentsline {subsection}{\numberline {2.2}Cloning the Hybrid Repository}{3}{subsection.2.2}\protected@file@percent } +\@writefile{toc}{\contentsline {section}{\numberline {1}Introduction}{1}{section.1}} +\@writefile{toc}{\contentsline {subsection}{\numberline {1.1}Modelica Models}{1}{subsection.1.1}} +\@writefile{toc}{\contentsline {subsection}{\numberline {1.2}Individual Components}{1}{subsection.1.2}} +\@writefile{toc}{\contentsline {subsection}{\numberline {1.3}Hybrid Requirements}{2}{subsection.1.3}} +\@writefile{toc}{\contentsline {section}{\numberline {2}HYBRID Installation Procedure}{3}{section.2}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.1}Overview}{3}{subsection.2.1}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.2}Cloning the Hybrid Repository}{3}{subsection.2.2}} \newlabel{sec:clone raven}{{2.2}{3}{Cloning the Hybrid Repository}{subsection.2.2}{}} -\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.1}Install RAVEN and its plugins as a sub-module}{4}{subsubsection.2.2.1}\protected@file@percent } -\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.2}Inform the Framework Paths}{4}{subsubsection.2.2.2}\protected@file@percent } -\@writefile{toc}{\contentsline {subsection}{\numberline {2.3}Setup of Dymola for the Regression Testing System}{5}{subsection.2.3}\protected@file@percent } -\@writefile{toc}{\contentsline {subsection}{\numberline {2.4}Run Regression tests related to the HYBRID project}{5}{subsection.2.4}\protected@file@percent } -\@writefile{toc}{\contentsline {section}{\numberline {3}Running and Creating New Code}{8}{section.3}\protected@file@percent } -\@writefile{toc}{\contentsline {subsection}{\numberline {3.1}Understanding and Running Existing Models}{8}{subsection.3.1}\protected@file@percent } -\@writefile{lot}{\contentsline {table}{\numberline {1}{\ignorespaces Examples of large-Scale Systems within the Hybrid repository used in the creation of Integrated Energy Systems.\relax }}{9}{table.caption.1}\protected@file@percent } +\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.1}Install RAVEN and its plugins as a sub-module}{4}{subsubsection.2.2.1}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.2}Inform the Framework Paths}{4}{subsubsection.2.2.2}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.3}Setup of Dymola for the Regression Testing System}{5}{subsection.2.3}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.4}Run Regression tests related to the HYBRID project}{5}{subsection.2.4}} +\@writefile{toc}{\contentsline {section}{\numberline {3}Running and Creating New Code}{8}{section.3}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.1}Understanding and Running Existing Models}{8}{subsection.3.1}} +\@writefile{lot}{\contentsline {table}{\numberline {1}{\ignorespaces Examples of large-Scale Systems within the Hybrid repository used in the creation of Integrated Energy Systems.\relax }}{9}{table.caption.1}} \providecommand*\caption@xref[2]{\@setref\relax\@undefined{#1}} \newlabel{tab:table1}{{1}{9}{Examples of large-Scale Systems within the Hybrid repository used in the creation of Integrated Energy Systems.\relax }{table.caption.1}{}} -\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces a) Overall Modelica package, b) template structure for creating new subsystem categories and specific subsystem models within a category, c) example of a specific implementation of a primary heat system using the template approach. \relax }}{10}{figure.caption.2}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces a) Overall Modelica package, b) template structure for creating new subsystem categories and specific subsystem models within a category, c) example of a specific implementation of a primary heat system using the template approach. \relax }}{10}{figure.caption.2}} \newlabel{fig:Template}{{1}{10}{a) Overall Modelica package, b) template structure for creating new subsystem categories and specific subsystem models within a category, c) example of a specific implementation of a primary heat system using the template approach. \relax }{figure.caption.2}{}} -\@writefile{lof}{\contentsline {figure}{\numberline {2}{\ignorespaces Exploded view of the NSSS\textunderscore Test example within the NHES library with control system options opened up \relax }}{11}{figure.caption.3}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {2}{\ignorespaces Exploded view of the NSSS\textunderscore Test example within the NHES library with control system options opened up \relax }}{11}{figure.caption.3}} \newlabel{Example File}{{2}{11}{Exploded view of the NSSS\textunderscore Test example within the NHES library with control system options opened up \relax }{figure.caption.3}{}} -\@writefile{lof}{\contentsline {figure}{\numberline {3}{\ignorespaces Subsystem for the Westinghouse-4 Loop model.\relax }}{12}{figure.caption.4}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {3}{\ignorespaces Subsystem for the Westinghouse-4 Loop model.\relax }}{12}{figure.caption.4}} \newlabel{Westinghouse 4-loop}{{3}{12}{Subsystem for the Westinghouse-4 Loop model.\relax }{figure.caption.4}{}} -\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.1}Modifying Existing Models for Specific Runs}{12}{subsubsection.3.1.1}\protected@file@percent } -\@writefile{lof}{\contentsline {figure}{\numberline {4}{\ignorespaces Control System (CS) for the Westinghouse 4 Loop model\relax }}{13}{figure.caption.5}\protected@file@percent } +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.1}Modifying Existing Models for Specific Runs}{12}{subsubsection.3.1.1}} +\@writefile{lof}{\contentsline {figure}{\numberline {4}{\ignorespaces Control System (CS) for the Westinghouse 4 Loop model\relax }}{13}{figure.caption.5}} \newlabel{Control System}{{4}{13}{Control System (CS) for the Westinghouse 4 Loop model\relax }{figure.caption.5}{}} -\@writefile{toc}{\contentsline {subsection}{\numberline {3.2}Configuring Existing Models into Integrated Energy Systems}{13}{subsection.3.2}\protected@file@percent } -\@writefile{lof}{\contentsline {figure}{\numberline {5}{\ignorespaces Creating a duplicate class for model runs.\relax }}{14}{figure.caption.6}\protected@file@percent } +\@writefile{toc}{\contentsline {subsection}{\numberline {3.2}Configuring Existing Models into Integrated Energy Systems}{13}{subsection.3.2}} +\@writefile{lof}{\contentsline {figure}{\numberline {5}{\ignorespaces Creating a duplicate class for model runs.\relax }}{14}{figure.caption.6}} \newlabel{Duplicate Class}{{5}{14}{Creating a duplicate class for model runs.\relax }{figure.caption.6}{}} -\@writefile{lof}{\contentsline {figure}{\numberline {6}{\ignorespaces Initial Integrated Energy System Starting Point\relax }}{15}{figure.caption.7}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {6}{\ignorespaces Initial Integrated Energy System Starting Point\relax }}{15}{figure.caption.7}} \newlabel{modular park}{{6}{15}{Initial Integrated Energy System Starting Point\relax }{figure.caption.7}{}} -\@writefile{lof}{\contentsline {figure}{\numberline {7}{\ignorespaces Rearrangement of Initial Energy System\relax }}{15}{figure.caption.8}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {7}{\ignorespaces Rearrangement of Initial Energy System\relax }}{15}{figure.caption.8}} \newlabel{coupling park}{{7}{15}{Rearrangement of Initial Energy System\relax }{figure.caption.8}{}} -\@writefile{lof}{\contentsline {figure}{\numberline {8}{\ignorespaces Creation of NuScale Energy System\relax }}{16}{figure.caption.9}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {8}{\ignorespaces Creation of NuScale Energy System\relax }}{16}{figure.caption.9}} \newlabel{NuScale park}{{8}{16}{Creation of NuScale Energy System\relax }{figure.caption.9}{}} -\@writefile{toc}{\contentsline {subsection}{\numberline {3.3}Test Creation}{16}{subsection.3.3}\protected@file@percent } -\@writefile{lof}{\contentsline {figure}{\numberline {9}{\ignorespaces Primary System Controller Settings\relax }}{17}{figure.caption.10}\protected@file@percent } +\@writefile{toc}{\contentsline {subsection}{\numberline {3.3}Test Creation}{16}{subsection.3.3}} +\@writefile{lof}{\contentsline {figure}{\numberline {9}{\ignorespaces Primary System Controller Settings\relax }}{17}{figure.caption.10}} \newlabel{primary controller settings}{{9}{17}{Primary System Controller Settings\relax }{figure.caption.10}{}} -\@writefile{lof}{\contentsline {figure}{\numberline {10}{\ignorespaces Turbine Control Settings\relax }}{18}{figure.caption.11}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {10}{\ignorespaces Turbine Control Settings\relax }}{18}{figure.caption.11}} \newlabel{Turbine Control Settings}{{10}{18}{Turbine Control Settings\relax }{figure.caption.11}{}} -\@writefile{lof}{\contentsline {figure}{\numberline {11}{\ignorespaces Port a Boundary Values of the Energy Manifold\relax }}{19}{figure.caption.12}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {11}{\ignorespaces Port a Boundary Values of the Energy Manifold\relax }}{19}{figure.caption.12}} \newlabel{Port a Nominal Values}{{11}{19}{Port a Boundary Values of the Energy Manifold\relax }{figure.caption.12}{}} -\@writefile{lof}{\contentsline {figure}{\numberline {12}{\ignorespaces Port b Nominal Values of the Energy Manifold \relax }}{20}{figure.caption.13}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {12}{\ignorespaces Port b Nominal Values of the Energy Manifold \relax }}{20}{figure.caption.13}} \newlabel{port B Nominal Values}{{12}{20}{Port b Nominal Values of the Energy Manifold \relax }{figure.caption.13}{}} -\@writefile{lof}{\contentsline {figure}{\numberline {13}{\ignorespaces Settings to Create a proper mat file for a gold folder test\relax }}{21}{figure.caption.14}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {13}{\ignorespaces Settings to Create a proper mat file for a gold folder test\relax }}{21}{figure.caption.14}} \newlabel{mat file settings}{{13}{21}{Settings to Create a proper mat file for a gold folder test\relax }{figure.caption.14}{}} -\@writefile{lof}{\contentsline {figure}{\numberline {14}{\ignorespaces Simulation Setup\relax }}{22}{figure.caption.15}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {14}{\ignorespaces Simulation Setup\relax }}{22}{figure.caption.15}} \newlabel{Interval Setup}{{14}{22}{Simulation Setup\relax }{figure.caption.15}{}} -\@writefile{toc}{\contentsline {subsection}{\numberline {3.4}Advanced Test File Options utilized for complex models}{22}{subsection.3.4}\protected@file@percent } -\@writefile{lof}{\contentsline {figure}{\numberline {15}{\ignorespaces Import Initial conditions from a previously run simulation\relax }}{23}{figure.caption.16}\protected@file@percent } +\@writefile{toc}{\contentsline {subsection}{\numberline {3.4}Advanced Test File Options utilized for complex models}{22}{subsection.3.4}} +\@writefile{lof}{\contentsline {figure}{\numberline {15}{\ignorespaces Import Initial conditions from a previously run simulation\relax }}{23}{figure.caption.16}} \newlabel{import Initial}{{15}{23}{Import Initial conditions from a previously run simulation\relax }{figure.caption.16}{}} -\@writefile{lof}{\contentsline {figure}{\numberline {16}{\ignorespaces Realign the Simulation Time\relax }}{24}{figure.caption.17}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {16}{\ignorespaces Realign the Simulation Time\relax }}{24}{figure.caption.17}} \newlabel{Simulation Time Realignment}{{16}{24}{Realign the Simulation Time\relax }{figure.caption.17}{}} \citation{Westinghouse} -\@writefile{toc}{\contentsline {section}{\numberline {4}Model Description}{25}{section.4}\protected@file@percent } -\@writefile{toc}{\contentsline {subsection}{\numberline {4.1}Primary Heat System}{25}{subsection.4.1}\protected@file@percent } -\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.1}Four Loop Pressurized Water Reactor}{25}{subsubsection.4.1.1}\protected@file@percent } -\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.2}Generic Modular PWR}{25}{subsubsection.4.1.2}\protected@file@percent } -\@writefile{lof}{\contentsline {figure}{\numberline {17}{\ignorespaces Top View of the Four-Loop PWR Plant\relax }}{26}{figure.caption.18}\protected@file@percent } +\@writefile{toc}{\contentsline {section}{\numberline {4}Model Description}{25}{section.4}} +\@writefile{toc}{\contentsline {subsection}{\numberline {4.1}Primary Heat System}{25}{subsection.4.1}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.1}Four Loop Pressurized Water Reactor}{25}{subsubsection.4.1.1}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.2}Generic Modular PWR}{25}{subsubsection.4.1.2}} +\@writefile{lof}{\contentsline {figure}{\numberline {17}{\ignorespaces Top View of the Four-Loop PWR Plant\relax }}{26}{figure.caption.18}} \newlabel{Top View Westinghouse}{{17}{26}{Top View of the Four-Loop PWR Plant\relax }{figure.caption.18}{}} -\@writefile{lof}{\contentsline {figure}{\numberline {18}{\ignorespaces Top Level Depiction of the Generic Modular PWR in the NHES package.\relax }}{26}{figure.caption.19}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {18}{\ignorespaces Top Level Depiction of the Generic Modular PWR in the NHES package.\relax }}{26}{figure.caption.19}} \newlabel{Top View Generic Modular}{{18}{26}{Top Level Depiction of the Generic Modular PWR in the NHES package.\relax }{figure.caption.19}{}} -\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.3}Natural Circulation Small Modular Reactor}{26}{subsubsection.4.1.3}\protected@file@percent } +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.3}Natural Circulation Small Modular Reactor}{26}{subsubsection.4.1.3}} \citation{2019NuScaleM4} -\@writefile{lof}{\contentsline {figure}{\numberline {19}{\ignorespaces Top Level Depiction of the SMR System in the NHES package.\relax }}{27}{figure.caption.20}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {19}{\ignorespaces Top Level Depiction of the SMR System in the NHES package.\relax }}{27}{figure.caption.20}} \newlabel{Top View NuScale Reactor}{{19}{27}{Top Level Depiction of the SMR System in the NHES package.\relax }{figure.caption.20}{}} -\@writefile{toc}{\contentsline {subsection}{\numberline {4.2}Energy Manifold}{27}{subsection.4.2}\protected@file@percent } +\@writefile{toc}{\contentsline {subsection}{\numberline {4.2}Energy Manifold}{27}{subsection.4.2}} \citation{Udagawa} \citation{JimObrien} -\@writefile{lof}{\contentsline {figure}{\numberline {20}{\ignorespaces : Top Level Depiction of the Energy Manifold in the NHES package\relax }}{28}{figure.caption.21}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {20}{\ignorespaces : Top Level Depiction of the Energy Manifold in the NHES package\relax }}{28}{figure.caption.21}} \newlabel{Top View Energy Manifold}{{20}{28}{: Top Level Depiction of the Energy Manifold in the NHES package\relax }{figure.caption.21}{}} -\@writefile{toc}{\contentsline {subsection}{\numberline {4.3}Industrial Process}{28}{subsection.4.3}\protected@file@percent } -\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.3.1}Hydrogen Production}{28}{subsubsection.4.3.1}\protected@file@percent } +\@writefile{toc}{\contentsline {subsection}{\numberline {4.3}Industrial Process}{28}{subsection.4.3}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.3.1}Hydrogen Production}{28}{subsubsection.4.3.1}} \citation{2016HTSE} \citation{2017HTSE} \citation{JongHydrogen} \citation{JongDesalination} -\@writefile{lof}{\contentsline {figure}{\numberline {21}{\ignorespaces Top Level Depiction of the High Temperature Steam Electrolysis Unit in the NHES package\relax }}{29}{figure.caption.22}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {21}{\ignorespaces Top Level Depiction of the High Temperature Steam Electrolysis Unit in the NHES package\relax }}{29}{figure.caption.22}} \newlabel{Top View HTSE}{{21}{29}{Top Level Depiction of the High Temperature Steam Electrolysis Unit in the NHES package\relax }{figure.caption.22}{}} \citation{2018ThermalStorage} \citation{JongDesalination} -\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.3.2}Desalination}{30}{subsubsection.4.3.2}\protected@file@percent } -\@writefile{lof}{\contentsline {figure}{\numberline {22}{\ignorespaces Top Level Depiction of the Brackish Water Desalination Process in the NHES package\relax }}{30}{figure.caption.23}\protected@file@percent } +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.3.2}Desalination}{30}{subsubsection.4.3.2}} +\@writefile{lof}{\contentsline {figure}{\numberline {22}{\ignorespaces Top Level Depiction of the Brackish Water Desalination Process in the NHES package\relax }}{30}{figure.caption.23}} \newlabel{Top View Reverse Osmosis}{{22}{30}{Top Level Depiction of the Brackish Water Desalination Process in the NHES package\relax }{figure.caption.23}{}} -\@writefile{toc}{\contentsline {subsection}{\numberline {4.4}Balance of Plant}{30}{subsection.4.4}\protected@file@percent } -\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.4.1}Simple Balance of Plant}{31}{subsubsection.4.4.1}\protected@file@percent } -\@writefile{lof}{\contentsline {figure}{\numberline {23}{\ignorespaces Top Level Depiction of the Balance of Plant in the NHES package\relax }}{31}{figure.caption.24}\protected@file@percent } +\@writefile{toc}{\contentsline {subsection}{\numberline {4.4}Balance of Plant}{30}{subsection.4.4}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.4.1}Simple Balance of Plant}{31}{subsubsection.4.4.1}} +\@writefile{lof}{\contentsline {figure}{\numberline {23}{\ignorespaces Top Level Depiction of the Balance of Plant in the NHES package\relax }}{31}{figure.caption.24}} \newlabel{Top View SimpleBOP}{{23}{31}{Top Level Depiction of the Balance of Plant in the NHES package\relax }{figure.caption.24}{}} -\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.4.2}Step Down Turbines}{31}{subsubsection.4.4.2}\protected@file@percent } -\@writefile{toc}{\contentsline {subsection}{\numberline {4.5}Energy Storage}{31}{subsection.4.5}\protected@file@percent } +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.4.2}Step Down Turbines}{31}{subsubsection.4.4.2}} +\@writefile{toc}{\contentsline {subsection}{\numberline {4.5}Energy Storage}{31}{subsection.4.5}} \citation{2018ThermalStorage} \citation{FrickThermalStorage} -\@writefile{lof}{\contentsline {figure}{\numberline {24}{\ignorespaces Top Level Depiction of the StepDown Turbines in the NHES package\relax }}{32}{figure.caption.25}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {24}{\ignorespaces Top Level Depiction of the StepDown Turbines in the NHES package\relax }}{32}{figure.caption.25}} \newlabel{Top View Step Down Turbines}{{24}{32}{Top Level Depiction of the StepDown Turbines in the NHES package\relax }{figure.caption.25}{}} -\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.5.1}Electric Battery Storage}{32}{subsubsection.4.5.1}\protected@file@percent } -\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.5.2}Two-Tank Thermal Energy Storage}{32}{subsubsection.4.5.2}\protected@file@percent } -\@writefile{lof}{\contentsline {figure}{\numberline {25}{\ignorespaces Top Level Depiction of the Logical Battery in the NHES package\relax }}{33}{figure.caption.26}\protected@file@percent } +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.5.1}Electric Battery Storage}{32}{subsubsection.4.5.1}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.5.2}Two-Tank Thermal Energy Storage}{32}{subsubsection.4.5.2}} +\@writefile{lof}{\contentsline {figure}{\numberline {25}{\ignorespaces Top Level Depiction of the Logical Battery in the NHES package\relax }}{33}{figure.caption.26}} \newlabel{Top View Logical Battery}{{25}{33}{Top Level Depiction of the Logical Battery in the NHES package\relax }{figure.caption.26}{}} \citation{Schumann} \citation{specialHeattransfer} -\@writefile{lof}{\contentsline {figure}{\numberline {26}{\ignorespaces Top Level Depiction of the Two-Tank Sensible Heat Storage Unit in the NHES package\relax }}{34}{figure.caption.27}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {26}{\ignorespaces Top Level Depiction of the Two-Tank Sensible Heat Storage Unit in the NHES package\relax }}{34}{figure.caption.27}} \newlabel{Top View Two Tank Sensible Storage}{{26}{34}{Top Level Depiction of the Two-Tank Sensible Heat Storage Unit in the NHES package\relax }{figure.caption.27}{}} -\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.5.3}Thermocline Packed Bed Thermal Energy Storage}{34}{subsubsection.4.5.3}\protected@file@percent } +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.5.3}Thermocline Packed Bed Thermal Energy Storage}{34}{subsubsection.4.5.3}} \citation{GasTurbine2008} \citation{GasTurbine2013} \citation{2016HTSE} -\@writefile{lof}{\contentsline {figure}{\numberline {27}{\ignorespaces Top Level Depiction of the Single Tank Packed Bed Heat Storage Unit in the NHES package\relax }}{35}{figure.caption.28}\protected@file@percent } +\@writefile{lof}{\contentsline {figure}{\numberline {27}{\ignorespaces Top Level Depiction of the Single Tank Packed Bed Heat Storage Unit in the NHES package\relax }}{35}{figure.caption.28}} \newlabel{Top View Thermocline}{{27}{35}{Top Level Depiction of the Single Tank Packed Bed Heat Storage Unit in the NHES package\relax }{figure.caption.28}{}} -\@writefile{toc}{\contentsline {subsection}{\numberline {4.6}Secondary Energy Source}{35}{subsection.4.6}\protected@file@percent } -\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.6.1}Natural Gas Fired Turbine}{35}{subsubsection.4.6.1}\protected@file@percent } -\@writefile{lof}{\contentsline {figure}{\numberline {28}{\ignorespaces Top Level Depiction of the Natural Gas Fired Turbine in the NHES package\relax }}{36}{figure.caption.29}\protected@file@percent } +\@writefile{toc}{\contentsline {subsection}{\numberline {4.6}Secondary Energy Source}{35}{subsection.4.6}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.6.1}Natural Gas Fired Turbine}{35}{subsubsection.4.6.1}} +\@writefile{lof}{\contentsline {figure}{\numberline {28}{\ignorespaces Top Level Depiction of the Natural Gas Fired Turbine in the NHES package\relax }}{36}{figure.caption.29}} \newlabel{Top View Gas Turbine}{{28}{36}{Top Level Depiction of the Natural Gas Fired Turbine in the NHES package\relax }{figure.caption.29}{}} -\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.6.2}Hydrogen Turbine}{36}{subsubsection.4.6.2}\protected@file@percent } -\@writefile{lof}{\contentsline {figure}{\numberline {29}{\ignorespaces Top Level Depiction of the Hydrogen Turbine in the NHES package\relax }}{37}{figure.caption.30}\protected@file@percent } +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.6.2}Hydrogen Turbine}{36}{subsubsection.4.6.2}} +\@writefile{lof}{\contentsline {figure}{\numberline {29}{\ignorespaces Top Level Depiction of the Hydrogen Turbine in the NHES package\relax }}{37}{figure.caption.30}} \newlabel{Top View Hydrogen Turbine}{{29}{37}{Top Level Depiction of the Hydrogen Turbine in the NHES package\relax }{figure.caption.30}{}} \bibstyle{ieeetr} \bibdata{References} @@ -153,7 +153,7 @@ \bibcite{JongDesalination}{12} \bibcite{FrickThermalStorage}{13} \bibcite{Schumann}{14} -\@writefile{toc}{\contentsline {section}{References}{39}{section*.31}\protected@file@percent } +\@writefile{toc}{\contentsline {section}{References}{39}{section*.31}} \bibcite{specialHeattransfer}{15} \bibcite{GasTurbine2008}{16} \bibcite{GasTurbine2013}{17} diff --git a/doc/user_manual/hybrid_user_manual.blg b/doc/user_manual/hybrid_user_manual.blg index f02e7668..9a73fb20 100644 --- a/doc/user_manual/hybrid_user_manual.blg +++ b/doc/user_manual/hybrid_user_manual.blg @@ -1,9 +1,7 @@ -This is BibTeX, Version 0.99d -Capacity: max_strings=200000, hash_size=200000, hash_prime=170003 +This is BibTeX, Version 0.99d (TeX Live 2016) +Capacity: max_strings=35307, hash_size=35307, hash_prime=30011 The top-level auxiliary file: hybrid_user_manual.aux -Reallocating 'name_of_file' (item size: 1) to 7 items. The style file: ieeetr.bst -Reallocating 'name_of_file' (item size: 1) to 11 items. Database file #1: References.bib Warning--empty journal in TRANSFORM You've used 17 entries, diff --git a/doc/user_manual/hybrid_user_manual.pdf b/doc/user_manual/hybrid_user_manual.pdf index 30c54315..df467892 100644 Binary files a/doc/user_manual/hybrid_user_manual.pdf and b/doc/user_manual/hybrid_user_manual.pdf differ diff --git a/doc/user_manual/hybrid_user_manual.synctex.gz b/doc/user_manual/hybrid_user_manual.synctex.gz deleted file mode 100644 index 2a2b5a3b..00000000 Binary files a/doc/user_manual/hybrid_user_manual.synctex.gz and /dev/null differ diff --git a/doc/user_manual/hybrid_user_manual.toc b/doc/user_manual/hybrid_user_manual.toc index d4a41369..5d31f641 100644 --- a/doc/user_manual/hybrid_user_manual.toc +++ b/doc/user_manual/hybrid_user_manual.toc @@ -1,37 +1,37 @@ -\contentsline {section}{\numberline {1}Introduction}{1}{section.1}% -\contentsline {subsection}{\numberline {1.1}Modelica Models}{1}{subsection.1.1}% -\contentsline {subsection}{\numberline {1.2}Individual Components}{1}{subsection.1.2}% -\contentsline {subsection}{\numberline {1.3}Hybrid Requirements}{2}{subsection.1.3}% -\contentsline {section}{\numberline {2}HYBRID Installation Procedure}{3}{section.2}% -\contentsline {subsection}{\numberline {2.1}Overview}{3}{subsection.2.1}% -\contentsline {subsection}{\numberline {2.2}Cloning the Hybrid Repository}{3}{subsection.2.2}% -\contentsline {subsubsection}{\numberline {2.2.1}Install RAVEN and its plugins as a sub-module}{4}{subsubsection.2.2.1}% -\contentsline {subsubsection}{\numberline {2.2.2}Inform the Framework Paths}{4}{subsubsection.2.2.2}% -\contentsline {subsection}{\numberline {2.3}Setup of Dymola for the Regression Testing System}{5}{subsection.2.3}% -\contentsline {subsection}{\numberline {2.4}Run Regression tests related to the HYBRID project}{5}{subsection.2.4}% -\contentsline {section}{\numberline {3}Running and Creating New Code}{8}{section.3}% -\contentsline {subsection}{\numberline {3.1}Understanding and Running Existing Models}{8}{subsection.3.1}% -\contentsline {subsubsection}{\numberline {3.1.1}Modifying Existing Models for Specific Runs}{12}{subsubsection.3.1.1}% -\contentsline {subsection}{\numberline {3.2}Configuring Existing Models into Integrated Energy Systems}{13}{subsection.3.2}% -\contentsline {subsection}{\numberline {3.3}Test Creation}{16}{subsection.3.3}% -\contentsline {subsection}{\numberline {3.4}Advanced Test File Options utilized for complex models}{22}{subsection.3.4}% -\contentsline {section}{\numberline {4}Model Description}{25}{section.4}% -\contentsline {subsection}{\numberline {4.1}Primary Heat System}{25}{subsection.4.1}% -\contentsline {subsubsection}{\numberline {4.1.1}Four Loop Pressurized Water Reactor}{25}{subsubsection.4.1.1}% -\contentsline {subsubsection}{\numberline {4.1.2}Generic Modular PWR}{25}{subsubsection.4.1.2}% -\contentsline {subsubsection}{\numberline {4.1.3}Natural Circulation Small Modular Reactor}{26}{subsubsection.4.1.3}% -\contentsline {subsection}{\numberline {4.2}Energy Manifold}{27}{subsection.4.2}% -\contentsline {subsection}{\numberline {4.3}Industrial Process}{28}{subsection.4.3}% -\contentsline {subsubsection}{\numberline {4.3.1}Hydrogen Production}{28}{subsubsection.4.3.1}% -\contentsline {subsubsection}{\numberline {4.3.2}Desalination}{30}{subsubsection.4.3.2}% -\contentsline {subsection}{\numberline {4.4}Balance of Plant}{30}{subsection.4.4}% -\contentsline {subsubsection}{\numberline {4.4.1}Simple Balance of Plant}{31}{subsubsection.4.4.1}% -\contentsline {subsubsection}{\numberline {4.4.2}Step Down Turbines}{31}{subsubsection.4.4.2}% -\contentsline {subsection}{\numberline {4.5}Energy Storage}{31}{subsection.4.5}% -\contentsline {subsubsection}{\numberline {4.5.1}Electric Battery Storage}{32}{subsubsection.4.5.1}% -\contentsline {subsubsection}{\numberline {4.5.2}Two-Tank Thermal Energy Storage}{32}{subsubsection.4.5.2}% -\contentsline {subsubsection}{\numberline {4.5.3}Thermocline Packed Bed Thermal Energy Storage}{34}{subsubsection.4.5.3}% -\contentsline {subsection}{\numberline {4.6}Secondary Energy Source}{35}{subsection.4.6}% -\contentsline {subsubsection}{\numberline {4.6.1}Natural Gas Fired Turbine}{35}{subsubsection.4.6.1}% -\contentsline {subsubsection}{\numberline {4.6.2}Hydrogen Turbine}{36}{subsubsection.4.6.2}% -\contentsline {section}{References}{39}{section*.31}% +\contentsline {section}{\numberline {1}Introduction}{1}{section.1} +\contentsline {subsection}{\numberline {1.1}Modelica Models}{1}{subsection.1.1} +\contentsline {subsection}{\numberline {1.2}Individual Components}{1}{subsection.1.2} +\contentsline {subsection}{\numberline {1.3}Hybrid Requirements}{2}{subsection.1.3} +\contentsline {section}{\numberline {2}HYBRID Installation Procedure}{3}{section.2} +\contentsline {subsection}{\numberline {2.1}Overview}{3}{subsection.2.1} +\contentsline {subsection}{\numberline {2.2}Cloning the Hybrid Repository}{3}{subsection.2.2} +\contentsline {subsubsection}{\numberline {2.2.1}Install RAVEN and its plugins as a sub-module}{4}{subsubsection.2.2.1} +\contentsline {subsubsection}{\numberline {2.2.2}Inform the Framework Paths}{4}{subsubsection.2.2.2} +\contentsline {subsection}{\numberline {2.3}Setup of Dymola for the Regression Testing System}{5}{subsection.2.3} +\contentsline {subsection}{\numberline {2.4}Run Regression tests related to the HYBRID project}{5}{subsection.2.4} +\contentsline {section}{\numberline {3}Running and Creating New Code}{8}{section.3} +\contentsline {subsection}{\numberline {3.1}Understanding and Running Existing Models}{8}{subsection.3.1} +\contentsline {subsubsection}{\numberline {3.1.1}Modifying Existing Models for Specific Runs}{12}{subsubsection.3.1.1} +\contentsline {subsection}{\numberline {3.2}Configuring Existing Models into Integrated Energy Systems}{13}{subsection.3.2} +\contentsline {subsection}{\numberline {3.3}Test Creation}{16}{subsection.3.3} +\contentsline {subsection}{\numberline {3.4}Advanced Test File Options utilized for complex models}{22}{subsection.3.4} +\contentsline {section}{\numberline {4}Model Description}{25}{section.4} +\contentsline {subsection}{\numberline {4.1}Primary Heat System}{25}{subsection.4.1} +\contentsline {subsubsection}{\numberline {4.1.1}Four Loop Pressurized Water Reactor}{25}{subsubsection.4.1.1} +\contentsline {subsubsection}{\numberline {4.1.2}Generic Modular PWR}{25}{subsubsection.4.1.2} +\contentsline {subsubsection}{\numberline {4.1.3}Natural Circulation Small Modular Reactor}{26}{subsubsection.4.1.3} +\contentsline {subsection}{\numberline {4.2}Energy Manifold}{27}{subsection.4.2} +\contentsline {subsection}{\numberline {4.3}Industrial Process}{28}{subsection.4.3} +\contentsline {subsubsection}{\numberline {4.3.1}Hydrogen Production}{28}{subsubsection.4.3.1} +\contentsline {subsubsection}{\numberline {4.3.2}Desalination}{30}{subsubsection.4.3.2} +\contentsline {subsection}{\numberline {4.4}Balance of Plant}{30}{subsection.4.4} +\contentsline {subsubsection}{\numberline {4.4.1}Simple Balance of Plant}{31}{subsubsection.4.4.1} +\contentsline {subsubsection}{\numberline {4.4.2}Step Down Turbines}{31}{subsubsection.4.4.2} +\contentsline {subsection}{\numberline {4.5}Energy Storage}{31}{subsection.4.5} +\contentsline {subsubsection}{\numberline {4.5.1}Electric Battery Storage}{32}{subsubsection.4.5.1} +\contentsline {subsubsection}{\numberline {4.5.2}Two-Tank Thermal Energy Storage}{32}{subsubsection.4.5.2} +\contentsline {subsubsection}{\numberline {4.5.3}Thermocline Packed Bed Thermal Energy Storage}{34}{subsubsection.4.5.3} +\contentsline {subsection}{\numberline {4.6}Secondary Energy Source}{35}{subsection.4.6} +\contentsline {subsubsection}{\numberline {4.6.1}Natural Gas Fired Turbine}{35}{subsubsection.4.6.1} +\contentsline {subsubsection}{\numberline {4.6.2}Hydrogen Turbine}{36}{subsubsection.4.6.2} +\contentsline {section}{References}{39}{section*.31} diff --git a/doc/version.tex b/doc/version.tex index c00d438f..5a8c4fde 100644 --- a/doc/version.tex +++ b/doc/version.tex @@ -1 +1 @@ -cb7e68b7e1757a4b957e18af7a6bdaa613d514b3 klfrick2 Mon, 15 Feb 2021 09:01:17 -0700 +09a34b32ae7a18d79261047cb9da2e7e7d35523a alfoa Mon, 15 Mar 2021 14:09:50 -0600