Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_ZeroContributedField.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_ZEROCONTRIBUTEDFIELD_HPP
44 #define PANZER_ZEROCONTRIBUTEDFIELD_HPP
45 
47 //
48 // Include Files
49 //
51 
52 // Panzer
54 
55 // Phalanx
56 #include "Phalanx_Evaluator_Derived.hpp"
57 #include "Phalanx_MDField.hpp"
58 
59 namespace panzer
60 {
67  template<typename EvalT, typename Traits>
69  :
70  public panzer::EvaluatorWithBaseImpl<Traits>,
71  public PHX::EvaluatorDerived<EvalT, Traits>
72  {
73  public:
74 
85  const std::string& fieldName,
86  PHX::DataLayout& layout);
87 
93  void
95  typename Traits::EvalData d) override;
96 
97  private:
98 
102  using ScalarT = typename EvalT::ScalarT;
103 
107  PHX::MDField<ScalarT> field_;
108 
109  }; // end of class ZeroContributedField
110 
111 } // end of namespace panzer
112 
113 #endif // PANZER_ZEROCONTRIBUTEDFIELD_HPP
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
PHX::MDField< ScalarT > field_
The field being initialized to zero.
void evaluateFields(typename Traits::EvalData d) override
Evaluate the field.
typename EvalT::ScalarT ScalarT
The scalar data type.
Build a field using a specified data layout, and set it to zero.
ZeroContributedField(const std::string &fieldName, PHX::DataLayout &layout)
Constructor.