mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-21 19:45:44 +00:00
f4362a4902
VTK-m style guidelines dictate that all classes part of the API should be in their own header file. Thus, we have moved the result classes out of the filter header files and into their own headers. We have also renamed these clases to ResultField and ResultDataSet to better match the class naming conventions of VTK-m. Since we are moving around these result classes, we have also revamped their structure. They are now in a hierarchy with a common ResultBase class. Additionally, all result classes have a reference to a complete DataSet that can be considered the output of the filter. This will make it easier for users to consistently deal with filter results. These changes cover issues #60 and #62.
208 lines
8.1 KiB
C++
208 lines
8.1 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 Sandia Corporation.
|
|
// Copyright 2014 UT-Battelle, LLC.
|
|
// Copyright 2014 Los Alamos National Security.
|
|
//
|
|
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
|
|
// 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.
|
|
//============================================================================
|
|
|
|
#include <vtkm/filter/FieldMetadata.h>
|
|
#include <vtkm/filter/FilterTraits.h>
|
|
#include <vtkm/filter/PolicyDefault.h>
|
|
|
|
#include <vtkm/filter/internal/ResolveFieldTypeAndExecute.h>
|
|
#include <vtkm/filter/internal/ResolveFieldTypeAndMap.h>
|
|
|
|
#include <vtkm/cont/Error.h>
|
|
#include <vtkm/cont/ErrorControlBadAllocation.h>
|
|
#include <vtkm/cont/ErrorExecution.h>
|
|
|
|
#include <vtkm/cont/cuda/DeviceAdapterCuda.h>
|
|
#include <vtkm/cont/tbb/DeviceAdapterTBB.h>
|
|
|
|
namespace vtkm {
|
|
namespace filter {
|
|
|
|
//----------------------------------------------------------------------------
|
|
template<class Derived>
|
|
FilterDataSetWithField<Derived>::FilterDataSetWithField():
|
|
OutputFieldName(),
|
|
CellSetIndex(0),
|
|
CoordinateSystemIndex(0),
|
|
Tracker()
|
|
{
|
|
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
template<typename Derived>
|
|
ResultDataSet FilterDataSetWithField<Derived>::Execute(const vtkm::cont::DataSet &input,
|
|
const std::string &inFieldName)
|
|
{
|
|
return this->Execute(input,
|
|
input.GetField(inFieldName),
|
|
vtkm::filter::DefaultPolicy());
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
template<typename Derived>
|
|
ResultDataSet FilterDataSetWithField<Derived>::Execute(const vtkm::cont::DataSet &input,
|
|
const vtkm::cont::Field &field)
|
|
{
|
|
return this->Execute(input,
|
|
field,
|
|
vtkm::filter::DefaultPolicy());
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
template<typename Derived>
|
|
ResultDataSet FilterDataSetWithField<Derived>::Execute(const vtkm::cont::DataSet &input,
|
|
const vtkm::cont::CoordinateSystem &field)
|
|
{
|
|
return this->Execute(input,
|
|
field,
|
|
vtkm::filter::DefaultPolicy());
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
template<typename Derived>
|
|
template<typename DerivedPolicy>
|
|
ResultDataSet FilterDataSetWithField<Derived>::Execute(const vtkm::cont::DataSet &input,
|
|
const std::string &inFieldName,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy )
|
|
{
|
|
return this->Execute(input,
|
|
input.GetField(inFieldName),
|
|
policy);
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
template<typename Derived>
|
|
template<typename DerivedPolicy>
|
|
ResultDataSet FilterDataSetWithField<Derived>::Execute(const vtkm::cont::DataSet &input,
|
|
const vtkm::cont::Field &field,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy )
|
|
{
|
|
return this->PrepareForExecution(input, field, policy);
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
template<typename Derived>
|
|
template<typename DerivedPolicy>
|
|
ResultDataSet FilterDataSetWithField<Derived>::Execute(const vtkm::cont::DataSet &input,
|
|
const vtkm::cont::CoordinateSystem &field,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy )
|
|
{
|
|
//we need to state that the field is actually a coordinate system, so that
|
|
//the filter uses the proper policy to convert the types.
|
|
return this->PrepareForExecution(input, field, policy);
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
template<typename Derived>
|
|
template<typename DerivedPolicy>
|
|
ResultDataSet FilterDataSetWithField<Derived>::PrepareForExecution(const vtkm::cont::DataSet &input,
|
|
const vtkm::cont::Field &field,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy )
|
|
{
|
|
vtkm::filter::FieldMetadata metaData(field);
|
|
ResultDataSet result;
|
|
|
|
typedef internal::ResolveFieldTypeAndExecute< Derived, DerivedPolicy,
|
|
ResultDataSet > FunctorType;
|
|
FunctorType functor(static_cast<Derived*>(this),
|
|
input,
|
|
metaData,
|
|
policy,
|
|
this->Tracker,
|
|
result);
|
|
|
|
typedef vtkm::filter::FilterTraits< Derived > Traits;
|
|
vtkm::filter::ApplyPolicy(field, policy, Traits()).CastAndCall(functor);
|
|
|
|
return result;
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
template<typename Derived>
|
|
template<typename DerivedPolicy>
|
|
ResultDataSet FilterDataSetWithField<Derived>::PrepareForExecution(const vtkm::cont::DataSet &input,
|
|
const vtkm::cont::CoordinateSystem &field,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy )
|
|
{
|
|
//We have a special signature just for CoordinateSystem, so that we can ask
|
|
//the policy for the storage types and value types just for coordinate systems
|
|
vtkm::filter::FieldMetadata metaData(field);
|
|
|
|
//determine the field type first
|
|
ResultDataSet result;
|
|
typedef internal::ResolveFieldTypeAndExecute< Derived, DerivedPolicy,
|
|
ResultDataSet > FunctorType;
|
|
FunctorType functor(static_cast<Derived*>(this),
|
|
input,
|
|
metaData,
|
|
policy,
|
|
this->Tracker,
|
|
result);
|
|
|
|
typedef vtkm::filter::FilterTraits< Derived > Traits;
|
|
vtkm::filter::ApplyPolicy(field, policy, Traits()).CastAndCall(functor);
|
|
|
|
return result;
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
template<typename Derived>
|
|
bool FilterDataSetWithField<Derived>::MapFieldOntoOutput(ResultDataSet& result,
|
|
const vtkm::cont::Field& field)
|
|
{
|
|
return this->MapFieldOntoOutput(result, field, vtkm::filter::DefaultPolicy());
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
template<typename Derived>
|
|
template<typename DerivedPolicy>
|
|
bool FilterDataSetWithField<Derived>::MapFieldOntoOutput(ResultDataSet& result,
|
|
const vtkm::cont::Field& field,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy)
|
|
{
|
|
bool valid = false;
|
|
if(result.IsValid())
|
|
{
|
|
vtkm::filter::FieldMetadata metaData(field);
|
|
typedef internal::ResolveFieldTypeAndMap< Derived,
|
|
DerivedPolicy > FunctorType;
|
|
FunctorType functor(static_cast<Derived*>(this),
|
|
result,
|
|
metaData,
|
|
policy,
|
|
this->Tracker,
|
|
valid);
|
|
|
|
typedef vtkm::filter::FilterTraits< Derived > Traits;
|
|
vtkm::filter::ApplyPolicy(field, policy, Traits()).CastAndCall(functor);
|
|
}
|
|
|
|
//the bool valid will be modified by the map algorithm to hold if the
|
|
//mapping occurred or not. If the mapping was good a new field has been
|
|
//added to the ResultDataSet that was passed in.
|
|
return valid;
|
|
|
|
}
|
|
|
|
|
|
}
|
|
}
|