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) 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_FieldPattern_hpp__
#define __Panzer_FieldPattern_hpp__

#include <ostream>
#include <vector>

#include "Shards_CellTopology.hpp"

namespace panzer {

class FieldPattern {
public:
   virtual ~FieldPattern() = 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;
};

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

}

#endif