SimVascular / SimVascular/svMultiPhysics

Add units to simulation results files

Open
#629 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C++
Stars
45
Forks
60
Avg merge
5d 23h
Merged PRs (30d)
11

Description

Problem

I'm working on adding simulation result visualization to 3D Slicer and what I am missing is a way to reliably determine the unit system (cgs, mm-g-s, mm-kg-s, ...), units of each quantity (e.g., speed: cm/s or length/time), and other metadata (such as anatomical coordinate system convention - LPS or RAS). Units are not only for labeling but for data transformation: we need to convert mesh point coordinates and all quantities to mm based unit system, as mm is used for all clinical imaging.

Currently, we need to manually specify coordinate system and unit system and use some heuristics based on array names to figure out how to scale them, but it is quite fragile. Could you add field data arrays to specify these information?

Solution

Save unit system, units for each point/cell array, and additional metadata (such as anatomical coordinate system) in the output mesh.

Additional context

It would be nice if this could become a commonly used standard across different solvers.

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

The issue names no files, tests, or entry points. Start by locating where output meshes and field-data arrays are written, then inspect how simulation result files represent point and cell quantities. Done means the output includes the unit system, units for each array, and additional metadata such as anatomical coordinate conventions.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
hpc
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.