tud_lbm.io.plotting.force
=========================

.. py:module:: tud_lbm.io.plotting.force

.. autoapi-nested-parse::

   Force magnitude plot operators.



Classes
-------

.. autoapisummary::

   tud_lbm.io.plotting.force.ForcePlotOperator
   tud_lbm.io.plotting.force.ExternalForcePlotOperator


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

.. py:class:: ForcePlotOperator(config: tud_lbm.config.SimulationConfig, data_dir: str | pathlib.Path | None = None)

   Bases: :py:obj:`_BaseForceOperator`


   Render the saved total force field.


   .. py:attribute:: name
      :value: 'force'



   .. py:attribute:: field_name
      :value: 'force'



   .. py:attribute:: title
      :value: 'Total force'



.. py:class:: ExternalForcePlotOperator(config: tud_lbm.config.SimulationConfig, data_dir: str | pathlib.Path | None = None)

   Bases: :py:obj:`_BaseForceOperator`


   Render the saved external force field.


   .. py:attribute:: name
      :value: 'force_ext'



   .. py:attribute:: field_name
      :value: 'force_ext'



   .. py:attribute:: title
      :value: 'External force'