From f77a2e961cf4d63ed522636bd4d9d9b2694cba2f Mon Sep 17 00:00:00 2001 From: GitHub CI Documentation builder Date: Tue, 11 Jun 2024 15:23:30 +0000 Subject: [PATCH] Update docs --- classDiffusiveNeutralSolver-members.html | 2 +- classDiffusiveNeutralSolver.html | 14 +++++++------- classDiffusiveNeutralSolver.js | 2 +- diffusiveneutralsolver_8hpp_source.html | 8 ++++---- navtreeindex1.js | 2 +- search/all_3.js | 2 +- search/functions_3.js | 2 +- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/classDiffusiveNeutralSolver-members.html b/classDiffusiveNeutralSolver-members.html index cae7d3ad0..0fdf7438c 100644 --- a/classDiffusiveNeutralSolver-members.html +++ b/classDiffusiveNeutralSolver-members.html @@ -106,7 +106,7 @@

This is the complete list of members for DiffusiveNeutralSolver, including all inherited members.

- + diff --git a/classDiffusiveNeutralSolver.html b/classDiffusiveNeutralSolver.html index 8ff3f7e97..c1f00adce 100644 --- a/classDiffusiveNeutralSolver.html +++ b/classDiffusiveNeutralSolver.html @@ -121,9 +121,9 @@
DiffusiveNeutralSolver(IReactionRate const &chargexchange, IReactionRate const &ionization, IReactionRate const &recombination, double const temperature, double const normalization_coeff, SplineXBuilder_1d const &spline_x_builder, SplineXEvaluator_1d const &spline_x_evaluator, DViewVx const &quadrature_coeffs)DiffusiveNeutralSolver
DiffusiveNeutralSolver(IReactionRate const &charge_exchange, IReactionRate const &ionization, IReactionRate const &recombination, double const temperature, double const normalization_coeff, SplineXBuilder_1d const &spline_x_builder, SplineXEvaluator_1d const &spline_x_evaluator, DViewVx const &quadrature_coeffs)DiffusiveNeutralSolver
get_derivative(DSpanSpMX dn, DViewSpMX n, DViewSpX density, DViewSpX velocity, DViewSpX temperature) constDiffusiveNeutralSolver
operator()(DSpanSpMX neutrals, DViewSpXVx allfdistribu, DViewX efield, double dt) const overrideDiffusiveNeutralSolvervirtual
~DiffusiveNeutralSolver() override=default (defined in DiffusiveNeutralSolver)DiffusiveNeutralSolver
- - - + + + @@ -157,8 +157,8 @@

Where \(\alpha_0\) is a normalization coefficient equal to \(\alpha_0 = \omega_{pe0}/(n_0 K_0)\). All the terms that appear in this normalized equation keep the same expression as when writing the dimensional form of the model, except that quantities involved are normalized.

The pressure-diffusive model is solved using a RK2 time integrator. Spatial derivatives are computed using splines polynomials.

Constructor & Destructor Documentation

- -

◆ DiffusiveNeutralSolver()

+ +

◆ DiffusiveNeutralSolver()

@@ -167,7 +167,7 @@

DiffusiveNeutralSolver::DiffusiveNeutralSolver

- + @@ -222,7 +222,7 @@

DiffusiveNeutralSolver class.

Parameters

Public Member Functions

 DiffusiveNeutralSolver (IReactionRate const &chargexchange, IReactionRate const &ionization, IReactionRate const &recombination, double const temperature, double const normalization_coeff, SplineXBuilder_1d const &spline_x_builder, SplineXEvaluator_1d const &spline_x_evaluator, DViewVx const &quadrature_coeffs)
 Creates an instance of the DiffusiveNeutralSolver class. More...
 
 DiffusiveNeutralSolver (IReactionRate const &charge_exchange, IReactionRate const &ionization, IReactionRate const &recombination, double const temperature, double const normalization_coeff, SplineXBuilder_1d const &spline_x_builder, SplineXEvaluator_1d const &spline_x_evaluator, DViewVx const &quadrature_coeffs)
 Creates an instance of the DiffusiveNeutralSolver class. More...
 
DSpanSpMX operator() (DSpanSpMX neutrals, DViewSpXVx allfdistribu, DViewX efield, double dt) const override
 Updates the neutral fluid moments according to the pressure-diffusive neutral model. More...
 
( IReactionRate const & chargexchange, charge_exchange,
- + diff --git a/classDiffusiveNeutralSolver.js b/classDiffusiveNeutralSolver.js index bed9aaaf6..7992fd139 100644 --- a/classDiffusiveNeutralSolver.js +++ b/classDiffusiveNeutralSolver.js @@ -1,6 +1,6 @@ var classDiffusiveNeutralSolver = [ - [ "DiffusiveNeutralSolver", "classDiffusiveNeutralSolver.html#a4e8da82c0223e1338581b8e0889c7644", null ], + [ "DiffusiveNeutralSolver", "classDiffusiveNeutralSolver.html#a59c3999309be8830fd85c7e1c4ef0aac", null ], [ "~DiffusiveNeutralSolver", "classDiffusiveNeutralSolver.html#af85115e532382e213d94d67cba76b058", null ], [ "operator()", "classDiffusiveNeutralSolver.html#abfa7ed6b9809fc0338cd689b7d8dd37e", null ], [ "get_derivative", "classDiffusiveNeutralSolver.html#ae5ebfe3292a4555f0c0df1cdd2a0fa6a", null ] diff --git a/diffusiveneutralsolver_8hpp_source.html b/diffusiveneutralsolver_8hpp_source.html index f3993a262..e94ab0818 100644 --- a/diffusiveneutralsolver_8hpp_source.html +++ b/diffusiveneutralsolver_8hpp_source.html @@ -116,7 +116,7 @@
60 class DiffusiveNeutralSolver : public IFluidSolver
61 {
62 private:
-
63  IReactionRate const& m_chargexchange;
+
63  IReactionRate const& m_charge_exchange;
64  IReactionRate const& m_ionization;
65  IReactionRate const& m_recombination;
66 
@@ -131,8 +131,8 @@
75  IndexSp find_ion(IDomainSp const dom_kinsp) const;
76 
77 public:
-
89  DiffusiveNeutralSolver(
-
90  IReactionRate const& chargexchange,
+
89  DiffusiveNeutralSolver(
+
90  IReactionRate const& charge_exchange,
91  IReactionRate const& ionization,
92  IReactionRate const& recombination,
93  double const temperature,
@@ -154,7 +154,7 @@
138  DViewSpX temperature) const;
139 };
DiffusiveNeutralSolver
A class that solves a so-called "pressure-diffusive" fluid neutral model.
Definition: diffusiveneutralsolver.hpp:61
-
DiffusiveNeutralSolver::DiffusiveNeutralSolver
DiffusiveNeutralSolver(IReactionRate const &chargexchange, IReactionRate const &ionization, IReactionRate const &recombination, double const temperature, double const normalization_coeff, SplineXBuilder_1d const &spline_x_builder, SplineXEvaluator_1d const &spline_x_evaluator, DViewVx const &quadrature_coeffs)
Creates an instance of the DiffusiveNeutralSolver class.
+
DiffusiveNeutralSolver::DiffusiveNeutralSolver
DiffusiveNeutralSolver(IReactionRate const &charge_exchange, IReactionRate const &ionization, IReactionRate const &recombination, double const temperature, double const normalization_coeff, SplineXBuilder_1d const &spline_x_builder, SplineXEvaluator_1d const &spline_x_evaluator, DViewVx const &quadrature_coeffs)
Creates an instance of the DiffusiveNeutralSolver class.
DiffusiveNeutralSolver::operator()
DSpanSpMX operator()(DSpanSpMX neutrals, DViewSpXVx allfdistribu, DViewX efield, double dt) const override
Updates the neutral fluid moments according to the pressure-diffusive neutral model.
DiffusiveNeutralSolver::get_derivative
void get_derivative(DSpanSpMX dn, DViewSpMX n, DViewSpX density, DViewSpX velocity, DViewSpX temperature) const
Computes the expression of the time derivative of the neutral fluid moments.
IFluidSolver
An abstract class for solving a fluid model.
Definition: ifluidsolver.hpp:11
diff --git a/navtreeindex1.js b/navtreeindex1.js index c0f2b6a1b..45b5d876c 100644 --- a/navtreeindex1.js +++ b/navtreeindex1.js @@ -65,7 +65,7 @@ var NAVTREEINDEX1 = "classDecentredRotationSimulation.html":[16,46], "classDecentredRotationSimulation.html#a94d97e6be53cae16d5458fd5c05e46e8":[16,46,0], "classDiffusiveNeutralSolver.html":[16,47], -"classDiffusiveNeutralSolver.html#a4e8da82c0223e1338581b8e0889c7644":[16,47,0], +"classDiffusiveNeutralSolver.html#a59c3999309be8830fd85c7e1c4ef0aac":[16,47,0], "classDiffusiveNeutralSolver.html#abfa7ed6b9809fc0338cd689b7d8dd37e":[16,47,2], "classDiffusiveNeutralSolver.html#ae5ebfe3292a4555f0c0df1cdd2a0fa6a":[16,47,3], "classDiffusiveNeutralSolver.html#af85115e532382e213d94d67cba76b058":[16,47,1], diff --git a/search/all_3.js b/search/all_3.js index c89131d56..fdec491ad 100644 --- a/search/all_3.js +++ b/search/all_3.js @@ -9,7 +9,7 @@ var searchData= ['deriv_5fdim_5f2_112',['deriv_dim_2',['../classPolarSplineEvaluator.html#af5de8a13917331a541a20a989b1564a0',1,'PolarSplineEvaluator::deriv_dim_2(ddc::ChunkSpan< double, Domain > const spline_eval, ddc::ChunkSpan< ddc::Coordinate< DimR, DimP > const, Domain > const coords_eval, PolarSplineView< PolarBSplinesType > const spline_coef) const'],['../classPolarSplineEvaluator.html#ab1d9832c70778fabd91dcf990a481001',1,'PolarSplineEvaluator::deriv_dim_2(ddc::Coordinate< DimR, DimP > coord_eval, PolarSplineView< PolarBSplinesType > const spline_coef) const']]], ['derivative_5fx_113',['derivative_x',['../classCartesianSolution.html#a451cd0cae3b100165ad5e7850f0572a8',1,'CartesianSolution']]], ['derivative_5fy_114',['derivative_y',['../classCartesianSolution.html#a6b7df1d82066dec5c620bddb7369e969',1,'CartesianSolution']]], - ['diffusiveneutralsolver_115',['DiffusiveNeutralSolver',['../classDiffusiveNeutralSolver.html#a4e8da82c0223e1338581b8e0889c7644',1,'DiffusiveNeutralSolver::DiffusiveNeutralSolver()'],['../classDiffusiveNeutralSolver.html',1,'DiffusiveNeutralSolver']]], + ['diffusiveneutralsolver_115',['DiffusiveNeutralSolver',['../classDiffusiveNeutralSolver.html#a59c3999309be8830fd85c7e1c4ef0aac',1,'DiffusiveNeutralSolver::DiffusiveNeutralSolver()'],['../classDiffusiveNeutralSolver.html',1,'DiffusiveNeutralSolver']]], ['dimp_116',['DimP',['../classPolarBSplines.html#a07b201e46fe1f666019ca6a9f85b5c1a',1,'PolarBSplines::DimP()'],['../classPolarSplineEvaluator.html#add8585efe107f2cb0e91a765d71f68ec',1,'PolarSplineEvaluator::DimP()']]], ['dimr_117',['DimR',['../classPolarBSplines.html#a36f25fbe8494742d19c56b2940498c8d',1,'PolarBSplines::DimR()'],['../classPolarSplineEvaluator.html#aaccc486ada502c4b48ab55b683c2cbb7',1,'PolarSplineEvaluator::DimR()']]], ['dimx_5fpc_118',['DimX_pC',['../structDimX__pC.html',1,'']]], diff --git a/search/functions_3.js b/search/functions_3.js index fb723b5fc..7bc3cd83a 100644 --- a/search/functions_3.js +++ b/search/functions_3.js @@ -9,7 +9,7 @@ var searchData= ['deriv_5fdim_5f2_854',['deriv_dim_2',['../classPolarSplineEvaluator.html#ab1d9832c70778fabd91dcf990a481001',1,'PolarSplineEvaluator::deriv_dim_2(ddc::Coordinate< DimR, DimP > coord_eval, PolarSplineView< PolarBSplinesType > const spline_coef) const'],['../classPolarSplineEvaluator.html#af5de8a13917331a541a20a989b1564a0',1,'PolarSplineEvaluator::deriv_dim_2(ddc::ChunkSpan< double, Domain > const spline_eval, ddc::ChunkSpan< ddc::Coordinate< DimR, DimP > const, Domain > const coords_eval, PolarSplineView< PolarBSplinesType > const spline_coef) const']]], ['derivative_5fx_855',['derivative_x',['../classCartesianSolution.html#a451cd0cae3b100165ad5e7850f0572a8',1,'CartesianSolution']]], ['derivative_5fy_856',['derivative_y',['../classCartesianSolution.html#a6b7df1d82066dec5c620bddb7369e969',1,'CartesianSolution']]], - ['diffusiveneutralsolver_857',['DiffusiveNeutralSolver',['../classDiffusiveNeutralSolver.html#a4e8da82c0223e1338581b8e0889c7644',1,'DiffusiveNeutralSolver']]], + ['diffusiveneutralsolver_857',['DiffusiveNeutralSolver',['../classDiffusiveNeutralSolver.html#a59c3999309be8830fd85c7e1c4ef0aac',1,'DiffusiveNeutralSolver']]], ['diocotrondensitysolution_858',['DiocotronDensitySolution',['../classDiocotronDensitySolution.html#a241c1b873cf5fd34a13d79a149fa5734',1,'DiocotronDensitySolution']]], ['discretetocartesian_859',['DiscreteToCartesian',['../classDiscreteToCartesian.html#aab258ec1dcafc8ee5e162daa5c0ee756',1,'DiscreteToCartesian']]], ['display_5ftime_5fdifference_860',['display_time_difference',['../classITimeSolverRP.html#aa9b8aa593b80793bd9b8586a6c50dd2a',1,'ITimeSolverRP']]]
[in]chargexchangeAn object that represents charge-exchange reaction rate.
[in]charge_exchangeAn object that represents charge-exchange reaction rate.
[in]ionizationAn object that represents ionization reaction rate.
[in]recombinationAn object that represents recombination reaction rate.
[in]temperatureThe constant temperature of neutrals.