Field3D
|
#include <MACField.h>
Public Types | |
typedef MACField< Data_T > | class_type |
typedef MACField< Data_T > | class_type |
typedef CubicMACFieldInterp< Data_T > | CubicInterp |
typedef LinearMACFieldInterp< Data_T > | LinearInterp |
typedef boost::intrusive_ptr< MACField > | Ptr |
typedef Data_T::BaseType | real_t |
This typedef is used to refer to the scalar component type of the vectors. | |
typedef MACField< Data_T >::real_t | real_t |
typedef std::vector< Ptr > | Vec |
![]() | |
typedef ResizableField< Data_T > | class_type |
typedef boost::intrusive_ptr< ResizableField > | Ptr |
![]() | |
typedef WritableField< Data_T > | class_type |
typedef boost::intrusive_ptr< WritableField > | Ptr |
![]() | |
typedef Field< Data_T > | class_type |
typedef boost::intrusive_ptr< Field > | Ptr |
typedef Data_T | value_type |
Allows us to reference the template class. | |
typedef std::vector< Ptr > | Vec |
This is a convenience typedef for the list that Field3DInputFile::readScalarLayers() and Field3DInputFile::readVectorLayers() will return its data in. | |
![]() | |
typedef FieldRes | class_type |
typedef boost::intrusive_ptr< FieldRes > | Ptr |
typedef std::vector< Ptr > | Vec |
![]() | |
typedef FieldBase | class_type |
typedef boost::intrusive_ptr< FieldBase > | Ptr |
![]() | |
typedef boost::intrusive_ptr< RefBase > | Ptr |
typedef boost::weak_ptr< RefBase > | WeakPtr |
Public Member Functions | |
const_mac_comp_iterator (MACComponent comp, const class_type &field, const Box3i &window, const V3i ¤tPos) | |
void | copyMAC (typename MACField::Ptr other) |
TEMP: Copies the MAC field data from another MAC field. This should be re-implemented using proper iterators over the field. | |
V3i | getComponentSize () const |
Returns the size of U,V,W components. | |
template<class Iter_T> | |
bool | operator!= (const Iter_T &rhs) const |
const real_t & | operator* () const |
const const_mac_comp_iterator & | operator++ () |
const real_t * | operator-> () const |
template<class Iter_T> | |
bool | operator== (const Iter_T &rhs) const |
real_t | uCenter (int i, int j, int k) const |
Returns the u-component interpolated to the cell center. | |
real_t | vCenter (int i, int j, int k) const |
Returns the v-component interpolated to the cell center. | |
real_t | wCenter (int i, int j, int k) const |
Returns the w-component interpolated to the cell center. | |
Constructors & destructor | |
MACField () | |
Constructs an empty buffer. | |
virtual void | clear (const Data_T &value) |
Clears all the voxels in the storage. | |
From Field | |
virtual Data_T | value (int i, int j, int k) const |
virtual long long int | memSize () const |
Returns the memory usage (in bytes) | |
From WritableField | |
virtual Data_T & | lvalue (int i, int j, int k) |
This will return the appropriate interpolated value but setting that to something else does not change the MAC field. | |
MAC-component access | |
const real_t & | u (int i, int j, int k) const |
Read access to value on u-facing wall. | |
real_t & | u (int i, int j, int k) |
Write access to value on u-facing wall. | |
const real_t & | v (int i, int j, int k) const |
Read access to value on v-facing wall. | |
real_t & | v (int i, int j, int k) |
Write access to value on v-facing wall. | |
const real_t & | w (int i, int j, int k) const |
Read access to value on w-facing wall. | |
real_t & | w (int i, int j, int k) |
Write access to value on w-facing wall. | |
MAC-component iterators | |
A note about MAC iterators The subset that we choose to iterate over is defined by voxels, not MAC face coordinates. Thus, iterator from (0, 0, 0) to (0, 0, 0) will actually visit (0, 0, 0) and (1, 0, 0) for the u component, and (0, 0, 0) to (0, 1, 0) for the v component... | |
const_mac_comp_iterator | cbegin_comp (MACComponent comp) const |
Const iterator to first element. "cbegin" matches the tr1 c++ standard. | |
const_mac_comp_iterator | cbegin_comp (MACComponent comp, const Box3i &subset) const |
Const iterator to first element of specific subset. | |
const_mac_comp_iterator | cend_comp (MACComponent comp) const |
Const iterator to first element. "cbegin" matches the tr1 c++ standard. | |
const_mac_comp_iterator | cend_comp (MACComponent comp, const Box3i &subset) const |
Const iterator to first element of specific subset. | |
mac_comp_iterator | begin_comp (MACComponent comp) |
Iterator to first element. | |
mac_comp_iterator | begin_comp (MACComponent comp, const Box3i &subset) |
Iterator to first element of specific subset. | |
mac_comp_iterator | end_comp (MACComponent comp) |
Iterator to first element. | |
mac_comp_iterator | end_comp (MACComponent comp, const Box3i &subset) |
Iterator to first element of specific subset. | |
![]() | |
void | copyFrom (typename Field< Data_T >::Ptr other) |
Copies the data from another Field, also resizes. | |
template<class Data_T2> | |
void | copyFrom (typename Field< Data_T2 >::Ptr other) |
Copies the data from another Field of another template class, also resizes. | |
void | matchDefinition (FieldRes::Ptr fieldToMatch) |
Sets up this field so that resolution and mapping matches the other. | |
void | setSize (const Box3i &extents) |
Resizes the object. | |
void | setSize (const Box3i &extents, const Box3i &dataWindow) |
Resizes the object. | |
void | setSize (const V3i &size) |
Resizes the object. | |
void | setSize (const V3i &size, int padding) |
Resizes the object with padding. | |
![]() | |
iterator | begin () |
Iterator to first element. | |
iterator | begin (const Box3i &subset) |
Iterator to first element of specific subset. | |
iterator | end () |
Iterator pointing one element past the last valid one. | |
iterator | end (const Box3i &subset) |
Iterator pointing one element past the last valid one (for a subset) | |
![]() | |
const_iterator | cbegin () const |
Const iterator to first element. "cbegin" matches the tr1 c++ standard. | |
const_iterator | cbegin (const Box3i &subset) const |
Const iterator to first element of specific subset. | |
const_iterator | cend () const |
Const iterator pointing one element past the last valid one. | |
const_iterator | cend (const Box3i &subset) const |
Const iterator pointing one element past the last valid one (for a subset) | |
virtual std::string | dataTypeString () const |
virtual | ~Field () |
Dtor. | |
![]() | |
V3i const | dataResolution () const |
const Box3i & | dataWindow () const |
Returns the data window. Any coordinate inside this window is safe to pass to value() in the Field subclass. | |
const Box3i & | extents () const |
Returns the extents of the data. This signifies the relevant area that the data exists over. However, the data window (below) may be smaller than the extents, in which case it is only safe to call value() for those coordinate inside the data window. | |
FieldRes () | |
This constructor ensures that we have a valid mapping at all times. | |
FieldRes (const FieldRes &src) | |
Base class copy constructor. | |
bool | isInBounds (int i, int j, int k) const |
Returns true is the indicies are in bounds of the data window. | |
FieldMapping::Ptr | mapping () |
Returns a pointer to the mapping. | |
const FieldMapping::Ptr | mapping () const |
Returns a pointer to the mapping. | |
virtual void | mappingChanged () |
Tells the subclass that the mapping changed. | |
void | setMapping (FieldMapping::Ptr mapping) |
Sets the field's mapping. | |
virtual size_t | voxelCount () const |
Counts the number of voxels. For most fields, this is just the volume of the data window, but sparse data structures can override this to return a better value. | |
![]() | |
FieldBase () | |
Constructor. | |
FieldBase (const FieldBase &) | |
Copy Constructor. | |
virtual | ~FieldBase () |
Destructor. | |
virtual std::string | className () const =0 |
Returns the class name of the object. Used by the class pool and when writing the data to disk. | |
virtual std::string | classType () const =0 |
Returns the full class type string. | |
FieldMetadata & | metadata () |
accessor to the m_metadata class | |
const FieldMetadata & | metadata () const |
Read only access to the m_metadata class. | |
void | copyMetadata (const FieldBase &field) |
Copies the metadata from a second field. | |
![]() | |
void | ref () const |
Used by boost::intrusive_pointer. | |
size_t | refcnt () |
Used by boost::intrusive_pointer. | |
void | unref () const |
Used by boost::intrusive_pointer. | |
WeakPtr | weakPtr () const |
RefBase () | |
RefBase (const RefBase &) | |
Copy constructor. | |
RefBase & | operator= (const RefBase &) |
Assignment operator. | |
virtual | ~RefBase () |
Destructor. | |
virtual bool | checkRTTI (const char *typenameStr)=0 |
This function is only implemented by concrete classes and triggers the actual RTTI check through matchRTTI();. | |
bool | matchRTTI (const char *typenameStr) |
Performs a check to see if the given typename string matches this class' This needs to be implemented in -all- subclasses, even abstract ones. | |
![]() | |
virtual void | metadataHasChanged (const std::string &) |
Alerts the callback holder that the metadata has changed. | |
Static Public Member Functions | |
static const char * | staticClassName () |
static const char * | staticClassType () |
![]() | |
static const char * | staticClassName () |
static const char * | staticClassType () |
![]() | |
static const char * | staticClassName () |
static const char * | staticClassType () |
![]() | |
static const char * | staticClassName () |
static const char * | staticClassType () |
![]() | |
static const char * | staticClassName () |
static const char * | staticClassType () |
![]() | |
static const char * | staticClassName () |
static const char * | staticClassType () |
static const char * | staticClassType () |
Public Attributes | |
DEFINE_FIELD_RTTI_CONCRETE_CLASS | |
int | x |
Current position. | |
int | y |
int | z |
![]() | |
DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
![]() | |
DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
![]() | |
DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
![]() | |
DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
![]() | |
std::string | attribute |
Optional name of the attribute the field represents. | |
std::string | name |
Optional name of the field. | |
Protected Member Functions | |
virtual void | sizeChanged () |
Subclasses should re-implement this if they need to perform memory allocations, etc. every time the size of the storage changes. | |
real_t * | uPtr (int i, int j, int k) |
Direct access to value on u-facing wall. | |
const real_t * | uPtr (int i, int j, int k) const |
Direct access to value on u-facing wall. | |
real_t * | vPtr (int i, int j, int k) |
Direct access to value on v-facing wall. | |
const real_t * | vPtr (int i, int j, int k) const |
Direct access to value on v-facing wall. | |
real_t * | wPtr (int i, int j, int k) |
Direct access to value on w-facing wall. | |
const real_t * | wPtr (int i, int j, int k) const |
Direct access to value on w-facing wall. | |
Protected Attributes | |
Data_T | m_dummy |
Dummy storage of a temp value that lvalue() can write to. | |
std::vector< real_t > | m_u |
U component storage. | |
V3i | m_uSize |
Size of U grid along each axis. | |
int | m_uSizeXY |
Size of xy slice for u component. | |
std::vector< real_t > | m_v |
V component storage. | |
V3i | m_vSize |
Size of V grid along each axis. | |
int | m_vSizeXY |
Size of xy slice for v component. | |
std::vector< real_t > | m_w |
W component storage. | |
V3i | m_wSize |
Size of W grid along each axis. | |
int | m_wSizeXY |
Size of xy slice for w component. | |
![]() | |
Box3i | m_dataWindow |
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval. | |
Box3i | m_extents |
Defines the extents of the the storage. This may be larger or smaller than the data window, and in the case where it is larger, care must be taken not to access voxels outside the data window. This should be treated as a closed (i.e. inclusive) interval. | |
FieldMapping::Ptr | m_mapping |
Pointer to the field's mapping. | |
Private Types | |
typedef ResizableField< Data_T > | base |
Private Member Functions | |
void | updatePointer () |
Private Attributes | |
MACComponent | m_comp |
Component to look up. | |
const class_type & | m_field |
Reference to field being iterated over. | |
const real_t * | m_p |
Pointer to current element. | |
Box3i | m_window |
Window to traverse. | |
Static Private Attributes | |
static TemplatedFieldType< MACField< Data_T > > | ms_classType |
From FieldBase | |
FIELD3D_CLASSNAME_CLASSTYPE_IMPLEMENTATION | |
virtual FieldBase::Ptr | clone () const |
Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it. | |
Additional Inherited Members | |
![]() | |
typedef WritableField< Data_T > | base |
![]() | |
typedef MatrixFieldMapping | default_mapping |
![]() | |
static TemplatedFieldType< ResizableField< Data_T > > | ms_classType |
Definition at line 359 of file MACField.h.
typedef MACField<Data_T> MACField< Data_T >::const_mac_comp_iterator::class_type |
Definition at line 365 of file MACField.h.
typedef MACField<Data_T>::real_t MACField< Data_T >::const_mac_comp_iterator::real_t |
Definition at line 366 of file MACField.h.
Definition at line 101 of file MACField.h.
Definition at line 102 of file MACField.h.
This typedef is used to refer to the scalar component type of the vectors.
Definition at line 105 of file MACField.h.
typedef LinearMACFieldInterp<Data_T> MACField< Data_T >::LinearInterp |
Definition at line 107 of file MACField.h.
typedef CubicMACFieldInterp<Data_T> MACField< Data_T >::CubicInterp |
Definition at line 108 of file MACField.h.
Definition at line 112 of file MACField.h.
|
private |
Definition at line 336 of file MACField.h.
|
inline |
Definition at line 370 of file MACField.h.
References m_comp, m_field, m_p, m_window, updatePointer(), x, y, and z.
Referenced by operator++().
|
inline |
Definition at line 384 of file MACField.h.
References const_mac_comp_iterator(), m_p, m_window, updatePointer(), x, y, and z.
|
inline |
|
inline |
|
inlineprivate |
Definition at line 439 of file MACField.h.
References m_comp, m_field, m_p, MACCompU, MACCompV, MACCompW, x, y, and z.
Referenced by const_mac_comp_iterator(), and operator++().
|
inlinestatic |
Definition at line 115 of file MACField.h.
|
inlinestatic |
Definition at line 120 of file MACField.h.
MACField< Data_T >::MACField | ( | ) |
|
inlinevirtual |
Clears all the voxels in the storage.
Reimplemented from WritableField< Data_T >.
Definition at line 138 of file MACField.h.
|
virtual |
Implements Field< Data_T >.
Definition at line 146 of file MACField.h.
|
virtual |
Returns the memory usage (in bytes)
Reimplemented from FieldRes.
Definition at line 147 of file MACField.h.
|
virtual |
This will return the appropriate interpolated value but setting that to something else does not change the MAC field.
Implements WritableField< Data_T >.
Definition at line 159 of file MACField.h.
Read access to value on u-facing wall.
Definition at line 170 of file MACField.h.
Write access to value on u-facing wall.
Definition at line 173 of file MACField.h.
Read access to value on v-facing wall.
Definition at line 176 of file MACField.h.
Write access to value on v-facing wall.
Definition at line 179 of file MACField.h.
Read access to value on w-facing wall.
Definition at line 182 of file MACField.h.
Write access to value on w-facing wall.
Definition at line 185 of file MACField.h.
MACField< Data_T >::const_mac_comp_iterator MACField< Data_T >::cbegin_comp | ( | MACComponent | comp | ) | const |
Const iterator to first element. "cbegin" matches the tr1 c++ standard.
Definition at line 207 of file MACField.h.
MACField< Data_T >::const_mac_comp_iterator MACField< Data_T >::cbegin_comp | ( | MACComponent | comp, |
const Box3i & | subset ) const |
Const iterator to first element of specific subset.
Definition at line 209 of file MACField.h.
MACField< Data_T >::const_mac_comp_iterator MACField< Data_T >::cend_comp | ( | MACComponent | comp | ) | const |
Const iterator to first element. "cbegin" matches the tr1 c++ standard.
Definition at line 212 of file MACField.h.
MACField< Data_T >::const_mac_comp_iterator MACField< Data_T >::cend_comp | ( | MACComponent | comp, |
const Box3i & | subset ) const |
Const iterator to first element of specific subset.
Definition at line 214 of file MACField.h.
MACField< Data_T >::mac_comp_iterator MACField< Data_T >::begin_comp | ( | MACComponent | comp | ) |
Iterator to first element.
Definition at line 218 of file MACField.h.
MACField< Data_T >::mac_comp_iterator MACField< Data_T >::begin_comp | ( | MACComponent | comp, |
const Box3i & | subset ) |
MACField< Data_T >::mac_comp_iterator MACField< Data_T >::end_comp | ( | MACComponent | comp | ) |
Iterator to first element.
Definition at line 223 of file MACField.h.
MACField< Data_T >::mac_comp_iterator MACField< Data_T >::end_comp | ( | MACComponent | comp, |
const Box3i & | subset ) |
Iterator to first element of specific subset.
Definition at line 225 of file MACField.h.
Returns the u-component interpolated to the cell center.
Definition at line 233 of file MACField.h.
Returns the v-component interpolated to the cell center.
Definition at line 238 of file MACField.h.
Returns the w-component interpolated to the cell center.
Definition at line 243 of file MACField.h.
|
inline |
TEMP: Copies the MAC field data from another MAC field. This should be re-implemented using proper iterators over the field.
Definition at line 250 of file MACField.h.
|
inlinevirtual |
Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it.
Implements FieldBase.
Definition at line 271 of file MACField.h.
|
protectedvirtual |
Subclasses should re-implement this if they need to perform memory allocations, etc. every time the size of the storage changes.
Reimplemented from ResizableField< Data_T >.
Definition at line 280 of file MACField.h.
|
inlineprotected |
Direct access to value on u-facing wall.
Definition at line 286 of file MACField.h.
Direct access to value on u-facing wall.
Definition at line 289 of file MACField.h.
|
inlineprotected |
Direct access to value on v-facing wall.
Definition at line 292 of file MACField.h.
Direct access to value on v-facing wall.
Definition at line 295 of file MACField.h.
|
inlineprotected |
Direct access to value on w-facing wall.
Definition at line 298 of file MACField.h.
Direct access to value on w-facing wall.
Definition at line 301 of file MACField.h.
int MACField< Data_T >::const_mac_comp_iterator::x |
Current position.
Definition at line 433 of file MACField.h.
Referenced by const_mac_comp_iterator(), operator++(), and updatePointer().
int MACField< Data_T >::const_mac_comp_iterator::y |
Definition at line 433 of file MACField.h.
Referenced by const_mac_comp_iterator(), operator++(), and updatePointer().
int MACField< Data_T >::const_mac_comp_iterator::z |
Definition at line 433 of file MACField.h.
Referenced by const_mac_comp_iterator(), operator++(), and updatePointer().
Pointer to current element.
Definition at line 459 of file MACField.h.
Referenced by const_mac_comp_iterator(), operator!=(), operator*(), operator++(), operator->(), operator==(), and updatePointer().
Window to traverse.
Definition at line 461 of file MACField.h.
Referenced by const_mac_comp_iterator(), and operator++().
|
private |
Component to look up.
Definition at line 463 of file MACField.h.
Referenced by const_mac_comp_iterator(), and updatePointer().
|
private |
Reference to field being iterated over.
Definition at line 465 of file MACField.h.
Referenced by const_mac_comp_iterator(), and updatePointer().
MACField< Data_T >::DEFINE_FIELD_RTTI_CONCRETE_CLASS |
Definition at line 113 of file MACField.h.
MACField< Data_T >::FIELD3D_CLASSNAME_CLASSTYPE_IMPLEMENTATION |
Definition at line 269 of file MACField.h.
U component storage.
Definition at line 306 of file MACField.h.
V component storage.
Definition at line 308 of file MACField.h.
W component storage.
Definition at line 310 of file MACField.h.
Size of U grid along each axis.
Definition at line 313 of file MACField.h.
|
protected |
Size of xy slice for u component.
Definition at line 315 of file MACField.h.
Size of V grid along each axis.
Definition at line 317 of file MACField.h.
|
protected |
Size of xy slice for v component.
Definition at line 319 of file MACField.h.
Size of W grid along each axis.
Definition at line 321 of file MACField.h.
|
protected |
Size of xy slice for w component.
Definition at line 323 of file MACField.h.
|
mutableprotected |
Dummy storage of a temp value that lvalue() can write to.
Definition at line 326 of file MACField.h.
|
staticprivate |
Definition at line 332 of file MACField.h.