Jan Petykiewicz
4b798893bc

4 years ago  

opencl_fdfd  4 years ago  
.gitignore  6 years ago  
LICENSE.md  6 years ago  
README.md  5 years ago  
setup.py  4 years ago 
README.md
opencl_fdfd
opencl_fdfd is a 3D Finite Difference Frequency Domain (FDFD) electromagnetic solver implemented in Python and OpenCL.
Capabilities:
 Arbitrary distributions of the following:
 Dielectric constant (
epsilon
)  Magnetic permeabilty (
mu
)  Perfect electric conductor (
PEC
)  Perfect magnetic conductor (
PMC
)
 Dielectric constant (
 Variablesized rectangular grids
 Stretchedcoordinate PMLs (complex cell sizes allowed)
Currently, only periodic boundary conditions are included. PEC/PMC boundaries can be implemented by drawing PEC/PMC cells near the edges. Bloch boundary conditions are not included but wouldn't be very hard to add.
The default solver opencl_fdfd.cg_solver(...)
located in main.py
implements the Efield wave operator directly (ie, as a list of OpenCL
instructions rather than a matrix). Additionally, there is a slower
(and slightly more versatile) solver in csr.py
which attempts to solve
an arbitrary sparse matrix in compressed sparse row (CSR) format using
the same conjugate gradient method as the default solver. The CSR solver
is significantly slower, but can be very useful for testing alternative
formulations of the FDFD electromagnetic wave equation.
Currently, this solver only uses a single GPU or other OpenCL accelerator; generalization to multiple GPUs should be pretty straightforward (ie, just copy over edge values during the matrix multiplication step).
Installation
Dependencies:
 python 3 (written and tested with 3.5)
 numpy
 pyopencl
 jinja2
 fdfd_tools (>=0.2)
Install with pip, via git:
pip install git+https://mpxd.net/code/jan/opencl_fdfd.git@release
Use
See the documentation for opencl_fdfd.cg_solver(...)
(located in main.py
) for details about how to call the solver.
The FDFD arguments are identical to those in
fdfd_tools.solvers.generic(...)
, and a few solverspecific
arguments are available.
An alternate (slower) FDFD solver and a general gpubased sparse matrix
solver is available in csr.py
. These aren't particularly
welloptimized, and something like
MAGMA would probably be a
better choice if you absolutely need to solve arbitrary sparse matrices
and can tolerate writing and compiling C/C++ code. Still, they're
usually quite a bit faster than the scipy.linalg solvers.