BornAgain
1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
FormFactorCantellatedCube.h
Go to the documentation of this file.
1
// ************************************************************************** //
2
//
3
// BornAgain: simulate and fit scattering at grazing incidence
4
//
5
//! @file Sample/HardParticle/FormFactorCantellatedCube.h
6
//! @brief Defines class FormFactorCantellatedCube.
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
#ifndef BORNAGAIN_CORE_HARDPARTICLE_FORMFACTORCANTELLATEDCUBE_H
16
#define BORNAGAIN_CORE_HARDPARTICLE_FORMFACTORCANTELLATEDCUBE_H
17
18
#include "
Sample/HardParticle/IFormFactorPolyhedron.h
"
19
20
//! A cube, with truncation of all edges and corners, as in Croset (2017) Fig 7
21
//! @ingroup hardParticle
22
23
class
FormFactorCantellatedCube
:
public
IFormFactorPolyhedron
24
{
25
public
:
26
FormFactorCantellatedCube
(
const
std::vector<double> P);
27
FormFactorCantellatedCube
(
double
length
,
double
removed_length);
28
29
FormFactorCantellatedCube
*
clone
() const override final
30
{
31
return
new
FormFactorCantellatedCube
(
m_length
,
m_removed_length
);
32
}
33
void
accept
(
INodeVisitor
* visitor)
const
override
final
{ visitor->visit(
this
); }
34
35
double
getLength
()
const
{
return
m_length
; }
36
double
getRemovedLength
()
const
{
return
m_removed_length
; }
37
38
protected
:
39
void
onChange
() override final;
40
41
private:
42
static const
PolyhedralTopology
topology
;
43
const
double
&
m_length
;
44
const
double
&
m_removed_length
;
45
};
46
47
#endif
// BORNAGAIN_CORE_HARDPARTICLE_FORMFACTORCANTELLATEDCUBE_H
IFormFactorPolyhedron.h
Defines class IFormFactorPolyhedron.
FormFactorCantellatedCube
A cube, with truncation of all edges and corners, as in Croset (2017) Fig 7.
Definition:
FormFactorCantellatedCube.h:24
FormFactorCantellatedCube::FormFactorCantellatedCube
FormFactorCantellatedCube(const std::vector< double > P)
Definition:
FormFactorCantellatedCube.cpp:49
FormFactorCantellatedCube::onChange
void onChange() override final
Action to be taken in inherited class when a parameter has changed.
Definition:
FormFactorCantellatedCube.cpp:67
FormFactorCantellatedCube::m_length
const double & m_length
Definition:
FormFactorCantellatedCube.h:43
FormFactorCantellatedCube::accept
void accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
Definition:
FormFactorCantellatedCube.h:33
FormFactorCantellatedCube::topology
static const PolyhedralTopology topology
Definition:
FormFactorCantellatedCube.h:42
FormFactorCantellatedCube::clone
FormFactorCantellatedCube * clone() const override final
Returns a clone of this ISample object.
Definition:
FormFactorCantellatedCube.h:29
FormFactorCantellatedCube::getRemovedLength
double getRemovedLength() const
Definition:
FormFactorCantellatedCube.h:36
FormFactorCantellatedCube::getLength
double getLength() const
Definition:
FormFactorCantellatedCube.h:35
FormFactorCantellatedCube::m_removed_length
const double & m_removed_length
Definition:
FormFactorCantellatedCube.h:44
IFormFactorPolyhedron
A polyhedron, for form factor computation.
Definition:
IFormFactorPolyhedron.h:27
INodeVisitor
Visitor interface to visit ISample objects.
Definition:
INodeVisitor.h:149
PolyhedralTopology
For internal use in IFormFactorPolyhedron.
Definition:
PolyhedralTopology.h:30
anonymous_namespace{BoxCompositionBuilder.cpp}::length
const double length
Definition:
BoxCompositionBuilder.cpp:30
Sample
HardParticle
FormFactorCantellatedCube.h
Generated by
1.9.1