Merge pull request #367 from ywkawai/feature/refactor

Feature/refactor
ywkawai · Oct 6, 2024 · 0b85239 · 0b85239
2 parents dbeff53 + e49ea54
commit 0b85239
Show file tree

Hide file tree

Showing 98 changed files with 268 additions and 258 deletions.
diff --git a/FElib/src/common/scale_coriolis_param.F90 b/FElib/src/common/scale_coriolis_param.F90
@@ -7,7 +7,7 @@
 !!
 !! @par Reference
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 #include "scaleFElib.h"
 module scale_coriolis_param

diff --git a/FElib/src/common/scale_cubedsphere_coord_cnv.F90 b/FElib/src/common/scale_cubedsphere_coord_cnv.F90
@@ -15,7 +15,7 @@
 !!    Geophysical Journal International, 209, 1934–1954. 
 !!    (Appendix A)
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 #include "scaleFElib.h"
 module scale_cubedsphere_coord_cnv

diff --git a/FElib/src/common/scale_geographic_coord_cnv.F90 b/FElib/src/common/scale_geographic_coord_cnv.F90
@@ -3,7 +3,7 @@
 !! @par Description
 !!      Coordinate conversion with a geographic coordinate
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 #include "scaleFElib.h"
 module scale_geographic_coord_cnv

diff --git a/FElib/src/common/scale_gmres.F90 b/FElib/src/common/scale_gmres.F90
@@ -9,7 +9,7 @@
 !!     GMRES: A generalized minimal residual algorithm for solving nonsymmetric linear systems.
 !!     SIAM J. Sci. Stat. Comput., 7:856–869
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 #include "scaleFElib.h"
 module scale_gmres

diff --git a/FElib/src/common/scale_linalgebra.F90 b/FElib/src/common/scale_linalgebra.F90
@@ -5,7 +5,7 @@
 !!
 !! @par Reference
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 #include "scaleFElib.h"
 module scale_linalgebra

diff --git a/FElib/src/common/scale_linkedlist.F90 b/FElib/src/common/scale_linkedlist.F90
@@ -5,7 +5,7 @@
 !!
 !! @par Reference
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 #include "scaleFElib.h"
 module scale_linkedlist

diff --git a/FElib/src/common/scale_polygon.F90 b/FElib/src/common/scale_polygon.F90
@@ -1,3 +1,12 @@
+!> module common / Polygon
+!!
+!! @par Description
+!!      A module to provide utilities for polygon
+!!
+!! @par Reference
+!!
+!! @author Yuta Kawai, Team SCALE
+!!
 #include "scaleFElib.h"
 module scale_polygon
   !-----------------------------------------------------------------------------

diff --git a/FElib/src/common/scale_polynominal.F90 b/FElib/src/common/scale_polynominal.F90
@@ -5,7 +5,7 @@
 !!
 !! @par Reference
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 #include "scaleFElib.h"
 module scale_polynominal

diff --git a/FElib/src/common/scale_quicksort.F90 b/FElib/src/common/scale_quicksort.F90
@@ -9,7 +9,7 @@
 !!
 !! @par Reference
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 #include "scaleFElib.h"
 module scale_quicksort

diff --git a/FElib/src/common/scale_quicksort.F90.erb b/FElib/src/common/scale_quicksort.F90.erb
@@ -9,7 +9,7 @@
 !!
 !! @par Reference
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 #include "scaleFElib.h"
 module scale_quicksort

diff --git a/FElib/src/common/scale_sparsemat.F90 b/FElib/src/common/scale_sparsemat.F90
@@ -1,3 +1,12 @@
+!-------------------------------------------------------------------------------
+!> module common / sparsemat
+!!
+!! @par Description
+!!          module to treat sparse matrix and the associated operations
+!!
+!! @author Yuta Kawai, Team SCALE
+!!
+!<
 #include "scaleFElib.h"
 module scale_sparsemat
   !-----------------------------------------------------------------------------

diff --git a/FElib/src/common/scale_time_manager.F90 b/FElib/src/common/scale_time_manager.F90
@@ -1,3 +1,12 @@
+!-------------------------------------------------------------------------------
+!> module common / time
+!!
+!! @par Description
+!!          Module to manage time with temporal integration
+!!
+!! @author Yuta Kawai, Team SCALE
+!!
+!<
 #include "scaleFElib.h"
 module scale_time_manager
   !-----------------------------------------------------------------------------

diff --git a/FElib/src/common/scale_timeint_rk.F90 b/FElib/src/common/scale_timeint_rk.F90
@@ -8,7 +8,7 @@
 !! @par Description
 !!      Driver module to provide various Runge-Kutta schemes. 
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !<
 #include "scaleFElib.h"
 module scale_timeint_rk

diff --git a/FElib/src/common/scale_timeint_rk.F90.erb b/FElib/src/common/scale_timeint_rk.F90.erb
@@ -8,7 +8,7 @@
 !! @par Description
 !!      Driver module to provide various Runge-Kutta schemes. 
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !<
 #include "scaleFElib.h"
 module scale_timeint_rk

diff --git a/FElib/src/data/scale_localmeshfield_base.F90 b/FElib/src/data/scale_localmeshfield_base.F90
@@ -1,7 +1,7 @@
 !> module FElib / Data / base
 !!
 !! @par Description
-!!           A module for managing field data with FEM 
+!!           A module for managing field data with subdomains included in each MPI process 
 !!
 !! @author Yuta Kawai, Team SCALE
 !!

diff --git a/FElib/src/data/scale_meshfield_analysis_numerror.F90 b/FElib/src/data/scale_meshfield_analysis_numerror.F90
@@ -1,10 +1,10 @@
 !-------------------------------------------------------------------------------
-!> module meshfield_analysis_numerror_base
+!> module FElib / Data / Statistics / numerical error
 !!
 !! @par Description
 !!           This module provides classes to evaluate numerical error for 1D, 2D, and 3D fields
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 !<
 !-------------------------------------------------------------------------------

diff --git a/FElib/src/data/scale_meshfield_analysis_numerror_base.F90 b/FElib/src/data/scale_meshfield_analysis_numerror_base.F90
@@ -1,10 +1,10 @@
 !-------------------------------------------------------------------------------
-!> module meshfield_analysis_numerror_base
+!> module FElib / Data / Statistics / numerical error
 !!
 !! @par Description
 !!           This module provides a base class useful for evaluating numerical errrors
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 !<
 !-------------------------------------------------------------------------------

diff --git a/FElib/src/data/scale_meshfield_base.F90 b/FElib/src/data/scale_meshfield_base.F90
@@ -1,3 +1,11 @@
+!> module FElib / Data / base
+!!
+!! @par Description
+!!           A module for managing field data with FEM 
+!!
+!! @author Yuta Kawai, Team SCALE
+!!
+!<
 #include "scaleFElib.h"
 module scale_meshfield_base
 
@@ -21,7 +29,7 @@ module scale_meshfield_base
     LocalMeshField1D, LocalMeshField2D, LocalMeshField3D
 
   use scale_element_base, only: &
-    elementbase1D, elementbase2D, elementbase3D
+    ElementBase1D, ElementBase2D, ElementBase3D
 
 
   !-----------------------------------------------------------------------------

diff --git a/FElib/src/data/scale_meshfield_statistics.F90 b/FElib/src/data/scale_meshfield_statistics.F90
@@ -1,3 +1,11 @@
+!> module FElib / Data / Statistics
+!!
+!! @par Description
+!!           A module for analyzing statistics of field data 
+!!
+!! @author Yuta Kawai, Team SCALE
+!!
+!<
 #include "scaleFElib.h"
 module scale_meshfield_statistics
 

diff --git a/FElib/src/data/scale_meshfieldcomm_1d.F90 b/FElib/src/data/scale_meshfieldcomm_1d.F90
@@ -16,7 +16,7 @@ module scale_meshfieldcomm_1d
   use scale_precision
   use scale_io
 
-  use scale_element_base, only: elementbase, elementbase1d
+  use scale_element_base, only: ElementBase, ElementBase1d
   use scale_mesh_base1d, only: MeshBase1D
   use scale_meshfield_base, only: MeshField1D
   use scale_meshfieldcomm_base, only: &

diff --git a/FElib/src/data/scale_meshfieldcomm_base.F90 b/FElib/src/data/scale_meshfieldcomm_base.F90
@@ -16,7 +16,7 @@ module scale_meshfieldcomm_base
   use scale_precision
   use scale_io
 
-  use scale_element_base, only: elementbase
+  use scale_element_base, only: ElementBase
   use scale_mesh_base, only: MeshBase
   use scale_meshfield_base, only: &
     MeshFieldBase, MeshField1D, MeshField2D, MeshField3D

diff --git a/FElib/src/data/scale_meshfieldcomm_cubedom3d.F90 b/FElib/src/data/scale_meshfieldcomm_cubedom3d.F90
@@ -16,7 +16,7 @@ module scale_meshfieldcomm_cubedom3d
   use scale_precision
   use scale_io
 
-  use scale_element_base, only: elementbase, elementBase3D
+  use scale_element_base, only: ElementBase, ElementBase3D
   use scale_mesh_cubedom3d, only: MeshCubeDom3D
   use scale_meshfield_base, only: MeshField3D
   use scale_meshfieldcomm_base, only: &

diff --git a/FElib/src/data/scale_meshfieldcomm_cubedspheredom2d.F90 b/FElib/src/data/scale_meshfieldcomm_cubedspheredom2d.F90
@@ -16,7 +16,7 @@ module scale_meshfieldcomm_cubedspheredom2d
   use scale_precision
   use scale_io
 
-  use scale_element_base, only: elementbase, elementBase2D
+  use scale_element_base, only: ElementBase, ElementBase2D
   use scale_mesh_cubedspheredom2d, only: MeshCubedSphereDom2D
   use scale_meshfield_base, only: MeshField2D
   use scale_meshfieldcomm_base, only: &
@@ -363,7 +363,7 @@ end subroutine push_localsendbuf
   subroutine extract_boundary_data2D( var, refElem, mesh, buf )
     implicit none
 
-    type(elementbase2D), intent(in) :: refElem
+    type(ElementBase2D), intent(in) :: refElem
     type(LocalMesh2D), intent(in) :: mesh
     real(DP), intent(in) :: var(refElem%Np * mesh%Ne)
     real(DP), intent(inout) :: buf(refElem%Nfp * mesh%NeX * 4)

diff --git a/FElib/src/data/scale_meshfieldcomm_cubedspheredom3d.F90 b/FElib/src/data/scale_meshfieldcomm_cubedspheredom3d.F90
@@ -16,7 +16,7 @@ module scale_meshfieldcomm_cubedspheredom3d
   use scale_precision
   use scale_io
 
-  use scale_element_base, only: elementbase, elementBase3D
+  use scale_element_base, only: ElementBase, ElementBase3D
   use scale_mesh_cubedspheredom3d, only: MeshCubedSphereDom3D
   use scale_meshfield_base, only: MeshField3D
   use scale_meshfieldcomm_base, only: &

diff --git a/FElib/src/data/scale_variableinfo.F90 b/FElib/src/data/scale_variableinfo.F90
@@ -1,3 +1,11 @@
+!> module FElib / Data / base
+!!
+!! @par Description
+!!           A module for managing information of variable
+!!
+!! @author Yuta Kawai, Team SCALE
+!!
+!<
 #include "scaleFElib.h"
 module scale_variableinfo
   !-----------------------------------------------------------------------------

diff --git a/FElib/src/element/scale_element_base.F90 b/FElib/src/element/scale_element_base.F90
@@ -1,9 +1,9 @@
-!> module FElib/ Element / Base
+!> module FElib / Element / Base
 !!
 !! @par Description
 !!           A base module for finite element
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 !<
 !-------------------------------------------------------------------------------

diff --git a/FElib/src/element/scale_element_hexahedral.F90 b/FElib/src/element/scale_element_hexahedral.F90
@@ -3,7 +3,7 @@
 !! @par Description
 !!           A module for a hexahedral finite element
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 !<
 #include "scaleFElib.h"

diff --git a/FElib/src/element/scale_element_line.F90 b/FElib/src/element/scale_element_line.F90
@@ -3,7 +3,7 @@
 !! @par Description
 !!           A module for a line finite element
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 !<
 #include "scaleFElib.h"

diff --git a/FElib/src/element/scale_element_modalfilter.F90 b/FElib/src/element/scale_element_modalfilter.F90
@@ -4,7 +4,7 @@
 !! @par Description
 !!      Modal filter
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !<
 !-------------------------------------------------------------------------------
 #include "scaleFElib.h"

diff --git a/FElib/src/element/scale_element_quadrilateral.F90 b/FElib/src/element/scale_element_quadrilateral.F90
@@ -3,7 +3,7 @@
 !! @par Description
 !!           A module for a quadrilateral finite element
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 !<
 #include "scaleFElib.h"
@@ -16,7 +16,7 @@ module scale_element_quadrilateral
   use scale_precision
 
   use scale_element_base, only: &
-    elementbase2D, &
+    ElementBase2D, &
     ElementBase2D_Init, ElementBase2D_Final
 
   !-----------------------------------------------------------------------------

diff --git a/FElib/src/file/scale_file_base_meshfield.F90 b/FElib/src/file/scale_file_base_meshfield.F90
@@ -4,7 +4,7 @@
 !! @par Description
 !!          A base module for outputting data with MeshField type 
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !<
 !-------------------------------------------------------------------------------
 #include "scaleFElib.h"
@@ -37,7 +37,7 @@ module scale_file_base_meshfield
     MF3D_DIMTYPE_Z => MeshBase3D_DIMTYPEID_Z, &
     MF3D_DTYPE_NUM => MeshBase3D_DIMTYPE_NUM
 
-  use scale_element_base, only: elementbase1D, elementbase2D, elementbase3D
+  use scale_element_base, only: ElementBase1D, ElementBase2D, ElementBase3D
   use scale_mesh_base1d, only: MeshBase1D
   use scale_mesh_base2d, only: MeshBase2D
   use scale_mesh_base3d, only: MeshBase3D

diff --git a/FElib/src/file/scale_file_common_meshfield.F90 b/FElib/src/file/scale_file_common_meshfield.F90
@@ -3,7 +3,7 @@
 !! @par Description
 !!           A common module for outputing field data 
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 !<
 !-------------------------------------------------------------------------------

diff --git a/FElib/src/file/scale_file_history_meshfield.F90 b/FElib/src/file/scale_file_history_meshfield.F90
@@ -3,7 +3,8 @@
 !!
 !! @par Description
 !!          A module for managing file history 
-!! @author Team SCALE
+!!
+!! @author Yuta Kawai, Team SCALE
 !<
 !-------------------------------------------------------------------------------
 #include "scaleFElib.h"
@@ -27,7 +28,7 @@ module scale_file_history_meshfield
     FILE_HISTORY_Set_Axis,    &
     FILE_HISTORY_finalize
 
-  use scale_element_base, only: elementbase1D, elementbase2D, elementbase3D
+  use scale_element_base, only: ElementBase1D, ElementBase2D, ElementBase3D
   use scale_mesh_base1d, only: MeshBase1D
   use scale_mesh_base2d, only: MeshBase2D
   use scale_mesh_base3d, only: MeshBase3D

diff --git a/FElib/src/file/scale_file_monitor_meshfield.F90 b/FElib/src/file/scale_file_monitor_meshfield.F90
@@ -4,7 +4,7 @@
 !! @par Description
 !!          A module for monitoring model statistics
 !!
-!! @author Team SCALE
+!! @author Yuta Kawai, Team SCALE
 !!
 !<
 !-------------------------------------------------------------------------------