Skip to content

Commit

Permalink
Deploy preview for PR 13 🛫
Browse files Browse the repository at this point in the history
  • Loading branch information
Gorkowski committed Jun 6, 2024
1 parent 57d3de1 commit 1de1ef5
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6285,7 +6285,7 @@ <h1 id="species-builder">Species Builder<a class="headerlink" href="#species-bui
<p>Auto-generated documentation for <a href="https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py">particula.next.gas.species_builder</a> module.</p>
</blockquote>
<h2 id="gasspeciesbuilder">GasSpeciesBuilder<a class="headerlink" href="#gasspeciesbuilder" title="Permanent link">&para;</a></h2>
<p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L25">Show source in species_builder.py:25</a></p>
<p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L24">Show source in species_builder.py:24</a></p>
<p>Builder class for GasSpecies objects, allowing for a more fluent and
readable creation of GasSpecies instances with optional parameters.</p>
<h4 id="attributes">Attributes<a class="headerlink" href="#attributes" title="Permanent link">&para;</a></h4>
Expand Down Expand Up @@ -6333,7 +6333,7 @@ <h4 id="see-also">See also<a class="headerlink" href="#see-also" title="Permanen
<li><a href="../../abc_builder/#buildermolarmassmixin">BuilderMolarMassMixin</a></li>
</ul>
<h3 id="gasspeciesbuilderbuild">GasSpeciesBuilder().build<a class="headerlink" href="#gasspeciesbuilderbuild" title="Permanent link">&para;</a></h3>
<p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L99">Show source in species_builder.py:99</a></p>
<p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L98">Show source in species_builder.py:98</a></p>
<p>Validate and return the GasSpecies 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">GasSpecies</span><span class="p">:</span> <span class="o">...</span>
Expand All @@ -6343,19 +6343,19 @@ <h4 id="see-also_1">See also<a class="headerlink" href="#see-also_1" title="Perm
<li><a href="../species/#gasspecies">GasSpecies</a></li>
</ul>
<h3 id="gasspeciesbuilderset_condensable">GasSpeciesBuilder().set_condensable<a class="headerlink" href="#gasspeciesbuilderset_condensable" title="Permanent link">&para;</a></h3>
<p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L91">Show source in species_builder.py:91</a></p>
<p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L90">Show source in species_builder.py:90</a></p>
<p>Set the condensable bool of the gas species.</p>
<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">def</span> <span class="nf">set_condensable</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">condensable</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">bool_</span><span class="p">]]):</span> <span class="o">...</span>
</code></pre></div>
<h3 id="gasspeciesbuilderset_name">GasSpeciesBuilder().set_name<a class="headerlink" href="#gasspeciesbuilderset_name" title="Permanent link">&para;</a></h3>
<p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L78">Show source in species_builder.py:78</a></p>
<p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L77">Show source in species_builder.py:77</a></p>
<p>Set the name of the gas species.</p>
<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">set_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">str_</span><span class="p">]]):</span> <span class="o">...</span>
</code></pre></div>
<h3 id="gasspeciesbuilderset_vapor_pressure_strategy">GasSpeciesBuilder().set_vapor_pressure_strategy<a class="headerlink" href="#gasspeciesbuilderset_vapor_pressure_strategy" title="Permanent link">&para;</a></h3>
<p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L83">Show source in species_builder.py:83</a></p>
<p><a href="https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L82">Show source in species_builder.py:82</a></p>
<p>Set the vapor pressure strategy for the gas species.</p>
<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">def</span> <span class="nf">set_vapor_pressure_strategy</span><span class="p">(</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
## GasSpeciesBuilder

[Show source in species_builder.py:25](https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L25)
[Show source in species_builder.py:24](https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L24)

Builder class for GasSpecies objects, allowing for a more fluent and
readable creation of GasSpecies instances with optional parameters.
Expand Down Expand Up @@ -60,7 +60,7 @@ class GasSpeciesBuilder(BuilderABC, BuilderMolarMassMixin, BuilderConcentrationM

### GasSpeciesBuilder().build

[Show source in species_builder.py:99](https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L99)
[Show source in species_builder.py:98](https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L98)

Validate and return the GasSpecies object.

Expand All @@ -76,7 +76,7 @@ def build(self) -> GasSpecies: ...

### GasSpeciesBuilder().set_condensable

[Show source in species_builder.py:91](https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L91)
[Show source in species_builder.py:90](https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L90)

Set the condensable bool of the gas species.

Expand All @@ -88,7 +88,7 @@ def set_condensable(self, condensable: Union[bool, NDArray[np.bool_]]): ...

### GasSpeciesBuilder().set_name

[Show source in species_builder.py:78](https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L78)
[Show source in species_builder.py:77](https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L77)

Set the name of the gas species.

Expand All @@ -100,7 +100,7 @@ def set_name(self, name: Union[str, NDArray[np.str_]]): ...

### GasSpeciesBuilder().set_vapor_pressure_strategy

[Show source in species_builder.py:83](https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L83)
[Show source in species_builder.py:82](https://github.com/Gorkowski/particula/blob/main/particula/next/gas/species_builder.py#L82)

Set the vapor pressure strategy for the gas species.

Expand Down
2 changes: 1 addition & 1 deletion pr-preview/pr-13/search/search_index.json

Large diffs are not rendered by default.

0 comments on commit 1de1ef5

Please sign in to comment.