STORMM Source Documentation
Loading...
Searching...
No Matches
stormm::generalized_born_defaults::NeckGeneralizedBornKit< T > Struct Template Reference

Abstract for the NeckGeneralizedBornTable object, in single- or double-precision. More...

#include <generalized_born.h>

Public Member Functions

 NeckGeneralizedBornKit (int table_size, T neck_cut_in, T kscale_in, const T *max_separation_in, const T *max_value_in)
 Constructor takes a simple list of the relevant constants and pointers.
 

Public Attributes

const int table_size
 Size of each table (they are both assumed to be square)
 
const T neck_cut
 The Generalized Born neck cutoff (see above for the default)
 
const T kscale
 
const T * max_separation
 Maximum separations of spheres resulting in neck corrections.
 
const T * max_value
 Maximum values of the neck correction in each case.
 

Detailed Description

template<typename T>
struct stormm::generalized_born_defaults::NeckGeneralizedBornKit< T >

Abstract for the NeckGeneralizedBornTable object, in single- or double-precision.

Member Data Documentation

◆ kscale

template<typename T>
const T stormm::generalized_born_defaults::NeckGeneralizedBornKit< T >::kscale

Generalized Born Kappa scaling parameter (see the default above). This parameter is carried through to this object to be loaded from the CPU cache or HPC constants cache, rather than taken at its default setting, to allow flexibility in the GB implementation. In contrast, the Generalzied Born Taylor series coefficients are not set by the user and left as constexpr.


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