Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
PLMD::switchContainers::nativeqSwitch Class Reference
Inheritance diagram for PLMD::switchContainers::nativeqSwitch:
Inheritance graph
[legend]

Public Member Functions

 nativeqSwitch (double D0, double DMAX, double R0, double BETA, double LAMBDA, double REF)
 
double calculate (const double distance, double &dfunc) const override
 the driver for the function (prepares rdist or returns 1 or 0 automatically) More...
 
virtual double calculateSqr (double distance2, double &dfunc) const
 
std::string description () const
 
double get_d0 () const
 
double get_dmax () const
 
double get_dmax2 () const
 
double get_r0 () const
 
void removeStretch ()
 
void setupStretch ()
 

Protected Member Functions

double function (const double rdist, double &dfunc) const override
 
std::string specificDescription () const override
 

Protected Attributes

double d0 =0.0
 Minimum distance (before this, function is one) More...
 
double dmax =0.0
 Maximum distance (after this, function is zero) More...
 
double dmax_2 =0.0
 Square of dmax, useful in calculateSqr() More...
 
double invr0 =0.0
 We store the inverse to avoid a division. More...
 
double invr0_2 =0.0
 Square of invr0, useful in calculateSqr() More...
 
std::string mytype
 
double shift =0.0
 
double stretch =1.0
 Parameters for stretching the function to zero at d_max. More...
 

Private Attributes

double beta = 50.0
 
double lambda = 1.8
 
double ref =0.0
 

Constructor & Destructor Documentation

◆ nativeqSwitch()

PLMD::switchContainers::nativeqSwitch::nativeqSwitch ( double  D0,
double  DMAX,
double  R0,
double  BETA,
double  LAMBDA,
double  REF 
)
inline

Member Function Documentation

◆ calculate()

double PLMD::switchContainers::nativeqSwitch::calculate ( const double  distance,
double &  dfunc 
) const
inlineoverridevirtual

the driver for the function (prepares rdist or returns 1 or 0 automatically)

Reimplemented from PLMD::switchContainers::baseSwitch.

◆ calculateSqr()

double PLMD::switchContainers::baseSwitch::calculateSqr ( double  distance2,
double &  dfunc 
) const
virtualinherited

◆ description()

std::string PLMD::switchContainers::baseSwitch::description ( ) const
inherited

◆ function()

double PLMD::switchContainers::nativeqSwitch::function ( const double  rdist,
double &  dfunc 
) const
inlineoverrideprotectedvirtual

◆ get_d0()

double PLMD::switchContainers::baseSwitch::get_d0 ( ) const
inherited

◆ get_dmax()

double PLMD::switchContainers::baseSwitch::get_dmax ( ) const
inherited

◆ get_dmax2()

double PLMD::switchContainers::baseSwitch::get_dmax2 ( ) const
inherited

◆ get_r0()

double PLMD::switchContainers::baseSwitch::get_r0 ( ) const
inherited

◆ removeStretch()

void PLMD::switchContainers::baseSwitch::removeStretch ( )
inherited

◆ setupStretch()

void PLMD::switchContainers::baseSwitch::setupStretch ( )
inherited

◆ specificDescription()

std::string PLMD::switchContainers::nativeqSwitch::specificDescription ( ) const
inlineoverrideprotectedvirtual

Member Data Documentation

◆ beta

double PLMD::switchContainers::nativeqSwitch::beta = 50.0
private

◆ d0

double PLMD::switchContainers::baseSwitch::d0 =0.0
protectedinherited

Minimum distance (before this, function is one)

◆ dmax

double PLMD::switchContainers::baseSwitch::dmax =0.0
protectedinherited

Maximum distance (after this, function is zero)

◆ dmax_2

double PLMD::switchContainers::baseSwitch::dmax_2 =0.0
protectedinherited

Square of dmax, useful in calculateSqr()

◆ invr0

double PLMD::switchContainers::baseSwitch::invr0 =0.0
protectedinherited

We store the inverse to avoid a division.

◆ invr0_2

double PLMD::switchContainers::baseSwitch::invr0_2 =0.0
protectedinherited

Square of invr0, useful in calculateSqr()

◆ lambda

double PLMD::switchContainers::nativeqSwitch::lambda = 1.8
private

◆ mytype

std::string PLMD::switchContainers::baseSwitch::mytype
protectedinherited

◆ ref

double PLMD::switchContainers::nativeqSwitch::ref =0.0
private

◆ shift

double PLMD::switchContainers::baseSwitch::shift =0.0
protectedinherited

◆ stretch

double PLMD::switchContainers::baseSwitch::stretch =1.0
protectedinherited

Parameters for stretching the function to zero at d_max.


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