Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
bufferedAccumulator< Type > Class Template Reference

Public Types

typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 

Public Member Functions

 bufferedAccumulator ()
 Construct null. More...
 
 bufferedAccumulator (const label nBuffers, const label bufferLength, const label bufferingInterval)
 Construct from components. More...
 
 bufferedAccumulator (const bufferedAccumulator< Type > &)
 Construct as copy. More...
 
 ~bufferedAccumulator ()
 Destructor. More...
 
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 > &)
 

Static Public Attributes

static const char *const typeName
 

Friends

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

Detailed Description

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

Source files

Definition at line 48 of file bufferedAccumulator.H.

Member Typedef Documentation

◆ cmptType

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 85 of file bufferedAccumulator.H.

Constructor & Destructor Documentation

◆ bufferedAccumulator() [1/3]

bufferedAccumulator ( )

Construct null.

Definition at line 56 of file bufferedAccumulator.C.

◆ bufferedAccumulator() [2/3]

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

Construct from components.

Definition at line 66 of file bufferedAccumulator.C.

◆ bufferedAccumulator() [3/3]

bufferedAccumulator ( const bufferedAccumulator< Type > &  bA)

Construct as copy.

Definition at line 87 of file bufferedAccumulator.C.

◆ ~bufferedAccumulator()

~bufferedAccumulator ( )

Destructor.

Definition at line 100 of file bufferedAccumulator.C.

Member Function Documentation

◆ addToBuffers()

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

Definition at line 134 of file bufferedAccumulator.C.

References Foam::abort(), Foam::constant::physicoChemical::b, Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ averaged()

Foam::Field< Type > averaged ( ) const

Definition at line 177 of file bufferedAccumulator.C.

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

Here is the call graph for this function:

◆ resetAveraging()

void resetAveraging ( )

Definition at line 199 of file bufferedAccumulator.C.

References Foam::Zero.

◆ averagesTaken()

label averagesTaken ( ) const
inline

Definition at line 50 of file bufferedAccumulatorI.H.

◆ nBuffers()

label nBuffers ( ) const
inline

Definition at line 57 of file bufferedAccumulatorI.H.

◆ bufferLength()

label bufferLength ( ) const
inline

Definition at line 64 of file bufferedAccumulatorI.H.

◆ bufferOffsets()

const List< label > & bufferOffsets ( ) const
inline

Definition at line 71 of file bufferedAccumulatorI.H.

◆ setSizes()

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

Definition at line 108 of file bufferedAccumulator.C.

References Foam::constant::physicoChemical::b, forAll, and Foam::Zero.

◆ operator=()

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

Definition at line 211 of file bufferedAccumulator.C.

Friends And Related Function Documentation

◆ operator

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

Member Data Documentation

◆ typeName

const char *const typeName
static

Definition at line 90 of file bufferedAccumulator.H.

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