Skip to content

Commit 3cded00

Browse files
authored
Merge pull request #11279 from NREL/cleanup-spellings
Doc, Error Message, and Comment String Spelling Corrections
2 parents 4f5c971 + 3f5362d commit 3cded00

File tree

288 files changed

+819
-814
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

288 files changed

+819
-814
lines changed

doc/engineering-reference/src/simulation-models-encyclopedic-reference-004/solar-collectors.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -979,7 +979,7 @@ \subsubsection{Heat Exchanger}\label{heat-exchanger}
979979

980980
where \({T_{{\rm{a,HX}}}}\) is determined using correlations described above.~ When the UTSC is active, the air mass flow is determined from the operation of the outdoor air mixer component.~ When the UTSC is off, this term is zero.
981981

982-
\subsubsection{Plenum LW Radation}\label{plenum-lw-radation}
982+
\subsubsection{Plenum LW Radiation}\label{plenum-lw-radation}
983983

984984
\({q''_{LWR,plen}}\) is a standard radiation exchange formulation between the collector surface and the underlying heat transfer surface located across the plenum.~ Radiation is modeled using linearized coefficients.
985985

doc/header.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@
132132

133133
% The current implementation of \degree doesn't use ensuremath and doesn't show
134134
% see https://github.com/josephwright/siunitx/issues/351
135-
% But requried mathspec with options 'math' above fixes it
135+
% But required mathspec with options 'math' above fixes it
136136
%\DeclareSIUnit[number-unit-product = \,]
137137
%\degree{ \ensuremath { { } ^ { \circ } } }
138138

doc/input-output-reference/src/hvac-template-objects/hvactemplate-processing.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ \section{HVACTemplate Processing}\label{hvactemplate-processing}
1111
\item
1212
The EnergyPlus simulation proceeds using the expidf file as the input stream.
1313
\item
14-
If there are error messages from EnergyPlus, they will refer to the contents of the expidf file. Specific objects referred to in error messages may exist in the original idf, but they may be objects created by ExpandObjects and only exist in the expidf. Remember that the expidf will be overwritten everytime the original idf is run using EP-Launch or RunEPlus.bat.
14+
If there are error messages from EnergyPlus, they will refer to the contents of the expidf file. Specific objects referred to in error messages may exist in the original idf, but they may be objects created by ExpandObjects and only exist in the expidf. Remember that the expidf will be overwritten every time the original idf is run using EP-Launch or RunEPlus.bat.
1515
\end{enumerate}
1616

1717
If you are trying to go beyond the capabilities of the HVACTemplate objects, one strategy you can use is to start your specification using the HVACTemplate objects, run EnergyPlus using EP-Launch and producing an expidf file, rename that file and start making modifications. This approach may help with getting all of the objects needed and the node names set consistently.

doc/input-output-reference/src/overview/group-electric-load-center-generator.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3649,7 +3649,7 @@ \subsubsection{Field: Heat Recovery Water Inlet Node Name}\label{field-heat-reco
36493649

36503650
This field contains the node name for the water inlet to the stack cooler.
36513651

3652-
\subsubsection{Field: Heat Recovery Water Outlet Node Nane}\label{field-heat-recovery-water-outlet-node-nane}
3652+
\subsubsection{Field: Heat Recovery Water Outlet Node Name}\label{field-heat-recovery-water-outlet-node-nane}
36533653

36543654
This field contains the node name for the water outlet from the stack cooler.
36553655

doc/input-output-reference/src/overview/group-surface-construction-elements.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3483,7 +3483,7 @@ \subsubsection{Inputs}\label{inputs-31-001}
34833483
The following entries are used only if Gas Type = Custom. The A, B and C coefficients are those in the following expression that gives a property value as a function of temperature in degrees K:
34843484

34853485
\begin{equation}
3486-
Property = Coef{f_A} + Coef{f_B} \times Temperatur{e_K} + Coef{f_C} \times Temperature_K^2
3486+
Property = Coef{f_A} + Coef{f_B} \times Temperature{e_K} + Coef{f_C} \times Temperature_K^2
34873487
\end{equation}
34883488

34893489
\paragraph{Field: Conductivity Coefficient A}\label{field-conductivity-coefficient-a-1}

doc/input-output-reference/src/weather-data/weather-data-hourly-interpolation.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ \section{Weather Data Hourly Interpolation}\label{weather-data-hourly-interpolat
1111
The weighting scheme / interpolation is simply:
1212

1313
\begin{equation}
14-
Valu{e_{TimeStep}} = LastHourValue\cdot Weigh{t_{LastHour}} + ThisHourValue\cdot Weigh{t_{ThisHour}}
14+
Value{e_{TimeStep}} = LastHourValue\cdot Weigh{t_{LastHour}} + ThisHourValue\cdot Weigh{t_{ThisHour}}
1515
\end{equation}
1616

1717
where

doc/module-developer/src/appendix-b-submissions-and-check-ins.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ \chapter{Appendix B.~ Submissions and Check-ins}\label{appendix-b.-submissions-a
3030

3131
Shall follow the guidelines shown in this document
3232

33-
All items shall be directly initialized (exception: derived type elements may be staticly initialized)
33+
All items shall be directly initialized (exception: derived type elements may be statically initialized)
3434

3535
There shall be no ``unused'' variables.~ If you put in a variable that you ``might use later'' -- comment it out and comment it to be used later.
3636

@@ -100,7 +100,7 @@ \chapter{Appendix B.~ Submissions and Check-ins}\label{appendix-b.-submissions-a
100100

101101
ü~\textbf{FeatureChanges.csv}
102102

103-
Every change to source code, example files, datsets, utilities (any change other than documentation) must include a line in the ``featurechanges.csv'' file.
103+
Every change to source code, example files, datasets, utilities (any change other than documentation) must include a line in the ``featurechanges.csv'' file.
104104

105105
ü~\textbf{Checked in?}
106106

doc/module-developer/src/energyplus-services/internal-zone-gains-services.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
\section{Internal Zone Gains Services}\label{internal-zone-gains-services}
22

3-
Services are available to help with modeling internal gains.~ Internal gains include the usual sources such as people, lights, plug loads, etc., but in EnergyPlus there can also be zone gains from the skin losses from certain equipment such as thermal tanks, electric load center equipment and refrigeration case credits.~ Developers adding new device models, or adding skin loss modeling to exisiting device models, need to use a call to SetupZoneInternalGains.~ This call is defined in DataInterfaces.f90 and contains a number of optional arguments depending on the type of internal gains involved.~ The types of gains that can be added with this call include convection, radiation, and latent gains to the zone, convection and latent gains to the return air, carbon dioxide gains to the zone and generic air contaminant gains to the zone.~ For example, the call to register gains for the People object includes convection(sensible), thermal radiation, latent, and CO2 and is:
3+
Services are available to help with modeling internal gains.~ Internal gains include the usual sources such as people, lights, plug loads, etc., but in EnergyPlus there can also be zone gains from the skin losses from certain equipment such as thermal tanks, electric load center equipment and refrigeration case credits.~ Developers adding new device models, or adding skin loss modeling to existing device models, need to use a call to SetupZoneInternalGains.~ This call is defined in DataInterfaces.f90 and contains a number of optional arguments depending on the type of internal gains involved.~ The types of gains that can be added with this call include convection, radiation, and latent gains to the zone, convection and latent gains to the return air, carbon dioxide gains to the zone and generic air contaminant gains to the zone.~ For example, the call to register gains for the People object includes convection(sensible), thermal radiation, latent, and CO2 and is:
44

55
\textbf{CALL} SetupZoneInternalGain(People(Loop)\%ZonePtr, \&
66

doc/module-developer/src/output.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ \chapter{Output}\label{output}
66

77
OutputFileInits is intended for ``one-time'' outputs.~ If the value is calculated or entered and should be echoed to output, this file is the place for it.~ The structure is similar to the IDD/IDF structure in that there is a ``definition'' line followed by the data being reported. Since the data may be produced in several places during the simulation, the actual file looks a bit hodge-podge but can be easily imported into a spreadsheet program and grouped.
88

9-
OutputFileStandard is the reporting variable output file from EnergyPlus.~ You can read more details from the \href{InterfaceDeveloper.pdf}{\emph{Guide for Interface Developers}} document and in the \href{InputOutputReference.pdf}{Input Output Reference} document.~ OutputFileMeters is a similar file to contain meter (only) output.~ Meter values also may appear in the OutputFileStandard file. Only values that change during the simulation should be output to these files.~ They are automaticallly included by the SetupOutputVariable calls.
9+
OutputFileStandard is the reporting variable output file from EnergyPlus.~ You can read more details from the \href{InterfaceDeveloper.pdf}{\emph{Guide for Interface Developers}} document and in the \href{InputOutputReference.pdf}{Input Output Reference} document.~ OutputFileMeters is a similar file to contain meter (only) output.~ Meter values also may appear in the OutputFileStandard file. Only values that change during the simulation should be output to these files.~ They are automatically included by the SetupOutputVariable calls.

doc/output-details-and-examples/src/example-input-files.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ \chapter{Example Input Files}\label{example-input-files}
66
\item
77
\textbf{ExampleFiles.xls} - lists all the files available -- whether through the install or through an external site.
88
\item
9-
\textbf{ExampleFiles-ObjectLink.xls} - illustrates the first 3 occurances in the example files of an object.
9+
\textbf{ExampleFiles-ObjectLink.xls} - illustrates the first 3 occurrences in the example files of an object.
1010
\end{itemize}
1111

1212
Following convention, each example file should have at the top a set of comments that tell what the purpose of the file is and the key features.

0 commit comments

Comments
 (0)