ansys.fluent.parametric.ParametricStudy#

class ansys.fluent.parametric.ParametricStudy(parametric_studies, session=None, name=None, design_points=None)#

Provides for managing parametric studies and their respective design points.

A parametric study is used to parametrize design points in a Fluent solver set up. This class provides the ability to run Fluent for a series of design points and access or modify input and output parameters.

Parameters
parametric_studies
sessionSession, optional

Connected Fluent session. The default is None.

namestr, optional

Name of the parametric study. The default is None.

design_pointsDict[str, DesignPoint], optional

Dictionary of design points under the parametric study by name. The default is None.

Methods

ParametricStudy.add_design_point([...])

Add a new design point under the parametric study.

ParametricStudy.clear_generated_data(...)

Clear the generated data for a list of design points.

ParametricStudy.delete()

Delete the parametric study.

ParametricStudy.delete_design_points(...)

Delete a list of design points.

ParametricStudy.duplicate([copy_design_points])

Duplicate the current study.

ParametricStudy.duplicate_design_point(...)

Duplicate the design point.

ParametricStudy.export_design_table(filepath)

Export the design table for the parametric study.

ParametricStudy.get_all_studies()

Get all currently active studies.

ParametricStudy.import_design_table(filepath)

Import the design table for the parametric study.

ParametricStudy.initialize()

Initialize the parametric study.

ParametricStudy.load_current_design_point_case_data()

Load case data of the current design point.

ParametricStudy.rename(new_name)

Rename the parametric study.

ParametricStudy.save_journals(separate_journals)

Save journals.

ParametricStudy.set_as_current()

Set the parametric study as the current parametric study.

ParametricStudy.update_all_design_points()

Update all design points.

ParametricStudy.update_current_design_point()

Update the current design point.

ParametricStudy.update_selected_design_points(...)

Update a list of design points.

ParametricStudy.use_base_data()

Use base data for the parametric study.

Attributes

ParametricStudy.current_design_point

Get the current design point.

ParametricStudy.is_current

Whether the parametric study is the current parametric study.