Panzer Version of the Day
Loading...
Searching...
No Matches
Panzer_BasisInformation.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_BasisInformation_HPP
44#define PANZER_BasisInformation_HPP
45
46#include <string>
47#include "Teuchos_RCP.hpp"
48
49#include "Shards_CellTopology.hpp"
50
51namespace panzer {
52
55
56 public:
57 typedef enum { HGRAD=0, HCURL=1, HDIV=2, CONST=3 } EElementSpace;
58
64 BasisInformation(const std::string & basis_type,const int basis_order,
65 const shards::CellTopology & cell_topo);
66
68 std::string type() const
69 { return basis_type_; }
70
72 int order() const
73 { return basis_order_; }
74
75 const shards::CellTopology & getCellTopology() const
76 { return topology_; }
77
79 int dimension() const
80 { return topology_.getDimension(); }
81
83 { return element_space_; }
84
87
88 bool supportsGrad() const
89 { return getElementSpace()==HGRAD; }
90
91 bool supportsCurl() const
92 { return getElementSpace()==HCURL; }
93
94 bool supportsDiv() const
95 { return getElementSpace()==HDIV; }
96
97 bool isVectorBasis() const
98 { return getElementSpace()==HCURL || getElementSpace()==HDIV; }
99
100 bool isScalarBasis() const
101 { return getElementSpace()==HGRAD || getElementSpace()==CONST; }
102
103 private:
104
105 shards::CellTopology topology_;
106
107 std::string basis_type_;
109
111 };
112
113}
114
115#endif
Description and data layouts associated with a particular basis.
std::string type() const
Returns the basis type.
EElementSpace getElementSpace() const
int dimension() const
Returns the dimension of the basis from the topology.
const shards::CellTopology & getCellTopology() const
int order() const
Returns the polynomial order of the basis.