SubdomainGraph_dh.h

Go to the documentation of this file.

/*@HEADER
// ***********************************************************************
//
//       Ifpack: Object-Oriented Algebraic Preconditioner Package
//                 Copyright (2002) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER
*/

#ifndef SUBDOMAIN_GRAPH_DH
#define SUBDOMAIN_GRAPH_DH

#if defined(Ifpack_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The Ifpack package is deprecated"
#endif
#endif

#include "euclid_common.h"

#ifdef __cplusplus
extern "C"
{
#endif

#define MAX_SUBDOMAIN_COLOR 100
  /* could be done better: if we can't color the subdomain graph
     with this many colors, an error is thrown in SubdomainGraph_dhColor().
   */

/* for internal timing */
#define TIMING_BINS_SG 10
  enum
  { TOTAL_SGT,      /* total Init (setup) time */
    FIND_NABORS_SGT,
    ORDER_BDRY_SGT,
    FORM_GRAPH_SGT,
    EXCHANGE_PERMS_SGT
  };

  struct _subdomain_dh
  {
    int blocks;     /* number of subdomains */
    int *ptrs, *adj;    /* csr structure for representing subdomain graph */
    int *o2n_sub;   /* subdomain graph permutation; */
    int *n2o_sub;   /* inverse permutation; */
    int colors;     /* number of colors used  for coloring the subdomain graph */
    bool doNotColor;    /* if true, subdomain graph is not colored and reordered */
    int *colorVec;    /* if colorVec[i] = x, then subdomain i was colored "x".
           this array is probably only useful for debugging.
         */

    int *beg_row;   /* global ordering of first local row owned by P_i */
    int *beg_rowP;    /* global ordering of first local row owned by P_i after
           subdomain reordering 
         */
    int *row_count;   /* P_i owns row_count[i] local rows */
    int *bdry_count;    /* bdry_count[i] of P_i's rows are boundary rows */

    /* Nearest neighbors in subdomain graph, before reordering;
       "self" is not included.  Not used for sequential case.
     */
    int *loNabors, loCount;
    int *hiNabors, hiCount;
    int *allNabors, allCount;


    /* permutation information for global unknowns (matrix rows) */
    int m;      /* length of n2o_row and o2n_col */
    int *n2o_row;   /* permutation for locally owned matrix rows */
    int *o2n_col;   /* permutation for locally owned matrix columns */

    Hash_i_dh o2n_ext;    /* permutation for external columns */
    Hash_i_dh n2o_ext;    /* inverse permutation for external columns */

    double timing[TIMING_BINS_SG];
    bool debug;
  };

  extern void SubdomainGraph_dhCreate (SubdomainGraph_dh * s);
  extern void SubdomainGraph_dhDestroy (SubdomainGraph_dh s);

  extern void SubdomainGraph_dhInit (SubdomainGraph_dh s, int blocks, bool bj,
             void *A);
  /* Partitions matrix A into the specified number of blocks,
     if there is a single MPI task; for mpi use, "blocks" must be the same 
     as the number of mpi tasks; for sequential, it may vary.
     On completion, the subdomain graph will be fully formed,
     (all fields valid); o2n_row[] and n2o_col[] will be permutations
     for the locally owned portion of A such that A's interior nodes are
     ordered first.
     This function may call a partitioner, such as METIS (currently, only for sequential).
     On completion, "o2n" contains a natural ordering, beg_row is identical to
     beg_rowP, and_rowP is identical to end_rowP.

     if "bj" is true, the following setup steps are NOT performed:
     form subdomain graph; find neighbors; order boundary nodes
   */

  extern void SubdomainGraph_dhColor (SubdomainGraph_dh s);
  /*
     Colors and orders subdomain graph; on completion, o2n[], beg_rowP[], and
     end_rowP[] may be altered.
   */

  extern int SubdomainGraph_dhFindOwner (SubdomainGraph_dh s, int idx,
           bool permuted);
  /* Returns the subdomain block to which row idx belongs, or throws an error.
     If "permuted" is true, it's assumed the graph has been permuted (i.e.,
     'globally reordering phase' in PILU algorithm).
   */

  extern void SubdomainGraph_dhExchangePerms (SubdomainGraph_dh s);
  /*
     exchange permutation information for external columns with nearest neighbors;
     caller must ensure SubdomainGraph_dhInit() has completed before calling.
   */

  extern void SubdomainGraph_dhPrintSubdomainGraph (SubdomainGraph_dh s,
                FILE * fp);

  extern void SubdomainGraph_dhPrintStatsLong (SubdomainGraph_dh s,
                 FILE * fp);
  /* similar to Short, but prints complete list of interior/bdry node ratios;
     also prints subdomain permutation
   */

  extern void SubdomainGraph_dhDump (SubdomainGraph_dh s, char *filename);
  /* for testing */

  extern void SubdomainGraph_dhPrintRatios (SubdomainGraph_dh s, FILE * fp);
  /* prints ratios of interior/boundary node for all subdomains */


  extern void SubdomainGraph_dhPrintStats (SubdomainGraph_dh sg, FILE * fp);

#ifdef __cplusplus
}
#endif
#endif