WmUnstructuredPatchArray< T > Class Template Reference

#include <wmunstructuredpatcharray.h>

Inheritance diagram for WmUnstructuredPatchArray< T >:

Public Member Functions
	WmUnstructuredPatchArray (const WmUnstructuredPatch &patch, int numSubComponents, const std::string &basisArraySetName="")
	Constructor for WmUnstructuredGlobalArray.
	~WmUnstructuredPatchArray ()
void	fill (const WxAny &fillValue)
	Fill all of the patch array with a specified fill value.
void	dump (WxIoBase &io, WxIoNodeType &grpNode, bool writeGhostCellsToo=false) const
	Write out the array to file.
void	load (WxIoBase &io, const WxIoNodeType &grpNode, bool includeGhosts=false)
	Load object from file.
T	min () const
	Returns the minimum value in patch array.
T	max () const
	Returns the maximum value in patch array.
T	absoluteMin () const
	Returns the absolute minimum value in patch array Absolute min is the closest value to zero Value will be negative if any negative values were found.
const WmTypeOpaqueArray< _WX_ROW_MAJOR_ORDER > *	getArray () const
	Get a pointer to the patch array.
WmTypeOpaqueArray< _WX_ROW_MAJOR_ORDER > *	getArray ()
	Get a pointer to the patch array.
int	getNumSubComponents () const
	The number of subcomponents per element.
const WmUnstructuredPatch &	getPatch () const
	Get the patch this array is setup for.
void	print () const
	Print patch.
int	getNumSubcomponents () const
	Get the number of subcomponents.
Public Member Functions inherited from WmTypedArray< _WX_ROW_MAJOR_ORDER, T >
	WmTypedArray (const WxRange &range, T *data)
	Array spanning given range object.
	WmTypedArray (const WxRange &range)
	Array spanning given range object.
	WmTypedArray (const WmTypedArray< MAJOR_ORDER_TYPE, T > &that)
	Copy constructor does not allocate new memory.
	WmTypedArray (const WmTypeOpaqueArray< MAJOR_ORDER_TYPE > &that)
	Special copy constructor does not allocate new memory.
WmTypedArray< MAJOR_ORDER_TYPE, T > &	operator= (const WmTypedArray< MAJOR_ORDER_TYPE, T > &that)
	~WmTypedArray ()
	Delete instance which may or may not involve freeing array element allocation.
T	operator() (int k0) const
	Rank-1 indexer.
T &	operator() (int k0)
T	operator() (int k0, int k1) const
	Rank-2 indexer.
T &	operator() (int k0, int k1)
T	operator() (int k0, int k1, int k2) const
	Rank-3 indexer.
T &	operator() (int k0, int k1, int k2)
T	operator() (int k0, int k1, int k2, int k3) const
	Rank-4 indexer.
T &	operator() (int k0, int k1, int k2, int k3)
T *	data ()
	Access raw array data.
const T *	data () const
	Access raw array data.
T *	dataSlab (const int *indices, int indicesRank)
	Access higher dimension slab of raw array element.
const T *	dataSlab (const int *indices, int indicesRank) const
	Access higher dimension slab of raw array element.
Public Member Functions inherited from WmTypeOpaqueArray< MAJOR_ORDER_TYPE >
	WmTypeOpaqueArray (const WxRange &range, void *data, int numBytesPerElement)
	Array spanning given range object.
	WmTypeOpaqueArray (const WmTypeOpaqueArray< MAJOR_ORDER_TYPE > &that)
	Copy constructor does not allocate new memory.
WmTypeOpaqueArray< MAJOR_ORDER_TYPE > &	operator= (const WmTypeOpaqueArray< MAJOR_ORDER_TYPE > &that)
void *	data ()
	Access start of raw array data.
const void *	data () const
	Access start of raw array data.
void *	data (const int *indices)
	Access raw array element.
const void *	data (const int *indices) const
	Access raw array element.
void *	dataSlab (const int *indices, int indicesRank)
	Access higher dimension slab of raw array element.
const void *	dataSlab (const int *indices, int indicesRank) const
	Access higher dimension slab of raw array element.
int	numBytesPerElement () const
void	put (const WxRange &selection, const WxRange &inputShape, const void *bufin)
	Copy data elements from bufin to the region described by the range selection.
void	get (const WxRange &selection, const WxRange &outputShape, void *bufout) const
	Copy data elements from the region described range selection to the bufout provided.
virtual	~WmTypeOpaqueArray ()
	Delete object which only describes the array geometry, no array allocation is deleted.
Public Member Functions inherited from WmArrayBase< MAJOR_ORDER_TYPE >
const WxRange &	range () const

Protected Attributes
const WmUnstructuredPatch &	_patch
int	_numSubComponents
int	_numImportDatapoints
int	_numExportDatapoints
int	_numInternalDatapoints
WxRange	_globalRange
WxRange	_localRange
WxRange	_interiorDataRange
Protected Attributes inherited from WmArrayBase< MAJOR_ORDER_TYPE >
WmIndexer< MAJOR_ORDER_TYPE >	_indexer
	Indexer assists finding linear position of array elements.
WxRange	_range
	Range covered by this array.

Additional Inherited Members
Protected Member Functions inherited from WmTypedArray< _WX_ROW_MAJOR_ORDER, T >
	WmTypedArray ()
	Default ctor does not set up array geometry initially, this must be done later, so it is only exposed to derived classes.
void	resetArrayProperties (const WxRange &range, T *newdata)
	Copy data elements from bufin to the region described by the range selection.
Protected Member Functions inherited from WmTypeOpaqueArray< MAJOR_ORDER_TYPE >
	WmTypeOpaqueArray ()
	Default ctor does not set up array geometry initially, this must be done later, so it is only exposed to derived classes.
void	resetArrayProperties (const WxRange &range, void *data, int numBytesPerElement)
	Reset the properties of this array.
Protected Member Functions inherited from WmArrayBase< MAJOR_ORDER_TYPE >
	WmArrayBase ()
	Default ctor does not set up array geometry initially, this must be done later.
	WmArrayBase (const WxRange &range)
	Array spanning given range object.
	WmArrayBase (const WmArrayBase< MAJOR_ORDER_TYPE > &that)
	Copy constructor duplicates the array geometry properties of original one.
WmArrayBase< MAJOR_ORDER_TYPE > &	operator= (const WmArrayBase< MAJOR_ORDER_TYPE > &that)
	Assignment operator duplicates the array geometry properties of right hand side one.
	~WmArrayBase ()
	Delete object which only describes the array geometry, no array allocation is deleted.
void	setRange (const WxRange &range)
	Array spanning given range object.
unsigned	rank () const
	Rank of array.
Static Protected Attributes inherited from WmArrayBase< MAJOR_ORDER_TYPE >
static const int	max_dims = 8

Constructor & Destructor Documentation

WmUnstructuredPatchArray()

template<typename T >

WmUnstructuredPatchArray< T >::WmUnstructuredPatchArray	(	const WmUnstructuredPatch &	patch,
		int	numSubComponents,
		const std::string &	basisArraySetName = ""
	)

Constructor for WmUnstructuredGlobalArray.

~WmUnstructuredPatchArray()

template<typename T >

WmUnstructuredPatchArray< T >::~WmUnstructuredPatchArray

(

)

Member Function Documentation

absoluteMin()

template<typename T >

T WmUnstructuredPatchArray< T >::absoluteMin

(

)

const

Returns the absolute minimum value in patch array Absolute min is the closest value to zero Value will be negative if any negative values were found.

Returns

Absolute minimum value of component with array

dump()

template<typename T >

void WmUnstructuredPatchArray< T >::dump	(	WxIoBase &	io,
		WxIoNodeType &	grpNode,
		bool	writeGhostCellsToo = false
	)		const

Write out the array to file.

Parameters

io	I/O object to use for writing
grpNode	group node to write to
writeGhostCellsToo	write external elements

fill()

template<typename T >

void WmUnstructuredPatchArray< T >::fill

(

const WxAny &

fillValue

)

Fill all of the patch array with a specified fill value.

Parameters

fillValue

to be applied to set in all elements in the local ext box.

getArray() [1/2]

template<typename T >

WmTypeOpaqueArray< _WX_ROW_MAJOR_ORDER > * WmUnstructuredPatchArray< T >::getArray ( )

inline

Get a pointer to the patch array.

Returns

an array object representing the patch array storage, element type is obscured.

getArray() [2/2]

template<typename T >

const WmTypeOpaqueArray< _WX_ROW_MAJOR_ORDER > * WmUnstructuredPatchArray< T >::getArray ( ) const

inline

Get a pointer to the patch array.

Returns

an array object representing the patch array storage, element type is obscured.

getNumSubComponents()

template<typename T >

int WmUnstructuredPatchArray< T >::getNumSubComponents ( ) const

inline

The number of subcomponents per element.

Returns

Number of subcomponents making up element array

getNumSubcomponents()

template<typename T >

int WmUnstructuredPatchArray< T >::getNumSubcomponents ( ) const

inline

Get the number of subcomponents.

Returns

Number of subcomponents in element arrays

getPatch()

template<typename T >

const WmUnstructuredPatch & WmUnstructuredPatchArray< T >::getPatch ( ) const

inline

Get the patch this array is setup for.

Returns

Patch

load()

template<typename T >

void WmUnstructuredPatchArray< T >::load	(	WxIoBase &	io,
		const WxIoNodeType &	grpNode,
		bool	includeGhosts = false
	)

Load object from file.

This method is passed a group node from which its data should be read and then constructed.

Parameters

io	I/O object to use for writing
grpNode	group node to read from
includeGhosts	read external elements

max()

template<typename T >

T WmUnstructuredPatchArray< T >::max

(

)

const

Returns the maximum value in patch array.

Returns

Maximum value of component with array

min()

template<typename T >

T WmUnstructuredPatchArray< T >::min

(

)

const

Returns the minimum value in patch array.

Non-blocking call

Returns

Minimum value of component with array

print()

template<typename T >

void WmUnstructuredPatchArray< T >::print

(

)

const

Print patch.

Member Data Documentation

_globalRange

template<typename T >

WxRange WmUnstructuredPatchArray< T >::_globalRange

protected

_interiorDataRange

template<typename T >

WxRange WmUnstructuredPatchArray< T >::_interiorDataRange

protected

_localRange

template<typename T >

WxRange WmUnstructuredPatchArray< T >::_localRange

protected

_numExportDatapoints

template<typename T >

int WmUnstructuredPatchArray< T >::_numExportDatapoints

protected

_numImportDatapoints

template<typename T >

int WmUnstructuredPatchArray< T >::_numImportDatapoints

protected

_numInternalDatapoints

template<typename T >

int WmUnstructuredPatchArray< T >::_numInternalDatapoints

protected

_numSubComponents

template<typename T >

int WmUnstructuredPatchArray< T >::_numSubComponents

protected

_patch

template<typename T >

const WmUnstructuredPatch& WmUnstructuredPatchArray< T >::_patch

protected

---

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

• src/variables/wmunstructuredpatcharray.h