Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_Integrator_GradBasisDotTensorTimesVector_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_GradBasisDotTensorTimesVector_decl_hpp__
44 #define __Panzer_Integrator_GradBasisDotTensorTimesVector_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 
121  const std::string& resName,
122  const std::string& fluxName,
123  const panzer::BasisIRLayout& basis,
124  const panzer::IntegrationRule& ir,
125  const std::string& tensorName,
126  const Teuchos::RCP<PHX::DataLayout>& vecDL = Teuchos::null);
127 
169  const Teuchos::ParameterList& p);
170 
181  void
183  typename Traits::SetupData d,
185 
195  void
197  typename Traits::EvalData d);
198 
205  struct FieldMultTag {};
206 
213 
230  // template<int NUM_FIELD_MULT>
231  KOKKOS_INLINE_FUNCTION
232  void
233  operator()(
234  const FieldMultTag& tag,
235  const Kokkos::TeamPolicy<PHX::exec_space>::member_type& team) const;
236 
253  // template<int NUM_FIELD_MULT>
254  KOKKOS_INLINE_FUNCTION
255  void
256  operator()(
257  const SharedFieldMultTag& tag,
258  const Kokkos::TeamPolicy<PHX::exec_space>::member_type& team) const;
259 
260  private:
261 
273  getValidParameters() const;
274 
278  using ScalarT = typename EvalT::ScalarT;
279 
281  using scratch_view = Kokkos::View<ScalarT* ,typename PHX::DevLayout<ScalarT>::type,typename PHX::exec_space::scratch_memory_space,Kokkos::MemoryUnmanaged>;
282 
293 
299 
306 
312 
317  PHX::View<const ScalarT****> kokkosTensor_;
318 
322  std::string basisName_;
323 
328  std::size_t basisIndex_;
329 
336 
338  PHX::View<ScalarT*> tmp_;
339 
340  }; // end of class Integrator_GradBasisDotTensorTimesVector
341 
342 } // end of namespace panzer
343 
344 #endif // __Panzer_Integrator_GradBasisDotTensorTimesVector_decl_hpp__
std::size_t basisIndex_
The index in the Workset bases for our particular BasisIRLayout name.
This empty struct allows us to optimize operator()() depending on the number of field multipliers...
KOKKOS_INLINE_FUNCTION void operator()(const FieldMultTag &tag, const Kokkos::TeamPolicy< PHX::exec_space >::member_type &team) const
Perform the integration.
PHX::MDField< const ScalarT, panzer::Cell, panzer::IP, panzer::Dim, panzer::Dim > tensor_
The tensor field( ).
EvaluatorStyle
An indication of how an Evaluator will behave.
PHX::MDField< double, panzer::Cell, panzer::BASIS, panzer::IP, panzer::Dim > basis_
The gradient vector basis information necessary for integration.
void postRegistrationSetup(typename Traits::SetupData d, PHX::FieldManager< Traits > &fm)
Post-Registration Setup.
Teuchos::RCP< Teuchos::ParameterList > getValidParameters() const
Get Valid Parameters.
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...
PHX::View< ScalarT * > tmp_
Temporary used when shared memory is disabled.
Integrator_GradBasisDotTensorTimesVector(const panzer::EvaluatorStyle &evalStyle, const std::string &resName, const std::string &fluxName, const panzer::BasisIRLayout &basis, const panzer::IntegrationRule &ir, const std::string &tensorName, const Teuchos::RCP< PHX::DataLayout > &vecDL=Teuchos::null)
Main Constructor.
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
panzer::EvaluatorStyle evalStyle
The EvaluatorStyle of the parent Integrator_CurlBasisDotVector object.
PHX::MDField< const ScalarT, panzer::Cell, panzer::IP, panzer::Dim > vector_
A field representing the vector-valued function we&#39;re integrating ( ).
const panzer::EvaluatorStyle evalStyle_
An enum determining the behavior of this Evaluator.
This empty struct allows us to optimize operator()() depending on the number of field multipliers...
PHX::View< const ScalarT **** > kokkosTensor_
The PHX::View representation of the tensor fields that are multiplied out in front of the integral ( ...