Interference2DLattice Class Reference

Description

Interference function of a 2D lattice.

Inheritance diagram for Interference2DLattice:

Public Member Functions
	Interference2DLattice (const Lattice2D &lattice)
	~Interference2DLattice () override
std::string	className () const final
Interference2DLattice *	clone () const override
double	DWfactor (R3 q) const
	structureFactors the Debye-Waller factor for a given wavevector transfer More...
bool	integrationOverXi () const
const Lattice2D &	lattice () const
std::vector< const INode * >	nodeChildren () const override
double	particleDensity () const override
	Returns the particle density associated with this 2d lattice. More...
double	positionVariance () const
	Returns the position variance. More...
void	setDecayFunction (const IProfile2D &decay)
void	setIntegrationOverXi (bool integrate_xi)
void	setPositionVariance (double var)
	Sets the variance of the position for the calculation of the DW factor It is defined as the variance in each relevant dimension. More...
virtual double	structureFactor (R3 q, double outer_iff=1.0) const
	The interference function for a given wavevector transfer. More...
virtual bool	supportsMultilayer () const
	Indicates if this interference function can be used with a sample (DWBA mode) More...

Protected Member Functions
double	iff_no_inner (R3 q, double outer_iff) const
	Calculates the structure factor in the absence of extra inner structure. More...

Protected Attributes
double	m_position_var

Constructor & Destructor Documentation

Interference2DLattice()

Interference2DLattice::Interference2DLattice

(

const Lattice2D &

lattice

)

~Interference2DLattice()

Interference2DLattice::~Interference2DLattice ( )

override

Member Function Documentation

className()

std::string Interference2DLattice::className ( ) const

final

clone()

Interference2DLattice* Interference2DLattice::clone ( ) const

overridevirtual

Implements IInterference.

DWfactor()

double IInterference::DWfactor ( R3  q ) const

inherited

structureFactors the Debye-Waller factor for a given wavevector transfer

iff_no_inner()

double IInterference::iff_no_inner ( R3  q, double  outer_iff  ) const

protectedinherited

Calculates the structure factor in the absence of extra inner structure.

integrationOverXi()

bool Interference2DLattice::integrationOverXi

(

)

const

lattice()

const Lattice2D& Interference2DLattice::lattice

(

)

const

nodeChildren()

std::vector<const INode*> Interference2DLattice::nodeChildren ( ) const

override

particleDensity()

double Interference2DLattice::particleDensity ( ) const

overridevirtual

Returns the particle density associated with this 2d lattice.

Reimplemented from IInterference.

positionVariance()

double IInterference::positionVariance ( ) const

inherited

Returns the position variance.

setDecayFunction()

void Interference2DLattice::setDecayFunction

(

const IProfile2D &

decay

)

setIntegrationOverXi()

void Interference2DLattice::setIntegrationOverXi

(

bool

integrate_xi

)

setPositionVariance()

void IInterference::setPositionVariance ( double  var )

inherited

Sets the variance of the position for the calculation of the DW factor It is defined as the variance in each relevant dimension.

structureFactor()

virtual double IInterference::structureFactor ( R3  q, double  outer_iff = 1.0  ) const

virtualinherited

The interference function for a given wavevector transfer.

Reimplemented in Interference2DSuperLattice.

supportsMultilayer()

virtual bool IInterference::supportsMultilayer ( ) const

virtualinherited

Indicates if this interference function can be used with a sample (DWBA mode)

Reimplemented in InterferenceFinite3DLattice, and Interference3DLattice.

Member Data Documentation

m_position_var

double IInterference::m_position_var

protectedinherited