flow360.TimeAverageForceDistributionOutput#

class TimeAverageForceDistributionOutput[source]#

Bases: ForceDistributionOutput

TimeAverageForceDistributionOutput class for time-averaged customized force and moment distribution output. Axis-aligned components are output for force and moment coefficients at the end of the simulation.

Example

Calculate the average value starting from the \(4^{th}\) physical step.

>>> fl.TimeAverageForceDistributionOutput(
...     name="spanwise",
...     distribution_direction=[0.1, 0.9, 0.0],
...     start_step=4,
... )

name: str = 'Time average force distribution output'#

Name of the TimeAverageForceDistributionOutput.

start_step: Annotated[int, Ge(ge=0)] | Literal[-1] = -1#

Physical time step to start calculating averaging. Important for child cases - this parameter refers to the global time step, which gets transferred from the parent case (see frequency parameter for an example).

output_type: Literal['TimeAverageForceDistributionOutput'] = 'TimeAverageForceDistributionOutput'#
distribution_direction: Axis [Required]#

Direction of the force distribution output.

distribution_type: Literal['incremental', 'cumulative'] = 'incremental'#

Type of the distribution.