Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_Integrator_GradBasisDotVector_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Panzer: A partial differential equation assembly
4 // engine for strongly coupled complex multiphysics systems
5 //
6 // Copyright 2011 NTESS and the Panzer contributors.
7 // SPDX-License-Identifier: BSD-3-Clause
8 // *****************************************************************************
9 // @HEADER
10 
11 #ifndef __Panzer_Integrator_GradBasisDotVector_decl_hpp__
12 #define __Panzer_Integrator_GradBasisDotVector_decl_hpp__
13 
15 //
16 // Include Files
17 //
19 
20 // C++
21 #include <string>
22 
23 // Panzer
26 
27 // Phalanx
28 #include "Phalanx_Evaluator_Derived.hpp"
29 #include "Phalanx_MDField.hpp"
30 
31 namespace panzer
32 {
45  template<typename EvalT, typename Traits>
47  :
48  public panzer::EvaluatorWithBaseImpl<Traits>,
49  public PHX::EvaluatorDerived<EvalT, Traits>
50  {
51  public:
52 
95  const std::string& resName,
96  const std::string& fluxName,
97  const panzer::BasisIRLayout& basis,
98  const panzer::IntegrationRule& ir,
99  const double& multiplier = 1,
100  const std::vector<std::string>& fmNames =
101  std::vector<std::string>(),
102  const Teuchos::RCP<PHX::DataLayout>& vecDL = Teuchos::null);
103 
151  const Teuchos::ParameterList& p);
152 
163  void
165  typename Traits::SetupData d,
167 
177  void
179  typename Traits::EvalData d);
180 
187  template<int NUM_FIELD_MULT>
188  struct FieldMultTag {};
189 
195  template<int NUM_FIELD_MULT>
197 
214  template<int NUM_FIELD_MULT>
215  KOKKOS_INLINE_FUNCTION
216  void
217  operator()(
218  const FieldMultTag<NUM_FIELD_MULT>& tag,
219  const Kokkos::TeamPolicy<PHX::exec_space>::member_type& team) const;
220 
237  template<int NUM_FIELD_MULT>
238  KOKKOS_INLINE_FUNCTION
239  void
240  operator()(
242  const Kokkos::TeamPolicy<PHX::exec_space>::member_type& team) const;
243 
244  private:
245 
257  getValidParameters() const;
258 
262  using ScalarT = typename EvalT::ScalarT;
263 
265  using scratch_view = Kokkos::View<ScalarT* ,typename PHX::DevLayout<ScalarT>::type,typename PHX::exec_space::scratch_memory_space,Kokkos::MemoryUnmanaged>;
266 
277 
283 
290 
295  double multiplier_;
296 
301  std::vector<PHX::MDField<const ScalarT, panzer::Cell, panzer::IP>>
303 
309  PHX::View<PHX::UnmanagedView<const ScalarT**>* > kokkosFieldMults_;
310 
314  std::string basisName_;
315 
320  std::size_t basisIndex_;
321 
328 
330  PHX::View<ScalarT*> tmp_;
331 
332  }; // end of class Integrator_GradBasisDotVector
333 
334 } // end of namespace panzer
335 
336 #endif // __Panzer_Integrator_GradBasisDotVector_decl_hpp__
std::size_t basisIndex_
The index in the Workset bases for our particular BasisIRLayout name.
PHX::MDField< const ScalarT, panzer::Cell, panzer::IP, panzer::Dim > vector_
A field representing the vector-valued function we&#39;re integrating ( ).
double multiplier_
The scalar multiplier 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.
PHX::MDField< ScalarT, panzer::Cell, panzer::BASIS > field_
A field to which we&#39;ll contribute, or in which we&#39;ll store, the result of computing this integral...
Teuchos::RCP< Teuchos::ParameterList > getValidParameters() const
Get Valid Parameters.
KOKKOS_INLINE_FUNCTION void operator()(const FieldMultTag< NUM_FIELD_MULT > &tag, const Kokkos::TeamPolicy< PHX::exec_space >::member_type &team) const
Perform the integration.
This empty struct allows us to optimize operator()() depending on the number of field multipliers...
EvaluatorStyle
An indication of how an Evaluator will behave.
const panzer::EvaluatorStyle evalStyle_
An enum determining the behavior of this Evaluator.
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 ( ...
double multiplier
The scalar multiplier out in front of the integral ( ).
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
PHX::MDField< double, panzer::Cell, panzer::BASIS, panzer::IP, panzer::Dim > basis_
The gradient vector basis information necessary for integration.
panzer::EvaluatorStyle evalStyle
The EvaluatorStyle of the parent Integrator_CurlBasisDotVector object.
std::string basisName_
The name of the basis we&#39;re using.
void evaluateFields(typename Traits::EvalData d)
Evaluate Fields.
PHX::View< PHX::UnmanagedView< const ScalarT ** > * > kokkosFieldMults_
The PHX::View representation of the (possibly empty) list of fields that are multipliers out in front...
void postRegistrationSetup(typename Traits::SetupData d, PHX::FieldManager< Traits > &fm)
Post-Registration Setup.
PHX::View< ScalarT * > tmp_
Temporary used when shared memory is disabled.
This empty struct allows us to optimize operator()() depending on the number of field multipliers...