Skip to content

Commit

Permalink
Remove grid from documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RemiLehe committed Oct 20, 2023
1 parent cdb389e commit ff6b509
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 13 deletions.
5 changes: 0 additions & 5 deletions docs/source/code_overview/grid.rst

This file was deleted.

7 changes: 3 additions & 4 deletions docs/source/code_overview/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,12 @@ The physical laser pulse parameters are defined in the laser :doc:`profile <../a
This is typically constructed from a :doc:`combination <../api/profiles/combined_profile>` of two classes representing the :doc:`longitudinal <../api/profiles/longitudinal/index>` and :doc:`transverse <../api/profiles/transverse/index>` profiles of the laser.
Alternatively, one can define the full 3D profile in a single function, for example the :doc:`GaussianProfile <../api/profiles/gaussian>`

The data associated with a given laser pulse is stored on a :doc:`grid <../code_overview/grid>`.
To create this grid and populate it with a laser pulse, we need to know something about the computational parmaeters being used.
The data associated with a given laser pulse is stored on a grid. To create this grid and populate it with a laser pulse, we need to know something about the computational parameters being used.
For example, the metadata associated with this grid such as the coordinate system being used, lower and higher ends of the computational domain and number of points etc.
All of this information is also stored in the :doc:`grid <../code_overview/grid>` class.
All of this information is passed when initializing the :doc:`laser <../api/laser>` object.

Once a laser :doc:`laser <../api/laser>` object has been defined, we can then propagate it forwards and backwards to see how it evolves or to set it in the right place for the beginning of a subsequent simulation.
The laser object can be :doc:`outputted <../code_overview/openpmd_output>` to a standard file format for these subsequent calculations. This allows for easy incorporation of standardised laser pulses to a range of different simulation tools.
The laser object can be written to a standard file format for these subsequent calculations. This allows for easy incorporation of standardized laser pulses to a range of different simulation tools.

Coordinate Systems
##################
Expand Down
4 changes: 0 additions & 4 deletions docs/source/code_overview/openpmd_output.rst

This file was deleted.

0 comments on commit ff6b509

Please sign in to comment.