#include <bufferedAccumulator.H>

Inheritance diagram for bufferedAccumulator< Type >:

[legend]

Collaboration diagram for bufferedAccumulator< Type >:

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
	The value type the list contains.
typedef Field< Type > *	pointer
	The pointer type for non-const access to value_type items.
typedef const Field< Type > *	const_pointer
	The pointer type for const access to value_type items.
typedef Field< Type > &	reference
	The type used for storing into value_type objects.
typedef const Field< Type > &	const_reference
	The type used for reading from constant value_type objects.
typedef Field< Type > *	iterator
	Random access iterator for traversing a UList.
typedef const Field< Type > *	const_iterator
	Random access iterator for traversing a UList.
typedef label	size_type
	The type to represent the size of a UList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
using	is_List
	Have unique tag.

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 ()
	Destructor.
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 > >
void	resize (const label len)
autoPtr< List< Field< Type > > >	clone () const
	Clone.
	~List ()
	Destructor.
void	clear ()
	Clear the list, i.e. set size to zero.
void	resize_copy (label count, const label len)
	Change allocated size of list, retaining the first count elements.
void	resize_fill (const label len, const Field< Type > &val)
	Adjust allocated size of list and set val for all elements.
void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily.
void	transfer (List< Field< Type > > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
Field< Type > &	newElmt (const label i)
	Return subscript-checked element of UList and resizing the list if required.
Field< Type > &	emplace_back (Args &&... args)
	Construct an element at the end of the list, return reference to the new list element.
void	push_back (const Field< Type > &val)
	Append an element at the end of the list.
label	push_uniq (const Field< Type > &val)
	Append an element if not already in the list.
void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list.
void	operator= (const UList< Field< Type > > &list)
	Assignment to UList operator. Takes linear time.
Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List.
void	shallowCopy (const UList< Field< Type > > &)=delete
	No shallowCopy permitted.
bool	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool.
void	append (const Field< Type > &val)
	Append an element at the end of the list.
label	appendUniq (const Field< Type > &val)
	Same as push_uniq().
void	setSize (label n)
	Alias for resize().
Public Member Functions inherited from UList< Field< Type > >
	UList (const UList< Field< Type > > &) noexcept=default
	Copy construct, shallow copy.
UList< Field< Type > > &	operator= (const UList< Field< Type > > &)=delete
	No copy assignment (default: shallow copy).
label	fcIndex (const label i) const noexcept
	The forward circular index. The next index in the list which returns to the first at the end of the list.
label	rcIndex (const label i) const noexcept
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list.
const Field< Type > &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
const Field< Type > &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
const Field< Type > *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
Field< Type > *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
Field< Type > &	front ()
	Access first element of the list, position [0].
Field< Type > &	back ()
	Access last element of the list, position [size()-1].
std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data.
std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous.
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is within valid range [0,size].
void	checkRange (const label start, const label len) const
	Check that start and length define a valid range.
void	checkIndex (const label i) const
	Check index is within valid range [0,size).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const Field< Type > &val) const
	True if the value is contained in the list.
label	find (const Field< Type > &val) const
	Find index of the first occurrence of the value.
label	rfind (const Field< Type > &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list.
void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list.
void	shallowCopy (Field< Type > *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size.
void	deepCopy (const UList< Field< Type > > &list)
	Copy elements of the given UList. Sizes must match!
SubList< Field< Type > >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking.
Field< Type > &	operator[] (const label i)
	Return element of UList.
	operator const Foam::List< Field< Type > > & () const
	Allow cast to a const List<T>&.
iterator	begin () noexcept
	Return an iterator to begin traversing the UList.
iterator	end () noexcept
	Return an iterator to end traversing the UList.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator	rend ()
	Return 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.
bool	empty () const noexcept
	True if List is empty (ie, size() is zero).
label	capacity () const noexcept
	Size of the underlying storage.
void	swap (UList< Field< Type > > &list) noexcept
	Swap content with another UList of the same type in constant time.
bool	operator== (const UList< Field< Type > > &list) const
	Equality operation on ULists of the same type.
bool	operator!= (const UList< Field< Type > > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const UList< Field< Type > > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator> (const UList< Field< Type > > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator<= (const UList< Field< Type > > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const UList< Field< Type > > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read List contents from Istream.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
bool	all () const
	True if all entries are 'true' or if the list is empty.
bool	any () const
	True if any entries are 'true'.
bool	none () const
	True if no entries are 'true'.
bool	test (const label i) const
	Test `bool` value at specified position, always false for out-of-range access.
bool	get (const label i) const
	Return `bool` value at specified position, always false for out-of-range access.
bool	unset (const label i)
	Unset the `bool` entry at specified position, always false for out-of-range access.
std::string_view	view () const
	Return a string_view of the charList. Content is non-modifiable.
Field< Type > &	first ()
	Access first element of the list, position [0].
Field< Type > &	last ()
	Access last element of the list, position [size()-1].
bool	found (const Field< Type > &val, label pos=0) const
	Same as contains().
auto	expr () const
	Wrap value as expression.

Static Public Attributes
static const char *const	typeName

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

Additional Inherited Members
Static Public Member Functions inherited from List< Field< Type > >
static const List< Field< Type > > &	null () noexcept
	Return a null List (reference to a nullObject). Behaves like an empty List.
Static Public Member Functions inherited from UList< Field< Type > >
static const UList< Field< Type > > &	null () noexcept
	Return a null UList (reference to a nullObject). Behaves like an empty UList.
static constexpr label	max_size () noexcept
	The size of the largest possible UList.
Protected Member Functions inherited from UList< Field< Type > >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage.
void	size (const label n)
	Older name for setAddressableSize.
void	writeEntry (Ostream &os) const
	Write the UList with its compound type.
labelRange	validateRange (const labelRange &requestedRange) const
	Return a validated (start,size) subset range, which means that it always addresses a valid section of the list.
void	fill_uniform (const Field< Type > &val)
	Assign all entries to the given value.

Detailed Description

template<class Type>
class Foam::bufferedAccumulator< Type >

Source files

Definition at line 58 of file bufferedAccumulator.H.

Member Typedef Documentation

◆ cmptType

template<class Type>

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 83 of file bufferedAccumulator.H.

Constructor & Destructor Documentation

◆ bufferedAccumulator() [1/3]

template<class Type>

bufferedAccumulator ( )

Construct null.

Definition at line 49 of file bufferedAccumulator.C.

Referenced by bufferedAccumulator(), operator<<, and operator=().

Here is the caller graph for this function:

◆ bufferedAccumulator() [2/3]

template<class Type>

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

Construct from components.

Definition at line 58 of file bufferedAccumulator.C.

References bufferLength(), nBuffers(), and setSizes().

Here is the call graph for this function:

◆ bufferedAccumulator() [3/3]

template<class Type>

bufferedAccumulator ( const bufferedAccumulator< Type > & bA )

Construct as copy.

Definition at line 79 of file bufferedAccumulator.C.

References averagesTaken(), bufferedAccumulator(), and bufferOffsets().

Here is the call graph for this function:

◆ ~bufferedAccumulator()

template<class Type>

~bufferedAccumulator ( )

Destructor.

Definition at line 93 of file bufferedAccumulator.C.

Member Function Documentation

◆ addToBuffers()

template<class Type>

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

Definition at line 126 of file bufferedAccumulator.C.

References b, and nBuffers().

Here is the call graph for this function:

◆ averaged()

template<class Type>

Foam::Field< Type > averaged ( ) const

Definition at line 170 of file bufferedAccumulator.C.

References bufferLength(), Foam::endl(), WarningInFunction, and Foam::Zero.

Here is the call graph for this function:

◆ resetAveraging()

template<class Type>

void resetAveraging ( )

Definition at line 192 of file bufferedAccumulator.C.

References bufferLength(), and Foam::Zero.

Here is the call graph for this function:

◆ averagesTaken()

template<class Type>

label averagesTaken ( ) const

inline

Definition at line 43 of file bufferedAccumulatorI.H.

Referenced by bufferedAccumulator().

Here is the caller graph for this function:

◆ nBuffers()

template<class Type>

label nBuffers ( ) const

inline

Definition at line 50 of file bufferedAccumulatorI.H.

References UList< T >::size().

Referenced by addToBuffers(), bufferedAccumulator(), and setSizes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ bufferLength()

template<class Type>

label bufferLength ( ) const

inline

Definition at line 57 of file bufferedAccumulatorI.H.

Referenced by averaged(), bufferedAccumulator(), resetAveraging(), and setSizes().

Here is the caller graph for this function:

◆ bufferOffsets()

template<class Type>

const List< label > & bufferOffsets ( ) const

inline

Definition at line 64 of file bufferedAccumulatorI.H.

Referenced by bufferedAccumulator().

Here is the caller graph for this function:

◆ setSizes()

template<class Type>

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

Definition at line 100 of file bufferedAccumulator.C.

References b, bufferLength(), forAll, nBuffers(), List< T >::setSize(), and Foam::Zero.

Referenced by bufferedAccumulator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

template<class Type>

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

Definition at line 203 of file bufferedAccumulator.C.

References bufferedAccumulator(), and Foam::rhs().

Here is the call graph for this function:

◆ operator<<

template<class Type>

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

friend

References bufferedAccumulator().

Member Data Documentation

◆ typeName

template<class Type>

const char *const typeName

static

Definition at line 88 of file bufferedAccumulator.H.

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

src/lagrangian/molecularDynamics/molecularMeasurements/bufferedAccumulator/bufferedAccumulator.H
src/lagrangian/molecularDynamics/molecularMeasurements/bufferedAccumulator/bufferedAccumulator.C
src/lagrangian/molecularDynamics/molecularMeasurements/bufferedAccumulator/bufferedAccumulatorI.H

Public Types

Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ cmptType

Constructor & Destructor Documentation

◆ bufferedAccumulator() [1/3]

◆ bufferedAccumulator() [2/3]

◆ bufferedAccumulator() [3/3]

◆ ~bufferedAccumulator()

Member Function Documentation

◆ addToBuffers()

◆ averaged()

◆ resetAveraging()

◆ averagesTaken()

◆ nBuffers()

◆ bufferLength()

◆ bufferOffsets()

◆ setSizes()

◆ operator=()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ typeName