Merge pull request #10 from ansys-internal/fb-ROCKY-20650-more-pyrock…

…y-examples

Include more pyrocky examples

examples/basic_examples/particle_wall_interaction.py

@@ -0,0 +1,101 @@
+""".. _ref_particle_wall_interaction:
+
+Particle simulation with wall interaction
+-----------------------------------------
+This example sets up and solves a simulation of particles interacting with a cylinder
+wall.
+
+"""
+
+###############################################################################
+# .. image:: /_static/open_cylinder_result.png
+#   :width: 400pt
+#   :align: center
+
+###############################################################################
+# Perform imports and create a project
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Perform the required imports and create an empty project.
+
+import os.path
+import tempfile
+
+import ansys.rocky.core as pyrocky
+from ansys.rocky.core import examples
+
+# Create a temp directory to save the project.
+project_dir = tempfile.mkdtemp(prefix="pyrocky_")
+
+# Launch Rocky and open a project.
+rocky = pyrocky.launch_rocky()
+project = rocky.api.CreateProject()
+project.SaveProject(os.path.join(project_dir, "rocky-testing.rocky"))
+
+###############################################################################
+# Configure the study
+# ~~~~~~~~~~~~~~~~~~~
+study = project.GetStudy()
+
+# Download the STL file that will imported into Rocky to represent a Wall.
+file_name = "open_cylinder.stl"
+file_path = examples.download_file(project_dir, file_name, "pyrocky/geometries")
+study.ImportWall(file_path)
+
+# Create a sphero-cylinder shape particle with the default size distribution (single
+# distribution with sieve size of 0.1 m).
+particle = study.CreateParticle()
+particle.SetShape("sphero_cylinder")
+
+# Create circular surface with a max radius of 0.3 m and default center coordinates
+# values (0.0, 0.0, 0.0).
+circular_surface = study.CreateCircularSurface()
+circular_surface.SetMaxRadius(0.3, "m")
+particle_inlet = study.CreateParticleInlet(circular_surface, particle)
+
+###############################################################################
+# Setup the solver and run the simulation
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+solver = study.GetSolver()
+solver.SetSimulationDuration(2, unit="s")
+study.StartSimulation()
+
+###############################################################################
+# Post-processing
+# ~~~~~~~~~~~~~~~
+# Obtain the particle count curve over the entire particle domain and in a half-cylinder
+# domain selection, as shown in the figure below.
+
+###############################################################################
+# .. image:: /_static/open_cylinder_result_selection.png
+#   :width: 400pt
+#   :align: center
+
+processes = project.GetUserProcessCollection()
+
+particles = study.GetParticles()
+cylinder_selection = processes.CreateCylinderProcess(particles)
+cylinder_selection.SetSize(2, 0.74, 2, unit="m")
+cylinder_selection.SetCenter(0, -0.37, 0, unit="m")
+cylinder_selection.SetFinalAngle(180)
+
+times, all_particles_count = particles.GetNumpyCurve("Particles Count")
+times, selection_count = cylinder_selection.GetNumpyCurve("Particles Count")
+
+#################################################################################
+# Plotting curves
+# +++++++++++++++
+
+import matplotlib.pyplot as plt
+
+fig, ax = plt.subplots(1)
+
+ax.plot(times, all_particles_count, "b", label="All Particles")
+ax.plot(times, selection_count, "r", label="Selection Particles")
+ax.set_xlabel("Time [s]")
+ax.set_ylabel("Count [-]")
+ax.legend(loc="upper left")
+
+plt.show()
+
+rocky.close()

examples/basic_examples/particle_wall_interaction_with_motion.py

@@ -0,0 +1,111 @@
+""".. _ref_particle_wall_interaction_with_motion:
+
+Particle simulation with moving wall interaction
+------------------------------------------------
+This example sets up and solves a simulation of particles interacting with a rotating
+L-shape tube wall.
+
+"""
+###############################################################################
+# .. image:: /_static/Lshape_tube_result.png
+#   :width: 400pt
+#   :align: center
+
+###############################################################################
+# Perform imports and create a project
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Perform the required imports and create an empty project.
+
+import os.path
+import tempfile
+
+import ansys.rocky.core as pyrocky
+from ansys.rocky.core import examples
+
+# Create a temp directory to save the project.
+project_dir = tempfile.mkdtemp(prefix="pyrocky_")
+
+# Launch Rocky and open a project.
+rocky = pyrocky.launch_rocky()
+project = rocky.api.CreateProject()
+project.SaveProject(os.path.join(project_dir, "rocky-testing.rocky"))
+
+###############################################################################
+# Configure the study
+# ~~~~~~~~~~~~~~~~~~~
+study = project.GetStudy()
+
+# Download the STL file that will imported into Rocky to represent a Wall.
+file_name = "Lshape_tube.stl"
+file_path = examples.download_file(project_dir, file_name, "pyrocky/geometries")
+wall = study.ImportWall(file_path)[0]
+
+# Create a particle with the default shape (Sphere) and size distribution (single
+# distribution with sieve size of 0.1 m).
+particle = study.CreateParticle()
+
+# Create circular surface to be used as inlet.
+circular_surface = study.CreateCircularSurface()
+circular_surface.SetMaxRadius(0.8, unit="m")
+
+# Create a rectangular surface to be used as outlet.
+rectangular_surface = study.CreateRectangularSurface()
+rectangular_surface.SetLength(3, unit="m")
+rectangular_surface.SetWidth(3, unit="m")
+rectangular_surface.SetCenter((5, -7.5, 0), unit="m")
+
+# Set the inlet and outlet.
+particle_inlet = study.CreateParticleInlet(circular_surface, particle)
+particle_inlet.GetInputPropertiesList().__getitem__(0).SetMassFlowRate(1000)
+outlet = study.CreateOutlet(rectangular_surface)
+
+# Set the motion rotation over Y axis a apply it on the wall and the rectagular surface
+# used as outlet.
+motion_frame_source = study.GetMotionFrameSource()
+motion_frame = motion_frame_source.NewFrame()
+motion_frame.AddRotationMotion(angular_velocity=((0.0, 0.5, 0.0), "rad/s"))
+motion_frame.ApplyTo(rectangular_surface)
+motion_frame.ApplyTo(wall)
+
+# The domain settings define the domain limits where the particles are enabled to be
+# computed in the simulation.
+domain = study.GetDomainSettings()
+domain.DisableUseBoundaryLimits()
+domain.SetCoordinateLimitsMaxValues((10, 1, 10), unit="m")
+
+###############################################################################
+# Setup the solver and run the simulation
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+solver = study.GetSolver()
+solver.SetSimulationDuration(5, unit="s")
+study.StartSimulation()
+
+###############################################################################
+# Post-processing
+# ~~~~~~~~~~~~~~~
+# Obtain the particles In/Out mass flow.
+
+particles = study.GetParticles()
+
+times, mass_flow_in = particles.GetNumpyCurve("Particles Mass Flow In", unit="t/h")
+times, mass_flow_out = particles.GetNumpyCurve("Particles Mass Flow Out", unit="t/h")
+
+
+#################################################################################
+# Plotting curves
+# +++++++++++++++
+
+import matplotlib.pyplot as plt
+
+fig, ax = plt.subplots(1)
+
+ax.plot(times, mass_flow_in, "b", label="Mass Flow In")
+ax.plot(times, mass_flow_out, "r", label="Mass Flow Out")
+ax.set_xlabel("Time [s]")
+ax.set_ylabel("Mass Flow [t/h]")
+ax.legend(loc="upper left")
+
+plt.show()
+
+rocky.close()

src/ansys/rocky/core/examples.py

@@ -7,14 +7,13 @@
 logger = logging.getLogger("pyrocky.networking")
 
 
-ANSYS_EXAMPLE_DATA_REPO = 'https://github.com/ansys/example-data/raw/master'
+ANSYS_EXAMPLE_DATA_REPO = "https://github.com/ansys/example-data/raw/master"
+
 
 def _get_file_url(file_name: str, directory: Optional[str] = None) -> str:
     """Get file URL."""
     if directory:
-        return (
-            f"{ANSYS_EXAMPLE_DATA_REPO}/{directory}/{file_name}"
-        )
+        return f"{ANSYS_EXAMPLE_DATA_REPO}/{directory}/{file_name}"
     return f"{ANSYS_EXAMPLE_DATA_REPO}/{file_name}"