Panzer  Version of the Day
Panzer_ScatterDirichletResidual_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_SCATTER_DIRICHLET_RESIDUAL_BLOCKEDTPETRA_HPP
44 #define PANZER_EVALUATOR_SCATTER_DIRICHLET_RESIDUAL_BLOCKEDTPETRA_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 }
63 
64 namespace panzer {
65 
66 template <typename LocalOrdinalT,typename GlobalOrdinalT>
67 class UniqueGlobalIndexer;
68 
69 template <typename LocalOrdinalT,typename GlobalOrdinalT>
70 class BlockedDOFManager; //forward declaration
71 
80 template <typename EvalT,typename TRAITS,typename LO,typename GO,typename NodeT=panzer::TpetraNodeType>
82  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
83  public PHX::EvaluatorDerived<panzer::Traits::Residual, TRAITS>,
85 public:
86  typedef typename EvalT::ScalarT ScalarT;
88  { }
89 
91  const Teuchos::ParameterList& p);
92 
95 
96  void postRegistrationSetup(typename TRAITS::SetupData d, PHX::FieldManager<TRAITS>& vm)
97  { }
98  void evaluateFields(typename TRAITS::EvalData d)
99  { std::cout << "unspecialized version of \"ScatterDirichletResidual_BlockedTpetra::evaluateFields\" on \""+PHX::typeAsString<EvalT>()+"\" should not be used!" << std::endl;
100  TEUCHOS_ASSERT(false); }
101 };
102 
103 // **************************************************************
104 // **************************************************************
105 // * Specializations
106 // **************************************************************
107 // **************************************************************
108 
109 
110 // **************************************************************
111 // Residual
112 // **************************************************************
113 template <typename TRAITS,typename LO,typename GO,typename NodeT>
115  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
116  public PHX::EvaluatorDerived<panzer::Traits::Residual, TRAITS>,
118 
119 public:
121  : globalIndexer_(indexer) {}
122 
124  const Teuchos::ParameterList& p);
125 
126  void postRegistrationSetup(typename TRAITS::SetupData d,
128 
129  void preEvaluate(typename TRAITS::PreEvalData d);
130 
131  void evaluateFields(typename TRAITS::EvalData workset);
132 
135 
136 private:
138  typedef typename TRAITS::RealType RealType;
139 
141  typedef Tpetra::Vector<RealType,LO,GO,NodeT> VectorType;
142  typedef Tpetra::CrsMatrix<RealType,LO,GO,NodeT> CrsMatrixType;
143  typedef Tpetra::CrsGraph<LO,GO,NodeT> CrsGraphType;
144  typedef Tpetra::Map<LO,GO,NodeT> MapType;
145  typedef Tpetra::Import<LO,GO,NodeT> ImportType;
146  typedef Tpetra::Export<LO,GO,NodeT> ExportType;
147 
148  // dummy field so that the evaluator will have something to do
150 
151  // fields that need to be scattered will be put in this vector
152  std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
153 
154  // maps the local (field,element,basis) triplet to a global ID
155  // for scattering
157 
158  std::vector<int> fieldIds_; // field IDs needing mapping
159 
160  // This maps the scattered field names to the DOF manager field
161  // For instance a Navier-Stokes map might look like
162  // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
163  // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
165 
166  std::size_t num_nodes;
167 
168  std::size_t side_subcell_dim_;
169  std::size_t local_side_id_;
170 
172  std::string globalDataKey_; // what global data does this fill?
174 
177 
178  // If set to true, scattering an initial condition
180 
181  // Allows runtime disabling of dirichlet BCs on node-by-node basis
182  std::vector< PHX::MDField<const bool,Cell,NODE> > applyBC_;
183 
185 };
186 
187 // **************************************************************
188 // Jacobian
189 // **************************************************************
190 template <typename TRAITS,typename LO,typename GO,typename NodeT>
192  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
193  public PHX::EvaluatorDerived<panzer::Traits::Jacobian, TRAITS>,
195 
196 public:
198  : globalIndexer_(indexer) {}
199 
201  const Teuchos::ParameterList& p);
202 
203  void preEvaluate(typename TRAITS::PreEvalData d);
204 
205  void postRegistrationSetup(typename TRAITS::SetupData d,
207 
208  void evaluateFields(typename TRAITS::EvalData workset);
209 
212 
213 private:
215  typedef typename TRAITS::RealType RealType;
216 
218  typedef Tpetra::Operator<RealType,LO,GO,NodeT> OperatorType;
219  typedef Tpetra::CrsMatrix<RealType,LO,GO,NodeT> CrsMatrixType;
220  typedef Tpetra::Map<LO,GO,NodeT> MapType;
221 
222  typedef Thyra::TpetraLinearOp<RealType,LO,GO,NodeT> ThyraLinearOp;
223 
224  // dummy field so that the evaluator will have something to do
226 
227  // fields that need to be scattered will be put in this vector
228  std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
229 
230  // maps the local (field,element,basis) triplet to a global ID
231  // for scattering
233 
234  std::vector<int> fieldIds_; // field IDs needing mapping
235 
236  // This maps the scattered field names to the DOF manager field
237  // For instance a Navier-Stokes map might look like
238  // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
239  // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
241 
242  std::size_t num_nodes;
243  std::size_t num_eq;
244 
245  std::size_t side_subcell_dim_;
246  std::size_t local_side_id_;
247 
249  std::string globalDataKey_; // what global data does this fill?
251 
254 
255  // Allows runtime disabling of dirichlet BCs on node-by-node basis
256  std::vector< PHX::MDField<const bool,Cell,NODE> > applyBC_;
257 
259 };
260 
261 }
262 
263 #ifdef Panzer_BUILD_HESSIAN_SUPPORT
265 #endif
266 
267 // **************************************************************
268 #endif
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
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.
Pushes residual values into the residual vector for a Newton-based solve.
#define TEUCHOS_ASSERT(assertion_test)
Non-templated empty base class for template managers.
ScatterDirichletResidual_BlockedTpetra(const Teuchos::RCP< const BlockedDOFManager< LO, GO > > &indexer)
void postRegistrationSetup(typename TRAITS::SetupData d, PHX::FieldManager< TRAITS > &vm)