Merge pull request #138 from KVSlab/add-comments

Add comments for post-processing
KVSlab · Dec 12, 2023 · 14a45a8 · 14a45a8
2 parents b8731fa + 025dcb9
commit 14a45a8
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/src/vampy/automatedPostprocessing/compute_flow_and_simulation_metrics.py b/src/vampy/automatedPostprocessing/compute_flow_and_simulation_metrics.py
@@ -19,7 +19,7 @@ def compute_flow_and_simulation_metrics(folder, nu, dt, velocity_degree, T, time
         nu (float): The kinematic viscosity value.
         dt (float): The time step size.
         velocity_degree (int): The degree of the velocity function space.
-        T (float): The total simulation time.
+        T (float): Length of one cardiac cycle, in [ms]
         times_to_average (list): A list of time points to perform phase averaging. Needs to be in the inverval [0,T).
         save_frequency (int): The frequency of saving data during the simulation.
         start_cycle (int): The starting cycle number for averaging.

diff --git a/src/vampy/automatedPostprocessing/compute_hemodynamic_indices.py b/src/vampy/automatedPostprocessing/compute_hemodynamic_indices.py
@@ -32,7 +32,7 @@ def compute_hemodynamic_indices(folder, nu, rho, dt, T, velocity_degree, save_fr
         nu (float): Kinematic viscosity
         rho (float): Fluid density
         dt (float): Time step of simulation
-        T (float): One cardiac cycle, in [ms]
+        T (float): Length of one cardiac cycle, in [ms]
         save_frequency (int): Frequency that velocity has been stored
         start_cycle (int): Determines which cardiac cycle to start from for post-processing
         step (int): Step size determining number of times data is sampled

diff --git a/src/vampy/automatedPostprocessing/postprocessing_common.py b/src/vampy/automatedPostprocessing/postprocessing_common.py
@@ -142,7 +142,12 @@ def rate_of_dissipation(dissipation, u, v, mesh, h, nu):
 
 
 class STRESS:
-    """Computes the stress on a given mesh based on provided velocity and pressure fields."""
+    """
+    Computes the stress on a given mesh based on provided velocity and pressure fields.
+    Note that the pressure term is unused since it disappears in the process of extracting the tangential component.
+
+    FIXME: Currently works for P1P1, but not for higher order finite elements (e.g. P2P1)
+    """
 
     def __init__(self, u, p, nu, mesh):
         """Initializes the StressComputer.