ESYS13  Revision_
Public Member Functions | Private Types
escript::DataReady Class Reference

#include <DataReady.h>

Inheritance diagram for escript::DataReady:
escript::DataAbstract escript::DataConstant escript::DataEmpty escript::DataExpanded escript::DataTagged

List of all members.

Public Member Functions

 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.
const double * getSampleDataRO (ValueType::size_type sampleNo) const
virtual DataTypes::ValueTypegetVectorRW ()=0
 Provide access to underlying storage. Internal use only!
virtual const
DataTypes::ValueType
getVectorRO () const =0
virtual bool hasNaN () const =0
 return true if data contains NaN.
virtual void setSlice (const DataAbstract *value, const DataTypes::RegionType &region)=0
 Copy the specified region from the given object.
DataTypes::ValueType::const_reference getDataAtOffsetRO (DataTypes::ValueType::size_type i) const
 get a reference to the beginning of a data point
DataTypes::ValueType::reference getDataAtOffsetRW (DataTypes::ValueType::size_type i)
DataReady_ptr resolve ()
 Return a data object with all points resolved.

Private Types

typedef DataAbstract parent

Detailed Description

Base class for Data which do not need to be resolved. Internally this means they have getVectorRO and getVectorRW methods.


Member Typedef Documentation


Constructor & Destructor Documentation

escript::DataReady::DataReady ( const FunctionSpace what,
const ShapeType shape,
bool  isDataEmpty = false 
)

Member Function Documentation

get a reference to the beginning of a data point

References getVectorRO().

Referenced by escript::Data::getDataAtOffsetRO(), and escript::Data::getDataPointRO().

const double * escript::DataReady::getSampleDataRO ( ValueType::size_type  sampleNo) const [inline]

Return the sample data for the given sample number.

References escript::DataAbstract::getPointOffset(), and getVectorRW().

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

virtual const DataTypes::ValueType& escript::DataReady::getVectorRO ( ) const [pure virtual]
virtual bool escript::DataReady::hasNaN ( ) const [pure virtual]

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.

Implemented in escript::DataTagged, escript::DataExpanded, escript::DataEmpty, and escript::DataConstant.

Referenced by escript::Data::infWorker(), escript::Data::LsupWorker(), and escript::Data::supWorker().

Return a data object with all points resolved.

Implements escript::DataAbstract.

References escript::DataAbstract::getPtr().

virtual void escript::DataReady::setSlice ( const DataAbstract value,
const DataTypes::RegionType region 
) [pure virtual]

Copy the specified region from the given object.

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

Implemented in escript::DataTagged, escript::DataExpanded, escript::DataConstant, and escript::DataEmpty.

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


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