Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_ScatterResidual_Tpetra_Hessian.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_ScatterResidual_Tpetra_Hessian_hpp__
44 #define __Panzer_ScatterResidual_Tpetra_Hessian_hpp__
45 
46 // only do this if required by the user
47 #ifdef Panzer_BUILD_HESSIAN_SUPPORT
48 
49 // the includes for this file come in as a result of the includes in the main
50 // Tpetra scatter residual file
51 
52 namespace panzer {
53 
54 // **************************************************************
55 // Hessian Specialization
56 // **************************************************************
57 template<typename TRAITS,typename LO,typename GO,typename NodeT>
58 class ScatterResidual_Tpetra<panzer::Traits::Hessian,TRAITS,LO,GO,NodeT>
59  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
60  public PHX::EvaluatorDerived<panzer::Traits::Hessian, TRAITS>,
62 
63 public:
65  : globalIndexer_(indexer) {}
66 
68  const Teuchos::ParameterList& p);
69 
70  void postRegistrationSetup(typename TRAITS::SetupData d,
72 
73  void preEvaluate(typename TRAITS::PreEvalData d);
74 
75  void evaluateFields(typename TRAITS::EvalData workset);
76 
79 
80 private:
82 
83  // dummy field so that the evaluator will have something to do
85 
86  // fields that need to be scattered will be put in this vector
87  std::vector< PHX::MDField<const ScalarT,Cell,NODE> > scatterFields_;
88 
89  // maps the local (field,element,basis) triplet to a global ID
90  // for scattering
92  std::vector<int> fieldIds_; // field IDs needing mapping
93 
94  // This maps the scattered field names to the DOF manager field
95  // For instance a Navier-Stokes map might look like
96  // fieldMap_["RESIDUAL_Velocity"] --> "Velocity"
97  // fieldMap_["RESIDUAL_Pressure"] --> "Pressure"
99 
100  std::string globalDataKey_; // what global data does this fill?
102 
104 };
105 
106 }
107 
108 #endif // end hessian support
109 
110 #endif
ScatterResidual_Tpetra(const Teuchos::RCP< const panzer::UniqueGlobalIndexer< LO, GO > > &indexer)
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
Pushes residual values into the residual vector for a Newton-based solve.
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
Teuchos::RCP< const TpetraLinearObjContainer< double, LO, GO, NodeT > > tpetraContainer_
Non-templated empty base class for template managers.