Deploy preview for PR 12 🛫

Gorkowski · Jun 3, 2024 · 908e6a6 · 908e6a6
1 parent 3fa54ea
commit 908e6a6
Show file tree

Hide file tree

Showing 3 changed files with 231 additions and 25 deletions.
diff --git a/pr-preview/pr-12/Source-Code/particula/next/particles/representation_builders/index.html b/pr-preview/pr-12/Source-Code/particula/next/particles/representation_builders/index.html
@@ -2553,13 +2553,13 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#massparticlerepresentationbuilder" class="md-nav__link">
+  <a href="#lognormalparticlerepresentationbuilder" class="md-nav__link">
     <span class="md-ellipsis">
-      MassParticleRepresentationBuilder
+      LogNormalParticleRepresentationBuilder
     </span>
   </a>
 
-    <nav class="md-nav" aria-label="MassParticleRepresentationBuilder">
+    <nav class="md-nav" aria-label="LogNormalParticleRepresentationBuilder">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -2590,13 +2590,13 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#massparticlerepresentationbuilderbuild" class="md-nav__link">
+  <a href="#lognormalparticlerepresentationbuilderbuild" class="md-nav__link">
     <span class="md-ellipsis">
-      MassParticleRepresentationBuilder().build
+      LogNormalParticleRepresentationBuilder().build
     </span>
   </a>
 
-    <nav class="md-nav" aria-label="MassParticleRepresentationBuilder().build">
+    <nav class="md-nav" aria-label="LogNormalParticleRepresentationBuilder().build">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -2637,13 +2637,13 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#radiusparticlerepresentationbuilder" class="md-nav__link">
+  <a href="#massparticlerepresentationbuilder" class="md-nav__link">
     <span class="md-ellipsis">
-      RadiusParticleRepresentationBuilder
+      MassParticleRepresentationBuilder
     </span>
   </a>
 
-    <nav class="md-nav" aria-label="RadiusParticleRepresentationBuilder">
+    <nav class="md-nav" aria-label="MassParticleRepresentationBuilder">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -2674,13 +2674,13 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#radiusparticlerepresentationbuilderbuild" class="md-nav__link">
+  <a href="#massparticlerepresentationbuilderbuild" class="md-nav__link">
     <span class="md-ellipsis">
-      RadiusParticleRepresentationBuilder().build
+      MassParticleRepresentationBuilder().build
     </span>
   </a>
 
-    <nav class="md-nav" aria-label="RadiusParticleRepresentationBuilder().build">
+    <nav class="md-nav" aria-label="MassParticleRepresentationBuilder().build">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -2718,6 +2718,90 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#radiusparticlerepresentationbuilder" class="md-nav__link">
+    <span class="md-ellipsis">
+      RadiusParticleRepresentationBuilder
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="RadiusParticleRepresentationBuilder">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#methods_2" class="md-nav__link">
+    <span class="md-ellipsis">
+      Methods
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#signature_4" class="md-nav__link">
+    <span class="md-ellipsis">
+      Signature
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#see-also_4" class="md-nav__link">
+    <span class="md-ellipsis">
+      See also
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#radiusparticlerepresentationbuilderbuild" class="md-nav__link">
+    <span class="md-ellipsis">
+      RadiusParticleRepresentationBuilder().build
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="RadiusParticleRepresentationBuilder().build">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#returns_2" class="md-nav__link">
+    <span class="md-ellipsis">
+      Returns
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#signature_5" class="md-nav__link">
+    <span class="md-ellipsis">
+      Signature
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#see-also_5" class="md-nav__link">
+    <span class="md-ellipsis">
+      See also
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
     </ul>
@@ -6146,10 +6230,63 @@ <h1 id="representation-builders">Representation Builders<a class="headerlink" hr
 <blockquote>
 <p>Auto-generated documentation for <a href="https://github.com/Gorkowski/particula/blob/main/particula/next/particles/representation_builders.py">particula.next.particles.representation_builders</a> module.</p>
 </blockquote>
+<h2 id="lognormalparticlerepresentationbuilder">LogNormalParticleRepresentationBuilder<a class="headerlink" href="#lognormalparticlerepresentationbuilder" title="Permanent link">&para;</a></h2>
+<p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/particles/representation_builders.py#L155">Show source in representation_builders.py:155</a></p>
+<p>Builder class for ParticleRepresentation objects with log-normal
+distribution.</p>
+<h4 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">&para;</a></h4>
+<ul>
+<li><code>set_distribution_strategy(strategy)</code> - Set the DistributionStrategy.</li>
+<li><code>set_activity_strategy(strategy)</code> - Set the ActivityStrategy.</li>
+<li><code>set_surface_strategy(strategy)</code> - Set the SurfaceStrategy.</li>
+<li><code>set_radius(radius,</code> <em>radius_units)</em> - Set the radius of the particles.
+    Default units are 'm'.</li>
+<li><code>set_density(density,</code> <em>density_units)</em> - Set the density of the particles.
+    Default units are 'kg/m**3'.</li>
+<li><code>set_concentration(concentration,</code> <em>concentration_units)</em> - Set the
+    concentration of the particles. Default units are '/m**3'.</li>
+<li><code>set_charge(charge,</code> <em>charge_units)</em> - Set the number of charges.</li>
+</ul>
+<h4 id="signature">Signature<a class="headerlink" href="#signature" title="Permanent link">&para;</a></h4>
+<div class="highlight"><pre><span></span><code><span class="k">class</span> <span class="nc">LogNormalParticleRepresentationBuilder</span><span class="p">(</span>
+    <span class="n">BuilderABC</span><span class="p">,</span>
+    <span class="n">BuilderDistributionStrategyMixin</span><span class="p">,</span>
+    <span class="n">BuilderActivityStrategyMixin</span><span class="p">,</span>
+    <span class="n">BuilderSurfaceStrategyMixin</span><span class="p">,</span>
+    <span class="n">BuilderRadiusMixin</span><span class="p">,</span>
+    <span class="n">BuilderDensityMixin</span><span class="p">,</span>
+    <span class="n">BuilderConcentrationMixin</span><span class="p">,</span>
+    <span class="n">BuilderChargeMixin</span><span class="p">,</span>
+<span class="p">):</span>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="o">...</span>
+</code></pre></div>
+<h4 id="see-also">See also<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h4>
+<ul>
+<li><a href="../../abc_builder/#builderabc">BuilderABC</a></li>
+<li><a href="../../abc_builder/#builderactivitystrategymixin">BuilderActivityStrategyMixin</a></li>
+<li><a href="../../abc_builder/#builderchargemixin">BuilderChargeMixin</a></li>
+<li><a href="../../abc_builder/#builderconcentrationmixin">BuilderConcentrationMixin</a></li>
+<li><a href="../../abc_builder/#builderdensitymixin">BuilderDensityMixin</a></li>
+<li><a href="../../abc_builder/#builderdistributionstrategymixin">BuilderDistributionStrategyMixin</a></li>
+<li><a href="../../abc_builder/#builderradiusmixin">BuilderRadiusMixin</a></li>
+<li><a href="../../abc_builder/#buildersurfacestrategymixin">BuilderSurfaceStrategyMixin</a></li>
+</ul>
+<h3 id="lognormalparticlerepresentationbuilderbuild">LogNormalParticleRepresentationBuilder().build<a class="headerlink" href="#lognormalparticlerepresentationbuilderbuild" title="Permanent link">&para;</a></h3>
+<p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/particles/representation_builders.py#L200">Show source in representation_builders.py:200</a></p>
+<p>Validate and return the ParticleRepresentation object.</p>
+<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">&para;</a></h4>
+<p>The validated ParticleRepresentation object.</p>
+<h4 id="signature_1">Signature<a class="headerlink" href="#signature_1" title="Permanent link">&para;</a></h4>
+<div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">build</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ParticleRepresentation</span><span class="p">:</span> <span class="o">...</span>
+</code></pre></div>
+<h4 id="see-also_1">See also<a class="headerlink" href="#see-also_1" title="Permanent link">&para;</a></h4>
+<ul>
+<li><a href="../representation/#particlerepresentation">ParticleRepresentation</a></li>
+</ul>
 <h2 id="massparticlerepresentationbuilder">MassParticleRepresentationBuilder<a class="headerlink" href="#massparticlerepresentationbuilder" title="Permanent link">&para;</a></h2>
 <p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/particles/representation_builders.py#L31">Show source in representation_builders.py:31</a></p>
 <p>Builder class for ParticleRepresentation objects with mass-based bins.</p>
-<h4 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">&para;</a></h4>
+<h4 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">&para;</a></h4>
 <ul>
 <li><code>set_distribution_strategy(strategy)</code> - Set the DistributionStrategy.</li>
 <li><code>set_activity_strategy(strategy)</code> - Set the ActivityStrategy.</li>
@@ -6162,7 +6299,7 @@ <h4 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
     concentration of the particles. Default units are '/m**3'.</li>
 <li><code>set_charge(charge,</code> <em>charge_units)</em> - Set the number of charges.</li>
 </ul>
-<h4 id="signature">Signature<a class="headerlink" href="#signature" title="Permanent link">&para;</a></h4>
+<h4 id="signature_2">Signature<a class="headerlink" href="#signature_2" title="Permanent link">&para;</a></h4>
 <div class="highlight"><pre><span></span><code><span class="k">class</span> <span class="nc">MassParticleRepresentationBuilder</span><span class="p">(</span>
     <span class="n">BuilderABC</span><span class="p">,</span>
     <span class="n">BuilderDistributionStrategyMixin</span><span class="p">,</span>
@@ -6175,7 +6312,7 @@ <h4 id="signature">Signature<a class="headerlink" href="#signature" title="Perma
 <span class="p">):</span>
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="o">...</span>
 </code></pre></div>
-<h4 id="see-also">See also<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h4>
+<h4 id="see-also_2">See also<a class="headerlink" href="#see-also_2" title="Permanent link">&para;</a></h4>
 <ul>
 <li><a href="../../abc_builder/#builderabc">BuilderABC</a></li>
 <li><a href="../../abc_builder/#builderactivitystrategymixin">BuilderActivityStrategyMixin</a></li>
@@ -6189,19 +6326,19 @@ <h4 id="see-also">See also<a class="headerlink" href="#see-also" title="Permanen
 <h3 id="massparticlerepresentationbuilderbuild">MassParticleRepresentationBuilder().build<a class="headerlink" href="#massparticlerepresentationbuilderbuild" title="Permanent link">&para;</a></h3>
 <p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/particles/representation_builders.py#L75">Show source in representation_builders.py:75</a></p>
 <p>Validate and return the ParticleRepresentation object.</p>
-<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">&para;</a></h4>
+<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">&para;</a></h4>
 <p>The validated ParticleRepresentation object.</p>
-<h4 id="signature_1">Signature<a class="headerlink" href="#signature_1" title="Permanent link">&para;</a></h4>
+<h4 id="signature_3">Signature<a class="headerlink" href="#signature_3" title="Permanent link">&para;</a></h4>
 <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">build</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ParticleRepresentation</span><span class="p">:</span> <span class="o">...</span>
 </code></pre></div>
-<h4 id="see-also_1">See also<a class="headerlink" href="#see-also_1" title="Permanent link">&para;</a></h4>
+<h4 id="see-also_3">See also<a class="headerlink" href="#see-also_3" title="Permanent link">&para;</a></h4>
 <ul>
 <li><a href="../representation/#particlerepresentation">ParticleRepresentation</a></li>
 </ul>
 <h2 id="radiusparticlerepresentationbuilder">RadiusParticleRepresentationBuilder<a class="headerlink" href="#radiusparticlerepresentationbuilder" title="Permanent link">&para;</a></h2>
 <p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/particles/representation_builders.py#L93">Show source in representation_builders.py:93</a></p>
 <p>Builder class for ParticleRepresentation objects with radius-based bins.</p>
-<h4 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">&para;</a></h4>
+<h4 id="methods_2">Methods<a class="headerlink" href="#methods_2" title="Permanent link">&para;</a></h4>
 <ul>
 <li><code>set_distribution_strategy(strategy)</code> - Set the DistributionStrategy.</li>
 <li><code>set_activity_strategy(strategy)</code> - Set the ActivityStrategy.</li>
@@ -6214,7 +6351,7 @@ <h4 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permane
     concentration of the particles. Default units are '/m**3'.</li>
 <li><code>set_charge(charge,</code> <em>charge_units)</em> - Set the number of charges.</li>
 </ul>
-<h4 id="signature_2">Signature<a class="headerlink" href="#signature_2" title="Permanent link">&para;</a></h4>
+<h4 id="signature_4">Signature<a class="headerlink" href="#signature_4" title="Permanent link">&para;</a></h4>
 <div class="highlight"><pre><span></span><code><span class="k">class</span> <span class="nc">RadiusParticleRepresentationBuilder</span><span class="p">(</span>
     <span class="n">BuilderABC</span><span class="p">,</span>
     <span class="n">BuilderDistributionStrategyMixin</span><span class="p">,</span>
@@ -6227,7 +6364,7 @@ <h4 id="signature_2">Signature<a class="headerlink" href="#signature_2" title="P
 <span class="p">):</span>
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="o">...</span>
 </code></pre></div>
-<h4 id="see-also_2">See also<a class="headerlink" href="#see-also_2" title="Permanent link">&para;</a></h4>
+<h4 id="see-also_4">See also<a class="headerlink" href="#see-also_4" title="Permanent link">&para;</a></h4>
 <ul>
 <li><a href="../../abc_builder/#builderabc">BuilderABC</a></li>
 <li><a href="../../abc_builder/#builderactivitystrategymixin">BuilderActivityStrategyMixin</a></li>
@@ -6241,12 +6378,12 @@ <h4 id="see-also_2">See also<a class="headerlink" href="#see-also_2" title="Perm
 <h3 id="radiusparticlerepresentationbuilderbuild">RadiusParticleRepresentationBuilder().build<a class="headerlink" href="#radiusparticlerepresentationbuilderbuild" title="Permanent link">&para;</a></h3>
 <p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/particles/representation_builders.py#L137">Show source in representation_builders.py:137</a></p>
 <p>Validate and return the ParticleRepresentation object.</p>
-<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">&para;</a></h4>
+<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">&para;</a></h4>
 <p>The validated ParticleRepresentation object.</p>
-<h4 id="signature_3">Signature<a class="headerlink" href="#signature_3" title="Permanent link">&para;</a></h4>
+<h4 id="signature_5">Signature<a class="headerlink" href="#signature_5" title="Permanent link">&para;</a></h4>
 <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">build</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ParticleRepresentation</span><span class="p">:</span> <span class="o">...</span>
 </code></pre></div>
-<h4 id="see-also_3">See also<a class="headerlink" href="#see-also_3" title="Permanent link">&para;</a></h4>
+<h4 id="see-also_5">See also<a class="headerlink" href="#see-also_5" title="Permanent link">&para;</a></h4>
 <ul>
 <li><a href="../representation/#particlerepresentation">ParticleRepresentation</a></li>
 </ul>

diff --git a/...ode/particula/next/particles/representation_builders/representation_builders.md b/...ode/particula/next/particles/representation_builders/representation_builders.md
@@ -4,6 +4,75 @@
 
 > Auto-generated documentation for [particula.next.particles.representation_builders](https://github.com/Gorkowski/particula/blob/main/particula/next/particles/representation_builders.py) module.
 
+## LogNormalParticleRepresentationBuilder
+
+[Show source in representation_builders.py:155](https://github.com/Gorkowski/particula/blob/main/particula/next/particles/representation_builders.py#L155)
+
+Builder class for ParticleRepresentation objects with log-normal
+distribution.
+
+#### Methods
+
+- `set_distribution_strategy(strategy)` - Set the DistributionStrategy.
+- `set_activity_strategy(strategy)` - Set the ActivityStrategy.
+- `set_surface_strategy(strategy)` - Set the SurfaceStrategy.
+- `set_radius(radius,` *radius_units)* - Set the radius of the particles.
+    Default units are 'm'.
+- `set_density(density,` *density_units)* - Set the density of the particles.
+    Default units are 'kg/m**3'.
+- `set_concentration(concentration,` *concentration_units)* - Set the
+    concentration of the particles. Default units are '/m**3'.
+- `set_charge(charge,` *charge_units)* - Set the number of charges.
+
+#### Signature
+
+```python
+class LogNormalParticleRepresentationBuilder(
+    BuilderABC,
+    BuilderDistributionStrategyMixin,
+    BuilderActivityStrategyMixin,
+    BuilderSurfaceStrategyMixin,
+    BuilderRadiusMixin,
+    BuilderDensityMixin,
+    BuilderConcentrationMixin,
+    BuilderChargeMixin,
+):
+    def __init__(self): ...
+```
+
+#### See also
+
+- [BuilderABC](../abc_builder.md#builderabc)
+- [BuilderActivityStrategyMixin](../abc_builder.md#builderactivitystrategymixin)
+- [BuilderChargeMixin](../abc_builder.md#builderchargemixin)
+- [BuilderConcentrationMixin](../abc_builder.md#builderconcentrationmixin)
+- [BuilderDensityMixin](../abc_builder.md#builderdensitymixin)
+- [BuilderDistributionStrategyMixin](../abc_builder.md#builderdistributionstrategymixin)
+- [BuilderRadiusMixin](../abc_builder.md#builderradiusmixin)
+- [BuilderSurfaceStrategyMixin](../abc_builder.md#buildersurfacestrategymixin)
+
+### LogNormalParticleRepresentationBuilder().build
+
+[Show source in representation_builders.py:200](https://github.com/Gorkowski/particula/blob/main/particula/next/particles/representation_builders.py#L200)
+
+Validate and return the ParticleRepresentation object.
+
+#### Returns
+
+The validated ParticleRepresentation object.
+
+#### Signature
+
+```python
+def build(self) -> ParticleRepresentation: ...
+```
+
+#### See also
+
+- [ParticleRepresentation](./representation.md#particlerepresentation)
+
+
+
 ## MassParticleRepresentationBuilder
 
 [Show source in representation_builders.py:31](https://github.com/Gorkowski/particula/blob/main/particula/next/particles/representation_builders.py#L31)

diff --git a/pr-preview/pr-12/search/search_index.json b/pr-preview/pr-12/search/search_index.json