doc: Add :: after TBP procedure fix links

developer-doc/FD-API.md

@@ -46,7 +46,7 @@ links to detailed API documentation and their implementations.
 This needs updating/finishing
 
 
-### `[[object(type)]]`
+### [[object(type)]]
 
 `[[object(type)]]` is an abstract type to ensure descendents declare the required deferred bindings to
 
@@ -55,7 +55,9 @@ This needs updating/finishing
 * `[[object(type):mark_as_defined]]` : Set the object as defined
 * `[[object(type):user_defined]]` : Query whether the object is defined
 
-### grid
+### [[grid(type)]]
+
+`[[grid(type)]]`
 
 
 ### matptr

src/FD/grid/cartesian_grid_interface.f90

@@ -19,14 +19,14 @@ module cartesian_grid_interface
 
   type, extends(structured_grid) :: cartesian_grid
   contains
-    procedure set_up_div_scalar_flux
-    procedure div_scalar_flux
-    procedure assign_structured_grid
-    procedure block_indicial_coordinates
-    procedure block_identifier
-    procedure build_surfaces
-    procedure block_identifier_in_bounds
-    procedure block_coordinates_in_bounds
+    procedure :: set_up_div_scalar_flux
+    procedure :: div_scalar_flux
+    procedure :: assign_structured_grid
+    procedure :: block_indicial_coordinates
+    procedure :: block_identifier
+    procedure :: build_surfaces
+    procedure :: block_identifier_in_bounds
+    procedure :: block_coordinates_in_bounds
   end type
 
   interface

src/FD/grid/ellipsoidal_field_interface.f90

@@ -18,8 +18,8 @@ module ellipsoidal_field_interface
 
   type, extends(differentiable_field) :: ellipsoidal_field
   contains
-    procedure evaluate
-    procedure laplacian
+    procedure :: evaluate
+    procedure :: laplacian
   end type
 
   interface

src/FD/grid/grid_interface.F90

@@ -21,8 +21,8 @@ module grid_interface
         private
         type(units) :: units_
     contains
-        procedure set_units
-        procedure get_units
+        procedure :: set_units
+        procedure :: get_units
     end type
 
     interface

src/FD/grid/package_interface.F90

@@ -34,14 +34,14 @@ module package_interface
     real(r8k), allocatable, dimension(:,:,:) :: positions
       !! flux planar locations: shape = [Nx, Ny, Nz], where one of Nx|Ny|Nz is 1, denoting the surface-normal direction
   contains
-    procedure set_neighbor_block_id
-    procedure set_step
-    procedure set_surface_flux_positions
-    procedure set_num_scalars
-    procedure set_normal_scalar_fluxes
-    procedure get_neighbor_block_id
-    procedure neighbor_block_id_null
-    procedure copy
+    procedure :: set_neighbor_block_id
+    procedure :: set_step
+    procedure :: set_surface_flux_positions
+    procedure :: set_num_scalars
+    procedure :: set_normal_scalar_fluxes
+    procedure :: get_neighbor_block_id
+    procedure :: neighbor_block_id_null
+    procedure :: copy
 #ifndef FORD
     generic :: assignment(=) => copy
 #endif

src/FD/grid/problem_discretization_interface.F90

@@ -39,20 +39,20 @@ module problem_discretization_interface
     class(geometry), allocatable :: problem_geometry
       !! description of problem domain and material identities; child types: plate_3D, cylinder_2D, sphere_1D
   contains
-    procedure get_surface_packages
-    procedure get_block_surfaces
-    procedure get_global_block_shape
-    procedure partition
-    procedure my_blocks
-    procedure block_indicial_coordinates
-    procedure block_identifier
-    procedure block_load
-    procedure user_defined_vertices
-    procedure set_analytical_scalars
-    procedure num_scalars
-    procedure num_scalar_flux_divergences
-    procedure initialize_from_plate_3D
-    procedure set_scalar_flux_divergence
+    procedure :: get_surface_packages
+    procedure :: get_block_surfaces
+    procedure :: get_global_block_shape
+    procedure :: partition
+    procedure :: my_blocks
+    procedure :: block_indicial_coordinates
+    procedure :: block_identifier
+    procedure :: block_load
+    procedure :: user_defined_vertices
+    procedure :: set_analytical_scalars
+    procedure :: num_scalars
+    procedure :: num_scalar_flux_divergences
+    procedure :: initialize_from_plate_3D
+    procedure :: set_scalar_flux_divergence
 #ifndef FORD
     generic :: set_vertices => user_defined_vertices
     generic :: set_scalars => set_analytical_scalars

src/FD/grid/structured_grid_interface.F90

@@ -43,31 +43,31 @@ module structured_grid_interface
     procedure(block_id_in_bounds_interface), deferred :: block_identifier_in_bounds
     procedure(block_ijk_in_bounds_interface), deferred :: block_coordinates_in_bounds
     generic :: block_in_bounds => block_identifier_in_bounds, block_coordinates_in_bounds
-    procedure set_global_block_shape
-    procedure get_global_block_shape
-    procedure clone
-    procedure diffusion_coefficient
-    procedure write_formatted
-    procedure space_dimension
-    procedure free_tensor_indices
-    procedure num_cells
-    procedure num_time_stamps
-    procedure vectors
-    procedure get_scalar
-    procedure set_metadata
-    procedure get_tag
-    procedure set_vector_components
-    procedure set_scalar
-    procedure increment_scalar
-    procedure subtract
+    procedure :: set_global_block_shape
+    procedure :: get_global_block_shape
+    procedure :: clone
+    procedure :: diffusion_coefficient
+    procedure :: write_formatted
+    procedure :: space_dimension
+    procedure :: free_tensor_indices
+    procedure :: num_cells
+    procedure :: num_time_stamps
+    procedure :: vectors
+    procedure :: get_scalar
+    procedure :: set_metadata
+    procedure :: get_tag
+    procedure :: set_vector_components
+    procedure :: set_scalar
+    procedure :: increment_scalar
+    procedure :: subtract
 #ifndef FORD
     generic :: operator(-) => subtract
 #endif
-    procedure compare
+    procedure :: compare
 #ifdef HAVE_UDDTIO
     generic :: write(formatted) => write_formatted
 #endif
-    procedure set_block_identifier
+    procedure :: set_block_identifier
   end type
 
   abstract interface

src/FD/grid/units_interface.F90

@@ -41,27 +41,27 @@ module units_interface
     integer :: system=dimensionless  !! Default to SI units
     character(len=:), allocatable :: description
   contains
-    procedure set_units
-    procedure get_units
-    procedure get_system
-    procedure is_dimensionless
-    procedure has_length_units
-    procedure has_mass_units
-    procedure has_time_units
-    procedure has_temperature_units
-    procedure has_velocity_units
-    procedure has_energy_units
-    procedure has_density_units
-    procedure has_specific_energy_units
-    procedure has_stress_units
-    procedure has_power_units
-    procedure add
-    procedure multiply
-    procedure divide
-    procedure subtract,negate
-    procedure integer_power
-    procedure real_power
-    procedure assign_units
+    procedure :: set_units
+    procedure :: get_units
+    procedure :: get_system
+    procedure :: is_dimensionless
+    procedure :: has_length_units
+    procedure :: has_mass_units
+    procedure :: has_time_units
+    procedure :: has_temperature_units
+    procedure :: has_velocity_units
+    procedure :: has_energy_units
+    procedure :: has_density_units
+    procedure :: has_specific_energy_units
+    procedure :: has_stress_units
+    procedure :: has_power_units
+    procedure :: add
+    procedure :: multiply
+    procedure :: divide
+    procedure :: subtract,negate
+    procedure :: integer_power
+    procedure :: real_power
+    procedure :: assign_units
 #ifndef FORD
     generic :: operator(+)=>add
     generic :: operator(*)=>multiply

src/FV/src/bc/class_bc_wall.f90

@@ -60,7 +60,7 @@ MODULE class_bc_wall
 
     IMPLICIT NONE
 
-    PRIVATE ! Default
+    PRIVATE
     PUBLIC :: bc_wall                      !! Class
     PUBLIC :: create_bc_wall, free_bc_wall !! Constructor/Destructor
     PUBLIC :: update_boundary_wall         !! Updater
@@ -114,20 +114,13 @@ END SUBROUTINE get_abc_wall_v
 
 
         MODULE SUBROUTINE set_bc_wall_map_s(bc,i,a,b,c)
-            !! Setter
-    !        USE class_vector
-    !        USE tools_bc
-    !        USE class_bc_math
             IMPLICIT NONE
             CLASS(bc_wall), INTENT(INOUT) :: bc
             INTEGER, INTENT(IN) :: i
             REAL(psb_dpk_), INTENT(IN) :: a, b, c
         END SUBROUTINE set_bc_wall_map_s
 
         MODULE SUBROUTINE set_bc_wall_map_v(bc,i,a,b,c)
-    !        USE class_vector
-    !        USE tools_bc
-    !        USE class_bc_math
             IMPLICIT NONE
             CLASS(bc_wall), INTENT(INOUT) :: bc
             INTEGER, INTENT(IN) :: i
@@ -146,7 +139,6 @@ ELEMENTAL MODULE FUNCTION nemo_bc_wall_sizeof(bc)
         END FUNCTION nemo_bc_wall_sizeof
 
         MODULE SUBROUTINE create_bc_wall(bc,input_file,sec,nbf)
-        !! Constructor
             IMPLICIT NONE
             TYPE(bc_wall), POINTER :: bc
             CHARACTER(len=*), INTENT(IN) :: input_file
@@ -155,7 +147,6 @@ MODULE SUBROUTINE create_bc_wall(bc,input_file,sec,nbf)
         END SUBROUTINE create_bc_wall
 
         MODULE SUBROUTINE free_bc_wall(bc)
-            !! Destructor
             IMPLICIT NONE
 
             TYPE(bc_wall), POINTER :: bc
@@ -164,14 +155,8 @@ END SUBROUTINE free_bc_wall
     END INTERFACE
 
     INTERFACE update_boundary_wall
-        !! Boundary Values Updater
 
         MODULE SUBROUTINE update_boundary_wall_s(ib,bc,dim,msh,mats,im,x,bx)
-    !        USE class_dimensions
-    !        USE class_face
-    !        USE class_material
-    !        USE class_mesh
-    !        USE tools_bc
             IMPLICIT NONE
             INTEGER, INTENT(IN) :: ib
             TYPE(bc_wall), INTENT(IN) :: bc
@@ -189,12 +174,8 @@ MODULE SUBROUTINE update_boundary_wall_v(ib,bc,dim,msh,x,bx)
             !!
             !! @todo
             !! Explain why
+            !!
             !! Number of boundary faces with flag < IB
-    !       USE class_dimensions
-    !       USE class_face
-    !       USE class_mesh
-    !       USE class_vector
-    !       USE tools_bc
             IMPLICIT NONE
             INTEGER, INTENT(IN) :: ib
             TYPE(bc_wall), INTENT(IN) :: bc