dummy-link

uFDTD

Simple FDTD solver in Julia, based on uFDTD from John B. Schneider.

Readme

uFDTD.jl

Implementation of a simple FDTD solver, based on Understanding the Finite-Difference Time-Domain Method, John B. Schneider.

Package status

macOS Linux Windows
Build Status Build Status Build status

Setup

To run code in the package directly

Start julia with julia --project=. from inside this git repo.

To setup this package as a library in your own code

Until this package gets registered, you cannot simply do pkg> add uFDTD. Instead, activate your environment and do once per system:

(scratch) pkg> develop --local ~/path/to/uFDTD.jl

Usage

using uFDTD

# Define simulation parameters (use many default values, see uFDTDParameters).
sim_params = uFDTDParameters()

# Run simulation.
p0, p1 = uFDTD.simulate(sim_params)

# display probes
using PyPlot
figure(); plot(p0);
figure(); imshow(p1); colorbar();

Tests

(scratch) pkg> test uFDTD

Documentation

We use Documenter.jl as our doc builder, please install it first.

(scratch) pkg> add Documenter

Then, build the documentation.

$ cd docs
$ make

The generated doc is located at docs/build. Visualize it:

$ open docs/build/index.html

First Commit

06/13/2018

Last Touched

about 2 months ago

Commits

23 commits

Requires:

Used By: