Changeset 1682 for palm/trunk/SOURCE/cuda_fft_interfaces.f90

Timestamp:

Oct 7, 2015 11:56:08 PM (9 years ago)

Author:

knoop

Message:

Code annotations made doxygen readable

File:

• palm/trunk/SOURCE/cuda_fft_interfaces.f90 (modified) (11 diffs)

palm/trunk/SOURCE/cuda_fft_interfaces.f90

@@ -1 @@
- MODULE cuda_fft_interfaces
-
+!> @file cuda_fft_interfaces.f90
 !--------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -20 +19 @@
 ! Current revisions:
 ! -----------------
-! 
+! Code annotations made doxygen readable 
 ! 
 ! Former revisions:
@@ -55 +54 @@
 ! Description:
 ! ------------
-! FORTRAN interfaces for the CUDA fft
-! Routines for the fft along x and y (forward/backward) using the CUDA fft
+!> FORTRAN interfaces for the CUDA fft
+!> Routines for the fft along x and y (forward/backward) using the CUDA fft
 !--------------------------------------------------------------------------------!
+ MODULE cuda_fft_interfaces
+ 
 
 #if defined ( __cuda_fft )
@@ -63 +64 @@
     USE kinds
 
-    INTEGER(iwp) ::  CUFFT_FORWARD = -1   !:
-    INTEGER(iwp) ::  CUFFT_INVERSE =  1   !:
-    INTEGER(iwp) ::  CUFFT_R2C = Z'2a'    !: Real to Complex (interleaved)
-    INTEGER(iwp) ::  CUFFT_C2R = Z'2c'    !: Complex (interleaved) to Real
-    INTEGER(iwp) ::  CUFFT_C2C = Z'29'    !: Complex to Complex, interleaved
-    INTEGER(iwp) ::  CUFFT_D2Z = Z'6a'    !: Double to Double-Complex
-    INTEGER(iwp) ::  CUFFT_Z2D = Z'6c'    !: Double-Complex to Double
-    INTEGER(iwp) ::  CUFFT_Z2Z = Z'69'    !: Double-Complex to Double-Complex
+    INTEGER(iwp) ::  CUFFT_FORWARD = -1   !<
+    INTEGER(iwp) ::  CUFFT_INVERSE =  1   !<
+    INTEGER(iwp) ::  CUFFT_R2C = Z'2a'    !< Real to Complex (interleaved)
+    INTEGER(iwp) ::  CUFFT_C2R = Z'2c'    !< Complex (interleaved) to Real
+    INTEGER(iwp) ::  CUFFT_C2C = Z'29'    !< Complex to Complex, interleaved
+    INTEGER(iwp) ::  CUFFT_D2Z = Z'6a'    !< Double to Double-Complex
+    INTEGER(iwp) ::  CUFFT_Z2D = Z'6c'    !< Double-Complex to Double
+    INTEGER(iwp) ::  CUFFT_Z2Z = Z'69'    !< Double-Complex to Double-Complex
 
     PUBLIC
@@ -79 +80 @@
     INTERFACE CUFFTPLAN1D
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> @todo Missing subroutine description.
+!------------------------------------------------------------------------------!
        SUBROUTINE CUFFTPLAN1D( plan, nx, type, batch ) bind( C, name='cufftPlan1d' )
 
           USE ISO_C_BINDING
 
-          INTEGER(C_INT)        ::  plan   !: 
-          INTEGER(C_INT), value ::  batch  !: 
-          INTEGER(C_INT), value ::  nx     !: 
-          INTEGER(C_INT), value ::  type   !: 
+          INTEGER(C_INT)        ::  plan   !< 
+          INTEGER(C_INT), value ::  batch  !< 
+          INTEGER(C_INT), value ::  nx     !< 
+          INTEGER(C_INT), value ::  type   !< 
        END SUBROUTINE CUFFTPLAN1D
 
@@ -95 +101 @@
     INTERFACE CUFFTDESTROY
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> @todo Missing subroutine description.
+!------------------------------------------------------------------------------!
        SUBROUTINE CUFFTDESTROY( plan ) bind( C, name='cufftDestroy' )
 
@@ -108 +119 @@
     INTERFACE CUFFTEXECZ2D
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> @todo Missing subroutine description.
+!------------------------------------------------------------------------------!
        SUBROUTINE CUFFTEXECZ2D( plan, idata, odata ) bind( C, name='cufftExecZ2D' )
 
@@ -113 +129 @@
           USE kinds
 
-          INTEGER(C_INT), VALUE ::  plan          !:
-          COMPLEX(dp), DEVICE   ::  idata(:,:,:)  !:
-          REAL(dp), DEVICE      ::  odata(:,:,:)  !:
+          INTEGER(C_INT), VALUE ::  plan          !<
+          COMPLEX(dp), DEVICE   ::  idata(:,:,:)  !<
+          REAL(dp), DEVICE      ::  odata(:,:,:)  !<
 
        END SUBROUTINE CUFFTEXECZ2D
@@ -124 +140 @@
     INTERFACE CUFFTEXECD2Z
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> @todo Missing subroutine description.
+!------------------------------------------------------------------------------!
        SUBROUTINE CUFFTEXECD2Z( plan, idata, odata ) bind( C, name='cufftExecD2Z' )
 
@@ -130 +151 @@
           USE kinds
 
-          INTEGER(C_INT), VALUE ::  plan          !:
-          REAL(dp), DEVICE      ::  idata(:,:,:)  !:
-          COMPLEX(dp), DEVICE   ::  odata(:,:,:)  !:
+          INTEGER(C_INT), VALUE ::  plan          !<
+          REAL(dp), DEVICE      ::  idata(:,:,:)  !<
+          COMPLEX(dp), DEVICE   ::  odata(:,:,:)  !<
 
        END SUBROUTINE CUFFTEXECD2Z
@@ -140 +161 @@
 #else
 
-!
-!-- Dummy interface to avoid compiler warnings in case of no bublic objects
-!-- declared
     INTERFACE CUFFTdummy
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> Dummy interface to avoid compiler warnings in case of no bublic objects
+!> declared.
+!------------------------------------------------------------------------------!
        SUBROUTINE CUFFTdummy( dummy )
        
           USE kinds
 
-          REAL(wp) ::  dummy  !:
+          REAL(wp) ::  dummy  !<
 
        END SUBROUTINE CUFFTdummy