peleffy.forcefield.selectors.ChargeCalculatorSelector

class peleffy.forcefield.selectors.ChargeCalculatorSelector[source]

It defines a charge calculator selector.

__init__()

Initialize self. See help(type(self)) for accurate signature.

get_by_name(charge_method, molecule)[source]

Given a charge method name, it returns the corresponding charge calculator class.

Parameters
  • charge_method (str) – The name of the requested charge calculator

  • molecule (a peleffy.topology.Molecule) – The peleffy’s Molecule object whose partial charges will be calculated

Returns

charge_calculator – The charge calculation method that will be employed to calculate partial charges

Return type

a PartialChargesCalculator

Raises

ValueError – If the requested charge method is unknown

get_list()[source]

It returns the complete list of available force fields.

Returns

charge_methods – The complete list of available charge methods

Return type

list[str]