Simulation options

The function simulation.options() gives access to a SimulationOptions object. This object can be modified through the following setter functions:

• setMonteCarloIntegration(switch, n)
• setNumberOfThreads(n)
• setIncludeSpecular(switch)
• setUseAvgMaterials(switch)
• setMesoReciprocalSum(switch, r)
• setOffspecIntegratorOptions(type, {option : value})

• Introduction
  • Functionality overview

• Install or build
  • Install Python
    • Python on Linux
    • Python on Windows
    • Python on Mac
    • Python modules
  • Install BornAgain
    • Linux
    • Windows
    • MacOS
    • Development snapshot
  • Build BornAgain
    • Unix
      • Install third-party software
      • Get the source
      • Build and install BornAgain
      • Run a first simulation
    • Windows

• Python scripting
  • Run a script
  • Understand the syntax
  • AI-assisted scripting
  • Fitting
  • Upgrading

• Reference
  • Simulation model
    • Simulation classes
      • Specular
        • Example
      • Scattering
        • Examples
          • GISAS
          • without DWBA terms
          • with specular peak
          • SAS
          • Polarized SANS
          • Monte-Carlo
      • Off-specular
        • Off-specular
        • Yoneda peak
      • Depth probe
        • Thin film
        • Fresnel transmission
        • Transmitted modulus
        • Opaque sample
        • Resonator
    • Common settings
      • Background
      • Options
        • Monte-Carlo
        • # threads
        • Mesocrystal summation
        • Offspec integration
        • Average materials
        • Include specular
      • Progress monitor
  • Instrument model
    • Beam
      • Footprint
      • Beam divergence
    • Scan
      • TOF reflectometry
      • TOF resolution
      • Beam Angular Spread
      • Beam Wavelength Spread
    • Detectors
      • SphericalDetector
      • 2d detector resolution
      • Offspec detector
    • Neutron polarization
      • Spin asymmetry example
    • Examples
      • 2D detector resolution
      • Neutron polarization
        • Magnetic layer
        • Ditto, realistic instrument
        • Polarized scattering
  • Sample model
    • Materials
      • Magnetization
    • Multilayer
      • Layer
      • LayerStack
    • Roughness
      • Interface model
      • Transient
      • Cross-correlation
      • Real space
      • Examples
        • Reflectivity
        • GISAS
    • Particles
      • Form factor
        • Hard particles
          • Bipyramid4
          • Box
          • CantellatedCube
          • Cone
          • Cylinder
          • Dodecahedron
          • Ellipsoid
          • EllipsoidalCylinder
          • EllipsoidalSegment
          • HorizontalCylinder
          • Icosahedron
          • PlatonicOctahedron
          • PlatonicTetrahedron
          • Prism3
          • Prism6
          • Pyramid2
          • Pyramid3
          • Pyramid4
          • Pyramid6
          • Sphere
          • SphericalSegment
          • Spheroid
          • SpheroidalSegment
          • TruncatedCube
        • Ripples
          • Bar ripple
          • Cosine ripple
          • Sawtooth ripple
        • Soft particles
          • FuzzySphere
          • Gauss
        • Custom formfactor
      • Composite particles
        • Core and shell
        • Mixture
        • Compound particle
        • Mesocrystal
      • Examples
        • Compound particle
        • Core and shell
        • Crossing an interface
        • Mesocrystal
        • Rotation example
    • Structure
      • 2D structures
        • Disorder
          • Uncorrelated mixture
          • Polydispersity
        • Grating
          • 1D lattice
          • Triangular ripples in a lattice
        • 2D lattice
          • Square lattice
          • Lattice orientation distribution
          • Finite square lattice
          • Lattice with basis
          • Multi-layer lattice
          • Position variance
        • 2D paracrystal
        • Radial paracrystal
        • Size-distribution models
      • 3D structures
        • Disordered
  • 3D sample view
  • Model modifiers
    • Rotation
    • Distributions
  • Data types
    • Class Datafield
      • Convert axes
      • Export
      • Find intensity peaks
    • Material profiles
      • Profiles with rough interfaces
      • SLD profile with a sliced particle layer
  • Plotting
    • Functions
    • Configuration
    • Heat map
    • LaTeX markup
    • Export
  • Fitting
    • Data import
      • TIFF
    • Minimizer
    • Multiple datasets
    • Examples
      • Fitting with masks
      • Custom objective function
      • Fitting along slices
      • GISAS 2D fits
      • Experiment at GALAXI
      • Find background
      • Bayesian Sampling
      • Consecutive fitting
      • Considering uncertainties
      • External minimizer: plotting
      • lmfit minimizer
      • Simultaneous fit of two datasets
      • Spin asymmetry fit example
      • Reflectometry: Fit Pt layer
      • Reflectometry: Fit honeycomb

• How to
  • Get announcements
  • Solve known problems
  • Request help or report bugs
  • Cite BornAgain

• Developers' corner
  • Configure
    • Pyenv
    • Doxygen
  • Develop
    • Manual checks
    • Debug
    • Webdoc
  • Release