class rgpot::EAMTablePot¶
Overview¶
Tabulated EAM or Finnis-Sinclair energy and forces. More…
#include <EAMTablePot.hpp>
class EAMTablePot: public rgpot::Potential< EAMTablePot > {
public:
// construction
EAMTablePot(const EAMTableConfig& c);
EAMTablePot(const EAMTable& table, bool periodic, bool stress, double skin = 1.0);
// methods
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);
bool listReused() const;
std::uint64_t listBuilds() const;
};
Detailed Documentation¶
Tabulated EAM or Finnis-Sinclair energy and 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, the embedding argument and phi all stop at the table cutoff. 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 F_a(rho_i), and each phi_ab and pair virial split half to each atom, as pair_style eam tallies eatom and vatom.
void densityStage(const HalfList& list, double* densities) const
Staged.hpp : adds rho_ab(r) to the density of each atom of a pair.
void forceStage(const HalfList& list, const double* densities, double* forces, StageTally* tally) const
Staged.hpp : F_a(rho_i) of each owned atom and the pair forces with F’(rho) of both atoms, tallied as forcePerAtom tallies them.
void setNeighbourMode(nlist::Mode mode)
Stream walks the cells on every call and keeps no list.
bool listReused() const
True when the last forceImpl or forcePerAtom kept the pair list.
std::uint64_t listBuilds() const
Pair lists built by forceImpl and forcePerAtom so far.