RAEulerianStatistics#

class ansys.rocky.app.ra_eulerian_statistics.RAEulerianStatistics#

Bases: ansys.rocky.app.ra_process_element.RAUserProcess

Overview#

GetWrappedClass

GetClassName

GetDivisions

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

SetDivisions

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

GetParticleGridFunctionNames

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

GetAvailableOperations

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

CreateEulerianGridFunction

Add a new grid function to the Eulerian Statistics.

Import detail#

from ansys.rocky.app.ra_eulerian_statistics import RAEulerianStatistics

Method detail#

classmethod RAEulerianStatistics.GetWrappedClass() → type[rocky30.process.eulerian.eulerian_statistics_process.EulerianStatisticsProcessSubject]#
classmethod RAEulerianStatistics.GetClassName() → str#
RAEulerianStatistics.GetDivisions() → tuple[int, int, int]#

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

Return type:

tuple(int)

RAEulerianStatistics.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.

Parameters:

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

RAEulerianStatistics.GetParticleGridFunctionNames() → list[str]#

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

Return type:

list(unicode)

RAEulerianStatistics.GetAvailableOperations() → list[str]#

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

Return type:

list(unicode)

RAEulerianStatistics.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.

Parameters:

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

  • value_name (unicode) – The name of the first particle grid function to be used (the “value”). Must be one of GetParticleGridFunctionNames().

  • 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().

Return type:

RAGridFunction