Skip to content

Commit

Permalink
Fix doc keywords display
Browse files Browse the repository at this point in the history
  • Loading branch information
henry2004y committed Nov 23, 2022
1 parent 3e232bb commit b76474b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 18 deletions.
7 changes: 2 additions & 5 deletions src/utility/fluxfunction.jl
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,8 @@ Find X-point and O-point indices in 2D magnetic field topology from flux functio
The current implementation does not work for the 3 layers near the boundary.
# Keywords
- `retol=1e-1`: determines the relative tolerance of the ratio w.r.t. |∇ψ|² to accept a
gradient as 0.
- `method=1`: method 1 compute the cell-centered 1st and 2nd order derivatives and check the
Hessian matrix; method 2 check the flux function at each point against its 8 neighbors,
which is more deterministic.
- `retol=1e-1`: determines the relative tolerance of the ratio w.r.t. |∇ψ|² to accept a gradient as 0.
- `method=1`: method 1 compute the cell-centered 1st and 2nd order derivatives and check the Hessian matrix; method 2 check the flux function at each point against its 8 neighbors, which is more deterministic.
"""
function find_reconnection_points::Array{T,2}; retol::Float64=1e-4, method::Int=1) where T
indices_x = Matrix{Int}(undef, 2, 0)
Expand Down
11 changes: 3 additions & 8 deletions src/utility/plot.jl
Original file line number Diff line number Diff line change
Expand Up @@ -234,15 +234,10 @@ and strings of labels and titles for VDF plots.
- `unit::AxisUnit`: location unit in `SI`, `EARTH`.
- `unitv::String`: velocity unit in ("km/s", "m/s").
- `limits::Vector{Real}`: velocity space range given in [xmin, xmax, ymin, ymax].
- `slicetype`: symbol for choosing the slice type from `:xy`, `:xz`, `:yz`,
`:bperp`, `:bpar1`, `:bpar2`.
- `slicetype`: symbol for choosing the slice type from `:xy`, `:xz`, `:yz`, `:bperp`, `:bpar1`, `:bpar2`.
- `center`: symbol for setting the reference frame from `:bulk`, `:peak`.
- `vslicethick`: setting the velocity space slice thickness in the normal direction. If set
to 0, the whole distribution along the normal direction is projected onto a plane. Currently
this is only meaningful when `center` is set such that a range near the bulk/peak normal
velocity is selected!
- `weight::Symbol`: choosing distribution weights from phase space density or particle flux
between `:particle` and `:flux`.
- `vslicethick`: setting the velocity space slice thickness in the normal direction. If set to 0, the whole distribution along the normal direction is projected onto a plane. Currently this is only meaningful when `center` is set such that a range near the bulk/peak normal velocity is selected.
- `weight::Symbol`: choosing distribution weights from phase space density or particle flux between `:particle` and `:flux`.
- `flimit`: minimum VDF threshold for plotting.
- `verbose`: display the selection process.
"""
Expand Down
9 changes: 4 additions & 5 deletions src/vlsv/vlsvutility.jl
Original file line number Diff line number Diff line change
Expand Up @@ -430,9 +430,9 @@ getpressure(meta::MetaVLSV, vcellids::Vector{Int32}, vcellf::Vector{<:AbstractFl
getpressure(meta.meshes[species], vcellids, vcellf)

"""
getheatfluxvector(meta, VDF; species="proton")
getheatfluxvector(meta, vcellids, vcellf; species="proton")
getheatfluxvector(vmesh::VMeshInfo, vcellids, vcellf)
getheatfluxvector(meta, VDF; species="proton")
getheatfluxvector(meta, vcellids, vcellf; species="proton")
getheatfluxvector(vmesh::VMeshInfo, vcellids, vcellf)
Get heat flux vector (3 components) of `species` from `VDF` associated with `meta`,
qᵢ = m/2 * ∫ (v - u)²(v - u)ᵢ * f(r,v) dV. Alternatively, one can directly pass `vcellids`,
Expand Down Expand Up @@ -1337,8 +1337,7 @@ Save `data` of name `vars` at AMR `level` into VTK image file of name `file`.
- `vtkGhostType::Array{UInt8}`: array for visibility control.
- `level::Int`: refinement level (0-based).
- `ascii::Bool=false`: save output in ASCII or binary format.
- `append::Bool=true`: determines whether to append data at the end of file or do in-block
writing.
- `append::Bool=true`: determines whether to append data at the end of file or do in-block writing.
- `box::Vector`: selected box range in 3D.
"""
function save_image(meta::MetaVLSV, file::String, vars::Vector{String},
Expand Down

0 comments on commit b76474b

Please sign in to comment.