interp3Dcomp.c File Reference

Tricubic spline interpolation in compact form. More...

#include <stdlib.h>
#include <math.h>
#include "../ascot5.h"
#include "../consts.h"
#include "interp.h"
#include "spline.h"

Go to the source code of this file.

Functions
int	interp3Dcomp_init_coeff (real *c, real *f, int n_x, int n_y, int n_z, int bc_x, int bc_y, int bc_z, real x_min, real x_max, real y_min, real y_max, real z_min, real z_max)
	Calculate tricubic spline interpolation coefficients for 3D data.
void	interp3Dcomp_init_spline (interp3D_data *str, real *c, int n_x, int n_y, int n_z, int bc_x, int bc_y, int bc_z, real x_min, real x_max, real y_min, real y_max, real z_min, real z_max)
	Initialize a tricubic spline.
int	interp3Dcomp_setup (interp3D_data *str, real *f, int n_x, int n_y, int n_z, int bc_x, int bc_y, int bc_z, real x_min, real x_max, real y_min, real y_max, real z_min, real z_max)
	Set up splines to interpolate 3D scalar data.
a5err	interp3Dcomp_eval_f (real *f, interp3D_data *str, real x, real y, real z)
	Evaluate interpolated value of 3D scalar field.
a5err	interp3Dcomp_eval_df (real *f_df, interp3D_data *str, real x, real y, real z)
	Evaluate interpolated value of 3D field and 1st and 2nd derivatives.

Detailed Description

Tricubic spline interpolation in compact form.

Definition in file interp3Dcomp.c.

Function Documentation

interp3Dcomp_init_coeff()

int interp3Dcomp_init_coeff	(	real *	c,
		real *	f,
		int	n_x,
		int	n_y,
		int	n_z,
		int	bc_x,
		int	bc_y,
		int	bc_z,
		real	x_min,
		real	x_max,
		real	y_min,
		real	y_max,
		real	z_min,
		real	z_max )

Calculate tricubic spline interpolation coefficients for 3D data.

This function calculates the tricubic spline interpolation coefficients for the given data and stores them in an array. Compact cofficients are calculated.

Parameters

c	allocated array of length n_z*n_y*n_x*8 to store the coefficients
f	3D data to be interpolated
n_x	number of data points in the x direction
n_y	number of data points in the y direction
n_z	number of data points in the z direction
bc_x	boundary condition for x axis
bc_y	boundary condition for y axis
bc_z	boundary condition for z axis
x_min	minimum value of the x axis
x_max	maximum value of the x axis
y_min	minimum value of the y axis
y_max	maximum value of the y axis
z_min	minimum value of the z axis
z_max	maximum value of the z axis

Returns

zero if initialization succeeded

Definition at line 37 of file interp3Dcomp.c.

interp3Dcomp_init_spline()

void interp3Dcomp_init_spline	(	interp3D_data *	str,
		real *	c,
		int	n_x,
		int	n_y,
		int	n_z,
		int	bc_x,
		int	bc_y,
		int	bc_z,
		real	x_min,
		real	x_max,
		real	y_min,
		real	y_max,
		real	z_min,
		real	z_max )

Initialize a tricubic spline.

Parameters

str	pointer to spline to be initialized
c	array where coefficients are stored
n_x	number of data points in the x direction
n_y	number of data points in the y direction
n_z	number of data points in the z direction
bc_x	boundary condition for x axis
bc_y	boundary condition for y axis
bc_z	boundary condition for z axis
x_min	minimum value of the x axis
x_max	maximum value of the x axis
y_min	minimum value of the y axis
y_max	maximum value of the y axis
z_min	minimum value of the z axis
z_max	maximum value of the z axis

Definition at line 203 of file interp3Dcomp.c.

interp3Dcomp_setup()

int interp3Dcomp_setup	(	interp3D_data *	str,
		real *	f,
		int	n_x,
		int	n_y,
		int	n_z,
		int	bc_x,
		int	bc_y,
		int	bc_z,
		real	x_min,
		real	x_max,
		real	y_min,
		real	y_max,
		real	z_min,
		real	z_max )

Set up splines to interpolate 3D scalar data.

This function is equivalent to calling both interp3Dcomp_init_coeff and interp3Dcomp_init_spline.

Parameters

str	pointer to spline to be initialized
f	3D data to be interpolated
n_x	number of data points in the x direction
n_y	number of data points in the y direction
n_z	number of data points in the z direction
bc_x	boundary condition for x axis
bc_y	boundary condition for y axis
bc_z	boundary condition for z axis
x_min	minimum value of the x axis
x_max	maximum value of the x axis
y_min	minimum value of the y axis
y_max	maximum value of the y axis
z_min	minimum value of the z axis
z_max	maximum value of the z axis

Returns

zero if initialization succeeded

Definition at line 259 of file interp3Dcomp.c.

interp3Dcomp_eval_f()

a5err interp3Dcomp_eval_f	(	real *	f,
		interp3D_data *	str,
		real	x,
		real	y,
		real	z )

Evaluate interpolated value of 3D scalar field.

This function evaluates the interpolated value of a 3D scalar field using tricubic spline interpolation coefficients of the compact form.

Parameters

f	variable in which to place the evaluated value
str	data struct for data interpolation
x	x-coordinate
y	y-coordinate
z	z-coordinate

Returns

zero on success and one if (x,y,z) point is outside the grid.

< Index jump to cell

Definition at line 288 of file interp3Dcomp.c.

interp3Dcomp_eval_df()

a5err interp3Dcomp_eval_df	(	real *	f_df,
		interp3D_data *	str,
		real	x,
		real	y,
		real	z )

Evaluate interpolated value of 3D field and 1st and 2nd derivatives.

This function evaluates the interpolated value of a 3D scalar field and its 1st and 2nd derivatives using bicubic spline interpolation coefficients of the compact form.

The evaluated values are returned in an array with following elements:

• f_df[0] = f
• f_df[1] = f_x
• f_df[2] = f_y
• f_df[3] = f_z
• f_df[4] = f_xx
• f_df[5] = f_yy
• f_df[6] = f_zz
• f_df[7] = f_xy
• f_df[8] = f_xz
• f_df[9] = f_yz

Parameters

f_df	array in which to place the evaluated values
str	data struct for data interpolation
x	x-coordinate
y	y-coordinate
z	z-coordinate

Returns

zero on success and one if (x,y,z) point is outside the grid.

Definition at line 454 of file interp3Dcomp.c.