Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_GatherTangent_Epetra_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_GatherTangent_Epetra_decl_hpp__
44 #define __Panzer_GatherTangent_Epetra_decl_hpp__
45 
47 //
48 // Include Files
49 //
51 
52 // Panzer
56 
57 // Phalanx
58 #include "Phalanx_Evaluator_Macros.hpp"
59 #include "Phalanx_MDField.hpp"
60 
62 //
63 // Forward Declarations
64 //
66 
67 namespace panzer
68 {
69  template <typename LocalOrdinalT, typename GlobalOrdinalT>
70  class UniqueGlobalIndexer;
71 }
72 
73 namespace panzer
74 {
91  template<typename EvalT, typename TRAITS, typename LO, typename GO>
93  :
94  public panzer::EvaluatorWithBaseImpl<TRAITS>,
95  public PHX::EvaluatorDerived<EvalT, TRAITS>,
97  {
98  public:
99 
110  :
111  globalIndexer_(indexer)
112  {
113  } // end of Constructor
114 
127  const Teuchos::ParameterList& p);
128 
137  void
139  typename TRAITS::SetupData d,
141 
151  void
152  preEvaluate(
153  typename TRAITS::PreEvalData d);
154 
163  void
165  typename TRAITS::EvalData d);
166 
180  const Teuchos::ParameterList& pl) const
181  {
182  using Teuchos::rcp;
183  return rcp(new
185  } // end of clone()
186 
187  private:
188 
192  typedef typename EvalT::ScalarT ScalarT;
193 
199 
203  std::vector<int> fieldIds_;
204 
208  std::vector<PHX::MDField<ScalarT, Cell, NODE>> gatherFields_;
209 
214 
220 
224  std::string globalDataKey_;
225 
232 
237 
238  }; // end of class GatherTangent_Epetra
239 
240 } // end of namespace panzer
241 
242 #endif // __Panzer_GatherTangent_Epetra_decl_hpp__
std::vector< PHX::MDField< ScalarT, Cell, NODE > > gatherFields_
The fields to be gathered.
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
Create a copy.
std::string globalDataKey_
The key identifying the GlobalEvaluationData.
Teuchos::RCP< panzer::EpetraVector_ReadOnly_GlobalEvaluationData > dxdpEvRoGed_
The GlobalEvaluationData containing both the owned and ghosted tangent vectors.
GatherTangent_Epetra(const Teuchos::RCP< const panzer::UniqueGlobalIndexer< LO, GO >> &indexer)
Constructor.
Teuchos::RCP< std::vector< std::string > > indexerNames_
A list of the names of the fields to be gathered.
GatherTangent_Epetra()
Default Constructor (disabled).
void postRegistrationSetup(typename TRAITS::SetupData d, PHX::FieldManager< TRAITS > &fm)
Post-Registration Setup.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
Teuchos::RCP< const panzer::UniqueGlobalIndexer< LO, GO > > globalIndexer_
Maps the local (field, element, basis) triplet to a global ID for scattering.
std::vector< int > fieldIds_
Field IDs, which need to be mapped.
void preEvaluate(typename TRAITS::PreEvalData d)
Pre-Evaluate: Sets the tangent vector.
Non-templated empty base class for template managers.
void evaluateFields(typename TRAITS::EvalData d)
Evaluate Fields: Gather operation.
bool useTimeDerivativeSolutionVector_
A flag indicating whether we should be working with or .