|
OpenMPCD
|
Public Member Functions | |
| def | __init__ (self, K, l_0, R) |
| def | getK (self) |
| def | get_l_0 (self) |
| def | getR (self) |
| def | getPotential (self, r) |
Models the FENE potential, which is given by
\f[ V_{\textrm{FENE}}(r) = - 0.5 K R^2 \log (1 - (\frac{r - l_0}{R})^2) \f]
| def MPCDAnalysis.PairPotentials.FENE.FENE.__init__ | ( | self, | |
| K, | |||
| l_0, | |||
| R | |||
| ) |
The constructor.
@throw TypeError
Throws if `K`, `l_0`, or `R` are neither `int` nor `float`.
@throw ValueError
Throws if `R` is `0` or negative.
@param[in] K
The \f$ K \f$ potential parameter.
@param[in] l_0
The \f$ l_0 \f$ potential parameter.
@param[in] R
The \f$ R \f$ potential parameter, which must be positive.
| def MPCDAnalysis.PairPotentials.FENE.FENE.get_l_0 | ( | self | ) |
| def MPCDAnalysis.PairPotentials.FENE.FENE.getK | ( | self | ) |
| def MPCDAnalysis.PairPotentials.FENE.FENE.getPotential | ( | self, | |
| r | |||
| ) |
Returns the potential for an input value of \f$ r \f$.
@throw TypeError
Throws if `r` is neither `int` nor `float` or `Vector3DReal`.
@throw ValueError
Throws if `r` is negative.
@throw ValueError
Throws if `r` is such that, in combination with the used
potential parameters, the result is undefined.
@param[in] r
The input value. It may be either an `int` or `float`, in
which case it must be non-negative. Alternatively, it may be
of type `Vector3DReal`, which is then euqivalent to calling
`getPotential(r.getLength())` instead.
| def MPCDAnalysis.PairPotentials.FENE.FENE.getR | ( | self | ) |
1.8.17