xref: /petsc/src/mat/utils/gcreate.c (revision e452cd2f5c6761e08e2d8d89e2f3e2dbc96d95af)

#ifndef lint
static char vcid[] = "$Id: gcreate.c,v 1.25 1995/05/26 19:24:11 curfman Exp curfman $";
#endif

#include "sys.h"
#include "sysio.h"
#include "mat.h"

/*@C
   MatCreate - Creates a matrix, where the type is determined
   from the options database. Generates a parallel MPI matrix if the
   communicator has more than one processor.

   Input Parameters:
.  m - number of global rows
.  n - number of global columns
.  comm - MPI communicator

   Output Parameter:
.  V - location to stash resulting matrix

   Options Database Keywords:
$  -mat_aij   : AIJ type, uses MatCreateSequentialAIJ()
$               and MatCreateMPIAIJ()
$  -mat_dense : dense type, uses MatCreateSequentialDense()
$  -mat_row   : row type, uses MatCreateSequentialRow()
$               and MatCreateMPIRow()
$  -mat_rowbs : rowbs type (for parallel symmetric matrices only),
$               uses MatCreateMPIRowbs()
$  -mat_bdiag : block diagonal type, uses
$               MatCreateSequentialBDiag() and
$               MatCreateMPIBDiag()
$
$  -mpi_objects : uses MPI matrix (parallel format), even for one processor

   Notes:
   The default matrix type is AIJ, using MatCreateSequentialAIJ() and
   MatCreateMPIAIJ().

.keywords: matrix, create, initial

.seealso: MatCreateSequentialAIJ((), MatCreateMPIAIJ(),
          MatCreateSequentialRow(), MatCreateMPIRow(),
          MatCreateSequentialBDiag(),MatCreateMPIBDiag(),
          MatCreateSequentialDense(), MatCreateMPIRowbs(), MatConvert()
@*/
int MatCreate(MPI_Comm comm,int m,int n,Mat *V)
{
  int numtid;
  MPI_Comm_size(comm,&numtid);
  if (OptionsHasName(0,"-help")) {
    MPIU_printf(comm,"MatCreate() options: -mat_dense, -mat_row -mat_rowbs\n");
    MPIU_printf(comm,"                     -mat_bdiag, -mpi_objects\n");
  }
  if (OptionsHasName(0,"-mat_dense")) {
    return MatCreateSequentialDense(comm,m,n,V);
  }
  if (OptionsHasName(0,"-mat_bdiag")) {
    int nb = 1, ndiag = 0, ndiag2,  *d, ierr;
    OptionsGetInt(0,"-mat_bdiag_bsize",&nb);
    OptionsGetInt(0,"-mat_bdiag_ndiag",&ndiag);
    if (!ndiag) SETERR(1,"Must set diagonals before creating matrix.");
    d = (int *)MALLOC( ndiag * sizeof(int) ); CHKPTR(d);
    ndiag2 = ndiag;
    OptionsGetIntArray(0,"-mat_bdiag_dvals",d,&ndiag2);
    if (ndiag2 != ndiag) {
      SETERR(1,"Incompatible number of diagonals and diagonal values.");
    }
    if (numtid > 1 || OptionsHasName(0,"-mpi_objects"))
      ierr = MatCreateMPIBDiag(comm,PETSC_DECIDE,m,n,ndiag,nb,d,0,V);
    else
      ierr = MatCreateSequentialBDiag(comm,m,n,ndiag,nb,d,0,V);
    CHKERR(ierr);
    if (d) FREE(d);
    return ierr;
  }
  if (numtid > 1 || OptionsHasName(0,"-mpi_objects")) {
    if (OptionsHasName(0,"-mat_row")) {
      return MatCreateMPIRow(comm,PETSC_DECIDE,PETSC_DECIDE,m,n,5,0,0,0,V);
    }
#if defined(HAVE_BLOCKSOLVE) && !defined(__cplusplus)
    if (OptionsHasName(0,"-mat_rowbs")) {
      return MatCreateMPIRowbs(comm,PETSC_DECIDE,m,5,0,0,V);
    }
#endif
    return MatCreateMPIAIJ(comm,PETSC_DECIDE,PETSC_DECIDE,m,n,5,0,0,0,V);
  }
  if (OptionsHasName(0,"-mat_row")) {
    return MatCreateSequentialRow(comm,m,n,10,0,V);
  }
  return MatCreateSequentialAIJ(comm,m,n,10,0,V);
}