WavevectorInfo Class Reference

Description

Holds all wavevector information relevant for calculating form factors.

Definition at line 29 of file WavevectorInfo.h.

Public Member Functions
	WavevectorInfo (C3 ki, C3 kf, double wavelength)
	WavevectorInfo (R3 ki, R3 kf, double wavelength)
C3	getKf () const
C3	getKi () const
C3	getQ () const
WavevectorInfo	transformed (const RotMatrix &transform) const
double	vacuumLambda () const

Static Public Member Functions
static WavevectorInfo	makeZeroQ ()

Private Attributes
C3	m_kf
C3	m_ki
double	m_vacuum_wavelength

Constructor & Destructor Documentation

WavevectorInfo() [1/2]

WavevectorInfo::WavevectorInfo	(	C3	ki,
		C3	kf,
		double	wavelength
	)

Definition at line 18 of file WavevectorInfo.cpp.

    : m_ki(ki)
    , m_kf(kf)
    , m_vacuum_wavelength(wavelength)
{
}

Referenced by transformed().

WavevectorInfo() [2/2]

WavevectorInfo::WavevectorInfo	(	R3	ki,
		R3	kf,
		double	wavelength
	)

Definition at line 25 of file WavevectorInfo.cpp.

    : WavevectorInfo(ki.complex(), kf.complex(), wavelength)
{
}

Member Function Documentation

getKf()

C3 WavevectorInfo::getKf ( ) const

inline

Definition at line 37 of file WavevectorInfo.h.

{ return m_kf; }

References m_kf.

Referenced by SumDWBA::coherentFF(), and SumDWBA::coherentPolFF().

getKi()

C3 WavevectorInfo::getKi ( ) const

inline

Definition at line 36 of file WavevectorInfo.h.

{ return m_ki; }

References m_ki.

Referenced by SumDWBA::coherentFF(), and SumDWBA::coherentPolFF().

getQ()

C3 WavevectorInfo::getQ ( ) const

inline

Definition at line 38 of file WavevectorInfo.h.

{ return m_ki - m_kf; }

References m_kf, and m_ki.

Referenced by MagneticMaterialImpl::polarizedSubtrSLD(), IFormFactor::theFF(), ReMesocrystal::theFF(), ReParticle::theFF(), IFormFactor::thePolFF(), ReMesocrystal::thePolFF(), and ReParticle::thePolFF().

makeZeroQ()

WavevectorInfo WavevectorInfo::makeZeroQ ( )

static

Definition at line 32 of file WavevectorInfo.cpp.

{
    return {R3{1, 0, 0}, R3{1, 0, 0}, 1.0};
}

Referenced by IReParticle::volume().

transformed()

WavevectorInfo WavevectorInfo::transformed

(

const RotMatrix &

transform

)

const

Definition at line 37 of file WavevectorInfo.cpp.

{
    return WavevectorInfo(transform.transformed(m_ki), transform.transformed(m_kf),
                          m_vacuum_wavelength);
}

References WavevectorInfo(), m_kf, m_ki, m_vacuum_wavelength, and RotMatrix::transformed().

Referenced by ReParticle::theFF(), and ReParticle::thePolFF().

Here is the call graph for this function:

vacuumLambda()

double WavevectorInfo::vacuumLambda ( ) const

inline

Definition at line 39 of file WavevectorInfo.h.

{ return m_vacuum_wavelength; }

References m_vacuum_wavelength.

Referenced by SumDWBA::coherentFF(), SumDWBA::coherentPolFF(), MagneticMaterialImpl::polarizedSubtrSLD(), Material::scalarSubtrSLD(), ReMesocrystal::theFF(), and ReMesocrystal::thePolFF().

Member Data Documentation

m_kf

C3 WavevectorInfo::m_kf

private

Definition at line 43 of file WavevectorInfo.h.

Referenced by getKf(), getQ(), and transformed().

m_ki

C3 WavevectorInfo::m_ki

private

Definition at line 42 of file WavevectorInfo.h.

Referenced by getKi(), getQ(), and transformed().

m_vacuum_wavelength

double WavevectorInfo::m_vacuum_wavelength

private

Definition at line 44 of file WavevectorInfo.h.

Referenced by transformed(), and vacuumLambda().

---

The documentation for this class was generated from the following files:

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Base/Vector/WavevectorInfo.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Base/Vector/WavevectorInfo.cpp