Skip to content

Commit b8db4a7

Browse files
jacobwilliamsjacobwilliams
committed
Minor documentation changes. Now only displaying public entities in API documentation.
Added private to the bspline base class.
1 parent 150b234 commit b8db4a7

File tree

3 files changed

+28
-26
lines changed

3 files changed

+28
-26
lines changed

‎bspline-fortran.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ predocmark: <
1010
docmark_alt:
1111
docmark: !
1212
display: public
13-
protected
14-
none
1513
source: true
1614
graph: true
15+
exclude: test_oo.f90
16+
test_regrid.f90
17+
test.f90
1718

1819
Brief description
1920
---------------

‎src/bspline_oo_module.f90‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,11 @@ module bspline_oo_module
2323
private
2424

2525
type,public,abstract :: bspline_class
26-
!! base class for the b-spline types
27-
integer :: inbvx = 1
26+
!! Base class for the b-spline types
27+
private
28+
integer :: inbvx = 1 !! internal variable used by dbvalu for efficient processing
2829
contains
29-
procedure(destroy_func),deferred :: destroy !! destructor
30+
procedure(destroy_func),deferred,public :: destroy !! destructor
3031
end type bspline_class
3132

3233
abstract interface

‎src/bspline_sub_module.f90‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ subroutine db1val(xval,idx,tx,nx,kx,bcoef,f,iflag,inbvx_in)
167167
real(wp),dimension(nx),intent(in) :: bcoef !! the b-spline coefficients computed by db1ink.
168168
real(wp),intent(out) :: f !! interpolated value
169169
integer,intent(out) :: iflag !! status flag: 0 : no errors, /=0 : error
170-
integer,intent(in),optional :: inbvx_in !! inbvx initialization parameter from class
170+
integer,intent(in),optional :: inbvx_in !! inbvx initialization parameter from class (used by object-oriented interface)
171171

172172
real(wp),dimension(3*kx) :: work
173173

@@ -358,8 +358,8 @@ subroutine db2val(xval,yval,idx,idy,tx,ty,nx,ny,kx,ky,bcoef,f,iflag,inbvx_in,ilo
358358
real(wp),dimension(nx,ny),intent(in) :: bcoef !! the b-spline coefficients computed by db2ink.
359359
real(wp),intent(out) :: f !! interpolated value
360360
integer,intent(out) :: iflag !! status flag: 0 : no errors, /=0 : error
361-
integer,intent(in),optional :: inbvx_in !! inbvx initialization parameter from class
362-
integer,intent(in),optional :: iloy_in !! iloy initialization parameter from class
361+
integer,intent(in),optional :: inbvx_in !! inbvx initialization parameter from class (used by object-oriented interface)
362+
integer,intent(in),optional :: iloy_in !! iloy initialization parameter from class (used by object-oriented interface)
363363

364364
integer :: inbv, k, lefty, mflag, kcol
365365
real(wp),dimension(ky) :: temp
@@ -597,9 +597,9 @@ subroutine db3val(xval,yval,zval,idx,idy,idz,&
597597
real(wp),dimension(nx,ny,nz),intent(in) :: bcoef !! the b-spline coefficients computed by db3ink.
598598
real(wp),intent(out) :: f !! interpolated value
599599
integer,intent(out) :: iflag !! status flag: 0 : no errors, /=0 : error
600-
integer,intent(in),optional :: inbvx_in !! inbvx initialization parameter from class
601-
integer,intent(in),optional :: iloy_in !! iloy initialization parameter from class
602-
integer,intent(in),optional :: iloz_in !! iloz initialization parameter from class
600+
integer,intent(in),optional :: inbvx_in !! inbvx initialization parameter from class (used by object-oriented interface)
601+
integer,intent(in),optional :: iloy_in !! iloy initialization parameter from class (used by object-oriented interface)
602+
integer,intent(in),optional :: iloz_in !! iloz initialization parameter from class (used by object-oriented interface)
603603

604604
real(wp),dimension(ky,kz) :: temp1
605605
real(wp),dimension(kz) :: temp2
@@ -810,10 +810,10 @@ subroutine db4val(xval,yval,zval,qval,&
810810
real(wp),dimension(nx,ny,nz,nq),intent(in) :: bcoef !! the b-spline coefficients computed by db4ink.
811811
real(wp),intent(out) :: f !! interpolated value
812812
integer,intent(out) :: iflag !! status flag: 0 : no errors, /=0 : error
813-
integer,intent(in),optional :: inbvx_in !! inbvx initialization parameter from class
814-
integer,intent(in),optional :: iloy_in !! iloy initialization parameter from class
815-
integer,intent(in),optional :: iloz_in !! iloz initialization parameter from class
816-
integer,intent(in),optional :: iloq_in !! iloq initialization parameter from class
813+
integer,intent(in),optional :: inbvx_in !! inbvx initialization parameter from class (used by object-oriented interface)
814+
integer,intent(in),optional :: iloy_in !! iloy initialization parameter from class (used by object-oriented interface)
815+
integer,intent(in),optional :: iloz_in !! iloz initialization parameter from class (used by object-oriented interface)
816+
integer,intent(in),optional :: iloq_in !! iloq initialization parameter from class (used by object-oriented interface)
817817

818818
real(wp),dimension(ky,kz,kq) :: temp1
819819
real(wp),dimension(kz,kq) :: temp2
@@ -1064,11 +1064,11 @@ subroutine db5val(xval,yval,zval,qval,rval,&
10641064
real(wp),dimension(nx,ny,nz,nq,nr),intent(in) :: bcoef !! the b-spline coefficients computed by db5ink.
10651065
real(wp),intent(out) :: f !! interpolated value
10661066
integer,intent(out) :: iflag !! status flag: 0 : no errors, /=0 : error
1067-
integer,intent(in),optional :: inbvx_in !! inbvx initialization parameter from class
1068-
integer,intent(in),optional :: iloy_in !! iloy initialization parameter from class
1069-
integer,intent(in),optional :: iloz_in !! iloz initialization parameter from class
1070-
integer,intent(in),optional :: iloq_in !! iloq initialization parameter from class
1071-
integer,intent(in),optional :: ilor_in !! ilor initialization parameter from class
1067+
integer,intent(in),optional :: inbvx_in !! inbvx initialization parameter from class (used by object-oriented interface)
1068+
integer,intent(in),optional :: iloy_in !! iloy initialization parameter from class (used by object-oriented interface)
1069+
integer,intent(in),optional :: iloz_in !! iloz initialization parameter from class (used by object-oriented interface)
1070+
integer,intent(in),optional :: iloq_in !! iloq initialization parameter from class (used by object-oriented interface)
1071+
integer,intent(in),optional :: ilor_in !! ilor initialization parameter from class (used by object-oriented interface)
10721072

10731073
real(wp),dimension(ky,kz,kq,kr) :: temp1
10741074
real(wp),dimension(kz,kq,kr) :: temp2
@@ -1351,12 +1351,12 @@ subroutine db6val(xval,yval,zval,qval,rval,sval,&
13511351
real(wp),dimension(nx,ny,nz,nq,nr,ns),intent(in) :: bcoef !! the b-spline coefficients computed by db6ink.
13521352
real(wp),intent(out) :: f !! interpolated value
13531353
integer,intent(out) :: iflag !! status flag: 0 : no errors, /=0 : error
1354-
integer,intent(in),optional :: inbvx_in !! inbvx initialization parameter from class
1355-
integer,intent(in),optional :: iloy_in !! iloy initialization parameter from class
1356-
integer,intent(in),optional :: iloz_in !! iloz initialization parameter from class
1357-
integer,intent(in),optional :: iloq_in !! iloq initialization parameter from class
1358-
integer,intent(in),optional :: ilor_in !! ilor initialization parameter from class
1359-
integer,intent(in),optional :: ilos_in !! ilos initialization parameter from class
1354+
integer,intent(in),optional :: inbvx_in !! inbvx initialization parameter from class (used by object-oriented interface)
1355+
integer,intent(in),optional :: iloy_in !! iloy initialization parameter from class (used by object-oriented interface)
1356+
integer,intent(in),optional :: iloz_in !! iloz initialization parameter from class (used by object-oriented interface)
1357+
integer,intent(in),optional :: iloq_in !! iloq initialization parameter from class (used by object-oriented interface)
1358+
integer,intent(in),optional :: ilor_in !! ilor initialization parameter from class (used by object-oriented interface)
1359+
integer,intent(in),optional :: ilos_in !! ilos initialization parameter from class (used by object-oriented interface)
13601360

13611361
real(wp),dimension(ky,kz,kq,kr,ks) :: temp1
13621362
real(wp),dimension(kz,kq,kr,ks) :: temp2

0 commit comments

Comments
 (0)