Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub CI Documentation builder committed Nov 24, 2023
1 parent 0724275 commit 987d348
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 2 deletions.
1 change: 1 addition & 0 deletions navtreedata.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ var NAVTREE =
[ "Description", "simulations_geometryXVx_sheath.html#Description", null ],
[ "Usage", "simulations_geometryXVx_sheath.html#Usage", null ],
[ "Recommended parameters", "simulations_geometryXVx_sheath.html#Recommended_parameters", null ],
[ "Verification of the simulation", "simulations_geometryXVx_sheath.html#Verification_of_the_simulation", null ],
[ "References", "simulations_geometryXVx_sheath.html#References", null ]
] ],
[ "Gyselalib++ contents", "src.html", "src" ],
Expand Down
2 changes: 1 addition & 1 deletion navtreeindex1.js
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,8 @@ var NAVTREEINDEX1 =
"classIPoissonSolver.html":[12,64],
"classIPoissonSolver.html#a2819621d345ddde4acad30a47c8fd7f9":[12,64,4],
"classIPoissonSolver.html#a2e07de086727dd87d194d5132517e8a5":[12,64,3],
"classIPoissonSolver.html#a92e67d73a6fdaeab87feeeaa11821de9":[12,64,1],
"classIPoissonSolver.html#a92e67d73a6fdaeab87feeeaa11821de9":[12,64,0],
"classIPoissonSolver.html#a92e67d73a6fdaeab87feeeaa11821de9":[12,64,1],
"classIPoissonSolver.html#a92e67d73a6fdaeab87feeeaa11821de9":[12,64,2],
"classIPoissonSolver.html#acc648976a27e0b36daf0615d7b8eebd6":[12,64,5],
"classIPreallocatableInterpolator.html":[12,65],
Expand Down
3 changes: 2 additions & 1 deletion navtreeindex5.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ var NAVTREEINDEX5 =
"simulations_geometryXVx_sheath.html":[7],
"simulations_geometryXVx_sheath.html#Description":[7,0],
"simulations_geometryXVx_sheath.html#Recommended_parameters":[7,2],
"simulations_geometryXVx_sheath.html#References":[7,3],
"simulations_geometryXVx_sheath.html#References":[7,4],
"simulations_geometryXVx_sheath.html#Usage":[7,1],
"simulations_geometryXVx_sheath.html#Verification_of_the_simulation":[7,3],
"species__info_8hpp_source.html":[13,0,7,0],
"spline__1d_8hpp_source.html":[13,2,0,0,0,5,4],
"spline__2d_8hpp_source.html":[13,2,0,0,0,5,5],
Expand Down
6 changes: 6 additions & 0 deletions simulations_geometryXVx_sheath.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,12 @@ <h1><a class="anchor" id="Recommended_parameters"></a>
<li>the default parameter given in <code>sheath.yaml.hpp</code>. This cas corresponds to a very light simulation case that runs a few iterations for testing purposes. This is the set of parameters that can be retrieved with the <code>--dump-config</code> command.</li>
<li>the parameters given in the folder <code>ref_simulation</code>, in the <code>sheath_ref.yaml</code> file. This simulation presents a glimpse of the plasma-wall interaction physics that can be seen on the figures in the mentioned folder: formation of a positively charged layer in front of the wall region, accompanied by a drop of the electric potential that confines fast electrons. A particle flux going towards the wall exists in the plasma. With the number of iterations performed to obtain these figures, the system is not at steady state. To observe a steady state plasma-wall interaction with interesting physical features (supersonic flow of ions, truncation of fast velocity electrons, etc.) see the paramerers of [2].</li>
</ul>
<h1><a class="anchor" id="Verification_of_the_simulation"></a>
Verification of the simulation</h1>
<p>The accuracy of the physical results from a sheath simulation can be verified as follows. The simulation should be run with the parameters given in <code>sheath.yaml.hpp</code> file. Then, any conservation diagnostic can be used to test the accuracy of the results. For instance, a post-process script that breaks down the terms present in the equation of energy conservation is <code>post-process/PythonScripts/geometryXVx/sheath/plot_conservation_energy</code>. This script can be run as an executable in the folder containing the simulation results. In the simple XVx geometry The equation of energy conservation is written as</p>
<p>\(\partial_t \Pi_a + 1/\sqrt{A_a}\, \partial_x Q_a - 2\Gamma_a q_a E/\sqrt{A_a} = S_{e}\) <br />
</p>
<p>Where \(\Gamma_a\), \(\Pi_a\) and \(Q_a\) stand for the particle flux, momentum flux and energy flux of species \(a\) (typically ions or electrons) respectively. These quantity are computed by the script using the distribution function of each species which is an output of the code. \(A_a = m_e/m_a\) is the mass ratio of species \(a\), and \(q_a\) represents its charge ( \(+e\) for ions, \(-e\) for electrons with \(e\) the elementary charge). \(E\) is the electric field, and \(S_{e}\) the energy source term. The script plots all of the terms that appear in the energy conservation equation, along with the error (denoted as <code>lhs-rhs</code>) defined as being the left-hand-side term minus the right-hand-side terms, i.e. \(lhs-rhs = \partial_t \Pi_a + 1/\sqrt{A_a}\, \partial_x Q_a - 2\Gamma_a q_a E/\sqrt{A_a} - S_{e}\). This error term is plotted as well, and thus a simulation can be verified by ensuring that this error remains small as compared to the other terms. It is recommended to look at the conservation equation for electrons first, since as the lightest species, the numerical error is larger. The script also produces a 2D map of the error as a function of time and space. One shall note that in order to compute the time derivative term \(\partial_t \Pi_a\), it is important to save all of the timesteps of the simulations, i.e. the parameters <code>time_diag</code> and <code>deltat</code> should be equal, as in the <code>sheath.yaml.hpp</code> file. Lastly, if one wishes to test a simulation that is faster, the number of iterations can be reduced to 10 for instance. The folder <code>conservation_plots</code> contains the graphs of the conservation equations computed using a simulation with the parameters of the <code>sheath.yaml.hpp</code> file.</p>
<h1><a class="anchor" id="References"></a>
References</h1>
<ul>
Expand Down

0 comments on commit 987d348

Please sign in to comment.