plot_potential

mapsci.quick_plots.plot_potential

plot_potential(r, potential, plot_opts={}, nondimensional=False, temperature=None, show=True)[source]

Plot given potential

Nondimensional parameters are scaled using the following physical constants: vacuum permittivity, \(\varepsilon_{0}\), Boltzmann constant, \(k_{B}\), and elementary charge, \(e\).

Parameters
  • r (numpy.ndarray) – Array (or float) of nondimensionalized distance between two beads. Reported in [Å] or \(r'=r (4 \pi \varepsilon_{0}) 3k_{B}T e^{-2}\)

  • potential (numpy.ndarray) – Array of nondimensionalized potential between beads based on multipole moments. Array is equal in length to “r”. Reported in units reduced by the Boltzmann constant, [K] or nondimensionalized as \(\phi'=\phi/(3k_{B}T)\)

  • plot_opts (dict, Optional, default={}) – Keyword arguments for matplotlib.pyplot.plot

  • temperature (float, Optional, default=None) – Temperature in [K] for adding and removing dimensions, if the parameters are nondimensionalized, this value isn’t used.

  • nondimensional (bool, Optional, default=False) – Indicates whether the given bead library has been nondimensionalized by dict_dimensions()

  • show (bool, Optional, default=True) – Dictate whether plt.show() should be executed within this function