petscvectormodule Module Reference

Data Types
type	petscvectortype

Functions/Subroutines
subroutine	petsc_vec_create_mm (this, n, name, mem_path)
	Create a PETSc vector, with memory. More...
subroutine	petsc_vec_create (this, n)
	Create a PETSc vector, with memory. More...
subroutine	petsc_vec_destroy (this)
	Clean up. More...
real(dp) function, dimension(:), pointer, contiguous	petsc_vec_get_array (this)
	Get a pointer to the underlying data array. More...
subroutine	petsc_vec_get_ownership_range (this, start, end)
integer(i4b) function	petsc_vec_get_size (this)
real(dp) function	petsc_vec_get_value_local (this, idx)
	Gets a value from the vector at the local index. More...
subroutine	petsc_vec_zero_entries (this)
	set all elements to zero More...
subroutine	petsc_vec_set_value_local (this, idx, val)
	Set vector value at local index. More...
subroutine	petsc_vec_axpy (this, alpha, vec_x)
	Calculate AXPY: y = a*x + y. More...
real(dp) function	petsc_vec_norm2 (this)
	Calculate this vector's (global) 2-norm. More...
subroutine	petsc_vec_print (this)

Function/Subroutine Documentation

petsc_vec_axpy()

subroutine petscvectormodule::petsc_vec_axpy ( class(petscvectortype)  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 178 of file PetscVector.F90.

    class(PetscVectorType) :: this !< this vector
    real(DP) :: alpha !< the factor
    class(VectorBaseType), pointer :: vec_x !< the vector to add
    ! local
    petscerrorcode :: ierr
    class(PetscVectorType), pointer :: x
 
    x => null()
    select type (vec_x)
    class is (petscvectortype)
      x => vec_x
    end select
    call vecaxpy(this%vec_impl, alpha, x%vec_impl, ierr)
    chkerrq(ierr)
 

petsc_vec_create()

subroutine petscvectormodule::petsc_vec_create ( class(petscvectortype)  this, integer(i4b)  n  )

private

Parameters

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

Definition at line 61 of file PetscVector.F90.

    class(PetscVectorType) :: this !< this vector
    integer(I4B) :: n !< the nr. of elements in the vector
    ! local
    petscerrorcode :: ierr
 
    this%is_mem_managed = .false.
 
    allocate (this%array(n))
    if (simulation_mode == 'PARALLEL' .and. nr_procs > 1) then
      call veccreatempiwitharray(petsc_comm_world, 1, n, petsc_decide, &
                                 this%array, this%vec_impl, ierr)
    else
      call veccreateseqwitharray(petsc_comm_world, 1, n, this%array, &
                                 this%vec_impl, ierr)
    end if
    chkerrq(ierr)
 
    call this%zero_entries()
 

petsc_vec_create_mm()

subroutine petscvectormodule::petsc_vec_create_mm	(	class(petscvectortype)	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 35 of file PetscVector.F90.

    class(PetscVectorType) :: 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
    ! local
    petscerrorcode :: ierr
 
    this%is_mem_managed = .true.
 
    call mem_allocate(this%array, n, name, mem_path)
    if (simulation_mode == 'PARALLEL' .and. nr_procs > 1) then
      call veccreatempiwitharray(petsc_comm_world, 1, n, petsc_decide, &
                                 this%array, this%vec_impl, ierr)
    else
      call veccreateseqwitharray(petsc_comm_world, 1, n, this%array, &
                                 this%vec_impl, ierr)
    end if
    chkerrq(ierr)
 
    call this%zero_entries()
 

petsc_vec_destroy()

subroutine petscvectormodule::petsc_vec_destroy ( class(petscvectortype)  this )

private

Parameters

this	this vector

Definition at line 85 of file PetscVector.F90.

    class(PetscVectorType) :: this !< this vector
    ! local
    petscerrorcode :: ierr
 
    call vecdestroy(this%vec_impl, ierr)
    chkerrq(ierr)
    if (this%is_mem_managed) then
      call mem_deallocate(this%array)
    else
      deallocate (this%array)
    end if
 

petsc_vec_get_array()

real(dp) function, dimension(:), pointer, contiguous petscvectormodule::petsc_vec_get_array ( class(petscvectortype)  this )

private

Parameters

this	this vector

Returns

the underlying data array for this vector

Definition at line 102 of file PetscVector.F90.

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

petsc_vec_get_ownership_range()

subroutine petscvectormodule::petsc_vec_get_ownership_range ( class(petscvectortype)  this, integer(i4b)  start, integer(i4b)  end  )

private

Parameters

this	this vector
start	the index of the first element (owned by this process) in the global vector
end	the index of the last element (owned by this process) in the global vector

Definition at line 110 of file PetscVector.F90.

    class(PetscVectorType) :: this !< this vector
    integer(I4B) :: start !< the index of the first element (owned by this process) in the global vector
    integer(I4B) :: end !< the index of the last element (owned by this process) in the global vector
    ! local
    petscerrorcode :: ierr
 
    ! gets the range as [start, end) but 0-based
    call vecgetownershiprange(this%vec_impl, start, end, ierr)
 
    ! now we make it [start, end] and 1-based
    start = start + 1
 
    chkerrq(ierr)
 

petsc_vec_get_size()

integer(i4b) function petscvectormodule::petsc_vec_get_size ( class(petscvectortype)  this )

private

Parameters

this	this vector

Returns

the (global) vector size

Definition at line 127 of file PetscVector.F90.

    class(PetscVectorType) :: this !< this vector
    integer(I4B) :: size !< the (global) vector size
    ! local
    petscerrorcode :: ierr
 
    call vecgetsize(this%vec_impl, size, ierr)
    chkerrq(ierr)
 

petsc_vec_get_value_local()

real(dp) function petscvectormodule::petsc_vec_get_value_local ( class(petscvectortype)  this, integer(i4b)  idx  )

private

Parameters

this	this vector
idx	the index in local numbering

Returns

the value

Definition at line 140 of file PetscVector.F90.

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

petsc_vec_norm2()

real(dp) function petscvectormodule::petsc_vec_norm2 ( class(petscvectortype)  this )

private

Parameters

this	this vector

Returns

the calculated 2-norm

Definition at line 198 of file PetscVector.F90.

    class(PetscVectorType) :: this !< this vector
    real(DP) :: n2 !< the calculated 2-norm
    ! local
    petscerrorcode :: ierr
 
    call vecnorm(this%vec_impl, norm_2, n2, ierr)
    chkerrq(ierr)
 

petsc_vec_print()

subroutine petscvectormodule::petsc_vec_print ( class(petscvectortype)  this )

private

Parameters

this	this vector

Definition at line 209 of file PetscVector.F90.

    class(PetscVectorType) :: this !< this vector
    ! local
    petscerrorcode :: ierr
 
    call vecview(this%vec_impl, petsc_viewer_stdout_world, ierr)
    chkerrq(ierr)
 

petsc_vec_set_value_local()

subroutine petscvectormodule::petsc_vec_set_value_local ( class(petscvectortype)  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 167 of file PetscVector.F90.

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

petsc_vec_zero_entries()

subroutine petscvectormodule::petsc_vec_zero_entries ( class(petscvectortype)  this )

private

Parameters

this	this vector

Definition at line 151 of file PetscVector.F90.

    class(PetscVectorType) :: this !< this vector
    ! local
    petscerrorcode :: ierr
 
    call veczeroentries(this%vec_impl, ierr)
    chkerrq(ierr)
    call vecassemblybegin(this%vec_impl, ierr)
    chkerrq(ierr)
    call vecassemblyend(this%vec_impl, ierr)
    chkerrq(ierr)