Skip to content

Commit

Permalink
Add kwargs doc
Browse files Browse the repository at this point in the history
  • Loading branch information
henry2004y committed Jan 30, 2022
1 parent db4ceb4 commit 758f051
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions src/FieldTracer.jl
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
module FieldTracer

# Hongyang Zhou, [email protected]

using Meshes, Requires, MuladdMacro

export trace
Expand All @@ -20,15 +18,16 @@ include("utility/seed.jl")
"""
trace(fieldx, fieldy, startx, starty, gridx, gridy; alg=RK4(), kwargs...)
Stream tracing on structured mesh with field in 2D array and grid in range.
Stream tracing on structured mesh with field in 2D array and grid in range. The keyword
arguments are the same as in [`trace2d_euler`](@ref) and [`trace2d_rk4`](@ref).
"""

"""
trace(fieldx, fieldy, fieldz, startx, starty, startz, gridx, gridy, gridz;
alg=RK4(), kwargs...)
trace(fieldx, fieldy, fieldz, startx, starty, startz, grid::CartesianGrid;
alg=RK4(), maxstep=20000, ds=0.01, gridType="ndgrid", direction="both")
alg=RK4(), maxstep=20000, ds=0.01, gridtype="ndgrid", direction="both")
Stream tracing on structured mesh with field in 3D array and grid in range.
"""
Expand Down

0 comments on commit 758f051

Please sign in to comment.