Panzer Version of the Day
Loading...
Searching...
No Matches
Panzer_ScatterResidual_Epetra_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_EPETRA_DECL_HPP
44#define PANZER_EVALUATOR_SCATTER_RESIDUAL_EPETRA_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
59class Epetra_Vector;
60
61namespace panzer {
62
63class EpetraLinearObjContainer;
64
65class GlobalIndexer;
66
84template<typename EvalT, typename TRAITS,typename LO,typename GO> class ScatterResidual_Epetra;
85
86// **************************************************************
87// **************************************************************
88// * Specializations
89// **************************************************************
90// **************************************************************
91
92
93// **************************************************************
94// Residual
95// **************************************************************
96template<typename TRAITS,typename LO,typename GO>
98 : public panzer::EvaluatorWithBaseImpl<TRAITS>,
99 public PHX::EvaluatorDerived<panzer::Traits::Residual, TRAITS>,
101
102public:
103 ScatterResidual_Epetra(const Teuchos::RCP<const panzer::GlobalIndexer> & indexer,
104 const Teuchos::RCP<const panzer::GlobalIndexer> & /* cIndexer=Teuchos::null */,
105 bool useDiscreteAdjoint=false)
106 : globalIndexer_(indexer),useDiscreteAdjoint_(useDiscreteAdjoint) {}
107
108 ScatterResidual_Epetra(const Teuchos::RCP<const panzer::GlobalIndexer> & indexer,
109 const Teuchos::RCP<const panzer::GlobalIndexer> & cIndexer,
110 const Teuchos::ParameterList& p,bool=false);
111
112 void postRegistrationSetup(typename TRAITS::SetupData d,
114
115 void preEvaluate(typename TRAITS::PreEvalData d);
116
117 void evaluateFields(typename TRAITS::EvalData workset);
118
119 virtual Teuchos::RCP<CloneableEvaluator> clone(const Teuchos::ParameterList & pl) const
120 { return Teuchos::rcp(new ScatterResidual_Epetra<panzer::Traits::Residual,TRAITS,LO,GO>(globalIndexer_,Teuchos::null,pl)); }
121
122private:
124
125 // dummy field so that the evaluator will have something to do
126 Teuchos::RCP<PHX::FieldTag> scatterHolder_;
127
128 // fields that need to be scattered will be put in this vector
129 std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
130
131 // maps the local (field,element,basis) triplet to a global ID
132 // for scattering
133 Teuchos::RCP<const panzer::GlobalIndexer> globalIndexer_;
134 std::vector<int> fieldIds_; // field IDs needing mapping
135
136 // This maps the scattered field names to the DOF manager field
137 // For instance a Navier-Stokes map might look like
138 // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
139 // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
140 Teuchos::RCP<const std::map<std::string,std::string> > fieldMap_;
141
142 std::string globalDataKey_; // what global data does this fill?
143
144 Teuchos::RCP<const EpetraLinearObjContainer> epetraContainer_;
145
147};
148
149// **************************************************************
150// Tangent
151// **************************************************************
152template<typename TRAITS,typename LO,typename GO>
154 : public panzer::EvaluatorWithBaseImpl<TRAITS>,
155 public PHX::EvaluatorDerived<panzer::Traits::Tangent, TRAITS>,
157
158public:
159 ScatterResidual_Epetra(const Teuchos::RCP<const panzer::GlobalIndexer> & indexer,
160 const Teuchos::RCP<const panzer::GlobalIndexer> & /* cIndexer=Teuchos::null */,
161 bool useDiscreteAdjoint=false)
162 : globalIndexer_(indexer),useDiscreteAdjoint_(useDiscreteAdjoint) {}
163
164 ScatterResidual_Epetra(const Teuchos::RCP<const panzer::GlobalIndexer> & indexer,
165 const Teuchos::RCP<const panzer::GlobalIndexer> & cIndexer,
166 const Teuchos::ParameterList& p,bool=false);
167
168 void postRegistrationSetup(typename TRAITS::SetupData d,
170
171 void preEvaluate(typename TRAITS::PreEvalData d);
172
173 void evaluateFields(typename TRAITS::EvalData workset);
174
175 virtual Teuchos::RCP<CloneableEvaluator> clone(const Teuchos::ParameterList & pl) const
176 { return Teuchos::rcp(new ScatterResidual_Epetra<panzer::Traits::Tangent,TRAITS,LO,GO>(globalIndexer_,Teuchos::null,pl)); }
177
178private:
180
181 // dummy field so that the evaluator will have something to do
182 Teuchos::RCP<PHX::FieldTag> scatterHolder_;
183
184 // fields that need to be scattered will be put in this vector
185 std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
186
187 // maps the local (field,element,basis) triplet to a global ID
188 // for scattering
189 Teuchos::RCP<const panzer::GlobalIndexer> globalIndexer_;
190 std::vector<int> fieldIds_; // field IDs needing mapping
191
192 // This maps the scattered field names to the DOF manager field
193 // For instance a Navier-Stokes map might look like
194 // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
195 // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
196 Teuchos::RCP<const std::map<std::string,std::string> > fieldMap_;
197
198 std::vector<Teuchos::RCP<Epetra_Vector> > dfdp_vectors_;
199
201};
202
203// **************************************************************
204// Jacobian
205// **************************************************************
206template<typename TRAITS,typename LO,typename GO>
208 : public panzer::EvaluatorWithBaseImpl<TRAITS>,
209 public PHX::EvaluatorDerived<panzer::Traits::Jacobian, TRAITS>,
211
212public:
213
214 ScatterResidual_Epetra(const Teuchos::RCP<const panzer::GlobalIndexer> & indexer,
215 const Teuchos::RCP<const panzer::GlobalIndexer> & cIndexer=Teuchos::null,
216 bool useDiscreteAdjoint=false)
217 : globalIndexer_(indexer), colGlobalIndexer_(cIndexer), useDiscreteAdjoint_(useDiscreteAdjoint) {}
218
219 ScatterResidual_Epetra(const Teuchos::RCP<const panzer::GlobalIndexer> & indexer,
220 const Teuchos::RCP<const panzer::GlobalIndexer> & cIndexer,
221 const Teuchos::ParameterList& pl,bool useDiscreteAdjoint=false);
222
223 void postRegistrationSetup(typename TRAITS::SetupData d,
225
226 void preEvaluate(typename TRAITS::PreEvalData d);
227
228 void evaluateFields(typename TRAITS::EvalData workset);
229
230 virtual Teuchos::RCP<CloneableEvaluator> clone(const Teuchos::ParameterList & pl) const
231 { return Teuchos::rcp(new ScatterResidual_Epetra<panzer::Traits::Jacobian,TRAITS,LO,GO>(globalIndexer_,colGlobalIndexer_,pl,useDiscreteAdjoint_)); }
232
233private:
234
236
237 // dummy field so that the evaluator will have something to do
238 Teuchos::RCP<PHX::FieldTag> scatterHolder_;
239
240 // fields that need to be scattered will be put in this vector
241 std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
242
243 // maps the local (field,element,basis) triplet to a global ID
244 // for scattering
245 Teuchos::RCP<const panzer::GlobalIndexer> globalIndexer_, colGlobalIndexer_;
246 std::vector<int> fieldIds_; // field IDs needing mapping
247
248 // This maps the scattered field names to the DOF manager field
249 // For instance a Navier-Stokes map might look like
250 // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
251 // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
252 Teuchos::RCP<const std::map<std::string,std::string> > fieldMap_;
253
254 std::string globalDataKey_; // what global data does this fill?
255
256 Teuchos::RCP<const EpetraLinearObjContainer> epetraContainer_;
257
259
261
262};
263
264}
265
266// optionally include hessian support
267#ifdef Panzer_BUILD_HESSIAN_SUPPORT
269#endif
270
271// **************************************************************
272#endif
Non-templated empty base class for template managers.
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
ScatterResidual_Epetra(const Teuchos::RCP< const panzer::GlobalIndexer > &indexer, const Teuchos::RCP< const panzer::GlobalIndexer > &cIndexer=Teuchos::null, bool useDiscreteAdjoint=false)
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
ScatterResidual_Epetra(const Teuchos::RCP< const panzer::GlobalIndexer > &indexer, const Teuchos::RCP< const panzer::GlobalIndexer > &cIndexer, const Teuchos::ParameterList &pl, bool useDiscreteAdjoint=false)
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
ScatterResidual_Epetra(const Teuchos::RCP< const panzer::GlobalIndexer > &indexer, const Teuchos::RCP< const panzer::GlobalIndexer > &, bool useDiscreteAdjoint=false)
ScatterResidual_Epetra(const Teuchos::RCP< const panzer::GlobalIndexer > &indexer, const Teuchos::RCP< const panzer::GlobalIndexer > &, bool useDiscreteAdjoint=false)
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
Pushes residual values into the residual vector for a Newton-based solve.