Panzer  Version of the Day
Panzer_GatherTangent_BlockedEpetra_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_GATHER_TANGENT_BLOCKEDEPETRA_DECL_HPP
44 #define PANZER_EVALUATOR_GATHER_TANGENT_BLOCKEDEPETRA_DECL_HPP
45 
46 #include "Phalanx_config.hpp"
47 #include "Phalanx_Evaluator_Macros.hpp"
48 #include "Phalanx_MDField.hpp"
49 
50 #include "Teuchos_ParameterList.hpp"
51 
52 #include "PanzerDiscFE_config.hpp"
53 #include "Panzer_Dimension.hpp"
54 #include "Panzer_Traits.hpp"
56 
58 
59 // thyra forward decl
60 namespace Thyra {
61  template <typename> class ProductVectorBase;
62 }
63 
64 namespace panzer {
65 
66 template <typename LocalOrdinalT,typename GlobalOrdinalT>
67 class UniqueGlobalIndexer; //forward declaration
68 
80 template<typename EvalT,typename TRAITS,typename LO,typename GO>
82  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
83  public PHX::EvaluatorDerived<EvalT, TRAITS>,
85 public:
86 
87  GatherTangent_BlockedEpetra(const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & indexers)
88  : indexers_(indexers) {}
89 
90  GatherTangent_BlockedEpetra(const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & indexers,
91  const Teuchos::ParameterList& p);
92 
93  void postRegistrationSetup(typename TRAITS::SetupData d,
95 
96  void preEvaluate(typename TRAITS::PreEvalData d);
97 
98  void evaluateFields(typename TRAITS::EvalData d);
99 
100  virtual Teuchos::RCP<CloneableEvaluator> clone(const Teuchos::ParameterList & pl) const
101  { return Teuchos::rcp(new GatherTangent_BlockedEpetra<EvalT,TRAITS,LO,GO>(indexers_,pl)); }
102 
103 
104 private:
105 
106  // We always use RealType for gathering as we never compute derivatives for this evaluator
107  //typedef typename panzer::Traits::RealType ScalarT;
108  typedef typename EvalT::ScalarT ScalarT;
109 
110  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > indexers_;
111 
112  std::vector<int> indexerIds_; // block index
113  std::vector<int> subFieldIds_; // sub field numbers
114 
115  std::vector< PHX::MDField<ScalarT,Cell,NODE> > gatherFields_;
116 
117  Teuchos::RCP<std::vector<std::string> > indexerNames_;
119  std::string globalDataKey_; // what global data does this fill?
120 
121  Teuchos::RCP<Thyra::ProductVectorBase<double> > x_;
122 
124 };
125 
126 }
127 
128 // **************************************************************
129 #endif
std::vector< PHX::MDField< ScalarT, Cell, NODE > > gatherFields_
GatherTangent_BlockedEpetra(const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &indexers)
Gathers tangent vectors dx/dp for computing df/dx*dx/dp + df/dp into the nodal fields of the field ma...
Teuchos::RCP< std::vector< std::string > > indexerNames_
PHX::MDField< ScalarT > vector
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
Teuchos::RCP< Thyra::ProductVectorBase< double > > x_
std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > indexers_
void postRegistrationSetup(typename TRAITS::SetupData d, PHX::FieldManager< TRAITS > &vm)
Non-templated empty base class for template managers.
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const