185 lines
16 KiB
HTML
185 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>kittycad.models.physics_constant_name — kittycad v0.3.8 documentation</title>
|
|
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../../_static/copybutton.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../../_static/autoclasstoc.css" type="text/css" />
|
|
<!--[if lt IE 9]>
|
|
<script src="../../../_static/js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
|
|
<script src="../../../_static/jquery.js"></script>
|
|
<script src="../../../_static/underscore.js"></script>
|
|
<script src="../../../_static/doctools.js"></script>
|
|
<script src="../../../_static/clipboard.min.js"></script>
|
|
<script src="../../../_static/copybutton.js"></script>
|
|
<script src="../../../_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="../../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../../search.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
|
|
|
|
|
|
<a href="../../../index.html" class="icon icon-home">
|
|
kittycad
|
|
</a>
|
|
<div class="version">
|
|
v0.3.8
|
|
</div>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../../../index.html">kittycad</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
|
|
<li class="breadcrumb-item active">kittycad.models.physics_constant_name</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<h1>Source code for kittycad.models.physics_constant_name</h1><div class="highlight"><pre>
|
|
<span></span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>
|
|
|
|
|
|
<div class="viewcode-block" id="PhysicsConstantName"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.physics_constant_name.PhysicsConstantName.html#kittycad.models.physics_constant_name.PhysicsConstantName">[docs]</a><span class="k">class</span> <span class="nc">PhysicsConstantName</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">Enum</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""The valid types of phys constant names."""</span> <span class="c1"># noqa: E501</span>
|
|
|
|
<span class="w"> </span><span class="sd">"""# pi - Ratio of a circle's circumference to its diameter. <https://en.wikipedia.org/wiki/Pi> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">PI</span> <span class="o">=</span> <span class="s2">"pi"</span>
|
|
<span class="w"> </span><span class="sd">"""# c - Speed of light in vacuum. <https://en.wikipedia.org/wiki//Speed_of_light> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">C</span> <span class="o">=</span> <span class="s2">"c"</span>
|
|
<span class="w"> </span><span class="sd">"""# Speed of light in a vacuum. <https://en.wikipedia.org/wiki//Speed_of_light> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">SPEED_OF_LIGHT</span> <span class="o">=</span> <span class="s2">"speed_of_light"</span>
|
|
<span class="w"> </span><span class="sd">"""# G - Newtonian constant of gravitation. <https://en.wikipedia.org/wiki/Gravitational_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">G</span> <span class="o">=</span> <span class="s2">"G"</span>
|
|
<span class="w"> </span><span class="sd">"""# Newtonian constant of gravitation. <https://en.wikipedia.org/wiki/Gravitational_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">NEWTONIAN_GRAVITATION</span> <span class="o">=</span> <span class="s2">"newtonian_gravitation"</span>
|
|
<span class="w"> </span><span class="sd">"""# h - Planck constant. <https://en.wikipedia.org/wiki/Planck_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">H</span> <span class="o">=</span> <span class="s2">"h"</span>
|
|
<span class="w"> </span><span class="sd">"""# Planck constant. <https://en.wikipedia.org/wiki/Planck_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">PLANCK_CONST</span> <span class="o">=</span> <span class="s2">"planck_const"</span>
|
|
<span class="w"> </span><span class="sd">"""# mu_0 - vacuum permeability. <https://en.wikipedia.org/wiki/Vacuum_permeability> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">MU_0</span> <span class="o">=</span> <span class="s2">"mu_0"</span>
|
|
<span class="w"> </span><span class="sd">"""# vacuum permeability. <https://en.wikipedia.org/wiki/Vacuum_permeability> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">VACUUM_PERMEABILITY</span> <span class="o">=</span> <span class="s2">"vacuum_permeability"</span>
|
|
<span class="w"> </span><span class="sd">"""# ε_0 - vacuum permitivity. <https://en.wikipedia.org/wiki/Vacuum_permittivity> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">E_0</span> <span class="o">=</span> <span class="s2">"E_0"</span>
|
|
<span class="w"> </span><span class="sd">"""# vacuum permitivity. <https://en.wikipedia.org/wiki/Vacuum_permittivity>] """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">VACUUM_PERMITIVITY</span> <span class="o">=</span> <span class="s2">"vacuum_permitivity"</span>
|
|
<span class="w"> </span><span class="sd">"""# Z_0 - characteristic impedance of vacuum. <https://en.wikipedia.org/wiki/Impedance_of_free_space> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">Z_0</span> <span class="o">=</span> <span class="s2">"Z_0"</span>
|
|
<span class="w"> </span><span class="sd">"""# characteristic impedance of vacuum. <https://en.wikipedia.org/wiki/Impedance_of_free_space> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">VACUUM_IMPEDANCE</span> <span class="o">=</span> <span class="s2">"vacuum_impedance"</span>
|
|
<span class="w"> </span><span class="sd">"""# k_e - Coulomb's constant. <https://en.wikipedia.org/wiki/Coulomb_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">K_E</span> <span class="o">=</span> <span class="s2">"k_e"</span>
|
|
<span class="w"> </span><span class="sd">"""# Coulomb's constant. <https://en.wikipedia.org/wiki/Coulomb_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">COULOMB_CONST</span> <span class="o">=</span> <span class="s2">"coulomb_const"</span>
|
|
<span class="w"> </span><span class="sd">"""# e - elementary charge. <https://en.wikipedia.org/wiki/Elementary_charge> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">E</span> <span class="o">=</span> <span class="s2">"e"</span>
|
|
<span class="w"> </span><span class="sd">"""# elementary charge. <https://en.wikipedia.org/wiki/Elementary_charge> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">ELEMENTARY_CHARGE</span> <span class="o">=</span> <span class="s2">"elementary_charge"</span>
|
|
<span class="w"> </span><span class="sd">"""# m_e - electron mass. <https://en.wikipedia.org/wiki/Electron_mass> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">M_E</span> <span class="o">=</span> <span class="s2">"m_e"</span>
|
|
<span class="w"> </span><span class="sd">"""# electron mass. <https://en.wikipedia.org/wiki/Electron_mass> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">ELECTRON_MASS</span> <span class="o">=</span> <span class="s2">"electron_mass"</span>
|
|
<span class="w"> </span><span class="sd">"""# m_p - proton mass. <https://en.wikipedia.org/wiki/Proton> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">M_P</span> <span class="o">=</span> <span class="s2">"m_p"</span>
|
|
<span class="w"> </span><span class="sd">"""# proton mass. <https://en.wikipedia.org/wiki/Proton> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">PROTON_MASS</span> <span class="o">=</span> <span class="s2">"proton_mass"</span>
|
|
<span class="w"> </span><span class="sd">"""# mu_B - Bohr magneton. <https://en.wikipedia.org/wiki/Bohr_magneton> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">MU_B</span> <span class="o">=</span> <span class="s2">"mu_B"</span>
|
|
<span class="w"> </span><span class="sd">"""# Bohr magneton. <https://en.wikipedia.org/wiki/Bohr_magneton> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">BOHR_MAGNETON</span> <span class="o">=</span> <span class="s2">"bohr_magneton"</span>
|
|
<span class="w"> </span><span class="sd">"""# NA - Avogadro's Number. <https://en.wikipedia.org/wiki/Avogadro_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">NA</span> <span class="o">=</span> <span class="s2">"NA"</span>
|
|
<span class="w"> </span><span class="sd">"""# Avogadro's Number. <https://en.wikipedia.org/wiki/Avogadro_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">AVOGADRO_NUM</span> <span class="o">=</span> <span class="s2">"avogadro_num"</span>
|
|
<span class="w"> </span><span class="sd">"""# R - Molar Gas constant. <https://en.wikipedia.org/wiki/Gas_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">R</span> <span class="o">=</span> <span class="s2">"R"</span>
|
|
<span class="w"> </span><span class="sd">"""# Molar Gas constant. <https://en.wikipedia.org/wiki/Gas_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">MOLAR_GAS_CONST</span> <span class="o">=</span> <span class="s2">"molar_gas_const"</span>
|
|
<span class="w"> </span><span class="sd">"""# K_B - Boltzmann constant. <https://en.wikipedia.org/wiki/Boltzmann_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">K_B</span> <span class="o">=</span> <span class="s2">"K_B"</span>
|
|
<span class="w"> </span><span class="sd">"""# Boltzmann constant. <https://en.wikipedia.org/wiki/Boltzmann_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">BOLTZMANN_CONST</span> <span class="o">=</span> <span class="s2">"boltzmann_const"</span>
|
|
<span class="w"> </span><span class="sd">"""# F - Faraday constant. <https://en.wikipedia.org/wiki/Faraday_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">F</span> <span class="o">=</span> <span class="s2">"F"</span>
|
|
<span class="w"> </span><span class="sd">"""# Faraday constant. <https://en.wikipedia.org/wiki/Faraday_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">FARADAY_CONST</span> <span class="o">=</span> <span class="s2">"faraday_const"</span>
|
|
<span class="w"> </span><span class="sd">"""# Sigma - Stefan-Boltzmann constant. <https://en.wikipedia.org/wiki/Stefan%E2%80%93Boltzmann_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">SIGMA</span> <span class="o">=</span> <span class="s2">"sigma"</span>
|
|
<span class="w"> </span><span class="sd">"""# Stefan-Boltzmann constant. <https://en.wikipedia.org/wiki/Stefan%E2%80%93Boltzmann_constant> """</span> <span class="c1"># noqa: E501</span>
|
|
<span class="n">STEFAN_BOLTZMANN_CONST</span> <span class="o">=</span> <span class="s2">"stefan_boltzmann_const"</span>
|
|
|
|
<div class="viewcode-block" id="PhysicsConstantName.__str__"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.physics_constant_name.PhysicsConstantName.html#kittycad.models.physics_constant_name.PhysicsConstantName.__str__">[docs]</a> <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">)</span></div></div>
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |