ForceDistributionCSVModel

class ForceDistributionCSVModel

Bases: PerEntityResultCSVModel

CustomForceDistributionResultCSVModel

Attributes

remote_file_name: str

local_file_name: str

Default:

None

do_download: bool, optional

Default:

None

local_storage: str, optional

Default:

None

temp_file: str

Default:

'/tmp/tmpx48idwvm/79699610-dd39-4090-a191-7516554346bb.csv'

Properties

values

Get the current data.

Returns:

Dictionary containing the current data.

Return type:

dict

entities

Returns list of entity names available for this result

raw_values

Get the raw CSV data.

Returns:

Dictionary containing the raw CSV data.

Return type:

dict

averages

Get average data over last 10%

Returns:

Dictionary containing CL, CD, CFx/y/z, CMx/y/z and other columns available in data

Return type:

dict

Additional Constructors

classmethod from_dict(data, group=None)

Overloaded version of from_dict to store entity groups.

Parameters:

• data (dict)

• group (dict[str, List[str]] | None)

by_boundary_condition(params)

Group entities by boundary condition’s name and create a SurfaceForcesGroupResultCSVModel. Forces from different boundaries but with the same type and name will be summed together.

Parameters:

params (SimulationParams)

Return type:

PerEntityResultCSVModel

by_body_group(params)

Group entities by body group’s name and create a SurfaceForcesGroupResultCSVModel

Parameters:

params (SimulationParams)

Return type:

PerEntityResultCSVModel

Methods

filter(include=None, exclude=None)

Filters entities based on include and exclude lists.

Parameters:

• include (list or single item, optional) – List of patterns or single pattern to include.

• exclude (list or single item, optional) – List of patterns or single pattern to exclude.

reload_data(filter_physical_steps_only=False, include_time=False)

Change default behavior of data loader, reload

Parameters:

• filter_physical_steps_only (bool)

• include_time (bool)

load_from_local(filename)

Load CSV data from a local file.

Parameters:

filename (str) – Path to the local CSV file.

load_from_remote(**kwargs_download)

Load CSV data from a remote source.

download(to_file=None, to_folder='.', overwrite=False, **kwargs)

Download the CSV file.

Parameters:

• to_file (str, optional) – The name of the file after downloading.

• to_folder (str, optional) – The folder where the file will be downloaded.

• overwrite (bool, optional) – Flag indicating whether to overwrite existing files.

update(df)

Update containing value to the given DataFrame

Parameters:

df (DataFrame)

to_file(filename=None)

Save the data to a CSV file.

Parameters:

filename (str, optional) – The name of the file to save the CSV data.

as_dict()

Convert the data to a dictionary.

Returns:

Dictionary containing the data.

Return type:

dict

as_numpy()

Convert the data to a NumPy array.

Returns:

NumPy array containing the data.

Return type:

numpy.ndarray

as_dataframe()

Convert the data to a Pandas DataFrame.

Returns:

DataFrame containing the data.

Return type:

pandas.DataFrame

wait(timeout_minutes=60)

Wait until the Case finishes processing, refresh periodically. Useful for postprocessing, eg sectional data

include_time()

Set the option to include time in the data

filter_physical_steps_only()

filters data to contain only last pseudo step data for every physical step

get_averages(average_fraction)

Computes the average of data