Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_ScatterDirichletResidual_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_DIRICHLET_RESIDUAL_BLOCKEDEPETRA_DECL_HPP
44 #define PANZER_EVALUATOR_SCATTER_DIRICHLET_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 ScalarT> class ProductVectorBase;
62  template <typename ScalarT> class BlockedLinearOpBase;
63 }
64 
65 namespace panzer {
66 
67 template <typename LocalOrdinalT,typename GlobalOrdinalT>
68 class UniqueGlobalIndexer;
69 
78 template<typename EvalT, typename TRAITS,typename LO,typename GO> class ScatterDirichletResidual_BlockedEpetra
79  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
80  public PHX::EvaluatorDerived<panzer::Traits::Residual, TRAITS>,
82 public:
83  typedef typename EvalT::ScalarT ScalarT;
84 
86 
89 
90  void postRegistrationSetup(typename TRAITS::SetupData d, PHX::FieldManager<TRAITS>& vm)
91  { }
92  void evaluateFields(typename TRAITS::EvalData d)
93  { std::cout << "unspecialized version of \"ScatterDirichletResidual_BlockedEpetra::evaluateFields\" on \""+PHX::typeAsString<EvalT>()+"\" should not be used!" << std::endl;
94  TEUCHOS_ASSERT(false); }
95 };
96 
97 // **************************************************************
98 // **************************************************************
99 // * Specializations
100 // **************************************************************
101 // **************************************************************
102 
103 
104 // **************************************************************
105 // Residual
106 // **************************************************************
107 template<typename TRAITS,typename LO,typename GO>
109  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
110  public PHX::EvaluatorDerived<panzer::Traits::Residual, TRAITS>,
112 
113 public:
114 
116  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & /* cIndexers */)
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 
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::size_t num_nodes;
156 
157  std::size_t side_subcell_dim_;
158  std::size_t local_side_id_;
159 
162  std::string globalDataKey_; // what global data does this fill?
163 
166 
167  // If set to true, scattering an initial condition
169 
170  // Allows runtime disabling of dirichlet BCs on node-by-node basis
171  std::vector< PHX::MDField<const bool,Cell,NODE> > applyBC_;
172 
174 };
175 
176 // **************************************************************
177 // Tangent
178 // **************************************************************
179 template<typename TRAITS,typename LO,typename GO>
181  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
182  public PHX::EvaluatorDerived<panzer::Traits::Tangent, TRAITS>,
184 
185 public:
186 
188  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & /* cIndexers */)
189  : rowIndexers_(rIndexers) {}
190 
192  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & cIndexers,
193  const Teuchos::ParameterList& p,
194  bool useDiscreteAdjoint=false);
195 
196  void postRegistrationSetup(typename TRAITS::SetupData d,
198 
199  void preEvaluate(typename TRAITS::PreEvalData d);
200 
201  void evaluateFields(typename TRAITS::EvalData workset);
202 
205 
206 private:
208 
209  // dummy field so that the evaluator will have something to do
211 
212  // fields that need to be scattered will be put in this vector
213  std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
214 
215  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > rowIndexers_;
216  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > colIndexers_;
217 
218  std::vector<int> indexerIds_; // block index
219  std::vector<int> subFieldIds_; // sub field numbers
220 
221  // This maps the scattered field names to the DOF manager field
222  // For instance a Navier-Stokes map might look like
223  // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
224  // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
226 
227  std::size_t num_nodes;
228 
229  std::size_t side_subcell_dim_;
230  std::size_t local_side_id_;
231 
234  std::string globalDataKey_; // what global data does this fill?
235 
238 
239  // If set to true, scattering an initial condition
241 
242  // Allows runtime disabling of dirichlet BCs on node-by-node basis
243  std::vector< PHX::MDField<const bool,Cell,NODE> > applyBC_;
244 
246 };
247 
248 // **************************************************************
249 // Jacobian
250 // **************************************************************
251 template<typename TRAITS,typename LO,typename GO>
253  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
254  public PHX::EvaluatorDerived<panzer::Traits::Jacobian, TRAITS>,
256 
257 public:
258 
260  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & cIndexers)
261  : rowIndexers_(rIndexers), colIndexers_(cIndexers) {}
262 
264  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > & cIndexers,
265  const Teuchos::ParameterList& p,
266  bool useDiscreteAdjoint=false);
267 
268  void preEvaluate(typename TRAITS::PreEvalData d);
269 
270  void postRegistrationSetup(typename TRAITS::SetupData d,
272 
273  void evaluateFields(typename TRAITS::EvalData workset);
274 
277 
278 private:
279 
281 
282  // dummy field so that the evaluator will have something to do
284 
285  // fields that need to be scattered will be put in this vector
286  std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
287 
288  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > rowIndexers_;
289  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO,int> > > colIndexers_;
290 
291  std::vector<int> indexerIds_; // block index
292  std::vector<int> subFieldIds_; // sub field numbers
293 
294  // This maps the scattered field names to the DOF manager field
295  // For instance a Navier-Stokes map might look like
296  // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
297  // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
299 
300  std::size_t num_nodes;
301  std::size_t num_eq;
302 
303  std::size_t side_subcell_dim_;
304  std::size_t local_side_id_;
305 
307  std::string globalDataKey_; // what global data does this fill?
308 
311 
314 
315  // Allows runtime disabling of dirichlet BCs on node-by-node basis
316  std::vector< PHX::MDField<const bool,Cell,NODE> > applyBC_;
317 
319 };
320 
321 }
322 
323 // optionally include hessian support
324 #ifdef Panzer_BUILD_HESSIAN_SUPPORT
326 #endif
327 
328 // **************************************************************
329 #endif
ScatterDirichletResidual_BlockedEpetra(const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &rIndexers, const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &cIndexers)
bool checkApplyBC_
If set to true, allows runtime disabling of dirichlet BCs on node-by-node basis.
void postRegistrationSetup(typename TRAITS::SetupData d, PHX::FieldManager< TRAITS > &vm)
ScatterDirichletResidual_BlockedEpetra(const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &rIndexers, const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &)
Pushes residual values into the residual vector for a Newton-based solve.
bool checkApplyBC_
If set to true, allows runtime disabling of dirichlet BCs on node-by-node basis.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
bool checkApplyBC_
If set to true, allows runtime disabling of dirichlet BCs on node-by-node basis.
ScatterDirichletResidual_BlockedEpetra(const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &rIndexers, const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > &)
#define TEUCHOS_ASSERT(assertion_test)
Non-templated empty base class for template managers.
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const