nnp::SymGrpBaseComp Class Reference

#include <SymGrpBaseComp.h>

Inheritance diagram for nnp::SymGrpBaseComp:

Collaboration diagram for nnp::SymGrpBaseComp:

Public Member Functions
double	getRmin () const
	Getter for rmin.
double	getRmax () const
	Getter for rmax.
Public Member Functions inherited from nnp::SymGrp
virtual	~SymGrp ()
	Virtual destructor.
virtual bool	operator== (SymGrp const &rhs) const =0
	Overload == operator.
virtual bool	operator< (SymGrp const &rhs) const =0
	Overload < operator.
bool	operator!= (SymGrp const &rhs) const
	Overload != operator.
bool	operator> (SymGrp const &rhs) const
	Overload > operator.
bool	operator<= (SymGrp const &rhs) const
	Overload <= operator.
bool	operator>= (SymGrp const &rhs) const
	Overload >= operator.
virtual bool	addMember (SymFnc const *const symmetryFunction)=0
	Potentially add a member to group.
virtual void	sortMembers ()=0
	Sort member symmetry functions.
virtual void	setScalingFactors ()=0
	Fill scalingFactors with values from member symmetry functions.
virtual void	calculate (Atom &atom, bool const derivatives) const =0
	Calculate all symmetry functions of this group for one atom.
virtual std::vector< std::string >	parameterLines () const =0
	Give symmetry function group parameters on multiple lines.
void	setIndex (std::size_t index)
	Set private index member variable.
std::size_t	getIndex () const
	Get private index member variable.
std::size_t	getType () const
	Get private type member variable.
std::size_t	getEc () const
	Get private ec member variable.

Protected Member Functions
	SymGrpBaseComp (std::size_t type, ElementMap const &elementMap)
	Constructor, sets type.
Protected Member Functions inherited from nnp::SymGrp
	SymGrp (std::size_t type, ElementMap const &elementMap)
	Constructor, sets type.
std::string	getPrintFormatCommon () const
	Get common parameter line format string.
std::string	getPrintFormatMember () const
	Get member parameter line format string.

Protected Attributes
double	rmin
	Minimum radius within group.
double	rmax
	Maximum radius within group.
Protected Attributes inherited from nnp::SymGrp
std::size_t	type
	Symmetry function type.
ElementMap	elementMap
	Copy of element map.
std::size_t	index
	Symmetry function group index.
std::size_t	ec
	Element index of center atom (common feature).
double	convLength
	Data set normalization length conversion factor.
std::vector< size_t >	memberIndex
	Vector containing indices of all member symmetry functions.
std::vector< double >	scalingFactors
	Scaling factors of all member symmetry functions.
std::set< std::string >	parametersCommon
	Set of common parameters IDs.
std::set< std::string >	parametersMember
	Set of common parameters IDs.
std::vector< std::vector< std::size_t > >	memberIndexPerElement
	Vector containing per-element indices of all member symmetry functions.

Additional Inherited Members
Protected Types inherited from nnp::SymGrp
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::SymGrp
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::SymGrp
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.

Detailed Description

Definition at line 30 of file SymGrpBaseComp.h.

Constructor & Destructor Documentation

SymGrpBaseComp()

SymGrpBaseComp::SymGrpBaseComp ( std::size_t type, ElementMap const & elementMap )

protected

Constructor, sets type.

Parameters

[in]	type	Type of symmetry functions grouped.
[in]	elementMap	Element Map used.

Definition at line 24 of file SymGrpBaseComp.cpp.

                                                                        :
    SymGrp(type, elementMap),
    rmin(0.0),
    rmax(0.0)
{
    parametersCommon.insert("rs/rl");
    parametersCommon.insert("rc");
 
    parametersMember.insert("subtype");
    parametersMember.insert("rs/rl");
    parametersMember.insert("rc");
}

References nnp::SymGrp::elementMap, nnp::SymGrp::parametersCommon, nnp::SymGrp::parametersMember, rmax, rmin, nnp::SymGrp::SymGrp(), and nnp::SymGrp::type.

Referenced by nnp::SymGrpBaseCompAng::SymGrpBaseCompAng(), nnp::SymGrpBaseCompAngWeighted::SymGrpBaseCompAngWeighted(), nnp::SymGrpCompRad::SymGrpCompRad(), and nnp::SymGrpCompRadWeighted::SymGrpCompRadWeighted().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

getRmin()

double nnp::SymGrpBaseComp::getRmin ( ) const

inline

Getter for rmin.

Definition at line 56 of file SymGrpBaseComp.h.

{
    return rmin;
}

References rmin.

getRmax()

double nnp::SymGrpBaseComp::getRmax ( ) const

inline

Getter for rmax.

Definition at line 61 of file SymGrpBaseComp.h.

{
    return rmax;
}

References rmax.

Member Data Documentation

rmin

double nnp::SymGrpBaseComp::rmin

protected

Minimum radius within group.

Definition at line 40 of file SymGrpBaseComp.h.

Referenced by nnp::SymGrpCompAngn::addMember(), nnp::SymGrpCompAngnWeighted::addMember(), nnp::SymGrpCompAngw::addMember(), nnp::SymGrpCompAngwWeighted::addMember(), nnp::SymGrpCompRad::addMember(), nnp::SymGrpCompRadWeighted::addMember(), nnp::SymGrpCompAngn::calculate(), nnp::SymGrpCompAngnWeighted::calculate(), nnp::SymGrpCompAngw::calculate(), nnp::SymGrpCompAngwWeighted::calculate(), nnp::SymGrpCompRad::calculate(), nnp::SymGrpCompRadWeighted::calculate(), getRmin(), nnp::SymGrpBaseCompAng::parameterLines(), nnp::SymGrpBaseCompAngWeighted::parameterLines(), nnp::SymGrpCompRad::parameterLines(), nnp::SymGrpCompRadWeighted::parameterLines(), and SymGrpBaseComp().

rmax

double nnp::SymGrpBaseComp::rmax

protected

Maximum radius within group.

Definition at line 42 of file SymGrpBaseComp.h.

Referenced by nnp::SymGrpCompAngn::addMember(), nnp::SymGrpCompAngnWeighted::addMember(), nnp::SymGrpCompAngw::addMember(), nnp::SymGrpCompAngwWeighted::addMember(), nnp::SymGrpCompRad::addMember(), nnp::SymGrpCompRadWeighted::addMember(), nnp::SymGrpCompAngn::calculate(), nnp::SymGrpCompAngnWeighted::calculate(), getRmax(), nnp::SymGrpBaseCompAng::parameterLines(), nnp::SymGrpBaseCompAngWeighted::parameterLines(), nnp::SymGrpCompRad::parameterLines(), nnp::SymGrpCompRadWeighted::parameterLines(), and SymGrpBaseComp().

---

The documentation for this class was generated from the following files:

• /home/runner/work/n2p2/n2p2/src/libnnp/SymGrpBaseComp.h
• /home/runner/work/n2p2/n2p2/src/libnnp/SymGrpBaseComp.cpp