Scine::Swoose  2.1.0
This is the SCINE module Swoose.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Scine::MolecularMechanics::SfamPotentialTermsGenerator Class Reference

This class creates the actual potential terms that are employed during an SFAM molecular mechanics calculation. It combines information about structure (bonds, angles, etc), atom types and parameters in order to do so. More...

#include <SfamPotentialTermsGenerator.h>

Collaboration diagram for Scine::MolecularMechanics::SfamPotentialTermsGenerator:
Collaboration graph

Public Member Functions

 SfamPotentialTermsGenerator (int nAtoms, const AtomTypesHolder &atomTypes, const IndexedStructuralTopology &topology, const SfamParameters &parameters, const Utils::PositionCollection &positions, const double &nonCovalentCutoffRadius, Core::Log &log)
 Constructor. More...
 
std::vector< BondedTermgetBondedTerms ()
 Getter for bonded terms.
 
std::vector< AngleTermgetAngleTerms ()
 Getter for angle terms.
 
std::vector< DihedralTermgetDihedralTerms ()
 Getter for dihedral terms.
 
std::vector< ImproperDihedralTermgetImproperDihedralTerms ()
 Getter for improper dihedral terms.
 
std::vector< DispersionTermgetDispersionTerms (bool applyCutoff)
 Getter for dispersion terms with decision whether to use a cutoff radius.
 
std::vector< RepulsionTermgetRepulsionTerms (bool applyCutoff)
 Getter for Pauli repulsion terms with decision whether to use a cutoff radius.
 
std::vector< HydrogenBondTermgetHydrogenBondTerms ()
 Getter for hydrogen bond terms.
 

Detailed Description

This class creates the actual potential terms that are employed during an SFAM molecular mechanics calculation. It combines information about structure (bonds, angles, etc), atom types and parameters in order to do so.

Constructor & Destructor Documentation

Scine::MolecularMechanics::SfamPotentialTermsGenerator::SfamPotentialTermsGenerator ( int  nAtoms,
const AtomTypesHolder atomTypes,
const IndexedStructuralTopology topology,
const SfamParameters parameters,
const Utils::PositionCollection positions,
const double &  nonCovalentCutoffRadius,
Core::Log log 
)

Constructor.

Parameters
nAtomsNumber of atoms in the system.
atomTypesThe atom types.
topologyThe topology.
parametersThe parameters of SFAM's MM model.
nonCovalentCutoffRadiusThe cutoff radius for non-covalent interactions.
logThe logger.

The documentation for this class was generated from the following files: