Interference1DLattice Class Reference

Description

Interference function of a 1D lattice.

Inheritance diagram for Interference1DLattice:

Public Member Functions
	Interference1DLattice (double length, double xi)
	~Interference1DLattice () override
std::string	className () const final
Interference1DLattice *	clone () const override
double	DWfactor (R3 q) const
	structureFactors the Debye-Waller factor for a given wavevector transfer More...
double	length () const
std::vector< const INode * >	nodeChildren () const override
std::vector< ParaMeta >	parDefs () const final
virtual double	particleDensity () const
	If defined by this interference function's parameters, returns the particle density (per area). Otherwise, returns zero or a user-defined value. More...
double	positionVariance () const
	Returns the position variance. More...
void	setDecayFunction (const IProfile1D &decay)
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...
double	xi () const

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

Interference1DLattice()

Interference1DLattice::Interference1DLattice	(	double	length,
		double	xi
	)

~Interference1DLattice()

Interference1DLattice::~Interference1DLattice ( )

override

Member Function Documentation

className()

std::string Interference1DLattice::className ( ) const

final

clone()

Interference1DLattice* Interference1DLattice::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.

length()

double Interference1DLattice::length

(

)

const

nodeChildren()

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

override

parDefs()

std::vector<ParaMeta> Interference1DLattice::parDefs ( ) const

final

particleDensity()

virtual double IInterference::particleDensity ( ) const

virtualinherited

If defined by this interference function's parameters, returns the particle density (per area). Otherwise, returns zero or a user-defined value.

Reimplemented in InterferenceHardDisk, InterferenceFinite2DLattice, Interference2DParaCrystal, and Interference2DLattice.

positionVariance()

double IInterference::positionVariance ( ) const

inherited

Returns the position variance.

setDecayFunction()

void Interference1DLattice::setDecayFunction

(

const IProfile1D &

decay

)

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.

xi()

double Interference1DLattice::xi

(

)

const

Member Data Documentation

m_position_var

double IInterference::m_position_var

protectedinherited