ls1-MarDyn
ls1-MarDyn molecular dynamics code
Public Member Functions | List of all members
bhfmm::MultipoleParticle Class Referenceabstract

#include <MultipoleParticle.h>

Inheritance diagram for bhfmm::MultipoleParticle:
bhfmm::PseudoParticle bhfmm::SHMultipoleParticle

Public Member Functions

virtual void addSource (const Vector3< double > &position, double charge)=0
 
virtual void addMultipoleParticle (const MultipoleParticle &small)=0
 
virtual void actOnLocalParticle (LocalParticle &local) const =0
 
virtual void actOnTarget (const Vector3< double > &position, double charge, double &pot, Vector3< double > &force) const =0
 
- Public Member Functions inherited from bhfmm::PseudoParticle
const Vector3< double > & getCenter () const
 
void setCenter (const Vector3< double > &center)
 
int getOrder () const
 
void setOrder (int order)
 
double getRadius () const
 
void setRadius (double radius)
 
virtual void clear ()=0
 
virtual int getNumEntries () const =0
 

Additional Inherited Members

- Protected Attributes inherited from bhfmm::PseudoParticle
Vector3< double > _center
 
double _radius
 
double _radiusSquared
 
int _order
 

Detailed Description

Interface for Multipole particles of any expansion.

Member Function Documentation

◆ actOnLocalParticle()

virtual void bhfmm::MultipoleParticle::actOnLocalParticle ( LocalParticle local) const
pure virtual

M2L operator

Parameters
local

Implemented in bhfmm::SHMultipoleParticle.

◆ actOnTarget()

virtual void bhfmm::MultipoleParticle::actOnTarget ( const Vector3< double > &  position,
double  charge,
double &  pot,
Vector3< double > &  force 
) const
pure virtual

M2P operator

Parameters
position
charge
potentialstores resulting potential
forcestores resulting force

Implemented in bhfmm::SHMultipoleParticle.

◆ addMultipoleParticle()

virtual void bhfmm::MultipoleParticle::addMultipoleParticle ( const MultipoleParticle small)
pure virtual

M2M operator

Parameters
smallthe smaller particle to be added to the larger one (this)

Implemented in bhfmm::SHMultipoleParticle.

◆ addSource()

virtual void bhfmm::MultipoleParticle::addSource ( const Vector3< double > &  position,
double  charge 
)
pure virtual

P2M operator

Parameters
position
charge

Implemented in bhfmm::SHMultipoleParticle.


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