Panzer  Version of the Day
Panzer_ScatterResidual_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_SCATTER_RESIDUAL_BLOCKEDEPETRA_DECL_HPP
44 #define PANZER_EVALUATOR_SCATTER_RESIDUAL_BLOCKEDEPETRA_DECL_HPP
45 
46 #include "Phalanx_config.hpp"
47 #include "Phalanx_Evaluator_Macros.hpp"
48 #include "Phalanx_MDField.hpp"
49 
51 
52 #include "PanzerDiscFE_config.hpp"
53 #include "Panzer_Dimension.hpp"
54 #include "Panzer_Traits.hpp"
57 
59 
60 class Epetra_Vector;
61 class Epetra_CrsMatrix;
62 
63 namespace Thyra {
64  template <typename> class ProductVectorBase;
65  template <typename> class BlockedLinearOpBase;
66 }
67 
68 namespace panzer {
69 
70 template <typename LocalOrdinalT,typename GlobalOrdinalT>
71 class UniqueGlobalIndexer;
72 
77 template<typename EvalT, typename TRAITS,typename LO,typename GO> class ScatterResidual_BlockedEpetra
78  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
79  public PHX::EvaluatorDerived<panzer::Traits::Residual, TRAITS>,
81 public:
82  typedef typename EvalT::ScalarT ScalarT;
83 
85 
88 
89  void postRegistrationSetup(typename TRAITS::SetupData d, PHX::FieldManager<TRAITS>& vm)
90  { }
91  void evaluateFields(typename TRAITS::EvalData d)
92  { std::cout << "unspecialized version of \"ScatterResidual_BlockedEpetra::evaluateFields\" on "+PHX::typeAsString<EvalT>()+" \" should not be used!" << std::endl;
93  TEUCHOS_ASSERT(false); }
94 };
95 
96 // **************************************************************
97 // **************************************************************
98 // * Specializations
99 // **************************************************************
100 // **************************************************************
101 
102 
103 // **************************************************************
104 // Residual
105 // **************************************************************
106 template<typename TRAITS,typename LO,typename GO>
108  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
109  public PHX::EvaluatorDerived<panzer::Traits::Residual, TRAITS>,
111 
112 public:
113 
115  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & cIndexers,
116  bool useDiscreteAdjoint=false)
117  : rowIndexers_(rIndexers) {}
118 
120  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & cIndexers,
121  const Teuchos::ParameterList& p,
122  bool useDiscreteAdjoint=false);
123 
124  void postRegistrationSetup(typename TRAITS::SetupData d,
126 
127  void preEvaluate(typename TRAITS::PreEvalData d);
128 
129  void evaluateFields(typename TRAITS::EvalData workset);
130 
132  { return Teuchos::rcp(new ScatterResidual_BlockedEpetra<panzer::Traits::Residual,TRAITS,LO,GO>(rowIndexers_,colIndexers_,pl)); }
133 
134 private:
136 
137  // dummy field so that the evaluator will have something to do
139 
140  // fields that need to be scattered will be put in this vector
141  std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
142 
143  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > rowIndexers_;
144  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > colIndexers_;
145 
146  std::vector<int> indexerIds_; // block index
147  std::vector<int> subFieldIds_; // sub field numbers
148 
149  // This maps the scattered field names to the DOF manager field
150  // For instance a Navier-Stokes map might look like
151  // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
152  // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
154 
155  std::string globalDataKey_; // what global data does this fill?
156 
158 
160 };
161 
162 // **************************************************************
163 // Tangent
164 // **************************************************************
165 template<typename TRAITS,typename LO,typename GO>
167  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
168  public PHX::EvaluatorDerived<panzer::Traits::Tangent, TRAITS>,
170 
171 public:
172 
174  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & cIndexers,
175  bool useDiscreteAdjoint=false)
176  : rowIndexers_(rIndexers) {}
177 
179  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & cIndexers,
180  const Teuchos::ParameterList& p,
181  bool useDiscreteAdjoint=false);
182 
183  void postRegistrationSetup(typename TRAITS::SetupData d,
185 
186  void preEvaluate(typename TRAITS::PreEvalData d);
187 
188  void evaluateFields(typename TRAITS::EvalData workset);
189 
191  { return Teuchos::rcp(new ScatterResidual_BlockedEpetra<panzer::Traits::Tangent,TRAITS,LO,GO>(rowIndexers_,colIndexers_,pl)); }
192 
193 private:
195 
196  // dummy field so that the evaluator will have something to do
198 
199  // fields that need to be scattered will be put in this vector
200  std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
201 
202  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > rowIndexers_;
203  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > colIndexers_;
204 
205  std::vector<int> indexerIds_; // block index
206  std::vector<int> subFieldIds_; // sub field numbers
207 
208  // This maps the scattered field names to the DOF manager field
209  // For instance a Navier-Stokes map might look like
210  // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
211  // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
213 
214  std::string globalDataKey_; // what global data does this fill?
215 
217 
219 };
220 
221 // **************************************************************
222 // Jacobian
223 // **************************************************************
224 
225 template<typename TRAITS,typename LO,typename GO>
227  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
228  public PHX::EvaluatorDerived<panzer::Traits::Jacobian, TRAITS>,
230 
231 public:
232 
254  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & cIndexers,
255  bool useDiscreteAdjoint=false)
256  : rowIndexers_(rIndexers), colIndexers_(cIndexers), useDiscreteAdjoint_(useDiscreteAdjoint) {}
257 
259  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & cIndexers,
260  const Teuchos::ParameterList& p,
261  bool useDiscreteAdjoint=false);
262 
263  void postRegistrationSetup(typename TRAITS::SetupData d,
265 
266  void preEvaluate(typename TRAITS::PreEvalData d);
267 
268  void evaluateFields(typename TRAITS::EvalData workset);
269 
271  { return Teuchos::rcp(new ScatterResidual_BlockedEpetra<panzer::Traits::Jacobian,TRAITS,LO,GO>(rowIndexers_,colIndexers_,pl,useDiscreteAdjoint_)); }
272 
273 private:
274 
276 
277  // dummy field so that the evaluator will have something to do
279 
280  // fields that need to be scattered will be put in this vector
281  std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
282 
283  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > rowIndexers_;
284  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > colIndexers_;
285 
286  std::vector<int> indexerIds_; // block index
287  std::vector<int> subFieldIds_; // sub field numbers
288 
289  // This maps the scattered field names to the DOF manager field
290  // For instance a Navier-Stokes map might look like
291  // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
292  // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
294 
295  std::string globalDataKey_; // what global data does this fill?
297 
300 
302 };
303 
304 }
305 
306 // optionally include hessian support
307 #ifdef Panzer_BUILD_HESSIAN_SUPPORT
309 #endif
310 
311 // **************************************************************
312 #endif
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
PHX::MDField< ScalarT > vector
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
ScatterResidual_BlockedEpetra(const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &rIndexers, const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &cIndexers, bool useDiscreteAdjoint=false)
ScatterResidual_BlockedEpetra(const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &rIndexers, const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &cIndexers, bool useDiscreteAdjoint=false)
Pushes residual values into the residual vector for a Newton-based solve.
void postRegistrationSetup(typename TRAITS::SetupData d, PHX::FieldManager< TRAITS > &vm)
#define TEUCHOS_ASSERT(assertion_test)
ScatterResidual_BlockedEpetra(const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &rIndexers, const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &cIndexers, bool useDiscreteAdjoint=false)
Non-templated empty base class for template managers.
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const