ansys.fluent.parametric.ParametricStudy

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

Class to manage design points.

Parametric study that manages design points to parametrize a Fluent solver set-up. Provides ability to run Fluent for a series of design points, and access/modify the input and output parameters.

Attributes:

namestr

Name of the parametric study.

is_currentbool

Whether the parametric study is the current parametric study.

design_pointsDict[str, DesignPoint]

Design points under the parametric study by name.

current_design_pointDesignPoint

Return the current design point.

project_filepathPath

Filepath of the associated project.

Methods

set_as_current()	Set the parametric study as the current parametric study.
get_all_studies()	Get all currently active studies.
initialize()	Initialize parametric study.
duplicate(copy_design_points)	Duplicate the parametric study.
rename(new_name)	Rename the parametric study.
delete()	Delete the parametric study.
use_base_data()	Use base data for the parametric study.
import_design_table(filepath)	Import the design table for the parametric study.
export_design_table(filepath)	Export the design table for the parametric study.
add_design_point(write_data, capture_simulation_report_data)	Add a new design point under the parametric study.
delete_design_points(design_points)	Delete a list of design points.
duplicate_design_point(design_point)	Duplicate the design point.
save_journals(separate_journals)	Save journals.
clear_generated_data(design_points)	Clear generated data for a list of design points.
load_current_design_point_case_data()	Load case-data of the current design point.
update_current_design_point()	Update the current design point.
update_all_design_points()	Update all design points.
update_selected_design_points(design_points)	Update a list of design points.

Methods

ParametricStudy.add_design_point([...])	Add a new design point under the parametric study.
ParametricStudy.clear_generated_data(...)	Clear 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 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	Return the current design point.
ParametricStudy.current_study_name
ParametricStudy.is_current	Whether the parametric study is the current parametric study.