Skip to content

Commit d95bc7a

Browse files
committed
updated readme.
1 parent fbcb1f1 commit d95bc7a

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,16 @@ subroutine db6val(xval,yval,zval,qval,rval,sval,idx,idy,idz,idq,idr,ids,tx,ty,tz
3838

3939
The ```ink``` routines compute the interpolant coefficients, and the ```val``` routines evalute the interpolant at the specified value of each coordinate. Eventually, object-oriented wrappers will be created for these routines for ease of use. The 2D and 3D routines are extensively refactored versions of the original routines from the [NIST Core Math Library](http://www.nist.gov/itl/math/mcsd-software.cfm). The others are new, and are simply extensions of the same algorithm into higher dimensions.
4040

41+
In addition to the main subroutines, an object-oriented wrapper is also provided. For example:
42+
43+
```Fortran
44+
type(bspline_3d) :: s3
45+
call s3%initialize(x,y,z,fcn,kx,ky,kz,iflag)
46+
call s3%evaluate(xval,yval,zval,idx,idy,idz,f,iflag)
47+
call s3%destroy()
48+
```
49+
See the examples for more details.
50+
4151
# Compiling
4252

4353
A simple bash script ```build.sh``` is provided for building bspline-fortran with gfortran using [FoBiS](https://github.com/szaghi/FoBiS). It also builds the API documentation using [FORD](https://github.com/cmacmackin/ford).

0 commit comments

Comments
 (0)