WallGo.results.BoltzmannResults

class BoltzmannResults(deltaF, Deltas, truncationError, truncatedTail, spectralPeaks, linearizationCriterion1=0, linearizationCriterion2=0)[source]

Bases: object

Holds results to be returned by BoltzmannSolver

Parameters:

  • deltaF (ndarray)

  • Deltas (BoltzmannDeltas)

  • truncationError (float)

  • truncatedTail (tuple[bool, bool, bool])

  • spectralPeaks (tuple[int, int, int])

  • linearizationCriterion1 (float)

  • linearizationCriterion2 (float)

__init__(deltaF, Deltas, truncationError, truncatedTail, spectralPeaks, linearizationCriterion1=0, linearizationCriterion2=0)
Parameters:

  • deltaF (ndarray)

  • Deltas (BoltzmannDeltas)

  • truncationError (float)

  • truncatedTail (tuple[bool, bool, bool])

  • spectralPeaks (tuple[int, int, int])

  • linearizationCriterion1 (float)

  • linearizationCriterion2 (float)

Return type:

None

Methods

__init__(deltaF, Deltas, truncationError, ...)

Attributes

linearizationCriterion1

Ratio of out-of-equilibrium and equilibrium pressures, \(|P[\delta f]| / |P[f_\text{eq}]|\).

linearizationCriterion2

Ratio of the first-order correction due to nonlinearities and total pressure computed by WallGo, \(|P[\delta f_2]| / |P[f_\text{eq}+\delta f]|\).

deltaF

Deviation of probability density function from equilibrium, \(\delta f(\xi, p_z, p_\parallel)\).

Deltas

Relativistically invariant integrals over \(\mathcal{E}_\text{pl}^{n_\mathcal{E}}\mathcal{P}_\text{pl}^{n_\mathcal{P}}\delta f\).

truncationError

Estimated relative error in \(\delta f\) due to truncation of spectral expansion.

truncatedTail

True if tail 1/3 of spectral expansion was truncated in each direction, False otherwise.

spectralPeaks

Indices of the peaks in the spectral expansion in each direction.
Deltas: BoltzmannDeltas

Relativistically invariant integrals over \(\mathcal{E}_\text{pl}^{n_\mathcal{E}}\mathcal{P}_\text{pl}^{n_\mathcal{P}}\delta f\).

deltaF: ndarray

Deviation of probability density function from equilibrium, \(\delta f(\xi, p_z, p_\parallel)\).

linearizationCriterion1: float = 0

Ratio of out-of-equilibrium and equilibrium pressures, \(|P[\delta f]| / |P[f_\text{eq}]|\). Default is 0.

linearizationCriterion2: float = 0

Ratio of the first-order correction due to nonlinearities and total pressure computed by WallGo, \(|P[\delta f_2]| / |P[f_\text{eq}+\delta f]|\). Default is 0.

spectralPeaks: tuple[int, int, int]

Indices of the peaks in the spectral expansion in each direction.

truncatedTail: tuple[bool, bool, bool]

True if tail 1/3 of spectral expansion was truncated in each direction, False otherwise.

truncationError: float

Estimated relative error in \(\delta f\) due to truncation of spectral expansion.