BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
ComputeBA.h
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file Sample/FFCompute/ComputeBA.h
6 //! @brief Defines class ComputeBA.
7 //!
8 //! @homepage http://www.bornagainproject.org
9 //! @license GNU General Public License v3 or higher (see COPYING)
10 //! @copyright Forschungszentrum Jülich GmbH 2018
11 //! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS)
12 //
13 // ************************************************************************************************
14 
15 #ifdef SWIG
16 #error no need to expose this header to Swig
17 #endif
18 
19 #ifndef USER_API
20 #ifndef BORNAGAIN_SAMPLE_FFCOMPUTE_COMPUTEBA_H
21 #define BORNAGAIN_SAMPLE_FFCOMPUTE_COMPUTEBA_H
22 
24 #include <memory>
25 
26 //! Provides scalar form factor evaluation in Born Approximation for given IFormFactor.
27 
28 //! @ingroup formfactors_internal
29 
30 class ComputeBA : public IComputeFF {
31 public:
32  ComputeBA(const IFormFactor& ff);
33  ~ComputeBA() override;
34 
35  ComputeBA* clone() const override;
36 
37  //! Calculates and returns a form factor calculation in BA
38  complex_t evaluate(const WavevectorInfo& wavevectors) const override;
39 };
40 
41 #endif // BORNAGAIN_SAMPLE_FFCOMPUTE_COMPUTEBA_H
42 #endif // USER_API
std::complex< double > complex_t
Definition: Complex.h:20
Defines and implements interface IFormFactor.
Provides scalar form factor evaluation in Born Approximation for given IFormFactor.
Definition: ComputeBA.h:30
~ComputeBA() override
ComputeBA(const IFormFactor &ff)
Definition: ComputeBA.cpp:19
ComputeBA * clone() const override
Definition: ComputeBA.cpp:23
complex_t evaluate(const WavevectorInfo &wavevectors) const override
Calculates and returns a form factor calculation in BA.
Definition: ComputeBA.cpp:28
Abstract base class for form factor evaluations.
Definition: IComputeFF.h:39
Abstract base class for all form factors.
Definition: IFormFactor.h:36
Holds all wavevector information relevant for calculating form factors.