mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-10-05 01:49:02 +00:00
Fix doxygen groups
This commit is contained in:
parent
b9074f0946
commit
70ba476bd5
@ -37,7 +37,7 @@ public:
|
||||
VTKM_CONT
|
||||
vtkm::Id GetNumberOfBins() const { return this->NumberOfBins; }
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Get/Set the range to use to generate the HistogramMPI. If range is set to
|
||||
/// empty, the field's global range (computed using `vtkm::cont::FieldRangeGlobalCompute`)
|
||||
/// will be used.
|
||||
@ -46,7 +46,7 @@ public:
|
||||
|
||||
VTKM_CONT
|
||||
const vtkm::Range& GetRange() const { return this->Range; }
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// Returns the bin delta of the last computed field.
|
||||
VTKM_CONT
|
||||
@ -64,7 +64,7 @@ public:
|
||||
const vtkm::filter::FieldMetadata& fieldMeta,
|
||||
const vtkm::filter::PolicyBase<DerivedPolicy>& policy);
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// when operating on vtkm::cont::PartitionedDataSet, we
|
||||
/// want to do processing across ranks as well. Just adding pre/post handles
|
||||
/// for the same does the trick.
|
||||
@ -76,7 +76,7 @@ public:
|
||||
VTKM_CONT void PostExecute(const vtkm::cont::PartitionedDataSet& input,
|
||||
vtkm::cont::PartitionedDataSet& output,
|
||||
const vtkm::filter::PolicyBase<DerivedPolicy>&);
|
||||
//@}
|
||||
///@}
|
||||
|
||||
private:
|
||||
vtkm::Id NumberOfBins;
|
||||
|
@ -68,7 +68,7 @@ public:
|
||||
|
||||
VTKM_CONT
|
||||
int rank(int gid) const override;
|
||||
//@}
|
||||
///@}
|
||||
private:
|
||||
std::vector<vtkm::Id> IScanPartitionCounts;
|
||||
};
|
||||
|
@ -121,7 +121,7 @@ public:
|
||||
|
||||
/// Returns the field that matches the provided name and association
|
||||
/// Will throw an exception if no match is found
|
||||
//@{
|
||||
///@{
|
||||
VTKM_CONT
|
||||
const vtkm::cont::Field& GetField(
|
||||
const std::string& name,
|
||||
@ -138,11 +138,11 @@ public:
|
||||
{
|
||||
return this->Fields.GetField(name, assoc);
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// Returns the first cell field that matches the provided name.
|
||||
/// Will throw an exception if no match is found
|
||||
//@{
|
||||
///@{
|
||||
VTKM_CONT
|
||||
const vtkm::cont::Field& GetCellField(const std::string& name) const
|
||||
{
|
||||
@ -154,11 +154,11 @@ public:
|
||||
{
|
||||
return this->GetField(name, vtkm::cont::Field::Association::Cells);
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// Returns the first cell field that matches the provided name.
|
||||
/// Will throw an exception if no match is found
|
||||
//@{
|
||||
///@{
|
||||
VTKM_CONT
|
||||
const vtkm::cont::Field& GetGhostCellField() const
|
||||
{
|
||||
@ -171,11 +171,11 @@ public:
|
||||
throw vtkm::cont::ErrorBadValue("No Ghost Cell Field");
|
||||
}
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// Returns the first point field that matches the provided name.
|
||||
/// Will throw an exception if no match is found
|
||||
//@{
|
||||
///@{
|
||||
VTKM_CONT
|
||||
const vtkm::cont::Field& GetPointField(const std::string& name) const
|
||||
{
|
||||
@ -187,7 +187,7 @@ public:
|
||||
{
|
||||
return this->GetField(name, vtkm::cont::Field::Association::Points);
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
VTKM_CONT
|
||||
void AddPointField(const std::string& fieldName, const vtkm::cont::UnknownArrayHandle& field)
|
||||
@ -290,13 +290,13 @@ public:
|
||||
|
||||
/// Returns the first CoordinateSystem that matches the provided name.
|
||||
/// Will throw an exception if no match is found
|
||||
//@{
|
||||
///@{
|
||||
VTKM_CONT
|
||||
const vtkm::cont::CoordinateSystem& GetCoordinateSystem(const std::string& name) const;
|
||||
|
||||
VTKM_CONT
|
||||
vtkm::cont::CoordinateSystem& GetCoordinateSystem(const std::string& name);
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// Returns an `std::vector` of `CoordinateSystem`s held in this `DataSet`.
|
||||
///
|
||||
|
@ -91,7 +91,7 @@ public:
|
||||
VTKM_CONT
|
||||
void AppendPartitions(const std::vector<vtkm::cont::DataSet>& partitions);
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Methods to Add and Get fields on a PartitionedDataSet
|
||||
VTKM_CONT
|
||||
vtkm::IdComponent GetNumberOfFields() const { return this->Fields.GetNumberOfFields(); }
|
||||
@ -205,7 +205,7 @@ public:
|
||||
{
|
||||
return (this->Fields.GetFieldIndex(name, vtkm::cont::Field::Association::Partitions) != -1);
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// Copies the partitions from the source. The fields on the PartitionedDataSet are not copied.
|
||||
VTKM_CONT
|
||||
@ -214,7 +214,7 @@ public:
|
||||
VTKM_CONT
|
||||
void PrintSummary(std::ostream& stream) const;
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// API to support range-based for loops on partitions.
|
||||
VTKM_CONT
|
||||
iterator begin() noexcept { return this->Partitions.begin(); }
|
||||
@ -228,7 +228,7 @@ public:
|
||||
const_iterator cbegin() const noexcept { return this->Partitions.cbegin(); }
|
||||
VTKM_CONT
|
||||
const_iterator cend() const noexcept { return this->Partitions.cend(); }
|
||||
//@}
|
||||
///@}
|
||||
|
||||
private:
|
||||
std::vector<vtkm::cont::DataSet> Partitions;
|
||||
|
@ -364,7 +364,7 @@ public:
|
||||
return VariantArrayHandleBase<NewTypeList>(*this);
|
||||
}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// \brief Call a functor using the underlying array type.
|
||||
///
|
||||
/// `CastAndCall` attempts to cast the held array to a specific value type,
|
||||
@ -398,7 +398,7 @@ public:
|
||||
{
|
||||
this->CastAndCallImpl(std::false_type(), std::forward<Functor>(f));
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// \brief Create a new array of the same type as this array.
|
||||
///
|
||||
|
@ -37,7 +37,7 @@ struct BoundaryState
|
||||
{
|
||||
}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Returns true if a neighborhood of the given radius is contained within the bounds of the cell
|
||||
/// set in the X, Y, or Z direction. Returns false if the neighborhood extends outside of the
|
||||
/// boundary of the data in the X, Y, or Z direction.
|
||||
@ -62,7 +62,7 @@ struct BoundaryState
|
||||
VTKM_ASSERT(radius >= 0);
|
||||
return (((this->IJK[2] - radius) >= 0) && ((this->IJK[2] + radius) < this->PointDimensions[2]));
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// Returns true if a neighborhood of the given radius is contained within the bounds
|
||||
/// of the cell set. Returns false if the neighborhood extends outside of the boundary of the
|
||||
@ -79,7 +79,7 @@ struct BoundaryState
|
||||
this->IsRadiusInZBoundary(radius);
|
||||
}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Returns true if the neighbor at the specified @a offset is contained
|
||||
/// within the bounds of the cell set in the X, Y, or Z direction. Returns
|
||||
/// false if the neighbor falls outside of the boundary of the data in the X,
|
||||
@ -97,7 +97,7 @@ struct BoundaryState
|
||||
{
|
||||
return (((this->IJK[2] + offset) >= 0) && ((this->IJK[2] + offset) < this->PointDimensions[2]));
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// Returns true if the neighbor at the specified offset vector is contained
|
||||
/// within the bounds of the cell set. Returns false if the neighbor falls
|
||||
@ -154,7 +154,7 @@ struct BoundaryState
|
||||
return maxIndices;
|
||||
}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Takes a local neighborhood index (in the ranges of -neighborhood size to neighborhood size)
|
||||
/// and returns the ijk of the equivalent point in the full data set. If the given value is out
|
||||
/// of range, the value is clamped to the nearest boundary. For example, if given a neighbor
|
||||
@ -174,9 +174,9 @@ struct BoundaryState
|
||||
{
|
||||
return this->NeighborIndexToFullIndexClamp(vtkm::make_Vec(neighborI, neighborJ, neighborK));
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Takes a local neighborhood index (in the ranges of -neighborhood size to neighborhood size)
|
||||
/// and returns the ijk of the equivalent point in the full data set. If the given value is out
|
||||
/// of range, the returned value is undefined.
|
||||
@ -192,9 +192,9 @@ struct BoundaryState
|
||||
{
|
||||
return this->NeighborIndexToFullIndex(vtkm::make_Vec(neighborI, neighborJ, neighborK));
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Takes a local neighborhood index (in the ranges of -neighborhood size to
|
||||
/// neighborhood size), clamps it to the dataset bounds, and returns a new
|
||||
/// neighborhood index. For example, if given a neighbor index that is past
|
||||
@ -215,9 +215,9 @@ struct BoundaryState
|
||||
{
|
||||
return this->ClampNeighborIndex(vtkm::make_Vec(neighborI, neighborJ, neighborK));
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Takes a local neighborhood index (in the ranges of -neighborhood size to neighborhood size)
|
||||
/// and returns the flat index of the equivalent point in the full data set. If the given value
|
||||
/// is out of range, the value is clamped to the nearest boundary. For example, if given a
|
||||
@ -237,9 +237,9 @@ struct BoundaryState
|
||||
{
|
||||
return this->NeighborIndexToFlatIndexClamp(vtkm::make_Vec(neighborI, neighborJ, neighborK));
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Takes a local neighborhood index (in the ranges of -neighborhood size to neighborhood size)
|
||||
/// and returns the flat index of the equivalent point in the full data set. If the given value
|
||||
/// is out of range, the result is undefined.
|
||||
@ -256,7 +256,7 @@ struct BoundaryState
|
||||
{
|
||||
return this->NeighborIndexToFlatIndex(vtkm::make_Vec(neighborI, neighborJ, neighborK));
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
vtkm::Id3 IJK;
|
||||
vtkm::Id3 PointDimensions;
|
||||
};
|
||||
|
@ -196,7 +196,7 @@ public:
|
||||
}
|
||||
}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Add fields to map. Note, if Mode is not MODE_SELECT, then adding fields
|
||||
/// will have no impact of the fields that will be mapped.
|
||||
VTKM_CONT
|
||||
@ -211,7 +211,7 @@ public:
|
||||
{
|
||||
this->Fields.insert(Field(fieldName, association));
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// Returns true if the input field has been added to this selection.
|
||||
/// Note that depending on the mode of this selection, the result of HasField
|
||||
|
@ -243,7 +243,7 @@ public:
|
||||
/// of concrete cell set it is. This provides a list of supported cell sets.
|
||||
using SupportedCellSets = VTKM_DEFAULT_CELL_SET_LIST;
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// \brief Specify which fields get passed from input to output.
|
||||
///
|
||||
/// After a filter successfully executes and returns a new data set, fields are mapped from
|
||||
@ -280,9 +280,9 @@ public:
|
||||
const vtkm::filter::FieldSelection& GetFieldsToPass() const { return this->FieldsToPass; }
|
||||
VTKM_CONT
|
||||
vtkm::filter::FieldSelection& GetFieldsToPass() { return this->FieldsToPass; }
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Executes the filter on the input and produces a result dataset.
|
||||
///
|
||||
/// On success, this the dataset produced. On error, vtkm::cont::ErrorExecution will be thrown.
|
||||
@ -294,9 +294,9 @@ public:
|
||||
"Specify default types in CMake configuration instead.")
|
||||
VTKM_CONT vtkm::cont::DataSet
|
||||
Execute(const vtkm::cont::DataSet& input, vtkm::filter::PolicyBase<DerivedPolicy> policy);
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Executes the filter on the input PartitionedDataSet and produces a result PartitionedDataSet.
|
||||
///
|
||||
/// On success, this the dataset produced. On error, vtkm::cont::ErrorExecution will be thrown.
|
||||
@ -312,7 +312,7 @@ public:
|
||||
"Specify default types in CMake configuration instead.")
|
||||
VTKM_CONT vtkm::cont::PartitionedDataSet Execute(const vtkm::cont::PartitionedDataSet& input,
|
||||
vtkm::filter::PolicyBase<DerivedPolicy> policy);
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// Map fields from input dataset to output.
|
||||
/// This is not intended for external use. Subclasses of Filter, however, may
|
||||
|
@ -40,7 +40,7 @@ public:
|
||||
VTKM_CONT
|
||||
vtkm::Id GetActiveCoordinateSystemIndex() const { return this->CoordinateSystemIndex; }
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Choose the field to operate on. Note, if
|
||||
/// `this->UseCoordinateSystemAsField` is true, then the active field is not used.
|
||||
VTKM_CONT
|
||||
@ -57,16 +57,16 @@ public:
|
||||
{
|
||||
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; }
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//From the field we can extract the association component
|
||||
// Association::Any -> unable to map
|
||||
|
@ -40,7 +40,7 @@ public:
|
||||
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
|
||||
@ -57,19 +57,19 @@ public:
|
||||
{
|
||||
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 when processing the input
|
||||
/// DataSet. This is used primarily by the Filter to select the coordinate system
|
||||
/// to use as a field when \c UseCoordinateSystemAsField is true.
|
||||
@ -78,9 +78,9 @@ public:
|
||||
|
||||
VTKM_CONT
|
||||
vtkm::Id GetActiveCoordinateSystemIndex() const { return this->CoordinateSystemIndex; }
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// These are provided to satisfy the Filter API requirements.
|
||||
template <typename DerivedPolicy>
|
||||
VTKM_CONT vtkm::cont::DataSet PrepareForExecution(const vtkm::cont::DataSet& input,
|
||||
@ -95,7 +95,7 @@ public:
|
||||
VTKM_CONT vtkm::cont::DataSet PrepareForExecution(const vtkm::cont::DataSet& input,
|
||||
const vtkm::cont::CoordinateSystem& field,
|
||||
vtkm::filter::PolicyBase<DerivedPolicy> policy);
|
||||
//@}
|
||||
///@}
|
||||
|
||||
protected:
|
||||
vtkm::filter::FilterField<Derived>& operator=(const vtkm::filter::FilterField<Derived>&) =
|
||||
|
@ -253,7 +253,7 @@ public:
|
||||
}
|
||||
}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// \brief Specify which fields get passed from input to output.
|
||||
///
|
||||
/// After a filter successfully executes and returns a new data set, fields are mapped from
|
||||
@ -290,21 +290,21 @@ public:
|
||||
const vtkm::filter::FieldSelection& GetFieldsToPass() const { return this->FieldsToPass; }
|
||||
VTKM_CONT
|
||||
vtkm::filter::FieldSelection& GetFieldsToPass() { return this->FieldsToPass; }
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Executes the filter on the input and produces a result dataset.
|
||||
///
|
||||
/// On success, this the dataset produced. On error, vtkm::cont::ErrorExecution will be thrown.
|
||||
VTKM_CONT vtkm::cont::DataSet Execute(const vtkm::cont::DataSet& input);
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Executes the filter on the input PartitionedDataSet and produces a result PartitionedDataSet.
|
||||
///
|
||||
/// On success, this the dataset produced. On error, vtkm::cont::ErrorExecution will be thrown.
|
||||
VTKM_CONT vtkm::cont::PartitionedDataSet Execute(const vtkm::cont::PartitionedDataSet& input);
|
||||
//@}
|
||||
///@}
|
||||
|
||||
// FIXME: Is this actually materialize? Are there different kinds of Invoker?
|
||||
/// Specify the vtkm::cont::Invoker to be used to execute worklets by
|
||||
|
@ -29,7 +29,7 @@ public:
|
||||
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
|
||||
@ -63,9 +63,9 @@ public:
|
||||
{
|
||||
return this->ActiveFieldAssociation[index];
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Select the coordinate system coord_idx to make active to use when processing the input
|
||||
/// DataSet. This is used primarily by the Filter to select the coordinate system
|
||||
/// to use as a field when \c UseCoordinateSystemAsField is true.
|
||||
@ -95,9 +95,9 @@ public:
|
||||
auto index_st = static_cast<std::size_t>(index);
|
||||
return this->ActiveCoordinateSystemIndices[index_st];
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// To simply use the active coordinate system as the field to operate on, set
|
||||
/// UseCoordinateSystemAsField to true.
|
||||
VTKM_CONT
|
||||
@ -118,7 +118,7 @@ public:
|
||||
(index < static_cast<vtkm::IdComponent>(this->ActiveFieldNames.size())));
|
||||
return this->UseCoordinateSystemAsField[index];
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
protected:
|
||||
VTKM_CONT
|
||||
|
@ -37,7 +37,7 @@ public:
|
||||
VTKM_CONT
|
||||
vtkm::Id GetNumberOfBins() const { return this->NumberOfBins; }
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Get/Set the range to use to generate the histogram. If range is set to
|
||||
/// empty, the field's global range (computed using `vtkm::cont::FieldRangeGlobalCompute`)
|
||||
/// will be used.
|
||||
@ -46,7 +46,7 @@ public:
|
||||
|
||||
VTKM_CONT
|
||||
const vtkm::Range& GetRange() const { return this->Range; }
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// Returns the bin delta of the last computed field.
|
||||
VTKM_CONT
|
||||
@ -63,14 +63,14 @@ private:
|
||||
VTKM_CONT vtkm::cont::PartitionedDataSet DoExecutePartitions(
|
||||
const vtkm::cont::PartitionedDataSet& inData) override;
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// when operating on vtkm::cont::PartitionedDataSet, we
|
||||
/// want to do processing across ranks as well. Just adding pre/post handles
|
||||
/// for the same does the trick.
|
||||
VTKM_CONT void PreExecute(const vtkm::cont::PartitionedDataSet& input);
|
||||
VTKM_CONT void PostExecute(const vtkm::cont::PartitionedDataSet& input,
|
||||
vtkm::cont::PartitionedDataSet& output);
|
||||
//@}
|
||||
///@}
|
||||
|
||||
vtkm::Id NumberOfBins = 10;
|
||||
vtkm::Float64 BinDelta = 0;
|
||||
|
@ -34,7 +34,7 @@ public:
|
||||
VTKM_CONT
|
||||
explicit WarpScalar(vtkm::FloatDefault scaleAmount);
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Choose the secondary field to operate on. In the warp op A + B *
|
||||
/// scaleAmount * scalarFactor, B is the secondary field
|
||||
VTKM_CONT
|
||||
@ -52,9 +52,9 @@ public:
|
||||
{
|
||||
return this->NormalFieldAssociation;
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Choose the scalar factor field to operate on. In the warp op A + B *
|
||||
/// scaleAmount * scalarFactor, scalarFactor is the scalar factor field.
|
||||
VTKM_CONT
|
||||
@ -75,7 +75,7 @@ public:
|
||||
{
|
||||
return this->ScalarFactorFieldAssociation;
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
private:
|
||||
VTKM_CONT vtkm::cont::DataSet DoExecute(const vtkm::cont::DataSet& input) override;
|
||||
|
@ -34,7 +34,7 @@ public:
|
||||
VTKM_CONT
|
||||
explicit WarpVector(vtkm::FloatDefault scale);
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Choose the vector field to operate on. In the warp op A + B *scale, B is
|
||||
/// the vector field
|
||||
VTKM_CONT
|
||||
@ -52,7 +52,7 @@ public:
|
||||
{
|
||||
return this->VectorFieldAssociation;
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
private:
|
||||
VTKM_CONT vtkm::cont::DataSet DoExecute(const vtkm::cont::DataSet& input) override;
|
||||
|
@ -68,7 +68,7 @@ public:
|
||||
this->VecFieldType = vecFieldType;
|
||||
}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Choose the field to operate on. Note, if
|
||||
/// `this->UseCoordinateSystemAsField` is true, then the active field is not used.
|
||||
VTKM_CONT void SetEField(const std::string& name) { this->SetActiveField(0, name); }
|
||||
|
@ -133,14 +133,14 @@ public:
|
||||
SetBlockIndices(blocksPerDim, localBlockIndices);
|
||||
}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Get the contour tree computed by the filter
|
||||
const vtkm::worklet::contourtree_augmented::ContourTree& GetContourTree() const;
|
||||
/// Get the sort order for the mesh vertices
|
||||
const vtkm::worklet::contourtree_augmented::IdArrayType& GetSortOrder() const;
|
||||
/// Get the number of iterations used to compute the contour tree
|
||||
vtkm::Id GetNumIterations() const;
|
||||
//@}
|
||||
///@}
|
||||
|
||||
private:
|
||||
/// Output field "saddlePeak" wich is pairs of vertex ids indicating saddle and peak of contour
|
||||
@ -148,7 +148,7 @@ private:
|
||||
VTKM_CONT vtkm::cont::PartitionedDataSet DoExecutePartitions(
|
||||
const vtkm::cont::PartitionedDataSet& inData) override;
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// when operating on vtkm::cont::MultiBlock we want to
|
||||
/// do processing across ranks as well. Just adding pre/post handles
|
||||
/// for the same does the trick.
|
||||
@ -164,7 +164,7 @@ private:
|
||||
template <typename T>
|
||||
VTKM_CONT void DoPostExecute(const vtkm::cont::PartitionedDataSet& input,
|
||||
vtkm::cont::PartitionedDataSet& output);
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// Use marching cubes connectivity for computing the contour tree
|
||||
bool UseMarchingCubes;
|
||||
|
@ -177,7 +177,7 @@ private:
|
||||
VTKM_CONT vtkm::cont::PartitionedDataSet DoExecutePartitions(
|
||||
const vtkm::cont::PartitionedDataSet& input) override;
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// when operating on vtkm::cont::MultiBlock we want to
|
||||
/// do processing across ranks as well. Just adding pre/post handles
|
||||
/// for the same does the trick.
|
||||
@ -204,7 +204,7 @@ private:
|
||||
template <typename T>
|
||||
VTKM_CONT void DoPostExecute(const vtkm::cont::PartitionedDataSet& input,
|
||||
vtkm::cont::PartitionedDataSet& output);
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// Use only boundary critical points in the parallel merge to reduce communication.
|
||||
/// Disabling this should only be needed for performance testing.
|
||||
|
@ -303,7 +303,7 @@ public:
|
||||
///
|
||||
struct GetPointDimensions
|
||||
{
|
||||
//@{
|
||||
///@{
|
||||
/// Get the number of rows, cols, and slices of a vtkm::cont::CellSetStructured
|
||||
/// @param[in] cells The input vtkm::cont::CellSetStructured
|
||||
/// @param[out] pointDimensions mesh size (#cols, #rows #slices in old notation) with last dimension having a value of 1 for 2D data
|
||||
@ -318,7 +318,7 @@ struct GetPointDimensions
|
||||
{
|
||||
pointDimensions = cells.GetPointDimensions();
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
/// Raise ErrorBadValue if the input cell set is not a vtkm::cont::CellSetStructured<2> or <3>
|
||||
template <typename T>
|
||||
@ -358,7 +358,7 @@ struct GetLocalAndGlobalPointDimensions
|
||||
globalPointDimensions = cells.GetGlobalPointDimensions();
|
||||
globalPointIndexStart = cells.GetGlobalPointIndexStart();
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
|
||||
/// Raise ErrorBadValue if the input cell set is not a vtkm::cont::CellSetStructured<2> or <3>
|
||||
|
@ -28,7 +28,7 @@ public:
|
||||
VTKM_CONT
|
||||
CrossProduct();
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Choose the primary field to operate on. In the cross product operation A x B, A is
|
||||
/// the primary field.
|
||||
VTKM_CONT
|
||||
@ -44,9 +44,9 @@ public:
|
||||
{
|
||||
return this->GetActiveFieldAssociation();
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// When set to true, uses a coordinate system as the primary field instead of the one selected
|
||||
/// by name. Use SetPrimaryCoordinateSystem to select which coordinate system.
|
||||
VTKM_CONT
|
||||
@ -59,9 +59,9 @@ public:
|
||||
{
|
||||
return this->GetUseCoordinateSystemAsField();
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Select the coordinate system index to use as the primary field. This only has an effect when
|
||||
/// UseCoordinateSystemAsPrimaryField is true.
|
||||
VTKM_CONT
|
||||
@ -71,9 +71,9 @@ public:
|
||||
{
|
||||
return this->GetActiveCoordinateSystemIndex();
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Choose the secondary field to operate on. In the dot product operation A . B, B is
|
||||
/// the secondary field.
|
||||
VTKM_CONT
|
||||
@ -89,9 +89,9 @@ public:
|
||||
{
|
||||
return this->GetActiveFieldAssociation(1);
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// When set to true, uses a coordinate system as the secondary field instead of the one selected
|
||||
/// by name. Use SetSecondaryCoordinateSystem to select which coordinate system.
|
||||
VTKM_CONT
|
||||
@ -104,9 +104,9 @@ public:
|
||||
{
|
||||
return this->GetUseCoordinateSystemAsField(1);
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Select the coordinate system index to use as the secondary field. This only has an effect when
|
||||
/// UseCoordinateSystemAsSecondaryField is true.
|
||||
VTKM_CONT
|
||||
@ -116,7 +116,7 @@ public:
|
||||
{
|
||||
return this->GetActiveCoordinateSystemIndex(1);
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
private:
|
||||
VTKM_CONT vtkm::cont::DataSet DoExecute(const vtkm::cont::DataSet& input) override;
|
||||
|
@ -25,7 +25,7 @@ class VTKM_FILTER_VECTOR_ANALYSIS_EXPORT DotProduct : public vtkm::filter::NewFi
|
||||
public:
|
||||
VTKM_CONT DotProduct();
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Choose the primary field to operate on. In the dot product operation A . B, A is
|
||||
/// the primary field.
|
||||
VTKM_CONT
|
||||
@ -41,9 +41,9 @@ public:
|
||||
{
|
||||
return this->GetActiveFieldAssociation();
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// When set to true, uses a coordinate system as the primary field instead of the one selected
|
||||
/// by name. Use SetPrimaryCoordinateSystem to select which coordinate system.
|
||||
VTKM_CONT
|
||||
@ -56,9 +56,9 @@ public:
|
||||
{
|
||||
return this->GetUseCoordinateSystemAsField();
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Select the coordinate system coord_idx to use as the primary field. This only has an effect when
|
||||
/// UseCoordinateSystemAsPrimaryField is true.
|
||||
VTKM_CONT
|
||||
@ -71,9 +71,9 @@ public:
|
||||
{
|
||||
return this->GetActiveCoordinateSystemIndex();
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Choose the secondary field to operate on. In the dot product operation A . B, B is
|
||||
/// the secondary field.
|
||||
VTKM_CONT
|
||||
@ -89,9 +89,9 @@ public:
|
||||
{
|
||||
return this->GetActiveFieldAssociation(1);
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// When set to true, uses a coordinate system as the secondary field instead of the one selected
|
||||
/// by name. Use SetSecondaryCoordinateSystem to select which coordinate system.
|
||||
VTKM_CONT
|
||||
@ -104,9 +104,9 @@ public:
|
||||
{
|
||||
return this->GetUseCoordinateSystemAsField(1);
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Select the coordinate system index to use as the secondary field. This only has an effect when
|
||||
/// UseCoordinateSystemAsSecondaryField is true.
|
||||
VTKM_CONT
|
||||
@ -116,7 +116,7 @@ public:
|
||||
{
|
||||
return this->GetActiveCoordinateSystemIndex(1);
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
private:
|
||||
vtkm::cont::DataSet DoExecute(const vtkm::cont::DataSet& input) override;
|
||||
|
@ -442,7 +442,7 @@ private:
|
||||
}
|
||||
|
||||
public:
|
||||
//@{
|
||||
///@{
|
||||
/// Returns the value as the type at the given index. The behavior is undefined if the
|
||||
/// variant does not contain the value at the given index.
|
||||
///
|
||||
@ -459,9 +459,9 @@ public:
|
||||
VTKM_ASSERT(I == this->GetIndex());
|
||||
return detail::VariantUnionGet<I>(this->Storage);
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// Returns the value as the given type. The behavior is undefined if the variant does not
|
||||
/// contain a value of the given type.
|
||||
///
|
||||
@ -476,7 +476,7 @@ public:
|
||||
{
|
||||
return this->GetImpl<T>(CanStore<T>{});
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
private:
|
||||
template <typename T>
|
||||
@ -508,7 +508,7 @@ private:
|
||||
}
|
||||
|
||||
public:
|
||||
//@{
|
||||
///@{
|
||||
/// Given a functor object, calls the functor with the contained object cast to the appropriate
|
||||
/// type. If extra \c args are given, then those are also passed to the functor after the cast
|
||||
/// object. If the functor returns a value, that value is returned from \c CastAndCall.
|
||||
|
@ -32,7 +32,7 @@ class MaskIndices : public internal::MaskBase
|
||||
public:
|
||||
using ThreadToOutputMapType = vtkm::cont::ArrayHandle<vtkm::Id>;
|
||||
|
||||
//@{
|
||||
///@{
|
||||
/// \brief Construct using an index array.
|
||||
///
|
||||
/// When you construct a \c MaskSelect with the \c IndexArray tag, you provide an array
|
||||
@ -57,7 +57,7 @@ public:
|
||||
{
|
||||
vtkm::cont::Algorithm::Copy(device, indexArray, this->ThreadToOutputMap);
|
||||
}
|
||||
//@}
|
||||
///@}
|
||||
|
||||
// TODO? Create a version that accepts an UnknownArrayHandle. Is this needed?
|
||||
|
||||
|
@ -586,7 +586,7 @@ private:
|
||||
}
|
||||
|
||||
public:
|
||||
//@{
|
||||
///@{
|
||||
/// Setting the device ID will force the execute to happen on a particular device. If no device
|
||||
/// is specified (or the device ID is set to any), then a device will automatically be chosen
|
||||
/// based on the runtime device tracker.
|
||||
@ -595,7 +595,7 @@ public:
|
||||
void SetDevice(vtkm::cont::DeviceAdapterId device) { this->Device = device; }
|
||||
|
||||
VTKM_CONT vtkm::cont::DeviceAdapterId GetDevice() const { return this->Device; }
|
||||
//@}
|
||||
///@}
|
||||
|
||||
using ScatterType = typename WorkletType::ScatterType;
|
||||
using MaskType = typename WorkletType::MaskType;
|
||||
|
Loading…
Reference in New Issue
Block a user