BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
PolyhedralFace Class Reference

A polygon, for form factor computation. More...

Public Member Functions

 PolyhedralFace (const std::vector< kvector_t > &_V=std::vector< kvector_t >(), bool _sym_S2=false)
 Sets internal variables for given vertex chain. More...
 
double area () const
 
double pyramidalVolume () const
 
double radius3d () const
 
complex_t normalProjectionConj (cvector_t q) const
 Returns conj(q)*normal [BasicVector3D::dot is antilinear in 'this' argument].
 
complex_t ff_n (int m, cvector_t q) const
 Returns contribution qn*f_n [of order q^(n+1)] from this face to the polyhedral form factor.
 
complex_t ff (cvector_t q, bool sym_Ci) const
 Returns the contribution ff(q) of this face to the polyhedral form factor.
 
complex_t ff_2D (cvector_t qpa) const
 Returns the two-dimensional form factor of this face, for use in a prism.
 
void assert_Ci (const PolyhedralFace &other) const
 Throws if deviation from inversion symmetry is detected. Does not check vertices.
 

Static Public Member Functions

static double diameter (const std::vector< kvector_t > &V)
 Static method, returns diameter of circle that contains all vertices.
 

Detailed Description

A polygon, for form factor computation.

Definition at line 43 of file PolyhedralComponents.h.

Constructor & Destructor Documentation

◆ PolyhedralFace()

PolyhedralFace::PolyhedralFace ( const std::vector< kvector_t > &  V = std::vector<kvector_t>(),
bool  _sym_S2 = false 
)

Sets internal variables for given vertex chain.

Parameters
Voriented vertex list
_sym_S2true if face has a perpedicular two-fold symmetry axis

Definition at line 120 of file PolyhedralComponents.cpp.


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