nnp::EwaldParameters Struct Reference

#include <IEwaldTrunc.h>

Collaboration diagram for nnp::EwaldParameters:

Public Member Functions
	EwaldParameters ()=default
	EwaldParameters (double oEta, double oRCut, double oKCut)
EwaldParameters	toPhysicalUnits (double const convLength) const
EwaldParameters	toNormalizedUnits (double const convLength) const

Public Attributes
double	eta = 0.0
	Width of the gaussian screening charges. More...
double	rCut = 0.0
	Cutoff in real space. More...
double	kCut = 0.0
	Cutoff in reciprocal space. More...

Detailed Description

Definition at line 37 of file IEwaldTrunc.h.

Constructor & Destructor Documentation

EwaldParameters() [1/2]

nnp::EwaldParameters::EwaldParameters ( )

default

EwaldParameters() [2/2]

nnp::EwaldParameters::EwaldParameters ( double  oEta, double  oRCut, double  oKCut  )

inline

Definition at line 47 of file IEwaldTrunc.h.

                : eta{oEta}, rCut{oRCut}, kCut{oKCut}
        {}

Member Function Documentation

toPhysicalUnits()

EwaldParameters nnp::EwaldParameters::toPhysicalUnits ( double const  convLength ) const

inline

Definition at line 51 of file IEwaldTrunc.h.

        {
            return EwaldParameters{eta / convLength,
                                   rCut / convLength,
                                   kCut * convLength};
        }

References eta, kCut, and rCut.

Referenced by nnp::EwaldSetup::logEwaldCutoffs(), and toNormalizedUnits().

Here is the caller graph for this function:

toNormalizedUnits()

EwaldParameters nnp::EwaldParameters::toNormalizedUnits ( double const  convLength ) const

inline

Definition at line 57 of file IEwaldTrunc.h.

        {
            return toPhysicalUnits(1/convLength);
        }

References toPhysicalUnits().

Referenced by nnp::EwaldSetup::toNormalizedUnits().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

eta

double nnp::EwaldParameters::eta = 0.0

Width of the gaussian screening charges.

Definition at line 40 of file IEwaldTrunc.h.

Referenced by nnp::Structure::calculateDAdrQ(), nnp::Structure::calculateElectrostaticEnergy(), nnp::EwaldTruncJackson::calculateParameters(), nnp::EwaldTruncKolafaFixR::calculateParameters(), nnp::EwaldTruncKolafaOptEta::calculateParameters(), nnp::EwaldTruncKolafaFixR::isEstimateReliable(), nnp::EwaldSetup::logEwaldCutoffs(), nnp::KspaceGrid::setup(), and toPhysicalUnits().

rCut

double nnp::EwaldParameters::rCut = 0.0

Cutoff in real space.

Definition at line 42 of file IEwaldTrunc.h.

Referenced by nnp::Structure::calculateDAdrQ(), nnp::Structure::calculateElectrostaticEnergy(), nnp::Structure::calculateMaxCutoffRadiusOverall(), nnp::EwaldTruncJackson::calculateParameters(), nnp::EwaldTruncKolafaFixR::calculateParameters(), nnp::EwaldTruncKolafaOptEta::calculateParameters(), nnp::EwaldSetup::logEwaldCutoffs(), nnp::EwaldSetup::readFromArgs(), and toPhysicalUnits().

kCut

double nnp::EwaldParameters::kCut = 0.0

Cutoff in reciprocal space.

Definition at line 44 of file IEwaldTrunc.h.

Referenced by nnp::EwaldTruncJackson::calculateParameters(), nnp::EwaldTruncKolafaFixR::calculateParameters(), nnp::EwaldTruncKolafaOptEta::calculateParameters(), nnp::EwaldSetup::logEwaldCutoffs(), nnp::KspaceGrid::setup(), and toPhysicalUnits().

---

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

• /home/runner/work/n2p2/n2p2/src/libnnp/IEwaldTrunc.h