OESmirnoffTorsionData

Attention

This API is currently available in C++ and Python.

class OESmirnoffTorsionData : public OEMolSmirnoff::OESmirnoffData

The OESmirnoffTorsionData class provides the ability to add new parameters and modify existing proper torsion parameters in the SMIRNOFF force field that has the functional form: \(V_t = \sum_n{V_n/d_n(1+\cos{(p_n\theta - \gamma_n)})}\) (see SMIRNOFF).

See also

• OESmirnoffData class

The following methods are publicly inherited from OESmirnoffData class:

• GetID

• GetSmarts

The class defines the following public methods:

• NumTerms

• GetDegeneracy

• GetPeriodicity

• GetEneConst

• GetPhaseAngle

• AddData

• ClearData

Constructors

OESmirnoffTorsionData() -> OESmirnoffTorsionData
OESmirnoffTorsionData(id: str, smarts: str) -> OESmirnoffTorsionData
OESmirnoffTorsionData(arg2: OESmirnoffTorsionData) -> OESmirnoffTorsionData

NumTerms

NumTerms() -> int

Returns the total number of terms (\(n\))

GetDegeneracy

GetDegeneracy(index: int) -> int

Returns the degeneracy (\(d_n\)) of the OESmirnoffTorsionData term corresponding to the index

GetPeriodicity

GetPeriodicity(index: int) -> int

Returns the periodicity of the cosine term (\(p_n\)) of the OESmirnoffTorsionData term corresponding to the index

GetEneConst

GetEneConst(index: int) -> float

Returns the energy constant (\(V_n\)) in kcal/mol multiplied to the cosine term of the OESmirnoffTorsionData term corresponding to the index

GetPhaseAngle

GetPhaseAngle(index: int) -> float

Returns the phase (\(\gamma_n\)) in degrees of the cosine term of the OESmirnoffTorsionData term corresponding to the index

AddData

AddData(degeneracy: int, periodicity: int, eneConst: float,
        phaseAngle: float) -> bool

Used to add a OESmirnoffTorsionData term to a set of OESmirnoffParams

ClearData

ClearData() -> bool

Clears the degeneracy, periodicity, energy constant and phase from a OESmirnoffTorsionData. The ID and Smarts associated with the OESmirnoffTorsionData are not cleared.