WallGo.collisionHelpers

Conversion between WallGo and WallGoCollision types

Functions

convertParticleStatistics(statisticsName)

Convert "Fermion" or "Boson" (string) to a type-safe enum.

dictToCollisionParameters(inParameterDict)

Convert a python dict of named float parameters to a WallGoCollision ModelParameters object.

generateCollisionModelDefinition(wallGoModel)

Automatically generates a WallGoCollision.ModelDefinition object with matching out-of-equilibrium particle content and model parameters as defined by the input dict.

generateCollisionParticle(particle, ...)

Creates a WallGoCollision.ParticleDescription object from a WallGo.Particle.

convertParticleStatistics(statisticsName)[source]

Convert “Fermion” or “Boson” (string) to a type-safe enum. FIXME: Python has enums too. Use them instead of strings.

Parameters:

statisticsName (str)

Return type:

EParticleType

dictToCollisionParameters(inParameterDict)[source]

Convert a python dict of named float parameters to a WallGoCollision ModelParameters object.

Parameters:

inParameterDict (dict[str, float])

Return type:

ModelParameters

generateCollisionModelDefinition(wallGoModel, parametersForCollisions={})[source]

Automatically generates a WallGoCollision.ModelDefinition object with matching out-of-equilibrium particle content and model parameters as defined by the input dict. You will need to manually add any relevant in-equilibrium particles. Currently this function defines all collision particles as ultrarelativistic.

Parameters:
  • wallGoModel (WallGo.GenericModel)

  • model. (WallGo physics model to use as a base for the collision)

  • defs. (We take the model's outOfEquilibriumParticles list and create corresponding collision particle)

  • parametersForCollisions (doct[str, float])

  • symbols (Dict of)

  • values. (and their current)

Returns:

A partically filled collision model definition that contains all out-of-eq particles from the input model and has its model parameter list filled with (symbol, value) pairs as specified by the input dict.

Return type:

WallGoCollision.ModelDefinition

generateCollisionParticle(particle, inEquilibrium, ultrarelativistic)[source]

Creates a WallGoCollision.ParticleDescription object from a WallGo.Particle. Note that currently this function does not support non-ultrarelativistic particles (ultrarelativistic=True raises an error).

Parameters:
  • particle (Particle)

  • inEquilibrium (bool)

  • ultrarelativistic (bool)

Return type:

ParticleDescription