ls1-MarDyn
ls1-MarDyn molecular dynamics code
Public Member Functions | List of all members
LegacyCellProcessor Class Reference

#include <LegacyCellProcessor.h>

Inheritance diagram for LegacyCellProcessor:
CellProcessor

Public Member Functions

LegacyCellProcessoroperator= (const LegacyCellProcessor &)=delete
 
 LegacyCellProcessor (const double cutoffRadius, const double LJCutoffRadius, ParticlePairsHandler *particlePairsHandler)
 
void initTraversal ()
 
void preprocessCell (ParticleCell &)
 
void processCellPair (ParticleCell &cell1, ParticleCell &cell2, bool sumAll=false)
 
double processSingleMolecule (Molecule *m1, ParticleCell &cell2)
 
void processCell (ParticleCell &cell)
 
void postprocessCell (ParticleCell &)
 
void endTraversal ()
 
- Public Member Functions inherited from CellProcessor
 CellProcessor (const double cutoffRadius, const double LJCutoffRadius)
 
virtual ~CellProcessor ()
 
double getCutoffRadius () const
 
double getLJCutoffRadius () const
 
void setCutoffRadius (const double c)
 
void setLJCutoffRadius (const double ljc)
 
double getCutoffRadiusSquare () const
 
double getLJCutoffRadiusSquare () const
 
void setCutoffRadiusSquare (const double c)
 
void setLJCutoffRadiusSquare (const double ljc)
 

Additional Inherited Members

- Protected Attributes inherited from CellProcessor
double _cutoffRadiusSquare
 
double _LJCutoffRadiusSquare
 

Detailed Description

This class is a simple extraction of the cell handling from the old class Blocktraverse. I expect it to be slightly refactored one day...

Member Function Documentation

◆ endTraversal()

void LegacyCellProcessor::endTraversal ( )
virtual

Called after the traversal finished.

Implements CellProcessor.

◆ initTraversal()

void LegacyCellProcessor::initTraversal ( )
virtual

called before the traversal starts.

Parameters
numCellsnumber of cells in window

Implements CellProcessor.

◆ postprocessCell()

void LegacyCellProcessor::postprocessCell ( ParticleCell cell)
inlinevirtual

Called after the cell has been considered for the last time during the traversal.

Implements CellProcessor.

◆ preprocessCell()

void LegacyCellProcessor::preprocessCell ( ParticleCell cell)
inlinevirtual

Called before a cell is touched for the first time during an interation.

Implements CellProcessor.

◆ processCell()

void LegacyCellProcessor::processCell ( ParticleCell cell)
virtual

Called when this cell is the current cell.

Note
will not be called for empty cells.

Implements CellProcessor.

◆ processCellPair()

void LegacyCellProcessor::processCellPair ( ParticleCell cell1,
ParticleCell cell2,
bool  sumAll = false 
)
virtual

Called for each cell pair within the cutoff radius. Called exactly once per pair (i.e. pairs are not ordered).

Note
will not be called for empty cells. Sum up all macroscopic values (e.g. for hs) or only half of them (e.g. for fs)

Implements CellProcessor.

◆ processSingleMolecule()

double LegacyCellProcessor::processSingleMolecule ( Molecule m1,
ParticleCell cell2 
)
virtual

Implements CellProcessor.


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