Skip to content

Commit

Permalink
Add documentation for option in PICMI
Browse files Browse the repository at this point in the history
  • Loading branch information
dpgrote committed Nov 10, 2023
1 parent 4b2d5d6 commit f78c5ba
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions Python/pywarpx/picmi.py
Original file line number Diff line number Diff line change
Expand Up @@ -464,6 +464,17 @@ def initialize_inputs(self, species_number, layout, species, density_scale):


class AnalyticDistribution(picmistandard.PICMI_AnalyticDistribution, DensityDistributionBase):
"""
Parameters
----------
warpx_momentum_spread_expressions: list of string
Analytic expressions describing the gamma*velocity spread for each axis [m/s].
Expressions should be in terms of the position, written as 'x', 'y', and 'z'.
Parameters can be used in the expression with the values given as keyword arguments.
For any axis not supplied (set to None), zero will be used.
"""
def init(self, kw):
self.momentum_spread_expressions = kw.pop('warpx_momentum_spread_expressions', [None, None, None])

Expand Down

0 comments on commit f78c5ba

Please sign in to comment.