Panzer  Version of the Day
Panzer_Integrator_GradBasisDotVector_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_Integrator_GradBasisDotVector_decl_hpp__
44 #define __Panzer_Integrator_GradBasisDotVector_decl_hpp__
45 
47 //
48 // Include Files
49 //
51 
52 // C++
53 #include <string>
54 
55 // Panzer
58 
59 // Phalanx
60 #include "Phalanx_Evaluator_Derived.hpp"
61 #include "Phalanx_MDField.hpp"
62 
63 namespace panzer
64 {
77  template<typename EvalT, typename Traits>
79  :
80  public panzer::EvaluatorWithBaseImpl<Traits>,
81  public PHX::EvaluatorDerived<EvalT, Traits>
82  {
83  public:
84 
127  const std::string& resName,
128  const std::string& fluxName,
129  const panzer::BasisIRLayout& basis,
130  const panzer::IntegrationRule& ir,
131  const double& multiplier = 1,
132  const std::vector<std::string>& fmNames =
133  std::vector<std::string>(),
134  const Teuchos::RCP<PHX::DataLayout>& vecDL = Teuchos::null);
135 
183  const Teuchos::ParameterList& p);
184 
195  void
197  typename Traits::SetupData d,
199 
209  void
211  typename Traits::EvalData d);
212 
219  template<int NUM_FIELD_MULT>
220  struct FieldMultTag {};
221 
227  template<int NUM_FIELD_MULT>
229 
246  template<int NUM_FIELD_MULT>
247  KOKKOS_INLINE_FUNCTION
248  void
249  operator()(
250  const FieldMultTag<NUM_FIELD_MULT>& tag,
251  const Kokkos::TeamPolicy<PHX::exec_space>::member_type& team) const;
252 
269  template<int NUM_FIELD_MULT>
270  KOKKOS_INLINE_FUNCTION
271  void
272  operator()(
274  const Kokkos::TeamPolicy<PHX::exec_space>::member_type& team) const;
275 
276  private:
277 
288  Teuchos::RCP<Teuchos::ParameterList>
289  getValidParameters() const;
290 
294  using ScalarT = typename EvalT::ScalarT;
295 
297  using scratch_view = Kokkos::View<ScalarT* ,typename PHX::DevLayout<ScalarT>::type,typename PHX::exec_space::scratch_memory_space,Kokkos::MemoryUnmanaged>;
298 
309 
314  PHX::MDField<ScalarT, panzer::Cell, panzer::BASIS> field_;
315 
320  PHX::MDField<const ScalarT, panzer::Cell, panzer::IP, panzer::Dim>
322 
327  double multiplier_;
328 
333  std::vector<PHX::MDField<const ScalarT, panzer::Cell, panzer::IP>>
335 
341  Kokkos::View<Kokkos::View<const ScalarT**,typename PHX::DevLayout<ScalarT>::type,PHX::Device>*> kokkosFieldMults_;
342 
346  std::string basisName_;
347 
352  std::size_t basisIndex_;
353 
358  PHX::MDField<double, panzer::Cell, panzer::BASIS, panzer::IP,
360 
361  }; // end of class Integrator_GradBasisDotVector
362 
363 } // end of namespace panzer
364 
365 #endif // __Panzer_Integrator_GradBasisDotVector_decl_hpp__
panzer::EvaluatorStyle evalStyle
The EvaluatorStyle of the parent Integrator_CurlBasisDotVector object.
double multiplier
The scalar multiplier out in front of the integral ( ).
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
PHX::MDField< ScalarT, panzer::Cell, panzer::BASIS > field_
A field to which we'll contribute, or in which we'll store, the result of computing this integral.
double multiplier_
The scalar multiplier out in front of the integral ( ).
Teuchos::RCP< Teuchos::ParameterList > getValidParameters() const
Get Valid Parameters.
std::vector< PHX::MDField< const ScalarT, panzer::Cell, panzer::IP > > fieldMults_
The (possibly empty) list of fields that are multipliers out in front of the integral ( ,...
Integrator_GradBasisDotVector(const panzer::EvaluatorStyle &evalStyle, const std::string &resName, const std::string &fluxName, const panzer::BasisIRLayout &basis, const panzer::IntegrationRule &ir, const double &multiplier=1, const std::vector< std::string > &fmNames=std::vector< std::string >(), const Teuchos::RCP< PHX::DataLayout > &vecDL=Teuchos::null)
Main Constructor.
Kokkos::View< ScalarT *,typename PHX::DevLayout< ScalarT >::type, typename PHX::exec_space::scratch_memory_space, Kokkos::MemoryUnmanaged > scratch_view
Type for shared memory.
void postRegistrationSetup(typename Traits::SetupData d, PHX::FieldManager< Traits > &fm)
Post-Registration Setup.
PHX::MDField< const ScalarT, panzer::Cell, panzer::IP, panzer::Dim > vector_
A field representing the vector-valued function we're integrating ( ).
const panzer::EvaluatorStyle evalStyle_
An enum determining the behavior of this Evaluator.
std::string basisName_
The name of the basis we're using.
KOKKOS_INLINE_FUNCTION void operator()(const FieldMultTag< NUM_FIELD_MULT > &tag, const Kokkos::TeamPolicy< PHX::exec_space >::member_type &team) const
Perform the integration.
Kokkos::View< Kokkos::View< const ScalarT **, typename PHX::DevLayout< ScalarT >::type, PHX::Device > * > kokkosFieldMults_
The Kokkos::View representation of the (possibly empty) list of fields that are multipliers out in fr...
PHX::MDField< double, panzer::Cell, panzer::BASIS, panzer::IP, panzer::Dim > basis_
The gradient vector basis information necessary for integration.
void evaluateFields(typename Traits::EvalData d)
Evaluate Fields.
std::size_t basisIndex_
The index in the Workset bases for our particular BasisIRLayout name.
EvaluatorStyle
An indication of how an Evaluator will behave.
This empty struct allows us to optimize operator()() depending on the number of field multipliers....
This empty struct allows us to optimize operator()() depending on the number of field multipliers....