plot_multipole_potential

mapsci.quick_plots.plot_multipole_potential

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

Plot multipole potential and if provided, the contribution of each multipole interaction.

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 \(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 nondimensionalized \(\phi'=\phi/(3k_{B}T)\)

  • potential_terms (numpy.ndarray) – This can be either a list of terms corresponds to the coefficients for r to the order of -4, -6, -8, and -10, or a list of nine terms terms corresponding to the coefficients the various multipole interactions. Calculated from calc_cross_multipole_terms()

  • 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()

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

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