PLMD::switchContainers::cubicSwitch Class Reference

Inheritance diagram for PLMD::switchContainers::cubicSwitch:

Public Member Functions
	cubicSwitch (double D0, double DMAX)
	~cubicSwitch ()=default
virtual double	calculate (double distance, double &dfunc) const
	the driver for the function (prepares rdist or returns 1 or 0 automatically)
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)
double	dmax =0.0
	Maximum distance (after this, function is zero)
double	dmax_2 =0.0
	Square of dmax, useful in calculateSqr()
double	invr0 =0.0
	We store the inverse to avoid a division.
double	invr0_2 =0.0
	Square of invr0, useful in calculateSqr()
std::string	mytype
double	shift =0.0
double	stretch =1.0
	Parameters for stretching the function to zero at d_max.

Constructor & Destructor Documentation

cubicSwitch()

PLMD::switchContainers::cubicSwitch::cubicSwitch ( double D0, double DMAX )

inline

~cubicSwitch()

PLMD::switchContainers::cubicSwitch::~cubicSwitch ( )

default

Member Function Documentation

calculate()

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

virtualinherited

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

Reimplemented in PLMD::switchContainers::leptonSwitch, and PLMD::switchContainers::nativeqSwitch.

calculateSqr()

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

virtualinherited

Reimplemented in PLMD::switchContainers::fastGaussianSwitch, PLMD::switchContainers::fixedRational< N,, >, PLMD::switchContainers::leptonSwitch, and PLMD::switchContainers::rational< isFast, nis2m >.

description()

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

inherited

function()

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

inlineoverrideprotectedvirtual

Implements PLMD::switchContainers::baseSwitch.

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::cubicSwitch::specificDescription ( ) const

inlineoverrideprotectedvirtual

Reimplemented from PLMD::switchContainers::baseSwitch.

Member Data Documentation

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()

mytype

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

protectedinherited

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:

• tools/SwitchingFunction.cpp