add progressbar, add an example

Author: Dengda98

.gitignore

@@ -6,4 +6,4 @@
 
 /pyfmm/__pycache__
 /pyfmm/C_extension/build
-/aaa
+/test_w

docs/source/examples/05_uniform_source_refined.ipynb

@@ -18,3 +18,4 @@ Jupyter 使用示例
    examples/02_random_model
    examples/03_spherical
    examples/04_distance
+   examples/05_uniform_source_refined

docs/source/jupyter_examples.rst

@@ -33,6 +33,7 @@
  * @param     sphcoord  (in)是否使用球坐标
  * @param     rfgfac    (in)对于源点附近的格点间加密倍数，>1
  * @param     rfgn      (in)对于源点附近的格点间加密处理的辐射半径，>=1
+ * @param     printbar  (in)是否打印进度条
  * 
  * 
  */
@@ -43,7 +44,7 @@ void FastMarching(
     double rr,  double tt, double pp,
     int maxodr,  const float *Slw, 
     float *TT, bool sphcoord, 
-    int rfgfac, int rfgn);
+    int rfgfac, int rfgn, bool printbar);
 
 
 /**
@@ -61,6 +62,7 @@ void FastMarching(
  * @param     FMM_stat  (out)记录每个节点的状态(alive, close, far)
  * @param     sphcoord  (in)是否使用球坐标
  * @param     edgeStop  (in)是否在波前传播到6个边界面时提前结束计算
+ * @param     printbar  (in)是否打印进度条
  * @param     FMM_data  (inout)堆首指针
  * @param     psize     (inout)堆大小，会被调整大小
  * @param     pcap      (inout)堆最大容量，视情况会被调整大小
@@ -73,7 +75,7 @@ HEAP_DATA * FastMarching_with_initial(
     const double *ts, int nt, 
     const double *ps, int np,
     int maxodr,  const float *Slw, float *TT, 
-    char *FMM_stat, bool sphcoord, bool *edgeStop,
+    char *FMM_stat, bool sphcoord, bool *edgeStop, bool printbar,
     HEAP_DATA *FMM_data, int *psize, int *pcap, int *NroIdx, int *pNdots);
 
 
@@ -133,6 +135,7 @@ HEAP_DATA * init_source_TT(
  * @param     sphcoord  (in)是否使用球坐标
  * @param     rfgfac    (in)对于源点附近的格点间加密倍数，>1
  * @param     rfgn      (in)对于源点附近的格点间加密处理的辐射半径，>=1
+ * @param     printbar  (in)是否打印进度条
  * @param     FMM_data  (inout)堆首指针
  * @param     psize     (inout)堆大小，会被调整大小
  * @param     pcap      (inout)堆最大容量，视情况会被调整大小
@@ -149,6 +152,7 @@ HEAP_DATA * init_source_TT_refinegrid(
     int maxodr,  const float *Slw, float *TT, 
     char *FMM_stat, bool sphcoord,
     int rfgfac, int rfgn, // refine grid factor and number of grids
+    bool printbar,
     HEAP_DATA *FMM_data, int *psize, int *pcap, int *NroIdx, int *pNdots);
 
 

pyfmm/C_extension/include/fmm.h

@@ -0,0 +1,23 @@
+/**
+ * @file   progressbar.h
+ * @author Zhu Dengda ([email protected])
+ * @date   2024-07
+ * 
+ * 以下代码实现进度条的输出
+ * 
+ */
+
+
+/**
+ * 定义进度条的长度
+ */
+#define _PROGRESSBAR_WIDTH_ 45
+
+
+/**
+ * 根据百分比打印进度条  
+ * 
+ * @param    prefix     (in)进度条前缀字符串
+ * @param    percentage (in)百分比(整数)
+ */
+void printprogressBar(const char *prefix, int percentage);

pyfmm/C_extension/include/progressbar.h

@@ -12,6 +12,8 @@
 #include <assert.h>
 #include <stddef.h>
 #include <unistd.h>
+#include <sys/time.h>
+
 
 #include "interp.h"
 #include "query.h"
@@ -20,6 +22,7 @@
 #include "diff.h"
 #include "heapsort.h"
 #include "index.h"
+#include "progressbar.h"
 #include "fmm.h"
 
 
@@ -31,8 +34,12 @@ void FastMarching(
     double rr,  double tt, double pp,
     int maxodr,  const float *Slw, 
     float *TT, bool sphcoord, 
-    int rfgfac, int rfgn)
+    int rfgfac, int rfgn, bool printbar)
 {
+    // 程序运行开始时间
+    struct timeval begin_t;
+    gettimeofday(&begin_t, NULL);
+
     int ntp=nt*np;
     int nrtp=nr*ntp;
     int Ndots=nrtp;
@@ -71,7 +78,7 @@ void FastMarching(
                 rr, tt, pp,
                 maxodr, Slw, TT, 
                 FMM_stat, sphcoord,
-                rfgfac, rfgn,
+                rfgfac, rfgn, printbar,
                 FMM_data, psize, pcap, NroIdx, &Ndots);
         } else {
             FMM_data = init_source_TT(
@@ -90,13 +97,20 @@ void FastMarching(
         ts, nt, 
         ps, np,
         maxodr, Slw, TT,
-        FMM_stat, sphcoord, NULL,
+        FMM_stat, sphcoord, NULL, printbar,
         FMM_data, psize, pcap, NroIdx, &Ndots);
 
     // printf("done, Ndots=%d, size=%d\n", Ndots, *psize);
     free(FMM_data);
     free(FMM_stat);
     free(NroIdx);
+
+
+    // 程序运行结束时间
+    struct timeval end_t;
+    gettimeofday(&end_t, NULL);
+    if(printbar) printf("Runtime: %.3f s\n", (end_t.tv_sec - begin_t.tv_sec) + (end_t.tv_usec - begin_t.tv_usec) / 1e6);
+    fflush(stdout);
 }
 
 
@@ -107,7 +121,7 @@ HEAP_DATA * FastMarching_with_initial(
     const double *ts, int nt, 
     const double *ps, int np,
     int maxodr,  const float *Slw, float *TT, 
-    char *FMM_stat, bool sphcoord, bool *edgeStop, 
+    char *FMM_stat, bool sphcoord, bool *edgeStop, bool printbar,
     HEAP_DATA *FMM_data, int *psize, int *pcap, int *NroIdx, int *pNdots)
 {
     double dr = (nr>1)? rs[1] - rs[0] : 0.0;
@@ -141,6 +155,10 @@ HEAP_DATA * FastMarching_with_initial(
     float *pt;
     char *pstat;
 
+    // 打印进度条时每隔print_interv打印一次
+    int size_bak = nr*ntp;
+    int last_barpercent = 0, barpercent;
+
     // printf("loop start, size=%d\n", *psize );
     char travt_stat;
     float maxtravt=-999;
@@ -247,14 +265,22 @@ HEAP_DATA * FastMarching_with_initial(
                     newdata= idx;
                     FMM_data = HeapPush(FMM_data, psize, pcap, newdata, NroIdx, TT);
                     *pstat = FMM_CLS;
-                    (pNdots)--;
+                    (*pNdots)--;
                 }
 
             }
             // print_FMM_HEAP(FMM_data, *psize, nr, nt, np, NroIdx, TT, gTr, gTt, gTp);
 
         } 
 
+
+        // 打印进度条 
+        barpercent = 100 - (*pNdots*100) / size_bak;
+        if(printbar && barpercent != last_barpercent){
+            printprogressBar("Fast Marching...  ", barpercent);
+            last_barpercent = barpercent;
+        }
+
     }
 
 
@@ -436,6 +462,7 @@ HEAP_DATA * init_source_TT_refinegrid(
     int maxodr,  const float *Slw, float *TT, 
     char *FMM_stat, bool sphcoord,
     int rfgfac, int rfgn, // refine grid factor and number of grids
+    bool printbar,
     HEAP_DATA *FMM_data, int *psize, int *pcap, int *NroIdx, int *pNdots)
 {   
     double dr = (nr>1)? rs[1] - rs[0] : 0.0;
@@ -546,7 +573,7 @@ HEAP_DATA * init_source_TT_refinegrid(
         rfg_ts, rfg_nt, 
         rfg_ps, rfg_np,
         maxodr, rfg_Slw, rfg_TT,
-        rfg_FMM_stat, sphcoord, edgeStop, // break loop in advance
+        rfg_FMM_stat, sphcoord, edgeStop, printbar, // break loop in advance
         rfg_FMM_data, prfg_size, prfg_cap, rfg_NroIdx, &rfg_Ndots);
 
     // record result to main TT 

pyfmm/C_extension/lib/libfmm.so

@@ -0,0 +1,30 @@
+/**
+ * @file   progressbar.c
+ * @author Zhu Dengda ([email protected])
+ * @date   2024-07
+ * 
+ * 以下代码实现进度条的输出
+ * 
+ */
+
+#include <stdio.h>
+
+#include "progressbar.h"
+
+
+void printprogressBar(const char *prefix, int percentage) {
+    printf("\r\033[K"); // 移动到行首并清空行
+    if(prefix!=NULL) printf("%s", prefix);
+    printf("[");
+    int pos = _PROGRESSBAR_WIDTH_ * percentage / 100;
+    for (int i = 0; i < _PROGRESSBAR_WIDTH_; ++i) {
+        if (i < pos) printf("=");
+        else if (i == pos) printf(">");
+        else printf(" ");
+    }
+    printf("] %d %%", percentage); 
+    if(percentage==100){
+        printf("\n");
+    }
+    fflush(stdout);
+}

pyfmm/C_extension/src/fmm.c

@@ -36,7 +36,7 @@
     c_double, c_double, c_double, 
     c_int, PFLOAT,
     PFLOAT, c_bool,
-    c_int, c_int
+    c_int, c_int, c_bool
 ]
 
 

pyfmm/C_extension/src/progressbar.c

@@ -18,7 +18,7 @@
 def travel_time_source(
     srcloc:list, 
     xarr:np.ndarray, yarr:np.ndarray, zarr:np.ndarray, slw:np.ndarray,
-    maxodr:int=2, sphcoord:bool=False, rfgfac:int=0, rfgn:int=0):
+    maxodr:int=2, sphcoord:bool=False, rfgfac:int=0, rfgn:int=0, printbar:bool=False):
     r'''
         给定源点坐标，计算全局走时场
 
@@ -33,6 +33,7 @@ def travel_time_source(
         :param   sphcoord:    是否为球坐标系
         :param     rfgfac:    对于源点附近的格点间加密倍数，>1
         :param       rfgn:    对于源点附近的格点间加密处理的辐射半径，>=1
+        :param   printbar:    是否打印进度条
 
         :return:   三维走时场
     '''
@@ -67,7 +68,7 @@ def travel_time_source(
         xx, yy, zz,
         maxodr, c_slw, 
         c_TT, sphcoord,
-        rfgfac, rfgn
+        rfgfac, rfgn, printbar
     )
 
     return TT
@@ -77,7 +78,7 @@ def travel_time_source(
 def travel_time_iniTT(
     iniTT:np.ndarray,
     xarr:np.ndarray, yarr:np.ndarray, zarr:np.ndarray, slw:np.ndarray,
-    maxodr:int=2, sphcoord:bool=False):
+    maxodr:int=2, sphcoord:bool=False, printbar:bool=False):
     r'''
         给定走时场初始状态，计算全局走时场
 
@@ -90,6 +91,7 @@ def travel_time_iniTT(
         :param        slw:    形状为(nx, ny, nz)的三维慢度场
         :param     maxodr:    使用的最大差分阶数, 1 or 2 or 3
         :param   sphcoord:    是否为球坐标系
+        :param   printbar:    是否打印进度条 
 
         :return:   三维走时场
     '''
@@ -112,7 +114,7 @@ def travel_time_iniTT(
         0.0, 0.0, 0.0,
         maxodr, c_slw, 
         c_TT, sphcoord,
-        0, 0
+        0, 0, printbar
     )
 
     return TT_ravel.reshape(iniTT.shape)