NeutronAtom.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
//------------------------------------------------------------------------------
// Include
//------------------------------------------------------------------------------
#include "MantidKernel/DllConfig.h"
#include <iosfwd>
 
namespace Mantid {
namespace PhysicalConstants {
 
struct MANTID_KERNEL_DLL NeutronAtom {
 
  static const double ReferenceLambda;
 
  NeutronAtom(const uint16_t z, const double coh_b_real, const double inc_b_real, const double coh_xs,
              const double inc_xs, const double tot_xs, const double abs_xs);
 
  NeutronAtom(const uint16_t z, const uint16_t a, const double coh_b_real, const double inc_b_real, const double coh_xs,
              const double inc_xs, const double tot_xs, const double abs_xs);
 
  NeutronAtom(const uint16_t z, const uint16_t a, const double coh_b_real, const double coh_b_img,
              const double inc_b_real, const double inc_b_img, const double coh_xs, const double inc_xs,
              const double tot_xs, const double abs_xs);
 
  NeutronAtom(const NeutronAtom &other);
 
  NeutronAtom &operator=(const NeutronAtom &other);
 
  NeutronAtom();
 
  uint16_t z_number;
 
  uint16_t a_number;
 
  double coh_scatt_length_real;
 
  double coh_scatt_length_img;
 
  double inc_scatt_length_real;
 
  double inc_scatt_length_img;
 
  double coh_scatt_xs;
 
  double inc_scatt_xs;
 
  double tot_scatt_xs;
 
  double abs_scatt_xs;
 
  double tot_scatt_length;
 
  double coh_scatt_length;
 
  double inc_scatt_length;
};
 
MANTID_KERNEL_DLL bool operator==(const NeutronAtom &left, const NeutronAtom &right);
MANTID_KERNEL_DLL bool operator!=(const NeutronAtom &left, const NeutronAtom &right);
 
// addition
MANTID_KERNEL_DLL NeutronAtom operator+(const NeutronAtom &left, const NeutronAtom &right);
 
// multiplication
MANTID_KERNEL_DLL NeutronAtom operator*(const NeutronAtom &left, const double right);
MANTID_KERNEL_DLL NeutronAtom operator*(const double left, const NeutronAtom &right);
 
MANTID_KERNEL_DLL std::ostream &operator<<(std::ostream &out, const NeutronAtom &atom);
MANTID_KERNEL_DLL NeutronAtom getNeutronAtom(const uint16_t z_number, const uint16_t a_number = 0);
MANTID_KERNEL_DLL NeutronAtom getNeutronNoExceptions(const uint16_t z_number, const uint16_t a_number);
MANTID_KERNEL_DLL NeutronAtom getNeutronNoExceptions(const NeutronAtom &other);
 
MANTID_KERNEL_DLL void calculateScatteringLengths(NeutronAtom &atom);
 
} // Namespace PhysicalConstants
} // Namespace Mantid