Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_Integrator_BasisTimesTensorTimesVector.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_Integerator_BasisTimesTensorTimesVector_decl_hpp__
44 #define __Panzer_Integerator_BasisTimesTensorTimesVector_decl_hpp__
45 
47 //
48 // Include Files
49 //
51 
52 // C++
53 #include <string>
54 
55 // Kokkos
56 #include "Kokkos_DynRankView.hpp"
57 
58 // Panzer
61 
62 // Phalanx
63 #include "Phalanx_Evaluator_Derived.hpp"
64 #include "Phalanx_MDField.hpp"
65 
66 namespace panzer
67 {
80  template<typename EvalT, typename Traits>
82  :
83  public panzer::EvaluatorWithBaseImpl<Traits>,
84  public PHX::EvaluatorDerived<EvalT, Traits>
85  {
86  public:
87 
119  const std::string& resName,
120  const std::string& valName,
121  const panzer::BasisIRLayout& basis,
122  const panzer::IntegrationRule& ir,
123  const std::string& tensorName );
124 
163  const Teuchos::ParameterList& p);
164 
196  const panzer::EvaluatorStyle& evalStyle,
197  const PHX::FieldTag& resTag,
198  const PHX::FieldTag& valTag,
199  const BasisDescriptor& bd,
200  const IntegrationDescriptor& id,
201  const PHX::FieldTag& tensorTag);
202 
214  void
216  typename Traits::SetupData sd,
218 
228  void
230  typename Traits::EvalData workset);
231 
244  KOKKOS_INLINE_FUNCTION
245  void operator()(const std::size_t& cell) const;
246 
247  private:
248 
260  getValidParameters() const;
261 
265  using ScalarT = typename EvalT::ScalarT;
266 
276 
282 
287 
292 
298 
305 
311 
316  PHX::View<const ScalarT****> kokkosTensor_;
317 
318 
322  int numQP_;
323 
327  int numDim_;
328 
332  std::string basisName_;
333 
338  std::size_t basisIndex_;
339 
345 
347  PHX::View<ScalarT*> tmp_;
348 
349  }; // end of class Integrator_BasisTimesTensorTimesVector
350 
351 } // end of namespace panzer
352 
353 #endif // __Panzer_Integerator_BasisTimesTensorTimesVector_decl_hpp__
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...
const panzer::EvaluatorStyle evalStyle_
An enum determining the behavior of this Evaluator.
Integrator_BasisTimesTensorTimesVector(const panzer::EvaluatorStyle &evalStyle, const std::string &resName, const std::string &valName, const panzer::BasisIRLayout &basis, const panzer::IntegrationRule &ir, const std::string &tensorName)
Main Constructor.
IntegrationDescriptor id_
The IntegrationDescriptor for the quadrature to use.
KOKKOS_INLINE_FUNCTION void operator()(const std::size_t &cell) const
Perform the integration.
EvaluatorStyle
An indication of how an Evaluator will behave.
PHX::MDField< const double, panzer::Cell, panzer::BASIS, panzer::IP, panzer::Dim > basis_
The vector basis information necessary for integration.
void postRegistrationSetup(typename Traits::SetupData sd, 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&#39;re integrating ( ).
PHX::View< const ScalarT **** > kokkosTensor_
The PHX::View representation of the tensor fields that are multiplied out in front of the integral ( ...
void evaluateFields(typename Traits::EvalData workset)
Evaluate Fields.
PHX::MDField< const ScalarT, panzer::Cell, panzer::IP, panzer::Dim, panzer::Dim > tensor_
The tensor field( ).
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
BasisDescriptor bd_
The BasisDescriptor for the basis to use.
panzer::EvaluatorStyle evalStyle
The EvaluatorStyle of the parent Integrator_CurlBasisDotVector object.
bool useDescriptors_
A flag indicating whether or not to use the descriptor interface.
PHX::View< ScalarT * > tmp_
Scratch space for caching temporary values in the kokkos kernel.
std::size_t basisIndex_
The index in the Workset bases for our particular BasisIRLayout name.