Panzer Version of the Day
Loading...
Searching...
No Matches
Panzer_WriteVector_GlobalEvaluationData.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_WriteVector_GlobalEvaluationData_hpp__
44#define __Panzer_WriteVector_GlobalEvaluationData_hpp__
45
46// Panzer
47#include "PanzerDiscFE_config.hpp"
48#ifdef PANZER_HAVE_EPETRA_STACK
50#endif
51
53
54// Teuchos
55#include "Teuchos_RCP.hpp"
56
57// Thyra
58#include "Thyra_VectorBase.hpp"
59
60namespace panzer {
61
66public:
67
70
73
76
79
82
84 virtual bool isInitialized() const = 0;
85
86
89 virtual void globalToGhost(int /* mem */) { }
90
94 virtual void ghostToGlobal(int mem) = 0;
95
97 virtual void setOwnedVector(const Teuchos::RCP<Thyra::VectorBase<double> > & ownedVector) = 0;
98
100 virtual Teuchos::RCP<Thyra::VectorBase<double> > getOwnedVector() const = 0;
101
103 virtual Teuchos::RCP<Thyra::VectorBase<double> > getGhostedVector() const = 0;
104
105#ifdef PANZER_HAVE_EPETRA_STACK
118 double&
119 operator[](
120 const int& lid)
121 {
122 if (lid < static_cast<int>(ownedView_.extent(0)))
123 return ownedView_(lid);
124 else // if (lid >= static_cast<int>(ownedView_.extent(0)))
125 return ghostedView_(lid - ownedView_.extent(0));
126 } // end of operator[]()
127
128protected:
129
134 ownedView_;
135
140 ghostedView_;
141#endif // PANZER_HAVE_EPETRA_STACK
142
143private:
144
146}; // end of class WriteVector_GlobalEvaluationData
147
148} // end of namespace panzer
149
150#endif // __Panzer_WriteVector_GlobalEvaluationData_hpp__
virtual Teuchos::RCP< Thyra::VectorBase< double > > getOwnedVector() const =0
Get the owned vector.
WriteVector_GlobalEvaluationData()
Default constructor, set combine mode to sum right away.
virtual Teuchos::RCP< Thyra::VectorBase< double > > getGhostedVector() const =0
Get the ghosted vector.
CombineMode getCombineMode() const
Get the combine mode, to be used by sub classes.
virtual void setOwnedVector(const Teuchos::RCP< Thyra::VectorBase< double > > &ownedVector)=0
Set the owned vector.
void setCombineMode(CombineMode cm)
Allow the user to set the combine mode (at any time)
CombineMode
when you gho from ghost to global, combine with a particular mode
virtual void ghostToGlobal(int mem)=0
virtual bool isInitialized() const =0
Is this object initialized.