Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@DurhamDecLab
DurhamDecLab committed Feb 15, 2019
1 parent c80897a commit 5791a36
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ Usage

Instantiate the 'tricubic' class by passing a loaded field to it. It is not necessary to order the x, y, z coordinates - the code will do that itself.

NOTE: a regular field (i.e. with equal grid spacing in all dimensions) must be supplied. The interpolant field does not have to be cubic, only cuboid.
NOTE: a regular field (i.e. with equal grid spacing in all dimensions) must be supplied. The spacing along all axes does not have to match, only be consistent along each.

The interpolant field does not have to be cubic, only cuboid.

If an N x 4 array is passed it will operate in scalar mode and return both the interpolated field magnitude and partial derivatives.

Expand Down

0 comments on commit 5791a36

Please sign in to comment.