Panzer Version of the Day
Loading...
Searching...
No Matches
Panzer_Integrator_BasisTimesScalar.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_BASISTIMESSCALAR_HPP
44#define PANZER_INTEGRATOR_BASISTIMESSCALAR_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{
79 template<typename EvalT, typename Traits>
81 :
82 public panzer::EvaluatorWithBaseImpl<Traits>,
83 public PHX::EvaluatorDerived<EvalT, Traits>
84 {
85 public:
86
123 const std::string& resName,
124 const std::string& valName,
125 const panzer::BasisIRLayout& basis,
126 const panzer::IntegrationRule& ir,
127 const double& multiplier = 1,
128 const std::vector<std::string>& fmNames =
129 std::vector<std::string>());
130
175 const Teuchos::ParameterList& p);
176
187 void
189 typename Traits::SetupData sd,
191
201 void
203 typename Traits::EvalData workset);
204
209 template<int NUM_FIELD_MULT>
211 {
212 }; // end of struct FieldMultTag
213
229 template<int NUM_FIELD_MULT>
230 KOKKOS_INLINE_FUNCTION
231 void
234 const std::size_t& cell) const;
235
236 private:
237
248 Teuchos::RCP<Teuchos::ParameterList>
249 getValidParameters() const;
250
254 using ScalarT = typename EvalT::ScalarT;
255
265
270 PHX::MDField<ScalarT, panzer::Cell, panzer::BASIS> field_;
271
276 PHX::MDField<const ScalarT, panzer::Cell, panzer::IP> scalar_;
277
283
288 std::vector<PHX::MDField<const ScalarT, panzer::Cell, panzer::IP>> fieldMults_;
289
295 PHX::View<Kokkos::View<const ScalarT**, typename PHX::DevLayout<ScalarT>::type, Kokkos::MemoryUnmanaged>*> kokkosFieldMults_;
296
301
305 std::string basisName_;
306
311 std::size_t basisIndex_;
312
316 PHX::MDField<double, panzer::Cell, panzer::BASIS, panzer::IP> basis_;
317
319 PHX::View<ScalarT*> tmp_;
321 PHX::View<ScalarT*> tmp2_;
322
323 }; // end of class Integrator_BasisTimesScalar
324
325} // end of namespace panzer
326
327#endif // PANZER_INTEGRATOR_BASISTIMESSCALAR_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.
void evaluateFields(typename Traits::EvalData workset)
Evaluate 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 ( ,...
PHX::View< ScalarT * > tmp2_
For storing temporaries, one value per thread.
KOKKOS_INLINE_FUNCTION void operator()(const FieldMultTag< NUM_FIELD_MULT > &tag, const std::size_t &cell) const
Perform the integration.
PHX::View< Kokkos::View< const ScalarT **, typename PHX::DevLayout< ScalarT >::type, Kokkos::MemoryUnmanaged > * > kokkosFieldMults_
The PHX::View representation of the (possibly empty) list of fields that are multipliers out in front...
PHX::View< ScalarT * > tmp_
For storing temporaries, one value per thread.
int numQP_
The number of quadrature points for each cell.
PHX::MDField< const ScalarT, panzer::Cell, panzer::IP > scalar_
A field representing the scalar function we're integrating ( ).
PHX::MDField< double, panzer::Cell, panzer::BASIS, panzer::IP > basis_
The scalar basis information necessary for integration.
double multiplier_
The scalar multiplier out in front of the integral ( ).
std::size_t basisIndex_
The index in the Workset bases for our particular BasisIRLayout name.
void postRegistrationSetup(typename Traits::SetupData sd, PHX::FieldManager< Traits > &fm)
Post-Registration Setup.
Teuchos::RCP< Teuchos::ParameterList > getValidParameters() const
Get Valid Parameters.
std::string basisName_
The name of the basis we're using.
typename EvalT::ScalarT ScalarT
The scalar type.
const panzer::EvaluatorStyle evalStyle_
An enum determining the behavior of this Evaluator.
Integrator_BasisTimesScalar(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< 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.
EvaluatorStyle
An indication of how an Evaluator will behave.
This empty struct allows us to optimize operator()() depending on the number of field multipliers.