#include <DataSetBuilderRectilinear.h>

Public Member Functions
	DataSetBuilderRectilinear ()

Static Public Member Functions
template<typename T >
static vtkm::cont::DataSet	Create (const std::vector< T > &xvals, const std::string &coordNm="coords")
	Create a 1D retilinear `DataSet`. More...

template<typename T >
static vtkm::cont::DataSet	Create (vtkm::Id nx, T *xvals, const std::string &coordNm="coords")
	Create a 1D retilinear `DataSet`. More...

template<typename T >
static vtkm::cont::DataSet	Create (const vtkm::cont::ArrayHandle< T > &xvals, const std::string &coordNm="coords")
	Create a 1D retilinear `DataSet`. More...

template<typename T >
static vtkm::cont::DataSet	Create (const std::vector< T > &xvals, const std::vector< T > &yvals, const std::string &coordNm="coords")
	Create a 2D retilinear `DataSet`. More...

template<typename T >
static vtkm::cont::DataSet	Create (vtkm::Id nx, vtkm::Id ny, T xvals, T yvals, const std::string &coordNm="coords")
	Create a 2D retilinear `DataSet`. More...

template<typename T >
static vtkm::cont::DataSet	Create (const vtkm::cont::ArrayHandle< T > &xvals, const vtkm::cont::ArrayHandle< T > &yvals, const std::string &coordNm="coords")
	Create a 2D retilinear `DataSet`. More...

template<typename T >
static vtkm::cont::DataSet	Create (vtkm::Id nx, vtkm::Id ny, vtkm::Id nz, T xvals, T yvals, T *zvals, const std::string &coordNm="coords")
	Create a 3D retilinear `DataSet`. More...

template<typename T >
static vtkm::cont::DataSet	Create (const std::vector< T > &xvals, const std::vector< T > &yvals, const std::vector< T > &zvals, const std::string &coordNm="coords")
	Create a 3D retilinear `DataSet`. More...

template<typename T >
static vtkm::cont::DataSet	Create (const vtkm::cont::ArrayHandle< T > &xvals, const vtkm::cont::ArrayHandle< T > &yvals, const vtkm::cont::ArrayHandle< T > &zvals, const std::string &coordNm="coords")
	Create a 3D retilinear `DataSet`. More...

Static Private Member Functions
template<typename T , typename U >
static void	CopyInto (const std::vector< T > &input, vtkm::cont::ArrayHandle< U > &output)

template<typename T , typename U >
static void	CopyInto (const vtkm::cont::ArrayHandle< T > &input, vtkm::cont::ArrayHandle< U > &output)

template<typename T , typename U >
static void	CopyInto (const T *input, vtkm::Id len, vtkm::cont::ArrayHandle< U > &output)

template<typename T >
static vtkm::cont::DataSet	BuildDataSet (const std::vector< T > &xvals, const std::vector< T > &yvals, const std::vector< T > &zvals, const std::string &coordNm)

template<typename T >
static vtkm::cont::DataSet	BuildDataSet (vtkm::Id nx, vtkm::Id ny, vtkm::Id nz, const T xvals, const T yvals, const T *zvals, const std::string &coordNm)

template<typename T >
static vtkm::cont::DataSet	BuildDataSet (const vtkm::cont::ArrayHandle< T > &X, const vtkm::cont::ArrayHandle< T > &Y, const vtkm::cont::ArrayHandle< T > &Z, const std::string &coordNm)

Constructor & Destructor Documentation

◆ DataSetBuilderRectilinear()

vtkm::cont::DataSetBuilderRectilinear::DataSetBuilderRectilinear ( )

Member Function Documentation

◆ BuildDataSet() [1/3]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderRectilinear::BuildDataSet	(	const std::vector< T > &	xvals,
		const std::vector< T > &	yvals,
		const std::vector< T > &	zvals,
		const std::string &	coordNm
	)

inlinestaticprivate

◆ BuildDataSet() [2/3]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderRectilinear::BuildDataSet	(	const vtkm::cont::ArrayHandle< T > &	X,
		const vtkm::cont::ArrayHandle< T > &	Y,
		const vtkm::cont::ArrayHandle< T > &	Z,
		const std::string &	coordNm
	)

inlinestaticprivate

◆ BuildDataSet() [3/3]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderRectilinear::BuildDataSet	(	vtkm::Id	nx,
		vtkm::Id	ny,
		vtkm::Id	nz,
		const T *	xvals,
		const T *	yvals,
		const T *	zvals,
		const std::string &	coordNm
	)

inlinestaticprivate

◆ CopyInto() [1/3]

template<typename T , typename U >

static void vtkm::cont::DataSetBuilderRectilinear::CopyInto	(	const std::vector< T > &	input,
		vtkm::cont::ArrayHandle< U > &	output
	)

inlinestaticprivate

◆ CopyInto() [2/3]

template<typename T , typename U >

static void vtkm::cont::DataSetBuilderRectilinear::CopyInto	(	const T *	input,
		vtkm::Id	len,
		vtkm::cont::ArrayHandle< U > &	output
	)

inlinestaticprivate

◆ CopyInto() [3/3]

template<typename T , typename U >

static void vtkm::cont::DataSetBuilderRectilinear::CopyInto	(	const vtkm::cont::ArrayHandle< T > &	input,
		vtkm::cont::ArrayHandle< U > &	output
	)

inlinestaticprivate

◆ Create() [1/9]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderRectilinear::Create	(	const std::vector< T > &	xvals,
		const std::string &	coordNm = `"coords"`
	)

inlinestatic

Create a 1D retilinear DataSet.

A rectilinear grid is specified with a scalar array for the point coordinates in the x direction. In this form, the coordinate array is specified with std::vector. The data is copied from the std::vector.

Parameters

[in]	xvals	An array of coordinates to use along the x dimension.
[in]	coordNm	(optional) The name to register the coordinates as.

◆ Create() [2/9]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderRectilinear::Create	(	const std::vector< T > &	xvals,
		const std::vector< T > &	yvals,
		const std::string &	coordNm = `"coords"`
	)

inlinestatic

Create a 2D retilinear DataSet.

A rectilinear grid is specified with separate arrays for the point coordinates in the x and y directions. In this form, the coordinate arrays are specified with std::vector. The data is copied from the std::vectors.

Parameters

[in]	xvals	An array of coordinates to use along the x dimension.
[in]	yvals	An array of coordinates to use along the x dimension.
[in]	coordNm	(optional) The name to register the coordinates as.

◆ Create() [3/9]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderRectilinear::Create	(	const std::vector< T > &	xvals,
		const std::vector< T > &	yvals,
		const std::vector< T > &	zvals,
		const std::string &	coordNm = `"coords"`
	)

inlinestatic

Create a 3D retilinear DataSet.

A rectilinear grid is specified with separate arrays for the point coordinates in the x, y, and z directions. In this form, the coordinate arrays are specified with std::vector. The data is copied from the std::vectors.

Parameters

[in]	xvals	An array of coordinates to use along the x dimension.
[in]	yvals	An array of coordinates to use along the x dimension.
[in]	zvals	An array of coordinates to use along the x dimension.
[in]	coordNm	(optional) The name to register the coordinates as.

◆ Create() [4/9]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderRectilinear::Create	(	const vtkm::cont::ArrayHandle< T > &	xvals,
		const std::string &	coordNm = `"coords"`
	)

inlinestatic

Create a 1D retilinear DataSet.

A rectilinear grid is specified with a scalar array for the point coordinates in the x direction. In this form, the coordinate array is specified with vtkm::cont::ArrayHandle. The ArrayHandle is shared with the DataSet, so changing the ArrayHandle changes the DataSet.

Parameters

[in]	xvals	An array of coordinates to use along the x dimension.
[in]	coordNm	(optional) The name to register the coordinates as.

◆ Create() [5/9]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderRectilinear::Create	(	const vtkm::cont::ArrayHandle< T > &	xvals,
		const vtkm::cont::ArrayHandle< T > &	yvals,
		const std::string &	coordNm = `"coords"`
	)

inlinestatic

Create a 2D retilinear DataSet.

A rectilinear grid is specified with separate arrays for the point coordinates in the x and y directions. In this form, the coordinate arrays are specified with vtkm::cont::ArrayHandle. The ArrayHandles are shared with the DataSet, so changing the ArrayHandles changes the DataSet.

Parameters

[in]	xvals	An array of coordinates to use along the x dimension.
[in]	yvals	An array of coordinates to use along the x dimension.
[in]	coordNm	(optional) The name to register the coordinates as.

◆ Create() [6/9]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderRectilinear::Create	(	const vtkm::cont::ArrayHandle< T > &	xvals,
		const vtkm::cont::ArrayHandle< T > &	yvals,
		const vtkm::cont::ArrayHandle< T > &	zvals,
		const std::string &	coordNm = `"coords"`
	)

inlinestatic

Create a 3D retilinear DataSet.

A rectilinear grid is specified with separate arrays for the point coordinates in the x, y, and z directions. In this form, the coordinate arrays are specified with vtkm::cont::ArrayHandle. The ArrayHandles are shared with the DataSet, so changing the ArrayHandles changes the DataSet.

Parameters

[in]	xvals	An array of coordinates to use along the x dimension.
[in]	yvals	An array of coordinates to use along the x dimension.
[in]	zvals	An array of coordinates to use along the x dimension.
[in]	coordNm	(optional) The name to register the coordinates as.

◆ Create() [7/9]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderRectilinear::Create	(	vtkm::Id	nx,
		T *	xvals,
		const std::string &	coordNm = `"coords"`
	)

inlinestatic

Create a 1D retilinear DataSet.

A rectilinear grid is specified with a scalar array for the point coordinates in the x direction. In this form, the coordinate array is specified with a standard C array. The data is copied from the array.

Parameters

[in]	nx	The size of the grid in the x direction (and length of the xvals array).
[in]	xvals	An array of coordinates to use along the x dimension.
[in]	coordNm	(optional) The name to register the coordinates as.

◆ Create() [8/9]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderRectilinear::Create	(	vtkm::Id	nx,
		vtkm::Id	ny,
		T *	xvals,
		T *	yvals,
		const std::string &	coordNm = `"coords"`
	)

inlinestatic

Create a 2D retilinear DataSet.

A rectilinear grid is specified with separate arrays for the point coordinates in the x and y directions. In this form, the coordinate arrays are specified with standard C arrays. The data is copied from the arrays.

Parameters

[in]	nx	The size of the grid in the x direction (and length of the xvals array).
[in]	ny	The size of the grid in the x direction (and length of the yvals array).
[in]	xvals	An array of coordinates to use along the x dimension.
[in]	yvals	An array of coordinates to use along the x dimension.
[in]	coordNm	(optional) The name to register the coordinates as.

◆ Create() [9/9]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderRectilinear::Create	(	vtkm::Id	nx,
		vtkm::Id	ny,
		vtkm::Id	nz,
		T *	xvals,
		T *	yvals,
		T *	zvals,
		const std::string &	coordNm = `"coords"`
	)

inlinestatic

Create a 3D retilinear DataSet.

A rectilinear grid is specified with separate arrays for the point coordinates in the x, y, and z directions. In this form, the coordinate arrays are specified with standard C arrays. The data is copied from the arrays.

Parameters

[in]	nx	The size of the grid in the x direction (and length of the xvals array).
[in]	ny	The size of the grid in the x direction (and length of the yvals array).
[in]	nz	The size of the grid in the x direction (and length of the zvals array).
[in]	xvals	An array of coordinates to use along the x dimension.
[in]	yvals	An array of coordinates to use along the x dimension.
[in]	zvals	An array of coordinates to use along the x dimension.
[in]	coordNm	(optional) The name to register the coordinates as.

The documentation for this class was generated from the following file:

DataSetBuilderRectilinear.h

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Constructor & Destructor Documentation

◆ DataSetBuilderRectilinear()

Member Function Documentation

◆ BuildDataSet() [1/3]

◆ BuildDataSet() [2/3]

◆ BuildDataSet() [3/3]

◆ CopyInto() [1/3]

◆ CopyInto() [2/3]

◆ CopyInto() [3/3]

◆ Create() [1/9]

◆ Create() [2/9]

◆ Create() [3/9]

◆ Create() [4/9]

◆ Create() [5/9]

◆ Create() [6/9]

◆ Create() [7/9]

◆ Create() [8/9]

◆ Create() [9/9]