edit_design_settings#

Icepak.edit_design_settings(gravity_dir: int | None = 0, ambient_temperature: float | str | BoundaryDictionary | dict = 20, perform_validation: bool | None = False, check_level: str | None = 'None', default_fluid: str | None = 'air', default_solid: str | None = 'Al-Extruded', default_surface: str | None = 'Steel-oxidised-surface', export_monitor: bool | None = False, export_sherlock: bool | None = False, export_directory: str | None = '/home/runner/work/pyaedt/pyaedt/doc/source', gauge_pressure: int | None = 0, radiation_temperature: int | None = 20, ignore_unclassified_objects: bool | None = False, skip_intersection_checks: bool | None = False) bool#

Update the main settings of the design.

Parameters:
gravity_dirint, optional

Gravity direction from -X to +Z. Options are 0 to 5. The default is 0.

ambient_temperaturefloat, str, BoundaryDict or dict optional

Ambient temperature. The default is 20. The default unit is Celsius for a float or string value. You can include a unit for a string value. For example, 325kel.

perform_validationbool, optional

Whether to perform validation. The default is False.

check_levelstr, optional

Level of check to perform during validation. The default is "None".

default_fluidstr, optional

Default fluid material. The default is "air".

default_solidstr, optional

Default solid material. The default is "Al-Extruded".

default_surfacestr, optional

Default surface material. The default is "Steel-oxidised-surface".

export_monitorbool, optional

Whether to export monitor data. The default is False.

export_sherlockbool, optional

Whether to export temperature data for Sherlock. The default is False.

export_directorystr, optional

Default export directory for monitor point and Sherlock data. The default is the current working directory.

gauge_pressurefloat, str, optional

Gauge pressure. It can be a float where “n_per_meter_sq” is assumed as the units or a string with the units specified. The default is 0.

radiation_temperaturefloat, str, optional

Set the radiation temperature. It can be a float (units will be “cel”) or a string with units. Default is 20.

ignore_unclassified_objectsbool, optional

Whether to ignore unclassified objects during validation check. The default value is False.

skip_intersection_checksbool, optional

Whether to skip intersection checks during validation check. The default value is False.

Returns:
bool

True when successful, False when failed.

References

>>> oDesign.SetDesignSettings