WallGo

Initialising WallGo package

Functions

isCollisionModuleAvailable()

Returns True if the WallGoCollision extension module could be loaded and is ready for use.

isCollisionModuleAvailable()

Returns True if the WallGoCollision extension module could be loaded and is ready for use. By default it is loaded together with WallGo, but WallGo can operate in restricted mode even if the load fails. This function can be used to check module availability at runtime if you must operate in an environment where the module may not always be available.

Return type:

bool

Modules

PotentialTools	Initialisation for PotentialTools module, includes loading of Jb/Jf integral data
boltzmann	Classes for solving the Boltzmann equations for out-of-equilibrium particles.
collisionArray	Class for loading and storing the collision files used in boltzmann.py.
collisionHelpers	Conversion between WallGo and WallGoCollision types
config	Dataclasses to store the configs
containers	Data classes passed around WallGo
effectivePotential	EffectivePotential class definition.
equationOfMotion	Class for solving the equation of motion and the hydrodynamic equations.
exceptions	Specific Exception types used in WallGo
fields	Classes for Fields and FieldPoint objects that hold information about the background fields.
freeEnergy	Class that does phase tracing, computes the effective potential in the minimum and interpolate it.
genericModel	Physics model class for WallGo
grid	Class for computing and storing the coordinates on the grid and other related quantities.
grid3Scales	Class for computing and storing the coordinates on the grid and other related quantities.
helpers	Helper functions that are used by WallGo.
hydrodynamics	Classes for solving the hydrodynamic equations for the fluid velocity and temperature.
hydrodynamicsTemplateModel	Class for solving the hydrodynamic equations for the fluid velocity and temperature by approximating the equation of state by the template model.
interpolatableFunction	Class that can be use to evaluate and interpolate functions.
manager	Defines the WallGoManager class which initializes the different object needed for the wall velocity calculation.
mathematicaHelpers	Common Wolfram Mathematica and WallGoMatrix related functions.
particle	Module with Particle class to hold particle information
polynomial	Class that stores and perfom operation on the coefficients of a polynomial series.
results	Data classes for compiling and returning results
thermodynamics	Classes that contain thermodynamics quantities like pressure, enthalpy, energy density for both phases
utils