seqvectormodule Module Reference

Data Types
type	seqvectortype

Functions/Subroutines
subroutine	sqv_create_mm (this, n, name, mem_path)
	Create a sequential vector: the classic MF6 version,. More...
subroutine	sqv_create (this, n)
	Create a sequential vector: the classic MF6 version. More...
subroutine	sqv_destroy (this)
	Clean up. More...
real(dp) function, dimension(:), pointer, contiguous	sqv_get_array (this)
	Get a pointer to the underlying data array. More...
subroutine	sqv_get_ownership_range (this, start, end)
integer(i4b) function	sqv_get_size (this)
real(dp) function	sqv_get_value_local (this, idx)
	Get value at local index. More...
subroutine	sqv_zero_entries (this)
	set all elements to zero More...
subroutine	sqv_set_value_local (this, idx, val)
	Set vector value at local index. More...
subroutine	sqv_axpy (this, alpha, vec_x)
	Caculcates AXPY: y = a*x + y. More...
real(dp) function	sqv_norm2 (this)
	Calculate the 2-norm. More...
subroutine	sqv_print (this)

Function/Subroutine Documentation

sqv_axpy()

subroutine seqvectormodule::sqv_axpy ( class(seqvectortype)  this, real(dp)  alpha, class(vectorbasetype), pointer  vec_x  )

private

Parameters

this	this vector
alpha	the factor
vec_x	the vector to add

Definition at line 135 of file SeqVector.f90.

    class(SeqVectorType) :: this !< this vector
    real(DP) :: alpha !< the factor
    class(VectorBaseType), pointer :: vec_x !< the vector to add
    ! local
    integer(I4B) :: i
    real(DP), dimension(:), pointer, contiguous :: x_array
 
    x_array => vec_x%get_array()
    do i = 1, this%size
      this%array(i) = alpha * x_array(i) + this%array(i)
    end do
 

sqv_create()

subroutine seqvectormodule::sqv_create ( class(seqvectortype)  this, integer(i4b)  n  )

private

Parameters

this	this vector
n	the nr. of elements in the vector

Definition at line 46 of file SeqVector.f90.

    class(SeqVectorType) :: this !< this vector
    integer(I4B) :: n !< the nr. of elements in the vector
 
    this%size = n
    this%is_mem_managed = .false.
    allocate (this%array(n))
    call this%zero_entries()
 

sqv_create_mm()

subroutine seqvectormodule::sqv_create_mm	(	class(seqvectortype)	this,
		integer(i4b)	n,
		character(len=*)	name,
		character(len=*)	mem_path
	)

Parameters

this	this vector
n	the nr. of elements in the vector
name	the variable name (for access through memory manager)
mem_path	memory path for storing the underlying memory items

Definition at line 31 of file SeqVector.f90.

    class(SeqVectorType) :: this !< this vector
    integer(I4B) :: n !< the nr. of elements in the vector
    character(len=*) :: name !< the variable name (for access through memory manager)
    character(len=*) :: mem_path !< memory path for storing the underlying memory items
 
    this%size = n
    this%is_mem_managed = .true.
    call mem_allocate(this%array, n, name, mem_path)
    call this%zero_entries()
 

sqv_destroy()

subroutine seqvectormodule::sqv_destroy ( class(seqvectortype)  this )

private

Parameters

this	this vector

Definition at line 59 of file SeqVector.f90.

    class(SeqVectorType) :: this !< this vector
 
    if (this%is_mem_managed) then
      call mem_deallocate(this%array)
    else
      deallocate (this%array)
    end if
 

sqv_get_array()

real(dp) function, dimension(:), pointer, contiguous seqvectormodule::sqv_get_array ( class(seqvectortype)  this )

private

Parameters

this	this vector

Returns

the underlying data array for this vector

Definition at line 72 of file SeqVector.f90.

    class(SeqVectorType) :: this !< this vector
    real(DP), dimension(:), pointer, contiguous :: array !< the underlying data array for this vector
 
    array => this%array
 

sqv_get_ownership_range()

subroutine seqvectormodule::sqv_get_ownership_range ( class(seqvectortype)  this, integer(i4b)  start, integer(i4b)  end  )

private

Parameters

this	this vector
start	the index of the first element in the vector
end	the index of the last element in the vector

Definition at line 80 of file SeqVector.f90.

    class(SeqVectorType) :: this !< this vector
    integer(I4B) :: start !< the index of the first element in the vector
    integer(I4B) :: end !< the index of the last element in the vector
 
    start = 1
    end = this%size
 

sqv_get_size()

integer(i4b) function seqvectormodule::sqv_get_size ( class(seqvectortype)  this )

private

Parameters

this	this vector

Returns

the vector size

Definition at line 90 of file SeqVector.f90.

    class(SeqVectorType) :: this !< this vector
    integer(I4B) :: size !< the vector size
 
    size = this%size
 

sqv_get_value_local()

real(dp) function seqvectormodule::sqv_get_value_local ( class(seqvectortype)  this, integer(i4b)  idx  )

private

Parameters

this	this vector
idx	the index in local numbering

Returns

the value

Definition at line 100 of file SeqVector.f90.

    class(SeqVectorType) :: this !< this vector
    integer(I4B) :: idx !< the index in local numbering
    real(DP) :: val !< the value
 
    val = this%array(idx)
 

sqv_norm2()

real(dp) function seqvectormodule::sqv_norm2 ( class(seqvectortype)  this )

private

Parameters

this	this vector

Definition at line 152 of file SeqVector.f90.

    class(SeqVectorType) :: this !< this vector
    real(DP) :: n2
    ! local
    integer(I4B) :: i
 
    n2 = dzero
    do i = 1, this%size
      n2 = n2 + this%array(i)**2
    end do
    n2 = sqrt(n2)
 

sqv_print()

subroutine seqvectormodule::sqv_print ( class(seqvectortype)  this )

private

Parameters

this	this vector

Definition at line 166 of file SeqVector.f90.

    class(SeqVectorType) :: this !< this vector
 
    write (*, *) this%array
 

sqv_set_value_local()

subroutine seqvectormodule::sqv_set_value_local ( class(seqvectortype)  this, integer(i4b)  idx, real(dp)  val  )

private

Parameters

this	this vector
idx	the index in local numbering
val	the value to set

Definition at line 124 of file SeqVector.f90.

    class(SeqVectorType) :: this !< this vector
    integer(I4B) :: idx !< the index in local numbering
    real(DP) :: val !< the value to set
 
    this%array(idx) = val
 

sqv_zero_entries()

subroutine seqvectormodule::sqv_zero_entries ( class(seqvectortype)  this )

private

Parameters

this	this vector

Definition at line 111 of file SeqVector.f90.

    class(SeqVectorType) :: this !< this vector
    ! local
    integer(I4B) :: i
 
    do i = 1, this%size
      this%array(i) = dzero
    end do