Reduction#

Generated reference

Source file:: ansys/api/fluent/v1/reduction.proto
Proto package:: ansys.api.fluent.v1.reduction
Contains:: 1 service, 44 messages

Services

Service: Reduction

Reduction service provides methods for computing reductions over field data.

Area

Request:: AreaRequest
Response:: AreaResponse

Computes the total area of the specified surfaces.

AreaAve

Request:: AreaAveRequest
Response:: AreaAveResponse

Computes the area-weighted average of an expression over the specified surfaces.

AreaInt

Request:: AreaIntRequest
Response:: AreaIntResponse

Computes the area integral of an expression over the specified surfaces.

Centroid

Request:: CentroidRequest
Response:: CentroidResponse

Computes the geometric centroid of the specified surfaces.

Count

Request:: CountRequest
Response:: CountResponse

Counts the number of cells or faces at the specified locations.

CountIf

Request:: CountIfRequest
Response:: CountIfResponse

Counts the number of cells or faces at the specified locations where the condition expression is true.

Force

Request:: ForceRequest
Response:: ForceResponse

Computes the total force (pressure and viscous) on the specified surfaces.

MassAve

Request:: MassAveRequest
Response:: MassAveResponse

Computes the mass-weighted average of an expression over the specified cell zones.

MassFlowAve

Request:: MassFlowAveRequest
Response:: MassFlowAveResponse

Computes the mass-flow-weighted average of an expression over the specified surfaces.

MassFlowAveAbs

Request:: MassFlowAveAbsRequest
Response:: MassFlowAveAbsResponse

Computes the mass-flow-weighted average using absolute mass flow values.

MassFlowInt

Request:: MassFlowIntRequest
Response:: MassFlowIntResponse

Computes the mass flow integral of an expression over the specified surfaces.

MassInt

Request:: MassIntRequest
Response:: MassIntResponse

Computes the mass integral of an expression over the specified cell zones.

Maximum

Request:: MaximumRequest
Response:: MaximumResponse

Computes the maximum value of an expression over the specified locations.

Minimum

Request:: MinimumRequest
Response:: MinimumResponse

Computes the minimum value of an expression over the specified locations.

PressureForce

Request:: PressureForceRequest
Response:: PressureForceResponse

Computes the pressure force on the specified surfaces.

ViscousForce

Request:: ViscousForceRequest
Response:: ViscousForceResponse

Computes the viscous force on the specified surfaces.

Volume

Request:: VolumeRequest
Response:: VolumeResponse

Computes the total volume of the specified cell zones.

VolumeAve

Request:: VolumeAveRequest
Response:: VolumeAveResponse

Computes the volume-weighted average of an expression over the specified cell zones.

VolumeInt

Request:: VolumeIntRequest
Response:: VolumeIntResponse

Computes the volume integral of an expression over the specified cell zones.

Moment

Request:: MomentRequest
Response:: MomentResponse

Computes the moment about the origin for the specified surfaces.

Sum

Request:: SumRequest
Response:: SumResponse

Computes the weighted sum of an expression over the specified locations.

SumIf

Request:: SumIfRequest
Response:: SumIfResponse

Computes the weighted sum of an expression where the condition is true over the specified locations.

Messages

AreaRequest

AreaRequest is the request message for computing surface area

locations (1)repeated string: Surface names or zone IDs where area is computed

AreaResponse

AreaResponse contains the computed area value

value (1)Variant: The total area of the specified surfaces

AreaAveRequest

AreaAveRequest is the request message for computing area-weighted average

expression (1)string: Field expression to average (e.g., “temperature”, “pressure”)
locations (2)repeated string: Surface names or zone IDs where average is computed

AreaAveResponse

AreaAveResponse contains the computed area-weighted average

value (1)Variant: The area-weighted average value

AreaIntRequest

AreaIntRequest is the request message for computing area integral

expression (1)string: Field expression to integrate
locations (2)repeated string: Surface names or zone IDs where integral is computed

AreaIntResponse

AreaIntResponse contains the computed area integral

value (1)Variant: The area integral value

CentroidRequest

CentroidRequest is the request message for computing geometric centroid

locations (1)repeated string: Surface names or zone IDs

CentroidResponse

CentroidResponse contains the computed centroid coordinates

value (1)Point: The centroid coordinates (x, y, z)

CountRequest

CountRequest is the request message for counting cells or faces

locations (1)repeated string: Surface or cell zone names/IDs to count

CountResponse

CountResponse contains the count of cells or faces

value (1)Variant: The number of cells or faces

CountIfRequest

CountIfRequest is the request message for conditional counting

expression (1)string: Conditional expression (e.g., “temperature > 300”)
locations (2)repeated string: Surface or cell zone names/IDs to count

CountIfResponse

CountIfResponse contains the conditional count

value (1)Variant: The number of cells/faces where condition is true

ForceRequest

ForceRequest is the request message for computing total force (pressure + viscous)

locations (1)repeated string: Surface names or zone IDs

ForceResponse

ForceResponse contains the computed force vector

value (1)Point: The force vector components (Fx, Fy, Fz)

MassAveRequest

MassAveRequest is the request message for computing mass-weighted average

expression (1)string: Field expression to average
locations (2)repeated string: Cell zone names or IDs

MassAveResponse

MassAveResponse contains the computed mass-weighted average

value (1)Variant: The mass-weighted average value

MassFlowAveRequest

MassFlowAveRequest is the request message for computing mass-flow-weighted average

expression (1)string: Field expression to average
locations (2)repeated string: Surface names or zone IDs

MassFlowAveResponse

MassFlowAveResponse contains the computed mass-flow-weighted average

value (1)Variant: The mass-flow-weighted average value

MassFlowAveAbsRequest

MassFlowAveAbsRequest is the request message for computing mass-flow-weighted average using absolute mass flow

expression (1)string: Field expression to average
locations (2)repeated string: Surface names or zone IDs

MassFlowAveAbsResponse

MassFlowAveAbsResponse contains the computed average using absolute mass flow

value (1)Variant: The mass-flow-weighted average (absolute) value

MassFlowIntRequest

MassFlowIntRequest is the request message for computing mass flow integral

expression (1)string: Field expression to integrate
locations (2)repeated string: Surface names or zone IDs

MassFlowIntResponse

MassFlowIntResponse contains the computed mass flow integral

value (1)Variant: The mass flow integral value

MassIntRequest

MassIntRequest is the request message for computing mass integral

expression (1)string: Field expression to integrate
locations (2)repeated string: Cell zone names or IDs

MassIntResponse

MassIntResponse contains the computed mass integral

value (1)Variant: The mass integral value

MaximumRequest

MaximumRequest is the request message for computing maximum value

expression (1)string: Field expression to evaluate
locations (2)repeated string: Surface or cell zone names/IDs

MaximumResponse

MaximumResponse contains the maximum value

value (1)Variant: The maximum value of the expression

MinimumRequest

MinimumRequest is the request message for computing minimum value

expression (1)string: Field expression to evaluate
locations (2)repeated string: Surface or cell zone names/IDs

MinimumResponse

MinimumResponse contains the minimum value

value (1)Variant: The minimum value of the expression

PressureForceRequest

PressureForceRequest is the request message for computing pressure force

locations (1)repeated string: Surface names or zone IDs

PressureForceResponse

PressureForceResponse contains the computed pressure force vector

value (1)Point: The pressure force vector components (Fx, Fy, Fz)

ViscousForceRequest

ViscousForceRequest is the request message for computing viscous force

locations (1)repeated string: Surface names or zone IDs

ViscousForceResponse

ViscousForceResponse contains the computed viscous force vector

value (1)Point: The viscous force vector components (Fx, Fy, Fz)

VolumeRequest

VolumeRequest is the request message for computing total volume

locations (1)repeated string: Cell zone names or IDs

VolumeResponse

VolumeResponse contains the computed volume

value (1)Variant: The total volume of the specified cell zones

VolumeAveRequest

VolumeAveRequest is the request message for computing volume-weighted average

expression (1)string: Field expression to average
locations (2)repeated string: Cell zone names or IDs

VolumeAveResponse

VolumeAveResponse contains the computed volume-weighted average

value (1)Variant: The volume-weighted average value

VolumeIntRequest

VolumeIntRequest is the request message for computing volume integral

expression (1)string: Field expression to integrate
locations (2)repeated string: Cell zone names or IDs

VolumeIntResponse

VolumeIntResponse contains the computed volume integral

value (1)Variant: The volume integral value

MomentRequest

MomentRequest is the request message for computing moment about the origin

expression (1)string: Field expression for moment calculation
locations (2)repeated string: Surface names or zone IDs

MomentResponse

MomentResponse contains the computed moment vector

value (1)Point: The moment vector components (Mx, My, Mz)

SumRequest

SumRequest is the request message for computing weighted sum

expression (1)string: Field expression to sum
locations (2)repeated string: Surface or cell zone names/IDs
weight (3)string: Weight expression (e.g., “area”, “volume”)

SumResponse

SumResponse contains the computed weighted sum

value (1)Variant: The weighted sum value

SumIfRequest

SumIfRequest is the request message for computing conditional weighted sum

expression (1)string: Field expression to sum
condition (2)string: Conditional expression for filtering
locations (3)repeated string: Surface or cell zone names/IDs
weight (4)string: Weight expression (e.g., “area”, “volume”)

SumIfResponse

SumIfResponse contains the computed conditional weighted sum

value (1)Variant: The weighted sum value where condition is true