Merge pull request #3687 from henrikt-ma/cleanup/remaining-linebreaks

Change remaining files to sentence-based line breaks

Author: HansOlsson

chapters/annotations.tex

@@ -401,7 +401,9 @@ \subsubsection{Variable Replacements}\label{variable-replacements}
 This is similar to the \lstinline!Text! graphical primitive in \cref{text}.
 
 \begin{table}[H]
-\caption{Attributes that can use variable replacements.}
+\caption{
+  Attributes that can use variable replacements.
+}
 \label{attributes-with-variable-replacements}
 \begin{center}
 \begin{tabular}{l l}
@@ -930,10 +932,11 @@ \subsubsection{Graphical Properties}\label{graphical-properties}
   \begin{center}
     \includegraphics{bezierpoints}
   \end{center}
-  \caption{%
+  \caption{
     Line with \lstinline!smooth = Bezier!.
     The four line points $P_{1}$, \ldots{}, $P_{4}$ result in two quadratic splines and two straight line segments.
-  }\label{fig:smooth-bezier}
+  }
+  \label{fig:smooth-bezier}
 \end{figure}
 
 The \lstinline!smooth! attribute specifies that a line can be drawn as straight line segments (\lstinline!None!) or using a spline (\lstinline!Bezier!), where the line's points specify control points of a quadratic Bezier curve, see \cref{fig:smooth-bezier}.
@@ -1361,8 +1364,7 @@ \subsubsection{Mouse Input}\label{mouse-input}
 \end{lstlisting}
 
 \begin{example}
-A button can be represented by a rectangle changing color depending on a \lstinline!Boolean! variable \lstinline!on! and toggles the
-variable when the rectangle is clicked on:
+A button can be represented by a rectangle changing color depending on a \lstinline!Boolean! variable \lstinline!on! and toggles the variable when the rectangle is clicked on:
 \begin{lstlisting}[language=modelica]
 annotation(Icon(
   graphics = {
@@ -1732,8 +1734,7 @@ \subsection{Connector Sizing}\label{connector-sizing}\annotationindex{connectorS
 If \lstinline!connectorSizing = true!, the corresponding variable must be declared with the \lstinline!parameter! prefix, must be a subtype of a scalar \lstinline!Integer! and must have a literal default value of zero.
 
 \begin{nonnormative}
-The reason why \lstinline!connectorSizing! must be given a literal value is that if the value is an expression,
-the \lstinline!connectorSizing! functionality is conditional and this will then lead easily to wrong models.
+The reason why \lstinline!connectorSizing! must be given a literal value is that if the value is an expression, the \lstinline!connectorSizing! functionality is conditional and this will then lead easily to wrong models.
 
 The default value of the variable must be zero since this annotation is designed for a parameter that is used as vector dimension, and the dimension of the vector should be zero when the component is dragged or redeclared.
 Furthermore, when a tool does not support the \lstinline!connectorSizing! annotation, dragging will still result in a correct model.
@@ -1963,8 +1964,7 @@ \subsubsection{Conversion Rules}\label{conversion-rules}
 convertClass("Modelica.SIunits", "Modelica.Units.SI");
 convertClass("Modelica.SIunits.Icons", "Modelica.Units.Icons");
 \end{lstlisting}
-This ensures that for example \lstinline!Modelica.SIunits.Length! is converted to \lstinline!Modelica.Units.SI.Length!
-and \lstinline!Modelica.SIunits.Icons! is converted to \lstinline!Modelica.Units.Icons!.
+This ensures that for example \lstinline!Modelica.SIunits.Length! is converted to \lstinline!Modelica.Units.SI.Length! and \lstinline!Modelica.SIunits.Icons! is converted to \lstinline!Modelica.Units.Icons!.
 \end{example}
 
 \paragraph*{convertClassIf("OldClass", "oldElement", "whenValue", "NewClass")}\label{convertclassifoldclass-oldelement-whenvalue-newclass}\annotationindex{convertClassIf}
@@ -2205,8 +2205,7 @@ \subsection{Version Date and Build Information}\label{version-date-and-build-inf
 The meanings of these annotations are:
 \begin{itemize}
 \item
-  \lstinline!version! is the version number of the released library,
-  see \cref{version-handling}.
+  \lstinline!version! is the version number of the released library, see \cref{version-handling}.
 \item
   \lstinline!versionDate! is the date in UTC format (according to ISO 8601) when the library was released.
   This string is updated by the library author to correspond with the version number.

chapters/arrays.tex

@@ -642,8 +642,7 @@ \subsection{Variability of Structured Entities}\label{variability-of-structured-
 \section{Class Declarations}\label{class-declarations}
 
 Essentially everything in Modelica is a \firstuse{class}, from the predefined classes \lstinline!Integer! and \lstinline!Real!, to large packages such as the Modelica standard library.
-The description consists of a class definition, a modification environment that modifies the class definition, an optional list of dimension expressions if the class is an array class, and a lexically
-enclosing class for all classes.
+The description consists of a class definition, a modification environment that modifies the class definition, an optional list of dimension expressions if the class is an array class, and a lexically enclosing class for all classes.
 
 The object generated by a class is called an \firstuse{instance}.
 An instance contains zero or more components (i.e., instances), equations, algorithms, and local classes.

chapters/classes.tex

@@ -77,7 +77,9 @@ \subsection{Inside and Outside Connectors}\label{inside-and-outside-connectors}
   \begin{center}
     \includegraphics{innerouterconnector}
   \end{center}
-  \caption{Example for inside and outside connectors.}
+  \caption{
+    Example for inside and outside connectors.
+  }
 \end{figure}
 The figure visualizes the following \lstinline!connect!-equations to the connector \lstinline!c! in the models \lstinline!m!$i$.
 Consider the following \lstinline!connect!-equations found in the model for component \lstinline!m0!:
@@ -426,8 +428,7 @@ \section{Generation of Connection Equations}\label{generation-of-connection-equa
 
 The bold-face $\mathbf{0}$ represents an array or scalar zero of appropriate dimensions (i.e., the same size as $z$).
 
-For an \lstinline!operator record! type this uses the operator \lstinline!'0'! -- which must be defined in the operator record -- and all of the flow variables for the \lstinline!operator record!
-must be of the same \lstinline!operator record! type.
+For an \lstinline!operator record! type this uses the operator \lstinline!'0'! -- which must be defined in the operator record -- and all of the flow variables for the \lstinline!operator record! must be of the same \lstinline!operator record! type.
 This implies that in order to have flow variables of an \lstinline!operator record! type the \lstinline!operator record! must define addition, negation, and \lstinline!'0'!; and these operations should define an additive group.
 
 In order to generate equations for flow variables (using the \lstinline!flow!\indexinline{flow} prefix), the sign used for the connector variable $z_{i}$ above is +1 for inside connectors and -1 for outside connectors ($z_{3}$ in the example above).
@@ -974,8 +975,8 @@ \subsection{Examples}\label{examples-of-overconstrained-connectors}
   \begin{center}
     \includegraphics{overdetermined}
   \end{center}
-  \caption{%
-  Example of a virtual connection graph.
+  \caption{
+    Example of a virtual connection graph.
   }
 \end{figure}
 \end{example}

chapters/connectors.tex

@@ -39,7 +39,9 @@ \section{Mixing Enthalpy}\label{reasons-for-avoiding-the-actual-mixing-enthalpy-
   \begin{center}
     \includegraphics{fluidmix}
   \end{center}
-  \caption{Exemplary connection set with three connected components and a common mixing enthalpy.}
+  \caption{
+    Exemplary connection set with three connected components and a common mixing enthalpy.
+  }
 \end{figure}
 
 \section{Rationale for inStream}\label{rationale-for-the-formulation-of-the-instream-operator}\label{rationale-for-instream}
@@ -128,7 +130,9 @@ \section{Rationale for inStream}\label{rationale-for-the-formulation-of-the-inst
   \begin{center}
     \includegraphics{fluidmix3}
   \end{center}
-  \caption{Exemplary connection set with three connected components.}
+  \caption{
+    Exemplary connection set with three connected components.
+  }
 \end{figure}
 
 In the general case of a connection set with \emph{n} components, similar considerations lead to the following.
@@ -174,7 +178,9 @@ \subsection{Zero Mass Flow Rate -- Connection of 3 Stream Connectors}\label{conn
   \begin{center}
     \includegraphics{fluidmix4}
   \end{center}
-  \caption{Example series connection of multiple models with stream connectors.}
+  \caption{
+    Example series connection of multiple models with stream connectors.
+  }
 \end{figure}
 
 For the two components with finite mass flow rates (not the sensor), the properties discussed for two connected components still hold.

chapters/derivationofstream.tex

@@ -449,8 +449,7 @@ \subsection{reinit}\label{reinit}
 If there are multiple \lstinline!reinit! for a variable inside the same \lstinline!when!- or \lstinline!elsewhen!-clause, they must appear in different branches of an \lstinline!if!-equation (in order that at most one \lstinline!reinit! for the variable is active at any event).
 In case of \lstinline!reinit! active during initialization (due to \lstinline!when initial()!), see \cref{initialization-initial-equation-and-initial-algorithm}.
 
-\lstinline!reinit! does not break the single assignment rule, because \lstinline!reinit(x, expr)! in equations evaluates \lstinline!expr! to a value,
-then at the end of the current event iteration step it assigns this value to \lstinline!x! (this copying from values to reinitialized state(s) is done after all other evaluations of the model and before copying \lstinline!x! to \lstinline!pre(x)!).
+\lstinline!reinit! does not break the single assignment rule, because \lstinline!reinit(x, expr)! in equations evaluates \lstinline!expr! to a value, then at the end of the current event iteration step it assigns this value to \lstinline!x! (this copying from values to reinitialized state(s) is done after all other evaluations of the model and before copying \lstinline!x! to \lstinline!pre(x)!).
 
 \begin{example}
 If a higher index system is present, i.e., constraints between state variables, some state variables need to be redefined to non-state variables.
@@ -558,12 +557,10 @@ \section{Synchronous Data-Flow Principle and Single Assignment Rule}\label{synch
 Modelica is based on the synchronous data flow principle and the single assignment rule, which are defined in the following way:
 \begin{enumerate}
 \item Discrete-time variables keep their values until these variables are explicitly changed.
-Differentiated variables have \lstinline!der(x)! corresponding to the time-derivative of \lstinline!x!,
-and \lstinline!x! is continuous, except when \lstinline!reinit! is triggered, see \cref{reinit}.
+Differentiated variables have \lstinline!der(x)! corresponding to the time-derivative of \lstinline!x!, and \lstinline!x! is continuous, except when \lstinline!reinit! is triggered, see \cref{reinit}.
 Variable values can be accessed at any time instant during continuous integration and at event instants.
 
-\item At every time instant, during continuous integration and at event instants,
-the equations express relations between variables which have to be fulfilled concurrently.
+\item At every time instant, during continuous integration and at event instants, the equations express relations between variables which have to be fulfilled concurrently.
 
 \item Computation and communication at an event instant does not take time.
 \begin{nonnormative}
@@ -728,8 +725,7 @@ \section{Initialization, initial equation, and initial algorithm}\label{initiali
 \begin{nonnormative}
 If a \lstinline!when!-clause equation \lstinline!v = expr;! is not active during the initialization phase, the equation \lstinline!v = pre(v)! is added for initialization.
 This follows from the mapping rule of \lstinline!when!-clause equations.
-If the condition of the \lstinline!when!-clause contains \lstinline!initial()!,
-but not in one of the specific forms, the \lstinline!when!-clause is not active during initialization: \lstinline!when not initial() then print("simulation started"); end when;!
+If the condition of the \lstinline!when!-clause contains \lstinline!initial()!, but not in one of the specific forms, the \lstinline!when!-clause is not active during initialization: \lstinline!when not initial() then print("simulation started"); end when;!
 \end{nonnormative}
 
 The algorithmic statements within a \lstinline!when!-statement are active during initialization, if and only if they are explicitly enabled with \lstinline!initial()!, and only in one of the two forms \lstinline!when initial() then! or \lstinline!when {$\ldots$, initial(), $\ldots$} then!.
@@ -738,8 +734,7 @@ \section{Initialization, initial equation, and initial algorithm}\label{initiali
 An active \lstinline!when!-clause inactivates the following \lstinline!elsewhen! (similarly as for \lstinline!when!-clauses during simulation), but apart from that the first \lstinline!elsewhen initial() then! or \lstinline!elsewhen {$\ldots$, initial(), $\ldots$} then! is similarly active during initialization as \lstinline!when initial() then! or \lstinline!when {$\ldots$, initial(), $\ldots$} then!.
 
 \begin{nonnormative}
-That means that any subsequent \lstinline!elsewhen initial()! has no effect,
-similarly as \lstinline!when false then!.
+That means that any subsequent \lstinline!elsewhen initial()! has no effect, similarly as \lstinline!when false then!.
 \end{nonnormative}
 
 \begin{nonnormative}
@@ -755,8 +750,7 @@ \section{Initialization, initial equation, and initial algorithm}\label{initiali
 \item
   For a continuous-time \lstinline!Real! variable \lstinline!vc!, the equation \lstinline!pre(vc) = vc! is added to the initialization equations.
   \begin{nonnormative}
-  If \lstinline!pre(vc)! is not present in the flattened model, a tool may choose not to introduce this equation, or if it was introduced
-  it can eliminate it (to avoid the introduction of many dummy variables \lstinline!pre(vc)!).
+  If \lstinline!pre(vc)! is not present in the flattened model, a tool may choose not to introduce this equation, or if it was introduced it can eliminate it (to avoid the introduction of many dummy variables \lstinline!pre(vc)!).
   \end{nonnormative}
 \item
   Implicitly by using the \lstinline!start!-attribute for variables with \lstinline!fixed = true!.