// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  crystal growth group                                                  ==
// ==                                                                        ==
// ==  Stiftung caesar                                                       ==
// ==  Ludwig-Erhard-Allee 2                                                 ==
// ==  53175 Bonn                                                            ==
// ==  germany                                                               ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  http://www.caesar.de/cg/AMDiS                                         ==
// ==                                                                        ==
// ============================================================================

/** \file InteriorBoundary.h */

#ifndef AMDIS_INTERIORBOUNDARY_H
#define AMDIS_INTERIORBOUNDARY_H

#include <vector>
#include <map>

#include "MacroElement.h"

namespace AMDiS {

  /// Defines the geometrical objects that forms the boundary;
  struct BoundaryObject {

    /// The macro element to which the boundary element corresponds to.
    Element* el;

    /** \brief
     * Defines the geometrical object at the boundary. It must be "a part" of the
     * macro element \ref el, i.e., either 1 (a vertex), 2 (an edge) or 3 (a face).
     */
    GeoIndex subObjAtBoundary;

    /** \brief
     * Defines which of vertix, edge or face of the macro element is part of the
     * boundary.
     *
     * Example: If the macro element is a triangle, than \ref subObjAtBoundary may
     * be either 1 (vertex) or 2 (edge). Assume its the last one. So this variable
     * defines which of the three possible edges of the triangle is at the interior
     * boundary.
     */
    int ithObjAtBoundary;
  };

  /** \brief 
   * Defines one atomic part of the boundary, i.e., two boundary objects where the
   * boundary goes through.
   */
  struct AtomicBoundary {
    /// The rank's part of the boundary.
    BoundaryObject rankObject;

    /// The object on the other side of the boundary.
    BoundaryObject neighbourObject;
  };

  /** \brief
   * Defines the interior boundary, i.e. a bound within the domain. It is used for
   * the classical domain decomposition parallelization.
   */
  class InteriorBoundary {
  public:
    InteriorBoundary() {}

    AtomicBoundary& getNewAtomicBoundary(int rank);

  public:
    std::map<int, std::vector<AtomicBoundary> > boundary;
  };

}

#endif // AMDIS_INTERIORBOUNDARY_H