Add Spherepack sources

Author: josephzhang8

src/Core/Spherepack/CMakeLists.txt.0

@@ -0,0 +1,128 @@
+set(source_dir ${CMAKE_CURRENT_SOURCE_DIR}) ##/../spherepack-e80da29462c5987162a0884baaab7434d0215467/src)
+
+set(sources
+    ${source_dir}/colatitudinal_derivative_gaussian_grid.f90
+    ${source_dir}/colatitudinal_derivative_gaussian_grid_saved.f90
+    ${source_dir}/colatitudinal_derivative_regular_grid.f90
+    ${source_dir}/colatitudinal_derivative_regular_grid_saved.f90
+    ${source_dir}/colatitudinal_derivative_routines.f90
+    ${source_dir}/coordinate_transfer_routines.f90
+    ${source_dir}/divergence_gaussian_grid.f90
+    ${source_dir}/divergence_gaussian_grid_saved.f90
+    ${source_dir}/divergence_regular_grid.f90
+    ${source_dir}/divergence_regular_grid_saved.f90
+    ${source_dir}/divergence_routines.f90
+    ${source_dir}/gaussian_latitudes_and_weights_routines.f90
+    ${source_dir}/gradient_gaussian_grid.f90
+    ${source_dir}/gradient_gaussian_grid_saved.f90
+    ${source_dir}/gradient_regular_grid.f90
+    ${source_dir}/gradient_regular_grid_saved.f90
+    ${source_dir}/gradient_routines.f90
+    ${source_dir}/grid_transfer_routines.f90
+    ${source_dir}/grid_transfer_scalar_shift.f90
+    ${source_dir}/grid_transfer_scalar_transform.f90
+    ${source_dir}/grid_transfer_vector_shift.f90
+    ${source_dir}/grid_transfer_vector_transform.f90
+    ${source_dir}/icosahedral_geodesic_routines.f90
+    ${source_dir}/idvtec.f90
+    ${source_dir}/idvtes.f90
+    ${source_dir}/idvtgc.f90
+    ${source_dir}/idvtgs.f90
+    ${source_dir}/invert_divergence_gaussian_grid.f90
+    ${source_dir}/invert_divergence_gaussian_grid_saved.f90
+    ${source_dir}/invert_divergence_regular_grid.f90
+    ${source_dir}/invert_divergence_regular_grid_saved.f90
+    ${source_dir}/invert_gradient_gaussian_grid.f90
+    ${source_dir}/invert_gradient_gaussian_grid_saved.f90
+    ${source_dir}/invert_gradient_regular_grid.f90
+    ${source_dir}/invert_gradient_regular_grid_saved.f90
+    ${source_dir}/invert_scalar_laplacian_gaussian_grid.f90
+    ${source_dir}/invert_scalar_laplacian_gaussian_grid_saved.f90
+    ${source_dir}/invert_scalar_laplacian_regular_grid.f90
+    ${source_dir}/invert_scalar_laplacian_regular_grid_saved.f90
+    ${source_dir}/invert_vector_laplacian_gaussian_grid.f90
+    ${source_dir}/invert_vector_laplacian_gaussian_grid_saved.f90
+    ${source_dir}/invert_vector_laplacian_regular_grid.f90
+    ${source_dir}/invert_vector_laplacian_regular_grid_saved.f90
+    ${source_dir}/invert_vorticity_gaussian_grid.f90
+    ${source_dir}/invert_vorticity_gaussian_grid_saved.f90
+    ${source_dir}/invert_vorticity_regular_grid.f90
+    ${source_dir}/invert_vorticity_regular_grid_saved.f90
+    ${source_dir}/isfvpec.f90
+    ${source_dir}/isfvpes.f90
+    ${source_dir}/isfvpgc.f90
+    ${source_dir}/isfvpgs.f90
+    ${source_dir}/main.f90
+    ${source_dir}/scalar_analysis_gaussian_grid.f90
+    ${source_dir}/scalar_analysis_gaussian_grid_saved.f90
+    ${source_dir}/scalar_analysis_regular_grid.f90
+    ${source_dir}/scalar_analysis_regular_grid_saved.f90
+    ${source_dir}/scalar_analysis_routines.f90
+    ${source_dir}/scalar_laplacian_gaussian_grid.f90
+    ${source_dir}/scalar_laplacian_gaussian_grid_saved.f90
+    ${source_dir}/scalar_laplacian_regular_grid.f90
+    ${source_dir}/scalar_laplacian_regular_grid_saved.f90
+    ${source_dir}/scalar_laplacian_routines.f90
+    ${source_dir}/scalar_projection_gaussian_grid.f90
+    ${source_dir}/scalar_projection_regular_grid.f90
+    ${source_dir}/scalar_projection_routines.f90
+    ${source_dir}/scalar_synthesis_gaussian_grid.f90
+    ${source_dir}/scalar_synthesis_gaussian_grid_saved.f90
+    ${source_dir}/scalar_synthesis_regular_grid.f90
+    ${source_dir}/scalar_synthesis_regular_grid_saved.f90
+    ${source_dir}/scalar_synthesis_routines.f90
+    ${source_dir}/sfvpec.f90
+    ${source_dir}/sfvpes.f90
+    ${source_dir}/sfvpgc.f90
+    ${source_dir}/sfvpgs.f90
+    ${source_dir}/spherepack.f90
+    ${source_dir}/spherepack_interfaces.f90
+    ${source_dir}/spherepack_precision.f90
+    ${source_dir}/type_AssociatedLegendrePolynomialGenerator.f90
+    ${source_dir}/type_FastFourierTransform.f90
+    ${source_dir}/type_GaussianGrid.f90
+    ${source_dir}/type_GaussianSphere.f90
+    ${source_dir}/type_GaussianWorkspace.f90
+    ${source_dir}/type_RealHarmonicCoefficients.f90
+    ${source_dir}/type_RealPeriodicFastFourierTransform.f90
+    ${source_dir}/type_RegularGrid.f90
+    ${source_dir}/type_RegularSphere.f90
+    ${source_dir}/type_RegularWorkspace.f90
+    ${source_dir}/type_ScalarHarmonic.f90
+    ${source_dir}/type_Sphere.f90
+    ${source_dir}/type_SpherepackUtility.f90
+    ${source_dir}/type_SphericalGrid.f90
+    ${source_dir}/type_SphericalUnitVectors.f90
+    ${source_dir}/type_TrigonometricTable.f90
+    ${source_dir}/type_Vector3D.f90
+    ${source_dir}/type_VectorHarmonic.f90
+    ${source_dir}/type_VectorHarmonicCoefficients.f90
+    ${source_dir}/type_WavetableUtility.f90
+    ${source_dir}/type_Workspace.f90
+    ${source_dir}/vector_analysis_gaussian_grid.f90
+    ${source_dir}/vector_analysis_gaussian_grid_saved.f90
+    ${source_dir}/vector_analysis_regular_grid.f90
+    ${source_dir}/vector_analysis_regular_grid_saved.f90
+    ${source_dir}/vector_analysis_routines.f90
+    ${source_dir}/vector_laplacian_gaussian_grid.f90
+    ${source_dir}/vector_laplacian_gaussian_grid_saved.f90
+    ${source_dir}/vector_laplacian_regular_grid.f90
+    ${source_dir}/vector_laplacian_regular_grid_saved.f90
+    ${source_dir}/vector_laplacian_routines.f90
+    ${source_dir}/vector_synthesis_gaussian_grid.f90
+    ${source_dir}/vector_synthesis_gaussian_grid_saved.f90
+    ${source_dir}/vector_synthesis_regular_grid.f90
+    ${source_dir}/vector_synthesis_regular_grid_saved.f90
+    ${source_dir}/vector_synthesis_routines.f90
+    ${source_dir}/vorticity_gaussian_grid.f90
+    ${source_dir}/vorticity_gaussian_grid_saved.f90
+    ${source_dir}/vorticity_regular_grid.f90
+    ${source_dir}/vorticity_regular_grid_saved.f90
+    ${source_dir}/vorticity_routines.f90
+)
+
+add_library(spherepack ${sources})
+
+#set_target_properties(spherepack PROPERTIES FOLDER third_party_open/spherepack)
+
+#target_link_libraries(spherepack PRIVATE no_compiler_warnings)

src/Core/Spherepack/LICENSE.md

@@ -0,0 +1,37 @@
+PLEASE READ THIS SOFTWARE LICENSE ("LICENSE") CAREFULLY. 
+
+Copyright 2004 the University Corporation for Atmospheric 
+Research ("UCAR"). All rights reserved. Developed by NCAR's 
+Computational and Information Systems Laboratory, UCAR,
+http://www2.cisl.ucar.edu. Redistribution and use of the Software 
+in source and binary forms, with or without modification, is 
+permitted provided that the following conditions are met:
+
+ * Neither the names of NCAR's Computational and 
+Information Systems Laboratory, the University Corporation for 
+Atmospheric Research, nor the names of its sponsors or 
+contributors may be used to endorse or promote products derived 
+from this Software without specific prior written permission.
+
+ * Redistributions of source code must retain the above 
+copyright notices, this list of conditions, and the disclaimer 
+below.
+
+ * Redistributions in binary form must reproduce the above 
+copyright notice, this list of conditions, and the disclaimer 
+below in the documentation and/or other materials provided with 
+the distribution.
+
+THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
+EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO THE WARRANTIES 
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
+NONINFRINGEMENT. IN NO EVENT SHALL THE CONTRIBUTORS OR COPYRIGHT 
+HOLDERS BE LIABLE FOR ANY CLAIM, INDIRECT, INCIDENTAL, SPECIAL, 
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT 
+OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
+DEALINGS WITH THE SOFTWARE.
+
+SPHEREPACK is a product of the Computational & Information 
+Systems Laboratory at the National Center for Atmospheric 
+Research (NCAR).

src/Core/Spherepack/LICENSE.mit.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+=====================
+
+Copyright (c) 2016 Jon Lo Kim Lin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

src/Core/Spherepack/README.md

@@ -0,0 +1,98 @@
+# **spherepack - A Fortran library of spherical harmonic transforms**
+
+A modernization of NCAR's SPHEREPACK3.2.
+
+* The original work, written in fixed-from FORTRAN 77, was heavily refactored to incorporate features of free-form modern Fortran (2008+). 
+* Dynamic memory allocation procedures for analysis and synthesis are now hidden from the end user.
+
+-----------------------------------------------------------------------------
+
+## What is spherepack?
+
+A collection of Fortran programs for computing common spherical differential operators including divergence, vorticity, latitudinal derivatives, gradients, the Laplacian of both scalar and vector functions, and the inverses of these operators.
+
+For example, given divergence and vorticity, the package can be used to compute velocity components, then the Laplacian inverse can be used to solve the scalar and vector Poisson equations. The package also contains routines for computing the associated Legendre functions, Gaussian points and weights, multiple fast Fourier transforms, and for converting scalar and vector fields between geophysical and mathematical spherical coordinates.
+
+Test programs are provided for solving these equations. Each program serves two purposes: as a template to guide you in writing your own codes utilizing the spherepack routines, and as a demonstration on your computer that you can correctly produce spherepack executables.
+
+-----------------------------------------------------------------------------
+
+## Usage
+
+```fortran
+        	
+    use spherepack, only: &
+        wp, & ! working precision
+        GaussianSphere
+
+    ! Explicit typing only
+    implicit none
+    
+    type(GaussianSphere)  :: foo
+    real(wp), allocatable :: scalar_function(:,:)
+    real(wp), allocatable :: laplacian(:,:)
+    real(wp), allocatable :: solution(:,:)
+    
+    ! Initialize object
+    foo = GaussianSphere(nlat=19, nlon=36)
+    
+    !.... generate some data
+    
+    ! Compute complex spectral coefficients
+    call foo%perform_complex_analysis(scalar_function)
+    
+    ! Compute laplacian on sphere
+    call foo%get_laplacian(scalar_function, laplacian)
+    
+    ! Invert laplacian on sphere
+    call foo%invert_laplacian(laplacian, solution)
+    
+    ! Release memory
+    call foo%destroy()
+
+```
+
+-----------------------------------------------------------------------------
+
+## Requirements
+
+* The GNU Make tool https://www.gnu.org/software/make/
+* The GNU gfortran compiler https://gcc.gnu.org/wiki/GFortran
+
+-----------------------------------------------------------------------------
+
+
+## To build the project
+
+Type the following command line arguments
+
+```bash
+
+	git clone https://github.com/jlokimlin/spherepack.git; cd spherepack; make all
+```
+
+-----------------------------------------------------------------------------
+
+## Contributing
+
+This project is still a work in progress and anyone is free to contribute under the proviso that they abstain from using the dreaded **go to**.
+
+For bug reports or feature requests please open an issue on github.
+
+-----------------------------------------------------------------------------
+
+
+## Bibliography
+
+[1] Swarztrauber, Paul N. "On computing the points and weights for Gauss--Legendre quadrature." *SIAM Journal on Scientific Computing* 24.3 (2003): 945-954.
+
+[2] Swarztrauber, Paul N., and William F. Spotz. "Generalized discrete spherical harmonic transforms." *Journal of Computational Physics* 159.2 (2000): 213-230.
+
+[3] Adams, John C., and Paul N. Swarztrauber. "SPHEREPACK 3.0: A model development facility." *Monthly Weather Review* 127.8 (1999): 1872-1878.
+
+[4] Swarztrauber, Paul N. "Spectral transform methods for solving the shallow-water equations on the sphere." *Monthly Weather Review* 124.4 (1996): 730-744.
+
+[5] Williamson, David L., et al. "A standard test set for numerical approximations to the shallow water equations in spherical geometry." *Journal of Computational Physics* 102.1 (1992): 211-224.
+
+
+

src/Core/Spherepack/README.txt

@@ -0,0 +1,4 @@
+From Deltares
+Commit e80da29462c5987162a0884baaab7434d0215467 of https://github.com/jlokimlin/spherepack/tree/e80da29462c5987162a0884baaab7434d0215467
+
+Modified to fix compiler errors in intel fortran (e.g., public declared twice).