Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_Parameter_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_PARAMETER_DECL_HPP
44 #define PANZER_EVALUATOR_PARAMETER_DECL_HPP
45 
46 #include "PanzerDiscFE_config.hpp"
47 
48 #include "Phalanx_Evaluator_Macros.hpp"
49 #include "Phalanx_MDField.hpp"
50 #include "Teuchos_RCP.hpp"
51 
53 
55 
56 namespace panzer {
57 
58  template <typename EvalT> class ScalarParameterEntry;
59 
61  template<typename EvalT, typename TRAITS>
62  class Parameter :
63  public panzer::EvaluatorWithBaseImpl<TRAITS>,
64  public PHX::EvaluatorDerived<EvalT, TRAITS> {
65 
66  public:
67 
68  Parameter(const std::string parameter_name,
69  const std::string field_name,
70  const Teuchos::RCP<PHX::DataLayout>& data_layout,
71  panzer::ParamLib& param_lib);
72 
73  void evaluateFields(typename TRAITS::EvalData ud);
74 
75  private:
76 
77  typedef typename EvalT::ScalarT ScalarT;
78 
79  PHX::MDField<ScalarT, Cell, Point> target_field;
80 
81  std::size_t cell_data_size;
82 
84 
86  };
87 
88 }
89 
90 #endif
PHX::MDField< ScalarT, Cell, Point > target_field
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
Sacado::ScalarParameterLibrary< panzer::EvaluationTraits > ParamLib
Constant parameter from sacado parameter library.
Parameter(const std::string parameter_name, const std::string field_name, const Teuchos::RCP< PHX::DataLayout > &data_layout, panzer::ParamLib &param_lib)
void evaluateFields(typename TRAITS::EvalData ud)
Teuchos::RCP< panzer::ScalarParameterEntry< EvalT > > param