Add 3D-1D coupling interface APIs by taeoukkim · Pull Request #131 · SimVascular/svOneDSolver

taeoukkim · 2026-06-04T22:53:53Z

Current situation

resolves #129

Release Notes

Update 1D solver for 3D-1D coupling.
Functions are stored in "interface.cpp" file.
Main functions are: initialize_1d, set_external_step_size_1d, return_1d_solution, update_1d_solution, run_1d_simulation_step_1d, and extract_coupled_dof.
Now, when you compile the code, it will create a shared library for coupling at ".../svOneDSolver/build/lib/libsvoned_interface.dylib"
The API functions can be accessed through this shared library.

Documentation

I will update document.

Testing

3D-1D testing done

Code of Conduct & Contributing Guidelines

I agree to follow the Code of Conduct and Contributing Guidelines.

ktbolt · 2026-07-15T20:51:48Z

@taeoukkim This PR does not build on MacOS.

svOneDSolver/Code/Source/cvOneDOptions.h:128:10: error: no template named 'optional' in namespace 'std'
    std::optional<int> vtkOutputType = std::nullopt; 
    ~~~~~^

This is a CMake issue I think; I'll have a look.

ktbolt · 2026-07-15T23:04:26Z

@taeoukkim The compiler used to build svOneDSolver/Code/Source/interface/interface.cpp was set to c++17.

I added

set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED True)

after the PROJECT CMake command and now everything compiles ok.

ktbolt

@taeoukkim You've done a great job here adding an interface to an old and confusing code !

A couple of important things to clean up

Only use print statements for debugging; they should not be active for release
Use a consistent error handing; really everything should use cvException I'm guessing; writing to cerr is not very useful should throw I think

svOneDSolver writes out lots of .dat files and prints a simulation history to stdout I think. How is this managed for the 3D interface ?

taeoukkim · 2026-07-22T19:31:12Z

@taeoukkim The compiler used to build svOneDSolver/Code/Source/interface/interface.cpp was set to c++17.

I added
set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED True)
after the PROJECT CMake command and now everything compiles ok.

Thank you for identifying the issue and suggesting the fix!! I added the C++20 settings to the top-level CMakeLists.txt and confirmed that the interface library builds successfully on my Mac.

taeoukkim · 2026-07-22T23:28:56Z

@ktbolt Thank you very much for the thorough review and helpful suggestions. I have addressed all of the comments. I also clarified that accepted coupled solutions are written to VTK and text files at the requested output interval. Both the standalone OneDSolver and svoned_interface build successfully on macOS, and I confirmed that the standalone solver still runs correctly.

ktbolt

@taeoukkim Fine work here, nice clean up !

Please add any necessary comments to the non-API functions in interface.cpp.

I want to confirm that if the 1D solver fails then the failure is reported by the 3D solver.

ktbolt · 2026-07-24T20:02:52Z

+#else
+#define SVONED_DEBUG_LOG(message) \
+  do { } while (false)
+#endif


@taeoukkim Why the do statements ?

ktbolt · 2026-07-24T20:15:55Z

-  if(argc == 2) {
-    string inputFile{removeQuotesIfPresent(argv[1])};
-    return readLegacyOptions(inputFile);
+    if (errorCode == CV_ERROR) {


@taeoukkim It is not good to cast away a const qualifier; better to change the signature of CreateNode.

CreateNode always returns CV_OK.

ktbolt · 2026-07-24T20:20:42Z

+  for (int jointIndex = 0; jointIndex < totalJoints; ++jointIndex) {
+    const std::string& inletName = opts.jointInletName[jointIndex];
+    const std::string& outletName = opts.jointOutletName[jointIndex];
+


@taeoukkim You can use const auto& inletName = opts.jointInletName[jointIndex];

ktbolt · 2026-07-24T20:26:46Z

+
+    const int totalInlets = opts.jointInletListNumber[inletID];
+    const int totalOutlets = opts.jointOutletListNumber[outletID];
+


@taeoukkim All of this use of const just really adds noise in my opinion but maybe this is your style; no problem with that.

You can also use auto errMsg = ERROR: Cannot Find JOINTOUTLET for key " + outletName;

ktbolt · 2026-07-24T20:50:39Z

+    for (int i = 0; i < totalInlets; ++i) {
+      inletSegments.push_back(opts.jointInletList[inletID][i]);
+    }
+


@taeoukkim You can replace all this (111-115) with

std::vector<int> inletSegments(opts.jointInletList[inletID].begin(), opts.jointInletList[inletID].end());

ktbolt · 2026-07-24T21:37:20Z

+    cvOneDGlobal::outputType = OutputTypeScope::OUTPUT_BOTH;
+  } else {
+    throw cvException("ERROR: Invalid OUTPUT Type.\n");
+  }


@taeoukkim Include in the exception message what the invalid type was.

ktbolt · 2026-07-24T21:39:55Z

+
+    if (cvOneDGlobal::vtkOutputType > 1) {
+      throw cvException("ERROR: Invalid OUTPUT VTK Type.\n");
+    }


@taeoukkim What does it mean to have cvOneDGlobal::vtkOutputType > 1 ?

ktbolt · 2026-07-24T22:02:17Z

+}
+
+int getDataTableIDFromStringKey(std::string key) {
+  std::size_t count = 0;


@taeoukkim Use const std::string& key

ktbolt · 2026-07-24T22:04:20Z

+        upper_string(cvOneDGlobal::gDataTables[count]->getName())) {
+      return static_cast<int>(count);
+    }
+


@taeoukkim Maybe cleaner to use a for loop or iterators; while loops are typically not used for a known range.

auto ukey = upper_string(key); for (auto& entry : cvOneDGlobal::gDataTables) { if (ukey == upper_string(entry->getName())) { return count; } count += 1; }

ktbolt · 2026-07-24T23:22:51Z

+  if (str.size() >= 2 && str.front() == '"' && str.back() == '"') {
+    return str.substr(1, str.size() - 2);
+  }
+


@taeoukkim It would be perhaps cleaner to use

auto mstr = str; mstr.erase(std::remove(mstr.begin(), mstr.end(), '"'), mstr.end()); return mstr;

Add 3D-1D coupling interface APIs

3daa1d4

taeoukkim requested a review from Copilot July 14, 2026 21:56

Copilot started reviewing on behalf of taeoukkim July 14, 2026 21:56 View session

taeoukkim requested review from ktbolt and mrp089 and removed request for Copilot July 14, 2026 22:00

ktbolt reviewed Jul 16, 2026

View reviewed changes

taeoukkim added 2 commits July 22, 2026 16:32

Address review comments for 3D-1D interface

b83eb27

Fix macOS version detection for installer builds

1153c80

ktbolt requested changes Jul 24, 2026

View reviewed changes


		const int totalInlets = opts.jointInletListNumber[inletID];
		const int totalOutlets = opts.jointOutletListNumber[outletID];

Uh oh!

Conversation

taeoukkim commented Jun 4, 2026

Current situation

Release Notes

Documentation

Testing

Code of Conduct & Contributing Guidelines

Uh oh!

ktbolt commented Jul 15, 2026

Uh oh!

ktbolt commented Jul 15, 2026

Uh oh!

ktbolt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

taeoukkim commented Jul 22, 2026

Uh oh!

taeoukkim commented Jul 22, 2026

Uh oh!

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

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants