From 46753fd54e3e0764348a885fe92233805bbd61a6 Mon Sep 17 00:00:00 2001 From: PESchoenberg Date: Wed, 27 Mar 2019 16:06:54 -0300 Subject: [PATCH] Updated comments. --- COPYING | 2 +- COPYING.LESSER | 2 +- README.md | 10 ++++++---- cfmath.sh | 12 ++++++------ fmath1.f95 | 1 + fmath2.f95 | 6 +++++- fmath3.f95 | 1 - fmath4.f95 | 2 +- fmath5.f95 | 3 --- tfmath1.f95 | 6 ++++-- 10 files changed, 25 insertions(+), 20 deletions(-) diff --git a/COPYING b/COPYING index d0e5884..9a2d4e6 100644 --- a/COPYING +++ b/COPYING @@ -6,7 +6,7 @@ of this license document, but changing it is not allowed. Preamble - + The GNU General Public License is a free, copyleft license for software and other kinds of works. diff --git a/COPYING.LESSER b/COPYING.LESSER index 0dfae2c..ab8f165 100644 --- a/COPYING.LESSER +++ b/COPYING.LESSER @@ -162,5 +162,5 @@ General Public License ever published by the Free Software Foundation. whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the -Library. +Library. diff --git a/README.md b/README.md index a84823c..b6bc13e 100644 --- a/README.md +++ b/README.md @@ -7,16 +7,18 @@ A collection under development of Fortran modules and functions written over time that might be useful for calculations in maths, astronomy, aeronautics, -etc. Some of these functions are still unfinished or need further testing. +etc. Some of these functions are still unfinished or need further testing; all +of them originated as "scrapbook material" from various Matlab and Frotran +projects that I kept jsut because they could be useful in the future. ## Dependencies and requirements: -* gfortran. +* gfortran compiler. -* OpenMP. +* OpenMP library. -* MPICH or OpenMPI. +* MPICH or OpenMPI libraries. ## Installation: diff --git a/cfmath.sh b/cfmath.sh index 4150baf..0fc4c7b 100755 --- a/cfmath.sh +++ b/cfmath.sh @@ -1,15 +1,15 @@ #!/bin/bash clear -echo 'Compiling fmath libraries...' -echo 'fmath3...' +echo 'Compiling fmath libraries... ' +echo 'fmath3... ' gfortran -std='gnu' -c fmath3.f95 -O3 -march=native -Wall -Wextra -ffree-form -echo 'fmath4...' +echo 'fmath4... ' gfortran -std='gnu' -c fmath4.f95 -O3 -march=native -Wall -Wextra -ffree-form -echo 'fmath1...' +echo 'fmath1... ' gfortran -std='gnu' -c fmath1.f95 -O3 -march=native -Wall -Wextra -ffree-form -echo 'fmath2...' +echo 'fmath2... ' gfortran -std='gnu' -c fmath2.f95 -O3 -march=native -Wall -Wextra -ffree-form -echo 'fmath5...' +echo 'fmath5... ' gfortran -std='gnu' -c fmath5.f95 -O3 -march=native -Wall -Wextra -ffree-form echo echo 'Finished compiling fmath libraries.' diff --git a/fmath1.f95 b/fmath1.f95 index d9a6c69..d8825ab 100644 --- a/fmath1.f95 +++ b/fmath1.f95 @@ -3834,6 +3834,7 @@ subroutine RspFTestFmath1All() !> Test for fmath1 subroutines and functions. + !> !> - RspFTestTime(...) !> - RspFTestMetricImperial(...) !> - RspFTestMetricLength(...) diff --git a/fmath2.f95 b/fmath2.f95 index 48d6553..595ae8e 100644 --- a/fmath2.f95 +++ b/fmath2.f95 @@ -112,7 +112,6 @@ pure real( kind = fmath2_p1 ) function RspFLinearMomentum1( p_m, p_v ) real( kind = fmath2_p1 ), intent(in) :: p_m, p_v - !RspFLinearMomentum1 = p_m * p_v * RspFLorentzFactor( RspFConst("c") ) RspFLinearMomentum1 = p_m * p_v * RspFLorentzFactor( p_v ) return @@ -1699,6 +1698,7 @@ subroutine RspFTestFmath2All() !> Test for fmath2 subroutines and functions. + !> !> - RspFAngularMomentum1(...) !> - RspFAngularMomentum2(...) !> - RspFLinearMomentum1(...) @@ -1821,6 +1821,7 @@ subroutine RspFTestFmath21() !> Test for fmath2 subroutines and functions. + !> !> - RspFApproximateRocheLobeEggleton(...) !> - RspFHillSphere(...) !> - RspFArcsec2Km(...) @@ -2071,6 +2072,7 @@ subroutine RspFTestFmath23() !> Test for fmath2 subroutines and functions. + !> !> - RspFIsBlackHole(...) !> - RspFIsOverChandrasekharLimit(...) !> - RspFKg2Em(...) @@ -2213,6 +2215,7 @@ subroutine RspFTestFmath24() !> Test for fmath2 subroutines and functions. + !> !> - RspFMeanMotion(...) !> - RspFPs2Ly(...) !> - RspFRadius2SchwarzschildRatio(...) @@ -2340,6 +2343,7 @@ subroutine RspFTestFmath25() !> Test for fmath2 subroutines and functions. + !> !> - RspFSurfaceGravity1(...) !> - RspFSurfaceGravity2(...) !> diff --git a/fmath3.f95 b/fmath3.f95 index 07eae1f..3b4459e 100644 --- a/fmath3.f95 +++ b/fmath3.f95 @@ -32,7 +32,6 @@ module fmath3 ! Setting a platform-independent floating point precision. integer, parameter :: fmath3_p1 = selected_real_kind( 10,300 ) - !integer, parameter :: fmath3_p2 = 10 !------------------------------------------------------------------------------ contains diff --git a/fmath4.f95 b/fmath4.f95 index e4f03af..a3179f9 100644 --- a/fmath4.f95 +++ b/fmath4.f95 @@ -39,7 +39,7 @@ module fmath4 ! Misc functions. - !> Draws a line on console. + !> Draws a simple line in the console. !> subroutine RspFLine() diff --git a/fmath5.f95 b/fmath5.f95 index 66ee3a3..d413c27 100644 --- a/fmath5.f95 +++ b/fmath5.f95 @@ -21,9 +21,6 @@ !> !> ============================================================================= !> -!> Modified: -!> - Jul 5 2018. -!> !> Compilation: !> - ./cfmath.sh or !> - mpif90 -std='gnu' -c fmath5.f95 -O3 -march=native -Wall -Wextra -fopenmp -fdec-math diff --git a/tfmath1.f95 b/tfmath1.f95 index 5582c5c..e7f1068 100644 --- a/tfmath1.f95 +++ b/tfmath1.f95 @@ -23,7 +23,7 @@ !> !> Test program for fmath* functions. !> -!> Compilation nad linking: +!> Compilation and linking: !> - gfortran -std='gnu' tfmath1.f95 fmath1.o fmath2.o fmath3.o fmath4.o fmath5.o -o tfmath1 -O3 -march=native -Wall -Wextra -fopenmp !> !> or (if you want to use MPICH with this) @@ -35,7 +35,9 @@ !> !> or (if you compiled it for use with MPICH) !> -!> - mpiexec -np [n] ./tfmath1_mpi (n = number of processes to use, recommended n = 1 in this case). +!> - mpiexec -np [n] ./tfmath1_mpi (n = number of processes to use, recommended +!> n = 1 in this case, because you might get errors otherwise, at least it the +!> present version of fmath). !> program tfmath1