FreeFOAM The Cross-Platform CFD Toolkit
bufferedAccumulator< Type > Class Template Reference

#include <molecularMeasurements/bufferedAccumulator.H>


Detailed Description

+ Inheritance diagram for bufferedAccumulator< Type >:
+ Collaboration diagram for bufferedAccumulator< Type >:

List of all members.

Public Types

typedef pTraits< Type >::cmptType cmptType
 Component type.
- Public Types inherited from List< Field< Type > >
typedef SubList< Field< Type > > subList
 Declare type of subList.
- Public Types inherited from UList< Field< Type > >
typedef Field< Type > value_type
 Type of values the UList contains.
typedef Field< Type > & reference
 Type that can be used for storing into.
typedef const Field< Type > & const_reference
 Type that can be used for storing into.
typedef label difference_type
 The type that can represent the difference between any two.
typedef label size_type
 The type that can represent the size of a UList.
typedef Field< Type > * iterator
 Random access iterator for traversing UList.
typedef const Field< Type > * const_iterator
 Random access iterator for traversing UList.
typedef Field< Type > * reverse_iterator
 Reverse iterator for reverse traversal of UList.
typedef const Field< Type > * const_reverse_iterator
 Reverse iterator for reverse traversal of constant UList.

Public Member Functions

 bufferedAccumulator ()
 Construct null.
 bufferedAccumulator (const label nBuffers, const label bufferLength, const label bufferingInterval)
 Construct from components.
 bufferedAccumulator (const bufferedAccumulator< Type > &)
 Construct as copy.
 ~bufferedAccumulator ()
label addToBuffers (const List< Type > &valuesToAdd)
Field< Type > averaged () const
void resetAveraging ()
label averagesTaken () const
label nBuffers () const
label bufferLength () const
const List< label > & bufferOffsets () const
void setSizes (const label nBuffers, const label bufferLength, const label bufferingInterval)
void operator= (const bufferedAccumulator< Type > &)
- Public Member Functions inherited from List< Field< Type > >
label size () const
 Return the number of elements in the UList.
 List ()
 Null constructor.
 List (const label)
 Construct with given size.
 List (const label, const Field< Type > &)
 Construct with given size and value for all elements.
 List (const List< Field< Type > > &)
 Copy constructor.
 List (const Xfer< List< Field< Type > > > &)
 Construct by transferring the parameter contents.
 List (List< Field< Type > > &, bool reUse)
 Construct as copy or re-use as specified.
 List (const UList< Field< Type > > &, const unallocLabelList &mapAddressing)
 Construct as subset.
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators.
 List (const FixedList< Field< Type >, Size > &)
 Construct as copy of FixedList<T, Size>
 List (const PtrList< Field< Type > > &)
 Construct as copy of PtrList<T>
 List (const SLList< Field< Type > > &)
 Construct as copy of SLList<T>
 List (const IndirectList< Field< Type > > &)
 Construct as copy of IndirectList<T>
 List (const UIndirectList< Field< Type > > &)
 Construct as copy of UIndirectList<T>
 List (const BiIndirectList< Field< Type > > &)
 Construct as copy of BiIndirectList<T>
 List (Istream &)
 Construct from Istream.
autoPtr< List< Field< Type > > > clone () const
 Clone.
 ~List ()
void resize (const label)
 Reset size of List.
void resize (const label, const Field< Type > &)
 Reset size of List and value for new elements.
void setSize (const label)
 Reset size of List.
void setSize (const label, const Field< Type > &)
 Reset size of List and value for new elements.
void clear ()
 Clear the list, i.e. set size to zero.
void append (const UList< Field< Type > > &)
 Append a List at the end of this list.
void append (const UIndirectList< Field< Type > > &)
 Append a UIndirectList at the end of this list.
void transfer (List< Field< Type > > &)
 Transfer the contents of the argument List into this list.
void transfer (DynamicList< Field< Type >, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list.
void transfer (SortableList< Field< Type > > &)
 Transfer the contents of the argument List into this list.
Xfer< List< Field< Type > > > xfer ()
 Transfer contents to the Xfer container.
Field< Type > & newElmt (const label)
 Return subscript-checked element of UList.
void operator= (const UList< Field< Type > > &)
 Assignment from UList operator. Takes linear time.
void operator= (const List< Field< Type > > &)
 Assignment operator. Takes linear time.
void operator= (const SLList< Field< Type > > &)
 Assignment from SLList operator. Takes linear time.
void operator= (const IndirectList< Field< Type > > &)
 Assignment from IndirectList operator. Takes linear time.
void operator= (const UIndirectList< Field< Type > > &)
 Assignment from UIndirectList operator. Takes linear time.
void operator= (const BiIndirectList< Field< Type > > &)
 Assignment from BiIndirectList operator. Takes linear time.
void operator= (const Field< Type > &)
 Assignment of all entries to the given value.
- Public Member Functions inherited from UList< Field< Type > >
 UList ()
 Null constructor.
 UList (Field< Type > *__restrict__ v, label size)
 Construct from components.
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index.
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index.
label byteSize () const
 Return the binary size in number of characters of the UList.
const Field< Type > * cdata () const
 Return a const pointer to the first data element,.
Field< Type > * data ()
 Return a pointer to the first data element,.
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1).
void checkSize (const label size) const
 Check size is within valid range (0 ... size).
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1).
void writeEntry (Ostream &) const
 Write the UList as a dictionary entry.
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword.
void assign (const UList< Field< Type > > &)
 Assign elements to those from UList.
Field< Type > & operator[] (const label)
 Return element of UList.
const Field< Type > & operator[] (const label) const
 Return element of constant UList.
 operator const Foam::List< Field< Type > > & () const
 Allow cast to a const List<T>&.
iterator begin ()
 Return an iterator to begin traversing the UList.
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList.
iterator end ()
 Return an iterator to end traversing the UList.
const_iterator end () const
 Return const_iterator to end traversing the constant UList.
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList.
const_iterator cend () const
 Return const_iterator to end traversing the constant UList.
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList.
label max_size () const
 Return size of the largest possible UList.
bool empty () const
 Return true if the UList is empty (ie, size() is zero).
void swap (UList< Field< Type > > &)
 Swap two ULists of the same type in constant time.
bool operator== (const UList< Field< Type > > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UList< Field< Type > > &) const
 The opposite of the equality operation. Takes linear time.
bool operator< (const UList< Field< Type > > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator> (const UList< Field< Type > > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator<= (const UList< Field< Type > > &) const
 Return true if !(a > b). Takes linear time.
bool operator>= (const UList< Field< Type > > &) const
 Return true if !(a < b). Takes linear time.

Static Public Attributes

static const char *const typeName

Friends

Ostreamoperator (Ostream &, const bufferedAccumulator< Type > &)

Additional Inherited Members

- Static Public Member Functions inherited from List< Field< Type > >
static const List< Field< Type > > & null ()
 Return a null List.
- Protected Member Functions inherited from List< Field< Type > >
void size (const label)
 Override size to be inconsistent with allocated storage.

Member Typedef Documentation

typedef pTraits<Type>::cmptType cmptType

Component type.

Reimplemented in correlationFunction< Type >.

Definition at line 84 of file bufferedAccumulator.H.


Constructor & Destructor Documentation

Construct null.

Definition at line 53 of file bufferedAccumulator.C.

bufferedAccumulator ( const label  nBuffers,
const label  bufferLength,
const label  bufferingInterval 
)

Construct from components.

Definition at line 63 of file bufferedAccumulator.C.

bufferedAccumulator ( const bufferedAccumulator< Type > &  bA)

Construct as copy.

Definition at line 84 of file bufferedAccumulator.C.

Definition at line 97 of file bufferedAccumulator.C.


Member Function Documentation

Foam::label addToBuffers ( const List< Type > &  valuesToAdd)

Definition at line 131 of file bufferedAccumulator.C.

References Foam::abort(), b, Foam::FatalError, and FatalErrorIn.

Foam::Field< Type > averaged ( ) const

Definition at line 174 of file bufferedAccumulator.C.

References Foam::endl(), and WarningIn.

void resetAveraging ( )

Definition at line 198 of file bufferedAccumulator.C.

label averagesTaken ( ) const
inline

Definition at line 48 of file bufferedAccumulatorI.H.

label nBuffers ( ) const
inline

Definition at line 55 of file bufferedAccumulatorI.H.

label bufferLength ( ) const
inline

Definition at line 62 of file bufferedAccumulatorI.H.

const List< label > & bufferOffsets ( ) const
inline

Definition at line 69 of file bufferedAccumulatorI.H.

void setSizes ( const label  nBuffers,
const label  bufferLength,
const label  bufferingInterval 
)

Definition at line 105 of file bufferedAccumulator.C.

References b, forAll, and List< T >::setSize().

void operator= ( const bufferedAccumulator< Type > &  rhs)

Definition at line 210 of file bufferedAccumulator.C.

References Foam::abort(), Foam::FatalError, and FatalErrorIn.


Friends And Related Function Documentation

Ostream& operator ( Ostream ,
const bufferedAccumulator< Type > &   
)
friend

Member Data Documentation

const char *const typeName
static

Reimplemented in correlationFunction< Type >.

Definition at line 89 of file bufferedAccumulator.H.


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