Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Post processing with pyVista #21

Merged
merged 31 commits into from
Feb 4, 2022
Merged

Post processing with pyVista #21

merged 31 commits into from
Feb 4, 2022

Conversation

ajain-work
Copy link
Contributor

@ajain-work ajain-work commented Jan 25, 2022 •
edited

Added a new module postprcessing/pyvista for pyFluent postprocessing. Currently mesh, contour and iso surfaces are supported.

After initialize and solve follow the steps:

#import module
import ansys.fluent.postprocessing.pyvista as pv
 
#get the graphics objects 
graphics_session1 = pv.Graphics(session)
m1 = graphics_session1.Meshes["m1"]
c1 = graphics_session1.Contours["c1"]
c2 = graphics_session1.Contours["c2"]
s1 = graphics_session1.Surfaces["s1"]

#set graphics objects properties
#mesh
m1.show_edges= True
m1.surfaces_list = ['symmetry']

#contour
c1.field = "velocity-magnitude"
c1.surfaces_list = ['symmetry']

c2.field = "temperature"
c2.surfaces_list = ['symmetry', 'wall']

#iso surface
s1.surface_type.iso_surface.field= "velocity-magnitude"
s1.surface_type.iso_surface.rendering= "contour"

#display
c1.display()
m1.display()
s1.display()

mkundu1
mkundu1 reviewed Jan 25, 2022
View reviewed changes
ansys/fluent/core/core.py Outdated Show resolved Hide resolved
mkundu1
mkundu1 reviewed Jan 25, 2022
View reviewed changes
ansys/fluent/solver/tui.py Outdated Show resolved Hide resolved
mkundu1
mkundu1 reviewed Jan 25, 2022
View reviewed changes
ansys/fluent/session.py Outdated
@@ -2,6 +2,8 @@
import threading

from ansys.api.fluent.v0 import datamodel_pb2_grpc as DataModelGrpcModule
from ansys.api.fluent.v0 import fielddata_pb2_grpc as FieldGrpcModule
from ansys.fluent.core.core import FieldDataService
Copy link
Contributor

@mkundu1 mkundu1 Jan 25, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These imports can be sorted. There is a tool isort to do that automatically.

@mkundu1

This comment has been minimized.

Sign in to view
h-krishnan
h-krishnan reviewed Jan 25, 2022
View reviewed changes
ansys/fluent/core/core.py Outdated
@@ -2,6 +2,7 @@
import os

from ansys.api.fluent.v0 import datamodel_pb2 as DataModelProtoModule
from ansys.api.fluent.v0 import fielddata_pb2 as FieldDataProtoModule
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest we have a module per service which wraps that service's grpc calls, rather than importing the _pb2 files in many modules.

seanpearsonuk
seanpearsonuk reviewed Jan 25, 2022
View reviewed changes
ansys/fluent/postprocessing/__init__.py Outdated
@@ -0,0 +1,2 @@

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we keep this file?

akaszynski
akaszynski reviewed Jan 25, 2022
View reviewed changes
README.rst Outdated
Comment on lines 50 to 51
-----------------
#import module

This comment was marked as resolved.

Sign in to view

akaszynski
akaszynski reviewed Jan 25, 2022
View reviewed changes
ansys/fluent/postprocessing/pyvista/graphics.py Outdated
Comment on lines 13 to 15
"""
Instantiate the graphics objects.
"""

This comment was marked as resolved.

Sign in to view

akaszynski
akaszynski reviewed Jan 25, 2022
View reviewed changes
ansys/fluent/postprocessing/pyvista/graphics.py Outdated
Comment on lines 45 to 47
"""
Displays mesh graphics.
"""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix docstring. Public methods should include an example.

akaszynski
akaszynski reviewed Jan 25, 2022
View reviewed changes
ansys/fluent/postprocessing/pyvista/plotter.py Outdated
Comment on lines 102 to 106
surface_ids = [
id
for surf in obj.surfaces_list()
for id in surfaces_info.get(surf, {}).get("surface_id", [])
]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems inefficient. Is there a way this can be done through array access?

akaszynski
akaszynski reviewed Jan 25, 2022
View reviewed changes
ansys/fluent/postprocessing/pyvista/plotter.py Outdated
Comment on lines 237 to 239
except Exception as e:
print(e)
pass

This comment was marked as resolved.

Sign in to view

akaszynski
akaszynski reviewed Jan 25, 2022
View reviewed changes
ansys/fluent/postprocessing/pyvista/plotter.py Outdated
.keys()
)
if not "dummy" in surfaces_list:
raise RuntimeError(f"Iso surface creation failed.")

This comment was marked as resolved.

Sign in to view

akaszynski
akaszynski reviewed Jan 25, 2022
View reviewed changes
Copy link
Contributor

@akaszynski akaszynski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great start, and I'm impressed how far you've gotten with pyvista!

This PR needs unit testing and documentation, which I know is hard without a fluent docker image, but we're going to have to add it in. There's really no way to do test driven development without CI/CD performing PR validation; otherwise this isn't going to scale when we start adding significant features.

There's no better time to add in docs and unit testing than when implementing features.

@mkundu1 mkundu1 mentioned this pull request Jan 27, 2022
Closed
ajain-work
ajain-work commented Jan 31, 2022
View reviewed changes
ansys/fluent/solver/meta.py
cls, name, bases, attrs
)


class PyNamedObjectMeta(type):
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should introduce a container object.

@ajain-work ajain-work mentioned this pull request Jan 31, 2022
Closed
akaszynski
akaszynski reviewed Jan 31, 2022
View reviewed changes
Makefile Outdated
Comment on lines 5 to 10
install-pyvista-for-python3.10-linux:
@pip install https://github.com/pyvista/pyvista-wheels/raw/main/vtk-9.1.0.dev0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

install-pyvista-for-python3.10-windows:
@pip install https://github.com/pyvista/pyvista-wheels/raw/main/vtk-9.1.0.dev0-cp310-cp310-win_amd64.whl

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ha! You found the wheels.

akaszynski
akaszynski reviewed Jan 31, 2022
View reviewed changes
README.rst Outdated Show resolved Hide resolved
akaszynski
akaszynski reviewed Jan 31, 2022
View reviewed changes
Copy link
Contributor

@akaszynski akaszynski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs are better, but we're still missing unit tests for this.

Even if we can't get unit tests for our CI/CD yet, we should still have unit tests that can be run locally.

@dnwillia-work dnwillia-work self-requested a review February 1, 2022 22:29
dnwillia-work
dnwillia-work reviewed Feb 4, 2022
View reviewed changes
.flake8
@@ -1,5 +1,7 @@
[flake8]
exclude = venv, tui.py, ansys/api/fluent
per-file-ignores =
Copy link
Collaborator

@dnwillia-work dnwillia-work Feb 4, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, what was causing the error. The naming looks ok. @ajain-ansys

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

class names should use CapWords convention

Copy link
Collaborator

@dnwillia-work dnwillia-work Feb 4, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes and I'm not seeing why you need to ignore that error? It looks like you are using CapWords already. @ajain-ansys

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I did not stare at it hard enough. It's because the member classes not following that naming convention.

Is there a reason the members are not following that?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Member classes represent, object properties. We are not following CapWords convention for properties, because that is how we are accessing them. For example field for a contour object is accessed as: contour1.field.

Copy link
Collaborator

@dnwillia-work dnwillia-work Feb 7, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, ok, but I still don't understand. Is there any reason it can't be contour1.Field? For instance, is there is an external requirement driving this design choice? @ajain-ansys

OK, sorry if I'm being dense, but Is it just that the other commands are all using lower case with underscores?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that is correct. Other commands are all using lower case. For example, all commands in auto generated file tui.py are lower case.

Copy link
Collaborator

@dnwillia-work dnwillia-work Feb 7, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, very sorry, now I got it.

@ajain-work ajain-work merged commit c41cddf into main Feb 4, 2022
@mkundu1 mkundu1 deleted the feat/pyvista_postprocessing branch March 4, 2022 04:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akaszynski akaszynski akaszynski left review comments

@dnwillia-work dnwillia-work dnwillia-work left review comments

@h-krishnan h-krishnan h-krishnan approved these changes

@seanpearsonuk seanpearsonuk seanpearsonuk approved these changes

@mkundu1 mkundu1 mkundu1 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@ajain-work @mkundu1 @akaszynski @dnwillia-work @h-krishnan @seanpearsonuk