Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_CellData.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Panzer: A partial differential equation assembly
5 // engine for strongly coupled complex multiphysics systems
6 // Copyright (2011) Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roger P. Pawlowski (rppawlo@sandia.gov) and
39 // Eric C. Cyr (eccyr@sandia.gov)
40 // ***********************************************************************
41 // @HEADER
42 
43 #ifndef PANZER_CELL_DATA_HPP
44 #define PANZER_CELL_DATA_HPP
45 
46 #include "PanzerDiscFE_config.hpp"
47 
48 #include "Teuchos_Assert.hpp"
49 #include "Teuchos_RCP.hpp"
50 
51 #include "Shards_CellTopology.hpp"
52 #include "Shards_BasicTopologies.hpp"
53 
54 namespace panzer {
55 
65  class CellData {
66 
67  public:
68 
70  explicit CellData()
71  { }
72 
76  explicit CellData(std::size_t num_cells,
78  m_num_cells(num_cells),
79  m_is_side(false),
80  m_side(-1),
81  m_cell_topo(ct)
82  { }
83 
87  explicit CellData(std::size_t num_cells,
88  int local_side_id,const Teuchos::RCP<const shards::CellTopology> & ct) :
89  m_num_cells(num_cells),
90  m_is_side(local_side_id >= 0),
91  m_side(local_side_id),
92  m_cell_topo(ct)
93  { }
94 
95  bool isSide() const
96  {return m_is_side;}
97 
98  int side() const
99  {
100  TEUCHOS_TEST_FOR_EXCEPTION(!m_is_side, std::logic_error,
101  "Cannot return side index, CellData is not a side!");
102  return m_side;
103  }
104 
105  std::size_t numCells() const
106  {return m_num_cells;}
107 
109  int baseCellDimension() const
110  {return m_cell_topo->getDimension();}
111 
114  { return m_cell_topo; }
115 
116  private:
117  std::size_t m_num_cells;
118  bool m_is_side;
119  int m_side;
120 
121 
123  };
124 
125 }
126 
127 #endif
CellData(std::size_t num_cells, const Teuchos::RCP< const shards::CellTopology > &ct)
int baseCellDimension() const
Dimension of the base cell. NOT the dimension of the local side, even if the side() method returns tr...
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Teuchos::RCP< const shards::CellTopology > getCellTopology() const
Get CellTopology for the base cell.
std::size_t numCells() const
Data for determining cell topology and dimensionality.
CellData(std::size_t num_cells, int local_side_id, const Teuchos::RCP< const shards::CellTopology > &ct)
std::size_t m_num_cells
Teuchos::RCP< const shards::CellTopology > m_cell_topo
bool isSide() const