Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_PointDescriptor.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 
44 #ifndef __Panzer_PointDescriptor_hpp__
45 #define __Panzer_PointDescriptor_hpp__
46 
47 #include <string>
48 
49 #include "Teuchos_RCP.hpp"
50 
51 // forward declarations
52 namespace panzer {
53 class PointGenerator;
54 }
55 
56 // class declarations
57 namespace panzer {
58 
60 {
61 public:
62 
64  PointDescriptor() = delete;
65 
72  PointDescriptor(const std::string & type,const Teuchos::RCP<PointGenerator> & generator);
73 
75  virtual ~PointDescriptor() = default;
76 
82  const PointGenerator & getGenerator() const { return *_generator; }
83 
90  const std::string & getType() const { return _type; }
91 
97  std::size_t getKey() const {return _key;}
98 
99 protected:
100 
107  void setup(const std::string & type,const Teuchos::RCP<PointGenerator> & generator);
108 
110  std::string _type;
111 
113  std::size_t _key;
114 
117 };
118 
119 }
120 
121 
122 namespace std {
123 
124 template <>
125 struct hash<panzer::PointDescriptor>
126 {
127  std::size_t operator()(const panzer::PointDescriptor& desc) const;
128 };
129 
130 }
131 
132 
133 #endif
std::size_t getKey() const
Get unique key associated with integrator of this order and type The key is used to sort through a ma...
virtual ~PointDescriptor()=default
Destructor.
Teuchos::RCP< PointGenerator > _generator
PointGenerator object to build the points.
std::size_t _key
Unique key associated with integrator.
PointDescriptor()=delete
Default constructor, no version.
void setup(const std::string &type, const Teuchos::RCP< PointGenerator > &generator)
Setup the point descriptor. Protected and used by constructors.
std::string _type
Type string.
const PointGenerator & getGenerator() const
const std::string & getType() const
Get unique string associated with the type of point descriptor. This will be used generate a hash to ...