WallGo.genericModel.GenericModel

class GenericModel[source]

Bases: ABC

Common interface for WallGo model definitions. This is basically input parameters + particle definitions + effective potential. The user should implement this and the abstract methods below with their model-specific stuff.

__init__()

Methods

`__init__`()
`addParticle`(particleToAdd)	Common routine for defining a new out-of-equilibrium particle.
`clearParticles`()	Empties the cached particle list
`getEffectivePotential`()	Override to return your effective potential.

Attributes

fieldCount

Override to return the number of classical background fields in your model.

addParticle(particleToAdd)[source]

Common routine for defining a new out-of-equilibrium particle.

Parameters:: particleToAdd (Particle)
Return type:: None

clearParticles()[source]

Empties the cached particle list

Return type:: None

abstract property fieldCount: int: Override to return the number of classical background fields in your model.

abstractmethod getEffectivePotential()[source]

Override to return your effective potential.

Return type:: EffectivePotential