vector_math Module Reference

Functions/Subroutines
subroutine, public	vector_rzero (a, n)
	Zero a real vector.
subroutine, public	vector_rone (a, n)
	Set all elements to one.
subroutine, public	vector_copy (a, b, n)
	Copy a vector \( a = b \).
subroutine, public	vector_cmult (a, c, n)
	Multiplication by constant c \( a = c \cdot a \).
subroutine, public	vector_cadd (a, s, n)
	Add a scalar to vector \( a = \sum a_i + s \).
subroutine, public	vector_cadd2 (a, b, s, n)
	Add a scalar to vector \( a_i = b_i + s \).
subroutine, public	vector_cfill (a, c, n)
	Set all elements to a constant c \( a = c \).
subroutine, public	vector_invcol1 (a, n)
	Invert a vector \( a = 1 / a \).
subroutine, public	vector_invcol3 (a, b, c, n)
	Invert a vector \( a = b / c \).
subroutine, public	vector_vdot3 (dot, u1, u2, u3, v1, v2, v3, n)
	Compute a dot product \( dot = u \cdot v \) (3-d version) assuming vector components \( u = (u_1, u_2, u_3) \) etc.
subroutine, public	vector_add2 (a, b, n)
	Vector addition \( a = a + b \).
subroutine, public	vector_add3 (a, b, c, n)
	Vector addition \( a = b + c \).
subroutine	vector_add4 (a, b, c, d, n)
	Vector addition \( a = b + c + d \).
subroutine, public	vector_sub2 (a, b, n)
	Vector substraction \( a = a - b \).
subroutine, public	vector_sub3 (a, b, c, n)
	Vector subtraction \( a = b - c \).
subroutine, public	vector_add2s1 (a, b, c1, n)
	Vector addition with scalar multiplication \( a = c_1 a + b \) (multiplication on first argument)
subroutine, public	vector_add2s2 (a, b, c1, n)
	Vector addition with scalar multiplication \( a = a + c_1 b \) (multiplication on second argument)
subroutine, public	vector_addsqr2s2 (a, b, c1, n)
	Returns \( a = a + c1 * (b * b )\).
subroutine, public	vector_cmult2 (a, b, c, n)
	Multiplication by constant c \( a = c \cdot b \).
subroutine, public	vector_invcol2 (a, b, n)
	Vector division \( a = a / b \).
subroutine, public	vector_col2 (a, b, n)
	Vector multiplication \( a = a \cdot b \).
subroutine, public	vector_col3 (a, b, c, n)
	Vector multiplication with 3 vectors \( a = b \cdot c \).
subroutine, public	vector_subcol3 (a, b, c, n)
	Returns \( a = a - b*c \).
subroutine, public	vector_add3s2 (a, b, c, c1, c2, n)
	Returns \( a = c1 * b + c2 * c \).
subroutine, public	vector_addcol3 (a, b, c, n)
	Returns \( a = a + b*c \).
subroutine, public	vector_addcol4 (a, b, c, d, n)
	Returns \( a = a + b*c*d \).
real(kind=rp) function, public	vector_glsum (a, n)
real(kind=rp) function, public	vector_glmax (a, n)
	Global maximum of all elements in a vector \( max = \max_i a_i \).
real(kind=rp) function, public	vector_glmin (a, n)
	Global minimum of all elements in a vector \( min = \min_i a_i \).
real(kind=rp) function, public	vector_glsc2 (a, b, n)
real(kind=rp) function, public	vector_glsc3 (a, b, c, n)
real(kind=rp) function, public	vector_glsubnorm (a, b, n)
subroutine, public	vector_masked_gather_copy_0 (a, b, mask, n, n_mask)
	Gather a vector to reduced contigous array \( a = b(mask) \).
subroutine, public	vector_face_masked_gather_copy_0 (a, b, mask, facet, lx, ly, lz, n_mask)
	Gather a face-local SEM field to a reduced contiguous vector.
subroutine, public	vector_masked_gather_copy (a, b, mask, n)
	Gather a vector to reduced contigous array \( a = b(mask) \).
subroutine, public	vector_masked_scatter_copy_0 (a, b, mask, n, n_mask)
	Scatter a contiguous vector into an array \( a(mask) = b \).
subroutine, public	vector_masked_scatter_copy (a, b, mask, n)
	Scatter a contiguous vector into an array \( a(mask) = b \).
subroutine, public	vector_cwrap (a, min_value, max_value, n)
	Wrap vector elements into the range [min_value, max_value)

Function/Subroutine Documentation

vector_add2()

subroutine, public vector_math::vector_add2	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		integer, intent(in), optional	n
	)

Definition at line 315 of file vector_math.f90.

Here is the call graph for this function:

vector_add2s1()

subroutine, public vector_math::vector_add2s1	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(inout)	b,
		real(kind=rp), intent(in)	c1,
		integer, intent(in), optional	n
	)

Definition at line 423 of file vector_math.f90.

Here is the call graph for this function:

vector_add2s2()

subroutine, public vector_math::vector_add2s2	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(inout)	b,
		real(kind=rp), intent(in)	c1,
		integer, intent(in), optional	n
	)

Definition at line 446 of file vector_math.f90.

Here is the call graph for this function:

vector_add3()

subroutine, public vector_math::vector_add3	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		type(vector_t), intent(in)	c,
		integer, intent(in), optional	n
	)

Definition at line 336 of file vector_math.f90.

Here is the call graph for this function:

vector_add3s2()

subroutine, public vector_math::vector_add3s2	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		type(vector_t), intent(in)	c,
		real(kind=rp), intent(in)	c1,
		real(kind=rp), intent(in)	c2,
		integer, intent(in), optional	n
	)

Definition at line 599 of file vector_math.f90.

Here is the call graph for this function:

vector_add4()

subroutine vector_math::vector_add4 ( type(vector_t), intent(inout)  a, type(vector_t), intent(in)  b, type(vector_t), intent(in)  c, type(vector_t), intent(in)  d, integer, intent(in), optional  n  )

private

Definition at line 357 of file vector_math.f90.

Here is the call graph for this function:

vector_addcol3()

subroutine, public vector_math::vector_addcol3	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		type(vector_t), intent(in)	c,
		integer, intent(in), optional	n
	)

Definition at line 622 of file vector_math.f90.

Here is the call graph for this function:

vector_addcol4()

subroutine, public vector_math::vector_addcol4	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		type(vector_t), intent(in)	c,
		type(vector_t), intent(in)	d,
		integer, intent(in), optional	n
	)

Definition at line 644 of file vector_math.f90.

Here is the call graph for this function:

vector_addsqr2s2()

subroutine, public vector_math::vector_addsqr2s2	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		real(kind=rp), intent(in)	c1,
		integer, intent(in), optional	n
	)

Definition at line 468 of file vector_math.f90.

Here is the call graph for this function:

vector_cadd()

subroutine, public vector_math::vector_cadd	(	type(vector_t), intent(inout)	a,
		real(kind=rp), intent(in)	s,
		integer, intent(in), optional	n
	)

Definition at line 182 of file vector_math.f90.

Here is the call graph for this function:

vector_cadd2()

subroutine, public vector_math::vector_cadd2	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		real(kind=rp), intent(in)	s,
		integer, intent(in), optional	n
	)

Definition at line 202 of file vector_math.f90.

Here is the call graph for this function:

vector_cfill()

subroutine, public vector_math::vector_cfill	(	type(vector_t), intent(inout)	a,
		real(kind=rp), intent(in)	c,
		integer, intent(in), optional	n
	)

Definition at line 224 of file vector_math.f90.

Here is the call graph for this function:

vector_cmult()

subroutine, public vector_math::vector_cmult	(	type(vector_t), intent(inout)	a,
		real(kind=rp), intent(in)	c,
		integer, intent(in), optional	n
	)

Definition at line 162 of file vector_math.f90.

Here is the call graph for this function:

vector_cmult2()

subroutine, public vector_math::vector_cmult2	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		real(kind=rp), intent(in)	c,
		integer, intent(in), optional	n
	)

Definition at line 490 of file vector_math.f90.

Here is the call graph for this function:

vector_col2()

subroutine, public vector_math::vector_col2	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		integer, intent(in), optional	n
	)

Definition at line 534 of file vector_math.f90.

Here is the call graph for this function:

vector_col3()

subroutine, public vector_math::vector_col3	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		type(vector_t), intent(in)	c,
		integer, intent(in), optional	n
	)

Definition at line 555 of file vector_math.f90.

Here is the call graph for this function:

vector_copy()

subroutine, public vector_math::vector_copy	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		integer, intent(in), optional	n
	)

Definition at line 142 of file vector_math.f90.

Here is the call graph for this function:

vector_cwrap()

subroutine, public vector_math::vector_cwrap	(	type(vector_t), intent(inout)	a,
		real(kind=rp), intent(in)	min_value,
		real(kind=rp), intent(in)	max_value,
		integer, intent(in), optional	n
	)

Definition at line 925 of file vector_math.f90.

Here is the call graph for this function:

vector_face_masked_gather_copy_0()

subroutine, public vector_math::vector_face_masked_gather_copy_0	(	type(vector_t), intent(inout)	a,
		real(kind=rp), dimension(:, :, :, :), intent(in)	b,
		integer, dimension(0:n_mask), intent(in)	mask,
		integer, dimension(0:n_mask), intent(in)	facet,
		integer, intent(in)	lx,
		integer, intent(in)	ly,
		integer, intent(in)	lz,
		integer, intent(in)	n_mask
	)

Parameters

a	Destination vector of size n_mask.
b	Source face-local array indexed as b(:, :, facet, element).
mask	Mask array of length n_mask + 1, where mask(0) = n_mask.
facet	Facet ids associated with the masked points.
lx	Number of points in the first SEM direction.
ly	Number of points in the second SEM direction.
lz	Number of points in the third SEM direction.
n_mask	Size of the mask array mask and vector a.

Definition at line 824 of file vector_math.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

vector_glmax()

real(kind=rp) function, public vector_math::vector_glmax	(	type(vector_t), intent(in)	a,
		integer, intent(in), optional	n
	)

Definition at line 687 of file vector_math.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

vector_glmin()

real(kind=rp) function, public vector_math::vector_glmin	(	type(vector_t), intent(in)	a,
		integer, intent(in), optional	n
	)

Definition at line 708 of file vector_math.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

vector_glsc2()

real(kind=rp) function, public vector_math::vector_glsc2	(	type(vector_t), intent(in)	a,
		type(vector_t), intent(in)	b,
		integer, intent(in), optional	n
	)

Definition at line 728 of file vector_math.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

vector_glsc3()

real(kind=rp) function, public vector_math::vector_glsc3	(	type(vector_t), intent(in)	a,
		type(vector_t), intent(in)	b,
		type(vector_t), intent(in)	c,
		integer, intent(in), optional	n
	)

Definition at line 748 of file vector_math.f90.

Here is the call graph for this function:

vector_glsubnorm()

real(kind=rp) function, public vector_math::vector_glsubnorm	(	type(vector_t), intent(in)	a,
		type(vector_t), intent(in)	b,
		integer, intent(in), optional	n
	)

Definition at line 768 of file vector_math.f90.

Here is the call graph for this function:

vector_glsum()

real(kind=rp) function, public vector_math::vector_glsum	(	type(vector_t), intent(in)	a,
		integer, intent(in), optional	n
	)

Definition at line 666 of file vector_math.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

vector_invcol1()

subroutine, public vector_math::vector_invcol1	(	type(vector_t), intent(inout)	a,
		integer, intent(in), optional	n
	)

Definition at line 244 of file vector_math.f90.

Here is the call graph for this function:

vector_invcol2()

subroutine, public vector_math::vector_invcol2	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		integer, intent(in), optional	n
	)

Definition at line 512 of file vector_math.f90.

Here is the call graph for this function:

vector_invcol3()

subroutine, public vector_math::vector_invcol3	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		type(vector_t), intent(in)	c,
		integer, intent(in), optional	n
	)

Definition at line 264 of file vector_math.f90.

Here is the call graph for this function:

vector_masked_gather_copy()

subroutine, public vector_math::vector_masked_gather_copy	(	type(vector_t), intent(inout)	a,
		real(kind=rp), dimension(:), intent(in)	b,
		type(mask_t), intent(in)	mask,
		integer, intent(in)	n
	)

Parameters

a	Destination vector of size n_mask.
b	Source array of size n.
mask	mask_t containing mask array and device pointer if needed.
n	Size of the vector b.

Definition at line 851 of file vector_math.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

vector_masked_gather_copy_0()

subroutine, public vector_math::vector_masked_gather_copy_0	(	type(vector_t), intent(inout)	a,
		real(kind=rp), dimension(n), intent(in)	b,
		integer, dimension(0:n_mask)	mask,
		integer, intent(in)	n,
		integer, intent(in)	n_mask
	)

Parameters

a	Destination vector of size n_mask.
b	Source array of size n.
mask	Mask array of length n_mask + 1, where mask(0) = n_mask the length of the mask array.
n	Size of the vector b.
n_mask	Size of the mask array mask and a.

Definition at line 796 of file vector_math.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

vector_masked_scatter_copy()

subroutine, public vector_math::vector_masked_scatter_copy	(	real(kind=rp), dimension(:), intent(inout)	a,
		type(vector_t), intent(in)	b,
		type(mask_t), intent(in)	mask,
		integer, intent(in)	n
	)

Parameters

a	Destination array.
b	Source vector of size n_mask.
mask	mask_t containing mask array and device pointer if needed. @param n Size of the arraya`.

Definition at line 904 of file vector_math.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

vector_masked_scatter_copy_0()

subroutine, public vector_math::vector_masked_scatter_copy_0	(	real(kind=rp), dimension(n), intent(inout)	a,
		type(vector_t), intent(in)	b,
		integer, dimension(0:n_mask)	mask,
		integer, intent(in)	n,
		integer, intent(in)	n_mask
	)

Parameters

a	Destination array.
b	Source vector of size n_mask.
mask	Mask array of length n_mask + 1, where mask(0) = n_mask the length of the mask array.
n	Size of the array a.
n_mask	Size of the mask array mask and vector b.

Definition at line 879 of file vector_math.f90.

Here is the call graph for this function:

vector_rone()

subroutine, public vector_math::vector_rone	(	type(vector_t), intent(inout)	a,
		integer, intent(in), optional	n
	)

Definition at line 123 of file vector_math.f90.

Here is the call graph for this function:

vector_rzero()

subroutine, public vector_math::vector_rzero	(	type(vector_t), intent(inout)	a,
		integer, intent(in), optional	n
	)

Definition at line 104 of file vector_math.f90.

Here is the call graph for this function:

vector_sub2()

subroutine, public vector_math::vector_sub2	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(inout)	b,
		integer, intent(in), optional	n
	)

Definition at line 378 of file vector_math.f90.

Here is the call graph for this function:

vector_sub3()

subroutine, public vector_math::vector_sub3	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		type(vector_t), intent(in)	c,
		integer, intent(in), optional	n
	)

Definition at line 399 of file vector_math.f90.

Here is the call graph for this function:

vector_subcol3()

subroutine, public vector_math::vector_subcol3	(	type(vector_t), intent(inout)	a,
		type(vector_t), intent(in)	b,
		type(vector_t), intent(in)	c,
		integer, intent(in), optional	n
	)

Definition at line 577 of file vector_math.f90.

Here is the call graph for this function:

vector_vdot3()

subroutine, public vector_math::vector_vdot3	(	type(vector_t), intent(out)	dot,
		type(vector_t), intent(in)	u1,
		type(vector_t), intent(in)	u2,
		type(vector_t), intent(in)	u3,
		type(vector_t), intent(in)	v1,
		type(vector_t), intent(in)	v2,
		type(vector_t), intent(in)	v3,
		integer, intent(in), optional	n
	)

Definition at line 287 of file vector_math.f90.

Here is the call graph for this function: