<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>book/src/dimension-definitions.md - fork/numbat @ master</title>
<meta name="description" content="book/src/dimension-definitions.md in fork/numbat at master.">
<meta property="og:title" content="book/src/dimension-definitions.md - fork/numbat @ master">
<meta property="og:description" content="book/src/dimension-definitions.md in fork/numbat at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="b070b880c8a713bac881084034ea6f0d857868ed">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/numbat</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/numbat</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">David Peter</span><span class="commit-message" data-commit="b7510ad0ccaf46d642ca34a6a6e835b6edca7e2c">Improve documentation around ad-hoc units</span><span class="snapshot-sha sha" data-commit="b7510ad0ccaf46d642ca34a6a6e835b6edca7e2c">b7510ad</span><time datetime="2024-02-24T21:31:59+01:00" title="2024-02-24 21:31:59 +0100">2024-02-24</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/numbat/ref/master/">master</a><strong>tags</strong><a href="/fork/numbat/ref/v1.6.0/">v1.6.0</a><a href="/fork/numbat/ref/v1.6.1/">v1.6.1</a><a href="/fork/numbat/ref/v1.6.2/">v1.6.2</a><a href="/fork/numbat/ref/v1.6.3/">v1.6.3</a><a href="/fork/numbat/ref/v1.7.0/">v1.7.0</a><a href="/fork/numbat/ref/v1.8.0/">v1.8.0</a><a class="all" href="/fork/numbat/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/numbat/">numbat</a> / <a href="/fork/numbat/ref/master/tree/book/">book</a> / <a href="/fork/numbat/ref/master/tree/book/src/">src</a> / <span class="cur">dimension-definitions.md</span></nav>
<span class="view-stats"><span>996 B</span><span>16 lines</span></span><span class="actions"><a class="raw" href="/fork/numbat/raw/29a845fe34f70de505ea6d7ed144541e3d23d814/book/src/dimension-definitions.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Dimension definitions</h1>
<p>New (physical) dimensions can be introduced with the <code>dimension</code> keyword. Similar like for <a href="/fork/numbat/ref/master/blob/book/src/unit-definitions.md">units</a>, there are base dimensions (like <em>length</em>, <em>time</em> and <em>mass</em>) and dimensions that are derived from those base dimensions (like <em>momentum</em>, which is <em>mass</em> · <em>length</em> / <em>time</em>). Base dimensions are simply introduced by declaring their name:</p>
<pre>dimension Length
dimension Time
dimension Mass
</pre>
<p>Derived dimensions need to specify their relation to base dimensions (or other derived dimensions). For example:</p>
<pre>dimension Velocity = Length / Time
dimension Momentum = Mass * Velocity
dimension Force = Mass * Acceleration = Momentum / Time
dimension Energy = Momentum^2 / Mass = Mass * Velocity^2 = Force * Length
</pre>
<p>In the definition of <code>Force</code> and <code>Energy</code>, we can see that multiple <em>alternative definitions</em> can be specified. This is entirely optional. When given, the compiler will make sure that all definitions are equivalent.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Dimension definitions</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">New (physical) dimensions can be introduced with the `dimension` keyword. Similar like for [units](./unit-definitions.md), there are base dimensions (like *length*, *time* and *mass*) and dimensions that are derived from those base dimensions (like *momentum*, which is *mass* · *length* / *time*). Base dimensions are simply introduced by declaring their name:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>```</a-p><a-tl> numbat</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>dimension Length</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>dimension Time</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>dimension Mass</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>Derived dimensions need to specify their relation to base dimensions (or other derived dimensions). For example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>```</a-p><a-tl> numbat</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>dimension Velocity = Length / Time</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>dimension Momentum = Mass * Velocity</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>dimension Force = Mass * Acceleration = Momentum / Time</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>dimension Energy = Momentum^2 / Mass = Mass * Velocity^2 = Force * Length</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">In the definition of `Force` and `Energy`, we can see that multiple *alternative definitions* can be specified. This is entirely optional. When given, the compiler will make sure that all definitions are equivalent.</span></span></pre></div></div>
</main>
</body>
</html>
