WavevectorInfo Class Reference

Collaboration diagram for WavevectorInfo:

Public Member Functions
	WavevectorInfo (cvector_t ki, cvector_t kf, double wavelength)
	WavevectorInfo (kvector_t ki, kvector_t kf, double wavelength)
WavevectorInfo	transformed (const Transform3D &transform) const
cvector_t	getKi () const
cvector_t	getKf () const
cvector_t	getQ () const
double	getWavelength () const

Static Public Member Functions
static WavevectorInfo	GetZeroQ ()

Private Member Functions
	WavevectorInfo ()

Private Attributes
cvector_t	m_ki
cvector_t	m_kf
double	m_vacuum_wavelength

Detailed Description

Holds all wavevector information relevant for calculating form factors.

Definition at line 25 of file WavevectorInfo.h.

Constructor & Destructor Documentation

WavevectorInfo() [1/3]

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

inline

Definition at line 29 of file WavevectorInfo.h.

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

WavevectorInfo() [2/3]

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

inline

Definition at line 33 of file WavevectorInfo.h.

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

WavevectorInfo() [3/3]

WavevectorInfo::WavevectorInfo ( )

private

Definition at line 32 of file WavevectorInfo.cpp.

: m_ki(1, 0, 0), m_kf(1, 0, 0), m_vacuum_wavelength(1) {}

Referenced by transformed().

Member Function Documentation

GetZeroQ()

WavevectorInfo WavevectorInfo::GetZeroQ ( )

static

Definition at line 20 of file WavevectorInfo.cpp.

{
    return {};
}

Referenced by IFormFactor::volume().

transformed()

WavevectorInfo WavevectorInfo::transformed

(

const Transform3D &

transform

)

const

Definition at line 25 of file WavevectorInfo.cpp.

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

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

Referenced by FormFactorDecoratorRotation::evaluate(), and FormFactorDecoratorRotation::evaluatePol().

Here is the call graph for this function:

getKi()

cvector_t WavevectorInfo::getKi ( ) const

inline

Definition at line 39 of file WavevectorInfo.h.

{ return m_ki; }

References m_ki.

Referenced by FormFactorDWBA::evaluate(), and FormFactorDWBAPol::evaluatePol().

getKf()

cvector_t WavevectorInfo::getKf ( ) const

inline

Definition at line 40 of file WavevectorInfo.h.

{ return m_kf; }

References m_kf.

Referenced by FormFactorDWBA::evaluate(), and FormFactorDWBAPol::evaluatePol().

getQ()

cvector_t WavevectorInfo::getQ ( ) const

inline

Definition at line 41 of file WavevectorInfo.h.

{ return m_ki - m_kf; }

References m_kf, and m_ki.

Referenced by IFormFactorBorn::evaluate(), FormFactorCrystal::evaluate(), IFormFactorBorn::evaluatePol(), FormFactorCrystal::evaluatePol(), FormFactorDecoratorPositionFactor::getPositionFactor(), and MagneticMaterialImpl::polarizedSubtrSLD().

getWavelength()

double WavevectorInfo::getWavelength ( ) const

inline

Definition at line 42 of file WavevectorInfo.h.

{ return m_vacuum_wavelength; }

References m_vacuum_wavelength.

Referenced by FormFactorDWBA::evaluate(), FormFactorCrystal::evaluate(), FormFactorDWBAPol::evaluatePol(), FormFactorCrystal::evaluatePol(), MaterialBySLDImpl::scalarSubtrSLD(), and RefractiveMaterialImpl::scalarSubtrSLD().

Member Data Documentation

m_ki

cvector_t WavevectorInfo::m_ki

private

Definition at line 46 of file WavevectorInfo.h.

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

m_kf

cvector_t WavevectorInfo::m_kf

private

Definition at line 47 of file WavevectorInfo.h.

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

m_vacuum_wavelength

double WavevectorInfo::m_vacuum_wavelength

private

Definition at line 48 of file WavevectorInfo.h.

Referenced by getWavelength(), and transformed().

---

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

• /home/www/ba/Sample/Material/WavevectorInfo.h
• /home/www/ba/Sample/Material/WavevectorInfo.cpp