class rgpot::SuttonChenPot

Overview

Sutton-Chen energy and analytic forces. More…

#include <SuttonChenPot.hpp>
 
class SuttonChenPot: public rgpot::Potential< SuttonChenPot > {
public:
    // construction
 
    SuttonChenPot();
    SuttonChenPot(const SuttonChenConfig& c);
 
    // methods
 
    const SuttonChenConfig& config() const;
    virtual PotCaps caps() const;
    virtual uint64_t paramsKey() const;
    Locality locality() const;
    void forceImpl(const ForceInput& in, ForceOut* out) const;
    void forcePerAtom(const ForceInput& in, ForceOut* out, const PerAtomOut& atoms) const;
    void densityStage(const HalfList& list, double* densities) const;
    void forceStage(const HalfList& list, const double* densities, double* forces, StageTally* tally) const;
    void setNeighbourMode(nlist::Mode mode);
    void setPairTermLimit(std::size_t pairs);
};

Detailed Documentation

Sutton-Chen energy and analytic forces.

Methods

virtual PotCaps caps() const

Concurrency and evaluation capabilities of this potential.

Multi-threaded callers (NEB images, dimer endpoints) derive their sharing and cloning policy from this instead of hard-coded lists.

virtual uint64_t paramsKey() const

Fingerprint of the potential’s parameter set.

Mixed into the result-cache key so results never cross parameter sets. Implementations hash their config field by field (see ParamHash.hpp) plus a kernel-version salt that changes whenever the numerics change. The default (0) suits parameter-free potentials whose numerics never changed.

Locality locality() const

The density and the pair term both stop at the cutoff. A cutoff <= 0 keeps every pair, so there is no finite range. The staged evaluation exchanges rho.

void forcePerAtom(const ForceInput& in, ForceOut* out, const PerAtomOut& atoms) const

forceImpl plus per-atom terms: each atom’s embedding -epsilon c sqrt(rho_i), and each pair energy and virial split half to each atom.

void densityStage(const HalfList& list, double* densities) const

Staged.hpp : adds (a / r)^m to the density of each atom of a pair.

void forceStage(const HalfList& list, const double* densities, double* forces, StageTally* tally) const

Staged.hpp : -epsilon c sqrt(rho_i) of each owned atom and the pair forces with the embedding weights of both atoms, tallied as forcePerAtom tallies them.

void setNeighbourMode(nlist::Mode mode)

Stored Verlet list or a streaming cell walk.

void setPairTermLimit(std::size_t pairs)

Pairs, over all threads, whose density-pass powers the force pass reads back. It computes the rest again, with the same bits. The default keeps 32 MiB of terms.