BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
LatticeUtils.h
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Sample/Lattice/LatticeUtils.h
6 //! @brief Defines factory functions for different types of lattices and orientations.
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_LATTICE_LATTICEUTILS_H
16 #define BORNAGAIN_CORE_LATTICE_LATTICEUTILS_H
17 
18 #include "Sample/Lattice/Lattice.h"
19 
21 
22 namespace LatticeUtils
23 {
24 Lattice createFCCLattice(double lattice_constant, const ILatticeOrientation& orientation);
25 Lattice createHCPLattice(double a, double c, const ILatticeOrientation& orientation);
26 Lattice createBCTLattice(double a, double c, const ILatticeOrientation& orientation);
27 } // namespace LatticeUtils
28 
29 #endif // BORNAGAIN_CORE_LATTICE_LATTICEUTILS_H
Defines class Lattice.
A lattice with three basis vectors.
Definition: Lattice.h:28
Lattice createHCPLattice(double a, double c, const ILatticeOrientation &orientation)
Lattice createFCCLattice(double lattice_constant, const ILatticeOrientation &orientation)
Lattice createBCTLattice(double a, double c, const ILatticeOrientation &orientation)