MOOSE FMU interface development #30912

MengnanLi91 · 2025-06-30T18:58:47Z

Reason

This PR will develop a MOOSE FMU interface

Design

The current MOOSE FMU interface will leverage web server control capability to communicate with MOOSE simulation. It requires a running MOOSE simulation on side.

Impact

This will be the first step to pack MOOSE as a FMU and integrates with other FMUs for co-simulation

MengnanLi91 · 2025-09-17T20:31:59Z

@zachmprince @maythuwin1313 @loganharbour

…iffision.i

Clean up interface and add test

Add testing examples in documentation Add unit test

Update tests Add more unit tests

Add moose fmu tester Fix unicode character errors

Python unit tests need to use platform and do not have capabilities available

moosebuild · 2025-10-08T15:51:01Z

Job Precheck, step Versioner verify on afb834d wanted to post the following:

Versioner templates

Found 14 templates, 0 failed

Versioner influential files

Found 58 influential files, 3 changed, 0 added, 0 removed

package	status	file
tools	CHANGE	conda/tools/meta.yaml
moose-dev	CHANGE	conda/moose-dev/conda_build_config.yaml
moose-dev	CHANGE	conda/moose-dev/meta.yaml

Versioner versions

Found 9 packages, 2 changed, 0 failed

package	status	hash	to hash	version	to version
tools	CHANGE	d73012a	a6ed2b3	2025.06.26	2025.10.07
moose-dev	CHANGE	32e04eb	4dbab7a	2025.09.18	2025.10.07

loganharbour

Can we sit together tomorrow briefly for you to show me an example with this? Would help with the review quite a bit

MengnanLi91 · 2025-10-16T11:26:56Z

Can we sit together tomorrow briefly for you to show me an example with this? Would help with the review quite a bit

Of course! Let's do that

GiudGiud · 2025-10-29T06:05:54Z

framework/doc/content/source/controls/MOOSEFMU.md

@@ -0,0 +1,145 @@
+# MOOSE FMU Interface
+
+The `MOOSEFMU` defines the `Moose2FMU` base class which contains the boilerplate needed to wrap a MOOSE simulation as a Functional Mock-up Unit (FMU). Users only need to implement their own `__init__` and `do_step` methods when deriving from `Moose2FMU`.


Suggested change

The `MOOSEFMU` defines the `Moose2FMU` base class which contains the boilerplate needed to wrap a MOOSE simulation as a Functional Mock-up Unit (FMU). Users only need to implement their own `__init__` and `do_step` methods when deriving from `Moose2FMU`.

The `MOOSEFMU` defines the `Moose2FMU` Python base class which contains the boilerplate needed to wrap a MOOSE simulation as a Functional Mock-up Unit (FMU). Users only need to implement their own `__init__` and `do_step` methods when deriving from `Moose2FMU`.

GiudGiud · 2025-10-29T06:06:47Z

framework/doc/content/source/controls/MOOSEFMU.md

+`Moose2FMU` accepts a number of keyword arguments that configure how the
+underlying MOOSE simulation is launched and interacted with:
+
+- `flag`: Optional flag that is forwarded to the MOOSE input deck.


how to pass multiple?
-flag a -flag b ? or -flag a b ?

is the rules for spaces same as for CLI args?

is the rules for spaces same as for CLI args?

Yes, this is just pass CLI args to MOOSE control. I can add an example here to show it. I keep all the examples in moose_fmu folder. I can refer that here

GiudGiud · 2025-10-29T06:08:16Z

framework/doc/content/source/controls/MOOSEFMU.md

+`Moose2FMU` provides a small collection of convenience methods that simplify
+interacting with a running MOOSE simulation:
+
+- `set_controllable_real` and `set_controllable_vector` push new controllable


vectors are controllable now?

In MOOSE web server control, controllable_vector is supported so I just include the option here. Not quiet sure if controllable vector actually used anywhere in the code. Maybe under stochastic tools? Here I just provide APIs we have in MOOSE web server control

we should check, let's get a test

GiudGiud · 2025-10-29T06:09:44Z

framework/doc/content/source/controls/MOOSEFMU.md

+`get_postprocessor_value` also accept per-call `flag` arguments. Passing custom
+flags in these locations allows FMUs to react to user-defined synchronization
+points while still benefiting from the built-in defaults. Refer to
+[SetupInterface.md]for additional details on


Suggested change

[SetupInterface.md]for additional details on

[SetupInterface.md] for additional details on

GiudGiud · 2025-10-29T06:10:01Z

framework/doc/content/source/controls/MOOSEFMU.md

+MOOSE execute flags.
+
+### Creating a Custom FMU
+


is there a script you could use a listing from instead?

GiudGiud · 2025-10-29T06:10:41Z

framework/doc/content/source/controls/MOOSEFMU.md

+
+Save the custom class in a Python file and use [`pythonfmu`](https://github.com/NTNU-IHB/PythonFMU) to build the FMU:
+
+```bash


so we dont include this package in our conda distrib? not through fmpy?

We include pythonfmu in conda, but to build a MOOSE fmu customized fmu input, output, you still use pythonfmu build command to do that. We don't need to install pythonfmu package every time we want to build fmu

I dont see a pythonfmu new package in conda?
Does it come with fmpy?

GiudGiud · 2025-10-29T06:11:07Z

framework/doc/content/source/controls/MOOSEFMU.md

+pythonfmu build custom_moose.py
+```
+
+The resulting `.fmu` file can then be imported into any compliant co-simulation environment.


Suggested change

The resulting `.fmu` file can then be imported into any compliant co-simulation environment.

The resulting `.fmu` file can then be imported into any standard-compliant co-simulation environment.

GiudGiud · 2025-10-29T06:11:34Z

framework/doc/content/source/controls/MOOSEFMU.md

@@ -0,0 +1,145 @@
+# MOOSE FMU Interface
+
+The `MOOSEFMU` defines the `Moose2FMU` base class which contains the boilerplate needed to wrap a MOOSE simulation as a Functional Mock-up Unit (FMU). Users only need to implement their own `__init__` and `do_step` methods when deriving from `Moose2FMU`.


what standard did you implement for FMU ? 2? 3? do we have the whole standard implemented or partiaL?

We support FMU 2 standard. The whole standard is implemented by pythonFMU and we use that to build MOOSE FMU

GiudGiud · 2025-10-29T06:12:50Z

framework/doc/content/source/controls/MOOSEFMU.md

+!syntax parameters /Controls/MOOSEFMU
+
+!syntax inputs /Controls/MOOSEFMU
+


I dont see a MOOSEFMU class registered? this shouldt work, what am I missing

Good catch, I'll fix it

scripts/convert_to_capabilities.py

GiudGiud

looks great. This is well organized and understandable at a good level

I think the next thing we need is a tutorial on MOOSE-FMU showing:

building the FMU
running it from python
controlling its stepping
controlling its inputs
plotting its outputs
coupling it to another FMU
which basically matches the tests you created!

GiudGiud · 2025-11-05T03:42:10Z

framework/doc/content/source/controls/MOOSEFMU.md

+`Moose2FMU` provides a small collection of convenience methods that simplify
+interacting with a running MOOSE simulation:
+
+- `set_controllable_real` and `set_controllable_vector` push new controllable


we should check, let's get a test

GiudGiud · 2025-11-05T16:24:17Z

python/MooseFMU/test/test_fmu_utils.py

+        fmu_utils.set_string(fmu, vr_map, "mode", "active")
+        fmu_utils.set_bool(fmu, vr_map, "enabled", False)
+
+        self.assertEqual(fmu.calls["getReal"], [(1,)])


add a comment for these 3, what is this checking? the call log?

GiudGiud · 2025-11-05T16:25:52Z

python/MooseFMU/test/test_fmu_utils.py

+        fmu = _DummyFmu()
+        vr_map = {"temperature": 1, "mode": 2, "enabled": 3}
+
+        self.assertEqual(fmu_utils.get_real(fmu, vr_map, "temperature"), 12.5)


so you always need to give the vr_map to a get_something call? that seems inefficient

I would imagine fmu.getReal("temperature") would be enough information ?

GiudGiud · 2025-11-05T16:43:59Z

framework/doc/content/source/controls/MOOSEFMU.md

+
+Save the custom class in a Python file and use [`pythonfmu`](https://github.com/NTNU-IHB/PythonFMU) to build the FMU:
+
+```bash


I dont see a pythonfmu new package in conda?
Does it come with fmpy?

GiudGiud · 2025-11-05T16:44:29Z

python/MooseFMU/MOOSE2FMU.py

@@ -0,0 +1,601 @@
+from pythonfmu import Fmi2Slave


we need the copyright header everywhere in the python files

#* This file is part of the MOOSE framework #* https://mooseframework.inl.gov #* #* All rights reserved, see COPYRIGHT for full restrictions #* https://github.com/idaholab/moose/blob/master/COPYRIGHT #* #* Licensed under LGPL 2.1, please see LICENSE for details #* https://www.gnu.org/licenses/lgpl-2.1.html

GiudGiud · 2025-11-05T17:30:52Z

test/tests/controls/moose_fmu/run_fmu.py

+  (a) rebuild the FMU with the desired dt with DefaultExperiment, or
+  (b) drive the FMU step-by-step (manual do_step loop) instead of simulate_fmu.
+
+- simulate_fmu integrates *up to* stop_time but does not necessarily perform a


so this is an issue with fmpy?

I would not expect a do_step at the stop time?

GiudGiud · 2025-11-05T17:33:08Z

test/tests/controls/moose_fmu/MooseTime.fmu

do we have to store this or can we generate it in the test suite using a RunCommand?

GiudGiud · 2025-11-05T17:34:13Z

test/tests/controls/moose_fmu/MooseTime.py

what test is using this file?

GiudGiud · 2025-11-05T17:43:19Z

test/tests/controls/moose_fmu/moose_fmu_tester.py

+
+    df = pd.DataFrame(result)
+
+    df.to_csv("run_fmu.csv", index=False)


ok I see how this handled to create a CSV

GiudGiud · 2025-11-05T17:46:39Z

test/tests/controls/moose_fmu/MooseTest.py

copyright on all these files

MengnanLi91 self-assigned this Jun 30, 2025

MengnanLi91 force-pushed the MOOSE_FMI branch 2 times, most recently from d106c24 to 1e2adbe Compare June 30, 2025 19:58

MengnanLi91 requested a review from loganharbour September 11, 2025 20:08

MengnanLi91 force-pushed the MOOSE_FMI branch from 211f66d to a40cada Compare September 15, 2025 17:59

MengnanLi91 force-pushed the MOOSE_FMI branch from afb3c10 to f20ccbb Compare September 25, 2025 16:48

MengnanLi91 added a commit to MengnanLi91/moose that referenced this pull request Oct 6, 2025

Initial commit for MOOSE_fmu idaholab#30912

01ec6f0

MengnanLi91 force-pushed the MOOSE_FMI branch 3 times, most recently from 42a1b26 to 2b49506 Compare October 7, 2025 15:24

MengnanLi91 added a commit to MengnanLi91/moose that referenced this pull request Oct 7, 2025

Initial commit for MOOSE_fmu idaholab#30912

ee0146f

MengnanLi91 added 18 commits October 8, 2025 09:16

Initial commit for MOOSE_fmu idaholab#30912

bc92ab5

Successfully build moose_fmu with web server control, test with fmu_d…

bc50c46

…iffision.i

Two FMUs coupled test case working

648aa13

Clean up, add logger

8db6700

Clean up interface and add test

Add documentation, test case and tests

361b2f6

Add testing examples in documentation Add unit test

Add mooseFMU interface, tests and gold files

7392e33

Leverage the new getTime() from MooseControl

75ea062

Add multiple flag support, use getTime()

dd21cdf

Add more APIs in MOOSE2FMU base class, update MooseTest run

f7c198b

Function renaming, add getReporter function

f251691

Update tests Add more unit tests

Use unittest instead of pytest, test case working

4549e6e

FMU start and stop time

5857503

moose_sync and test case improvement

d0bccfe

Add more documentation and use CSVDiff for test

ef99198

Refactor moose fmu test

f88136a

Improve tests and logging

b342f1f

Update unit tests for new feature, accelarate fmu connection test

22df305

Add moose fmu tester Fix unicode character errors

Add fmpy to moose-tools

d1b0d77

MengnanLi91 added 2 commits October 8, 2025 09:26

Don't check for platform in capabilities conversion

18bf06a

Python unit tests need to use platform and do not have capabilities available

Rename getTimeStepSize to getDT in MOOSE2FMU

afb834d

MengnanLi91 force-pushed the MOOSE_FMI branch from f00f68b to afb834d Compare October 8, 2025 15:42

MengnanLi91 marked this pull request as ready for review October 8, 2025 15:43

MengnanLi91 requested review from cticenhour and lindsayad as code owners October 8, 2025 15:43

lindsayad assigned loganharbour Oct 10, 2025

loganharbour reviewed Oct 16, 2025

View reviewed changes

GiudGiud reviewed Oct 29, 2025

View reviewed changes

GiudGiud reviewed Nov 5, 2025

View reviewed changes

		@@ -0,0 +1,145 @@
		# MOOSE FMU Interface

		The `MOOSEFMU` defines the `Moose2FMU` base class which contains the boilerplate needed to wrap a MOOSE simulation as a Functional Mock-up Unit (FMU). Users only need to implement their own `__init__` and `do_step` methods when deriving from `Moose2FMU`.

	The `MOOSEFMU` defines the `Moose2FMU` base class which contains the boilerplate needed to wrap a MOOSE simulation as a Functional Mock-up Unit (FMU). Users only need to implement their own `__init__` and `do_step` methods when deriving from `Moose2FMU`.
	The `MOOSEFMU` defines the `Moose2FMU` Python base class which contains the boilerplate needed to wrap a MOOSE simulation as a Functional Mock-up Unit (FMU). Users only need to implement their own `__init__` and `do_step` methods when deriving from `Moose2FMU`.

	[SetupInterface.md]for additional details on
	[SetupInterface.md] for additional details on


		Save the custom class in a Python file and use [`pythonfmu`](https://github.com/NTNU-IHB/PythonFMU) to build the FMU:

		```bash

	The resulting `.fmu` file can then be imported into any compliant co-simulation environment.
	The resulting `.fmu` file can then be imported into any standard-compliant co-simulation environment.

		!syntax parameters /Controls/MOOSEFMU

		!syntax inputs /Controls/MOOSEFMU


		df = pd.DataFrame(result)

		df.to_csv("run_fmu.csv", index=False)

MOOSE FMU interface development #30912

Are you sure you want to change the base?

MOOSE FMU interface development #30912

Uh oh!

Conversation

MengnanLi91 commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reason

Design

Impact

Uh oh!

MengnanLi91 commented Sep 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

moosebuild commented Oct 8, 2025

Versioner templates

Versioner influential files

Versioner versions

Uh oh!

loganharbour left a comment

Choose a reason for hiding this comment

Uh oh!

MengnanLi91 commented Oct 16, 2025

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!

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!

Uh oh!

GiudGiud 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!

MengnanLi91 commented Jun 30, 2025 •

edited

Loading

MengnanLi91 commented Sep 17, 2025 •

edited

Loading