molsysmt.element.group.ion.is_ion#

molsysmt.element.group.ion.is_ion(name)[source]#

Check whether a group name corresponds to an atomic ion.

Parameters:

name (str) – Residue or group name as stored in the topology (e.g. 'NA', 'CL', 'ZN').

Returns:

True if name belongs to the set of known ion group names, False otherwise.

Return type:

bool

Notes

The recognised names are defined in molsysmt.element.group.ion.group_names.

Added in version 1.0.0.