Panzer  Version of the Day
Panzer_ZeroSensitivities.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_ZERO_SENSITIVITIES_HPP
44 #define PANZER_ZERO_SENSITIVITIES_HPP
45 
46 #include <iostream>
47 #include "Panzer_Traits.hpp" // for scalar types
48 
49 namespace panzer {
50 
52  // template<typename ScalarT>
53  // void zeroSensitivities(ScalarT& s);
54 
57 
60  {
61  s.zero();
62  }
63 
65 #ifdef Panzer_BUILD_HESSIAN_SUPPORT
66  inline void zeroSensitivities(panzer::Traits::HessianType& s)
67  {
68  s.val().zero(); // is this right...? What does zero sensitivities mean here?
69  s.zero();
70  }
71 #endif
72 
74  /*
75  template<typename S, unsigned l, unsigned s, typename b>
76  inline
77  void
78  zeroSensitivities(Sacado::Fad::ViewFad<S,l,s,b> v)
79  {
80  v.zero();
81  }
82  */
83  template <typename T>
84  inline
85  typename Sacado::mpl::enable_if< Sacado::IsView<T> >::type
87  //std::cout << "zeroSensitivities - ViewFad" << std::endl;
88  x.zero();
89  }
90 
91 }
92 
93 #endif
void zeroSensitivities(panzer::Traits::RealType &s)
Zero out AD types so that we can drop sensitivity contributions.
PANZER_FADTYPE FadType