SfamPotentialTermsGenerator.h

Go to the documentation of this file.

#ifndef MOLECULARMECHANICS_SFAMPOTENTIALTERMSGENERATOR_H
#define MOLECULARMECHANICS_SFAMPOTENTIALTERMSGENERATOR_H

#include "../Interactions/AngleTerm.h"
#include "../Interactions/BondedTerm.h"
#include "../Interactions/DihedralTerm.h"
#include "../Interactions/DispersionTerm.h"
#include "../Interactions/HydrogenBondTerm.h"
#include "../Interactions/ImproperDihedralTerm.h"
#include "../Interactions/RepulsionTerm.h"
#include <vector>

namespace Scine {

namespace Core {
struct Log;
} // namespace Core

namespace MolecularMechanics {
class IndexedStructuralTopology;
class AtomTypesHolder;
class SfamParameters;

class SfamPotentialTermsGenerator {
 public:
  SfamPotentialTermsGenerator(int nAtoms, const AtomTypesHolder& atomTypes, const IndexedStructuralTopology& topology,
                              const SfamParameters& parameters, const Utils::PositionCollection& positions,
                              const double& nonCovalentCutoffRadius, Core::Log& log);

  std::vector<BondedTerm> getBondedTerms();
  std::vector<AngleTerm> getAngleTerms();
  std::vector<DihedralTerm> getDihedralTerms();
  std::vector<ImproperDihedralTerm> getImproperDihedralTerms();
  std::vector<DispersionTerm> getDispersionTerms(bool applyCutoff);
  std::vector<RepulsionTerm> getRepulsionTerms(bool applyCutoff);
  std::vector<HydrogenBondTerm> getHydrogenBondTerms();

 private:
  int nAtoms_;
  const AtomTypesHolder& atomTypesHolder_;
  const IndexedStructuralTopology& topology_;
  const SfamParameters& parameters_;
  const Utils::PositionCollection& positions_;
  /*
   * @brief The cutoff radius for the non-covalent interactions.
   *
   *        It is a pointer so that it is updated with the settings.
   *        This is important since it is passed on from here to the actual DispersionTerms, etc.
   *        A reference does not work because then the assignment operator of DispersionTerms, etc. vanishes.
   */
  std::shared_ptr<double> cutoff_;
  // The logger
  Core::Log& log_;

  static constexpr double scalingFactorForElectrostaticOneFourTerms_ = 1.0;
  static constexpr double scalingFactorForDispersionOneFourTerms_ = 1.0;
  static constexpr double scalingFactorForRepulsionOneFourTerms_ = 1.0;
};

} // namespace MolecularMechanics
} // namespace Scine

#endif // MOLECULARMECHANICS_SFAMPOTENTIALTERMSGENERATOR_H