Panzer  Version of the Day
Panzer_DotProduct_decl.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_EVALUATOR_DotProduct_DECL_HPP
44 #define PANZER_EVALUATOR_DotProduct_DECL_HPP
45 
46 #include "Phalanx_Evaluator_Macros.hpp"
47 #include "Phalanx_MDField.hpp"
48 
50 
51 namespace panzer {
52 
64 template<typename EvalT, typename Traits>
66  :
67  public panzer::EvaluatorWithBaseImpl<Traits>,
68  public PHX::EvaluatorDerived<EvalT, Traits>
69 {
70  public:
71 
72  DotProduct(
73  const Teuchos::ParameterList& p);
74 
75  void
77  typename Traits::SetupData d,
79 
80  void
82  typename Traits::EvalData d);
83 
84  private:
85 
86  using ScalarT = typename EvalT::ScalarT;
87 
88  PHX::MDField<ScalarT> vec_a_dot_vec_b;
89  PHX::MDField<const ScalarT> vec_a, vec_b;
90  PHX::MDField<const ScalarT> multiplier_field;
91 
92  int num_pts;
93  int num_dim;
94 
97 }; // end of class DotProduct
98 
99 
112 template <typename EvalT,typename TraitsT>
114  const panzer::PointRule & pr,
115  const std::string & vecA,
116  const std::string & vecB,
117  double multiplier=1,
118  const std::string & fieldMultiplier="");
119 
120 }
121 
122 #endif
panzer::DotProduct::postRegistrationSetup
void postRegistrationSetup(typename Traits::SetupData d, PHX::FieldManager< Traits > &fm)
Definition: Panzer_DotProduct_impl.hpp:119
panzer::DotProduct::multiplier_field_on
bool multiplier_field_on
Definition: Panzer_DotProduct_decl.hpp:95
panzer::Traits::SD
Definition: Panzer_Traits.hpp:123
panzer::buildEvaluator_DotProduct
Teuchos::RCP< DotProduct< EvalT, TraitsT > > buildEvaluator_DotProduct(const std::string &resultName, const panzer::PointRule &pr, const std::string &vecA, const std::string &vecB, double multiplier=1, const std::string &fieldMultiplier="")
Build a dot product evaluator. Evaluates dot product at a set of points.
Definition: Panzer_DotProduct_impl.hpp:57
panzer::DotProduct::ScalarT
typename EvalT::ScalarT ScalarT
Definition: Panzer_DotProduct_decl.hpp:86
panzer::DotProduct::vec_b
PHX::MDField< const ScalarT > vec_b
Definition: Panzer_DotProduct_decl.hpp:89
Panzer_Evaluator_Macros.hpp
panzer::Workset
Definition: Panzer_Workset.hpp:186
Teuchos::RCP
multiplier
double multiplier
The scalar multiplier out in front of the integral ( ).
Definition: Panzer_Integrator_CurlBasisDotVector_impl.hpp:410
panzer::DotProduct::multiplier_value
double multiplier_value
Definition: Panzer_DotProduct_decl.hpp:96
panzer::DotProduct::DotProduct
DotProduct(const Teuchos::ParameterList &p)
Definition: Panzer_DotProduct_impl.hpp:78
panzer::PointRule
Definition: Panzer_PointRule.hpp:61
panzer::DotProduct::evaluateFields
void evaluateFields(typename Traits::EvalData d)
Definition: Panzer_DotProduct_impl.hpp:134
panzer::EvaluatorWithBaseImpl
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
Definition: Panzer_Evaluator_WithBaseImpl.hpp:54
panzer::DotProduct::num_dim
int num_dim
Definition: Panzer_DotProduct_decl.hpp:93
panzer::DotProduct
Evaluates dot product at a set of points.
Definition: Panzer_DotProduct_decl.hpp:65
panzer
Definition: Panzer_BasisValues_Evaluator_decl.hpp:54
Teuchos::ParameterList
panzer::DotProduct::vec_a_dot_vec_b
PHX::MDField< ScalarT > vec_a_dot_vec_b
Definition: Panzer_DotProduct_decl.hpp:88
PHX::FieldManager
Definition: Panzer_BCStrategy_Base.hpp:53
panzer::DotProduct::vec_a
PHX::MDField< const ScalarT > vec_a
Definition: Panzer_DotProduct_decl.hpp:89
panzer::DotProduct::num_pts
int num_pts
Definition: Panzer_DotProduct_decl.hpp:92
panzer::DotProduct::multiplier_field
PHX::MDField< const ScalarT > multiplier_field
Definition: Panzer_DotProduct_decl.hpp:90