Interference2DSuperLattice Class Reference

Description

Interference function of a 2D superlattice with a configurable interference function for each lattice site.

Inheritance diagram for Interference2DSuperLattice:

Public Member Functions
	Interference2DSuperLattice (const Lattice2D &lattice, unsigned size_1, unsigned size_2)
	Interference2DSuperLattice (double length_1, double length_2, double alpha, double xi, unsigned size_1, unsigned size_2)
	~Interference2DSuperLattice () override
std::string	className () const final
Interference2DSuperLattice *	clone () const override
unsigned	domainSize1 () const
unsigned	domainSize2 () const
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
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	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...
void	setSubstructureIFF (const IInterference &sub_iff)
double	structureFactor (R3 q, double outer_iff=1.0) const override
	The interference function for a given wavevector transfer. More...
const IInterference &	substructureIFF () const
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

Interference2DSuperLattice() [1/2]

Interference2DSuperLattice::Interference2DSuperLattice	(	const Lattice2D &	lattice,
		unsigned	size_1,
		unsigned	size_2
	)

Interference2DSuperLattice() [2/2]

Interference2DSuperLattice::Interference2DSuperLattice	(	double	length_1,
		double	length_2,
		double	alpha,
		double	xi,
		unsigned	size_1,
		unsigned	size_2
	)

~Interference2DSuperLattice()

Interference2DSuperLattice::~Interference2DSuperLattice ( )

override

Member Function Documentation

className()

std::string Interference2DSuperLattice::className ( ) const

final

clone()

Interference2DSuperLattice* Interference2DSuperLattice::clone ( ) const

overridevirtual

Implements IInterference.

domainSize1()

unsigned Interference2DSuperLattice::domainSize1

(

)

const

domainSize2()

unsigned Interference2DSuperLattice::domainSize2

(

)

const

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 Interference2DSuperLattice::integrationOverXi

(

)

const

lattice()

const Lattice2D& Interference2DSuperLattice::lattice

(

)

const

nodeChildren()

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

override

parDefs()

std::vector<ParaMeta> Interference2DSuperLattice::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.

setIntegrationOverXi()

void Interference2DSuperLattice::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.

setSubstructureIFF()

void Interference2DSuperLattice::setSubstructureIFF

(

const IInterference &

sub_iff

)

structureFactor()

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

overridevirtual

The interference function for a given wavevector transfer.

Reimplemented from IInterference.

substructureIFF()

const IInterference& Interference2DSuperLattice::substructureIFF

(

)

const

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