Panzer_FieldPattern.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//           Panzer: A partial differential equation assembly
//       engine for strongly coupled complex multiphysics systems
//
// Copyright 2011 NTESS and the Panzer contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef __Panzer_FieldPattern_hpp__
#define __Panzer_FieldPattern_hpp__

#include <ostream>
#include <vector>

#include "Shards_CellTopology.hpp"
#include "Teuchos_RCP.hpp"

namespace panzer {

class FieldPattern {
public:
   virtual ~FieldPattern() = 0;

   virtual Teuchos::RCP<panzer::FieldPattern> clone() const = 0;

   virtual int getSubcellCount(int dim) const = 0;

   virtual const std::vector<int> & getSubcellIndices(int dim,int cellIndex) const = 0;

   virtual void getSubcellClosureIndices(int dim,int cellIndex,std::vector<int> & indices) const = 0;

   virtual int getDimension() const = 0;

   virtual shards::CellTopology getCellTopology() const = 0;

   virtual int numberIds() const;

   virtual bool sameGeometry(const FieldPattern & fp) const;

   virtual bool consistentSubcells() const;

   virtual void print(std::ostream & os) const;

   /* Compare two field patterns, a call to <code>sameGeometry()</code>
    * must return true and calls to <code>getSubcellIndices()</code> must
    * return the equivalent vectors
    */
   virtual bool equals(const FieldPattern & fp) const;
};

bool operator==(const panzer::FieldPattern& left,const panzer::FieldPattern& right);
bool operator!=(const panzer::FieldPattern& left,const panzer::FieldPattern& right);

std::ostream & operator<<(std::ostream & os,const FieldPattern & fp);

}

#endif