VFFCrossBondStretchingPotential

class VFFCrossBondStretchingPotential(particleType1, particleType2, particleType3, alpha, r0, r1)

Constructor of the potential.

Parameters:
  • particleType1 (ParticleType or ParticleIdentifier) – Identifier of the first particle type.
  • particleType2 (ParticleType or ParticleIdentifier) – Identifier of the second particle type. This is the central particle (the vertex) when calculating the angle.
  • particleType3 (ParticleType or ParticleIdentifier) – Identifier of the third particle type.
  • alpha (PhysicalQuantity of type energy * length**-4) – Potential parameter.
  • r0 (PhysicalQuantity of type length**2) – Potential parameter.
  • r1 (PhysicalQuantity of type length**2) – 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.

setAlpha(alpha)

Set the parameter alpha.

Parameters:alpha (PhysicalQuantity of type energy * length**-4) – Potential parameter.
setCutoff(r_cut)

Sets the cutoff radius for the given potential

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.
setr0(r0)

Set the parameter r0.

Parameters:r0 (PhysicalQuantity of type length**2) – Potential parameter.
setr1(r1)

Set the parameter r1.

Parameters:r1 (PhysicalQuantity of type length**2) – Potential parameter.

Notes

  • This potential class is a bonded potential. This means it requires a bond topology to be specified on the configuration which the potential should be used for. Bonds can be set using the findBonds() method on configurations (MoleculeConfiguration, BulkConfiguration, DeviceConfiguration, or SurfaceConfiguration), which automatically adds bonds for atoms which are closer than their combined covalent radii (multiplied by a fuzz_factor of 1.1 by default). Alternatively bonds can be set manually by passing a list of the atom index pairs that form the bonds to the setBonds() method on the configuration. If no bonds are specified on the configuration bonded potentials have no effect.

  • This potential is part of the potential functions that are used in valence force fields (VFF) [Kea66][LvAO+04].

  • This potential is calculated as

    \[V(r_{i,j}, r_{j,k}) = \alpha (r_{i,j}^2 - r_0) (r_{j,k} - r_1)\]

    where \(r_{i,j}\) is the bond distance between atoms i and j.

[Kea66]P. N. Keating. Effect of invariance requirements on the elastic strain energy of crystals with application to the diamond structure. Phys. Rev., 145:637–645, 1966. doi:10.1103/PhysRev.145.637.
[LvAO+04]Olga L. Lazarenkova, Paul von Allmen, Fabiano Oyafuso, Seungwon Lee, and Gerhard Klimeck. Effect of anharmonicity of the strain energy on band offsets in semiconductor nanostructures. Appl. Phys. Lett., 85(18):4193–4195, 2004. doi:10.1063/1.1814810.