Skip to content

Latest commit

 

History

42 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

codecov CI Documentation GitHub License

Overview

A Julia package for numerical computation of vector calculus operations in arbitrary orthogonal curvilinear coordinate systems. Currently implements gradient, curl, divergence, and Laplacian functions.

Example

In the Julia REPL:

julia> using VectorCalculus

julia> f(point) = point[1]^2
f (generic function with 1 method)

julia> laplacian(f, [3.0, pi/3, pi/4], Spherical())
6.0

julia> gradient(f, [2.0, pi/4, 1.0], Cylindrical())
3-element SVector{3, Float64} with indices SOneTo(3):
 4.0
 0.0
 0.0

As of version 0.1.0, vector-valued results from this package's return in the local curvilinear basis of the supplied coordinate system, not just Cartesian components.

Installation

] add VectorCalculus

Documentation

See https://michaeljhanley.github.io/VectorCalculus.jl

Contributing

See https://github.com/michaeljhanley/VectorCalculus.jl/blob/main/CONTRIBUTING.md

Development Notes

Initial development of this package incorporated LLMs as a targeted writing and debugging aid. Generative tools helped draft docstrings and format LaTeX and KaTeX equations for the documentation. They also provided a second opinion on architecture, logic, and syntax while assisting with bug fixes. No autonomous agents were used. Every line was typed or pasted in manually, and all code was thoroughly verified before committing.

License

This project is licensed under the terms of the MIT license.

About

A Julia package for differential operators and general vector calculus across custom coordinate systems.

Topics

Resources

Contributing

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages