Implements the DataAbstract interface for an empty Data object. More...

#include <DataEmpty.h>

Inheritance diagram for escript::DataEmpty:

Public Member Functions
	DataEmpty ()
	Default constructor for DataEmpty. More...

virtual	~DataEmpty ()
	Destructor for DataEmpty. More...

virtual std::string	toString () const
	Return a textual representation of the Data object. More...

virtual DataAbstract *	deepCopy ()
	Return a deep copy of the current object. More...

virtual DataTypes::ValueType::size_type	getPointOffset (int sampleNo, int dataPointNo) const
	Return the offset for the given sample. NB: This will throw an exception as obviously an empty Data object contains no samples. An implementation is required by parent DataAbstract class. More...

virtual DataTypes::ValueType::size_type	getPointOffset (int sampleNo, int dataPointNo)

virtual ValueType::size_type	getLength () const
	Return the number of doubles stored for the Data object. As this is an empty Data object, this method will always return 0. More...

virtual DataAbstract *	getSlice (const DataTypes::RegionType &region) const
	Factory method that returns a newly created DataEmpty sliced from the current Data object according to the specified region. NB: This will throw an exception as obviously an empty Data object contains no data to slice from. An implementation is required by parent DataAbstract class. More...

virtual void	setSlice (const DataAbstract *value, const DataTypes::RegionType &region)
	Set the current Data object according to the specified slice from the given input value. NB: This will throw an exception as obviously an empty Data object contains no data to slice to. An implementation is required by parent DataAbstract class. More...

int	matrixInverse (DataAbstract *out) const
	invert square matricies More...

void	dump (const std::string fileName) const
	dumps the object into a netCDF file More...

bool	hasNaN () const
	return true if data contains NaN. More...

void	replaceNaN (double value)
	replaces all NaN values with value More...

Public Member Functions inherited from escript::DataReady
	DataReady (const FunctionSpace &what, const ShapeType &shape, bool isDataEmpty=false)

	~DataReady ()

double *	getSampleDataRW (ValueType::size_type sampleNo)
	Return the sample data for the given sample number. More...

const double *	getSampleDataRO (ValueType::size_type sampleNo) const

DataTypes::ValueType::const_reference	getDataAtOffsetRO (DataTypes::ValueType::size_type i) const
	get a reference to the beginning of a data point More...

DataTypes::ValueType::reference	getDataAtOffsetRW (DataTypes::ValueType::size_type i)

DataReady_ptr	resolve ()
	Return a data object with all points resolved. More...

Public Member Functions inherited from escript::DataAbstract
DataAbstract_ptr	getPtr ()
	Return shared pointer managing this object. More...

const_DataAbstract_ptr	getPtr () const

	DataAbstract (const FunctionSpace &what, const ShapeType &shape, bool isDataEmpty=false)
	Constructor for DataAbstract. More...

virtual	~DataAbstract ()
	Destructor for DataAbstract. More...

int	getNumDPPSample () const
	Return the number of data points per sample. More...

int	getNumSamples () const
	Return the number of samples. More...

const DataTypes::ShapeType &	getShape () const
	Return the shape information for the point data. More...

unsigned int	getRank () const
	Return the rank information for the point data. More...

virtual double *	getSampleDataByTag (int tag)
	Return the sample data for the given tag key. NB: If the data isn't tagged an exception will be thrown. More...

virtual size_t	getTagCount () const
	Return number of tagged values stored in the data object. More...

void	operandCheck (const DataAbstract &right) const
	Check this and the given RHS operands are compatible. Throws an exception if they aren't. More...

bool	validSamplePointNo (int samplePointNo) const
	Return true if a valid sample point number. More...

bool	validSampleNo (int sampleNo) const
	Return true if a valid sample number. More...

const FunctionSpace &	getFunctionSpace () const
	Return the function space associated with this Data object. More...

virtual void	setTaggedValue (int tagKey, const DataTypes::ShapeType &pointshape, const DataTypes::ValueType &value, int dataOffset=0)
	setTaggedValue More...

virtual void	copyToDataPoint (const int sampleNo, const int dataPointNo, const double value)
	Copy a double value to the data point dataPointNo of sample sampleNo in this object. More...

virtual void	copyToDataPoint (const int sampleNo, const int dataPointNo, const WrappedArray &value)
	Copy the array object to the data point dataPointNo of sample sampleNo in this object. More...

virtual int	getTagNumber (int dpno)
	Return the tag number associated with the given data-point number. More...

virtual void	symmetric (DataAbstract *ev)
	Computes a symmetric matrix (A + AT) / 2. More...

virtual void	nonsymmetric (DataAbstract *ev)
	Computes a nonsymmetric matrix (A - AT) / 2. More...

virtual void	trace (DataAbstract *ev, int axis_offset)
	Computes the trace of a matrix. More...

virtual void	transpose (DataAbstract *ev, int axis_offset)
	Transpose each data point of this Data object around the given axis. More...

virtual void	swapaxes (DataAbstract *ev, int axis0, int axis1)
	swaps components axis0 and axis1 More...

virtual void	eigenvalues (DataAbstract *ev)
	solves the eigenvalue problem thisV=evV for the eigenvalues ev More...

virtual void	setToZero ()
	sets values to zero More...

virtual void	eigenvalues_and_eigenvectors (DataAbstract ev, DataAbstract V, const double tol=1.e-13)
	solves the eigenvalue problem thisV=evV for the eigenvalues ev and eigenvectors V More...

virtual void	reorderByReferenceIDs (dim_t *reference_ids)
	reorders data sample ordered by reference_ids to the ordering of the functions space More...

unsigned int	getNoValues () const
	Return the number of values in the shape for this object. More...

bool	isLazy () const

virtual bool	isConstant () const

virtual bool	isExpanded () const

virtual bool	actsExpanded () const
	Return true if this Data is expanded or resolves to expanded. That is, if it has a separate value for each datapoint in the sample. More...

virtual bool	isTagged () const

bool	isEmpty () const

void	addOwner (Data *)

void	removeOwner (Data *)

bool	isShared () const
	Is this object owned by more than one Data object. More...

Protected Member Functions
virtual DataTypes::ValueType &	getVectorRW ()
	Provide access to underlying storage. Internal use only! More...

virtual const DataTypes::ValueType &	getVectorRO () const

Protected Member Functions inherited from escript::DataAbstract
bool	checkNoSharing () const
	Returns true if this object is not shared. For internal use only. - It may not be particularly fast. More...

void	makeLazyShared ()
	Marks this DataAbstract shared as LazyData For internal use only. More...

Private Types
typedef DataReady	parent

Additional Inherited Members
Public Types inherited from escript::DataAbstract
typedef DataTypes::ValueType	ValueType

typedef DataTypes::ShapeType	ShapeType

Protected Attributes inherited from escript::DataAbstract
std::vector< Data * >	m_owners

bool	m_lazyshared

Detailed Description

Implements the DataAbstract interface for an empty Data object.

Description: Implements the DataAbstract interface for an empty Data object.

Member Typedef Documentation

typedef DataReady escript::DataEmpty::parent

private

Constructor & Destructor Documentation

escript::DataEmpty::DataEmpty ( )

Default constructor for DataEmpty.

Description: Default constructor for DataEmpty.

Referenced by deepCopy().

escript::DataEmpty::~DataEmpty ( )

virtual

Destructor for DataEmpty.

Member Function Documentation

DataAbstract * escript::DataEmpty::deepCopy ( )

virtual

Return a deep copy of the current object.

Implements escript::DataAbstract.

References DataEmpty().

void escript::DataEmpty::dump ( const std::string fileName ) const

virtual

dumps the object into a netCDF file

Reimplemented from escript::DataAbstract.

DataTypes::ValueType::size_type escript::DataEmpty::getLength ( ) const

virtual

Return the number of doubles stored for the Data object. As this is an empty Data object, this method will always return 0.

Implements escript::DataAbstract.

DataTypes::ValueType::size_type escript::DataEmpty::getPointOffset	(	int	sampleNo,
		int	dataPointNo
	)		const

virtual

Return the offset for the given sample. NB: This will throw an exception as obviously an empty Data object contains no samples. An implementation is required by parent DataAbstract class.

Parameters

sampleNo	- Input - Sample number.
dataPointNo	- Input - data-point number.

Implements escript::DataAbstract.

DataTypes::ValueType::size_type escript::DataEmpty::getPointOffset	(	int	sampleNo,
		int	dataPointNo
	)

virtual

Implements escript::DataAbstract.

DataAbstract * escript::DataEmpty::getSlice ( const DataTypes::RegionType & region ) const

virtual

Factory method that returns a newly created DataEmpty sliced from the current Data object according to the specified region. NB: This will throw an exception as obviously an empty Data object contains no data to slice from. An implementation is required by parent DataAbstract class.

Implements escript::DataAbstract.

const DataTypes::ValueType & escript::DataEmpty::getVectorRO ( ) const

protectedvirtual

Implements escript::DataReady.

Referenced by replaceNaN().

DataTypes::ValueType & escript::DataEmpty::getVectorRW ( )

protectedvirtual

Provide access to underlying storage. Internal use only!

Implements escript::DataReady.

Referenced by replaceNaN().

bool escript::DataEmpty::hasNaN ( ) const

inlinevirtual

return true if data contains NaN.

Warning: This is dependent on the ability to reliably detect NaNs on your compiler. See the nancheck function in LocalOps for details.

Implements escript::DataReady.

References ESCRIPT_DLL_API.

int escript::DataEmpty::matrixInverse ( DataAbstract * out ) const

virtual

invert square matricies

Parameters

out	- Where to store the results

Returns: errorcode (0 indicates success)

Reimplemented from escript::DataAbstract.

void escript::DataEmpty::replaceNaN ( double value )

inlinevirtual

replaces all NaN values with value

Implements escript::DataReady.

References ESCRIPT_DLL_API, getVectorRO(), and getVectorRW().

void escript::DataEmpty::setSlice	(	const DataAbstract *	value,
		const DataTypes::RegionType &	region
	)

virtual

Set the current Data object according to the specified slice from the given input value. NB: This will throw an exception as obviously an empty Data object contains no data to slice to. An implementation is required by parent DataAbstract class.

Parameters

value	Input - Data to copy from
region	Input - Region to copy.

Implements escript::DataReady.

std::string escript::DataEmpty::toString ( ) const

virtual

Return a textual representation of the Data object.

Implements escript::DataAbstract.

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

Public Member Functions

Protected Member Functions

Private Types

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation