![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|


Public Member Functions | |
| procedure | init (this, sparse, mem_path) |
| Initialize sparse matrix from passed. | |
| procedure | destroy (this) |
| procedure | create_vec_mm (this, n, name, mem_path) |
| procedure | create_vec (this, n) |
| procedure | get_value_pos (this, ipos) |
| procedure | get_diag_value (this, irow) |
| procedure | set_diag_value (this, irow, diag_value) |
| procedure | set_value_pos (this, ipos, value) |
| procedure | add_value_pos (this, ipos, value) |
| procedure | add_diag_value (this, irow, value) |
| procedure | zero_entries (this) |
| Set all entries in the matrix to zero. | |
| procedure | zero_row_offdiag (this, irow) |
| Set all off-diagonal entries in the matrix to zero. | |
| procedure | get_first_col_pos (this, irow) |
| procedure | get_last_col_pos (this, irow) |
| procedure | get_column (this, ipos) |
| procedure | get_position (this, irow, icol) |
| Return position index for (irow,icol) element in the matrix. This index can be used in other routines for direct access. | |
| procedure | get_position_diag (this, irow) |
| procedure | get_aij (this, ia, ja, amat) |
| procedure | get_row_offset (this) |
| procedure | multiply (this, vec_x, vec_y) |
| Calculates the matrix vector product y = A*x. | |
| procedure | allocate_scalars (this) |
| procedure | allocate_arrays (this) |
| procedure(init_if), deferred | init (this, sparse, mem_path) |
| procedure(destroy_if), deferred | destroy (this) |
| procedure(create_vec_mm_if), deferred | create_vec_mm (this, n, name, mem_path) |
| procedure(create_vec_if), deferred | create_vec (this, n) |
| procedure(get_value_pos_if), deferred | get_value_pos (this, ipos) |
| procedure(get_diag_value_if), deferred | get_diag_value (this, irow) |
| procedure(set_diag_value_if), deferred | set_diag_value (this, irow, diag_value) |
| procedure(set_value_pos_if), deferred | set_value_pos (this, ipos, value) |
| procedure(add_value_pos_if), deferred | add_value_pos (this, ipos, value) |
| procedure(add_diag_value_if), deferred | add_diag_value (this, irow, value) |
| procedure(zero_entries_if), deferred | zero_entries (this) |
| procedure(zero_row_offdiag_if), deferred | zero_row_offdiag (this, irow) |
| procedure(get_first_col_pos_if), deferred | get_first_col_pos (this, irow) |
| procedure(get_last_col_pos_if), deferred | get_last_col_pos (this, irow) |
| procedure(get_column_if), deferred | get_column (this, ipos) |
| procedure(get_position_if), deferred | get_position (this, irow, icol) |
| procedure(get_position_diag_if), deferred | get_position_diag (this, irow) |
| procedure(get_aij_if), deferred | get_aij (this, ia, ja, amat) |
| procedure(get_row_offset_if), deferred | get_row_offset (this) |
| procedure(multiply_if), deferred | multiply (this, vec_x, vec_y) |
Public Attributes | |
| integer(i4b), pointer | nrow |
| integer(i4b), pointer | ncol |
| integer(i4b), pointer | nja |
| integer(i4b), dimension(:), pointer, contiguous | ia |
| indexes into ja for columns, sorted: diagonal element first | |
| integer(i4b), dimension(:), pointer, contiguous | ja |
| real(dp), dimension(:), pointer, contiguous | amat |
| character(len=lenmempath) | memory_path |
Definition at line 12 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 23 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::add_diag_value | ( | class(sparsematrixtype) | this, |
| integer(i4b) | irow, | ||
| real(dp) | value ) |
Definition at line 31 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 22 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::add_value_pos | ( | class(sparsematrixtype) | this, |
| integer(i4b) | ipos, | ||
| real(dp) | value ) |
Definition at line 30 of file SparseMatrix.f90.
| procedure sparsematrixmodule::sparsematrixtype::allocate_arrays | ( | class(sparsematrixtype) | this | ) |
Definition at line 46 of file SparseMatrix.f90.
| procedure sparsematrixmodule::sparsematrixtype::allocate_scalars | ( | class(sparsematrixtype) | this | ) |
Definition at line 45 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 15 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::create_vec | ( | class(sparsematrixtype) | this, |
| integer(i4b) | n ) |
| n | the nr. of elements in the vector |
Definition at line 23 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 14 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::create_vec_mm | ( | class(sparsematrixtype) | this, |
| integer(i4b) | n, | ||
| character(len=*) | name, | ||
| character(len=*) | mem_path ) |
| 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 22 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 13 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::destroy | ( | class(sparsematrixtype) | this | ) |
Definition at line 21 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 33 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::get_aij | ( | class(sparsematrixtype) | this, |
| integer(i4b), dimension(:), pointer, contiguous | ia, | ||
| integer(i4b), dimension(:), pointer, contiguous | ja, | ||
| real(dp), dimension(:), pointer, contiguous | amat ) |
Definition at line 40 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 29 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::get_column | ( | class(sparsematrixtype) | this, |
| integer(i4b) | ipos ) |
Definition at line 37 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 18 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::get_diag_value | ( | class(sparsematrixtype) | this, |
| integer(i4b) | irow ) |
Definition at line 26 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 27 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::get_first_col_pos | ( | class(sparsematrixtype) | this, |
| integer(i4b) | irow ) |
Definition at line 35 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 28 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::get_last_col_pos | ( | class(sparsematrixtype) | this, |
| integer(i4b) | irow ) |
Definition at line 36 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 30 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::get_position | ( | class(sparsematrixtype) | this, |
| integer(i4b) | irow, | ||
| integer(i4b) | icol ) |
Definition at line 38 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 31 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::get_position_diag | ( | class(sparsematrixtype) | this, |
| integer(i4b) | irow ) |
Definition at line 39 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 34 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::get_row_offset | ( | class(sparsematrixtype) | this | ) |
Definition at line 41 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 17 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::get_value_pos | ( | class(sparsematrixtype) | this, |
| integer(i4b) | ipos ) |
Definition at line 25 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 12 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::init | ( | class(sparsematrixtype) | this, |
| type(sparsematrix) | sparse, | ||
| character(len=*) | mem_path ) |
Definition at line 20 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 36 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::multiply | ( | class(sparsematrixtype) | this, |
| class(vectorbasetype), pointer | vec_x, | ||
| class(vectorbasetype), pointer | vec_y ) |
Definition at line 43 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 20 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::set_diag_value | ( | class(sparsematrixtype) | this, |
| integer(i4b) | irow, | ||
| real(dp) | diag_value ) |
Definition at line 28 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 21 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::set_value_pos | ( | class(sparsematrixtype) | this, |
| integer(i4b) | ipos, | ||
| real(dp) | value ) |
Definition at line 29 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 24 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::zero_entries | ( | class(sparsematrixtype) | this | ) |
Definition at line 32 of file SparseMatrix.f90.
|
pure virtualinherited |
Definition at line 25 of file MatrixBase.f90.
| procedure sparsematrixmodule::sparsematrixtype::zero_row_offdiag | ( | class(sparsematrixtype) | this, |
| integer(i4b) | irow ) |
Definition at line 33 of file SparseMatrix.f90.
| real(dp), dimension(:), pointer, contiguous sparsematrixmodule::sparsematrixtype::amat |
Definition at line 18 of file SparseMatrix.f90.
| integer(i4b), dimension(:), pointer, contiguous sparsematrixmodule::sparsematrixtype::ia |
Definition at line 16 of file SparseMatrix.f90.
| integer(i4b), dimension(:), pointer, contiguous sparsematrixmodule::sparsematrixtype::ja |
Definition at line 17 of file SparseMatrix.f90.
|
inherited |
Definition at line 10 of file MatrixBase.f90.
| integer(i4b), pointer sparsematrixmodule::sparsematrixtype::ncol |
Definition at line 14 of file SparseMatrix.f90.
| integer(i4b), pointer sparsematrixmodule::sparsematrixtype::nja |
Definition at line 15 of file SparseMatrix.f90.
| integer(i4b), pointer sparsematrixmodule::sparsematrixtype::nrow |
Definition at line 13 of file SparseMatrix.f90.