Merge branch 'devel' into issue-384

PrincetonUniversity · Jan 15, 2025 · 1308e6f · 1308e6f
2 parents 8db43f2 + f22674a
commit 1308e6f
Show file tree

Hide file tree

Showing 9 changed files with 178 additions and 56 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -11,13 +11,13 @@ repos:
       - id: requirements-txt-fixer
       - id: trailing-whitespace
   - repo: https://github.com/pre-commit/mirrors-clang-format
-    rev: "v14.0.5"
+    rev: "v14.0.6"
     hooks:
       - id: clang-format
         types_or: [c++]
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.6.7
+    rev: v0.9.1
     hooks:
       # Run the linter.
       - id: ruff

diff --git a/docs/index.rst b/docs/index.rst
@@ -171,8 +171,8 @@ Table below shows various features available and tested in this package on vario
       -
 
 .. note::
-    While we work towards building this package and making the 
-    code/documentation more complete, please refer relevant SPECFEM package 
+    While we work towards building this package and making the
+    code/documentation more complete, please refer relevant SPECFEM package
     documentations for technical details on SPECFEM theory.
 
 .. raw:: html

diff --git a/fortran/.clang-format b/fortran/.clang-format
@@ -0,0 +1,5 @@
+# This is only used because .clang-format-ignore is not supported
+# by the current clang-format version and the newer versions are introducing
+# too many formatting updates...
+DisableFormat: true
+SortIncludes: Never  // with clang-format version < 13 use `false` here.
diff --git a/fortran/meshfem3d/meshfem3D/constants_meshfem3D.h b/fortran/meshfem3d/meshfem3D/constants_meshfem3D.h
@@ -1,3 +1,30 @@
+!=====================================================================
+!
+!                          S p e c f e m 3 D
+!                          -----------------
+!
+!     Main historical authors: Dimitri Komatitsch and Jeroen Tromp
+!                              CNRS, France
+!                       and Princeton University, USA
+!                 (there are currently many more authors!)
+!                           (c) October 2017
+!
+! This program is free software; you can redistribute it and/or modify
+! it under the terms of the GNU General Public License as published by
+! the Free Software Foundation; either version 3 of the License, or
+! (at your option) any later version.
+!
+! This program is distributed in the hope that it will be useful,
+! but WITHOUT ANY WARRANTY; without even the implied warranty of
+! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+! GNU General Public License for more details.
+!
+! You should have received a copy of the GNU General Public License along
+! with this program; if not, write to the Free Software Foundation, Inc.,
+! 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+!
+!=====================================================================
+
 
 ! number of material properties + element ID in input file Mesh_Par_file
   integer, parameter :: NUMBER_OF_MATERIAL_PROPERTIES = 18

diff --git a/fortran/meshfem3d/setup/constants.h b/fortran/meshfem3d/setup/constants.h
@@ -1,3 +1,30 @@
+!=====================================================================
+!
+!                          S p e c f e m 3 D
+!                          -----------------
+!
+!     Main historical authors: Dimitri Komatitsch and Jeroen Tromp
+!                              CNRS, France
+!                       and Princeton University, USA
+!                 (there are currently many more authors!)
+!                           (c) October 2017
+!
+! This program is free software; you can redistribute it and/or modify
+! it under the terms of the GNU General Public License as published by
+! the Free Software Foundation; either version 3 of the License, or
+! (at your option) any later version.
+!
+! This program is distributed in the hope that it will be useful,
+! but WITHOUT ANY WARRANTY; without even the implied warranty of
+! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+! GNU General Public License for more details.
+!
+! You should have received a copy of the GNU General Public License along
+! with this program; if not, write to the Free Software Foundation, Inc.,
+! 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+!
+!=====================================================================
+
 ! setup/constants.h.  Generated from constants.h.in by configure.
 
 !

diff --git a/fortran/meshfem3d/setup/constants_tomography.h b/fortran/meshfem3d/setup/constants_tomography.h
@@ -1,24 +1,26 @@
-!= == == == == == == == == == == == == == == == == == == == == == == == == == ==
-        == == == == == == == ==
-        !!S p e c f e m 3 D !-- -- -- -- -- -- -- -- -!!Main historical authors
-    : Dimitri Komatitsch and
-    Jeroen Tromp !CNRS,
-    France !and Princeton University,
-    USA !(there are currently many more authors !) !(
-        c)October 2017 !!This program is free software;
-you can redistribute it and / or
-    modify !it under the terms of the GNU General Public License
-        as published by !the Free Software Foundation;
-either version 3 of the License,
-    or !(at your option)any later version.!!This program is distributed in the
-            hope that it will be useful,
-    !but WITHOUT ANY WARRANTY; without even the implied warranty of
+!=====================================================================
+!
+!                          S p e c f e m 3 D
+!                          -----------------
+!
+!     Main historical authors: Dimitri Komatitsch and Jeroen Tromp
+!                              CNRS, France
+!                       and Princeton University, USA
+!                 (there are currently many more authors!)
+!                           (c) October 2017
+!
+! This program is free software; you can redistribute it and/or modify
+! it under the terms of the GNU General Public License as published by
+! the Free Software Foundation; either version 3 of the License, or
+! (at your option) any later version.
+!
+! This program is distributed in the hope that it will be useful,
+! but WITHOUT ANY WARRANTY; without even the implied warranty of
 ! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ! GNU General Public License for more details.
 !
 ! You should have received a copy of the GNU General Public License along
-! with this program;
-if not, write to the Free Software Foundation, Inc.,
+! with this program; if not, write to the Free Software Foundation, Inc.,
 ! 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 !
 !=====================================================================

diff --git a/fortran/meshfem3d/setup/precision.h b/fortran/meshfem3d/setup/precision.h
@@ -1,33 +1,39 @@
-!= == == == == == == == == == == == == == == == == == == == == == == == == == ==
-        == == == == == == == ==
-        !!S p e c f e m 3 D !-- -- -- -- -- -- -- -- -!!Main historical authors
-    : Dimitri Komatitsch and
-    Jeroen Tromp !CNRS,
-    France !and Princeton University,
-    USA !(there are currently many more authors !) !(
-        c)October 2017 !!This program is free software;
-you can redistribute it and / or
-    modify !it under the terms of the GNU General Public License
-        as published by !the Free Software Foundation;
-either version 3 of the License,
-    or !(at your option)any later version.!!This program is distributed in the
-            hope that it will be useful,
-    !but WITHOUT ANY WARRANTY; without even the implied warranty of
+!=====================================================================
+!
+!                          S p e c f e m 3 D
+!                          -----------------
+!
+!     Main historical authors: Dimitri Komatitsch and Jeroen Tromp
+!                              CNRS, France
+!                       and Princeton University, USA
+!                 (there are currently many more authors!)
+!                           (c) October 2017
+!
+! This program is free software; you can redistribute it and/or modify
+! it under the terms of the GNU General Public License as published by
+! the Free Software Foundation; either version 3 of the License, or
+! (at your option) any later version.
+!
+! This program is distributed in the hope that it will be useful,
+! but WITHOUT ANY WARRANTY; without even the implied warranty of
 ! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ! GNU General Public License for more details.
 !
 ! You should have received a copy of the GNU General Public License along
-! with this program;
-if
-not, write to the Free Software Foundation, Inc., !51 Franklin Street,
-    Fifth Floor, Boston,
-    MA 02110 - 1301 USA.! != == == == == == == == == == == == == == == == == ==
-            == == == == == == == == == == == == == == == == ==
+! with this program; if not, write to the Free Software Foundation, Inc.,
+! 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+!
+!=====================================================================
 
-            !setup / precision.h.Generated from precision.h.in by configure.
 
-                     !!solver in single or
-        double precision depending on the machine !!set to MPI_REAL to run in
-            single precision !set to MPI_DOUBLE_PRECISION to run in double
-                precision !!ALSO CHANGE FILE constants.h ACCORDINGLY !integer,
-    parameter ::CUSTOM_MPI_TYPE = MPI_REAL
+! setup/precision.h.  Generated from precision.h.in by configure.
+
+!
+! solver in single or double precision depending on the machine
+!
+! set to MPI_REAL to run in single precision
+! set to MPI_DOUBLE_PRECISION to run in double precision
+!
+! ALSO CHANGE FILE constants.h ACCORDINGLY
+!
+  integer, parameter :: CUSTOM_MPI_TYPE = MPI_REAL