CaseResultsModel

CaseResultsModel#

class CaseResultsModel[source]#

Bases: BaseModel

Pydantic models for case results

Attributes

case: Any#
surfaces: ResultTarGZModel#
Default:

ResultTarGZModel()

volumes: ResultTarGZModel#
Default:

ResultTarGZModel()

slices: ResultTarGZModel#
Default:

ResultTarGZModel()

isosurfaces: ResultTarGZModel#
Default:

ResultTarGZModel()

monitors: MonitorsResultModel#
Default:

MonitorsResultModel()

nonlinear_residuals: NonlinearResidualsResultCSVModel#
Default:

NonlinearResidualsResultCSVModel()

linear_residuals: LinearResidualsResultCSVModel#
Default:

LinearResidualsResultCSVModel()

cfl: CFLResultCSVModel#
Default:

CFLResultCSVModel()

minmax_state: MinMaxStateResultCSVModel#
Default:

MinMaxStateResultCSVModel()

max_residual_location: MaxResidualLocationResultCSVModel#
Default:

MaxResidualLocationResultCSVModel()

total_forces: TotalForcesResultCSVModel#
Default:

TotalForcesResultCSVModel()

surface_forces: SurfaceForcesResultCSVModel#
Default:

SurfaceForcesResultCSVModel()

actuator_disks: ActuatorDiskResultCSVModel#
Default:

ActuatorDiskResultCSVModel()

bet_forces: BETForcesResultCSVModel#
Default:

BETForcesResultCSVModel()

porous_media: PorousMediumResultCSVModel#
Default:

PorousMediumResultCSVModel()

bet_forces_radial_distribution: BETForcesRadialDistributionResultCSVModel#
Default:

BETForcesRadialDistributionResultCSVModel()

legacy_force_distribution: LegacyForceDistributionResultCSVModel#
Default:

LegacyForceDistributionResultCSVModel()

x_slicing_force_distribution: XSlicingForceDistributionResultCSVModel#
Default:

XSlicingForceDistributionResultCSVModel()

y_slicing_force_distribution: YSlicingForceDistributionResultCSVModel#
Default:

YSlicingForceDistributionResultCSVModel()

user_defined_dynamics: UserDefinedDynamicsResultModel#
Default:

UserDefinedDynamicsResultModel()

custom_forces: CustomForceResultModel#
Default:

CustomForceResultModel()

force_distributions: ForceDistributionsResultModel#
Default:

ForceDistributionsResultModel()

surface_heat_transfer: SurfaceHeatTransferResultCSVModel#
Default:

SurfaceHeatTransferResultCSVModel()

aeroacoustics: AeroacousticsResultCSVModel#
Default:

AeroacousticsResultCSVModel()

local_storage: str, optional#
Default:

None

Methods

pass_download_function()[source]#

Pass download methods into fields of the case results.

pass_has_functions()[source]#

Pass check to see if result is downloadable based on params

set_destination(folder_name=None, use_case_name=None, use_case_id=None)[source]#

Set the destination for downloading files.

Parameters:

  • folder_name (str, optional) – The name of the folder where files will be downloaded.

  • use_case_name (bool, optional) – Whether to use the use case name for the destination.

  • use_case_id (bool, optional) – Whether to use the use case ID for the destination.

Raises:

ValueError – If more than one argument is provided or if no arguments are provided.

download(surface=None, volume=None, slices=None, isosurfaces=None, monitors=None, nonlinear_residuals=None, linear_residuals=None, cfl=None, minmax_state=None, max_residual_location=None, surface_forces=None, total_forces=None, bet_forces=None, bet_forces_radial_distribution=None, actuator_disks=None, legacy_force_distribution=None, x_slicing_force_distribution=None, y_slicing_force_distribution=None, user_defined_dynamics=None, custom_forces=None, force_distributions=None, aeroacoustics=None, surface_heat_transfer=None, all=None, overwrite=False, destination=None)[source]#

Download result files associated with the case.

Parameters:

  • surface (bool, optional) – Download surface result file if True.

  • volume (bool, optional) – Download volume result file if True.

  • nonlinear_residuals (bool, optional) – Download nonlinear residuals file if True.

  • linear_residuals (bool, optional) – Download linear residuals file if True.

  • cfl (bool, optional) – Download CFL file if True.

  • minmax_state (bool, optional) – Download minmax state file if True.

  • surface_forces (bool, optional) – Download surface forces file if True.

  • total_forces (bool, optional) – Download total forces file if True.

  • bet_forces (bool, optional) – Download BET (Blade Element Theory) forces file if True.

  • bet_forces_radial_distribution (bool, optional) – Download BET (Blade Element Theory) forces radial distribution file if True.

  • actuator_disk_output (bool, optional) – Download actuator disk output file if True.

  • all (bool, optional) – Download all result files if True. Ignore file if explicitly set: <result_name>=False

  • overwrite (bool, optional) – If True, overwrite existing files with the same name in the destination.

  • destination (str, optional) – Location to save downloaded files. If None, files will be saved in the current directory under ID folder.

  • slices (bool | None)

  • isosurfaces (bool | None)

  • monitors (bool | None)

  • max_residual_location (bool | None)

  • actuator_disks (bool | None)

  • legacy_force_distribution (bool | None)

  • x_slicing_force_distribution (bool | None)

  • y_slicing_force_distribution (bool | None)

  • user_defined_dynamics (bool | None)

  • custom_forces (bool | None)

  • force_distributions (bool | None)

  • aeroacoustics (bool | None)

  • surface_heat_transfer (bool | None)

download_file_by_name(file_name, to_file=None, to_folder='.', overwrite=True)[source]#

Download file by name

Parameters:

overwrite (bool)

set_local_storage(local_storage, keep_remote_structure=False)[source]#

Set local storage for fetching data from. Used with Case.from_local_storage(…)

Parameters:

  • local_storage (str) – Path to local folder

  • keep_remote_structure (bool, optional) – When true, remote folder structure is assumed to be preserved, otherwise flat structure, by default False