mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-20 11:05:44 +00:00
de4e840eae
Filters now support executing on a dataset to produce a result dataset with automatic mapping of fields to the output dataset. Fields to map can be selected using `vtkm::filter::FieldSelection` class, which provides constructors to map all or no fields, along with a selection of fields. This updates all tests to use the new filter API.
134 lines
4.5 KiB
C++
134 lines
4.5 KiB
C++
//============================================================================
|
|
// 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 vtk_m_filter_FieldFilter_h
|
|
#define vtk_m_filter_FieldFilter_h
|
|
|
|
#include <vtkm/cont/CoordinateSystem.h>
|
|
#include <vtkm/cont/DataSet.h>
|
|
#include <vtkm/cont/Field.h>
|
|
#include <vtkm/cont/MultiBlock.h>
|
|
#include <vtkm/cont/RuntimeDeviceTracker.h>
|
|
|
|
#include <vtkm/filter/Filter.h>
|
|
#include <vtkm/filter/PolicyBase.h>
|
|
#include <vtkm/filter/Result.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace filter
|
|
{
|
|
|
|
template <class Derived>
|
|
class FilterField : public vtkm::filter::Filter<FilterField<Derived>>
|
|
{
|
|
public:
|
|
VTKM_CONT
|
|
FilterField();
|
|
|
|
VTKM_CONT
|
|
~FilterField();
|
|
|
|
VTKM_CONT
|
|
void SetOutputFieldName(const std::string& name) { this->OutputFieldName = name; }
|
|
|
|
VTKM_CONT
|
|
const std::string& GetOutputFieldName() const { return this->OutputFieldName; }
|
|
|
|
//@{
|
|
/// Choose the field to operate on. Note, if
|
|
/// `this->UseCoordinateSystemAsField` is true, then the active field is not used.
|
|
VTKM_CONT
|
|
void SetActiveField(const std::string& name,
|
|
vtkm::cont::Field::AssociationEnum association = vtkm::cont::Field::ASSOC_ANY)
|
|
{
|
|
this->ActiveFieldName = name;
|
|
this->ActiveFieldAssociation = association;
|
|
}
|
|
|
|
VTKM_CONT const std::string& GetActiveFieldName() const { return this->ActiveFieldName; }
|
|
VTKM_CONT vtkm::cont::Field::AssociationEnum GetActiveFieldAssociation() const
|
|
{
|
|
return this->ActiveFieldAssociation;
|
|
}
|
|
//@}
|
|
|
|
//@{
|
|
/// To simply use the active coordinate system as the field to operate on, set
|
|
/// UseCoordinateSystemAsField to true.
|
|
VTKM_CONT
|
|
void SetUseCoordinateSystemAsField(bool val) { this->UseCoordinateSystemAsField = val; }
|
|
VTKM_CONT
|
|
bool GetUseCoordinateSystemAsField() const { return this->UseCoordinateSystemAsField; }
|
|
//@}
|
|
|
|
|
|
//@{
|
|
/// Select the coordinate system index to make active to use as the field when
|
|
/// UseCoordinateSystemAsField is true.
|
|
VTKM_CONT
|
|
void SetActiveCoordinateSystem(vtkm::Id index) { this->CoordinateSystemIndex = index; }
|
|
|
|
VTKM_CONT
|
|
vtkm::Id GetActiveCoordinateSystemIndex() const { return this->CoordinateSystemIndex; }
|
|
//@}
|
|
|
|
|
|
/// These are provided to satisfy the Filter API requirements.
|
|
/// They simply pass the field to the result dataset as there's no mapping
|
|
/// needed for FilterField.
|
|
VTKM_CONT
|
|
bool MapFieldOntoOutput(Result& result, const vtkm::cont::Field& field);
|
|
|
|
template <typename DerivedPolicy>
|
|
VTKM_CONT bool MapFieldOntoOutput(Result& result,
|
|
const vtkm::cont::Field& field,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy);
|
|
|
|
private:
|
|
template <typename DerivedPolicy>
|
|
VTKM_CONT Result PrepareForExecution(const vtkm::cont::DataSet& input,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy);
|
|
|
|
template <typename DerivedPolicy>
|
|
VTKM_CONT Result PrepareForExecution(const vtkm::cont::DataSet& input,
|
|
const vtkm::cont::Field& field,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy);
|
|
|
|
template <typename DerivedPolicy>
|
|
VTKM_CONT Result PrepareForExecution(const vtkm::cont::DataSet& input,
|
|
const vtkm::cont::CoordinateSystem& field,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy);
|
|
|
|
std::string OutputFieldName;
|
|
vtkm::Id CoordinateSystemIndex;
|
|
std::string ActiveFieldName;
|
|
vtkm::cont::Field::AssociationEnum ActiveFieldAssociation;
|
|
bool UseCoordinateSystemAsField;
|
|
|
|
friend class vtkm::filter::Filter<FilterField<Derived>>;
|
|
};
|
|
}
|
|
} // namespace vtkm::filter
|
|
|
|
#include <vtkm/filter/FilterField.hxx>
|
|
|
|
#endif // vtk_m_filter_FieldFilter_h
|