ls1-MarDyn
ls1-MarDyn molecular dynamics code
Public Member Functions | Public Attributes | List of all members
FFTAccelerableExpansion Class Referenceabstract

#include <FFTAccelerableExpansion.h>

Inheritance diagram for FFTAccelerableExpansion:
DummyExpansion

Public Member Functions

 FFTAccelerableExpansion ()
 Constructor, set the storage pointer to NULL by default.
 
virtual ~FFTAccelerableExpansion ()
 virtual destructor to ensure correct destructor sequence, delete the _FFTData if set
 
virtual double & get_C (unsigned l, unsigned m)=0
 
virtual double & get_S (unsigned l, unsigned m)=0
 
bool issetFFTData ()
 inline isset test
 

Public Attributes

FFTDataContainer_FFTData
 

Detailed Description

Interface of the expansion used by the FFTAcceleration, Expansions have to inherit it

Requires accessor to the expansion's values and set a FFTDataContainer storage (abstract class by itself) Delete the storage by itself in its virtual destructor.

Member Function Documentation

◆ get_C()

virtual double& FFTAccelerableExpansion::get_C ( unsigned  l,
unsigned  m 
)
pure virtual

Accessor to the real part of an expansion. Only require access to the positive m part, the negative m will be reconstructed using the symmetry

Parameters
unsignedint l, 0 <= l < max_order
unsignedint m, 0 <= m <= l
Returns
double & C[l][m]

Implemented in DummyExpansion.

◆ get_S()

virtual double& FFTAccelerableExpansion::get_S ( unsigned  l,
unsigned  m 
)
pure virtual

Accessor to the imaginary part of an expansion. Only require access to the positive m part, the negative m will be reconstructed using the symmetry

Parameters
unsignedint l, 0 <= l < max_order
unsignedint m, 0 <= m <= l
Returns
double & C[l][m]

Implemented in DummyExpansion.

Member Data Documentation

◆ _FFTData

FFTDataContainer* FFTAccelerableExpansion::_FFTData

FFTDataContainer pointer, abstract class whose implementations store all required data to the M2L FFT acceleration by an FFTAcceleration's implementation

Will need to be copied by a copy constructor using _FFTData->copyContainer() to get a copy (see FFTDataContainer.h)


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