Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_Integrator_BasisTimesVector.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_BasisTimesVector_decl_hpp__
44 #define __Panzer_Integerator_BasisTimesVector_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 
125  const std::string& resName,
126  const std::string& valName,
127  const panzer::BasisIRLayout& basis,
128  const panzer::IntegrationRule& ir,
129  const double& multiplier = 1,
130  const std::vector<std::string>& fmNames =
131  std::vector<std::string>());
132 
177  const Teuchos::ParameterList& p);
178 
216  const panzer::EvaluatorStyle& evalStyle,
217  const PHX::FieldTag& resTag,
218  const PHX::FieldTag& valTag,
219  const BasisDescriptor& bd,
220  const IntegrationDescriptor& id,
221  const double& multiplier = 1,
222  const std::vector<PHX::FieldTag>& multipliers =
223  std::vector<PHX::FieldTag>());
224 
236  void
238  typename Traits::SetupData sd,
240 
250  void
252  typename Traits::EvalData workset);
253 
258  template<int NUM_FIELD_MULT>
260  {
261  }; // end of struct FieldMultTag
262 
279  template<int NUM_FIELD_MULT>
280  KOKKOS_INLINE_FUNCTION
281  void
282  operator()(
283  const FieldMultTag<NUM_FIELD_MULT>& tag,
284  const std::size_t& cell) const;
285 
286  private:
287 
299  getValidParameters() const;
300 
304  using ScalarT = typename EvalT::ScalarT;
305 
315 
321 
326 
331 
336  PHX::MDField<ScalarT, panzer::Cell, panzer::BASIS> field_;
337 
342  PHX::MDField<const ScalarT, panzer::Cell, panzer::IP, panzer::Dim>
344 
349  double multiplier_;
350 
355  std::vector<PHX::MDField<const ScalarT, panzer::Cell, panzer::IP>>
357 
363  Kokkos::View<Kokkos::View<const ScalarT**,typename PHX::DevLayout<ScalarT>::type,PHX::Device>*> kokkosFieldMults_;
364 
368  int numQP_;
369 
373  int numDim_;
374 
378  std::string basisName_;
379 
384  std::size_t basisIndex_;
385 
389  PHX::MDField<double, panzer::Cell, panzer::BASIS, panzer::IP,
391 
392  }; // end of class Integrator_BasisTimesVector
393 
394 } // end of namespace panzer
395 
396 #endif // __Panzer_Integerator_BasisTimesVector_decl_hpp__
IntegrationDescriptor id_
The IntegrationDescriptor for the quadrature to use.
const panzer::EvaluatorStyle evalStyle_
An enum determining the behavior of this Evaluator.
PHX::MDField< double, panzer::Cell, panzer::BASIS, panzer::IP, panzer::Dim > basis_
The vector basis information necessary for integration.
bool useDescriptors_
A flag indicating whether or not to use the descriptor interface.
BasisDescriptor bd_
The BasisDescriptor for the basis to use.
EvaluatorStyle
An indication of how an Evaluator will behave.
int numQP_
The number of quadrature points for each cell.
std::size_t basisIndex_
The index in the Workset bases for our particular BasisIRLayout name.
double multiplier_
The scalar multiplier out in front of the integral ( ).
std::string basisName_
The name of the basis we&#39;re using.
Teuchos::RCP< Teuchos::ParameterList > getValidParameters() const
Get Valid Parameters.
double multiplier
The scalar multiplier out in front of the integral ( ).
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...
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
void evaluateFields(typename Traits::EvalData workset)
Evaluate Fields.
panzer::EvaluatorStyle evalStyle
The EvaluatorStyle of the parent Integrator_CurlBasisDotVector object.
typename EvalT::ScalarT ScalarT
The scalar type.
This empty struct allows us to optimize operator()() depending on the number of field multipliers...
void postRegistrationSetup(typename Traits::SetupData sd, PHX::FieldManager< Traits > &fm)
Post-Registration Setup.
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...
Integrator_BasisTimesVector(const panzer::EvaluatorStyle &evalStyle, const std::string &resName, const std::string &valName, const panzer::BasisIRLayout &basis, const panzer::IntegrationRule &ir, const double &multiplier=1, const std::vector< std::string > &fmNames=std::vector< std::string >())
Main Constructor.
PHX::MDField< const ScalarT, panzer::Cell, panzer::IP, panzer::Dim > vector_
A field representing the vector-valued function we&#39;re integrating ( ).
int numDim_
The dimensionality of our vector-valued fields.
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 ( ...
KOKKOS_INLINE_FUNCTION void operator()(const FieldMultTag< NUM_FIELD_MULT > &tag, const std::size_t &cell) const
Perform the integration.