Interference3DLattice Class Reference

Description

Interference function of a 3D lattice.

Inheritance diagram for Interference3DLattice:

Public Member Functions
	Interference3DLattice (const Lattice3D &lattice)
	~Interference3DLattice () override
std::string	className () const final
Interference3DLattice *	clone () const override
double	DWfactor (R3 q) const
	structureFactors the Debye-Waller factor for a given wavevector transfer More...
const Lattice3D &	lattice () const
std::vector< const INode * >	nodeChildren () const override
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	setPeakShape (const IPeakShape &peak_shape)
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...
bool	supportsMultilayer () const override
	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

Interference3DLattice()

Interference3DLattice::Interference3DLattice

(

const Lattice3D &

lattice

)

~Interference3DLattice()

Interference3DLattice::~Interference3DLattice ( )

override

Member Function Documentation

className()

std::string Interference3DLattice::className ( ) const

final

clone()

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

lattice()

const Lattice3D& Interference3DLattice::lattice

(

)

const

nodeChildren()

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

override

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.

setPeakShape()

void Interference3DLattice::setPeakShape

(

const IPeakShape &

peak_shape

)

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()

bool Interference3DLattice::supportsMultilayer ( ) const

overridevirtual

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

Reimplemented from IInterference.

Member Data Documentation

m_position_var

double IInterference::m_position_var

protectedinherited