TimeAverageForceDistributionOutput

class TimeAverageForceDistributionOutput

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,
... )

Specifying specific surfaces to include in the force integration (useful for automotive cases to exclude road/floor surfaces):

>>> fl.TimeAverageForceDistributionOutput(
...     name="vehicle_x_distribution",
...     distribution_direction=[1.0, 0.0, 0.0],
...     entities=[volume_mesh["vehicle_body"], volume_mesh["wheels"]],
...     number_of_segments=500,
...     start_step=100,
... )

---

Attributes

name: str

Name of the TimeAverageForceDistributionOutput.

Default:

'Time average force distribution output'

distribution_direction: Axis

Direction of the force distribution output.

entities: EntityList[Surface, MirroredSurface], optional

List of surfaces to include in the force integration. If not specified, all wall surfaces are included. This is useful for automotive cases to exclude road/floor surfaces.

Default:

None

number_of_segments: int

Number of segments (bins) to use along the distribution direction. Default is 300 segments. Increasing this value provides higher resolution in the force distribution plot.

Default:

300

start_step: int | Literal[-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).

Default:

-1

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')