Skip to content
This repository was archived by the owner on Jul 19, 2023. It is now read-only.

Commit 3a55dd6

Browse files
Merge pull request #368 from mjsheikh/docs
docs update
2 parents 2792e85 + fa2a057 commit 3a55dd6

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

docs/src/operators/derivative_operators.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ CenteredDifference{N}(derivative_order::Int,
9696

9797
UpwindDifference{N}(derivative_order::Int,
9898
approximation_order::Int, dx
99-
len::Int, coeff_func=nothing)
99+
len::Int, coeff_func=nothing; offside::Int=0)
100100
```
101101

102102
The arguments are:
@@ -114,6 +114,9 @@ The arguments are:
114114
then the coefficients are set to be constant with that number. If `coeff_func`
115115
is an `AbstractArray` with length matching `len`, then the coefficients are
116116
constant but spatially dependent.
117+
- `offside`: A keyword argument for `UpwindDifference` which sets the number of offside
118+
points against the primary wind direction allowing it to have some bias/offset. Number
119+
of points used for approximation remain same. By default its `0`.
117120

118121
`N`-dimensional derivative operators need to act against a value of at least
119122
`N` dimensions.

0 commit comments

Comments
 (0)