|
n2p2 - A neural network potential package
|
Intermediate class for angular SFs based on cutoffs and exponentials. More...
#include <SymFncBaseExpAng.h>


Public Member Functions | |
| virtual void | setParameters (std::string const ¶meterString) |
| Set symmetry function parameters. | |
| virtual void | changeLengthUnit (double convLength) |
| Change length unit. | |
| virtual std::string | getSettingsLine () const |
| Get settings file line from currently set parameters. | |
| virtual std::string | parameterLine () const |
| Give symmetry function parameters in one line. | |
| virtual std::vector< std::string > | parameterInfo () const |
| Get description with parameter names and values. | |
| virtual double | calculateRadialPart (double distance) const |
| Calculate (partial) symmetry function value for one given distance. | |
| virtual double | calculateAngularPart (double angle) const |
| Calculate (partial) symmetry function value for one given angle. | |
| virtual bool | checkRelevantElement (std::size_t index) const |
| Check whether symmetry function is relevant for given element. | |
| virtual std::vector< std::string > | getCacheIdentifiers () const |
| Get unique cache identifiers. | |
| bool | getUseIntegerPow () const |
| Get private useIntegerPow member variable. | |
| std::size_t | getE1 () const |
| Get private e1 member variable. | |
| std::size_t | getE2 () const |
| Get private e2 member variable. | |
| int | getZetaInt () const |
| Get private zetaInt member variable. | |
| double | getLambda () const |
| Get private lambda member variable. | |
| double | getEta () const |
| Get private eta member variable. | |
| double | getZeta () const |
| Get private zeta member variable. | |
| double | getRs () const |
| Get private rs member variable. | |
Public Member Functions inherited from nnp::SymFncBaseCutoff | |
| void | setCutoffFunction (CutoffFunction::CutoffType cutoffType, double cutoffAlpha) |
| Set cutoff function type and parameter. | |
| double | getCutoffAlpha () const |
| Get private cutoffAlpha member variable. | |
| std::string | getSubtype () const |
| Get private subtype member variable. | |
| CutoffFunction::CutoffType | getCutoffType () const |
| Get private cutoffType member variable. | |
Public Member Functions inherited from nnp::SymFnc | |
| virtual | ~SymFnc () |
| Virtual destructor. | |
| virtual bool | operator== (SymFnc const &rhs) const =0 |
| Overload == operator. | |
| virtual bool | operator< (SymFnc const &rhs) const =0 |
| Overload < operator. | |
| bool | operator!= (SymFnc const &rhs) const |
| Overload != operator. | |
| bool | operator> (SymFnc const &rhs) const |
| Overload > operator. | |
| bool | operator<= (SymFnc const &rhs) const |
| Overload <= operator. | |
| bool | operator>= (SymFnc const &rhs) const |
| Overload >= operator. | |
| virtual void | calculate (Atom &atom, bool const derivatives) const =0 |
| Calculate symmetry function for one atom. | |
| void | setScalingType (ScalingType scalingType, std::string statisticsLine, double Smin, double Smax) |
| Set symmetry function scaling type. | |
| double | scale (double value) const |
| Apply symmetry function scaling and/or centering. | |
| double | unscale (double value) const |
| Undo symmetry function scaling and/or centering. | |
| std::size_t | getType () const |
| Get private type member variable. | |
| std::size_t | getIndex () const |
| Get private index member variable. | |
| std::size_t | getLineNumber () const |
| Get private lineNumber member variable. | |
| std::size_t | getEc () const |
| Get private ec member variable. | |
| std::size_t | getMinNeighbors () const |
| Get private minNeighbors member variable. | |
| double | getRc () const |
| Get private rc member variable. | |
| double | getGmin () const |
| Get private Gmin member variable. | |
| double | getGmax () const |
| Get private Gmax member variable. | |
| double | getScalingFactor () const |
| Get private scalingFactor member variable. | |
| double | getConvLength () const |
| Get private convLength member variable. | |
| std::set< std::string > | getParameters () const |
| Get private parameters member variable. | |
| std::vector< std::size_t > | getIndexPerElement () const |
| Get private indexPerElement member variable. | |
| void | setIndex (std::size_t index) |
| Set private index member variable. | |
| void | setIndexPerElement (std::size_t elementIndex, std::size_t index) |
| Set private indexPerElement member variable. | |
| void | setLineNumber (std::size_t lineNumber) |
| Set line number. | |
| std::string | scalingLine () const |
| Get string with scaling information. | |
| void | addCacheIndex (std::size_t element, std::size_t cacheIndex, std::string cacheIdentifier) |
| Add one cache index for given neighbor element and check identifier. | |
| std::vector< std::vector< std::size_t > > | getCacheIndices () const |
| Getter for cacheIndices. | |
Protected Member Functions | |
| SymFncBaseExpAng (std::size_t type, ElementMap const &) | |
| Constructor, initializes type. | |
Protected Member Functions inherited from nnp::SymFncBaseCutoff | |
| SymFncBaseCutoff (std::size_t type, ElementMap const &) | |
| Constructor, initializes type. | |
Protected Member Functions inherited from nnp::SymFnc | |
| SymFnc (std::size_t type, ElementMap const &) | |
| Constructor, initializes type. | |
| std::string | getPrintFormat () const |
| Generate format string for symmetry function parameter printing. | |
Protected Attributes | |
| bool | useIntegerPow |
| Whether to use integer version of power function (faster). | |
| std::size_t | e1 |
| Element index of neighbor atom 1. | |
| std::size_t | e2 |
| Element index of neighbor atom 2. | |
| int | zetaInt |
| Integer version of \(\zeta\). | |
| double | lambda |
| Cosine shift factor. | |
| double | eta |
| Width \(\eta\) of gaussian. | |
| double | zeta |
| Exponent \(\zeta\) of cosine term. | |
| double | rs |
| Shift \(r_s\) of gaussian. | |
Protected Attributes inherited from nnp::SymFncBaseCutoff | |
| double | cutoffAlpha |
| Cutoff parameter \(\alpha\). | |
| std::string | subtype |
| Subtype string (specifies cutoff type). | |
| CutoffFunction | fc |
| Cutoff function used by this symmetry function. | |
| CutoffFunction::CutoffType | cutoffType |
| Cutoff type used by this symmetry function. | |
Protected Attributes inherited from nnp::SymFnc | |
| std::size_t | type |
| Symmetry function type. | |
| ElementMap | elementMap |
| Copy of element map. | |
| std::size_t | index |
| Symmetry function index (per element). | |
| std::size_t | lineNumber |
| Line number. | |
| std::size_t | ec |
| Element index of center atom. | |
| std::size_t | minNeighbors |
| Minimum number of neighbors required. | |
| double | Smin |
| Minimum for scaling range. | |
| double | Smax |
| Maximum for scaling range. | |
| double | Gmin |
| Minimum unscaled symmetry function value. | |
| double | Gmax |
| Maximum unscaled symmetry function value. | |
| double | Gmean |
| Mean unscaled symmetry function value. | |
| double | Gsigma |
| Sigma of unscaled symmetry function values. | |
| double | rc |
| Cutoff radius \(r_c\). | |
| double | scalingFactor |
| Scaling factor. | |
| double | convLength |
| Data set normalization length conversion factor. | |
| ScalingType | scalingType |
| Symmetry function scaling type used by this symmetry function. | |
| std::set< std::string > | parameters |
| Set with symmetry function parameter IDs (lookup for printing). | |
| std::vector< std::size_t > | indexPerElement |
| Per-element index for derivative memory in Atom::Neighbor::dGdr arrays. | |
| std::vector< std::vector< std::size_t > > | cacheIndices |
| Cache indices for each element. | |
Additional Inherited Members | |
Public Types inherited from nnp::SymFnc | |
| enum | ScalingType { ST_NONE , ST_SCALE , ST_CENTER , ST_SCALECENTER , ST_SCALESIGMA } |
| List of available scaling types. More... | |
Protected Types inherited from nnp::SymFnc | |
| typedef std::map< std::string, std::pair< std::string, std::string > > | PrintFormat |
| typedef std::vector< std::string > | PrintOrder |
Static Protected Member Functions inherited from nnp::SymFnc | |
| static PrintFormat const | initializePrintFormat () |
| Initialize static print format map for all possible parameters. | |
| static PrintOrder const | initializePrintOrder () |
| Initialize static print order vector for all possible parameters. | |
Static Protected Attributes inherited from nnp::SymFnc | |
| static std::size_t const | sfinfoWidth = 12 |
| Width of the SFINFO parameter description field (see parameterInfo()). | |
| static PrintFormat const | printFormat = initializePrintFormat() |
| Map of parameter format strings and empty strings. | |
| static PrintOrder const | printOrder = initializePrintOrder() |
| Vector of parameters in order of printing. | |
Intermediate class for angular SFs based on cutoffs and exponentials.
Definition at line 29 of file SymFncBaseExpAng.h.
|
protected |
Constructor, initializes type.
Definition at line 30 of file SymFncBaseExpAng.cpp.
References e1, e2, nnp::SymFnc::elementMap, eta, lambda, nnp::SymFnc::minNeighbors, nnp::SymFnc::parameters, rs, nnp::SymFncBaseCutoff::SymFncBaseCutoff(), nnp::SymFnc::type, useIntegerPow, zeta, and zetaInt.
Referenced by nnp::SymFncExpAngn::SymFncExpAngn(), and nnp::SymFncExpAngw::SymFncExpAngw().


|
virtual |
Set symmetry function parameters.
| [in] | parameterString | String containing angular symmetry function parameters. |
Implements nnp::SymFnc.
Definition at line 50 of file SymFncBaseExpAng.cpp.
References nnp::SymFncBaseCutoff::cutoffAlpha, e1, e2, nnp::SymFnc::ec, nnp::SymFnc::elementMap, eta, nnp::SymFncBaseCutoff::fc, lambda, nnp::SymFnc::rc, nnp::reduce(), rs, nnp::split(), nnp::SymFnc::type, useIntegerPow, zeta, and zetaInt.

|
virtual |
Change length unit.
| [in] | convLength | Multiplicative length unit conversion factor. |
Implements nnp::SymFnc.
Definition at line 95 of file SymFncBaseExpAng.cpp.
References nnp::SymFnc::convLength, nnp::SymFncBaseCutoff::cutoffAlpha, eta, nnp::SymFncBaseCutoff::fc, nnp::SymFnc::rc, and rs.
|
virtual |
Get settings file line from currently set parameters.
Implements nnp::SymFnc.
Definition at line 108 of file SymFncBaseExpAng.cpp.
References nnp::SymFnc::convLength, e1, e2, nnp::SymFnc::ec, nnp::SymFnc::elementMap, eta, lambda, nnp::SymFnc::rc, rs, nnp::strpr(), nnp::SymFnc::type, and zeta.

|
virtual |
Give symmetry function parameters in one line.
Implements nnp::SymFnc.
Definition at line 125 of file SymFncBaseExpAng.cpp.
References nnp::SymFnc::convLength, nnp::SymFncBaseCutoff::cutoffAlpha, e1, e2, nnp::SymFnc::ec, nnp::SymFnc::elementMap, eta, nnp::SymFnc::getPrintFormat(), nnp::SymFnc::index, lambda, nnp::SymFnc::lineNumber, nnp::SymFnc::rc, rs, nnp::strpr(), nnp::SymFncBaseCutoff::subtype, nnp::SymFnc::type, and zeta.

|
virtual |
Get description with parameter names and values.
Reimplemented from nnp::SymFncBaseCutoff.
Definition at line 143 of file SymFncBaseExpAng.cpp.
References nnp::SymFnc::convLength, e1, e2, nnp::SymFnc::elementMap, eta, lambda, nnp::pad(), nnp::SymFncBaseCutoff::parameterInfo(), rs, nnp::SymFnc::sfinfoWidth, nnp::strpr(), and zeta.

|
virtual |
Calculate (partial) symmetry function value for one given distance.
| [in] | distance | Distance between two atoms. |
Implements nnp::SymFnc.
Definition at line 166 of file SymFncBaseExpAng.cpp.
References nnp::SymFnc::convLength, eta, nnp::SymFncBaseCutoff::fc, p, and rs.
|
virtual |
Calculate (partial) symmetry function value for one given angle.
| [in] | angle | Angle between triplet of atoms (in radians). |
Implements nnp::SymFnc.
Definition at line 174 of file SymFncBaseExpAng.cpp.
|
virtual |
Check whether symmetry function is relevant for given element.
| [in] | index | Index of given element. |
Implements nnp::SymFnc.
Definition at line 179 of file SymFncBaseExpAng.cpp.
References e1, e2, and nnp::SymFnc::index.
|
virtual |
Get unique cache identifiers.
Reimplemented from nnp::SymFnc.
Definition at line 186 of file SymFncBaseExpAng.cpp.
References nnp::SymFnc::convLength, nnp::SymFncBaseCutoff::cutoffAlpha, e1, e2, nnp::SymFnc::rc, nnp::strpr(), and nnp::SymFncBaseCutoff::subtype.

|
inline |
Get private useIntegerPow member variable.
Definition at line 139 of file SymFncBaseExpAng.h.
References useIntegerPow.
|
inline |
Get private e1 member variable.
Definition at line 140 of file SymFncBaseExpAng.h.
References e1.
Referenced by nnp::SymGrpExpAngn::addMember(), and nnp::SymGrpExpAngw::addMember().

|
inline |
Get private e2 member variable.
Definition at line 141 of file SymFncBaseExpAng.h.
References e2.
Referenced by nnp::SymGrpExpAngn::addMember(), and nnp::SymGrpExpAngw::addMember().

|
inline |
Get private zetaInt member variable.
Definition at line 142 of file SymFncBaseExpAng.h.
References zetaInt.
|
inline |
Get private lambda member variable.
Definition at line 143 of file SymFncBaseExpAng.h.
References lambda.
|
inline |
|
inline |
Get private zeta member variable.
Definition at line 145 of file SymFncBaseExpAng.h.
References zeta.
|
inline |
|
protected |
Whether to use integer version of power function (faster).
Definition at line 114 of file SymFncBaseExpAng.h.
Referenced by nnp::SymFncExpAngn::calculate(), nnp::SymFncExpAngw::calculate(), getUseIntegerPow(), setParameters(), and SymFncBaseExpAng().
|
protected |
Element index of neighbor atom 1.
Definition at line 116 of file SymFncBaseExpAng.h.
Referenced by nnp::SymFncExpAngn::calculate(), nnp::SymFncExpAngw::calculate(), checkRelevantElement(), getCacheIdentifiers(), getE1(), getSettingsLine(), nnp::SymFncExpAngn::operator<(), nnp::SymFncExpAngw::operator<(), nnp::SymFncExpAngn::operator==(), nnp::SymFncExpAngw::operator==(), parameterInfo(), parameterLine(), setParameters(), and SymFncBaseExpAng().
|
protected |
Element index of neighbor atom 2.
Definition at line 118 of file SymFncBaseExpAng.h.
Referenced by nnp::SymFncExpAngn::calculate(), nnp::SymFncExpAngw::calculate(), checkRelevantElement(), getCacheIdentifiers(), getE2(), getSettingsLine(), nnp::SymFncExpAngn::operator<(), nnp::SymFncExpAngw::operator<(), nnp::SymFncExpAngn::operator==(), nnp::SymFncExpAngw::operator==(), parameterInfo(), parameterLine(), setParameters(), and SymFncBaseExpAng().
|
protected |
Integer version of \(\zeta\).
Definition at line 120 of file SymFncBaseExpAng.h.
Referenced by nnp::SymFncExpAngn::calculate(), nnp::SymFncExpAngw::calculate(), getZetaInt(), setParameters(), and SymFncBaseExpAng().
|
protected |
Cosine shift factor.
Definition at line 122 of file SymFncBaseExpAng.h.
Referenced by nnp::SymFncExpAngn::calculate(), nnp::SymFncExpAngw::calculate(), calculateAngularPart(), getLambda(), getSettingsLine(), nnp::SymFncExpAngn::operator<(), nnp::SymFncExpAngw::operator<(), nnp::SymFncExpAngn::operator==(), nnp::SymFncExpAngw::operator==(), parameterInfo(), parameterLine(), setParameters(), and SymFncBaseExpAng().
|
protected |
Width \(\eta\) of gaussian.
Definition at line 124 of file SymFncBaseExpAng.h.
Referenced by nnp::SymFncExpAngn::calculate(), nnp::SymFncExpAngw::calculate(), calculateRadialPart(), changeLengthUnit(), getEta(), getSettingsLine(), nnp::SymFncExpAngn::operator<(), nnp::SymFncExpAngw::operator<(), nnp::SymFncExpAngn::operator==(), nnp::SymFncExpAngw::operator==(), parameterInfo(), parameterLine(), setParameters(), and SymFncBaseExpAng().
|
protected |
Exponent \(\zeta\) of cosine term.
Definition at line 126 of file SymFncBaseExpAng.h.
Referenced by nnp::SymFncExpAngn::calculate(), nnp::SymFncExpAngw::calculate(), calculateAngularPart(), getSettingsLine(), getZeta(), nnp::SymFncExpAngn::operator<(), nnp::SymFncExpAngw::operator<(), nnp::SymFncExpAngn::operator==(), nnp::SymFncExpAngw::operator==(), parameterInfo(), parameterLine(), setParameters(), and SymFncBaseExpAng().
|
protected |
Shift \(r_s\) of gaussian.
Definition at line 128 of file SymFncBaseExpAng.h.
Referenced by nnp::SymFncExpAngn::calculate(), nnp::SymFncExpAngw::calculate(), calculateRadialPart(), changeLengthUnit(), getRs(), getSettingsLine(), nnp::SymFncExpAngn::operator<(), nnp::SymFncExpAngw::operator<(), parameterInfo(), parameterLine(), setParameters(), and SymFncBaseExpAng().