WallGo.config.ConfigBoltzmannSolver

class ConfigBoltzmannSolver(basisM='Cardinal', basisN='Chebyshev', collisionMultiplier=1.0, truncationOption='AUTO')[source]

Bases: object

Holds the config of the BoltzmannSolver class.

Parameters:
  • basisM (str)

  • basisN (str)

  • collisionMultiplier (float)

  • truncationOption (str)

__init__(basisM='Cardinal', basisN='Chebyshev', collisionMultiplier=1.0, truncationOption='AUTO')
Parameters:
  • basisM (str)

  • basisN (str)

  • collisionMultiplier (float)

  • truncationOption (str)

Return type:

None

Methods

__init__([basisM, basisN, ...])

Attributes

basisM

The position polynomial basis type, either 'Cardinal' or 'Chebyshev'.

basisN

The momentum polynomial basis type, either 'Cardinal' or 'Chebyshev'.

collisionMultiplier

Factor multiplying the collision term in the Boltzmann equation.

truncationOption

Truncation option for spectral expansions.

basisM: str = 'Cardinal'

The position polynomial basis type, either ‘Cardinal’ or ‘Chebyshev’.

basisN: str = 'Chebyshev'

The momentum polynomial basis type, either ‘Cardinal’ or ‘Chebyshev’.

collisionMultiplier: float = 1.0

Factor multiplying the collision term in the Boltzmann equation. Can be used for testing or for studying the solution’s sensibility to the collision integrals. Don’t forget to adjust meanFreePathScale accordingly if this is different from 1 (meanFreePathScale should scale like 1/collisionMultiplier). WARNING: THIS CHANGES THE COLLISION TERMS WRT TO THEIR PHYSICAL VALUE.

truncationOption: str = 'AUTO'

Truncation option for spectral expansions. Can be ‘NONE’ for no truncation, ‘AUTO’ to automatically detect if the spectral expansion is converging and truncate if not, or ‘THIRD’ which always truncates the last third.