Skip to content

Commit

Permalink
Update theory section layout initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
roelof-groenewald committed Sep 13, 2024
1 parent be50f9b commit 2e1b867
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 20 deletions.
28 changes: 11 additions & 17 deletions Docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ We also have a `discussion page <https://github.com/ECP-WarpX/WarpX/discussions>
/* front page: hide chapter titles
* needed for consistent HTML-PDF-EPUB chapters
*/
section#theory,
section#installation,
section#usage,
section#theory,
section#data-analysis,
section#development,
section#maintenance,
Expand All @@ -54,6 +54,16 @@ We also have a `discussion page <https://github.com/ECP-WarpX/WarpX/discussions>
acknowledge_us
highlights

Theory
------
.. toctree::
:titlesonly:
:caption: THEORY
:maxdepth: 1
:hidden:

theory/intro

Installation
------------
.. toctree::
Expand Down Expand Up @@ -99,22 +109,6 @@ Data Analysis
dataanalysis/reduced_diags
dataanalysis/workflows

Theory
------
.. toctree::
:caption: THEORY
:maxdepth: 1
:hidden:

theory/intro
theory/pic
theory/amr
theory/boundary_conditions
theory/boosted_frame
theory/multiphysics_extensions
theory/kinetic_fluid_hybrid_model
theory/cold_fluid_model

Development
-----------
.. toctree::
Expand Down
51 changes: 48 additions & 3 deletions Docs/source/theory/intro.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.. _theory:

Introduction
============
Models & Algorithms
===================

.. figure:: Plasma_acceleration_sim.png
:alt: Plasma laser-driven (top) and charged-particles-driven (bottom) acceleration (rendering from 3-D Particle-In-Cell simulations). A laser beam (red and blue disks in top picture) or a charged particle beam (red dots in bottom picture) propagating (from left to right) through an under-dense plasma (not represented) displaces electrons, creating a plasma wakefield that supports very high electric fields (pale blue and yellow). These electric fields, which can be orders of magnitude larger than with conventional techniques, can be used to accelerate a short charged particle beam (white) to high-energy over a very short distance.
:alt: Plasma acceleration diagram

Plasma laser-driven (top) and charged-particles-driven (bottom) acceleration (rendering from 3-D Particle-In-Cell simulations). A laser beam (red and blue disks in top picture) or a charged particle beam (red dots in bottom picture) propagating (from left to right) through an under-dense plasma (not represented) displaces electrons, creating a plasma wakefield that supports very high electric fields (pale blue and yellow). These electric fields, which can be orders of magnitude larger than with conventional techniques, can be used to accelerate a short charged particle beam (white) to high-energy over a very short distance.

Expand All @@ -19,5 +19,50 @@ Various techniques or reduced models have been developed to allow multidimension
ponderomotive guiding center (PGC) models :cite:p:`i-Antonsenprl1992,i-Krallpre1993,i-Quickpic,i-Benedettiaac2010,i-Cowanjcp11`, simulation in an optimal Lorentz boosted frame :cite:p:`i-Vayprl07,i-Bruhwileraac08,i-Vayscidac09,i-Vaypac09,i-Martinspac09,i-VayAAC2010,i-Martinsnaturephysics10,i-Martinspop10,i-Martinscpc10,i-Vayjcp2011,i-VayPOPL2011,i-Vaypop2011,i-Yu2016`,
expanding the fields into a truncated series of azimuthal modes :cite:p:`i-godfrey1985iprop,i-LifschitzJCP2009,i-DavidsonJCP2015,i-Lehe2016,i-AndriyashPoP2016`, fluid approximation :cite:p:`i-Krallpre1993,i-Shadwickpop09,i-Benedettiaac2010` and scaled parameters :cite:p:`i-Cormieraac08,i-Geddespac09`.

Field Solvers
-------------

.. toctree::
:maxdepth: 1

pic
kinetic_fluid_hybrid_model

Grid & Geometries
-----------------

Boundary Conditions
-------------------

.. toctree::
:maxdepth: 1

boundary_conditions

Species Representations
-----------------------

.. toctree::
:maxdepth: 1

cold_fluid_model

Multiphysics Processes
----------------------

.. toctree::
:maxdepth: 1

multiphysics_extensions

Advanced Modes of Running
-------------------------

.. toctree::
:maxdepth: 1

amr
boosted_frame

.. bibliography::
:keyprefix: i-

0 comments on commit 2e1b867

Please sign in to comment.