Enum Class Polarization

java.lang.Object
java.lang.Enum<Polarization>
ffx.potential.nonbonded.pme.Polarization
All Implemented Interfaces:
Serializable, Comparable<Polarization>, Constable

@FFXProperty(name="polarization", clazz=java.lang.String.class, propertyGroup=ElectrostaticsFunctionalForm, defaultValue="mutual", description="[DIRECT / MUTUAL / NONE]\nSelects between the use of direct and mutual dipole polarization for force fields\nthat incorporate the polarization term. The direct modifier avoids an iterative calculation by using only the\npermanent electric field in computation of induced dipoles. The mutual option, which is the default in the\nabsence of the polarization property, iterates the induced dipoles to self-consistency.\nThe none option turns off polarization and takes precedence over the polarizeterm property.\n") public enum Polarization extends Enum<Polarization>
  • Enum Constant Details

  • Method Details

    • values

      public static Polarization[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static Polarization valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null