$darkmode
DENOPTIM
denoptim.integration.tinker.TinkerAtom Class Reference

Based on the code from ffx.kenai.com Michael J. More...

Inheritance diagram for denoptim.integration.tinker.TinkerAtom:
[legend]
Collaboration diagram for denoptim.integration.tinker.TinkerAtom:
[legend]

Public Member Functions

 TinkerAtom ()
 
 TinkerAtom (int xyzIndex, String atomStr, int ffAtomType, double[] xyz, int[] atmNb, double[] distAngles)
 
void setAtomNeighbours (int[] atmNb)
 
int[] getAtomNeighbours ()
 
void setDistAngle (double[] distAngles)
 
double[] getDistAngle ()
 
void moveTo (double[] d)
 Add a vector to the Atom's current position vector. More...
 
void moveTo (double a, double b, double c)
 
void setXYZ (double[] xyz)
 
double[] getXYZ ()
 
void getXYZ (double[] x)
 
int getXYZIndex ()
 Gets the XYZ Index. More...
 
void setXYZIndex (int xyzIndex)
 
String getAtomString ()
 
void setAtomString (String atomStr)
 
int getAtomType ()
 
void setAtomType (int ffAtomType)
 
void setVertexId (long vidx)
 
long getVertexId ()
 
boolean usesProperTorsion ()
 Evaluates whether this TinkerAtom's line refers to a torsion (chiral flag is 0) or to an inproper torsion (chiral flag is +/-1). More...
 
String toString ()
 

Private Attributes

int ffAtomType
 
String atomStr
 
double[] xyz
 
int xyzIndex
 
double[] distAngles
 
int[] atmNb
 
long vtxId
 

Detailed Description

Based on the code from ffx.kenai.com Michael J.

Schnieders

Author
Vishwesh Venkatraman

Definition at line 25 of file TinkerAtom.java.

Constructor & Destructor Documentation

◆ TinkerAtom() [1/2]

denoptim.integration.tinker.TinkerAtom.TinkerAtom ( )

Definition at line 66 of file TinkerAtom.java.

◆ TinkerAtom() [2/2]

denoptim.integration.tinker.TinkerAtom.TinkerAtom ( int  xyzIndex,
String  atomStr,
int  ffAtomType,
double[]  xyz,
int[]  atmNb,
double[]  distAngles 
)

Member Function Documentation

◆ getAtomNeighbours()

int[] denoptim.integration.tinker.TinkerAtom.getAtomNeighbours ( )

Definition at line 100 of file TinkerAtom.java.

References denoptim.integration.tinker.TinkerAtom.atmNb.

◆ getAtomString()

String denoptim.integration.tinker.TinkerAtom.getAtomString ( )

Definition at line 210 of file TinkerAtom.java.

References denoptim.integration.tinker.TinkerAtom.atomStr.

◆ getAtomType()

int denoptim.integration.tinker.TinkerAtom.getAtomType ( )

◆ getDistAngle()

double[] denoptim.integration.tinker.TinkerAtom.getDistAngle ( )

◆ getVertexId()

long denoptim.integration.tinker.TinkerAtom.getVertexId ( )

Definition at line 245 of file TinkerAtom.java.

References denoptim.integration.tinker.TinkerAtom.vtxId.

◆ getXYZ() [1/2]

double[] denoptim.integration.tinker.TinkerAtom.getXYZ ( )

getXYZ

Returns
an array of double.

Definition at line 169 of file TinkerAtom.java.

References denoptim.integration.tinker.TinkerAtom.xyz.

◆ getXYZ() [2/2]

void denoptim.integration.tinker.TinkerAtom.getXYZ ( double[]  x)

getXYZ

Parameters
xan array of double.

Definition at line 181 of file TinkerAtom.java.

References denoptim.integration.tinker.TinkerAtom.xyz.

◆ getXYZIndex()

int denoptim.integration.tinker.TinkerAtom.getXYZIndex ( )

Gets the XYZ Index.

Returns
XYZ Index

Definition at line 195 of file TinkerAtom.java.

References denoptim.integration.tinker.TinkerAtom.xyzIndex.

Referenced by denoptim.integration.tinker.TinkerBond.TinkerBond().

Here is the caller graph for this function:

◆ moveTo() [1/2]

void denoptim.integration.tinker.TinkerAtom.moveTo ( double  a,
double  b,
double  c 
)

moveTo

Parameters
aa double.
ba double.
ca double.

Definition at line 142 of file TinkerAtom.java.

References denoptim.integration.tinker.TinkerAtom.xyz.

◆ moveTo() [2/2]

void denoptim.integration.tinker.TinkerAtom.moveTo ( double[]  d)

Add a vector to the Atom's current position vector.

Parameters
dVector to add to the current position

Definition at line 126 of file TinkerAtom.java.

References denoptim.integration.tinker.TinkerAtom.xyz.

◆ setAtomNeighbours()

void denoptim.integration.tinker.TinkerAtom.setAtomNeighbours ( int[]  atmNb)

Definition at line 93 of file TinkerAtom.java.

References denoptim.integration.tinker.TinkerAtom.atmNb.

◆ setAtomString()

void denoptim.integration.tinker.TinkerAtom.setAtomString ( String  atomStr)

Definition at line 217 of file TinkerAtom.java.

References denoptim.integration.tinker.TinkerAtom.atomStr.

◆ setAtomType()

void denoptim.integration.tinker.TinkerAtom.setAtomType ( int  ffAtomType)

◆ setDistAngle()

void denoptim.integration.tinker.TinkerAtom.setDistAngle ( double[]  distAngles)

◆ setVertexId()

void denoptim.integration.tinker.TinkerAtom.setVertexId ( long  vidx)

Definition at line 238 of file TinkerAtom.java.

◆ setXYZ()

void denoptim.integration.tinker.TinkerAtom.setXYZ ( double[]  xyz)

setXYZ

Parameters
xyzan array of double.

Definition at line 157 of file TinkerAtom.java.

References denoptim.integration.tinker.TinkerAtom.xyz.

◆ setXYZIndex()

void denoptim.integration.tinker.TinkerAtom.setXYZIndex ( int  xyzIndex)

Definition at line 202 of file TinkerAtom.java.

References denoptim.integration.tinker.TinkerAtom.xyzIndex.

◆ toString()

◆ usesProperTorsion()

boolean denoptim.integration.tinker.TinkerAtom.usesProperTorsion ( )

Evaluates whether this TinkerAtom's line refers to a torsion (chiral flag is 0) or to an inproper torsion (chiral flag is +/-1).

For the position to be defined by a proper torsion, all 3 neighbouring atoms has to be defined (!= 0).

Returns
true if this TinkerAtom makes use of a proper torsion

Definition at line 261 of file TinkerAtom.java.

Member Data Documentation

◆ atmNb

◆ atomStr

◆ distAngles

◆ ffAtomType

◆ vtxId

long denoptim.integration.tinker.TinkerAtom.vtxId
private

◆ xyz

◆ xyzIndex


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