ConstantPotential

class ConstantPotential(particleType, c)

Constructor of the potential.

Parameters:
  • particleType (ParticleType or ParticleIdentifier) – Identifier of the particle type.
  • c (PhysicalQuantity of type energy) – Potential parameter.
getAllParameterNames()

Return the names of all used parameters as a list.

getAllParameters()

Return all parameters of this potential and their current values as a <parameterName / parameterValue> dictionary.

static getDefaults()

Get the default parameters of this potential and return them in form of a dictionary of <parameter name, default value> key-value pairs.

getParameter(parameterName)

Get the current value of the parameter parameterName.

setParameter(parameterName, value)

Set the parameter parameterName to the given value.

Parameters:
  • parameterName (str) – The name of the parameter that will be modified.
  • value – The new value that will be assigned to the parameter parameterName.

Notes

Add a constant offset to the potential energy. This potential has no effect on the forces or stress.