tud_lbm.io.plotting.contact_angle_plot
======================================

.. py:module:: tud_lbm.io.plotting.contact_angle_plot

.. autoapi-nested-parse::

   Contact-angle history analysis plots.



Classes
-------

.. autoapisummary::

   tud_lbm.io.plotting.contact_angle_plot.ContactAngleLeftPlot
   tud_lbm.io.plotting.contact_angle_plot.ContactAngleRightPlot
   tud_lbm.io.plotting.contact_angle_plot.ContactAnglesPairPlot


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

.. py:class:: ContactAngleLeftPlot(config: tud_lbm.config.SimulationConfig | None = None)

   Bases: :py:obj:`tud_lbm.io.plotting._analysis_common._BaseAnalysisPlot`


   Plot left contact angle over time.


   .. py:attribute:: name
      :value: 'contact_angle_left'



   .. py:attribute:: title
      :value: 'Left contact angle vs timestep'



   .. py:attribute:: ylabel
      :value: 'Contact angle (deg)'



   .. py:attribute:: color
      :value: 'tab:purple'



   .. py:attribute:: required_keys
      :value: ('ca_left',)



   .. py:method:: compute(files: list[pathlib.Path]) -> dict[str, numpy.ndarray]

      Compute left contact angle values for each timestep file.



.. py:class:: ContactAngleRightPlot(config: tud_lbm.config.SimulationConfig | None = None)

   Bases: :py:obj:`tud_lbm.io.plotting._analysis_common._BaseAnalysisPlot`


   Plot right contact angle over time.


   .. py:attribute:: name
      :value: 'contact_angle_right'



   .. py:attribute:: title
      :value: 'Right contact angle vs timestep'



   .. py:attribute:: ylabel
      :value: 'Contact angle (deg)'



   .. py:attribute:: color
      :value: 'tab:red'



   .. py:attribute:: required_keys
      :value: ('ca_right',)



   .. py:method:: compute(files: list[pathlib.Path]) -> dict[str, numpy.ndarray]

      Compute right contact angle values for each timestep file.



.. py:class:: ContactAnglesPairPlot(config: tud_lbm.config.SimulationConfig | None = None)

   Bases: :py:obj:`tud_lbm.io.plotting.base.AnalysisPlot`


   Render paired left/right contact-angle history.


   .. py:attribute:: name
      :value: 'contact_angles_pair'



   .. py:attribute:: required_keys
      :value: ('ca_left', 'ca_right')



   .. py:method:: compute(files: list[pathlib.Path]) -> dict[str, numpy.ndarray]

      Compute left/right contact-angle arrays for all snapshots.



   .. py:method:: render(ax: matplotlib.axes.Axes, precomputed: dict[str, numpy.ndarray]) -> None

      Draw the paired contact-angle scatter plot.