Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_VectorToScalar_decl.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_EVALUATOR_VECTOR_TO_SCALAR_DECL_HPP
44 #define PANZER_EVALUATOR_VECTOR_TO_SCALAR_DECL_HPP
45 
46 #include <vector>
47 #include <string>
48 #include "Phalanx_Evaluator_Macros.hpp"
49 #include "Phalanx_MDField.hpp"
51 
52 namespace panzer {
53 
54 template<typename EvalT, typename Traits>
56  :
57  public panzer::EvaluatorWithBaseImpl<Traits>,
58  public PHX::EvaluatorDerived<EvalT, Traits>
59 {
60  public:
61 
63  const Teuchos::ParameterList& p);
64 
65  void
67  typename Traits::EvalData d);
68 
69  private:
70 
71  using ScalarT = typename EvalT::ScalarT;
72 
73  std::vector< PHX::MDField<ScalarT,Cell,Point> > scalar_fields;
74  PHX::MDField<const ScalarT,Cell,Point,Dim> vector_field;
75 
76 public:
77 
81  VectorToScalar(const PHX::FieldTag & input,
82  const std::vector<PHX::Tag<ScalarT>> & output);
83 
84 }; // end of class VectorToScalar
85 
86 
99 template <typename EvalT,typename Traits>
101  const std::string & scalarPrefix,
102  const std::vector<std::string> & postfix,
103  const Teuchos::RCP<const PHX::DataLayout> & vectorLayout,
104  const Teuchos::RCP<const PHX::DataLayout> & scalarLayout)
105 {
106  using Teuchos::RCP;
107  using Teuchos::rcp;
108  using Teuchos::rcp_const_cast;
109 
110  RCP<std::vector<std::string> > scalarNames = rcp(new std::vector<std::string>);
111  for(std::size_t i=0;i<postfix.size();i++)
112  scalarNames->push_back(scalarPrefix+postfix[i]);
113 
115  input.set("Vector Name",vectorName);
116  input.set("Scalar Names",scalarNames.getConst());
117  input.set("Data Layout Vector",rcp_const_cast<PHX::DataLayout>(vectorLayout));
118  input.set("Data Layout Scalar",rcp_const_cast<PHX::DataLayout>(scalarLayout));
119 
120  return rcp(new VectorToScalar<EvalT,Traits>(input));
121 }
122 
134 template <typename EvalT,typename Traits>
136  const std::vector<std::string> & postfix,
137  const Teuchos::RCP<const PHX::DataLayout> & vectorLayout,
138  const Teuchos::RCP<const PHX::DataLayout> & scalarLayout)
139 {
140  return vectorToScalarEvaluator<EvalT,Traits>(vectorName,vectorName,postfix,vectorLayout,scalarLayout);
141 }
142 
143 }
144 
145 #endif
RCP< const T > getConst() const
PHX::MDField< const ScalarT, Cell, Point, Dim > vector_field
ParameterList & set(std::string const &name, T const &value, std::string const &docString="", RCP< const ParameterEntryValidator > const &validator=null)
Teuchos::RCP< PHX::Evaluator< Traits > > vectorToScalarEvaluator(const std::string &vectorName, const std::string &scalarPrefix, const std::vector< std::string > &postfix, const Teuchos::RCP< const PHX::DataLayout > &vectorLayout, const Teuchos::RCP< const PHX::DataLayout > &scalarLayout)
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
std::vector< PHX::MDField< ScalarT, Cell, Point > > scalar_fields
VectorToScalar(const Teuchos::ParameterList &p)
void evaluateFields(typename Traits::EvalData d)
typename EvalT::ScalarT ScalarT