Panzer_ConnManager.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//           Panzer: A partial differential equation assembly
//       engine for strongly coupled complex multiphysics systems
//                 Copyright (2011) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 Roger P. Pawlowski (rppawlo@sandia.gov) and
// Eric C. Cyr (eccyr@sandia.gov)
// ***********************************************************************
// @HEADER

#ifndef __Panzer_ConnManager_hpp__
#define __Panzer_ConnManager_hpp__

#include <vector>

// Teuchos includes
#include "Teuchos_RCP.hpp"
#include "Shards_CellTopology.hpp"
namespace panzer {

class FieldPattern; // from DOFManager

template <typename LocalOrdinalT>
class ConnManagerBase {
public:
   typedef LocalOrdinalT LocalOrdinal;

   virtual ~ConnManagerBase() {}

   virtual void buildConnectivity(const FieldPattern & fp) = 0;
  
   virtual Teuchos::RCP<ConnManagerBase<LocalOrdinalT> > noConnectivityClone() const = 0;

   virtual LocalOrdinal getConnectivitySize(LocalOrdinal localElmtId) const = 0;

   virtual std::string getBlockId(LocalOrdinal localElmtId) const = 0;

   virtual std::size_t numElementBlocks() const = 0;

   virtual void getElementBlockIds(std::vector<std::string> & elementBlockIds) const = 0; 

   virtual void getElementBlockTopologies(std::vector<shards::CellTopology> & elementBlockTopologies) const = 0;

     virtual const std::vector<LocalOrdinal> & getElementBlock(const std::string & blockID) const = 0;

   virtual const std::vector<LocalOrdinal> & getNeighborElementBlock(const std::string & blockID) const = 0;

   virtual const std::vector<LocalOrdinal>& getAssociatedNeighbors(const LocalOrdinal& el) const = 0;

   virtual bool hasAssociatedNeighbors() const = 0;
};

template <typename LocalOrdinalT,typename GlobalOrdinalT>
class ConnManager : public ConnManagerBase<LocalOrdinalT> {
public:
   typedef GlobalOrdinalT GlobalOrdinal;
   typedef LocalOrdinalT LocalOrdinal;

   virtual ~ConnManager() {}

   virtual void buildConnectivity(const FieldPattern & fp) = 0;

   virtual Teuchos::RCP<ConnManagerBase<LocalOrdinalT> > noConnectivityClone() const = 0;

   virtual const GlobalOrdinal * getConnectivity(LocalOrdinal localElmtId) const = 0;

   virtual LocalOrdinal getConnectivitySize(LocalOrdinal localElmtId) const = 0;

   virtual std::string getBlockId(LocalOrdinal localElmtId) const = 0;

   virtual std::size_t numElementBlocks() const = 0;

   virtual void getElementBlockIds(std::vector<std::string> & elementBlockIds) const = 0; 

   virtual const std::vector<LocalOrdinal> & getElementBlock(const std::string & blockID) const = 0;

   virtual const std::vector<LocalOrdinal> & getNeighborElementBlock(const std::string & blockID) const = 0;
};

}

#endif