CylinderPairCorrelationEstimator Class Reference

Compute the two-body pair-correlation function, g(r) ~ <rho(r)rho(0)>. More...

#include <estimator.h>

Inheritance diagram for CylinderPairCorrelationEstimator:

Collaboration diagram for CylinderPairCorrelationEstimator:

Public Member Functions
	CylinderPairCorrelationEstimator (const Path &, ActionBase *, const MTRand &, double, int _frequency=1, string _label="cyl_pair")
	Constructor. More...
	~CylinderPairCorrelationEstimator ()
	Destructor.
void	sample ()
	Sample the estimator. More...
string	getName () const
	Get the name of the estimator.
Public Member Functions inherited from EstimatorBase
	EstimatorBase (const Path &_path, ActionBase *_actionPtr, const MTRand &_random, double _maxR, int _frequency=1, string _label="")
	Constructor. More...
virtual	~EstimatorBase ()
	Destructor.
void	reset ()
	Reset numAccumulated and the estimator to 0.
void	restart (const uint32, const uint32)
	Restart the measurment process from a previous state.
virtual void	output ()
	Output the estimator value to disk. More...
virtual void	outputFlat ()
	Output a flat estimator value to disk. More...
virtual void	outputFooter ()
	Ouptut the fooder to disk.
bool	baseSample ()
	Determine the basic sampling condition. More...
uint32	getTotNumAccumulated () const
	Get the total number of accumulated measurments.
uint32	getNumAccumulated () const
	Get the number of accumulated measurements since the last reset.
uint32	getNumSampled () const
	Get the number of samples since the last reset.
void	prepare ()
	Prepare the estimator for i/o. More...
void	addEndLine ()
	Add a carriage return to estimator files.
void	appendLabel (string append)
	Append to default label. More...
string	getLabel () const
	Get the estimator label.

Static Public Attributes
static const string	name

Additional Inherited Members
Protected Member Functions inherited from EstimatorBase
void	initialize (int)
	Initialize estimator. More...
void	initialize (vector< string >)
	Initialize estimator. More...
Protected Attributes inherited from EstimatorBase
const Path &	path
	A constant reference to the paths.
ActionBase *	actionPtr
	A pointer to the action.
MTRand	random
double	maxR
fstream *	outFilePtr
	The output fie.
map< string, int >	estIndex
	Map estimator labels to indices.
Array< double, 1 >	estimator
	The estimator array.
Array< double, 1 >	norm
	The normalization factor for each estimator.
int	numEst
	The number of individual quantities measured.
int	frequency
	The frequency at which we accumulate.
int	startSlice
	Where imaginary time averages begin.
int	endSlice
	Where imaginary time averages end.
int	endDiagSlice
	Where imaginary time averages end for diagonal estimiators.
vector< double >	sliceFactor
	Used to properly incorporate end affects.
string	label
	The label used for the output file.
uint32	numSampled
	The number of times we have sampled.
uint32	numAccumulated
	The number of accumulated values.
uint32	totNumAccumulated
	The total number of accumulated values.
int	numBeads0
	The target number of beads for the canonical ensemble.
bool	diagonal
	Is this a diagonal estimator?
bool	endLine
	Should we output a carriage return?
bool	canonical
	Are we in the canonical ensemble?
string	header
	The data file header.

Detailed Description

Compute the two-body pair-correlation function, g(r) ~ <rho(r)rho(0)>.

Definition at line 975 of file estimator.h.

Constructor & Destructor Documentation

CylinderPairCorrelationEstimator()

CylinderPairCorrelationEstimator::CylinderPairCorrelationEstimator	(	const Path &	_path,
		ActionBase *	_actionPtr,
		const MTRand &	_random,
		double	_maxR,
		int	_frequency = 1,
		string	_label = "cyl_pair"
	)

Constructor.

For the pair correlation function, we measure NPCFSEP positions to get high enough data density to observe possible osscilations. The normalization depends on dimension.

Definition at line 3536 of file estimator.cpp.

                                       : 
    EstimatorBase(_path,_actionPtr,_random,_maxR,_frequency,_label) 
{
    /* The spatial discretization */
    dR = 0.5*sqrt(sum(path.boxPtr->periodic))*path.boxPtr->side[NDIM-1] / (1.0*NPCFSEP);
 
    /* This is a diagonal estimator that gets its own file */
    initialize(NPCFSEP);
 
    /* The header is the first line which contains the spatial separations */
    header = str(format("#%15.3E") % 0.0);
    for (int n = 1; n < NPCFSEP; n++) 
        header.append(str(format("%16.3E") % ((n)*dR)));
 
    /* The normalization factor for the pair correlation function */
    norm = 0.5*path.boxPtr->side[NDIM-1] / dR;
}

Here is the call graph for this function:

Member Function Documentation

sample()

void CylinderPairCorrelationEstimator::sample ( )

virtual

Sample the estimator.

Here we overload the cylinder pair correlation function estimator, as we only measure when we have some relevant particle separations.

Reimplemented from EstimatorBase.

Definition at line 3583 of file estimator.cpp.

                                              {
    numSampled++;
 
    if (baseSample() && (sum(actionPtr->cylSepHist) > 0)) {
        totNumAccumulated++;
        numAccumulated++;
        accumulate();
    }
}

Here is the call graph for this function:

---

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

• include/estimator.h
• src/estimator.cpp