mythos.energy.potentials

This module contains the potential energy functions used in the oxDNA DNA1 model.

Functions

`v_fene`(→ mythos.utils.types.ARR_OR_SCALAR)	FENE spring (used to connect backbones).
`v_morse`(→ mythos.utils.types.ARR_OR_SCALAR)	Morse potential (used for stacking and H-bonding).
`v_harmonic`(→ mythos.utils.types.ARR_OR_SCALAR)	Harmonic potential (used for cross-stacking and coaxial stacking).
`v_lj`(→ mythos.utils.types.ARR_OR_SCALAR)	Lennard - Jones potential (used for soft repulsion).
`v_mod`(→ mythos.utils.types.ARR_OR_SCALAR)	Quadratic terms (used for modulation).
`v_smooth`(→ mythos.utils.types.ARR_OR_SCALAR)	Quadratic smoothing terms for truncation.

Module Contents

mythos.energy.potentials.v_fene(r: mythos.utils.types.ARR_OR_SCALAR, eps: mythos.utils.types.Scalar, r0: mythos.utils.types.Scalar, delt: mythos.utils.types.Scalar) → mythos.utils.types.ARR_OR_SCALAR[source]

FENE spring (used to connect backbones).

This is based on equation 2.1 from the oxDNA paper.

mythos.energy.potentials.v_morse(r: mythos.utils.types.ARR_OR_SCALAR, eps: mythos.utils.types.Scalar, r0: mythos.utils.types.Scalar, a: mythos.utils.types.Scalar) → mythos.utils.types.ARR_OR_SCALAR[source]

Morse potential (used for stacking and H-bonding).

This is based on equation 2.2 from the oxDNA paper.

mythos.energy.potentials.v_harmonic(r: mythos.utils.types.ARR_OR_SCALAR, k: mythos.utils.types.Scalar, r0: mythos.utils.types.Scalar) → mythos.utils.types.ARR_OR_SCALAR[source]

Harmonic potential (used for cross-stacking and coaxial stacking).

This is based on equation 2.3 from the oxDNA paper.

mythos.energy.potentials.v_lj(r: mythos.utils.types.ARR_OR_SCALAR, eps: mythos.utils.types.Scalar, sigma: mythos.utils.types.Scalar) → mythos.utils.types.ARR_OR_SCALAR[source]

Lennard - Jones potential (used for soft repulsion).

This is based on equation 2.4 from the oxDNA paper.

mythos.energy.potentials.v_mod(theta: mythos.utils.types.ARR_OR_SCALAR, a: mythos.utils.types.Scalar, theta0: mythos.utils.types.Scalar) → mythos.utils.types.ARR_OR_SCALAR[source]

Quadratic terms (used for modulation).

This is based on equation 2.5 from the oxDNA paper.

mythos.energy.potentials.v_smooth(x: mythos.utils.types.ARR_OR_SCALAR, b: mythos.utils.types.Scalar, x_c: mythos.utils.types.Scalar) → mythos.utils.types.ARR_OR_SCALAR[source]

Quadratic smoothing terms for truncation.

This is based on equation 2.6 from the oxDNA paper.