Panzer  Version of the Day
Panzer_GatherSolution_Epetra_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_GatherSolution_Epetra_Hessian_hpp__
44 #define __Panzer_GatherSolution_Epetra_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 // Epetra gather solution file
51 
52 namespace panzer {
53 
54 // **************************************************************
55 // Hessian Specialization
56 // **************************************************************
57 template<typename TRAITS,typename LO,typename GO>
58 class GatherSolution_Epetra<panzer::Traits::Hessian,TRAITS,LO,GO>
59  : public panzer::EvaluatorWithBaseImpl<TRAITS>,
60  public PHX::EvaluatorDerived<panzer::Traits::Hessian, TRAITS>,
62 
63 
64 public:
65 
66  GatherSolution_Epetra(const Teuchos::RCP<const panzer::UniqueGlobalIndexer<LO,GO> > & indexer) :
67  globalIndexer_(indexer) {}
68 
69  GatherSolution_Epetra(const Teuchos::RCP<const panzer::UniqueGlobalIndexer<LO,GO> > & indexer,
70  const Teuchos::ParameterList& p);
71 
72  void postRegistrationSetup(typename TRAITS::SetupData d,
74 
75  void preEvaluate(typename TRAITS::PreEvalData d);
76 
77  void evaluateFields(typename TRAITS::EvalData d);
78 
79  virtual Teuchos::RCP<CloneableEvaluator> clone(const Teuchos::ParameterList & pl) const
80  { return Teuchos::rcp(new GatherSolution_Epetra<panzer::Traits::Hessian,TRAITS,LO,GO>(globalIndexer_,pl)); }
81 
82 private:
83  typedef typename panzer::Traits::Hessian EvalT;
84  typedef typename panzer::Traits::Hessian::ScalarT ScalarT;
85 
86  // maps the local (field,element,basis) triplet to a global ID
87  // for scattering
88  Teuchos::RCP<const panzer::UniqueGlobalIndexer<LO,GO> > globalIndexer_;
89  std::vector<std::string> indexerNames_;
90  std::vector<int> fieldIds_; // field IDs needing mapping
91 
92  std::vector< PHX::MDField<ScalarT,Cell,NODE> > gatherFields_;
93  std::vector< PHX::MDField<ScalarT,Cell,NODE> > sensFields_;
94 
95  bool useTimeDerivativeSolutionVector_;
96  std::string globalDataKey_; // what global data does this fill?
97 
98  std::string sensitivitiesName_; // This sets which gather operations have sensitivities
99 
100  // first derivative fields
101  int gatherSeedIndex_; // what gather seed in the workset to use
102  // if less than zero then use alpha or beta
103  // as appropriate
104  bool firstSensitivitiesAvailable_; // Turn on the first derivative sensitivities
105  // to turn on/off a certain set of sensitivities
106  bool firstApplySensitivities_; // This is a local variable that is used by evaluateFields
107 
108  // handle second derivatives
109  std::string sensitivities2ndPrefix_; // Prefix for field containing the sensitivities
110  bool secondSensitivitiesAvailable_; // Turn on the second derivative sensitivities
111  bool secondApplySensitivities_; // This is a local variable that is used by evaluateFields
112 
113  Teuchos::RCP<Epetra_Vector> x_;
114  Teuchos::RCP<Epetra_Vector> dx_;
115 
116  GatherSolution_Epetra();
117 };
118 
119 }
120 
121 #endif // end hessian support
122 
123 #endif
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
Non-templated empty base class for template managers.