ConnectivityStructured.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt for details.
//
//  This software is distributed WITHOUT ANY WARRANTY; without even
//  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
//  PURPOSE.  See the above copyright notice for more information.
//============================================================================
 
#ifndef viskores_exec_ConnectivityStructured_h
#define viskores_exec_ConnectivityStructured_h
 
#include <viskores/Deprecated.h>
#include <viskores/TopologyElementTag.h>
#include <viskores/Types.h>
#include <viskores/internal/ConnectivityStructuredInternals.h>
 
namespace viskores
{
namespace exec
{
 
template <typename VisitTopology, typename IncidentTopology, viskores::IdComponent Dimension>
class ConnectivityStructured
{
  VISKORES_IS_TOPOLOGY_ELEMENT_TAG(VisitTopology);
  VISKORES_IS_TOPOLOGY_ELEMENT_TAG(IncidentTopology);
 
  using InternalsType = viskores::internal::ConnectivityStructuredInternals<Dimension>;
 
  using Helper = viskores::internal::
    ConnectivityStructuredIndexHelper<VisitTopology, IncidentTopology, Dimension>;
 
public:
  using SchedulingRangeType = typename InternalsType::SchedulingRangeType;
 
  ConnectivityStructured() = default;
 
  VISKORES_EXEC_CONT
  ConnectivityStructured(const InternalsType& src)
    : Internals(src)
  {
  }
 
  ConnectivityStructured(const ConnectivityStructured& src) = default;
 
  VISKORES_EXEC_CONT
  ConnectivityStructured(
    const ConnectivityStructured<IncidentTopology, VisitTopology, Dimension>& src)
    : Internals(src.Internals)
  {
  }
 
 
  ConnectivityStructured& operator=(const ConnectivityStructured& src) = default;
  ConnectivityStructured& operator=(ConnectivityStructured&& src) = default;
 
 
  VISKORES_EXEC
  viskores::Id GetNumberOfElements() const { return Helper::GetNumberOfElements(this->Internals); }
 
  using CellShapeTag = typename Helper::CellShapeTag;
 
  VISKORES_EXEC
  CellShapeTag GetCellShape(viskores::Id) const { return CellShapeTag(); }
 
  template <typename IndexType>
  VISKORES_EXEC viskores::IdComponent GetNumberOfIndices(const IndexType& index) const
  {
    return Helper::GetNumberOfIndices(this->Internals, index);
  }
 
  using IndicesType = typename Helper::IndicesType;
 
  template <typename IndexType>
  VISKORES_EXEC IndicesType GetIndices(const IndexType& index) const
  {
    return Helper::GetIndices(this->Internals, index);
  }
 
  VISKORES_EXEC_CONT SchedulingRangeType FlatToLogicalVisitIndex(viskores::Id flatVisitIndex) const
  {
    return Helper::FlatToLogicalVisitIndex(this->Internals, flatVisitIndex);
  }
 
  VISKORES_EXEC_CONT SchedulingRangeType
  FlatToLogicalIncidentIndex(viskores::Id flatIncidentIndex) const
  {
    return Helper::FlatToLogicalIncidentIndex(this->Internals, flatIncidentIndex);
  }
 
  VISKORES_EXEC_CONT viskores::Id LogicalToFlatVisitIndex(
    const SchedulingRangeType& logicalVisitIndex) const
  {
    return Helper::LogicalToFlatVisitIndex(this->Internals, logicalVisitIndex);
  }
 
  VISKORES_EXEC_CONT viskores::Id LogicalToFlatIncidentIndex(
    const SchedulingRangeType& logicalIncidentIndex) const
  {
    return Helper::LogicalToFlatIncidentIndex(this->Internals, logicalIncidentIndex);
  }
 
  VISKORES_EXEC_CONT
  VISKORES_DEPRECATED(2.1, "Use FlatToLogicalIncidentIndex.")
  SchedulingRangeType FlatToLogicalFromIndex(viskores::Id flatFromIndex) const
  {
    return this->FlatToLogicalIncidentIndex(flatFromIndex);
  }
 
  VISKORES_EXEC_CONT
  VISKORES_DEPRECATED(2.1, "Use LogicalToFlatIncidentIndex.")
  viskores::Id LogicalToFlatFromIndex(const SchedulingRangeType& logicalFromIndex) const
  {
    return this->LogicalToFlatIncidentIndex(logicalFromIndex);
  }
 
  VISKORES_EXEC_CONT
  VISKORES_DEPRECATED(2.1, "Use FlatToLogicalVisitIndex.")
  SchedulingRangeType FlatToLogicalToIndex(viskores::Id flatToIndex) const
  {
    return this->FlatToLogicalVisitIndex(flatToIndex);
  }
 
  VISKORES_EXEC_CONT
  VISKORES_DEPRECATED(2.1, "Use LogicalToFlatVisitIndex.")
  viskores::Id LogicalToFlatToIndex(const SchedulingRangeType& logicalToIndex) const
  {
    return this->LogicalToFlatVisitIndex(logicalToIndex);
  }
 
  VISKORES_EXEC_CONT
  viskores::Vec<viskores::Id, Dimension> GetPointDimensions() const
  {
    return this->Internals.GetPointDimensions();
  }
 
  VISKORES_EXEC_CONT
  viskores::Vec<viskores::Id, Dimension> GetCellDimensions() const
  {
    return this->Internals.GetCellDimensions();
  }
 
  VISKORES_EXEC_CONT
  SchedulingRangeType GetGlobalPointIndexStart() const
  {
    return this->Internals.GetGlobalPointIndexStart();
  }
 
  friend class ConnectivityStructured<IncidentTopology, VisitTopology, Dimension>;
 
private:
  InternalsType Internals;
};
}
} // namespace viskores::exec
 
#endif //viskores_exec_ConnectivityStructured_h