Panzer Version of the Day
Loading...
Searching...
No Matches
Panzer_Integrator_DivBasisTimesScalar.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_DivBasisTimesScalar_hpp__
44#define __Panzer_Integrator_DivBasisTimesScalar_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
66namespace panzer
67{
80 template<typename EvalT, typename Traits>
82 :
83 public panzer::EvaluatorWithBaseImpl<Traits>,
84 public PHX::EvaluatorDerived<EvalT, Traits>
85 {
86 public:
87
124 const std::string& resName,
125 const std::string& valName,
126 const panzer::BasisIRLayout& basis,
127 const panzer::IntegrationRule& ir,
128 const double& multiplier = 1,
129 const std::vector<std::string>& fmNames =
130 std::vector<std::string>());
131
176 const Teuchos::ParameterList& p);
177
188 void
190 typename Traits::SetupData d,
192
202 void
204 typename Traits::EvalData d);
205
210 template<int NUM_FIELD_MULT>
212 {
213 }; // end of struct FieldMultTag
214
219 template<int NUM_FIELD_MULT>
221 {
222 }; // end of struct FieldMultTag
223
239 template<int NUM_FIELD_MULT>
240 KOKKOS_INLINE_FUNCTION
241 void
244 const Kokkos::TeamPolicy<PHX::exec_space>::member_type& team) const;
245
261 template<int NUM_FIELD_MULT>
262 KOKKOS_INLINE_FUNCTION
263 void
266 const Kokkos::TeamPolicy<PHX::exec_space>::member_type& team) const;
267
268 private:
269
280 Teuchos::RCP<Teuchos::ParameterList> getValidParameters() const;
281
285 using ScalarT = typename EvalT::ScalarT;
286
288 using scratch_view = Kokkos::View<ScalarT* ,typename PHX::DevLayout<ScalarT>::type,typename PHX::exec_space::scratch_memory_space,Kokkos::MemoryUnmanaged>;
289
299
304 PHX::MDField<ScalarT, Cell, BASIS> field_;
305
310 PHX::MDField<const ScalarT, Cell, IP> scalar_;
311
317
322 std::vector<PHX::MDField<const ScalarT, Cell, IP>> fieldMults_;
323
329 PHX::View<PHX::UnmanagedView<const ScalarT**>*> kokkosFieldMults_;
330
334 std::size_t numQP_;
335
339 std::string basisName_;
340
345 std::size_t basisIndex_;
346
350 PHX::MDField<double, panzer::Cell, panzer::BASIS, panzer::IP> basis_;
351
356
358 PHX::View<ScalarT*> tmp_;
359
360 }; // end of class Integrator_DivBasisTimesScalar
361
362} // end of namespace panzer
363
364#endif // __Panzer_Integrator_DivBasisTimesScalar_hpp__
panzer::EvaluatorStyle evalStyle
The EvaluatorStyle of the parent Integrator_CurlBasisDotVector object.
double multiplier
The scalar multiplier out in front of the integral ( ).
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
PHX::MDField< const ScalarT, Cell, IP > scalar_
A field representing the scalar function we're integrating ( ).
Teuchos::RCP< Teuchos::ParameterList > getValidParameters() const
Get Valid Parameters.
PHX::MDField< double, panzer::Cell, panzer::BASIS, panzer::IP > basis_
The scalar basis information necessary for integration.
std::size_t numQP_
The number of quadrature points for each cell.
KOKKOS_INLINE_FUNCTION void operator()(const FieldMultTag< NUM_FIELD_MULT > &tag, const Kokkos::TeamPolicy< PHX::exec_space >::member_type &team) const
Perform the integration. Main memory version.
Integrator_DivBasisTimesScalar(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.
void postRegistrationSetup(typename Traits::SetupData d, PHX::FieldManager< Traits > &fm)
Post-Registration Setup.
Kokkos::View< ScalarT *,typename PHX::DevLayout< ScalarT >::type, typename PHX::exec_space::scratch_memory_space, Kokkos::MemoryUnmanaged > scratch_view
Type for shared memory.
std::string basisName_
The name of the basis we're using.
void evaluateFields(typename Traits::EvalData d)
Evaluate Fields.
PHX::View< ScalarT * > tmp_
Temporary for non-shared calculations.
const panzer::EvaluatorStyle evalStyle_
An enum determining the behavior of this Evaluator.
double multiplier_
The scalar multiplier out in front of the integral ( ).
bool use_shared_memory
If set to true, device shared memory will be used.
std::size_t basisIndex_
The index in the Workset bases for our particular BasisIRLayout name.
PHX::MDField< ScalarT, Cell, BASIS > field_
A field to which we'll contribute, or in which we'll store, the result of computing this integral.
PHX::View< PHX::UnmanagedView< const ScalarT ** > * > kokkosFieldMults_
The PHX::View representation of the (possibly empty) list of fields that are multipliers out in front...
std::vector< PHX::MDField< const ScalarT, Cell, IP > > fieldMults_
The (possibly empty) list of fields that are multipliers out in front of the integral ( ,...
EvaluatorStyle
An indication of how an Evaluator will behave.
This empty struct allows us to optimize operator()() depending on the number of field multipliers.
This empty struct allows us to optimize operator()() depending on the number of field multipliers.