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 // 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 
130  const std::string& resName,
131  const std::string& fluxName,
132  const panzer::BasisIRLayout& basis,
133  const panzer::IntegrationRule& ir,
134  const double& multiplier = 1,
135  const std::vector<std::string>& fmNames =
136  std::vector<std::string>(),
137  const Teuchos::RCP<PHX::DataLayout>& vecDL = Teuchos::null);
138 
186  const Teuchos::ParameterList& p);
187 
200  void
202  typename Traits::SetupData d,
204 
214  void
216  typename Traits::EvalData d);
217 
222  template<int NUM_FIELD_MULT>
224  {
225  }; // end of struct FieldMultTag
226 
243  template<int NUM_FIELD_MULT>
244  KOKKOS_INLINE_FUNCTION
245  void
246  operator()(
247  const FieldMultTag<NUM_FIELD_MULT>& tag,
248  const std::size_t& cell) const;
249 
250  private:
251 
263  getValidParameters() const;
264 
268  using ScalarT = typename EvalT::ScalarT;
269 
280 
285  PHX::MDField<ScalarT, panzer::Cell, panzer::BASIS> field_;
286 
291  PHX::MDField<const ScalarT, panzer::Cell, panzer::IP, panzer::Dim>
293 
298  double multiplier_;
299 
304  std::vector<PHX::MDField<const ScalarT, panzer::Cell, panzer::IP>>
306 
312  Kokkos::View<Kokkos::View<const ScalarT**>*> kokkosFieldMults_;
313 
317  int numQP_;
318 
322  int numDim_;
323 
327  std::string basisName_;
328 
333  std::size_t basisIndex_;
334 
339  PHX::MDField<double, panzer::Cell, panzer::BASIS, panzer::IP,
340  panzer::Dim> basis_;
341 
342  }; // end of class Integrator_GradBasisDotVector
343 
344 } // end of namespace panzer
345 
346 #endif // __Panzer_Integrator_GradBasisDotVector_decl_hpp__
panzer::Integrator_GradBasisDotVector::getValidParameters
Teuchos::RCP< Teuchos::ParameterList > getValidParameters() const
Get Valid Parameters.
Definition: Panzer_Integrator_GradBasisDotVector_impl.hpp:324
panzer::Traits::SD
Definition: Panzer_Traits.hpp:123
panzer::Integrator_GradBasisDotVector::basisIndex_
std::size_t basisIndex_
The index in the Workset bases for our particular BasisIRLayout name.
Definition: Panzer_Integrator_GradBasisDotVector_decl.hpp:333
panzer::IntegrationRule
Definition: Panzer_IntegrationRule.hpp:73
panzer::Integrator_GradBasisDotVector::numQP_
int numQP_
The number of quadrature points for each cell.
Definition: Panzer_Integrator_GradBasisDotVector_decl.hpp:317
panzer::Integrator_GradBasisDotVector::vector_
PHX::MDField< const ScalarT, panzer::Cell, panzer::IP, panzer::Dim > vector_
A field representing the vector-valued function we're integrating ( ).
Definition: Panzer_Integrator_GradBasisDotVector_decl.hpp:292
Panzer_EvaluatorStyle.hpp
panzer::Integrator_GradBasisDotVector::postRegistrationSetup
void postRegistrationSetup(typename Traits::SetupData d, PHX::FieldManager< Traits > &fm)
Post-Registration Setup.
Definition: Panzer_Integrator_GradBasisDotVector_impl.hpp:189
panzer::Workset
Definition: Panzer_Workset.hpp:186
Teuchos::RCP< PHX::DataLayout >
multiplier
double multiplier
The scalar multiplier out in front of the integral ( ).
Definition: Panzer_Integrator_CurlBasisDotVector_impl.hpp:410
panzer::Integrator_GradBasisDotVector::evalStyle_
const panzer::EvaluatorStyle evalStyle_
An enum determining the behavior of this Evaluator.
Definition: Panzer_Integrator_GradBasisDotVector_decl.hpp:279
Panzer_Evaluator_WithBaseImpl.hpp
panzer::Integrator_GradBasisDotVector::ScalarT
typename EvalT::ScalarT ScalarT
The scalar type.
Definition: Panzer_Integrator_GradBasisDotVector_decl.hpp:268
panzer::Integrator_GradBasisDotVector::numDim_
int numDim_
The number of dimensions in the vector field .
Definition: Panzer_Integrator_GradBasisDotVector_decl.hpp:322
panzer::Integrator_GradBasisDotVector::basis_
PHX::MDField< double, panzer::Cell, panzer::BASIS, panzer::IP, panzer::Dim > basis_
The gradient vector basis information necessary for integration.
Definition: Panzer_Integrator_GradBasisDotVector_decl.hpp:340
panzer::EvaluatorStyle
EvaluatorStyle
An indication of how an Evaluator will behave.
Definition: Panzer_EvaluatorStyle.hpp:54
panzer::Integrator_GradBasisDotVector::Integrator_GradBasisDotVector
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.
Definition: Panzer_Integrator_GradBasisDotVector_impl.hpp:66
evalStyle
panzer::EvaluatorStyle evalStyle
The EvaluatorStyle of the parent Integrator_CurlBasisDotVector object.
Definition: Panzer_Integrator_CurlBasisDotVector_impl.hpp:602
panzer::Integrator_GradBasisDotVector::field_
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.
Definition: Panzer_Integrator_GradBasisDotVector_decl.hpp:285
panzer::Integrator_GradBasisDotVector
Computes .
Definition: Panzer_Integrator_GradBasisDotVector_decl.hpp:81
panzer::Integrator_GradBasisDotVector::operator()
KOKKOS_INLINE_FUNCTION void operator()(const FieldMultTag< NUM_FIELD_MULT > &tag, const std::size_t &cell) const
Perform the integration.
panzer::EvaluatorWithBaseImpl
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
Definition: Panzer_Evaluator_WithBaseImpl.hpp:54
panzer::Integrator_GradBasisDotVector::fieldMults_
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 ( ,...
Definition: Panzer_Integrator_GradBasisDotVector_decl.hpp:305
panzer::Integrator_GradBasisDotVector::multiplier_
double multiplier_
The scalar multiplier out in front of the integral ( ).
Definition: Panzer_Integrator_GradBasisDotVector_decl.hpp:298
panzer::Integrator_GradBasisDotVector::FieldMultTag
This empty struct allows us to optimize operator()() depending on the number of field multipliers.
Definition: Panzer_Integrator_GradBasisDotVector_decl.hpp:223
panzer
Definition: Panzer_BasisValues_Evaluator_decl.hpp:54
Teuchos::ParameterList
PHX::FieldManager
Definition: Panzer_BCStrategy_Base.hpp:53
panzer::Integrator_GradBasisDotVector::evaluateFields
void evaluateFields(typename Traits::EvalData d)
Evaluate Fields.
Definition: Panzer_Integrator_GradBasisDotVector_impl.hpp:296
panzer::Integrator_GradBasisDotVector::kokkosFieldMults_
Kokkos::View< Kokkos::View< const ScalarT ** > * > kokkosFieldMults_
The Kokkos::View representation of the (possibly empty) list of fields that are multipliers out in fr...
Definition: Panzer_Integrator_GradBasisDotVector_decl.hpp:312
panzer::BasisIRLayout
Definition: Panzer_BasisIRLayout.hpp:71
panzer::Integrator_GradBasisDotVector::basisName_
std::string basisName_
The name of the basis we're using.
Definition: Panzer_Integrator_GradBasisDotVector_decl.hpp:327