BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
DomainSimulationBuilder.h
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file GUI/coregui/Models/DomainSimulationBuilder.h
6 //! @brief Defines class DomainSimulationBuilder
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_GUI_COREGUI_MODELS_DOMAINSIMULATIONBUILDER_H
16 #define BORNAGAIN_GUI_COREGUI_MODELS_DOMAINSIMULATIONBUILDER_H
17 
18 #include <memory>
19 
20 class ISimulation;
21 class MultiLayerItem;
22 class InstrumentItem;
24 
25 //! Contains functions to build the domain simulation from instrument and sample models.
26 
28 
29 //! Creates domain simulation from sample and instrument items.
30 
31 std::unique_ptr<ISimulation> createSimulation(const MultiLayerItem* sampleItem,
32  const InstrumentItem* instrumentItem,
33  const SimulationOptionsItem* optionsItem = nullptr);
34 }; // namespace DomainSimulationBuilder
35 
36 #endif // BORNAGAIN_GUI_COREGUI_MODELS_DOMAINSIMULATIONBUILDER_H
Abstract base class of OffSpecularSimulation, GISASSimulation and SpecularSimulation.
Definition: ISimulation.h:38
The SimulationOptionsItem class holds simulation status (run policy, number of threads,...
Contains functions to build the domain simulation from instrument and sample models.
std::unique_ptr< ISimulation > createSimulation(const MultiLayerItem *sampleItem, const InstrumentItem *instrumentItem, const SimulationOptionsItem *optionsItem=nullptr)
Creates domain simulation from sample and instrument items.