MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
seqvectormodule::seqvectortype Type Referenceabstract
Inheritance diagram for seqvectormodule::seqvectortype:
Inheritance graph
Collaboration diagram for seqvectormodule::seqvectortype:
Collaboration graph

Public Member Functions

procedure create_mm (this, n, name, mem_path)
 Create a sequential vector: the classic MF6 version,.
procedure create (this, n)
 Create a sequential vector: the classic MF6 version.
procedure destroy (this)
 Clean up.
procedure get_array (this)
 Get a pointer to the underlying data array.
procedure get_ownership_range (this, start, end)
procedure get_size (this)
procedure get_value_local (this, idx)
 Get value at local index.
procedure zero_entries (this)
 set all elements to zero
procedure set_value_local (this, idx, val)
 Set vector value at local index.
procedure axpy (this, alpha, vec_x)
 Caculcates AXPY: y = a*x + y.
procedure norm2 (this)
 Calculate the 2-norm.
procedure print (this)
procedure(create_mm_if), deferred create_mm (this, n, name, mem_path)
procedure(destroy_if), deferred destroy (this)
procedure(get_array_if), deferred get_array (this)
procedure(get_ownership_range_if), deferred get_ownership_range (this, start, end)
procedure(get_size_if), deferred get_size (this)
procedure(get_value_local_if), deferred get_value_local (this, idx)
procedure(zero_entries_if), deferred zero_entries (this)
procedure(set_value_local_if), deferred set_value_local (this, idx, val)
procedure(axpy_if), deferred axpy (this, alpha, vec_x)
procedure(norm2_if), deferred norm2 (this)
procedure(print_if), deferred print (this)

Public Attributes

real(dp), dimension(:), pointer, contiguous array
logical(lgp) is_mem_managed

Private Attributes

integer(i4b), private size

Detailed Description

Definition at line 9 of file SeqVector.f90.

Member Function/Subroutine Documentation

◆ axpy() [1/2]

procedure seqvectormodule::seqvectortype::axpy ( class(seqvectortype) this,
real(dp) alpha,
class(vectorbasetype), pointer vec_x )
Parameters
thisthis vector
alphathe factor
vec_xthe vector to add

Definition at line 22 of file SeqVector.f90.

◆ axpy() [2/2]

procedure(axpy_if), deferred vectorbasemodule::vectorbasetype::axpy ( class(vectorbasetype) this,
real(dp) alpha,
class(vectorbasetype), pointer vec_x )
pure virtualinherited
Parameters
thisthis vector y => alpha*x + y
alphathe factor
vec_xthe vector to add

Definition at line 17 of file VectorBase.f90.

◆ create()

procedure seqvectormodule::seqvectortype::create ( class(seqvectortype) this,
integer(i4b) n )
Parameters
thisthis vector
nthe nr. of elements in the vector

Definition at line 14 of file SeqVector.f90.

◆ create_mm() [1/2]

procedure seqvectormodule::seqvectortype::create_mm ( class(seqvectortype) this,
integer(i4b) n,
character(len=*) name,
character(len=*) mem_path )
Parameters
thisthis vector
nthe nr. of elements in the vector
namethe variable name (for access through memory manager)
mem_pathmemory path for storing the underlying memory items

Definition at line 13 of file SeqVector.f90.

◆ create_mm() [2/2]

procedure(create_mm_if), deferred vectorbasemodule::vectorbasetype::create_mm ( class(vectorbasetype) this,
integer(i4b) n,
character(len=*) name,
character(len=*) mem_path )
pure virtualinherited
Parameters
thisthis vector
nthe nr. of elements in the (local) vector
namethe variable name (for access through memory manager)
mem_pathmemory path for storing the underlying memory items

Definition at line 9 of file VectorBase.f90.

◆ destroy() [1/2]

procedure seqvectormodule::seqvectortype::destroy ( class(seqvectortype) this)
Parameters
thisthis vector

Definition at line 15 of file SeqVector.f90.

◆ destroy() [2/2]

procedure(destroy_if), deferred vectorbasemodule::vectorbasetype::destroy ( class(vectorbasetype) this)
pure virtualinherited
Parameters
thisthis vector

Definition at line 10 of file VectorBase.f90.

◆ get_array() [1/2]

procedure seqvectormodule::seqvectortype::get_array ( class(seqvectortype) this)
Parameters
thisthis vector
Returns
the underlying data array for this vector

Definition at line 16 of file SeqVector.f90.

◆ get_array() [2/2]

procedure(get_array_if), deferred vectorbasemodule::vectorbasetype::get_array ( class(vectorbasetype) this)
pure virtualinherited
Parameters
thisthis vector

Definition at line 11 of file VectorBase.f90.

◆ get_ownership_range() [1/2]

procedure seqvectormodule::seqvectortype::get_ownership_range ( class(seqvectortype) this,
integer(i4b) start,
integer(i4b) end )
Parameters
thisthis vector
startthe index of the first element in the vector
endthe index of the last element in the vector

Definition at line 17 of file SeqVector.f90.

◆ get_ownership_range() [2/2]

procedure(get_ownership_range_if), deferred vectorbasemodule::vectorbasetype::get_ownership_range ( class(vectorbasetype) this,
integer(i4b) start,
integer(i4b) end )
pure virtualinherited
Parameters
thisthis vector
endlocal range in global numbering

Definition at line 12 of file VectorBase.f90.

◆ get_size() [1/2]

procedure seqvectormodule::seqvectortype::get_size ( class(seqvectortype) this)
Parameters
thisthis vector
Returns
the vector size

Definition at line 18 of file SeqVector.f90.

◆ get_size() [2/2]

procedure(get_size_if), deferred vectorbasemodule::vectorbasetype::get_size ( class(vectorbasetype) this)
pure virtualinherited
Parameters
thisthis vector

Definition at line 13 of file VectorBase.f90.

◆ get_value_local() [1/2]

procedure seqvectormodule::seqvectortype::get_value_local ( class(seqvectortype) this,
integer(i4b) idx )
Parameters
thisthis vector
idxthe index in local numbering
Returns
the value

Definition at line 19 of file SeqVector.f90.

◆ get_value_local() [2/2]

procedure(get_value_local_if), deferred vectorbasemodule::vectorbasetype::get_value_local ( class(vectorbasetype) this,
integer(i4b) idx )
pure virtualinherited
Parameters
thisthis vector
idxindex in local numbering

Definition at line 14 of file VectorBase.f90.

◆ norm2() [1/2]

procedure seqvectormodule::seqvectortype::norm2 ( class(seqvectortype) this)
Parameters
thisthis vector

Definition at line 23 of file SeqVector.f90.

◆ norm2() [2/2]

procedure(norm2_if), deferred vectorbasemodule::vectorbasetype::norm2 ( class(vectorbasetype) this)
pure virtualinherited
Parameters
thisthis vector

Definition at line 18 of file VectorBase.f90.

◆ print() [1/2]

procedure seqvectormodule::seqvectortype::print ( class(seqvectortype) this)
Parameters
thisthis vector

Definition at line 24 of file SeqVector.f90.

◆ print() [2/2]

procedure(print_if), deferred vectorbasemodule::vectorbasetype::print ( class(vectorbasetype) this)
pure virtualinherited

Definition at line 19 of file VectorBase.f90.

◆ set_value_local() [1/2]

procedure seqvectormodule::seqvectortype::set_value_local ( class(seqvectortype) this,
integer(i4b) idx,
real(dp) val )
Parameters
thisthis vector
idxthe index in local numbering
valthe value to set

Definition at line 21 of file SeqVector.f90.

◆ set_value_local() [2/2]

procedure(set_value_local_if), deferred vectorbasemodule::vectorbasetype::set_value_local ( class(vectorbasetype) this,
integer(i4b) idx,
real(dp) val )
pure virtualinherited
Parameters
thisthis vector
idxindex in local numbering
valthe value to set

Definition at line 16 of file VectorBase.f90.

◆ zero_entries() [1/2]

procedure seqvectormodule::seqvectortype::zero_entries ( class(seqvectortype) this)
Parameters
thisthis vector

Definition at line 20 of file SeqVector.f90.

◆ zero_entries() [2/2]

procedure(zero_entries_if), deferred vectorbasemodule::vectorbasetype::zero_entries ( class(vectorbasetype) this)
pure virtualinherited

Definition at line 15 of file VectorBase.f90.

Member Data Documentation

◆ array

real(dp), dimension(:), pointer, contiguous seqvectormodule::seqvectortype::array

Definition at line 11 of file SeqVector.f90.

11 real(DP), dimension(:), pointer, contiguous :: array

◆ is_mem_managed

logical(lgp) vectorbasemodule::vectorbasetype::is_mem_managed
inherited

Definition at line 7 of file VectorBase.f90.

7 logical(LGP) :: is_mem_managed

◆ size

integer(i4b), private seqvectormodule::seqvectortype::size
private

Definition at line 10 of file SeqVector.f90.

10 integer(I4B), private :: size

The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Utilities/Vector/SeqVector.f90