BornAgain  1.19.79
Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering
InterferenceRadialParaCrystal Class Reference

Description

Interference function of radial paracrystal.

Inheritance diagram for InterferenceRadialParaCrystal:

Public Member Functions

 InterferenceRadialParaCrystal (double peak_distance, double damping_length)
 
std::string className () const final
 
InterferenceRadialParaCrystalclone () const override
 
double dampingLength () const
 
double domainSize () const
 
double DWfactor (R3 q) const
 structureFactors the Debye-Waller factor for a given wavevector transfer More...
 
complex_t FTPDF (double qpar) const
 
double kappa () 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 peakDistance () const
 
double positionVariance () const
 Returns the position variance. More...
 
double randomSample () const
 
void setDomainSize (double size)
 
void setKappa (double kappa)
 
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 setProbabilityDistribution (const IProfile1D &pdf)
 
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

◆ InterferenceRadialParaCrystal()

InterferenceRadialParaCrystal::InterferenceRadialParaCrystal ( double  peak_distance,
double  damping_length 
)

Member Function Documentation

◆ className()

std::string InterferenceRadialParaCrystal::className ( ) const
final

◆ clone()

InterferenceRadialParaCrystal* InterferenceRadialParaCrystal::clone ( ) const
overridevirtual

Implements IInterference.

◆ dampingLength()

double InterferenceRadialParaCrystal::dampingLength ( ) const

◆ domainSize()

double InterferenceRadialParaCrystal::domainSize ( ) const

◆ DWfactor()

double IInterference::DWfactor ( R3  q) const
inherited

structureFactors the Debye-Waller factor for a given wavevector transfer

◆ FTPDF()

complex_t InterferenceRadialParaCrystal::FTPDF ( double  qpar) const

◆ 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.

◆ kappa()

double InterferenceRadialParaCrystal::kappa ( ) const

◆ nodeChildren()

std::vector<const INode*> InterferenceRadialParaCrystal::nodeChildren ( ) const
override

◆ parDefs()

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

◆ peakDistance()

double InterferenceRadialParaCrystal::peakDistance ( ) const

◆ positionVariance()

double IInterference::positionVariance ( ) const
inherited

Returns the position variance.

◆ randomSample()

double InterferenceRadialParaCrystal::randomSample ( ) const

◆ setDomainSize()

void InterferenceRadialParaCrystal::setDomainSize ( double  size)

◆ setKappa()

void InterferenceRadialParaCrystal::setKappa ( double  kappa)

◆ 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.

◆ setProbabilityDistribution()

void InterferenceRadialParaCrystal::setProbabilityDistribution ( const IProfile1D &  pdf)

◆ 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