Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 namespace Thyra {
61  template <typename> class ProductVectorBase;
62  template <typename> class BlockedLinearOpBase;
63 }
64 
65 namespace panzer {
66 
67 template <typename LocalOrdinalT,typename GlobalOrdinalT>
68 class UniqueGlobalIndexer;
69 
74 template<typename EvalT, typename TRAITS,typename LO,typename GO> class ScatterResidual_BlockedEpetra
75  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
76  public PHX::EvaluatorDerived<panzer::Traits::Residual, TRAITS>,
78 public:
79  typedef typename EvalT::ScalarT ScalarT;
80 
82 
85 
86  void postRegistrationSetup(typename TRAITS::SetupData d, PHX::FieldManager<TRAITS>& vm)
87  { }
88  void evaluateFields(typename TRAITS::EvalData d)
89  { std::cout << "unspecialized version of \"ScatterResidual_BlockedEpetra::evaluateFields\" on "+PHX::typeAsString<EvalT>()+" \" should not be used!" << std::endl;
90  TEUCHOS_ASSERT(false); }
91 };
92 
93 // **************************************************************
94 // **************************************************************
95 // * Specializations
96 // **************************************************************
97 // **************************************************************
98 
99 
100 // **************************************************************
101 // Residual
102 // **************************************************************
103 template<typename TRAITS,typename LO,typename GO>
105  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
106  public PHX::EvaluatorDerived<panzer::Traits::Residual, TRAITS>,
108 
109 public:
110 
112  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & /* cIndexers */,
113  bool /* useDiscreteAdjoint=false */)
114  : rowIndexers_(rIndexers) {}
115 
116  ScatterResidual_BlockedEpetra(const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & rIndexers,
117  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & cIndexers,
118  const Teuchos::ParameterList& p,
119  bool useDiscreteAdjoint=false);
120 
121  void postRegistrationSetup(typename TRAITS::SetupData d,
123 
124  void preEvaluate(typename TRAITS::PreEvalData d);
125 
126  void evaluateFields(typename TRAITS::EvalData workset);
127 
129  { return Teuchos::rcp(new ScatterResidual_BlockedEpetra<panzer::Traits::Residual,TRAITS,LO,GO>(rowIndexers_,colIndexers_,pl)); }
130 
131 private:
133 
134  // dummy field so that the evaluator will have something to do
136 
137  // fields that need to be scattered will be put in this vector
138  std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
139 
140  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > rowIndexers_;
141  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > colIndexers_;
142 
143  std::vector<int> indexerIds_; // block index
144  std::vector<int> subFieldIds_; // sub field numbers
145 
146  // This maps the scattered field names to the DOF manager field
147  // For instance a Navier-Stokes map might look like
148  // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
149  // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
151 
152  std::string globalDataKey_; // what global data does this fill?
153 
155 
157 };
158 
159 // **************************************************************
160 // Tangent
161 // **************************************************************
162 template<typename TRAITS,typename LO,typename GO>
164  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
165  public PHX::EvaluatorDerived<panzer::Traits::Tangent, TRAITS>,
167 
168 public:
169 
171  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & /* cIndexers */,
172  bool /* useDiscreteAdjoint=false */)
173  : rowIndexers_(rIndexers) {}
174 
175  ScatterResidual_BlockedEpetra(const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & rIndexers,
176  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & cIndexers,
177  const Teuchos::ParameterList& p,
178  bool useDiscreteAdjoint=false);
179 
180  void postRegistrationSetup(typename TRAITS::SetupData d,
182 
183  void preEvaluate(typename TRAITS::PreEvalData d);
184 
185  void evaluateFields(typename TRAITS::EvalData workset);
186 
188  { return Teuchos::rcp(new ScatterResidual_BlockedEpetra<panzer::Traits::Tangent,TRAITS,LO,GO>(rowIndexers_,colIndexers_,pl)); }
189 
190 private:
192 
193  // dummy field so that the evaluator will have something to do
195 
196  // fields that need to be scattered will be put in this vector
197  std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
198 
199  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > rowIndexers_;
200  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > colIndexers_;
201 
202  std::vector<int> indexerIds_; // block index
203  std::vector<int> subFieldIds_; // sub field numbers
204 
205  // This maps the scattered field names to the DOF manager field
206  // For instance a Navier-Stokes map might look like
207  // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
208  // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
210 
211  std::string globalDataKey_; // what global data does this fill?
212 
214 
216 };
217 
218 // **************************************************************
219 // Jacobian
220 // **************************************************************
221 
222 template<typename TRAITS,typename LO,typename GO>
224  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
225  public PHX::EvaluatorDerived<panzer::Traits::Jacobian, TRAITS>,
227 
228 public:
229 
251  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & cIndexers,
252  bool useDiscreteAdjoint=false)
253  : rowIndexers_(rIndexers), colIndexers_(cIndexers), useDiscreteAdjoint_(useDiscreteAdjoint) {}
254 
255  ScatterResidual_BlockedEpetra(const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & rIndexers,
256  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & cIndexers,
257  const Teuchos::ParameterList& p,
258  bool useDiscreteAdjoint=false);
259 
260  void postRegistrationSetup(typename TRAITS::SetupData d,
262 
263  void preEvaluate(typename TRAITS::PreEvalData d);
264 
265  void evaluateFields(typename TRAITS::EvalData workset);
266 
268  { return Teuchos::rcp(new ScatterResidual_BlockedEpetra<panzer::Traits::Jacobian,TRAITS,LO,GO>(rowIndexers_,colIndexers_,pl,useDiscreteAdjoint_)); }
269 
270 private:
271 
273 
274  // dummy field so that the evaluator will have something to do
276 
277  // fields that need to be scattered will be put in this vector
278  std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
279 
280  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > rowIndexers_;
281  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > colIndexers_;
282 
283  std::vector<int> indexerIds_; // block index
284  std::vector<int> subFieldIds_; // sub field numbers
285 
286  // This maps the scattered field names to the DOF manager field
287  // For instance a Navier-Stokes map might look like
288  // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
289  // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
291 
292  std::string globalDataKey_; // what global data does this fill?
294 
297 
299 };
300 
301 }
302 
303 // optionally include hessian support
304 #ifdef Panzer_BUILD_HESSIAN_SUPPORT
306 #endif
307 
308 // **************************************************************
309 #endif
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
ScatterResidual_BlockedEpetra(const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &rIndexers, const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &, bool)
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
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 > > > &, bool)
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)
Non-templated empty base class for template managers.