LOOS  v2.3.2
ENM::DistanceCutoff Class Reference

Basic distance cutoff for "traditional" ENM. More...

#include <spring_functions.hpp>

Inheritance diagram for ENM::DistanceCutoff:
Collaboration diagram for ENM::DistanceCutoff:

Public Member Functions

 DistanceCutoff (const double &r)
 
std::string name () const
 Name for this particular spring function.
 
Params setParams (const Params &p)
 Sets the internal constants, returning the unused ones.
 
bool validParams () const
 Determines if the internal constants are "valid".
 
uint paramSize () const
 How many internal constants there are.
 
double constantImpl (const loos::GCoord &u, const loos::GCoord &v, const loos::GCoord &d)
 Implementation of the spring constant calculation.
 
- Public Member Functions inherited from ENM::UniformSpringFunction
loos::DoubleMatrix constant (const loos::GCoord &u, const loos::GCoord &v, const loos::GCoord &d)
 Actually compute the spring constant as a 3x3 matrix.
 

Additional Inherited Members

- Public Types inherited from ENM::SpringFunction
typedef std::vector< double > Params
 
- Protected Member Functions inherited from ENM::SpringFunction
double checkConstant (double d)
 Check for negative spring-constants. More...
 

Detailed Description

Basic distance cutoff for "traditional" ENM.

\begin{eqnarray*} r^{-2} & \mbox{for} & r \leq r_c \\ 0 & \mbox{for} & r > r_c\\ \end{eqnarray*}

Where r is the distance between nodes.

Definition at line 165 of file spring_functions.hpp.


The documentation for this class was generated from the following file: