Panzer  Version of the Day
Panzer_SubcellSum_impl.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_SubcellSum_impl_hpp__
44 #define __Panzer_SubcellSum_impl_hpp__
45 
46 #include "Panzer_PureBasis.hpp"
49 
50 #include "Phalanx_DataLayout_MDALayout.hpp"
51 
52 namespace panzer {
53 
54 //**********************************************************************
55 PHX_EVALUATOR_CTOR(SubcellSum,p)
56  : evaluateOnClosure_(false)
57 {
58  Teuchos::RCP<Teuchos::ParameterList> valid_params = this->getValidParameters();
59  p.validateParameters(*valid_params);
60 
61  const std::string inName = p.get<std::string>("Field Name");
62  const std::string outName = p.get<std::string>("Sum Name");
63  Teuchos::RCP<const PureBasis> basis = p.get< Teuchos::RCP<const PureBasis> >("Basis");
64  multiplier = p.get<double>("Multiplier");
65  if(p.isType<bool>("Evaluate On Closure"))
66  evaluateOnClosure_ = p.get<bool>("Evaluate On Closure");
67 
68  inField = PHX::MDField<ScalarT,Cell,BASIS>( inName, basis->functional);
69  outField = PHX::MDField<ScalarT,Cell>( outName, basis->cell_data);
70 
71  this->addDependentField(inField);
72  this->addEvaluatedField(outField);
73 
74  // build a field pattern object so that looking up closure indices is easy
75  fieldPattern_ = Teuchos::rcp(new Intrepid2FieldPattern(basis->getIntrepid2Basis()));
76 
77  std::string n = "SubcellSum: " + outField.fieldTag().name();
78  this->setName(n);
79 }
80 
81 //**********************************************************************
82 PHX_POST_REGISTRATION_SETUP(SubcellSum,sd,fm)
83 {
84  this->utils.setFieldData(inField,fm);
85  this->utils.setFieldData(outField,fm);
86 }
87 
88 //**********************************************************************
89 PHX_EVALUATE_FIELDS(SubcellSum,workset)
90 {
91  std::vector<int> indices;
92 
93  // figure out which indices to sum (this can be made more efficient by
94  // simply saving the indices and only updating if the subcell dimension
95  // and index changes)
97  fieldPattern_->getSubcellClosureIndices(workset.subcell_dim,this->wda(workset).subcell_index,indices);
98  else
99  indices = fieldPattern_->getSubcellIndices(workset.subcell_dim,this->wda(workset).subcell_index);
100 
101  for(index_t c=0;c<workset.num_cells;c++) {
102  outField(c) = 0.0; // initialize field
103 
104  // sum over all relevant indices for this subcell
105  for(std::size_t i=0;i<indices.size();i++)
106  outField(c) += inField(c,indices[i]);
107 
108  // scale by what ever the user wants
109  outField(c) *= multiplier;
110  }
111 }
112 
113 //**********************************************************************
114 template<typename EvalT, typename TRAITS>
115 Teuchos::RCP<Teuchos::ParameterList>
117 {
118  Teuchos::RCP<Teuchos::ParameterList> p = Teuchos::rcp(new Teuchos::ParameterList);
119  p->set<std::string>("Sum Name", "?");
120  p->set<std::string>("Field Name", "?");
121  p->set<double>("Multiplier",1.0);
122  p->set<bool>("Evaluate On Closure",false);
123 
124  Teuchos::RCP<const panzer::PureBasis> basis;
125  p->set("Basis", basis);
126 
127  return p;
128 }
129 
130 //**********************************************************************
131 
132 }
133 
134 #endif
PHX::MDField< ScalarT, Cell, BASIS > inField
PHX::MDField< ScalarT, Cell > outField
Teuchos::RCP< Teuchos::ParameterList > getValidParameters() const
PHX_EVALUATOR_CTOR(BasisValues_Evaluator, p)
double multiplier
PHX_EVALUATE_FIELDS(BasisValues_Evaluator, workset)
Teuchos::RCP< const panzer::PureBasis > basis
Interpolates basis DOF values to IP DOF values.
Teuchos::RCP< const panzer::FieldPattern > fieldPattern_
PHX_POST_REGISTRATION_SETUP(BasisValues_Evaluator, sd, fm)