SimVascular / SimVascular/svZeroDSolver

The external_coupling_block error does not show the invalid type

Open
#209 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
C++
Stars
22
Forks
44
PR merge metrics
No merged PRs in 30d

Description

Description

A user is trying to run an svMultiPhysics simulation using the svZeroDSolver. The JSON file used for the coupling has a misspelled bc_type which causes the simulation to fail with

ibc++abi: terminating due to uncaught exception of type std::runtime_error: Error: The specified connection type for inlet external_coupling_block is invalid.

This error message does not show what the

  1. invalid connection type is
  2. valid connection types are

Note that with an informative error message the user could have identified the problem and fixed it rather than posting to the SV Forum for help.

Reproduction

Run a simulation with a misspelled bc_type parameter.

Expected behavior

The error should contain information that would help the user to find and fix the error.

Additional context

There is no documentation that I can see describing what the valid BC types are.

Code of Conduct
  • I agree to follow this project's Code of Conduct and Contributing Guidelines

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the failure by running an svMultiPhysics simulation with a misspelled bc_type in the coupling JSON. Start by tracing the external_coupling_block error handling in svZeroDSolver; the work is done when the error identifies the invalid connection type and lists the valid connection types.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.