Panzer  Version of the Day
Panzer_GatherTangent_BlockedTpetra.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_BLOCKEDTPETRA_DECL_HPP
44 #define PANZER_EVALUATOR_GATHER_TANGENT_BLOCKEDTPETRA_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 class Tpetra_Vector;
60 class Tpetra_CrsMatrix;
61 
62 namespace panzer {
63 
64 template <typename ScalarT,typename LocalOrdinalT,typename GlobalOrdinalT,typename NodeT>
65 class BlockedTpetraLinearObjContainer;
66 
67 template <typename LocalOrdinalT,typename GlobalOrdinalT>
68 class UniqueGlobalIndexer; //forward declaration
69 
70 template <typename LocalOrdinalT,typename GlobalOrdinalT>
71 class BlockedDOFManager; //forward declaration
72 
84 template <typename EvalT,typename TRAITS,typename S,typename LO,typename GO,typename NodeT=panzer::TpetraNodeType>
86  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
87  public PHX::EvaluatorDerived<EvalT, TRAITS>,
89 public:
90 
91  GatherTangent_BlockedTpetra(const Teuchos::RCP<const BlockedDOFManager<LO,GO> > & indexer)
92  : gidIndexer_(indexer) {}
93 
94  GatherTangent_BlockedTpetra(const Teuchos::RCP<const BlockedDOFManager<LO,GO> > & indexer,
95  const Teuchos::ParameterList& p);
96 
97  void postRegistrationSetup(typename TRAITS::SetupData d,
99 
100  void preEvaluate(typename TRAITS::PreEvalData d);
101 
102  void evaluateFields(typename TRAITS::EvalData d);
103 
104  virtual Teuchos::RCP<CloneableEvaluator> clone(const Teuchos::ParameterList & pl) const
105  { return Teuchos::rcp(new GatherTangent_BlockedTpetra<EvalT,TRAITS,S,LO,GO>(gidIndexer_,pl)); }
106 
107 private:
108 
109  // We always use RealType for gathering as we never compute derivatives for this evaluator
110  //typedef typename panzer::Traits::RealType ScalarT;
111  typedef typename EvalT::ScalarT ScalarT;
112 
114  typedef Tpetra::Vector<S,LO,GO,NodeT> VectorType;
115  typedef Tpetra::CrsMatrix<S,LO,GO,NodeT> CrsMatrixType;
116  typedef Tpetra::CrsGraph<LO,GO,NodeT> CrsGraphType;
117  typedef Tpetra::Map<LO,GO,NodeT> MapType;
118  typedef Tpetra::Import<LO,GO,NodeT> ImportType;
119  typedef Tpetra::Export<LO,GO,NodeT> ExportType;
120 
121  // maps the local (field,element,basis) triplet to a global ID
122  // for scattering
123  Teuchos::RCP<const BlockedDOFManager<LO,GO> > gidIndexer_;
124 
125  std::vector<int> fieldIds_; // field IDs needing mapping
126 
127  std::vector< PHX::MDField<ScalarT,Cell,NODE> > gatherFields_;
128 
129  Teuchos::RCP<std::vector<std::string> > indexerNames_;
131  std::string globalDataKey_; // what global data does this fill?
132 
133  Teuchos::RCP<const BlockedTpetraLinearObjContainer<S,LO,GO,NodeT> > blockedContainer_;
134 
136 };
137 
138 }
139 
141 
142 // **************************************************************
143 #endif
Teuchos::RCP< std::vector< std::string > > indexerNames_
BlockedTpetraLinearObjContainer< S, LO, GO, NodeT > ContainerType
GatherTangent_BlockedTpetra(const Teuchos::RCP< const BlockedDOFManager< LO, GO > > &indexer)
Tpetra::CrsMatrix< S, LO, GO, NodeT > CrsMatrixType
void postRegistrationSetup(typename TRAITS::SetupData d, PHX::FieldManager< TRAITS > &vm)
Teuchos::RCP< const BlockedDOFManager< LO, GO > > gidIndexer_
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
std::vector< PHX::MDField< ScalarT, Cell, NODE > > gatherFields_
Teuchos::RCP< const BlockedTpetraLinearObjContainer< S, LO, GO, NodeT > > blockedContainer_
Gathers tangent vectors dx/dp for computing df/dx*dx/dp + df/dp into the nodal fields of the field ma...
Non-templated empty base class for template managers.