-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Vlasov1D1V docs update * ergoExo docs
- Loading branch information
Showing
4 changed files
with
63 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,6 +30,7 @@ Documentation | |
|
||
.. toctree:: | ||
usage | ||
solvers | ||
faq | ||
api | ||
:maxdepth: 1 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Available solvers | ||
================== | ||
|
||
The solvers that we have implemented so far are | ||
|
||
|
||
.. toctree:: | ||
solvers/vlasov1d1v | ||
:maxdepth: 1 | ||
:caption: Implemented solvers: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
Vlasov 1D1V | ||
----------------------------------------- | ||
|
||
Equations and Quantities | ||
======================== | ||
We solve the following coupled set of partial differential equations | ||
|
||
.. math:: | ||
\frac{\partial f}{\partial t} + v \frac{\partial f}{\partial x} + \frac{q}{m} (E + E_D) \frac{\partial f}{\partial v} &= \nu \partial_v (v f + v_0^2 \partial_v f) | ||
\partial_x E &= 1 - \int f dv | ||
where :math:`f` is the distribution function, :math:`E` is the electric field, :math:`C(f)` is the collision operator, :math:`q` is the charge, :math:`m` is the mass, and :math:`v` is the velocity. | ||
|
||
The distribution function is :math:`f = f(t, x, v)` and the electric field is :math:`E = E(t, x)` | ||
|
||
These simulations can be initialized via perturbing the distribution function or the electric field. | ||
The electric field can be "driven" using :math:`E_D` which is a user defined function of time and space. | ||
|
||
|
||
Solver Options | ||
================ | ||
This is where we should have a list of the different solvers that can be chosen including the collision operator. #TODO | ||
|
||
Configuration parameters | ||
======================== | ||
This is where there should be a line by line explanation of everything in a config file... #TODO |