Panzer Version of the Day
Loading...
Searching...
No Matches
Panzer_Integrator_CurlBasisDotVector.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_CurlBasisDotVector_hpp
44#define Panzer_Integrator_CurlBasisDotVector_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{
84 template<typename EvalT, typename Traits>
86 :
87 public panzer::EvaluatorWithBaseImpl<Traits>,
88 public PHX::EvaluatorDerived<EvalT, Traits>
89 {
90 public:
91
129 const std::string& resName,
130 const std::string& valName,
131 const panzer::BasisIRLayout& basis,
132 const panzer::IntegrationRule& ir,
133 const double& multiplier = 1,
134 const std::vector<std::string>& fmNames =
135 std::vector<std::string>());
136
181 const Teuchos::ParameterList& p);
182
223 const PHX::FieldTag& resTag,
224 const PHX::FieldTag& valTag,
225 const panzer::BasisDescriptor& bd,
227 const int& spaceDim = 3,
228 const double& multiplier = 1,
229 const std::vector<PHX::FieldTag>& multipliers =
230 std::vector<PHX::FieldTag>());
231
244 void
246 typename Traits::SetupData sd,
248
258 void
260 typename Traits::EvalData d);
261
262 private:
263
274 Teuchos::RCP<Teuchos::ParameterList> getValidParameters() const;
275
279 using ScalarT = typename EvalT::ScalarT;
280
290
296
301
306
311 PHX::MDField<ScalarT, panzer::Cell, panzer::BASIS> field_;
312
317 PHX::MDField<const ScalarT, panzer::Cell, panzer::IP> vector2D_;
318
323 PHX::MDField<const ScalarT, panzer::Cell, panzer::IP, panzer::Dim>
325
331
336 std::vector<PHX::MDField<const ScalarT, panzer::Cell, panzer::IP>>
338
344 PHX::View<Kokkos::View<const ScalarT**, typename PHX::DevLayout<ScalarT>::type, Kokkos::MemoryUnmanaged>*> kokkosFieldMults_;
345
349 std::string basisName_;
350
355 std::size_t basisIndex_;
356
362
367 PHX::MDField<ScalarT, panzer::Cell, panzer::IP> result2D_;
368
373 PHX::MDField<ScalarT, panzer::Cell, panzer::IP, panzer::Dim> result3D_;
374 }; // end of class Integrator_CurlBasisDotVector
375
376} // end of namespace panzer
377
378#endif // Panzer_Integrator_CurlBasisDotVector_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.
const panzer::EvaluatorStyle evalStyle_
An enum determining the behavior of this Evaluator.
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::MDField< const ScalarT, panzer::Cell, panzer::IP, panzer::Dim > vector3D_
A field representing the vector-valued function we're integrating ( ) in a three-dimensional problem.
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 ( ,...
std::string basisName_
The name of the basis we're using.
PHX::MDField< const ScalarT, panzer::Cell, panzer::IP > vector2D_
A field representing the vector-valued function we're integrating ( ) in a two-dimensional problem.
Teuchos::RCP< Teuchos::ParameterList > getValidParameters() const
Get Valid Parameters.
void postRegistrationSetup(typename Traits::SetupData sd, PHX::FieldManager< Traits > &fm)
Post-Registration Setup.
panzer::BasisDescriptor bd_
The BasisDescriptor for the basis to use.
double multiplier_
The scalar multiplier out in front of the integral ( ).
panzer::IntegrationDescriptor id_
The IntegrationDescriptor for the quadrature to use.
bool useDescriptors_
A flag indicating whether or not to use the descriptor interface.
int spaceDim_
The spatial dimension of the vector-valued function we're integrating, either 2 or 3.
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.
PHX::MDField< ScalarT, panzer::Cell, panzer::IP, panzer::Dim > result3D_
A field used to build up the result of this integral when working on a three-dimensional vector field...
std::size_t basisIndex_
The index in the Workset bases for our particular BasisIRLayout name.
void evaluateFields(typename Traits::EvalData d)
Evaluate Fields.
PHX::MDField< ScalarT, panzer::Cell, panzer::IP > result2D_
A field used to build up the result of this integral when working on a two-dimensional vector field.
Integrator_CurlBasisDotVector(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.
EvaluatorStyle
An indication of how an Evaluator will behave.