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

#include <PseudoParticle.h>

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

Public Member Functions

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
 

Protected Attributes

Vector3< double > _center
 
double _radius
 
double _radiusSquared
 
int _order
 

Detailed Description

Base class for multipole and local pseudo-particles. Define center, radius and order. Radius will be more extensively used (and tested) in the adaptive case.

Member Function Documentation

◆ clear()

virtual void bhfmm::PseudoParticle::clear ( )
pure virtual

set expansions to zero for a new iteration

Implemented in bhfmm::SHLocalParticle, and bhfmm::SHMultipoleParticle.

◆ getCenter()

const Vector3<double>& bhfmm::PseudoParticle::getCenter ( ) const
inline
Returns
the center of the particle

◆ getOrder()

int bhfmm::PseudoParticle::getOrder ( ) const
inline
Todo:
: is this needed?
Returns
the order of the particle

◆ getRadius()

double bhfmm::PseudoParticle::getRadius ( ) const
inline

get the radius of the pseudo particle

Returns
radius

◆ setCenter()

void bhfmm::PseudoParticle::setCenter ( const Vector3< double > &  center)
inline

set the center of the particle

Parameters
center

◆ setOrder()

void bhfmm::PseudoParticle::setOrder ( int  order)
inline

set the order

Parameters
order

◆ setRadius()

void bhfmm::PseudoParticle::setRadius ( double  radius)
inline

set the radius

Parameters
radius

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