-
Notifications
You must be signed in to change notification settings - Fork 122
/
SetSampleMaterial.h
69 lines (56 loc) · 2.23 KB
/
SetSampleMaterial.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
#ifndef MANTID_DATAHANDLING_SetSampleMaterial_H_
#define MANTID_DATAHANDLING_SetSampleMaterial_H_
//--------------------------------
// Includes
//--------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidKernel/NeutronAtom.h"
namespace Mantid {
namespace DataHandling {
/**
This class allows the shape of the sample to be defined by using the allowed
XML
expressions
@author Vickie Lynch, SNS
@date 2/7/2013
Copyright © 2009 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
National Laboratory & European Spallation Source
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://github.com/mantidproject/mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport SetSampleMaterial : public Mantid::API::Algorithm {
public:
/// Algorithm's name
const std::string name() const override;
/// Summary of algorithms purpose
const std::string summary() const override {
return "Sets the neutrons information in the sample.";
}
/// Algorithm's version
int version() const override;
/// Algorithm's category for identification
const std::string category() const override;
std::map<std::string, std::string> validateInputs() override;
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
/// Print out the list of information for the material
void fixNeutron(PhysicalConstants::NeutronAtom &neutron, double coh_xs,
double inc_xs, double abs_xs, double tot_xs);
};
}
}
#endif /* MANTID_DATAHANDLING_SetSampleMaterial_H_*/