relentless.model.potential.HarmonicBond#

class relentless.model.potential.HarmonicBond(types, name=None)#

Harmonic bond potential.

\[u(r) = \frac{k}{2} (r - r_0)^2\]

where \(r\) is the distance between two bonded particles. The parameters for each type are:

Parameter

Description

k

Spring constant \(k\).

r0

Minimum-energy length \(r_0\).
Parameters:

  • types (tuple[str]) – Types.

  • name (str) – Unique name of the potential. Defaults to __u[id], where id is the unique integer ID of the potential.

coeff#

Parameters of the potential for each type.

Type:

BondParameters

Examples

Harmonic Bond:

>>> u = relentless.potential.bond.Harmonic(("A",))
>>> u.coeff["A"].update({'k': 1000, 'r0': 1})

Methods

derivative(type_, var, r)

Evaluate bond derivative with respect to a variable.

energy(type_, r)

Evaluate bond energy.

force(type_, r)

Evaluate bond force.

from_file(filename[, name])

Create potential from a JSON file.

from_json(data[, name])

Create potential from JSON data.

save(filename)

Save the potential to file as JSON data.

to_json()

Export potential to a JSON-compatible dictionary.

Attributes

count

names

derivative(type_, var, r)#

Evaluate bond derivative with respect to a variable.

The derivative is evaluated using the _derivative() function for all \(u_{0,\lambda}(r)\).

The derivative will be carried out with respect to var for all Variable parameters. The appropriate chain rules are handled automatically. If the potential does not depend on var, the derivative will be zero by definition.

Parameters:

  • _type (tuple[str]) – The type for which to calculate the derivative.

  • var (Variable) – The variable with respect to which the derivative is calculated.

  • r (float or list) – The bond distance(s) at which to evaluate the derivative.

Returns:

The bond derivative evaluated at r. The return type is consistent with r.

Return type:

float or numpy.ndarray

Raises:

  • ValueError – If any value in r is negative.

  • TypeError – If the parameter with respect to which to take the derivative is not a Variable.

energy(type_, r)#

Evaluate bond energy.

force(type_, r)#

Evaluate bond force.

classmethod from_file(filename, name=None)#

Create potential from a JSON file.

It is assumed that the JSON file is compatible with the potential type.

Parameters:

  • filename (str) – JSON file to load.

  • name (str or bool or None) – Name of the potential. If a str, name overrides the value in the file. If True, the name in the file is always preserved. If False, the name in the file is always ignored, and a default name is created. If None, the value in the file is used if it is not taken and does not match the default name pattern; otherwise, a new default name is generated.

classmethod from_json(data, name=None)#

Create potential from JSON data.

It is assumed that the data is compatible with the pair potential.

Parameters:

  • data (dict) – JSON data for potential.

  • name (str or bool or None) – Name of the potential. If a str, name overrides the value in the JSON data. If True, the name in the JSON data is always preserved. If False, the name in the JSON data is always ignored, and a default name is created. If None, the value in the JSON data is used if it is not taken and does not match the default name pattern; otherwise, a new default name is generated.

save(filename)#

Save the potential to file as JSON data.

Parameters:

filename (str) – The name of the file to which to save the data.

to_json()#

Export potential to a JSON-compatible dictionary.

The JSON dictionary will contain the id and name of the potential, along with the JSON representation of its coefficients.

Returns:

Potential.

Return type:

dict