material::BaseInfluenceFn Class Reference

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

#include <influenceFn.h>

Inheritance diagram for material::BaseInfluenceFn:

Collaboration diagram for material::BaseInfluenceFn:

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

Detailed Description

A base class for computing influence function.

Definition at line 22 of file influenceFn.h.

Constructor & Destructor Documentation

BaseInfluenceFn()

material::BaseInfluenceFn::BaseInfluenceFn ( )

default

Constructor.

Member Function Documentation

getInfFn()

virtual double material::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::ConstInfluenceFn, material::LinearInfluenceFn, and material::GaussianInfluenceFn.

getMoment()

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

pure virtual

Returns the moment of influence function.

If \( J(r) \) is the influence function for \( r\in [0,1)\) then \( i^{th} \) moment is given by

\[ M_i = \int_0^1 J(r) r^i dr. \]

Parameters

i	ith moment

Returns

moment Moment

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

print() [1/2]

virtual void material::BaseInfluenceFn::print ( ) const

inlinevirtual

Prints the information about the object.

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

Definition at line 75 of file influenceFn.h.

{ print(0, 0); }

References print().

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

print() [2/2]

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

inlinevirtual

Prints the information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

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

Definition at line 72 of file influenceFn.h.

{ std::cout << printStr(nt, lvl); }

References printStr().

Here is the call graph for this function:

printStr()

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

inlinevirtual

Returns the string containing printable information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Returns

string String containing printable information about the object

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

Definition at line 54 of file influenceFn.h.

                                                    {
 
    auto tabS = util::io::getTabS(nt);
    std::ostringstream oss;
    oss << tabS << "------- BaseInfluenceFn --------" << std::endl << std::endl;
    oss << tabS << "Provides abstraction for different influence function "
                   "types" << std::endl;
    oss << tabS << std::endl;
 
    return oss.str();
  }

References util::io::getTabS().

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:

• /home/user/project/src/material/mparticle/influenceFn.h