type_int_point_3d Module Reference

The type for generic 3D point interpolation that has to be derived.

Data Types
interface	int_point_3d_init
	Abstract interfaces. More...

Functions/Subroutines
subroutine	int_point_3d_construct (self, index_start, index_end, spatial_dimension)
	Initialize a 3D point interpolant.
subroutine	int_point_3d_place (self, x, coordinates_x, coordinates_y, coordinates_z, cv_x, cv_y, cv_z)
	Place (position) the interpolant to the corresponding 'index' given the coordinate 'X' of the point and the discrete nodes. The resulting index corresponds to the node that is just before (less than or equal) the point.
double precision function	int_point_3d_apply (self, values)
	Apply the stencil of the interpolant after it has been placed, given the array of discrete node values. The result is the interpolation.
double precision function	int_point_3d_interpolate (self, x, coordinates_x, coordinates_y, coordinates_z, values, derivatives, cv_x, cv_y, cv_z)
	Directly compute the interpolation at the given position. The result is the interpolation value.
subroutine	int_point_3d_compute_stencil (self, coordinates_x, coordinates_y, coordinates_z, derivatives, cv_x, cv_y, cv_z)
	Compute (fill) the stencil with the X, Y and Z interpolants.
pure double precision function, dimension(3)	int_point_3d_get_x (self)
pure integer function, dimension(3)	int_point_3d_get_index (self)

Function/Subroutine Documentation

int_point_3d_apply()

double precision function type_int_point_3d::int_point_3d_apply	(	class(t_int_point_3d), intent(in)	self,
		double precision, dimension(:,:,:), intent(in)	values )

Parameters

[in]	self	the element
[in]	values	the values in the interval '1:nx,1:ny'

Precondition

- the subroutine 'place' has been previously called

- the subroutine 'compute_stencil' have been previously called

int_point_3d_compute_stencil()

subroutine type_int_point_3d::int_point_3d_compute_stencil	(	class(t_int_point_3d), intent(inout)	self,
		double precision, dimension(:), intent(in)	coordinates_x,
		double precision, dimension(:), intent(in)	coordinates_y,
		double precision, dimension(:), intent(in)	coordinates_z,
		integer, dimension(:), intent(in), optional	derivatives,
		double precision, dimension(:), intent(in), optional	cv_x,
		double precision, dimension(:), intent(in), optional	cv_y,
		double precision, dimension(:), intent(in), optional	cv_z )

Precondition

the subroutine 'place' has been previously called

int_point_3d_place()

subroutine type_int_point_3d::int_point_3d_place	(	class(t_int_point_3d), intent(inout)	self,
		double precision, dimension(3), intent(in)	x,
		double precision, dimension(:), intent(in)	coordinates_x,
		double precision, dimension(:), intent(in)	coordinates_y,
		double precision, dimension(:), intent(in)	coordinates_z,
		double precision, dimension(:), intent(in), optional	cv_x,
		double precision, dimension(:), intent(in), optional	cv_y,
		double precision, dimension(:), intent(in), optional	cv_z )

Warning

if 'X' is less than 'coordinates(1)', then 'index' is set to '1'.

if 'X' is greater than 'coordinates(nx)', then 'index' is set to 'nx'.

Note

the index search algorithm is dichotomic

Precondition

coordinates is ordered and is at least of size 2