Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_GatherTangent_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_GatherTangent_BlockedEpetra_decl_hpp__
44 #define __Panzer_GatherTangent_BlockedEpetra_decl_hpp__
45 
47 //
48 // Include Files
49 //
51 
52 // Panzer
55 #include "Panzer_Dimension.hpp"
56 #include "PanzerDiscFE_config.hpp"
58 #include "Panzer_Traits.hpp"
59 
60 // Phalanx
61 #include "Phalanx_config.hpp"
62 #include "Phalanx_Evaluator_Macros.hpp"
63 #include "Phalanx_MDField.hpp"
64 
65 // Teuchos
67 
69 //
70 // Forward Declarations
71 //
73 
74 namespace panzer
75 {
76  template <typename LocalOrdinalT, typename GlobalOrdinalT>
77  class UniqueGlobalIndexer;
78 }
79 
80 namespace panzer
81 {
98  template<typename EvalT, typename TRAITS, typename LO, typename GO>
100  :
101  public panzer::EvaluatorWithBaseImpl<TRAITS>,
102  public PHX::EvaluatorDerived<EvalT, TRAITS>,
104  {
105  public:
106 
116  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO, int>>>&
117  indexers)
118  :
119  indexers_(indexers)
120  {
121  } // end of Constructor
122 
135  const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO, int>>>&
136  indexers,
137  const Teuchos::ParameterList& p);
138 
148  void
150  typename TRAITS::SetupData d,
152 
161  void
162  preEvaluate(
163  typename TRAITS::PreEvalData d);
164 
173  void
175  typename TRAITS::EvalData d);
176 
190  const Teuchos::ParameterList& pl) const
191  {
192  using Teuchos::rcp;
193  return rcp(new
195  } // end of clone()
196 
197  private:
198 
202  typedef typename EvalT::ScalarT ScalarT;
203 
208  std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO, int>>> indexers_;
209 
213  std::vector<int> indexerIds_; // block index
214 
218  std::vector<int> subFieldIds_; // sub field numbers
219 
223  std::vector< PHX::MDField<ScalarT, Cell, NODE>> gatherFields_;
224 
229 
235 
239  std::string globalDataKey_;
240 
247 
252 
253  }; // end of class GatherTangent_BlockedEpetra
254 
255 } // end of namespace panzer
256 
257 #endif // __Panzer_GatherTangent_BlockedEpetra_decl_hpp__
bool useTimeDerivativeSolutionVector_
A flag indicating whether we&#39;re to be working with or .
virtual Teuchos::RCP< CloneableEvaluator > clone(const Teuchos::ParameterList &pl) const
Create a copy.
Teuchos::RCP< panzer::BlockedVector_ReadOnly_GlobalEvaluationData > xBvRoGed_
The GlobalEvaluationData containing both the owned and ghosted tangent vectors.
Teuchos::RCP< std::vector< std::string > > indexerNames_
A list of the names of the fields to be gathered.
std::vector< int > indexerIds_
The block index into indexers_.
std::string globalDataKey_
The key identifying the GlobalEvaluationData.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Wrapper to PHX::EvaluatorWithBaseImpl that implements Panzer-specific helpers.
void preEvaluate(typename TRAITS::PreEvalData d)
Pre-Evaluate: Sets the tangent vector.
std::vector< PHX::MDField< ScalarT, Cell, NODE > > gatherFields_
The fields to be gathered.
GatherTangent_BlockedEpetra(const std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int >>> &indexers)
Constructor.
GatherTangent_BlockedEpetra()
Default Constructor (disabled)
std::vector< Teuchos::RCP< const UniqueGlobalIndexer< LO, int > > > indexers_
These map the local (field, element, basis) triplet to a global ID for scattering.
std::vector< int > subFieldIds_
Sub-field IDs, which need to be mapped.
void evaluateFields(typename TRAITS::EvalData d)
Evaluate Fields: Gather operation.
void postRegistrationSetup(typename TRAITS::SetupData d, PHX::FieldManager< TRAITS > &vm)
Post-Registration Setup.
Non-templated empty base class for template managers.