:class:`RAEulerianStatistics`
=============================


.. py:class:: ansys.rocky.app.ra_eulerian_statistics.RAEulerianStatistics

   Bases: :py:obj:`ansys.rocky.app.ra_process_element.RAUserProcess`





.. py:currentmodule:: RAEulerianStatistics

Overview
--------

.. tab-set::


   .. tab-item:: Constructors

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

          * - :py:attr:`~GetWrappedClass`
            - 
          * - :py:attr:`~GetClassName`
            - 


   .. tab-item:: Methods

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

          * - :py:attr:`~GetDivisions`
            - Get the number of divisions in i/j/k.
          * - :py:attr:`~SetDivisions`
            - Set the number of divisions in i/j/k. Note that the minimum value for each number is 1.
          * - :py:attr:`~GetParticleGridFunctionNames`
            - Get a list with the particle grid function names that can be passed to `CreateGridFunction()`.
          * - :py:attr:`~GetAvailableOperations`
            - Get a list with the operations that can be passed to `CreateGridFunction()`.
          * - :py:attr:`~CreateEulerianGridFunction`
            - Add a new grid function to the Eulerian Statistics.








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

.. code-block:: python

    from ansys.rocky.app.ra_eulerian_statistics import RAEulerianStatistics



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

.. py:method:: GetWrappedClass() -> type[rocky30.process.eulerian.eulerian_statistics_process.EulerianStatisticsProcessSubject]
   :classmethod:


.. py:method:: GetClassName() -> str
   :classmethod:


.. py:method:: GetDivisions() -> tuple[int, int, int]

   
   Get the number of divisions in i/j/k.

   :rtype: tuple(int)















   ..
       !! processed by numpydoc !!

.. py:method:: SetDivisions(divisions: tuple[int, int, int]) -> None

   
   Set the number of divisions in i/j/k. Note that the minimum value for each number is 1.

   :param tuple(int) divisions:
       The divisions in (i,j,k) order.















   ..
       !! processed by numpydoc !!

.. py:method:: GetParticleGridFunctionNames() -> list[str]

   
   Get a list with the particle grid function names that can be passed to `CreateGridFunction()`.

   :rtype: list(unicode)















   ..
       !! processed by numpydoc !!

.. py:method:: GetAvailableOperations() -> list[str]

   
   Get a list with the operations that can be passed to `CreateGridFunction()`.

   :rtype: list(unicode)















   ..
       !! processed by numpydoc !!

.. py:method:: CreateEulerianGridFunction(operation_name: str, value_name: str, weight_name: str | None = None, grid_function_source: None | ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem = None) -> kraken20.plugins.api.ka_grid_function.RAGridFunction

   
   Add a new grid function to the Eulerian Statistics.

   This method takes an operation and one (or two) particle grid function names and creates
   a new grid function for this EulerianStatistics. For instance, the call:

       CreateEulerianGridFunction('Weighted Average', 'Velocity : Translational : Absolute', 'Particle Mass')

   ... will create the `Weighted Average of Velocity : Translational : Absolute by Particle Mass`
   grid function. The grid function PrePost Scripting wrapper is returned.

   :param unicode operation_name:
       The name of the operation to be performed on the particles in each grid block. Must be
       one of `GetAvailableOperations()`.

   :param unicode value_name:
       The name of the first particle grid function to be used (the "value"). Must be one of
       `GetParticleGridFunctionNames()`.

   :param weight_name:
       The name of the second particle grid function to be used (the "weight"). Only used for
       operations that take two grid functions. Must be one of `GetParticleGridFunctionNames()`.

   :rtype: RAGridFunction















   ..
       !! processed by numpydoc !!