BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Functions | Variables
Units Namespace Reference

Functions

double rad2deg (double angle)
 
double deg2rad (double angle)
 

Variables

static constexpr double nanometer = 1.
 
static constexpr double angstrom = 1.e-1 * nanometer
 
static constexpr double micrometer = 1.e+3 * nanometer
 
static constexpr double millimeter = 1.e+6 * nanometer
 
static constexpr double meter = 1.e+9 * nanometer
 
static constexpr double nm = nanometer
 
static constexpr double nm2 = nanometer * nanometer
 
static constexpr double barn = nanometer * nanometer * 1e-10
 
static constexpr double radian = 1.
 
static constexpr double milliradian = 1.e-3 * radian
 
static constexpr double degree = (3.1415926535897932 / 180.0) * radian
 
static constexpr double steradian = 1.
 
static constexpr double rad = radian
 
static constexpr double mrad = milliradian
 
static constexpr double sr = steradian
 
static constexpr double deg = degree
 
static constexpr double tesla = 1.
 
static constexpr double gauss = 1e-4
 

Detailed Description

Constants and functions for physical unit conversions.

Function Documentation

◆ rad2deg()

double Units::rad2deg ( double  angle)
inline

Definition at line 43 of file Units.h.

44 {
45  return angle / degree;
46 }
Units::degree
static constexpr double degree
Definition: Units.h:40

References degree.

Referenced by SphericalConverter::calculateValue(), RectangularConverter::calculateValue(), OffSpecularConverter::calculateValue(), DepthProbeConverter::calculateValue(), UnitConverterConvSpec::getTraslatorTo(), and pyfmt::printDegrees().

◆ deg2rad()

double Units::deg2rad ( double  angle)
inline

Definition at line 47 of file Units.h.

48 {
49  return angle * degree;
50 }

References degree.

Referenced by RotatedPyramidsBuilder::buildSample(), FormFactorComponents::FormFactorComponents(), and UnitConverterConvSpec::getTraslatorFrom().

Variable Documentation

◆ nanometer

constexpr double Units::nanometer = 1.
staticconstexpr

Definition at line 24 of file Units.h.

Referenced by BoxesSquareLatticeBuilder::buildSample(), CoreShellParticleBuilder::buildSample(), CoreShellBoxRotateZandYBuilder::buildSample(), CustomMorphologyBuilder::buildSample(), Lattice1DBuilder::buildSample(), LayersWithAbsorptionBuilder::buildSample(), LayersWithAbsorptionBySLDBuilder::buildSample(), MagneticSubstrateZeroFieldBuilder::buildSample(), MagneticRotationBuilder::buildSample(), MagneticParticleZeroFieldBuilder::buildSample(), MagneticCylindersBuilder::buildSample(), MagneticSpheresBuilder::buildSample(), MultiLayerWithRoughnessBuilder::buildSample(), MultipleLayoutBuilder::buildSample(), RadialParaCrystalBuilder::buildSample(), Basic2DParaCrystalBuilder::buildSample(), HexParaCrystalBuilder::buildSample(), RectParaCrystalBuilder::buildSample(), ParticleCompositionBuilder::buildSample(), CylindersWithSizeDistributionBuilder::buildSample(), HardDiskBuilder::buildSample(), RotatedPyramidsBuilder::buildSample(), SizeDistributionDAModelBuilder::buildSample(), SizeDistributionLMAModelBuilder::buildSample(), SizeDistributionSSCAModelBuilder::buildSample(), CylindersInSSCABuilder::buildSample(), Basic2DLatticeBuilder::buildSample(), SquareLatticeBuilder::buildSample(), CenteredSquareLatticeBuilder::buildSample(), RotatedSquareLatticeBuilder::buildSample(), FiniteSquareLatticeBuilder::buildSample(), SuperLatticeBuilder::buildSample(), and TwoLayerRoughnessBuilder::buildSample().

◆ angstrom

constexpr double Units::angstrom = 1.e-1 * nanometer
staticconstexpr

Definition at line 25 of file Units.h.

Referenced by StandardSimulations::BasicDepthProbe(), StandardSimulations::BasicGISAS(), StandardSimulations::BasicSpecular(), StandardSimulations::BasicSpecularQ(), FeNiBilayerTanhBuilder::buildSample(), FeNiBilayerNCBuilder::buildSample(), FeNiBilayerSpinFlipTanhBuilder::buildSample(), FeNiBilayerSpinFlipNCBuilder::buildSample(), anonymous_namespace{SlicedCylindersBuilder.cpp}::getSLDFromN(), StandardSimulations::GISASWithMasks(), StandardSimulations::IsGISAXSSimulation1(), StandardSimulations::IsGISAXSSimulation2(), StandardSimulations::MaxiGISAS(), StandardSimulations::MiniGISAS(), StandardSimulations::MiniGISAS_v2(), StandardSimulations::MiniGISASBeamDivergence(), StandardSimulations::MiniGISASFit(), StandardSimulations::MiniGISASSpecularPeak(), StandardSimulations::MiniOffSpec(), anonymous_namespace{KzComputation.cpp}::normalizedSLD(), anonymous_namespace{MagneticLayersBuilder.cpp}::parametricBuild(), StandardSimulations::RectDetectorGeneric(), StandardSimulations::RectDetectorPerpToDirectBeam(), StandardSimulations::RectDetectorPerpToReflectedBeam(), StandardSimulations::RectDetectorPerpToReflectedBeamDpos(), StandardSimulations::RectDetectorPerpToSample(), StandardSimulations::SpecularDivergentBeam(), StandardSimulations::SpecularWithGaussianBeam(), StandardSimulations::SpecularWithSquareBeam(), and StandardSimulations::SphericalDetWithRoi().

◆ micrometer

constexpr double Units::micrometer = 1.e+3 * nanometer
staticconstexpr

Definition at line 26 of file Units.h.

Referenced by Basic2DParaCrystalBuilder::buildSample(), HexParaCrystalBuilder::buildSample(), RectParaCrystalBuilder::buildSample(), and ResonatorBuilder::buildSample().

◆ millimeter

constexpr double Units::millimeter = 1.e+6 * nanometer
staticconstexpr

Definition at line 27 of file Units.h.

◆ meter

constexpr double Units::meter = 1.e+9 * nanometer
staticconstexpr

Definition at line 28 of file Units.h.

◆ nm

constexpr double Units::nm = nanometer
staticconstexpr

Definition at line 31 of file Units.h.

Referenced by StandardSimulations::BasicDepthProbe(), SpheresWithLimitsDistributionBuilder::buildSample(), ConesWithLimitsDistributionBuilder::buildSample(), LinkedBoxDistributionBuilder::buildSample(), ResonatorBuilder::buildSample(), and StandardSimulations::ExtraLongWavelengthGISAS().

◆ nm2

constexpr double Units::nm2 = nanometer * nanometer
staticconstexpr

Definition at line 34 of file Units.h.

◆ barn

constexpr double Units::barn = nanometer * nanometer * 1e-10
staticconstexpr

Definition at line 35 of file Units.h.

◆ radian

constexpr double Units::radian = 1.
staticconstexpr

Definition at line 38 of file Units.h.

◆ milliradian

constexpr double Units::milliradian = 1.e-3 * radian
staticconstexpr

Definition at line 39 of file Units.h.

◆ degree

constexpr double Units::degree = (3.1415926535897932 / 180.0) * radian
staticconstexpr

Definition at line 40 of file Units.h.

Referenced by StandardSimulations::BasicGISAS(), BoxCompositionRotateXBuilder::buildSample(), BoxCompositionRotateYBuilder::buildSample(), BoxCompositionRotateZBuilder::buildSample(), BoxCompositionRotateZandYBuilder::buildSample(), BoxStackCompositionBuilder::buildSample(), CoreShellBoxRotateZandYBuilder::buildSample(), CustomMorphologyBuilder::buildSample(), FeNiBilayerSpinFlipBuilder::buildSample(), FeNiBilayerSpinFlipTanhBuilder::buildSample(), FeNiBilayerSpinFlipNCBuilder::buildSample(), LayersWithAbsorptionBuilder::buildSample(), LayersWithAbsorptionBySLDBuilder::buildSample(), Basic2DParaCrystalBuilder::buildSample(), RotatedPyramidsBuilder::buildSample(), TransformBoxBuilder::buildSample(), RotatedSquareLatticeBuilder::buildSample(), deg2rad(), StandardSimulations::GISASWithMasks(), StandardSimulations::IsGISAXSSimulation1(), StandardSimulations::IsGISAXSSimulation2(), StandardSimulations::MaxiGISAS(), StandardSimulations::MiniGISAS(), StandardSimulations::MiniGISAS_v2(), StandardSimulations::MiniGISASBeamDivergence(), StandardSimulations::MiniGISASFit(), StandardSimulations::MiniGISASSpecularPeak(), rad2deg(), StandardSimulations::RectDetectorGeneric(), StandardSimulations::RectDetectorPerpToDirectBeam(), StandardSimulations::RectDetectorPerpToReflectedBeam(), StandardSimulations::RectDetectorPerpToReflectedBeamDpos(), StandardSimulations::RectDetectorPerpToSample(), StandardSimulations::SpecularDivergentBeam(), and StandardSimulations::SphericalDetWithRoi().

◆ steradian

constexpr double Units::steradian = 1.
staticconstexpr

Definition at line 41 of file Units.h.

◆ rad

constexpr double Units::rad = radian
staticconstexpr

Definition at line 53 of file Units.h.

Referenced by KzComputation::computeReducedKz().

◆ mrad

constexpr double Units::mrad = milliradian
staticconstexpr

Definition at line 54 of file Units.h.

◆ sr

constexpr double Units::sr = steradian
staticconstexpr

Definition at line 55 of file Units.h.

◆ deg

constexpr double Units::deg = degree
staticconstexpr

Definition at line 56 of file Units.h.

Referenced by StandardSimulations::BasicDepthProbe(), StandardSimulations::BasicSpecular(), StandardSimulations::BasicSpecularQ(), Lattice1DBuilder::buildSample(), MagneticRotationBuilder::buildSample(), RotatedPyramidsDistributionBuilder::buildSample(), ConesWithLimitsDistributionBuilder::buildSample(), SlicedCompositionBuilder::buildSample(), Basic2DLatticeBuilder::buildSample(), StandardSimulations::ExtraLongWavelengthGISAS(), StandardSimulations::GISASWithMasks(), StandardSimulations::MiniOffSpec(), StandardSimulations::SpecularDivergentBeam(), StandardSimulations::SpecularWithGaussianBeam(), and StandardSimulations::SpecularWithSquareBeam().

◆ tesla

constexpr double Units::tesla = 1.
staticconstexpr

Definition at line 59 of file Units.h.

◆ gauss

constexpr double Units::gauss = 1e-4
staticconstexpr

Definition at line 60 of file Units.h.

Referenced by CylindersWithSizeDistributionBuilder::buildSample(), SpheresWithLimitsDistributionBuilder::buildSample(), ConesWithLimitsDistributionBuilder::buildSample(), CylindersInSSCABuilder::buildSample(), and MisesGaussPeakShape::integrand().