reduction#

Public Fluent reduction APIs and their implementation contracts.

Classes:

`AbstractReduction`()	Abstract interface for area, volume, force, and statistical reductions.
`Reduction`(service)	Reduction backed by the Reduction gRPC service.
`Weight`(value[, names, module, qualname, ...])	Enum of available weighting options for `sum` and `sum_if`.

class ansys.fluent.core.fields.reduction.AbstractReduction#

Bases: ABC

Abstract interface for area, volume, force, and statistical reductions.

Methods:

`area`(locations[, ctxt])	Get area.
`area_average`(expression, locations[, ctxt])	Get area average.
`area_integral`(expression, locations[, ctxt])	Get area integral.
`centroid`(locations[, ctxt])	Get centroid.
`count`(locations[, ctxt])	Count the number of faces or cells within the locations.
`count_if`(condition, locations[, ctxt])	Count the number of faces or cells where the specified condition is satisfied.
`force`(locations[, ctxt])	Get force.
`mass_average`(expression, locations[, ctxt])	Get mass average.
`mass_flow_average`(expression, locations[, ctxt])	Get mass flow average.
`mass_flow_average_absolute`(expression, locations)	Compute the mass flow average of the absolute value of the given expression.
`mass_flow_integral`(expression, locations[, ctxt])	Get mass flow integral.
`mass_integral`(expression, locations[, ctxt])	Get mass integral.
`maximum`(expression, locations[, ctxt])	Get maximum.
`minimum`(expression, locations[, ctxt])	Get minimum.
`moment`(expression, locations[, ctxt])	Get moment.
`pressure_force`(locations[, ctxt])	Get pressure force.
`sum`(expression, locations, weight[, ctxt])	Get sum.
`sum_if`(expression, condition, locations, weight)	Compute the weighted sum of the expression at locations where the given condition is satisfied.
`viscous_force`(locations[, ctxt])	Get viscous force.
`volume`(locations[, ctxt])	Get volume.
`volume_average`(expression, locations[, ctxt])	Get volume average.
`volume_integral`(expression, locations[, ctxt])	Get volume integral.

abstract area(locations, ctxt=None)#: Get area.

abstract area_average(expression, locations, ctxt=None)#: Get area average.

abstract area_integral(expression, locations, ctxt=None)#: Get area integral.

abstract centroid(locations, ctxt=None)#: Get centroid.

abstract count(locations, ctxt=None)#: Count the number of faces or cells within the locations.

abstract count_if(condition, locations, ctxt=None)#: Count the number of faces or cells where the specified condition is satisfied.

abstract force(locations, ctxt=None)#: Get force.

abstract mass_average(expression, locations, ctxt=None)#: Get mass average.

abstract mass_flow_average(expression, locations, ctxt=None)#: Get mass flow average.

abstract mass_flow_average_absolute(expression, locations, ctxt=None)#: Compute the mass flow average of the absolute value of the given expression.

abstract mass_flow_integral(expression, locations, ctxt=None)#: Get mass flow integral.

abstract mass_integral(expression, locations, ctxt=None)#: Get mass integral.

abstract maximum(expression, locations, ctxt=None)#: Get maximum.

abstract minimum(expression, locations, ctxt=None)#: Get minimum.

abstract moment(expression, locations, ctxt=None)#: Get moment.

abstract pressure_force(locations, ctxt=None)#: Get pressure force.

abstract sum(expression, locations, weight, ctxt=None)#: Get sum.

abstract sum_if(expression, condition, locations, weight, ctxt=None)#: Compute the weighted sum of the expression at locations where the given condition is satisfied.

abstract viscous_force(locations, ctxt=None)#: Get viscous force.

abstract volume(locations, ctxt=None)#: Get volume.

abstract volume_average(expression, locations, ctxt=None)#: Get volume average.

abstract volume_integral(expression, locations, ctxt=None)#: Get volume integral.

class ansys.fluent.core.fields.reduction.Reduction(service)#

Bases: AbstractReduction

Reduction backed by the Reduction gRPC service.

Methods:

`__init__`(service)	Initialize Reduction.
`area`(locations[, ctxt])	Get area.
`area_average`(expression, locations[, ctxt])	Get area average.
`area_integral`(expression, locations[, ctxt])	Get area integral.
`centroid`(locations[, ctxt])	Get centroid.
`count`(locations[, ctxt])	Count the number of faces or cells within the locations.
`count_if`(condition, locations[, ctxt])	Count the number of faces or cells where the specified condition is satisfied.
`force`(locations[, ctxt])	Get force.
`mass_average`(expression, locations[, ctxt])	Get mass average.
`mass_flow_average`(expression, locations[, ctxt])	Get mass flow average.
`mass_flow_average_absolute`(expression, locations)	Compute the mass flow average of the absolute value of the given expression.
`mass_flow_integral`(expression, locations[, ctxt])	Get mass flow integral.
`mass_integral`(expression, locations[, ctxt])	Get mass integral.
`maximum`(expression, locations[, ctxt])	Get maximum.
`minimum`(expression, locations[, ctxt])	Get minimum.
`moment`(expression, locations[, ctxt])	Get moment.
`pressure_force`(locations[, ctxt])	Get pressure force.
`set_context`(ctxt)	Set the context over which reduction service should operate.
`sum`(expression, locations, weight[, ctxt])	Get sum.
`sum_if`(expression, condition, locations, weight)	Compute the weighted sum of the expression at locations where the given condition is satisfied.
`viscous_force`(locations[, ctxt])	Get viscous force.
`volume`(locations[, ctxt])	Get volume.
`volume_average`(expression, locations[, ctxt])	Get volume average.
`volume_integral`(expression, locations[, ctxt])	Get volume integral.

__init__(service)#: Initialize Reduction.

area(locations, ctxt=None)#: Get area.

area_average(expression, locations, ctxt=None)#: Get area average.

area_integral(expression, locations, ctxt=None)#: Get area integral.

centroid(locations, ctxt=None)#: Get centroid.

count(locations, ctxt=None)#: Count the number of faces or cells within the locations.

count_if(condition, locations, ctxt=None)#: Count the number of faces or cells where the specified condition is satisfied.

force(locations, ctxt=None)#: Get force.

mass_average(expression, locations, ctxt=None)#: Get mass average.

mass_flow_average(expression, locations, ctxt=None)#: Get mass flow average.

mass_flow_average_absolute(expression, locations, ctxt=None)#: Compute the mass flow average of the absolute value of the given expression.

mass_flow_integral(expression, locations, ctxt=None)#: Get mass flow integral.

mass_integral(expression, locations, ctxt=None)#: Get mass integral.

maximum(expression, locations, ctxt=None)#: Get maximum.

minimum(expression, locations, ctxt=None)#: Get minimum.

moment(expression, locations, ctxt=None)#: Get moment.

pressure_force(locations, ctxt=None)#: Get pressure force.

set_context(ctxt)#: Set the context over which reduction service should operate.

sum(expression, locations, weight, ctxt=None)#: Get sum.

sum_if(expression, condition, locations, weight, ctxt=None)#: Compute the weighted sum of the expression at locations where the given condition is satisfied.

viscous_force(locations, ctxt=None)#: Get viscous force.

volume(locations, ctxt=None)#: Get volume.

volume_average(expression, locations, ctxt=None)#: Get volume average.

volume_integral(expression, locations, ctxt=None)#: Get volume integral.

class ansys.fluent.core.fields.reduction.Weight(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: Enum

Enum of available weighting options for sum and sum_if.

Attributes:

`ABS_MASS_FLOW_RATE`
`AREA`
`MASS`
`MASS_FLOW_RATE`
`VOLUME`

ABS_MASS_FLOW_RATE = 'AbsMassFlowRate'#

AREA = 'Area'#

MASS = 'Mass'#

MASS_FLOW_RATE = 'MassFlowRate'#

VOLUME = 'Volume'#