#include "DataC.h"
#include "Data.h"
#include "DataTypes.h"

Functions
int	getFunctionSpaceType (struct escriptDataC *data)
	Return the function space type code.
int	isDataPointShapeEqual (struct escriptDataC data, int rank, const int dimensions)
	Return true if the input shape matches the data point shape for data.
int	getNumDataPointsPerSample (struct escriptDataC *data)
	Returns the number of data points per sample.
int	numSamplesEqual (struct escriptDataC *data, int numDataPointsPerSample, int numSamples)
	Return true if the number of data points per sample and the number of samples equal the input values. In the case that data is empty or NULL, true is returned.
int	getDataPointRank (struct escriptDataC *data)
	Returns the rank of the point data for the data.
int	getDataPointShape (struct escriptDataC *data, int i)
	Returns the value of the i-th component of the shape of the point data.
int	getDataPointSize (struct escriptDataC *data)
	Return the number of doubles needed for each data point.
int	getLength (struct escriptDataC *data)
int	isExpanded (struct escriptDataC *data)
	Return true if data can be treated as expanded.
int	isEmpty (escriptDataC *data)
	Returns the true if the data are empty or data is NULL.
double const *	getSampleDataRO (struct escriptDataC *data, int sampleNo)
	Return a pointer to the data for the given sample number. if data is empty NULL is returned. data may be NULL, in which case NULL is returnd.
double *	getSampleDataRW (struct escriptDataC *data, int sampleNo)
const double *	getSampleDataROFast (struct escriptDataC *data, int sampleNo)
	Return a pointer to the data for the given sample number. Fast version of getSampledataRO: does no error checking.
double *	getSampleDataRWFast (struct escriptDataC *data, int sampleNo)
	Return a pointer to the data for the given sample number. Fast version of getSampledataRW: does no error checking.
double *	getDataRW (escriptDataC *data)
	Return getSampleDataRWFast(escriptDataC* data, 0) if there are samples. if not, returns NULL.
void	requireWrite (escriptDataC *data)
	Ensure that this object is ready for writing. It will be resolved and copied if it is currently shared. Use only in single threaded sections of code. Do not create new Data objects based on this one between this call and writing to the object.

Function Documentation

int getDataPointRank ( escriptDataC * data )

Returns the rank of the point data for the data.

Parameters:

data	Input - C wrapper for Data.

References escript::Data::getDataPointRank(), and escriptDataC::m_dataPtr.

Referenced by escript::saveDataCSV().

int getDataPointShape	(	escriptDataC *	data,
		int	i
	)

Returns the value of the i-th component of the shape of the point data.

Parameters:

data	Input - C wrapper for Data.
i	Input - index of shape component.

References escript::Data::getDataPointRank(), escript::Data::getDataPointShape(), and escriptDataC::m_dataPtr.

Referenced by escript::saveDataCSV().

int getDataPointSize ( escriptDataC * data )

Return the number of doubles needed for each data point.

Parameters:

data	Input - C wrapper for Data.

References escript::Data::getDataPointSize(), and escriptDataC::m_dataPtr.

Referenced by Dudley_Assemble_AverageElementData(), Dudley_Assemble_CopyElementData(), Dudley_Assemble_CopyNodalData(), Dudley_Assemble_getAssembleParameters(), Dudley_Assemble_gradient(), Dudley_Assemble_integrate(), Dudley_Assemble_interpolate(), Dudley_ElementFile_setTags(), Dudley_NodeFile_setCoordinates(), and Dudley_NodeFile_setTags().

double* getDataRW ( escriptDataC * data )

Return getSampleDataRWFast(escriptDataC* data, 0) if there are samples. if not, returns NULL.

Warning:: This function calls requireWrite if there are samples so do not use in parallel sections.; Please do not use this in new code.

Parameters:

data	Input - C wrapper for Data.

References escript::Data::getNumSamples(), getSampleDataRWFast(), escriptDataC::m_dataPtr, and requireWrite().

Referenced by Dudley_Assemble_CopyNodalData().

int getFunctionSpaceType ( escriptDataC * data )

Return the function space type code.

Parameters:

data	Input - C wrapper for Data.

References escript::Data::getFunctionSpace(), escript::FunctionSpace::getTypeCode(), and escriptDataC::m_dataPtr.

Referenced by Dudley_Assemble_CopyNodalData(), Dudley_Assemble_gradient(), Dudley_Assemble_interpolate(), Dudley_Assemble_LumpedSystem(), and Dudley_Assemble_NodeCoordinates().

int getLength ( struct escriptDataC * data )

References escript::Data::getLength(), and escriptDataC::m_dataPtr.

int getNumDataPointsPerSample ( escriptDataC * data )

Returns the number of data points per sample.

Parameters:

data	Input - C wrapper for Data.

References escript::Data::getNumDataPointsPerSample(), escript::Data::isEmpty(), and escriptDataC::m_dataPtr.

Referenced by escript::Data::lazyAlgWorker().

double const* getSampleDataRO	(	escriptDataC *	data,
		int	sampleNo
	)

Return a pointer to the data for the given sample number. if data is empty NULL is returned. data may be NULL, in which case NULL is returnd.

Parameters:

data	Input - C wrapper for Data.
sampleNo	Input - The sample number.

References escript::Data::getSampleDataRO(), escript::Data::isEmpty(), and escriptDataC::m_dataPtr.

Referenced by Dudley_Assemble_AverageElementData(), Dudley_Assemble_CopyElementData(), Dudley_Assemble_gradient(), Dudley_Assemble_integrate(), Dudley_Assemble_interpolate(), Dudley_Assemble_LumpedSystem(), Dudley_Assemble_PDE_Points(), Dudley_Assemble_PDE_Single2_1D(), Dudley_Assemble_PDE_Single2_2D(), Dudley_Assemble_PDE_Single2_3D(), Dudley_Assemble_PDE_System2_1D(), Dudley_Assemble_PDE_System2_2D(), Dudley_Assemble_PDE_System2_3D(), Dudley_ElementFile_setTags(), and Dudley_NodeFile_setTags().

const double* getSampleDataROFast	(	escriptDataC *	data,
		int	sampleNo
	)

Return a pointer to the data for the given sample number. Fast version of getSampledataRO: does no error checking.

Parameters:

data	Input - C wrapper for Data.
sampleNo	Input - The sample number.

References escript::Data::getSampleDataRO(), and escriptDataC::m_dataPtr.

Referenced by Dudley_Assemble_CopyNodalData(), and Dudley_NodeFile_setCoordinates().

double* getSampleDataRW	(	struct escriptDataC *	data,
		int	sampleNo
	)

References escript::Data::getSampleDataRW(), escript::Data::isEmpty(), and escriptDataC::m_dataPtr.

Referenced by Dudley_Assemble_AverageElementData(), Dudley_Assemble_CopyElementData(), Dudley_Assemble_getSize(), Dudley_Assemble_gradient(), Dudley_Assemble_interpolate(), Dudley_Assemble_LumpedSystem(), Dudley_Assemble_PDE_Points(), Dudley_Assemble_PDE_Single2_1D(), Dudley_Assemble_PDE_Single2_2D(), Dudley_Assemble_PDE_Single2_3D(), Dudley_Assemble_PDE_System2_1D(), Dudley_Assemble_PDE_System2_2D(), Dudley_Assemble_PDE_System2_3D(), and Dudley_Assemble_setNormal().

double* getSampleDataRWFast	(	escriptDataC *	data,
		int	sampleNo
	)

Return a pointer to the data for the given sample number. Fast version of getSampledataRW: does no error checking.

Parameters:

data	Input - C wrapper for Data.
sampleNo	Input - The sample number.

References escript::Data::getSampleDataRW(), and escriptDataC::m_dataPtr.

Referenced by Dudley_Assemble_CopyNodalData(), Dudley_Assemble_NodeCoordinates(), and getDataRW().

int isDataPointShapeEqual	(	escriptDataC *	data,
		int	rank,
		const int *	dimensions
	)

Return true if the input shape matches the data point shape for data.

Parameters:

data	Input - C wrapper for Data.
rank	Input - number of dimensions.
dimensions	Input -

References escript::Data::isDataPointShapeEqual(), and escriptDataC::m_dataPtr.

Referenced by ripley::Brick::assembleCoordinates(), ripley::Rectangle::assembleCoordinates(), Dudley_Assemble_getSize(), Dudley_Assemble_LumpedSystem(), Dudley_Assemble_NodeCoordinates(), Dudley_Assemble_PDE(), and Dudley_Assemble_setNormal().

int isEmpty ( escriptDataC * data )

Returns the true if the data are empty or data is NULL.

Parameters:

data	Input - C wrapper for Data.

References escript::Data::isEmpty(), and escriptDataC::m_dataPtr.

Referenced by ripley::WaveAssembler2D::assemblePDESystem(), ripley::WaveAssembler3D::assemblePDESystem(), ripley::LameAssembler2D::assemblePDESystem(), ripley::LameAssembler3D::assemblePDESystem(), Dudley_Assemble_getAssembleParameters(), Dudley_Assemble_LumpedSystem(), and Dudley_Assemble_PDE().

int isExpanded ( escriptDataC * data )

Return true if data can be treated as expanded.

Argument data may be NULL, in which case false is returnd.

Parameters:

data	Input - C wrapper for Data.

Returns:: true if data is expanded or the data is lazy but would resolve to expanded. False otherwise.

References escript::Data::actsExpanded(), escript::Data::isEmpty(), and escriptDataC::m_dataPtr.

Referenced by Dudley_Assemble_AverageElementData(), Dudley_Assemble_CopyElementData(), Dudley_Assemble_CopyNodalData(), Dudley_Assemble_getAssembleParameters(), Dudley_Assemble_getSize(), Dudley_Assemble_gradient(), Dudley_Assemble_integrate(), Dudley_Assemble_interpolate(), Dudley_Assemble_LumpedSystem(), Dudley_Assemble_NodeCoordinates(), Dudley_Assemble_PDE_Single2_1D(), Dudley_Assemble_PDE_Single2_2D(), Dudley_Assemble_PDE_Single2_3D(), Dudley_Assemble_PDE_System2_1D(), Dudley_Assemble_PDE_System2_2D(), Dudley_Assemble_PDE_System2_3D(), Dudley_Assemble_setNormal(), and Dudley_ElementFile_setTags().

int numSamplesEqual	(	escriptDataC *	data,
		int	numDataPointsPerSample,
		int	numSamples
	)

Return true if the number of data points per sample and the number of samples equal the input values. In the case that data is empty or NULL, true is returned.

Parameters:

data	Input - C wrapper for Data.
numDataPointsPerSample	Input - number of data points per sample
numSamples	Input - number of samples

References escriptDataC::m_dataPtr, and escript::Data::numSamplesEqual().

Referenced by ripley::Brick::assembleCoordinates(), ripley::Rectangle::assembleCoordinates(), Dudley_Assemble_AverageElementData(), Dudley_Assemble_CopyElementData(), Dudley_Assemble_CopyNodalData(), Dudley_Assemble_getAssembleParameters(), Dudley_Assemble_getSize(), Dudley_Assemble_gradient(), Dudley_Assemble_integrate(), Dudley_Assemble_interpolate(), Dudley_Assemble_LumpedSystem(), Dudley_Assemble_NodeCoordinates(), Dudley_Assemble_PDE(), Dudley_Assemble_setNormal(), Dudley_ElementFile_setTags(), Dudley_NodeFile_setCoordinates(), and Dudley_NodeFile_setTags().

void requireWrite ( escriptDataC * data )

Ensure that this object is ready for writing. It will be resolved and copied if it is currently shared. Use only in single threaded sections of code. Do not create new Data objects based on this one between this call and writing to the object.

References escriptDataC::m_dataPtr, and requireWrite().

Referenced by Dudley_Assemble_AverageElementData(), Dudley_Assemble_CopyElementData(), Dudley_Assemble_CopyNodalData(), Dudley_Assemble_getSize(), Dudley_Assemble_gradient(), Dudley_Assemble_interpolate(), Dudley_Assemble_LumpedSystem(), Dudley_Assemble_NodeCoordinates(), Dudley_Assemble_PDE_Points(), Dudley_Assemble_PDE_Single2_1D(), Dudley_Assemble_PDE_Single2_2D(), Dudley_Assemble_PDE_Single2_3D(), Dudley_Assemble_PDE_System2_1D(), Dudley_Assemble_PDE_System2_2D(), Dudley_Assemble_PDE_System2_3D(), Dudley_Assemble_setNormal(), getDataRW(), and requireWrite().

Functions

Function Documentation