Detailed Description

Native vector class.

Used for implementing global vector operations in OFT

Inheritance diagram for oft_native_vector:

Public Member Functions
procedure(vec_add), deferred	add (self, gamma, alpha, a, beta, b)
	Add vectors.

procedure	add (self, gamma, alpha, a, beta, b)
	Add vectors.

procedure	delete (self)
	Delete vector.

procedure	delete (self)
	Delete vector.

generic	dot (self, a)
	Dot product with a second vector.

generic	dot (self, a)
	Dot product with a second vector.

procedure(vec_dot_cvec), deferred	dot_complex (self, a)

procedure	dot_complex (self, a)
	Dot product with a complex vector.

procedure(vec_dot_vec), deferred	dot_real (self, a)

procedure	dot_real (self, a)
	Dot product with a vector.

procedure(vec_get_local), deferred	get_local (self, array, iblock)
	Get local portion of vector.

procedure	get_local (self, array, iblock)
	Get local portion of field.

procedure(vec_get_slice), deferred	get_slice (self, array, iblock)
	Get locally-owned portion of vector.

procedure	get_slice (self, array, iblock)
	Get owned portion of field.

generic	mdot (self, a, n)
	Dot product with a set of vectors.

generic	mdot (self, a, n)
	Dot product with a set of vectors.

procedure(vec_mdot_cvec), deferred	mdot_complex (self, a, n)

procedure	mdot_complex (self, a, n)
	Dot product with an array of complex vectors.

procedure(vec_mdot_vec), deferred	mdot_real (self, a, n)

procedure	mdot_real (self, a, n)
	Dot product with an array of vectors.

procedure(vec_mult), deferred	mult (self, a, div_flag)
	Multiply vectors element by element.

procedure	mult (self, a, div_flag)
	Multiply fields element by element.

generic	new (self, new)
	Create a new vector as a bare copy.

generic	new (self, new)
	Create a new vector as a bare copy.

procedure(vec_new_cvec), deferred	new_complex (self, new)

procedure	new_complex (self, new)
	Create a new complex vector as a bare copy of `self`

procedure(vec_new_vec), deferred	new_real (self, new)

procedure	new_real (self, new)
	Create a new vector as a bare copy of `self`

procedure(vec_norm), deferred	norm (self, itype)
	Norm of vector.

procedure	norm (self, itype)
	Norm of field.

procedure(vec_restore_local), deferred	restore_local (self, array, iblock, add, wait)
	Restore local portion of vector.

procedure	restore_local (self, array, iblock, add, wait)
	Restore local portion of field.

procedure(vec_restore_slice), deferred	restore_slice (self, array, iblock, wait)
	Restore locally-owned portion of vector.

procedure	restore_slice (self, array, iblock, wait)
	Restore owned portion of field.

procedure(vec_scale), deferred	scale (self, alpha)
	Scale vector by a scalar.

procedure	scale (self, alpha)
	Scale vector by a scalar.

procedure(vec_set), deferred	set (self, alpha, iblock, random)
	Set all elements to a scalar.

procedure	set (self, alpha, iblock, random)
	Set all elements to a scalar.

procedure(vec_stitch), deferred	stitch (self, up_method)
	Perform global sitching.

procedure	stitch (self, up_method)
	Perform global stitching.

procedure(vec_sum), deferred	sum (self)
	Sum reduction over vector.

procedure	sum (self)
	Sum reduction over vector.

Public Attributes
real(r8), dimension(:), pointer, contiguous	local_tmp => NULL()
	Local value cache.

type(oft_map), dimension(:), pointer	map => NULL()
	Block mapping.

integer(i4)	n = -1
	Local size of vector.

integer(i4)	nblocks = 1
	Number of blocks.

integer(i8)	ng = -1
	Gobal size of vector.

integer(i4)	nslice = -1
	Number of locally-owned values.

type(oft_seam), pointer	stitch_info => NULL()
	Seam information.

real(r8), dimension(:), pointer, contiguous	v => NULL()
	Vector values.

Member Function/Subroutine Documentation

◆ add() [1/2]

procedure(vec_add), deferred add	(	class(oft_vector), intent(inout)	self,
		real(r8), intent(in)	gamma,
		real(r8), intent(in)	alpha,
		class(oft_vector), intent(inout), target	a,
		real(r8), intent(in), optional	beta,
		class(oft_vector), intent(inout), optional, target	b
	)

pure virtualinherited

Add vectors.

Parameters

[in,out]	self	Vector object
[in]	gamma	Scale of source vector
[in]	alpha	Scale of first vector
[in,out]	a	First vector to add
[in]	beta	Scale of second vector (optional)
[in,out]	b	Second vector to add (optional)

◆ add() [2/2]

procedure add	(	class(oft_native_vector), intent(inout)	self,
		real(r8), intent(in)	gamma,
		real(r8), intent(in)	alpha,
		class(oft_vector), intent(inout), target	a,
		real(r8), intent(in), optional	beta,
		class(oft_vector), intent(inout), optional, target	b
	)

Add vectors.

self = \( \gamma \) self + \( \alpha \) a + \( \beta \) b

Parameters

[in,out]	self	Vector object
[in]	gamma	Scale of source vector
[in]	alpha	Scale of first vector
[in,out]	a	First vector to add
[in]	beta	Scale of second vector (optional)
[in,out]	b	Second vector to add (optional)

◆ delete() [1/2]

procedure delete ( class(oft_vector), intent(inout) self )

inherited

Delete vector.

Note: This subroutine is a dummy routine used to specify the interface of the member function and catch errors in uninitialized vectors

◆ delete() [2/2]

procedure delete ( class(oft_native_vector), intent(inout) self )

Delete vector.

Parameters

[in,out] self Vector object

◆ dot() [1/2]

generic dot	(	class(oft_vector), intent(inout)	self,
		class(oft_vector), intent(inout), target	a
	)

inherited

Dot product with a second vector.

Parameters

[in,out]	self	Vector object
[in,out]	a	Second vector for dot product

Returns: dot(self,a)

◆ dot() [2/2]

generic dot	(	class(oft_vector), intent(inout)	self,
		class(oft_cvector), intent(inout), target	a
	)

inherited

Dot product with a second vector.

Parameters

[in,out]	self	Vector object
[in,out]	a	Second vector for dot product

Returns: dot(self,a)

◆ dot_complex() [1/2]

procedure(vec_dot_cvec), deferred dot_complex	(	class(oft_vector), intent(inout)	self,
		class(oft_cvector), intent(inout), target	a
	)

pure virtualinherited

Parameters

[in,out]	self	Vector object
[in,out]	a	Second vector for dot product

Returns: dot(self,a)

◆ dot_complex() [2/2]

procedure dot_complex	(	class(oft_native_vector), intent(inout)	self,
		class(oft_cvector), intent(inout), target	a
	)

Dot product with a complex vector.

Parameters

[in,out]	self	Vector object
[in,out]	a	Second vector for dot product

Returns: \( \sum_i self_i a_i \)

◆ dot_real() [1/2]

procedure(vec_dot_vec), deferred dot_real	(	class(oft_vector), intent(inout)	self,
		class(oft_vector), intent(inout), target	a
	)

pure virtualinherited

Parameters

[in,out]	self	Vector object
[in,out]	a	Second vector for dot product

Returns: dot(self,a)

◆ dot_real() [2/2]

procedure dot_real	(	class(oft_native_vector), intent(inout)	self,
		class(oft_vector), intent(inout), target	a
	)

Dot product with a vector.

Parameters

[in,out]	self	Vector object
[in,out]	a	Second vector for dot product

Returns: \( \sum_i self_i a_i \)

◆ get_local() [1/2]

procedure(vec_get_local), deferred get_local	(	class(oft_vector), intent(inout)	self,
		real(r8), dimension(:), intent(inout), pointer	array,
		integer(i4), intent(in), optional	iblock
	)

pure virtualinherited

Get local portion of vector.

Parameters

[in,out]	self	Vector object
[in,out]	array	Local values
[in]	iblock	Sub-block to retrieve

◆ get_local() [2/2]

procedure get_local	(	class(oft_native_vector), intent(inout)	self,
		real(r8), dimension(:), intent(inout), pointer	array,
		integer(i4), intent(in), optional	iblock
	)

Get local portion of field.

Parameters

[in,out]	self	Vector object
[in,out]	array	Local values
[in]	iblock	Sub-block to retrieve

◆ get_slice() [1/2]

procedure(vec_get_slice), deferred get_slice	(	class(oft_vector), intent(inout)	self,
		real(r8), dimension(:), intent(inout), pointer	array,
		integer(i4), intent(in), optional	iblock
	)

pure virtualinherited

Get locally-owned portion of vector.

Parameters

[in,out]	self	Vector object
[in,out]	array	Slice values
[in]	iblock	Sub-block to retrieve

◆ get_slice() [2/2]

procedure get_slice	(	class(oft_native_vector), intent(inout)	self,
		real(r8), dimension(:), intent(inout), pointer	array,
		integer(i4), intent(in), optional	iblock
	)

Get owned portion of field.

Parameters

[in,out]	self	Vector object
[in,out]	array	Slice values
[in]	iblock	Sub-block to retrieve

◆ mdot() [1/2]

generic mdot	(	class(oft_vector), intent(inout)	self,
		type(oft_vector_ptr), dimension(n), intent(inout)	a,
		integer(i4), intent(in)	n
	)

inherited

Dot product with a set of vectors.

Parameters

[in,out]	self	Vector object
[in,out]	a	Array of vectors for dot product [n]
[in]	n	Length of vector array

Returns: \( \sum_i self_i a(j)_i \)

◆ mdot() [2/2]

generic mdot	(	class(oft_vector), intent(inout)	self,
		type(oft_cvector_ptr), dimension(n), intent(inout)	a,
		integer(i4), intent(in)	n
	)

inherited

Dot product with a set of vectors.

Parameters

[in,out]	self	Vector object
[in,out]	a	Array of vectors for dot product [n]
[in]	n	Length of vector array

Returns: \( \sum_i self_i a(j)_i \)

◆ mdot_complex() [1/2]

procedure(vec_mdot_cvec), deferred mdot_complex	(	class(oft_vector), intent(inout)	self,
		type(oft_cvector_ptr), dimension(n), intent(inout)	a,
		integer(i4), intent(in)	n
	)

pure virtualinherited

Parameters

[in,out]	self	Vector object
[in,out]	a	Array of vectors for dot product [n]
[in]	n	Length of vector array

Returns: \( \sum_i self_i a(j)_i \)

◆ mdot_complex() [2/2]

procedure mdot_complex	(	class(oft_native_vector), intent(inout)	self,
		type(oft_cvector_ptr), dimension(n), intent(inout)	a,
		integer(i4), intent(in)	n
	)

Dot product with an array of complex vectors.

Parameters

[in,out]	self	Vector object
[in,out]	a	Array of vectors for dot product [n]
[in]	n	Length of vector array

Returns: \( \sum_i self_i a(j)_i \)

◆ mdot_real() [1/2]

procedure(vec_mdot_vec), deferred mdot_real	(	class(oft_vector), intent(inout)	self,
		type(oft_vector_ptr), dimension(n), intent(inout)	a,
		integer(i4), intent(in)	n
	)

pure virtualinherited

Parameters

[in,out]	self	Vector object
[in,out]	a	Array of vectors for dot product [n]
[in]	n	Length of vector array

Returns: \( \sum_i self_i a(j)_i \)

◆ mdot_real() [2/2]

procedure mdot_real	(	class(oft_native_vector), intent(inout)	self,
		type(oft_vector_ptr), dimension(n), intent(inout)	a,
		integer(i4), intent(in)	n
	)

Dot product with an array of vectors.

Parameters

[in,out]	self	Vector object
[in,out]	a	Array of vectors for dot product [n]
[in]	n	Length of vector array

Returns: \( \sum_i self_i a(j)_i \)

◆ mult() [1/2]

procedure(vec_mult), deferred mult	(	class(oft_vector), intent(inout)	self,
		class(oft_vector), intent(inout), target	a,
		logical, intent(in), optional	div_flag
	)

pure virtualinherited

Multiply vectors element by element.

Parameters

[in,out]	self	Vector object
[in,out]	a	vector for multiplication
[in]	div_flag	Divide instead of multiply?

◆ mult() [2/2]

procedure mult	(	class(oft_native_vector), intent(inout)	self,
		class(oft_vector), intent(inout), target	a,
		logical, intent(in), optional	div_flag
	)

Multiply fields element by element.

\( self_i = self_i * a_i \)

Parameters

[in,out]	self	Vector object
[in,out]	a	vector for multiplication
[in]	div_flag	Divide instead of multiply?

◆ new() [1/2]

generic new	(	class(oft_vector), intent(in)	self,
		class(oft_cvector), intent(out), pointer	new
	)

inherited

Create a new vector as a bare copy.

Parameters

[in]	self	Vector object
[out]	new	New vector

◆ new() [2/2]

generic new	(	class(oft_vector), intent(in)	self,
		class(oft_vector), intent(out), pointer	new
	)

inherited

Create a new vector as a bare copy.

Parameters

[in]	self	Vector object
[out]	new	New vector

◆ new_complex() [1/2]

procedure(vec_new_cvec), deferred new_complex	(	class(oft_vector), intent(in)	self,
		class(oft_cvector), intent(out), pointer	new
	)

pure virtualinherited

Parameters

[in]	self	Vector object
[out]	new	New vector

◆ new_complex() [2/2]

procedure new_complex	(	class(oft_native_vector), intent(in)	self,
		class(oft_cvector), intent(out), pointer	new
	)

Create a new complex vector as a bare copy of self

Parameters

[in]	self	Vector object
[out]	new	New vector

◆ new_real() [1/2]

procedure(vec_new_vec), deferred new_real	(	class(oft_vector), intent(in)	self,
		class(oft_vector), intent(out), pointer	new
	)

pure virtualinherited

Parameters

[in]	self	Vector object
[out]	new	New vector

◆ new_real() [2/2]

procedure new_real	(	class(oft_native_vector), intent(in)	self,
		class(oft_vector), intent(out), pointer	new
	)

Create a new vector as a bare copy of self

Parameters

[in]	self	Vector object
[out]	new	New vector

◆ norm() [1/2]

procedure(vec_norm), deferred norm	(	class(oft_vector), intent(inout)	self,
		integer(i4), intent(in)	itype
	)

pure virtualinherited

Norm of vector.

Parameters

[in,out]	self	Vector object
[in]	itype	Type of norm (1-> 1-norm, 2-> 2-norm, 3-> Inf-norm)

Returns: Specified norm of vector

◆ norm() [2/2]

procedure norm	(	class(oft_native_vector), intent(inout)	self,
		integer(i4), intent(in)	itype
	)

Norm of field.

Parameters

[in,out]	self	Vector object
[in]	itype	Type of norm (1-> 1-norm, 2-> 2-norm, 3-> Inf-norm)

Returns: Specified norm of vector

◆ restore_local() [1/2]

procedure(vec_restore_local), deferred restore_local	(	class(oft_vector), intent(inout)	self,
		real(r8), dimension(:), intent(in)	array,
		integer(i4), intent(in), optional	iblock,
		logical, intent(in), optional	add,
		logical, intent(in), optional	wait
	)

pure virtualinherited

Restore local portion of vector.

Parameters

[in,out]	self	Vector object
[in]	array	Local values
[in]	iblock	Sub-block to restore
[in]	add	Add values instead of replace
[in]	wait	Wait to perform global sync

◆ restore_local() [2/2]

procedure restore_local	(	class(oft_native_vector), intent(inout)	self,
		real(r8), dimension(:), intent(in)	array,
		integer(i4), intent(in), optional	iblock,
		logical, intent(in), optional	add,
		logical, intent(in), optional	wait
	)

Restore local portion of field.

Parameters

[in,out]	self	Vector object
[in]	array	Local values
[in]	iblock	Sub-block to restore
[in]	add	Add values instead of replace
[in]	wait	Wait to perform global sync

◆ restore_slice() [1/2]

procedure(vec_restore_slice), deferred restore_slice	(	class(oft_vector), intent(inout)	self,
		real(r8), dimension(:), intent(in)	array,
		integer(i4), intent(in), optional	iblock,
		logical, intent(in), optional	wait
	)

pure virtualinherited

Restore locally-owned portion of vector.

Parameters

[in,out]	self	Vector object
[in]	array	Slice values
[in]	iblock	Sub-block to restore
[in]	wait	Wait to perform global sync?

◆ restore_slice() [2/2]

procedure restore_slice	(	class(oft_native_vector), intent(inout)	self,
		real(r8), dimension(:), intent(in)	array,
		integer(i4), intent(in), optional	iblock,
		logical, intent(in), optional	wait
	)

Restore owned portion of field.

Parameters

[in,out]	self	Vector object
[in]	array	Slice values
[in]	iblock	Sub-block to restore
[in]	wait	Wait to perform global sync?

◆ scale() [1/2]

procedure(vec_scale), deferred scale	(	class(oft_vector), intent(inout)	self,
		real(r8), intent(in)	alpha
	)

pure virtualinherited

Scale vector by a scalar.

Parameters

[in,out]	self	Vector object
[in]	alpha	Scale factor

◆ scale() [2/2]

procedure scale	(	class(oft_native_vector), intent(inout)	self,
		real(r8), intent(in)	alpha
	)

Scale vector by a scalar.

Parameters

[in,out]	self	Vector object
[in]	alpha	Scale factor

◆ set() [1/2]

procedure(vec_set), deferred set	(	class(oft_vector), intent(inout)	self,
		real(r8), intent(in)	alpha,
		integer(i4), intent(in), optional	iblock,
		logical, intent(in), optional	random
	)

pure virtualinherited

Set all elements to a scalar.

Parameters

[in,out]	self	Vector object
[in]	alpha	Updated vector value
[in]	iblock	Vector sub-block to act on
[in]	random	Set to random number, if true alpha is ignored (optional)

◆ set() [2/2]

procedure set	(	class(oft_native_vector), intent(inout)	self,
		real(r8), intent(in)	alpha,
		integer(i4), intent(in), optional	iblock,
		logical, intent(in), optional	random
	)

Set all elements to a scalar.

Parameters

[in,out]	self	Vector object
[in]	alpha	Updated vector value
[in]	iblock	Vector sub-block to act on
[in]	random	Set to random number, if true alpha is ignored (optional)

◆ stitch() [1/2]

procedure(vec_stitch), deferred stitch	(	class(oft_vector), intent(inout)	self,
		integer(i4), intent(in)	up_method
	)

pure virtualinherited

Perform global sitching.

Parameters

[in,out]	self	Vector object
[in]	up_method	Type of stitching to perform

◆ stitch() [2/2]

procedure stitch	(	class(oft_native_vector), intent(inout)	self,
		integer(i4), intent(in)	up_method
	)

Perform global stitching.

Parameters

[in,out]	self	Vector object
[in]	up_method	Type of stitching to perform

◆ sum() [1/2]

procedure(vec_sum), deferred sum ( class(oft_vector), intent(inout) self )

pure virtualinherited

Sum reduction over vector.

Parameters

[in,out] self Vector object

Returns: Sum of vector elements

◆ sum() [2/2]

procedure sum ( class(oft_native_vector), intent(inout) self )

Sum reduction over vector.

Parameters

[in,out] self Vector object

Returns: Sum of vector elements

Member Data Documentation

◆ local_tmp

real(r8), dimension(:), pointer, contiguous local_tmp => NULL()

Local value cache.

◆ map

type(oft_map), dimension(:), pointer map => NULL()

inherited

Block mapping.

◆ n

integer(i4) n = -1

inherited

Local size of vector.

◆ nblocks

integer(i4) nblocks = 1

inherited

Number of blocks.

◆ ng

integer(i8) ng = -1

inherited

Gobal size of vector.

◆ nslice

integer(i4) nslice = -1

inherited

Number of locally-owned values.

◆ stitch_info

type(oft_seam), pointer stitch_info => NULL()

inherited

Seam information.

◆ v

real(r8), dimension(:), pointer, contiguous v => NULL()

Vector values.

The documentation for this type was generated from the following file:

/home/runner/work/OpenFUSIONToolkit/OpenFUSIONToolkit/src/lin_alg/native_la.F90

Detailed Description

Public Member Functions

Public Attributes

Member Function/Subroutine Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ delete() [1/2]

◆ delete() [2/2]

◆ dot() [1/2]

◆ dot() [2/2]

◆ dot_complex() [1/2]

◆ dot_complex() [2/2]

◆ dot_real() [1/2]

◆ dot_real() [2/2]

◆ get_local() [1/2]

◆ get_local() [2/2]

◆ get_slice() [1/2]

◆ get_slice() [2/2]

◆ mdot() [1/2]

◆ mdot() [2/2]

◆ mdot_complex() [1/2]

◆ mdot_complex() [2/2]

◆ mdot_real() [1/2]

◆ mdot_real() [2/2]

◆ mult() [1/2]

◆ mult() [2/2]

◆ new() [1/2]

◆ new() [2/2]

◆ new_complex() [1/2]

◆ new_complex() [2/2]

◆ new_real() [1/2]

◆ new_real() [2/2]

◆ norm() [1/2]

◆ norm() [2/2]

◆ restore_local() [1/2]

◆ restore_local() [2/2]

◆ restore_slice() [1/2]

◆ restore_slice() [2/2]

◆ scale() [1/2]

◆ scale() [2/2]

◆ set() [1/2]

◆ set() [2/2]

◆ stitch() [1/2]

◆ stitch() [2/2]

◆ sum() [1/2]

◆ sum() [2/2]

Member Data Documentation

◆ local_tmp

◆ map

◆ n

◆ nblocks

◆ ng

◆ nslice

◆ stitch_info

◆ v