meshi.symmetryComplex.energy.cylinder
Class CylinderEnergy

java.lang.Object
  meshi.energy.AbstractEnergy
      meshi.energy.simpleEnergyTerms.SimpleEnergyTerm
          meshi.symmetryComplex.energy.cylinder.CylinderEnergy

All Implemented Interfaces:

Attributable, Updateable

public class CylinderEnergy
extends SimpleEnergyTerm

Cylinder energy term. The energy of every atom is w * f * ([radius term] + [height term]), where:

• w is the weight.
• f is the force constant. Currently f=1 but this can be changed
• [radius term] is zero when the atom is between the two (infinite) coaxial cylinders, or the square of the distance to the nearer one.
• [height term] is zero when the atom is between the cylinders' (infinite) top and bottom surfaces, or the square of the distance to the nearer one.

Nested Class Summary

Nested classes/interfaces inherited from class meshi.energy.AbstractEnergy

AbstractEnergy.UpdateableList

Field Summary

Fields inherited from class meshi.energy.simpleEnergyTerms.SimpleEnergyTerm

elementsList, parametersList

Fields inherited from class meshi.energy.AbstractEnergy

comment, filter, INFINITY, NaN, on, updateableResources, weight

Constructor Summary

CylinderEnergy(AtomList atomList, DistanceMatrix distanceMatrix, ParametersList parametersList, double weight, Filter filter)

Method Summary

EnergyElement

createElement(java.lang.Object baseElement, Parameters parameters)

Methods inherited from class meshi.energy.simpleEnergyTerms.SimpleEnergyTerm

createElementsList, elementsList, evaluate, evaluateAtoms, test

Methods inherited from class meshi.energy.AbstractEnergy

addAttribute, comment, getAttribute, handleMissingParameters, isOn, off, on, toArray, toArray, toArray, toArray, toString, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CylinderEnergy

public CylinderEnergy(AtomList atomList,
                      DistanceMatrix distanceMatrix,
                      ParametersList parametersList,
                      double weight,
                      Filter filter)

Method Detail

createElement

public EnergyElement createElement(java.lang.Object baseElement,
                                   Parameters parameters)

Specified by:

createElement in class SimpleEnergyTerm