BornAgain  1.19.79
Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering
ReCoreShell.h
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file Resample/Particle/ReCoreShell.h
6 //! @brief Defines class ReCoreShell.
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_RESAMPLE_PARTICLE_RECORESHELL_H
21 #define BORNAGAIN_RESAMPLE_PARTICLE_RECORESHELL_H
22 
24 
25 #include <memory>
26 
27 //! A reprocessed core shell particle.
28 
29 class ReCoreShell : public IReParticle {
30 public:
31  ReCoreShell(IReParticle* core, IReParticle* shell);
32  ~ReCoreShell() override;
33 
34  ReCoreShell* clone() const override;
35 
36  double radialExtension() const override;
37 
38  double bottomZ(const IRotation* rotation) const override;
39 
40  double topZ(const IRotation* rotation) const override;
41 
42  void setAmbientMaterial(const Material& material) override;
43 
44  complex_t theFF(const WavevectorInfo& wavevectors) const override;
45  SpinMatrix thePolFF(const WavevectorInfo& wavevectors) const override;
46 
47 protected:
48  std::unique_ptr<IReParticle> m_core;
49  std::unique_ptr<IReParticle> m_shell;
50 };
51 
52 #endif // BORNAGAIN_RESAMPLE_PARTICLE_RECORESHELL_H
53 #endif // USER_API
Defines and implements interface IReParticle.
Abstract base class for reprocessed particles.
Definition: IReParticle.h:37
Abstract base class for rotations.
Definition: Rotations.h:29
A wrapper for underlying material implementation.
Definition: Material.h:35
A reprocessed core shell particle.
Definition: ReCoreShell.h:29
complex_t theFF(const WavevectorInfo &wavevectors) const override
Returns scattering amplitude for complex wavevectors ki, kf.
Definition: ReCoreShell.cpp:52
double radialExtension() const override
Returns the (approximate in some cases) radial size of the particle of this form factor's shape....
Definition: ReCoreShell.cpp:32
double bottomZ(const IRotation *rotation) const override
Returns the z-coordinate of the lowest point in this shape after a given rotation.
Definition: ReCoreShell.cpp:37
~ReCoreShell() override
void setAmbientMaterial(const Material &material) override
Passes the material in which this particle is embedded.
Definition: ReCoreShell.cpp:47
ReCoreShell * clone() const override
Definition: ReCoreShell.cpp:27
std::unique_ptr< IReParticle > m_core
Definition: ReCoreShell.h:48
double topZ(const IRotation *rotation) const override
Returns the z-coordinate of the lowest point in this shape after a given rotation.
Definition: ReCoreShell.cpp:42
ReCoreShell(IReParticle *core, IReParticle *shell)
Definition: ReCoreShell.cpp:19
SpinMatrix thePolFF(const WavevectorInfo &wavevectors) const override
Returns scattering amplitude for matrix interactions.
Definition: ReCoreShell.cpp:57
std::unique_ptr< IReParticle > m_shell
Definition: ReCoreShell.h:49
Holds all wavevector information relevant for calculating form factors.