Skip to content

Commit

Permalink
Merge pull request #153 from AlbertoCuadra/develop
Browse files Browse the repository at this point in the history
Update: include summary
  • Loading branch information
AlbertoCuadra authored Feb 7, 2024
2 parents bca2fa3 + 7aa8b41 commit 0ced392
Show file tree
Hide file tree
Showing 68 changed files with 176 additions and 1 deletion.
Binary file modified docs/build/html/.doctrees/documentation/api/gui/index.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/documentation/api/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/html/.doctrees/documentation/api/utils/index.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/documentation/databases.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/html/.doctrees/examples.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/examples/examples_gui.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/examples/examples_plain.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/examples/examples_plain_DET.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/html/.doctrees/examples/examples_plain_DET_R.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/html/.doctrees/examples/examples_plain_EV.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/html/.doctrees/examples/examples_plain_HP.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/html/.doctrees/examples/examples_plain_SHOCK_I.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/html/.doctrees/examples/examples_plain_SHOCK_R.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/examples/examples_plain_SP.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/examples/examples_plain_SV.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/html/.doctrees/examples/examples_plain_TP.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/examples/examples_plain_TV.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/front_matter/copyright.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/home.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/index_latex.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/install.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/publications.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/references.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/tutorials.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/tutorials/0_basics.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/html/.doctrees/tutorials/basics/basics_1.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/tutorials/basics/basics_2.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/tutorials/basics/basics_3.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/tutorials/basics/basics_4.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/html/.doctrees/validations.doctree
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -256,5 +256,65 @@ This section is under development. Stay tuned!

```````

## Summary

`````{tab-set}

````{tab-item} Individual study

```matlab
% Initialize CT and define chemical system
self = App('Soot formation');

% Define initial chemical composition
self.PD.S_Fuel = {'CH4'};
self.PD.S_Oxidizer = {'N2', 'O2'};
self.PD.ratio_oxidizers_O2 = [79, 21]/21;
self = set_prop(self, 'phi', 1);

% Define initial thermochemical state
self = set_prop(self, 'TR', 300, 'pR', 1 * 1.01325);

% Set chemical transformation
self = set_prop(self, 'pP', self.PD.pR.value, 'TP', 3000);

% Perform chemical calculations
self = solve_problem(self, 'TP');


```

````

````{tab-item} Parametric study

```matlab
% Initialize CT and define chemical system
self = App('Soot formation');

% Define initial chemical composition
self.PD.S_Fuel = {'CH4'};
self.PD.S_Oxidizer = {'N2', 'O2'};
self.PD.ratio_oxidizers_O2 = [79, 21]/21;
self = set_prop(self, 'phi', 0.5:0.01:4);

% Define initial thermochemical state
self = set_prop(self, 'TR', 300, 'pR', 1 * 1.01325);

% Set chemical transformation
self = set_prop(self, 'pP', self.PD.pR.value, 'TP', 3000);

% Perform chemical calculations
self = solve_problem(self, 'TP');

% Postprocess results
post_results(self);
```

````

`````


## Congratulations!
Congratulations you have finished the Combustion Toolbox MATLAB tutorial! You should now be ready to begin using the Combustion Toolbox on your own (see the `examples` folder).
Binary file modified docs/build/html/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -608,6 +608,60 @@ <h2>Postprocessed results (predefined plots for several cases)<a class="headerli
</div>
</div>
</section>
<section id="summary">
<h2>Summary<a class="headerlink" href="#summary" title="Permalink to this heading">#</a></h2>
<div class="sd-tab-set docutils">
<input checked="checked" id="sd-tab-item-18" name="sd-tab-set-9" type="radio">
</input><label class="sd-tab-label" for="sd-tab-item-18">
Individual study</label><div class="sd-tab-content docutils">
<div class="highlight-matlab notranslate"><div class="highlight"><pre><span></span><span class="c">% Initialize CT and define chemical system</span><span class="w"></span>
<span class="n">self</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">App</span><span class="p">(</span><span class="s">&#39;Soot formation&#39;</span><span class="p">);</span><span class="w"></span>

<span class="c">% Define initial chemical composition</span><span class="w"></span>
<span class="n">self</span><span class="p">.</span><span class="n">PD</span><span class="p">.</span><span class="n">S_Fuel</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">{</span><span class="s">&#39;CH4&#39;</span><span class="p">};</span><span class="w"></span>
<span class="n">self</span><span class="p">.</span><span class="n">PD</span><span class="p">.</span><span class="n">S_Oxidizer</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">{</span><span class="s">&#39;N2&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;O2&#39;</span><span class="p">};</span><span class="w"></span>
<span class="n">self</span><span class="p">.</span><span class="n">PD</span><span class="p">.</span><span class="n">ratio_oxidizers_O2</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">[</span><span class="mi">79</span><span class="p">,</span><span class="w"> </span><span class="mi">21</span><span class="p">]</span><span class="o">/</span><span class="mi">21</span><span class="p">;</span><span class="w"></span>
<span class="n">self</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">set_prop</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;phi&#39;</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p">);</span><span class="w"></span>

<span class="c">% Define initial thermochemical state</span><span class="w"></span>
<span class="n">self</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">set_prop</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;TR&#39;</span><span class="p">,</span><span class="w"> </span><span class="mi">300</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;pR&#39;</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="mf">1.01325</span><span class="p">);</span><span class="w"></span>

<span class="c">% Set chemical transformation</span><span class="w"></span>
<span class="n">self</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">set_prop</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;pP&#39;</span><span class="p">,</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">PD</span><span class="p">.</span><span class="n">pR</span><span class="p">.</span><span class="n">value</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;TP&#39;</span><span class="p">,</span><span class="w"> </span><span class="mi">3000</span><span class="p">);</span><span class="w"></span>

<span class="c">% Perform chemical calculations</span><span class="w"></span>
<span class="n">self</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">solve_problem</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;TP&#39;</span><span class="p">);</span><span class="w"></span>
</pre></div>
</div>
</div>
<input id="sd-tab-item-19" name="sd-tab-set-9" type="radio">
</input><label class="sd-tab-label" for="sd-tab-item-19">
Parametric study</label><div class="sd-tab-content docutils">
<div class="highlight-matlab notranslate"><div class="highlight"><pre><span></span><span class="c">% Initialize CT and define chemical system</span><span class="w"></span>
<span class="n">self</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">App</span><span class="p">(</span><span class="s">&#39;Soot formation&#39;</span><span class="p">);</span><span class="w"></span>

<span class="c">% Define initial chemical composition</span><span class="w"></span>
<span class="n">self</span><span class="p">.</span><span class="n">PD</span><span class="p">.</span><span class="n">S_Fuel</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">{</span><span class="s">&#39;CH4&#39;</span><span class="p">};</span><span class="w"></span>
<span class="n">self</span><span class="p">.</span><span class="n">PD</span><span class="p">.</span><span class="n">S_Oxidizer</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">{</span><span class="s">&#39;N2&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;O2&#39;</span><span class="p">};</span><span class="w"></span>
<span class="n">self</span><span class="p">.</span><span class="n">PD</span><span class="p">.</span><span class="n">ratio_oxidizers_O2</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">[</span><span class="mi">79</span><span class="p">,</span><span class="w"> </span><span class="mi">21</span><span class="p">]</span><span class="o">/</span><span class="mi">21</span><span class="p">;</span><span class="w"></span>
<span class="n">self</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">set_prop</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;phi&#39;</span><span class="p">,</span><span class="w"> </span><span class="mf">0.5</span><span class="p">:</span><span class="mf">0.01</span><span class="p">:</span><span class="mi">4</span><span class="p">);</span><span class="w"></span>

<span class="c">% Define initial thermochemical state</span><span class="w"></span>
<span class="n">self</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">set_prop</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;TR&#39;</span><span class="p">,</span><span class="w"> </span><span class="mi">300</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;pR&#39;</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="mf">1.01325</span><span class="p">);</span><span class="w"></span>

<span class="c">% Set chemical transformation</span><span class="w"></span>
<span class="n">self</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">set_prop</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;pP&#39;</span><span class="p">,</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">PD</span><span class="p">.</span><span class="n">pR</span><span class="p">.</span><span class="n">value</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;TP&#39;</span><span class="p">,</span><span class="w"> </span><span class="mi">3000</span><span class="p">);</span><span class="w"></span>

<span class="c">% Perform chemical calculations</span><span class="w"></span>
<span class="n">self</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">solve_problem</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;TP&#39;</span><span class="p">);</span><span class="w"></span>

<span class="c">% Postprocess results</span><span class="w"></span>
<span class="n">post_results</span><span class="p">(</span><span class="n">self</span><span class="p">);</span><span class="w"></span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="congratulations">
<h2>Congratulations!<a class="headerlink" href="#congratulations" title="Permalink to this heading">#</a></h2>
<p>Congratulations you have finished the Combustion Toolbox MATLAB tutorial! You should now be ready to begin using the Combustion Toolbox on your own (see the <code class="docutils literal notranslate"><span class="pre">examples</span></code> folder).</p>
Expand Down Expand Up @@ -689,6 +743,7 @@ <h2>Congratulations!<a class="headerlink" href="#congratulations" title="Permali
<li><a class="reference internal" href="#perform-chemical-calculations">Perform chemical calculations</a></li>
<li><a class="reference internal" href="#results">Results</a></li>
<li><a class="reference internal" href="#postprocessed-results-predefined-plots-for-several-cases">Postprocessed results (predefined plots for several cases)</a></li>
<li><a class="reference internal" href="#summary">Summary</a></li>
<li><a class="reference internal" href="#congratulations">Congratulations!</a></li>
</ul>
</li>
Expand Down
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -256,5 +256,65 @@ This section is under development. Stay tuned!
```````

## Summary

`````{tab-set}
````{tab-item} Individual study
```matlab
% Initialize CT and define chemical system
self = App('Soot formation');
% Define initial chemical composition
self.PD.S_Fuel = {'CH4'};
self.PD.S_Oxidizer = {'N2', 'O2'};
self.PD.ratio_oxidizers_O2 = [79, 21]/21;
self = set_prop(self, 'phi', 1);
% Define initial thermochemical state
self = set_prop(self, 'TR', 300, 'pR', 1 * 1.01325);
% Set chemical transformation
self = set_prop(self, 'pP', self.PD.pR.value, 'TP', 3000);
% Perform chemical calculations
self = solve_problem(self, 'TP');
```
````
````{tab-item} Parametric study
```matlab
% Initialize CT and define chemical system
self = App('Soot formation');
% Define initial chemical composition
self.PD.S_Fuel = {'CH4'};
self.PD.S_Oxidizer = {'N2', 'O2'};
self.PD.ratio_oxidizers_O2 = [79, 21]/21;
self = set_prop(self, 'phi', 0.5:0.01:4);
% Define initial thermochemical state
self = set_prop(self, 'TR', 300, 'pR', 1 * 1.01325);
% Set chemical transformation
self = set_prop(self, 'pP', self.PD.pR.value, 'TP', 3000);
% Perform chemical calculations
self = solve_problem(self, 'TP');
% Postprocess results
post_results(self);
```
````
`````


## Congratulations!
Congratulations you have finished the Combustion Toolbox MATLAB tutorial! You should now be ready to begin using the Combustion Toolbox on your own (see the `examples` folder).

0 comments on commit 0ced392

Please sign in to comment.