Graphics Objects - Contours

[hpohekar]

import ansys.fluent.core as pyfluent
from ansys.fluent.core import examples
from ansys.fluent.visualization.contour import Contour
from ansys.fluent.visualization.pyvista import Graphics

case_filename = examples.download_file("elbow.cas.h5", "pyfluent/examples/DOE-ML-Mixing-Elbow")
data_filename = "../mixing_elbow.dat.h5"

solver = pyfluent.launch_fluent()
solver.tui.file.read_case(case_filename)
solver.tui.file.read_data(data_filename)

contour_1 = Contour("y-face-area", ["cold-inlet"])
contour_1.draw(solver, Graphics(solver))
contour_api_object_1 = contour_1.draw(solver, solver)
solver.results.graphics.contour.display(object_name=contour_api_object_1.name())

contour_2 = Contour("y-face-area", ["cold-inlet"], solver)
contour_2.draw(solver, Graphics(solver))
contour_api_object_2 = contour_2.draw(solver, solver)
solver.results.graphics.contour.display(object_name=contour_api_object_2.name())

[raph-luc]

import ansys.fluent.core as pyfluent
from ansys.fluent.core import examples
from ansys.fluent.visualization.contour import Contour
from ansys.fluent.visualization.pyvista import Graphics

case_filename = examples.download_file("elbow.cas.h5", "pyfluent/examples/DOE-ML-Mixing-Elbow")
data_filename = "../mixing_elbow.dat.h5"

solver = pyfluent.launch_fluent()
solver.tui.file.read_case(case_filename)
solver.tui.file.read_data(data_filename)

contour_1 = Contour("y-face-area", ["cold-inlet"])
contour_1.draw(solver, Graphics(solver))
contour_api_object_1 = contour_1.draw(solver, solver)

contour_2 = Contour("y-face-area", ["cold-inlet"], solver)
contour_2.draw(solver, Graphics(solver))
contour_api_object_2 = contour_2.draw(solver, solver) 

Shouldn't we add this example in the documentation of the Contour class? And perhaps some docstrings in the methods as well?

Also, would probably be useful to have this show up in the documentation somewhere, for example maybe: https://visualization.fluent.docs.pyansys.com/version/stable/users_guide/index.html#display-contour

[seanpearsonuk]

import ansys.fluent.core as pyfluent
from ansys.fluent.core import examples
from ansys.fluent.visualization.contour import Contour
from ansys.fluent.visualization.pyvista import Graphics

case_filename = examples.download_file("elbow.cas.h5", "pyfluent/examples/DOE-ML-Mixing-Elbow")
data_filename = "../mixing_elbow.dat.h5"

solver = pyfluent.launch_fluent()
solver.tui.file.read_case(case_filename)
solver.tui.file.read_data(data_filename)

contour_1 = Contour("y-face-area", ["cold-inlet"])
contour_1.draw(solver, Graphics(solver))
contour_api_object_1 = contour_1.draw(solver, solver)

contour_2 = Contour("y-face-area", ["cold-inlet"], solver)
contour_2.draw(solver, Graphics(solver))
contour_api_object_2 = contour_2.draw(solver, solver) 

Shouldn't we add this example in the documentation of the Contour class? And perhaps some docstrings in the methods as well?

Also, would probably be useful to have this show up in the documentation somewhere, for example maybe: https://visualization.fluent.docs.pyansys.com/version/stable/users_guide/index.html#display-contour

I agree. We also want to do a bit more work here to maximise the usefulness of this.

[hpohekar]

import ansys.fluent.core as pyfluent
from ansys.fluent.core import examples
from ansys.fluent.visualization.contour import Contour
from ansys.fluent.visualization.pyvista import Graphics

case_filename = examples.download_file("elbow.cas.h5", "pyfluent/examples/DOE-ML-Mixing-Elbow")
data_filename = "../mixing_elbow.dat.h5"

solver = pyfluent.launch_fluent()
solver.tui.file.read_case(case_filename)
solver.tui.file.read_data(data_filename)

contour_1 = Contour("y-face-area", ["cold-inlet"])
contour_1.draw(solver, Graphics(solver))
contour_api_object_1 = contour_1.draw(solver, solver)

contour_2 = Contour("y-face-area", ["cold-inlet"], solver)
contour_2.draw(solver, Graphics(solver))
contour_api_object_2 = contour_2.draw(solver, solver) 

Shouldn't we add this example in the documentation of the Contour class? And perhaps some docstrings in the methods as well?

Also, would probably be useful to have this show up in the documentation somewhere, for example maybe: https://visualization.fluent.docs.pyansys.com/version/stable/users_guide/index.html#display-contour

@raph-luc Done. Thank you.

[raph-luc]

Looks good, only a few additional minor suggestions