Upgrade adapter to preCICE version 3 API by KhalilHkiri · Pull Request #34 · precice/fluent-adapter

KhalilHkiri · 2025-04-18T17:42:28Z

No description provided.

Co-authored-by: Ishaan Desai <[email protected]>

* Change ANSYS to Ansys * Change FLUENT to Fluent * Use ticks to indicate code

BenjaminRodenberg

The installation instructions for a UDF under https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/corp/v242/en/flu_udf/flu_udf_sec_compile_tui.html say: "Copy your source file (for example, myudf.c) to the source directory (src)." I think we should stay consistent with this approach and provide the sources under fluent-adapter/src and then ask the user to copy them to the example directory. Therefore, we should avoid the code duplication of examples/Cavity2D/libudf/src.

Additionally: Do you want to mention https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/corp/v242/en/flu_udf/flu_udf_sec_compile_tui.html in the README.md?

BenjaminRodenberg · 2025-04-22T06:36:21Z

+    a = 0.01              # Thickness [m]
+    MI = a**4 / 12        # Area moment of inertia
+    ME = 117e9            # Modulus of elasticity (117 GPa)
+    ll = 1.0              # Beam length [m]


Suggested change

a = 0.01 # Thickness [m]

MI = a**4 / 12 # Area moment of inertia

ME = 117e9 # Modulus of elasticity (117 GPa)

ll = 1.0 # Beam length [m]

a = 0.01 # Thickness [m]

MI = a**4 / 12 # Area moment of inertia of square cross section

ME = 117e9 # Modulus of elasticity (117 GPa) of copper

ll = 1.0 # Beam length [m]

better keep this information. Otherwise these number are just "magic" numbers.

BenjaminRodenberg · 2025-04-22T06:36:48Z

+

 dim = interface.get_mesh_dimensions(mesh_name)
+print("Mesh dimensions:", dim)


Suggested change

print("Mesh dimensions:", dim)

let's remove this debug statement

BenjaminRodenberg · 2025-04-22T06:37:54Z

-
 print("coordinate array to be sent to set_mesh_vertices = {}".format(coords))
-print("mesh_name sent to set_mesh_vertices = {}".format(mesh_name))
+print("mesh_id sent to set_mesh_vertices = {}".format(mesh_name))


Suggested change

print("mesh_id sent to set_mesh_vertices = {}".format(mesh_name))

print("mesh_name sent to set_mesh_vertices = {}".format(mesh_name))

no?

BenjaminRodenberg · 2025-04-22T06:40:45Z

-    forces = interface.read_data(mesh_name, force_name, vertexIDs, dt)
+    forces = interface.read_data("beam", "Forces", vertexIDs, dt)


Generally ok, but why? I usually prefer to define mesh_name somewhere at the top during initialization. At some point we will have to change "beam" to "Beam-Mesh". If we use a variable mesh_name = "beam" we only have to change this at one place and there is a lower risk to forget it. They way how it is currently written here is a bit more risky in this regard.

BenjaminRodenberg · 2025-04-22T06:40:53Z

-    interface.write_data(mesh_name, displ_name, vertexIDs, displacements)
+    interface.write_data("beam", "Displacements", vertexIDs, displacements)


BenjaminRodenberg · 2025-04-22T06:41:32Z

-if interface.requires_initial_data():
-    interface.write_data(mesh_name, force_name, vertexIDs, forces)
-    interface.write_data(mesh_name, displ_name, vertexIDs, displacements)
-


Why did you remove this? Generally we should initialize data. If this does not work at the moment: Let's at least put a todo here.

BenjaminRodenberg · 2025-04-22T06:42:55Z

@@ -0,0 +1,5 @@
+CSOURCES= fsi_udf.c fsi.c
+HSOURCES= fsi.h
+FLUENT_INC= /lrz/sys/applications/ansys/v241/fluent


Suggested change

FLUENT_INC= /lrz/sys/applications/ansys/v241/fluent

FLUENT_INC= /path/to/fluent # TODO has to be provided by user

Is # the correct way to define a comment?

BenjaminRodenberg · 2025-04-22T06:43:46Z

@@ -0,0 +1,5 @@
+CSOURCES= fsi_udf.c fsi.c
+HSOURCES= fsi.h
+FLUENT_INC= /lrz/sys/applications/ansys/v241/fluent


Suggested change

FLUENT_INC= /lrz/sys/applications/ansys/v241/fluent

FLUENT_INC= /path/to/fluent # TODO has to be provided by user

See above.

BenjaminRodenberg · 2025-04-22T06:45:26Z

I think we should not duplicate the src files for the adapter here and just provide them under fluent-adapter/src. Be careful: Don't delete this file (and the others) but copy-paste them over the ones in fluent-adapter/src (I'm not sure if there are any changes you want to keep).

BenjaminRodenberg · 2025-04-22T06:47:31Z

+      <relative-convergence-measure limit="1e-6" data="Displacements" mesh="beam"/>
+      <relative-convergence-measure limit="1e-6" data="Forces" mesh="beam"/>


Why? This should not harm but I would like to know if this is necessary or not.

BenjaminRodenberg · 2025-04-22T10:47:43Z

    </participant>

-    <m2n:sockets from="Fluent" to="CSMdummy"/>
+    <m2n:sockets acceptor="Fluent" connector="CSMdummy" exchange-directory=".."/>


Suggested change

<m2n:sockets acceptor="Fluent" connector="CSMdummy" exchange-directory=".."/>

<m2n:sockets acceptor="Fluent" connector="CSMdummy"/>

Does not harm but this is also not needed.

…e diff

BenjaminRodenberg

Looks good to me. I did not test the adapter myself but it is confirmed to be working by @KhalilHkiri.

KhalilHkiri and others added 12 commits February 28, 2025 09:38

update Readme for the ansys 23R2 and upgraded the configs to preciceV3

6b3fc1d

Cleanup.

25ecec2

Apply suggestions from code review

cb98ff9

Co-authored-by: Ishaan Desai <[email protected]>

Fix formatting issues.

b492c18

* Change ANSYS to Ansys * Change FLUENT to Fluent * Use ticks to indicate code

Use consistent names for identifying data and meshes.

e0d9da3

Revert some removals and properly migrate.

d8fa95c

Migrate missing calls in CSMdummy.

9c6b756

Formatting and minor fixes.

ed440e3

Minor formatting.

7cd8963

Update instructions on makefile

aa50d64

Update README.md

55187c7

adapter version 3 upgrade

ae4e136

BenjaminRodenberg self-requested a review April 22, 2025 06:35

BenjaminRodenberg suggested changes Apr 22, 2025

View reviewed changes

BenjaminRodenberg changed the base branch from update-v3 to develop April 22, 2025 08:43

BenjaminRodenberg added the compatibility label Apr 22, 2025

BenjaminRodenberg mentioned this pull request Apr 22, 2025

Update adapter to preCICE v3 #33

Closed

BenjaminRodenberg reviewed Apr 22, 2025

View reviewed changes

KhalilHkiri and others added 4 commits April 22, 2025 21:13

removed libudf, update the readme and adjusted the fsi to minimize th…

0eaa7fe

…e diff

Fix whitespace.

4b63329

Fix comments.

027be49

Fix whitespace.

8e20727

BenjaminRodenberg approved these changes Apr 23, 2025

View reviewed changes

Comment thread README.md Outdated

Comment thread README.md Outdated

Comment thread src/fsi.c Outdated

BenjaminRodenberg added 3 commits April 23, 2025 11:15

Apply suggestions from code review

c814e6b

Update src/fsi.c

5c7df47

Add entry in development history.

c2b4dac

BenjaminRodenberg changed the title ~~adapter version 3 upgrade~~ Upgrade adapter to preCICE version 3 API Apr 23, 2025

BenjaminRodenberg merged commit 636bc34 into precice:develop Apr 23, 2025



		dim = interface.get_mesh_dimensions(mesh_name)
		print("Mesh dimensions:", dim)

	print("mesh_id sent to set_mesh_vertices = {}".format(mesh_name))
	print("mesh_name sent to set_mesh_vertices = {}".format(mesh_name))

		forces = interface.read_data(mesh_name, force_name, vertexIDs, dt)
		forces = interface.read_data("beam", "Forces", vertexIDs, dt)

		interface.write_data(mesh_name, displ_name, vertexIDs, displacements)
		interface.write_data("beam", "Displacements", vertexIDs, displacements)

	FLUENT_INC= /lrz/sys/applications/ansys/v241/fluent
	FLUENT_INC= /path/to/fluent # TODO has to be provided by user

		<relative-convergence-measure limit="1e-6" data="Displacements" mesh="beam"/>
		<relative-convergence-measure limit="1e-6" data="Forces" mesh="beam"/>

	<m2n:sockets acceptor="Fluent" connector="CSMdummy" exchange-directory=".."/>
	<m2n:sockets acceptor="Fluent" connector="CSMdummy"/>

Uh oh!

Conversation

KhalilHkiri commented Apr 18, 2025

Uh oh!

BenjaminRodenberg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BenjaminRodenberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants