An outline of all sections included in this SRS is recorded here for easy reference.
This section records information for easy reference.
The unit system used throughout is SI (Système International d'Unités). In addition to the basic units, several derived units are also used. For each unit, the Table of Units lists the symbol, a description, and the SI name.
Symbol | Description | SI Name |
---|---|---|
$kg$ | mass | kilogram |
$m$ | length | metre |
$N$ | force | newton |
$rad$ | angle | radian |
$s$ | time | second |
The symbols used in this document are summarized in the Table of Symbols along with their units. Throughout the document, symbols in bold will represent vectors, and scalars otherwise. The symbols are listed in alphabetical order. For vector quantities, the units shown are for each component of the vector.
Symbol | Description | Units |
---|---|---|
$a_x1$ | Horizontal acceleration of the first object | $\frac{m}{s^2}$ |
$a_x2$ | Horizontal acceleration of the second object | $\frac{m}{s^2}$ |
$a_y1$ | Vertical acceleration of the first object | $\frac{m}{s^2}$ |
$a_y2$ | Vertical acceleration of the second object | $\frac{m}{s^2}$ |
$a(t)$ | Acceleration | $\frac{m}{s^2}$ |
$F$ | Force | $N$ |
$g$ | Magnitude of gravitational acceleration | $\frac{m}{s^2}$ |
$g$ | Gravitational acceleration | $\frac{m}{s^2}$ |
$î$ | Unit vector | -- |
$L_1$ | Length of the first rod | $m$ |
$L_2$ | Length of the second rod | $m$ |
$m$ | Mass | $kg$ |
$m_1$ | Mass of the first object | $kg$ |
$m_2$ | Mass of the second object | $kg$ |
$p_x1$ | Horizontal position of the first object | $m$ |
$p_x2$ | Horizontal position of the second object | $m$ |
$p_y1$ | Vertical position of the first object | $m$ |
$p_y2$ | Vertical position of the second object | $m$ |
$p(t)$ | Position | $m$ |
$T$ | Tension | $N$ |
$T_1$ | Tension of the first object | $N$ |
$T_2$ | Tension of the second object | $N$ |
$t$ | Time | $s$ |
$theta$ | Dependent variables | $rad$ |
$v_x1$ | Horizontal velocity of the first object | $\frac{m}{s}$ |
$v_x2$ | Horizontal velocity of the second object | $\frac{m}{s}$ |
$v_y1$ | Vertical velocity of the first object | $\frac{m}{s}$ |
$v_y2$ | Vertical velocity of the second object | $\frac{m}{s}$ |
$v(t)$ | Velocity | $\frac{m}{s}$ |
$w_1$ | Angular velocity of the first object | $\frac{rad}{s}$ |
$w_2$ | Angular velocity of the second object | $\frac{rad}{s}$ |
$α_1$ | Angular acceleration of the first object | $\frac{rad}{s^2}$ |
$α_2$ | Angular acceleration of the second object | $\frac{rad}{s^2}$ |
$θ_1$ | Angle of the first rod | $rad$ |
$θ_2$ | Angle of the second rod | $rad$ |
$π$ | Ratio of circumference to diameter for any circle | -- |
Abbreviation | Full Form |
---|---|
2D | Two-Dimensional |
A | Assumption |
DD | Data Definition |
DblPend | Double Pendulum |
GD | General Definition |
GS | Goal Statement |
IM | Instance Model |
PS | Physical System Description |
R | Requirement |
RefBy | Referenced by |
Refname | Reference Name |
SRS | Software Requirements Specification |
TM | Theoretical Model |
Uncert. | Typical Uncertainty |
A pendulum consists of mass attached to the end of a rod and its moving curve is highly sensitive to initial conditions. Therefore, it is useful to have a program to simulate the motion of the pendulum to exhibit its chaotic characteristics. The document describes the program called Double Pendulum , which is based on the original, manually created version of <a href=\"https://github.com/Zhang-Zhi-ZZ/CAS741Project/tree/master/Double%20Pendulum\">Double Pendulum</a>.
The following section provides an overview of the Software Requirements Specification (SRS) for Double Pendulum. This section explains the purpose of this document, the scope of the requirements, the characteristics of the intended reader, and the organization of the document.
The primary purpose of this document is to record the requirements of DblPend. Goals, assumptions, theoretical models, definitions, and other model derivation information are specified, allowing the reader to fully understand and verify the purpose and scientific basis of DblPend. With the exception of system constraints, this SRS will remain abstract, describing what problem is being solved, but not how to solve it.
This document will be used as a starting point for subsequent development phases, including writing the design specification and the software verification and validation plan. The design document will show how the requirements are to be realized, including decisions on the numerical algorithms and programming environment. The verification and validation plan will show the steps that will be used to increase confidence in the software documentation and the implementation. Although the SRS fits in a series of documents that follow the so-called waterfall model, the actual development process is not constrained in any way. Even when the waterfall model is not followed, as Parnas and Clements point out parnasClements1986 , the most logical way to present the documentation is still to "fake" a rational design process.
The scope of the requirements includes the analysis of a two-dimensional (2D) pendulum motion problem with various initial conditions.
Reviewers of this documentation should have an understanding of undergraduate level 2 physics, undergraduate level 1 calculus, and ordinary differential equations. The users of DblPend can have a lower level of expertise, as explained in Sec:User Characteristics.
The organization of this document follows the template for an SRS for scientific computing software proposed by koothoor2013 , smithLai2005 , smithEtAl2007 , and smithKoothoor2016 . The presentation follows the standard pattern of presenting goals, theories, definitions, and assumptions. For readers that would like a more bottom up approach, they can start reading the instance models and trace back to find any additional information they require.
The goal statements are refined to the theoretical models and the theoretical models to the instance models.
This section provides general information about the system. It identifies the interfaces between the system and its environment, describes the user characteristics, and lists the system constraints.
Fig:sysCtxDiag shows the system context. A circle represents an entity external to the software, the user in this case. A rectangle represents the software system itself (DblPend). Arrows are used to show the data flow between the system and its environment.
The interaction between the product and the user is through an application programming interface. The responsibilities of the user and the system are as follows:
The end user of DblPend should have an understanding of high school physics, high school calculus and ordinary differential equations.
There are no system constraints.
This section first presents the problem description, which gives a high-level view of the problem to be solved. This is followed by the solution characteristics specification, which presents the assumptions, theories, and definitions that are used.
A system is needed to predict the motion of a double pendulum.
This subsection provides a list of terms that are used in the subsequent sections and their meaning, with the purpose of reducing ambiguity and making it easier to correctly understand the requirements.
The physical system of DblPend, as shown in Fig:dblpend, includes the following elements:
PS1: The first rod (with length of the first rod $L_1$).
PS2: The second rod (with length of the second rod $L_2$).
PS3: The first object.
PS4: The second object.
Given the masses, length of the rods, initial angle of the masses and the gravitational constant, the goal statement is:
<div id=\"motionMass\"> motionMass: Calculate the motion of the masses.
</div>
The instance models that govern DblPend are presented in the Instance Model Section. The information to understand the meaning of the instance models and their derivation is also presented, so that the instance models can be verified.
This section simplifies the original problem and helps in developing the theoretical models by filling in the missing information for the physical system. The assumptions refine the scope by providing more detail.
<div id=\"twoDMotion\"> twoDMotion: The pendulum motion is two-dimensional (2D).
</div>
<div id=\"cartSys\"> cartSys: A Cartesian coordinate system is used.
</div>
<div id=\"cartSysR\"> cartSysR: The Cartesian coordinate system is right-handed where positive $x$-axis and $y$-axis point right up.
</div>
<div id=\"yAxisDir\"> yAxisDir: The direction of the $y$-axis is directed opposite to gravity.
</div>
This section focuses on the general equations and laws that DblPend is based on.
<table class=\"tdefn\">
Acceleration </td> </tr>
accelerationWiki </td> </tr>
<table class=\"tdefn\">
Velocity </td> </tr>
velocityWiki </td> </tr>
<table class=\"tdefn\">
Newton's second law of motion </td> </tr>
The net force $F$ on a body is proportional to the acceleration $a(t)$ of the body, where $m$ denotes the mass of the body as the constant of proportionality. </td> </tr>
-- </td> </tr>
</td> </tr> </table>
This section collects the laws and equations that will be used to build the instance models.
<table class=\"gdefn\">
The $x$-component of velocity of the first object </td> </tr>
$\frac{m}{s}$ </td> </tr>
-- </td> </tr>
</td> </tr> </table>
At a given point in time, velocity is defined in DD:positionGDD $$\symbf{v}\text{(}t\text{)}=\frac{\,d\symbf{p}\text{(}t\text{)}}{\,dt}$$
We also know the horizontal position that is defined in DD:positionXDD1 $${p_{\text{x}1}}={L_{1}}\,\sin\left({θ_{1}}\right)$$
Applying this, $${v_{\text{x}1}}=\frac{\,d{L_{1}}\,\sin\left({θ_{1}}\right)}{\,dt}$$
$L_1$ is constant with respect to time, so $${v_{\text{x}1}}={L_{1}}\,\frac{\,d\sin\left({θ_{1}}\right)}{\,dt}$$
Therefore, using the chain rule,
$${v_{\text{x}1}}={w_{1}}\,{L_{1}}\,\cos\left({θ_{1}}\right)$$
<table class=\"gdefn\">
The $y$-component of velocity of the first object </td> </tr>
$\frac{m}{s}$ </td> </tr>
-- </td> </tr>
</td> </tr> </table>
At a given point in time, velocity is defined in DD:positionGDD $$\symbf{v}\text{(}t\text{)}=\frac{\,d\symbf{p}\text{(}t\text{)}}{\,dt}$$
We also know the vertical position that is defined in DD:positionYDD1 $${p_{\text{y}1}}=-{L_{1}}\,\cos\left({θ_{1}}\right)$$
Applying this, $${v_{\text{y}1}}=-\left(\frac{\,d{L_{1}}\,\cos\left({θ_{1}}\right)}{\,dt}\right)$$
$L_1$ is constant with respect to time, so $${v_{\text{y}1}}=-{L_{1}}\,\frac{\,d\cos\left({θ_{1}}\right)}{\,dt}$$
Therefore, using the chain rule,
$${v_{\text{y}1}}={w_{1}}\,{L_{1}}\,\sin\left({θ_{1}}\right)$$
<table class=\"gdefn\">
The $x$-component of velocity of the second object </td> </tr>
$\frac{m}{s}$ </td> </tr>
-- </td> </tr>
</td> </tr> </table>
At a given point in time, velocity is defined in DD:positionGDD $$\symbf{v}\text{(}t\text{)}=\frac{\,d\symbf{p}\text{(}t\text{)}}{\,dt}$$
We also know the horizontal position that is defined in DD:positionXDD2 $${p_{\text{x}2}}={p_{\text{x}1}}+{L_{2}}\,\sin\left({θ_{2}}\right)$$
Applying this, $${v_{\text{x}2}}=\frac{\,d{p_{\text{x}1}}+{L_{2}}\,\sin\left({θ_{2}}\right)}{\,dt}$$
$L_1$ is constant with respect to time, so
$${v_{\text{x}2}}={v_{\text{x}1}}+{w_{2}}\,{L_{2}}\,\cos\left({θ_{2}}\right)$$
<table class=\"gdefn\">
The $y$-component of velocity of the second object </td> </tr>
$\frac{m}{s}$ </td> </tr>
-- </td> </tr>
</td> </tr> </table>
At a given point in time, velocity is defined in DD:positionGDD $$\symbf{v}\text{(}t\text{)}=\frac{\,d\symbf{p}\text{(}t\text{)}}{\,dt}$$
We also know the vertical position that is defined in DD:positionYDD2 $${p_{\text{y}2}}={p_{\text{y}1}}-{L_{2}}\,\cos\left({θ_{2}}\right)$$
Applying this, $${v_{\text{y}2}}=-\left(\frac{\,d{p_{\text{y}1}}-{L_{2}}\,\cos\left({θ_{2}}\right)}{\,dt}\right)$$
Therefore, using the chain rule,
$${v_{\text{y}2}}={v_{\text{y}1}}+{w_{2}}\,{L_{2}}\,\sin\left({θ_{2}}\right)$$
<table class=\"gdefn\">
The $x$-component of acceleration of the first object </td> </tr>
$\frac{m}{s^2}$ </td> </tr>
-- </td> </tr>
IM:calOfAngle2 </td> </tr> </table>
Our acceleration is: $$\symbf{a}\text{(}t\text{)}=\frac{\,d\symbf{v}\text{(}t\text{)}}{\,dt}$$
Earlier, we found the horizontal velocity to be $${v_{\text{x}1}}={w_{1}}\,{L_{1}}\,\cos\left({θ_{1}}\right)$$
Applying this to our equation for acceleration $${a_{\text{x}1}}=\frac{\,d{w_{1}}\,{L_{1}}\,\cos\left({θ_{1}}\right)}{\,dt}$$
By the product and chain rules, we find $${a_{\text{x}1}}=\frac{\,d{w_{1}}}{\,dt}\,{L_{1}}\,\cos\left({θ_{1}}\right)-{w_{1}}\,{L_{1}}\,\sin\left({θ_{1}}\right)\,\frac{\,d{θ_{1}}}{\,dt}$$
Simplifying,
$${a_{\text{x}1}}=-{w_{1}}^{2}\,{L_{1}}\,\sin\left({θ_{1}}\right)+{α_{1}}\,{L_{1}}\,\cos\left({θ_{1}}\right)$$
<table class=\"gdefn\">
The $y$-component of acceleration of the first object </td> </tr>
$\frac{m}{s^2}$ </td> </tr>
-- </td> </tr>
IM:calOfAngle2 </td> </tr> </table>
Our acceleration is: $$\symbf{a}\text{(}t\text{)}=\frac{\,d\symbf{v}\text{(}t\text{)}}{\,dt}$$
Earlier, we found the vertical velocity to be $${v_{\text{y}1}}={w_{1}}\,{L_{1}}\,\sin\left({θ_{1}}\right)$$
Applying this to our equation for acceleration $${a_{\text{y}1}}=\frac{\,d{w_{1}}\,{L_{1}}\,\sin\left({θ_{1}}\right)}{\,dt}$$
By the product and chain rules, we find $${a_{\text{y}1}}=\frac{\,d{w_{1}}}{\,dt}\,{L_{1}}\,\sin\left({θ_{1}}\right)+{w_{1}}\,{L_{1}}\,\cos\left({θ_{1}}\right)\,\frac{\,d{θ_{1}}}{\,dt}$$
Simplifying,
$${a_{\text{y}1}}={w_{1}}^{2}\,{L_{1}}\,\cos\left({θ_{1}}\right)+{α_{1}}\,{L_{1}}\,\sin\left({θ_{1}}\right)$$
<table class=\"gdefn\">
The $x$-component of acceleration of the second object </td> </tr>
$\frac{m}{s^2}$ </td> </tr>
-- </td> </tr>
IM:calOfAngle2 </td> </tr> </table>
Our acceleration is: $$\symbf{a}\text{(}t\text{)}=\frac{\,d\symbf{v}\text{(}t\text{)}}{\,dt}$$
Earlier, we found the horizontal velocity to be $${v_{\text{x}2}}={v_{\text{x}1}}+{w_{2}}\,{L_{2}}\,\cos\left({θ_{2}}\right)$$
Applying this to our equation for acceleration $${a_{\text{x}2}}=\frac{\,d{v_{\text{x}1}}+{w_{2}}\,{L_{2}}\,\cos\left({θ_{2}}\right)}{\,dt}$$
By the product and chain rules, we find
$${a_{\text{x}2}}={a_{\text{x}1}}-{w_{2}}^{2}\,{L_{2}}\,\sin\left({θ_{2}}\right)+{α_{2}}\,{L_{2}}\,\cos\left({θ_{2}}\right)$$
<table class=\"gdefn\">
The $y$-component of acceleration of the second object </td> </tr>
$\frac{m}{s^2}$ </td> </tr>
-- </td> </tr>
IM:calOfAngle2 </td> </tr> </table>
Our acceleration is: $$\symbf{a}\text{(}t\text{)}=\frac{\,d\symbf{v}\text{(}t\text{)}}{\,dt}$$
Earlier, we found the horizontal velocity to be $${v_{\text{y}2}}={v_{\text{y}1}}+{w_{2}}\,{L_{2}}\,\sin\left({θ_{2}}\right)$$
Applying this to our equation for acceleration $${a_{\text{y}2}}=\frac{\,d{v_{\text{y}1}}+{w_{2}}\,{L_{2}}\,\sin\left({θ_{2}}\right)}{\,dt}$$
By the product and chain rules, we find
$${a_{\text{y}2}}={a_{\text{y}1}}+{w_{2}}^{2}\,{L_{2}}\,\cos\left({θ_{2}}\right)+{α_{2}}\,{L_{2}}\,\sin\left({θ_{2}}\right)$$
<table class=\"gdefn\">
Horizontal force on the first object </td> </tr>
$N$ </td> </tr>
-- </td> </tr>
IM:calOfAngle2 </td> </tr> </table>
$$\symbf{F}=m \symbf{a}\text{(}t\text{)}=-{\symbf{T}_{1}}\,\sin\left({θ_{1}}\right)+{\symbf{T}_{2}}\,\sin\left({θ_{2}}\right)$$
<table class=\"gdefn\">
Vertical force on the first object </td> </tr>
$N$ </td> </tr>
-- </td> </tr>
IM:calOfAngle2 </td> </tr> </table>
$$\symbf{F}=m \symbf{a}\text{(}t\text{)}={\symbf{T}_{1}}\,\cos\left({θ_{1}}\right)-{\symbf{T}_{2}}\,\cos\left({θ_{2}}\right)-{m_{1}}\,\symbf{g}$$
<table class=\"gdefn\">
Horizontal force on the second object </td> </tr>
$N$ </td> </tr>
-- </td> </tr>
IM:calOfAngle2 </td> </tr> </table>
$$\symbf{F}=m \symbf{a}\text{(}t\text{)}=-{\symbf{T}_{2}}\,\sin\left({θ_{2}}\right)$$
<table class=\"gdefn\">
Vertical force on the second object </td> </tr>
$N$ </td> </tr>
-- </td> </tr>
IM:calOfAngle2 </td> </tr> </table>
$$\symbf{F}=m \symbf{a}\text{(}t\text{)}={\symbf{T}_{2}}\,\cos\left({θ_{2}}\right)-{m_{2}}\,\symbf{g}$$
This section collects and defines all the data needed to build the instance models.
<table class=\"ddefn\">
Velocity </td> </tr>
$v(t)$ </td> </tr>
$\frac{m}{s}$ </td> </tr>
-- </td> </tr>
GD:velocityY2, GD:velocityY1, GD:velocityX2, and GD:velocityX1
</td>
</tr>
</table>
<table class=\"ddefn\">
Horizontal position of the first object </td> </tr>
$p_x1$ </td> </tr>
$m$ </td> </tr>
$p_x1$ is the horizontal position
$p_x1$ is shown in Fig:dblpend. </td> </tr>
-- </td> </tr>
GD:velocityX1
</td>
</tr>
</table>
<table class=\"ddefn\">
Vertical position of the first object </td> </tr>
$p_y1$ </td> </tr>
$m$ </td> </tr>
$p_y1$ is the vertical position
$p_y1$ is shown in Fig:dblpend. </td> </tr>
-- </td> </tr>
GD:velocityY1
</td>
</tr>
</table>
<table class=\"ddefn\">
Horizontal position of the second object </td> </tr>
$p_x2$ </td> </tr>
$m$ </td> </tr>
$p_x2$ is the horizontal position
$p_x2$ is shown in Fig:dblpend. </td> </tr>
-- </td> </tr>
GD:velocityX2
</td>
</tr>
</table>
<table class=\"ddefn\">
Vertical position of the second object </td> </tr>
$p_y2$ </td> </tr>
$m$ </td> </tr>
$p_y2$ is the vertical position
$p_y2$ is shown in Fig:dblpend. </td> </tr>
-- </td> </tr>
GD:velocityY2
</td>
</tr>
</table>
<table class=\"ddefn\">
Acceleration </td> </tr>
$a(t)$ </td> </tr>
$\frac{m}{s^2}$ </td> </tr>
-- </td> </tr>
<table class=\"ddefn\">
Force </td> </tr>
$F$ </td> </tr>
$N$ </td> </tr>
-- </td> </tr>
</td> </tr> </table>
This section transforms the problem defined in the problem description into one which is expressed in mathematical terms. It uses concrete symbols defined in the data definitions to replace the abstract symbols in the models identified in theoretical models and general definitions.
<table class=\"idefn\">
Calculation of angle of first rod </td> </tr>
$L_1$, $L_2$, $m_1$, $m_2$, $θ_1$, $θ_2$ </td> </tr>
$θ_1$ </td> </tr>
$θ_1$ is calculated by solving the ODE here together with the initial conditions and IM:calOfAngle2. </td> </tr>
-- </td> </tr>
IM:calOfAngle2, FR:Output-Values, and FR:Calculate-Angle-Of-Rod
</td>
</tr>
</table>
<table class=\"idefn\">
Calculation of angle of second rod </td> </tr>
$L_1$, $L_2$, $m_1$, $m_2$, $θ_1$, $θ_2$ </td> </tr>
$θ_2$ </td> </tr>
$θ_2$ is calculated by solving the ODE here together with the initial conditions and IM:calOfAngle1. </td> </tr>
-- </td> </tr>
IM:calOfAngle2, IM:calOfAngle1, FR:Output-Values, and FR:Calculate-Angle-Of-Rod </td> </tr> </table>
By solving equations GD:xForce2 and GD:yForce2 for $T_2sin(θ_2)$ and $T_2cos(θ_2)$ and then substituting into equation GD:xForce1 and GD:yForce1 , we can get equations 1 and 2: $${m_{1}}\,{a_{\text{x}1}}=-{\symbf{T}_{1}}\,\sin\left({θ_{1}}\right)-{m_{2}}\,{a_{\text{x}2}}$$
$${m_{1}}\,{a_{\text{y}1}}={\symbf{T}_{1}}\,\cos\left({θ_{1}}\right)-{m_{2}}\,{a_{\text{y}2}}-{m_{2}}\,g-{m_{1}}\,g$$Multiply the equation 1 by $cos(θ_1)$ and the equation 2 by $sin(θ_1)$ and rearrange to get: $${\symbf{T}_{1}}\,\sin\left({θ_{1}}\right)\,\cos\left({θ_{1}}\right)=-\cos\left({θ_{1}}\right)\,\left({m_{1}}\,{a_{\text{x}1}}+{m_{2}}\,{a_{\text{x}2}}\right)$$
$${\symbf{T}_{1}}\,\sin\left({θ_{1}}\right)\,\cos\left({θ_{1}}\right)=\sin\left({θ_{1}}\right)\,\left({m_{1}}\,{a_{\text{y}1}}+{m_{2}}\,{a_{\text{y}2}}+{m_{2}}\,g+{m_{1}}\,g\right)$$This leads to the equation 3 $$\sin\left({θ_{1}}\right)\,\left({m_{1}}\,{a_{\text{y}1}}+{m_{2}}\,{a_{\text{y}2}}+{m_{2}}\,g+{m_{1}}\,g\right)=-\cos\left({θ_{1}}\right)\,\left({m_{1}}\,{a_{\text{x}1}}+{m_{2}}\,{a_{\text{x}2}}\right)$$
Next, multiply equation GD:xForce2 by $cos(θ_2)$ and equation GD:yForce2 by $sin(θ_2)$ and rearrange to get: $${\symbf{T}_{2}}\,\sin\left({θ_{2}}\right)\,\cos\left({θ_{2}}\right)=-\cos\left({θ_{2}}\right)\,{m_{2}}\,{a_{\text{x}2}}$$
$${\symbf{T}_{1}}\,\sin\left({θ_{2}}\right)\,\cos\left({θ_{2}}\right)=\sin\left({θ_{2}}\right)\,\left({m_{2}}\,{a_{\text{y}2}}+{m_{2}}\,g\right)$$which leads to equation 4 $$\sin\left({θ_{2}}\right)\,\left({m_{2}}\,{a_{\text{y}2}}+{m_{2}}\,g\right)=-\cos\left({θ_{2}}\right)\,{m_{2}}\,{a_{\text{x}2}}$$
By giving equations GD:accelerationX1 and GD:accelerationX2 and GD:accelerationY1 and GD:accelerationY2 plus additional two equations, 3 and 4, we can get IM:calOfAngle1 and IM:calOfAngle2 via a computer algebra program:
The Data Constraints Table shows the data constraints on the input variables. The column for physical constraints gives the physical limitations on the range of values that can be taken by the variable. The uncertainty column provides an estimate of the confidence with which the physical quantities can be measured. This information would be part of the input if one were performing an uncertainty quantification exercise. The constraints are conservative to give the user of the model the flexibility to experiment with unusual situations. The column of typical values is intended to provide a feel for a common scenario.
Var | Physical Constraints | Typical Value | Uncert. |
---|---|---|---|
$L_1$ | $L_1 > 0$ | $1.0$ $m$ | 10$%$ |
$L_2$ | $L_2 > 0$ | $1.0$ $m$ | 10$%$ |
$m_1$ | $m_1 > 0$ | $0.5$ $kg$ | 10$%$ |
$m_2$ | $m_2 > 0$ | $0.5$ $kg$ | 10$%$ |
The Data Constraints Table shows the data constraints on the output variables. The column for physical constraints gives the physical limitations on the range of values that can be taken by the variable.
Var | Physical Constraints |
---|---|
$θ_1$ | $θ_1 > 0$ |
$θ_2$ | $θ_2 > 0$ |
This section provides the functional requirements, the tasks and behaviours that the software is expected to complete, and the non-functional requirements, the qualities that the software is expected to exhibit.
This section provides the functional requirements, the tasks and behaviours that the software is expected to complete.
<div id=\"inputValues\"> Input-Values: Input the values from Tab:ReqInputs.
</div>
<div id=\"verifyInptVals\"> Verify-Input-Values: Check the entered input values to ensure that they do not exceed the data constraints. If any of the input values are out of bounds, an error message is displayed and the calculations stop.
</div>
<div id=\"calcAng\"> Calculate-Angle-Of-Rod: Calculate the following values: $θ_1$ and $θ_2$ (from IM:calOfAngle1 and IM:calOfAngle2).
</div>
<div id=\"outputValues\"> Output-Values: Output $θ_1$ and $θ_2$ (from IM:calOfAngle1 and IM:calOfAngle2).
</div>
Symbol | Description | Units |
---|---|---|
$L_1$ | Length of the first rod | $m$ |
$L_2$ | Length of the second rod | $m$ |
$m_1$ | Mass of the first object | $kg$ |
$m_2$ | Mass of the second object | $kg$ |
This section provides the non-functional requirements, the qualities that the software is expected to exhibit.
<div id=\"correct\"> Correctness: The outputs of the code have the properties of a correct solution.
</div>
<div id=\"portable\"> Portability: The code shall be portable to multiple environments, particularly Windows, Mac OSX, and Linux.
</div>
The purpose of the traceability matrices is to provide easy references on what has to be additionally modified if a certain component is changed. Every time a component is changed, the items in the column of that component that are marked with an "X" should be modified as well. Tab:TraceMatAvsA shows the dependencies of the assumptions on each other. Tab:TraceMatAvsAll shows the dependencies of the data definitions, theoretical models, general definitions, instance models, requirements, likely changes, and unlikely changes on the assumptions. Tab:TraceMatRefvsRef shows the dependencies of the data definitions, theoretical models, general definitions, and instance models on each other. Tab:TraceMatAllvsR shows the dependencies of the requirements and goal statements on the data definitions, theoretical models, general definitions, and instance models.
A:twoDMotion | A:cartSys | A:cartSysR | A:yAxisDir | |
---|---|---|---|---|
A:twoDMotion | ||||
A:cartSys | ||||
A:cartSysR | ||||
A:yAxisDir |
The purpose of the traceability graphs is also to provide easy references on what has to be additionally modified if a certain component is changed. The arrows in the graphs represent dependencies. The component at the tail of an arrow is depended on by the component at the head of that arrow. Therefore, if a component is changed, the components that it points to should also be changed. Fig:TraceGraphAvsA shows the dependencies of assumptions on each other. Fig:TraceGraphAvsAll shows the dependencies of data definitions, theoretical models, general definitions, instance models, requirements, likely changes, and unlikely changes on the assumptions. Fig:TraceGraphRefvsRef shows the dependencies of data definitions, theoretical models, general definitions, and instance models on each other. Fig:TraceGraphAllvsR shows the dependencies of requirements and goal statements on the data definitions, theoretical models, general definitions, and instance models. Fig:TraceGraphAllvsAll shows the dependencies of dependencies of assumptions, models, definitions, requirements, goals, and changes with each other.
For convenience, the following graphs can be found at the links below:
There are no auxiliary constants.
[1]: Hibbeler, R. C. Engineering Mechanics: Dynamics. Pearson Prentice Hall, 2004. Print. [2]: Koothoor, Nirmitha. A Document Driven Approach to Certifying Scientific Computing Software. McMaster University, Hamilton, ON, Canada: 2013. Print. [3]: Parnas, David L. and Clements, P. C. "A rational design process: How and why to fake it." IEEE Transactions on Software Engineering, vol. 12, no. 2, Washington, USA: February, 1986. pp. 251–257. Print. [4]: Smith, W. Spencer and Koothoor, Nirmitha. "A Document-Driven Method for Certifying Scientific Computing Software for Use in Nuclear Safety Analysis." Nuclear Engineering and Technology, vol. 48, no. 2, April, 2016. http://www.sciencedirect.com/science/article/pii/S1738573315002582. pp. 404–418. [5]: Smith, W. Spencer and Lai, Lei. "A new requirements template for scientific computing." Proceedings of the First International Workshop on Situational Requirements Engineering Processes - Methods, Techniques and Tools to Support Situation-Specific Requirements Engineering Processes, SREP'05. Edited by PJ Agerfalk, N. Kraiem, and J. Ralyte, Paris, France: 2005. pp. 107–121. In conjunction with 13th IEEE International Requirements Engineering Conference, [6]: Smith, W. Spencer, Lai, Lei, and Khedri, Ridha. "Requirements Analysis for Engineering Computation: A Systematic Approach for Improving Software Reliability." Reliable Computing, Special Issue on Reliable Engineering Computation, vol. 13, no. 1, February, 2007. https://doi.org/10.1007/s11155-006-9020-7. pp. 83–107. [7]: Wikipedia Contributors. Acceleration. June, 2019. https://en.wikipedia.org/wiki/Acceleration. [8]: Wikipedia Contributors. Cartesian coordinate system. June, 2019. https://en.wikipedia.org/wiki/Cartesian_coordinate_system. [9]: Wikipedia Contributors. Velocity. June, 2019. https://en.wikipedia.org/wiki/Velocity.