MathLib::PETScMatrixOption Struct Reference

Detailed Description

This a struct data containing the configuration information to create a PETSc type matrix.

Definition at line 24 of file PETScMatrixOption.h.

#include <PETScMatrixOption.h>

Public Member Functions
	PETScMatrixOption ()

Public Attributes
bool	is_global_size
	Flag for the type of size, which is one of arguments of the constructor of class PETScMatrix true: the size is the number of local rows, false: the size is the number of global rows. The default is false.
PetscInt	n_local_cols
	Number of local columns. The default is PETSC_DECIDE.
PetscInt	d_nz
	Number of nonzeros per row in the diagonal portion of local submatrix (same value is used for all local rows), the default is PETSC_DECIDE.
PetscInt	o_nz
	Number of nonzeros per row in the off-diagonal portion of local submatrix (same value is used for all local rows), the default is PETSC_DECIDE.

Constructor & Destructor Documentation

PETScMatrixOption()

MathLib::PETScMatrixOption::PETScMatrixOption ( )

inline

Definition at line 26 of file PETScMatrixOption.h.

        : is_global_size(true),
          n_local_cols(PETSC_DECIDE),
          d_nz(PETSC_DECIDE),
          o_nz(PETSC_DECIDE)
    {
    }

Member Data Documentation

d_nz

PetscInt MathLib::PETScMatrixOption::d_nz

Number of nonzeros per row in the diagonal portion of local submatrix (same value is used for all local rows), the default is PETSC_DECIDE.

Definition at line 51 of file PETScMatrixOption.h.

Referenced by MathLib::PETScMatrix::PETScMatrix(), and MathLib::PETScMatrix::PETScMatrix().

is_global_size

bool MathLib::PETScMatrixOption::is_global_size

Flag for the type of size, which is one of arguments of the constructor of class PETScMatrix true: the size is the number of local rows, false: the size is the number of global rows. The default is false.

Definition at line 41 of file PETScMatrixOption.h.

Referenced by MathLib::PETScMatrix::PETScMatrix(), and MathLib::PETScMatrix::PETScMatrix().

n_local_cols

PetscInt MathLib::PETScMatrixOption::n_local_cols

Number of local columns. The default is PETSC_DECIDE.

Definition at line 44 of file PETScMatrixOption.h.

o_nz

PetscInt MathLib::PETScMatrixOption::o_nz

Number of nonzeros per row in the off-diagonal portion of local submatrix (same value is used for all local rows), the default is PETSC_DECIDE.

Definition at line 58 of file PETScMatrixOption.h.

Referenced by MathLib::PETScMatrix::PETScMatrix(), and MathLib::PETScMatrix::PETScMatrix().

---

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

• MathLib/LinAlg/PETSc/PETScMatrixOption.h