Panzer Version of the Day
Loading...
Searching...
No Matches
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
50#include "Teuchos_ParameterList.hpp"
51
52#include "PanzerDiscFE_config.hpp"
53#include "Panzer_Dimension.hpp"
54#include "Panzer_Traits.hpp"
57
59
60namespace Thyra {
61 template <typename ScalarT> class ProductVectorBase;
62 template <typename ScalarT> class BlockedLinearOpBase;
63}
64
65namespace panzer {
66
67class GlobalIndexer;
68
77template<typename EvalT, typename TRAITS,typename LO,typename GO> class ScatterDirichletResidual_BlockedEpetra
78 : public panzer::EvaluatorWithBaseImpl<TRAITS>,
79 public PHX::EvaluatorDerived<panzer::Traits::Residual, TRAITS>,
81public:
82 typedef typename EvalT::ScalarT ScalarT;
83
84 ScatterDirichletResidual_BlockedEpetra(const Teuchos::ParameterList& p) {}
85
86 virtual Teuchos::RCP<CloneableEvaluator> clone(const Teuchos::ParameterList & pl) const
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 \"ScatterDirichletResidual_BlockedEpetra::evaluateFields\" on \""+PHX::print<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// **************************************************************
106template<typename TRAITS,typename LO,typename GO>
108 : public panzer::EvaluatorWithBaseImpl<TRAITS>,
109 public PHX::EvaluatorDerived<panzer::Traits::Residual, TRAITS>,
111
112public:
113
114 ScatterDirichletResidual_BlockedEpetra(const std::vector<Teuchos::RCP<const GlobalIndexer> > & rIndexers,
115 const std::vector<Teuchos::RCP<const GlobalIndexer> > & /* cIndexers */)
116 : rowIndexers_(rIndexers) {}
117
118 ScatterDirichletResidual_BlockedEpetra(const std::vector<Teuchos::RCP<const GlobalIndexer> > & rIndexers,
119 const std::vector<Teuchos::RCP<const GlobalIndexer> > & cIndexers,
120 const Teuchos::ParameterList& p,
121 bool useDiscreteAdjoint=false);
122
123 void postRegistrationSetup(typename TRAITS::SetupData d,
125
126 void preEvaluate(typename TRAITS::PreEvalData d);
127
128 void evaluateFields(typename TRAITS::EvalData workset);
129
130 virtual Teuchos::RCP<CloneableEvaluator> clone(const Teuchos::ParameterList & pl) const
131 { return Teuchos::rcp(new ScatterDirichletResidual_BlockedEpetra<panzer::Traits::Residual,TRAITS,LO,GO>(rowIndexers_,colIndexers_,pl)); }
132
133private:
135 using BCFieldType = PHX::MDField<const bool,Cell,NODE>;
136
137 // dummy field so that the evaluator will have something to do
138 Teuchos::RCP<PHX::FieldTag> scatterHolder_;
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 GlobalIndexer> > rowIndexers_;
144 std::vector<Teuchos::RCP<const GlobalIndexer> > 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"
153 Teuchos::RCP<const std::map<std::string,std::string> > fieldMap_;
154
155 std::size_t num_nodes;
156
157 std::size_t side_subcell_dim_;
158 std::size_t local_side_id_;
159
160 Teuchos::RCP<Thyra::ProductVectorBase<double> > dirichletCounter_;
161 Teuchos::RCP<Thyra::ProductVectorBase<double> > r_;
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< BCFieldType > applyBC_;
172
174};
175
176// **************************************************************
177// Tangent
178// **************************************************************
179template<typename TRAITS,typename LO,typename GO>
181 : public panzer::EvaluatorWithBaseImpl<TRAITS>,
182 public PHX::EvaluatorDerived<panzer::Traits::Tangent, TRAITS>,
184
185public:
186
187 ScatterDirichletResidual_BlockedEpetra(const std::vector<Teuchos::RCP<const GlobalIndexer> > & rIndexers,
188 const std::vector<Teuchos::RCP<const GlobalIndexer> > & /* cIndexers */)
189 : rowIndexers_(rIndexers) {}
190
191 ScatterDirichletResidual_BlockedEpetra(const std::vector<Teuchos::RCP<const GlobalIndexer> > & rIndexers,
192 const std::vector<Teuchos::RCP<const GlobalIndexer> > & 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
203 virtual Teuchos::RCP<CloneableEvaluator> clone(const Teuchos::ParameterList & pl) const
204 { return Teuchos::rcp(new ScatterDirichletResidual_BlockedEpetra<panzer::Traits::Tangent,TRAITS,LO,GO>(rowIndexers_,colIndexers_,pl)); }
205
206private:
208 using BCFieldType = PHX::MDField<const bool,Cell,NODE>;
209
210 // dummy field so that the evaluator will have something to do
211 Teuchos::RCP<PHX::FieldTag> scatterHolder_;
212
213 // fields that need to be scattered will be put in this vector
214 std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
215
216 std::vector<Teuchos::RCP<const GlobalIndexer> > rowIndexers_;
217 std::vector<Teuchos::RCP<const GlobalIndexer> > colIndexers_;
218
219 std::vector<int> indexerIds_; // block index
220 std::vector<int> subFieldIds_; // sub field numbers
221
222 // This maps the scattered field names to the DOF manager field
223 // For instance a Navier-Stokes map might look like
224 // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
225 // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
226 Teuchos::RCP<const std::map<std::string,std::string> > fieldMap_;
227
228 std::size_t num_nodes;
229
230 std::size_t side_subcell_dim_;
231 std::size_t local_side_id_;
232
233 Teuchos::RCP<Thyra::ProductVectorBase<double> > dirichletCounter_;
234 Teuchos::RCP<Thyra::ProductVectorBase<double> > r_;
235 std::string globalDataKey_; // what global data does this fill?
236
239
240 // If set to true, scattering an initial condition
242
243 // Allows runtime disabling of dirichlet BCs on node-by-node basis
244 std::vector< BCFieldType > applyBC_;
245
247};
248
249// **************************************************************
250// Jacobian
251// **************************************************************
252template<typename TRAITS,typename LO,typename GO>
254 : public panzer::EvaluatorWithBaseImpl<TRAITS>,
255 public PHX::EvaluatorDerived<panzer::Traits::Jacobian, TRAITS>,
257
258public:
259
260 ScatterDirichletResidual_BlockedEpetra(const std::vector<Teuchos::RCP<const GlobalIndexer> > & rIndexers,
261 const std::vector<Teuchos::RCP<const GlobalIndexer> > & cIndexers)
262 : rowIndexers_(rIndexers), colIndexers_(cIndexers) {}
263
264 ScatterDirichletResidual_BlockedEpetra(const std::vector<Teuchos::RCP<const GlobalIndexer> > & rIndexers,
265 const std::vector<Teuchos::RCP<const GlobalIndexer> > & cIndexers,
266 const Teuchos::ParameterList& p,
267 bool useDiscreteAdjoint=false);
268
269 void preEvaluate(typename TRAITS::PreEvalData d);
270
271 void postRegistrationSetup(typename TRAITS::SetupData d,
273
274 void evaluateFields(typename TRAITS::EvalData workset);
275
276 virtual Teuchos::RCP<CloneableEvaluator> clone(const Teuchos::ParameterList & pl) const
277 { return Teuchos::rcp(new ScatterDirichletResidual_BlockedEpetra<panzer::Traits::Jacobian,TRAITS,LO,GO>(rowIndexers_,colIndexers_,pl)); }
278
279private:
280
282 using BCFieldType = PHX::MDField<const bool,Cell,NODE>;
283
284 // dummy field so that the evaluator will have something to do
285 Teuchos::RCP<PHX::FieldTag> scatterHolder_;
286
287 // fields that need to be scattered will be put in this vector
288 std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
289
290 std::vector<Teuchos::RCP<const GlobalIndexer> > rowIndexers_;
291 std::vector<Teuchos::RCP<const GlobalIndexer> > colIndexers_;
292
293 std::vector<int> indexerIds_; // block index
294 std::vector<int> subFieldIds_; // sub field numbers
295
296 // This maps the scattered field names to the DOF manager field
297 // For instance a Navier-Stokes map might look like
298 // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
299 // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
300 Teuchos::RCP<const std::map<std::string,std::string> > fieldMap_;
301
302 std::size_t num_nodes;
303 std::size_t num_eq;
304
305 std::size_t side_subcell_dim_;
306 std::size_t local_side_id_;
307
308 Teuchos::RCP<Thyra::ProductVectorBase<double> > dirichletCounter_;
309 std::string globalDataKey_; // what global data does this fill?
310
311 Teuchos::RCP<Thyra::ProductVectorBase<double> > r_;
312 Teuchos::RCP<Thyra::BlockedLinearOpBase<double> > Jac_;
313
316
317 // Allows runtime disabling of dirichlet BCs on node-by-node basis
318 std::vector< BCFieldType > applyBC_;
319
321};
322
323}
324
325// optionally include hessian support
326#ifdef Panzer_BUILD_HESSIAN_SUPPORT
328#endif
329
330// **************************************************************
331#endif
Non-templated empty base class for template managers.
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 GlobalIndexer > > &rIndexers, const std::vector< Teuchos::RCP< const GlobalIndexer > > &cIndexers)
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 GlobalIndexer > > &rIndexers, const std::vector< Teuchos::RCP< const GlobalIndexer > > &)
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 GlobalIndexer > > &rIndexers, const std::vector< Teuchos::RCP< const GlobalIndexer > > &)
Pushes residual values into the residual vector for a Newton-based solve.
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
void postRegistrationSetup(typename TRAITS::SetupData d, PHX::FieldManager< TRAITS > &vm)