ODFCellProcessor Class Reference

#include <ODFCellProcessor.h>

Inheritance diagram for ODFCellProcessor:

Public Member Functions
	ODFCellProcessor (double cutoffRadius, ODF *odf, const std::array< double, 3 > &simBoxSize)
void	initTraversal () override
void	preprocessCell (ParticleCell &cell) override
void	processCellPair (ParticleCell &cell1, ParticleCell &cell2, bool sumAll) override
void	processCell (ParticleCell &cell) override
double	processSingleMolecule (Molecule *m1, ParticleCell &cell2) override
void	postprocessCell (ParticleCell &cell) override
void	endTraversal () override
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

Class to calculate an orientation distribution function. It calculates the distribution of relative orientations of particles using the ODF class.

Member Function Documentation

endTraversal()

void ODFCellProcessor::endTraversal ( )

overridevirtual

Called after the traversal finished.

Implements CellProcessor.

initTraversal()

void ODFCellProcessor::initTraversal ( )

overridevirtual

called before the traversal starts.

Parameters

numCells

number of cells in window

Implements CellProcessor.

postprocessCell()

void ODFCellProcessor::postprocessCell ( ParticleCell &  cell )

overridevirtual

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

Implements CellProcessor.

preprocessCell()

void ODFCellProcessor::preprocessCell ( ParticleCell &  cell )

overridevirtual

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

Implements CellProcessor.

processCell()

void ODFCellProcessor::processCell ( ParticleCell &  cell )

overridevirtual

Called when this cell is the current cell.

Note

will not be called for empty cells.

Implements CellProcessor.

processCellPair()

void ODFCellProcessor::processCellPair ( ParticleCell &  cell1, ParticleCell &  cell2, bool  sumAll  )

overridevirtual

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 ODFCellProcessor::processSingleMolecule ( Molecule *  m1, ParticleCell &  cell2  )

overridevirtual

Implements CellProcessor.

---

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

• src/particleContainer/adapter/ODFCellProcessor.h
• src/particleContainer/adapter/ODFCellProcessor.cpp