Panzer  Version of the Day
Panzer_CellAverage.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_CellAverage_hpp__
44 #define __Panzer_CellAverage_hpp__
45 
46 #include <string>
47 #include "Panzer_Dimension.hpp"
48 #include "Phalanx_Evaluator_Macros.hpp"
49 #include "Phalanx_MDField.hpp"
50 #include "Kokkos_DynRankView.hpp"
51 
53 
54 namespace panzer {
55 
69 PANZER_EVALUATOR_CLASS(CellAverage)
70 
71  PHX::MDField<ScalarT,Cell> average; // result
72 
73  PHX::MDField<const ScalarT,Cell,IP> scalar; // function to be integrated
74 
75  std::vector<PHX::MDField<const ScalarT,Cell,IP> > field_multipliers;
76  double multiplier;
77 
78  std::size_t num_qp;
79  std::size_t quad_index;
81 
82 public:
83  // for testing purposes
84  const PHX::FieldTag & getFieldTag() const
85  { return average.fieldTag(); }
86 
87 private:
88  Teuchos::RCP<Teuchos::ParameterList> getValidParameters() const;
89 
91 
103 template <typename EvalT,typename Traits>
104 Teuchos::RCP<PHX::Evaluator<Traits> > cellAverageEvaluator(const std::string & averageName,
105  const std::string & fieldName,
106  const Teuchos::RCP<const panzer::IntegrationRule> & ir)
107 {
108  using Teuchos::RCP;
109  using Teuchos::rcp;
110  using Teuchos::rcp_const_cast;
111 
112  Teuchos::ParameterList input;
113  input.set("Average Name",averageName);
114  input.set("Field Name",fieldName);
115  input.set("IR",rcp_const_cast<panzer::IntegrationRule>(ir));
116 
117  return rcp(new CellAverage<EvalT,Traits>(input));
118 }
119 
120 }
121 
122 #endif
std::size_t num_qp
const PHX::FieldTag & getFieldTag() const
PHX::MDField< const ScalarT > input
#define PANZER_EVALUATOR_CLASS(NAME)
Macro definition of an evaluator class.
PHX::MDField< ScalarT, Cell > average
PANZER_EVALUATOR_CLASS_END Teuchos::RCP< PHX::Evaluator< Traits > > cellAverageEvaluator(const std::string &averageName, const std::string &fieldName, const Teuchos::RCP< const panzer::IntegrationRule > &ir)
PHX::MDField< ScalarT > vector
Teuchos::RCP< Teuchos::ParameterList > getValidParameters() const
std::size_t quad_index
double multiplier
#define PANZER_EVALUATOR_CLASS_END
Macro definition to end an evaluator class declaration.
PHX::MDField< const ScalarT, Cell, IP > scalar
std::vector< PHX::MDField< const ScalarT, Cell, IP > > field_multipliers