ILatticeFunction.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2015 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 "MantidAPI/DllConfig.h"
#include "MantidAPI/FunctionParameterDecorator.h"
#include "MantidAPI/LatticeDomain.h"
#include "MantidGeometry/Crystal/UnitCell.h"
 
namespace Mantid {
namespace API {
 
class MANTID_API_DLL ILatticeFunction : public FunctionParameterDecorator {
public:
  ILatticeFunction();
 
  void function(const FunctionDomain &domain, FunctionValues &values) const override;
  void functionDeriv(const FunctionDomain &domain, Jacobian &jacobian) override;
 
  virtual void functionLattice(const LatticeDomain &latticeDomain, FunctionValues &values) const = 0;
 
  virtual void functionDerivLattice(const LatticeDomain &latticeDomain, Jacobian &jacobian);
 
  virtual void setLatticeSystem(const std::string &crystalSystem) = 0;
 
  virtual void setUnitCell(const std::string &unitCellString) = 0;
  virtual void setUnitCell(const Geometry::UnitCell &unitCell) = 0;
 
  virtual Geometry::UnitCell getUnitCell() const = 0;
};
 
using ILatticeFunction_sptr = std::shared_ptr<ILatticeFunction>;
 
} // namespace API
} // namespace Mantid