Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lkedward/focal
A modern Fortran abstraction layer for OpenCL
https://github.com/lkedward/focal
fortran fortran-library fortran-modules fortran2003 fortran2008 opencl opencl-api
Last synced: 12 days ago
JSON representation
A modern Fortran abstraction layer for OpenCL
- Host: GitHub
- URL: https://github.com/lkedward/focal
- Owner: LKedward
- License: mit
- Created: 2019-10-28T11:13:11.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-14T14:35:04.000Z (over 1 year ago)
- Last Synced: 2023-07-14T16:08:30.994Z (over 1 year ago)
- Topics: fortran, fortran-library, fortran-modules, fortran2003, fortran2008, opencl, opencl-api
- Language: Fortran
- Homepage: https://lkedward.github.io/focal-docs
- Size: 2.47 MB
- Stars: 37
- Watchers: 4
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# Focal
[](https://opensource.org/licenses/MIT)
[](https://github.com/LKedward/focal/actions)
[](https://codecov.io/gh/LKedward/focal)
## *A modern Fortran abstraction layer for OpenCL*
Focal is a module library which wraps calls to the OpenCL runtime API (using [clfortran](https://github.com/cass-support/clfortran)) with a higher abstraction level appropriate to the Fortran language.
The goal of Focal is to provide a concise and accessible Fortran interface to the OpenCL API while retaining the full functionality thereof.
This is desirable in Fortran which as a language provides a higher level of abstraction than C; importantly this allows scientists and engineers to focus on their domain specific problem rather than details of low-level implementation.
__Key features:__
* Removes use of c pointers to call OpenCL API
* Provides a level of type safety using typed buffer objects
* Decreases verbosity of OpenCL API calls while still providing the same functionality
* Abstracts away low level details, such as size in bytes
* Contains built-in customisable error handling for all OpenCL API calls
* Contains built-in 'debug' mode for checking program correctness
* Contains build-in routines for collecting and presented profiling information
__Project status:__ v1.0.1 stable release
__Documentation__: [lkedward.github.io/focal-docs](https://lkedward.github.io/focal-docs/)
__License__: [MIT](./LICENSE)
__Prerequisites:__
- [GNU make](https://www.gnu.org/software/make/) utility
- Fortran compiler supporting the 2008 standard (tested in the CI with `gfortran` 9.3.0 and `ifort` (oneAPI) 21.3.0 )
- An OpenCL development library (One of:
[Intel OpenCL SDK](https://software.intel.com/en-us/opencl-sdk),
[NVIDIA CUDA Toolkit](https://developer.nvidia.com/cuda-downloads),
[AMD Radeon Software](https://www.amd.com/en/support) )
## Getting started
* [Building the Focal Library](https://lkedward.github.io/focal-docs/build)
* [Using and linking Focal](https://lkedward.github.io/focal-docs/linking/)
* [Quickstart programming guide](https://lkedward.github.io/focal-docs/quickstart/)
* [Example programs](./examples)
* [Lattice Boltzmann demo](https://github.com/LKedward/lbm2d_opencl)
## Quick example
The following fortran program calculates the sum of two large arrays using an OpenCL kernel.
```fortran
program sum
!! Focal example program: calculate the sum of two arrays on an OpenCL device
use Focal
implicit none
integer, parameter :: Nelem = 1E6 ! No. of array elements
real, parameter :: sumVal = 10.0 ! Target value for array sum
integer :: i ! Counter variable
character(:), allocatable :: kernelSrc ! Kernel source string
type(fclDevice) :: device ! Device object
type(fclProgram) :: prog ! Focal program object
type(fclKernel) :: sumKernel ! Focal kernel object
real :: array1(Nelem) ! Host array 1
real :: array2(Nelem) ! Host array 2
type(fclDeviceFloat) :: array1_d ! Device array 1
type(fclDeviceFloat) :: array2_d ! Device array 2
! Select device with most cores and create command queue
device = fclInit(vendor='nvidia',sortBy='cores')
call fclSetDefaultCommandQ(fclCreateCommandQ(device,enableProfiling=.true.))
! Load kernel from file and compile
call fclSourceFromFile('examples/sum.cl',kernelSrc)
prog = fclCompileProgram(kernelSrc)
sumKernel = fclGetProgramKernel(prog,'sum')
! Initialise device arrays
call fclInitBuffer(array1_d,Nelem)
call fclInitBuffer(array2_d,Nelem)
! Initialise host array data
do i=1,Nelem
array1(i) = i
end do
array2 = sumVal - array1
! Copy data to device
array1_d = array1
array2_d = array2
! Set global work size equal to array length and launch kernel
sumKernel%global_work_size(1) = Nelem
call sumKernel%launch(Nelem,array1_d,array2_d)
! Copy result back to host and print out to check
array2 = array2_d
write(*,*) array2(1), array2(size(array2,1))
end program sum
```
Where `sum.cl` contains the following openCL kernel:
```openCL
__kernel void sum(const int nElem, const __global float * v1, __global float * v2){
int i = get_global_id(0);
if(i < nElem) v2[i] += v1[i];
}
```
## Bundled third-party sources
The following open source libraries are used as dependencies and bundled in the repository ([./external](https://github.com/LKedward/focal/tree/master/external)):
* [fortran-utils](https://github.com/certik/fortran-utils)/[sorting](https://github.com/certik/fortran-utils/blob/master/src/sorting.f90) (MIT license)
* [clfortran](https://github.com/cass-support/clfortran) (LGPL)
* [M_strings](https://github.com/urbanjost/M_strings) (Unlicense/Public domain)
## Acknowledgement
_This work was funded by the MENtOR project, a UKVLN project
supported by the Engineering and Physical Sciences Research
Council (EPSRC) of the UK. Grant reference number
EP/S010378/1_.