porereax.bond_length
====================

.. py:module:: porereax.bond_length

.. autoapi-nested-parse::

   Module for sampling bond lengths and bond orders.

   The module provides :class:`BondLengthSampler` to sample bond length histograms (in Angstroms) or ReaxFF bond order histograms for specified bonds.



Classes
-------

.. autoapisummary::

   porereax.bond_length.BondLengthSampler


Module Contents
---------------

.. py:class:: BondLengthSampler(name_out: str, bonds: list, dimension: str, region, process_id: int, atom_lib: dict, masses: dict, num_frames: int, box: numpy.ndarray, system_properties: dict, num_bins: int, range: tuple)

   Bases: :py:obj:`porereax.meta_sampler.BondSampler`


   Sampler class for bond lengths and bond orders between bonded atom pairs.


   .. py:method:: sample(frame_id: int, mol_index: dict, mol_bonds: dict, bond_mask: dict, frame: object, bond_enum: object, positions_transformed: numpy.ndarray)

      Sample data for the current frame. Must be implemented by subclasses.



   .. py:method:: join_samplers(num_cores)

      Join sampler data from multiple processes.

      :param num_cores: Number of parallel processes used for sampling.
      :type num_cores: int