Actual source code: slepcmat.h

      1: /*
      2:    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      3:    SLEPc - Scalable Library for Eigenvalue Problem Computations
      4:    Copyright (c) 2002-, Universitat Politecnica de Valencia, Spain

      6:    This file is part of SLEPc.
      7:    SLEPc is distributed under a 2-clause BSD license (see LICENSE).
      8:    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      9: */
     10: /*
     11:    User interface for various matrix operations added in SLEPc
     12: */

     14: #pragma once

     16: #include <petscmat.h>

     18: /* SUBMANSEC = Sys */

     20: SLEPC_EXTERN PetscErrorCode MatCreateTile(PetscScalar,Mat,PetscScalar,Mat,PetscScalar,Mat,PetscScalar,Mat,Mat*);
     21: SLEPC_EXTERN PetscErrorCode MatCreateVecsEmpty(Mat,Vec*,Vec*);
     22: SLEPC_EXTERN PetscErrorCode MatNormEstimate(Mat,Vec,Vec,PetscReal*);

     24: /* Matrices for structured eigenproblems */
     25: SLEPC_EXTERN PetscErrorCode MatCreateBSE(Mat,Mat,Mat*);
     26: SLEPC_EXTERN PetscErrorCode MatCreateHamiltonian(Mat,Mat,Mat,Mat*);
     27: SLEPC_EXTERN PetscErrorCode MatCreateLREP(Mat,Mat,PetscBool,Mat*);

     29: /* Deprecated functions */
     30: PETSC_DEPRECATED_FUNCTION(3, 6, 0, "MatCreateRedundantMatrix() followed by MatConvert()", ) static inline PetscErrorCode SlepcMatConvertSeqDense(Mat mat,Mat *newmat)
     31: {
     32:   Mat Ar;

     34:   PetscFunctionBegin;
     35:   PetscCall(MatCreateRedundantMatrix(mat,0,PETSC_COMM_SELF,MAT_INITIAL_MATRIX,&Ar));
     36:   PetscCall(MatConvert(Ar,MATSEQDENSE,MAT_INITIAL_MATRIX,newmat));
     37:   PetscCall(MatDestroy(&Ar));
     38:   PetscFunctionReturn(PETSC_SUCCESS);
     39: }
     40: PETSC_DEPRECATED_FUNCTION(3, 8, 0, "MatCreateTile()", ) static inline PetscErrorCode SlepcMatTile(PetscScalar a,Mat A,PetscScalar b,Mat B,PetscScalar c,Mat C,PetscScalar d,Mat D,Mat *G) {return MatCreateTile(a,A,b,B,c,C,d,D,G);}