cee::ug::ResultsQueryResult Class Reference

A ResultsQuery result that contains the values found by a ResultsQuery on one ResultsQueryItem. More...

Public Member Functions

 ResultsQueryResult ()
 Constructs a query result. More...
 
 ResultsQueryResult (const ResultsQueryResult &other)
 Constructs a query result as a copy of other. More...
 
ResultsQueryResultoperator= (const ResultsQueryResult &other)
 Assigns other to this query result and returns a reference to this result. More...
 
bool operator== (const ResultsQueryResult &other) const
 Returns true if this result is equal to the passed result. More...
 
void setSpatialDimension (int spatialDimension)
 set the spatial dimension of the result data being storage per item More...
 
bool addSubItem (double *data, size_t dataCount)
 Insert the item into the container verifying that its match the spatial dimension. More...
 
size_t subItemCount () const
 Returns the number of subitem values in the result. More...
 
double scalar () const
 Returns the unique scalar stored in this result. More...
 
Vec3d vector () const
 Returns the unique vector stored in this result. More...
 
SymmetricTensor tensor () const
 Returns the unique symmetric tensor stored in this result. More...
 
double subItemScalar (size_t subItemIndex) const
 Returns the scalar stored in this result for a given sub-item (element node or element surface). More...
 
Vec3d subItemVector (size_t subItemIndex) const
 Returns the vector stored in this result for a given sub-item (element node or element surface). More...
 
SymmetricTensor subItemTensor (size_t subItemIndex) const
 Returns the symmetric tensor stored in this result for a given sub-item (element node or element surface). More...
 
double averageSubItemScalar () const
 Returns the arithmetic average of the scalars stored for all sub items. More...
 
Vec3d averageSubItemVector () const
 Returns the arithmetic average of the vectors stored for all sub items. More...
 
SymmetricTensor averageSubItemTensor () const
 Returns the arithmetic average of the symmetric tensors stored for all sub items. More...
 

Detailed Description

A ResultsQuery result that contains the values found by a ResultsQuery on one ResultsQueryItem.

The count of stored values depends on the mapping of the result.

For a node-mapped or an element-mapped result, there will be only one result value (i.e. one scalar, vector or symmetric tensor).

For element-node-mapped or element-surface-mapped results, there will be one result value per subitem (element-node or element-surface).

Constructor & Destructor Documentation

cee::ug::ResultsQueryResult::ResultsQueryResult ( )

Constructs a query result.

cee::ug::ResultsQueryResult::ResultsQueryResult ( const ResultsQueryResult other)

Constructs a query result as a copy of other.

Member Function Documentation

bool cee::ug::ResultsQueryResult::addSubItem ( double *  data,
size_t  dataCount 
)

Insert the item into the container verifying that its match the spatial dimension.

double cee::ug::ResultsQueryResult::averageSubItemScalar ( ) const

Returns the arithmetic average of the scalars stored for all sub items.

SymmetricTensor cee::ug::ResultsQueryResult::averageSubItemTensor ( ) const

Returns the arithmetic average of the symmetric tensors stored for all sub items.

Vec3d cee::ug::ResultsQueryResult::averageSubItemVector ( ) const

Returns the arithmetic average of the vectors stored for all sub items.

ResultsQueryResult & cee::ug::ResultsQueryResult::operator= ( const ResultsQueryResult other)

Assigns other to this query result and returns a reference to this result.

bool cee::ug::ResultsQueryResult::operator== ( const ResultsQueryResult other) const

Returns true if this result is equal to the passed result.

double cee::ug::ResultsQueryResult::scalar ( ) const

Returns the unique scalar stored in this result.

Use this only if the result is not element-node-mapped or element-surface-mapped.

void cee::ug::ResultsQueryResult::setSpatialDimension ( int  spatialDimension)

set the spatial dimension of the result data being storage per item

size_t cee::ug::ResultsQueryResult::subItemCount ( ) const

Returns the number of subitem values in the result.

double cee::ug::ResultsQueryResult::subItemScalar ( size_t  subItemIndex) const

Returns the scalar stored in this result for a given sub-item (element node or element surface).

By extension, when the result is node-mapped or element-mapped the unique scalar is stored in place of this first subitem.

SymmetricTensor cee::ug::ResultsQueryResult::subItemTensor ( size_t  subItemIndex) const

Returns the symmetric tensor stored in this result for a given sub-item (element node or element surface).

By extension, when the result is node-mapped or element-mapped the unique symmetric tensor is stored in place of this first subitem.

Vec3d cee::ug::ResultsQueryResult::subItemVector ( size_t  subItemIndex) const

Returns the vector stored in this result for a given sub-item (element node or element surface).

By extension, when the result is node-mapped or element-mapped the unique vector is stored in place of this first subitem.

SymmetricTensor cee::ug::ResultsQueryResult::tensor ( ) const

Returns the unique symmetric tensor stored in this result.

Use this only if the result is not element-node-mapped or element-surface-mapped.

Vec3d cee::ug::ResultsQueryResult::vector ( ) const

Returns the unique vector stored in this result.

Use this only if the result is not element-node-mapped or element-surface-mapped.