gridenums.hh

// SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
// SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
#ifndef DUNE_GRID_COMMON_GRIDENUMS_HH
#define DUNE_GRID_COMMON_GRIDENUMS_HH
 
#include <iostream>
 
#include <dune/common/exceptions.hh>
 
namespace Dune {
 
  enum PartitionType {
    InteriorEntity=0,     
    BorderEntity=1  ,     
    OverlapEntity=2 ,     
    FrontEntity=3  ,      
    GhostEntity=4         
  };
 
  inline std::string PartitionName(PartitionType type)
  {
    switch(type) {
    case InteriorEntity :
      return "interior";
    case BorderEntity :
      return "border";
    case OverlapEntity :
      return "overlap";
    case FrontEntity :
      return "front";
    case GhostEntity :
      return "ghost";
    default :
      DUNE_THROW(NotImplemented, "name of unknown partition type requested");
    }
  }
 
 
  inline std::ostream &operator<< ( std::ostream &out, const PartitionType &type )
  {
    return out << PartitionName( type );
  }
 
 
  enum InterfaceType {
    InteriorBorder_InteriorBorder_Interface=0,     
    InteriorBorder_All_Interface=1,                
    Overlap_OverlapFront_Interface=2,              
    Overlap_All_Interface=3,                       
    All_All_Interface=4                            
  };
 
 
 
  inline std::ostream &operator<< ( std::ostream &out, const InterfaceType &type )
  {
    switch( type )
    {
    case InteriorBorder_InteriorBorder_Interface :
      return out << "interior-border / interior-border interface";
 
    case InteriorBorder_All_Interface :
      return out << "interior-border / all interface";
 
    case Overlap_OverlapFront_Interface :
      return out << "overlap / overlap-front interface";
 
    case Overlap_All_Interface :
      return out << "overlap / all interface";
 
    case All_All_Interface :
      return out << "all / all interface";
 
    default :
      return out << "unknown interface";
    }
  }
 
 
  enum PartitionIteratorType {
    Interior_Partition=0,           
    InteriorBorder_Partition=1,     
    Overlap_Partition=2,            
    OverlapFront_Partition=3,       
    All_Partition=4,                
    Ghost_Partition=5               
  };
 
 
 
  inline std::ostream &operator<< ( std::ostream &out, const PartitionIteratorType &type )
  {
    static std::string name[ 6 ] = { "interior partition", "interior-border partition", "overlap partition",
                                     "overlap-front partition", "all partition", "ghost partition" };
    return out << name[ type ];
  }
 
 
  enum CommunicationDirection {
    ForwardCommunication,     
    BackwardCommunication     
  };
 
}
#endif