material::pd::BaseInfluenceFn Class Reference

A base class for computing influence function. More...

#include <influenceFn.h>

Inheritance diagram for material::pd::BaseInfluenceFn:

Collaboration diagram for material::pd::BaseInfluenceFn:

Public Member Functions
	BaseInfluenceFn ()=default
	Constructor.
virtual double	getInfFn (const double &r) const =0
	Returns the value of influence function. More...
virtual double	getMoment (const size_t &i) const =0
	Returns the moment of influence function. More...
virtual void	print () const
	Prints the information about the instance of the object.
virtual void	print (int nt, int lvl) const
	Prints the information about the instance of the object. More...
virtual std::string	printStr (int nt, int lvl) const
	Returns the string containing information about the instance of the object. More...

Detailed Description

A base class for computing influence function.

Member Function Documentation

getInfFn()

virtual double material::pd::BaseInfluenceFn::getInfFn ( const double &  r ) const

pure virtual

Returns the value of influence function.

Parameters

r	Reference (initial) bond length

Returns

value Influence function at r

Implemented in material::pd::GaussianInfluenceFn, material::pd::LinearInfluenceFn, and material::pd::ConstInfluenceFn.

getMoment()

virtual double material::pd::BaseInfluenceFn::getMoment ( const size_t &  i ) const

pure virtual

Returns the moment of influence function.

If is the influence function for then moment is given by

Parameters

i	ith moment

Returns

moment Moment

Implemented in material::pd::GaussianInfluenceFn, material::pd::LinearInfluenceFn, and material::pd::ConstInfluenceFn.

Referenced by material::pd::RNPBond::RNPBond().

Here is the caller graph for this function:

print()

virtual void material::pd::BaseInfluenceFn::print ( int  nt, int  lvl  ) const

inlinevirtual

Prints the information about the instance of the object.

Parameters

nt	Number of tabs to append before each line of string
lvl	Level of information sought (higher level means more information)

Reimplemented in material::pd::GaussianInfluenceFn, material::pd::LinearInfluenceFn, and material::pd::ConstInfluenceFn.

Here is the call graph for this function:

printStr()

virtual std::string material::pd::BaseInfluenceFn::printStr ( int  nt, int  lvl  ) const

inlinevirtual

Returns the string containing information about the instance of the object.

Parameters

nt	Number of tabs to append before each line of string
lvl	Level of information sought (higher level means more information)

Returns

string String containing information about this object

Reimplemented in material::pd::GaussianInfluenceFn, material::pd::LinearInfluenceFn, and material::pd::ConstInfluenceFn.

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• /root/project/src/material/pd/influenceFn.h