Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//           Panzer: A partial differential equation assembly
//       engine for strongly coupled complex multiphysics systems
//                 Copyright (2011) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roger P. Pawlowski (rppawlo@sandia.gov) and
// Eric C. Cyr (eccyr@sandia.gov)
// ***********************************************************************
// @HEADER

#ifndef   __Panzer_BlockedVector_ReadOnly_GlobalEvaluationData_hpp__
#define   __Panzer_BlockedVector_ReadOnly_GlobalEvaluationData_hpp__

//
//  Include Files
//

// Panzer
#include "Panzer_ReadOnlyVector_GlobalEvaluationData.hpp"

//
//  Forward Declarations
//

namespace Thyra
{
  template<typename> class DefaultProductVectorSpace;
}

namespace panzer
{
  class BlockedVector_ReadOnly_GlobalEvaluationData
    :
    public ReadOnlyVector_GlobalEvaluationData
  {
    public:

      BlockedVector_ReadOnly_GlobalEvaluationData();

      BlockedVector_ReadOnly_GlobalEvaluationData(
        const BlockedVector_ReadOnly_GlobalEvaluationData& src);

      BlockedVector_ReadOnly_GlobalEvaluationData(
        const Teuchos::RCP<const Thyra::VectorSpaceBase<double>> ghostedSpace,
        const Teuchos::RCP<const Thyra::VectorSpaceBase<double>> ownedSpace,
        const std::vector<Teuchos::RCP<ReadOnlyVector_GlobalEvaluationData>>&
          gedBlocks);

      virtual ~BlockedVector_ReadOnly_GlobalEvaluationData()
      {
      } // end of Destructor

      void
      initialize(
        const Teuchos::RCP<const Thyra::VectorSpaceBase<double>>& ghostedSpace,
        const Teuchos::RCP<const Thyra::VectorSpaceBase<double>>& ownedSpace,
        const std::vector<Teuchos::RCP<ReadOnlyVector_GlobalEvaluationData>>&
          gedBlocks);

      virtual bool
      isInitialized() const
      {
        return isInitialized_;
      } // end of isInitialized()

      virtual void
      globalToGhost(
        int mem);

      virtual void
      initializeData();

      virtual void
      setOwnedVector(
        const Teuchos::RCP<const Thyra::VectorBase<double>>& ownedVector);

      virtual Teuchos::RCP<const Thyra::VectorBase<double>>
      getOwnedVector() const;

      virtual Teuchos::RCP<Thyra::VectorBase<double>>
      getGhostedVector() const;

      size_t
      getBlockCount() const
      {
        return gedBlocks_.size();
      } // end of getBlockCount()

      Teuchos::RCP<ReadOnlyVector_GlobalEvaluationData>
      getGEDBlock(
        int i)
      {
        return gedBlocks_[i];
      } // end of getGEDBlock()

      Teuchos::RCP<const ReadOnlyVector_GlobalEvaluationData>
      getGEDBlock(
        int i) const
      {
        return gedBlocks_[i];
      } // end of getGEDBlock()

      bool
      requiresDirichletAdjustment() const
      {
        return false;
      } // end of requiresDirichletAdjustment()

    private:

      bool isInitialized_;

      std::vector<Teuchos::RCP<ReadOnlyVector_GlobalEvaluationData>>
      gedBlocks_;

      Teuchos::RCP<const Thyra::VectorBase<double>> ownedVector_;

      Teuchos::RCP<const Thyra::DefaultProductVectorSpace<double>>
      ghostedSpace_;

  }; // end of class BlockedVector_ReadOnly_GlobalEvaluationData

} // end of namespace panzer

#endif // __Panzer_BlockedVector_ReadOnly_GlobalEvaluationData_hpp__