:class:`TqdmProgressBar`
========================

.. py:class:: ansys.dpf.core.common.TqdmProgressBar(text, unit, tot_size=None)

   Bases: :py:obj:`ansys.dpf.gate.common.ProgressBarBase`


   Custom progress bar implementation based on tqdm.




.. py:currentmodule:: TqdmProgressBar

Overview
--------

.. tab-set::



   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~update`
            - Modify how the current value of the progress bar is updated.



   .. tab-item:: Attributes

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~bar`
            - 


   .. tab-item:: Static methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~progress_available`
            - Check if the tdqm module exists.





Import detail
-------------

.. code-block:: python

    from ansys.dpf.core.common import TqdmProgressBar


Attribute detail
----------------

.. py:attribute:: bar



Method detail
-------------

.. py:method:: update(current_value)

   Modify how the current value of the progress bar is updated.


.. py:method:: progress_available()
   :staticmethod:


   Check if the tdqm module exists.

   :returns: True if module exists, else False.
   :rtype: bool