MeshQuality.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.
//
//  Copyright 2014 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
//  Copyright 2014 UT-Battelle, LLC.
//  Copyright 2014 Los Alamos National Security.
//
//  Under the terms of Contract DE-NA0003525 with NTESS,
//  the U.S. Government retains certain rights in this software.
//
//  Under the terms of Contract DE-AC52-06NA25396 with Los Alamos National
//  Laboratory (LANL), the U.S. Government retains certain rights in
//  this software.
//============================================================================
 
#ifndef viskores_filter_mesh_info_MeshQuality_h
#define viskores_filter_mesh_info_MeshQuality_h
 
#include <viskores/filter/Filter.h>
#include <viskores/filter/mesh_info/viskores_filter_mesh_info_export.h>
 
#include <viskores/Deprecated.h>
 
namespace viskores
{
namespace filter
{
namespace mesh_info
{
 
enum struct CellMetric
{
  Area,
  AspectGamma,
  AspectRatio,
  Condition,
  DiagonalRatio,
  Dimension,
  Jacobian,
  MaxAngle,
  MaxDiagonal,
  MinAngle,
  MinDiagonal,
  Oddy,
  RelativeSizeSquared,
  ScaledJacobian,
  Shape,
  ShapeAndSize,
  Shear,
  Skew,
  Stretch,
  Taper,
  Volume,
  Warpage,
  None
};
 
class VISKORES_FILTER_MESH_INFO_EXPORT MeshQuality : public viskores::filter::Filter
{
public:
  MeshQuality();
 
  VISKORES_DEPRECATED(2.2, "use default constructor and SetMetric().")
  VISKORES_CONT explicit MeshQuality(CellMetric);
 
  VISKORES_CONT void SetMetric(CellMetric metric);
  VISKORES_CONT CellMetric GetMetric() const { return this->MyMetric; }
 
  VISKORES_CONT std::string GetMetricName() const;
 
private:
  VISKORES_CONT viskores::cont::DataSet DoExecute(const viskores::cont::DataSet& input) override;
 
  CellMetric MyMetric = CellMetric::None;
};
} // namespace mesh_info
} // namespace filter
} // namespace viskores
 
#endif // viskores_filter_mesh_info_MeshQuality_h