Metadata-Version: 2.1
Name: filamentlib
Version: 0.1.2
Summary: Simulate the evolution of any given vortex filament over time
Author: Daniel Krawciw
Author-email: dkrawciw@mines.edu
License: MIT
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy >=1.26
Requires-Dist: scipy >=1.13.0

# Vortex Filament Simulation

Creating a Vortex Filament Simulation using Python

## How to use the library

Functions:

- BiotSavart( curve, curveTangent, fieldPoints )
- RegularBiotSavart( curve, curveTangent, fieldPoints, *epsilon* )
- KappaBinormal( curve, meshpoints )
- EvolveKappaBinormal( curve, meshpoints, tspan, *method* )
- EvolveRegularBiotSavart( curve, meshpoints, eps, tspan, *method* )

### EvolveKappaBinormal

Example Code:

    from filamentlib import EvolveKappaBinormal

    # Creating the initial curve with 100 initial meshpoints from -pi to pi
    meshpoints = np.linspace(-np.pi,np.pi,100,endpoints=False)  
    f = lambda t: [ np.cos(t), np.sin(t), t*0 ]  
    curve = np.array( f(meshpoints) )

    # Integrator Settings
    tspan = [0,10]  
    method = "rk23"     # By default the method is rk23  

    evolvedCurve = EvolveKappaBinormal( curve, meshpoints, tspan, method )

