Vlasiator ebf0dd394 on dev (v5.4.0 + 1054 commits)
Loading...
Searching...
No Matches
DRO::MLPepochs Class Reference

#include <datareductionoperator.h>

Inheritance diagram for DRO::MLPepochs:
Collaboration diagram for DRO::MLPepochs:

Public Member Functions

 MLPepochs (cuint popID)
virtual ~MLPepochs ()
virtual bool getDataVectorInfo (std::string &dataType, unsigned int &dataSize, unsigned int &vectorSize) const
virtual std::string getName () const
virtual bool reduceData (const SpatialCell *cell, char *buffer)
virtual bool setSpatialCell (const SpatialCell *cell)
virtual bool reduceDiagnostic (const SpatialCell *cell, Real *buffer)
Public Member Functions inherited from DRO::DataReductionOperator
 DataReductionOperator ()
virtual ~DataReductionOperator ()
virtual bool getUnitMetadata (std::string &_unit, std::string &_unitLaTeX, std::string &_variableLaTeX, std::string &_unitConversion)
virtual bool setUnitMetadata (std::string &_unit, std::string &_unitLaTeX, std::string &_variableLaTeX, std::string &_unitConversion)

Protected Attributes

uint32_t epochs
uint popID
std::string popName
Protected Attributes inherited from DRO::DataReductionOperator
std::string unit
std::string unitLaTeX
std::string variableLaTeX
std::string unitConversion

Detailed Description

Definition at line 231 of file datareductionoperator.h.

Constructor & Destructor Documentation

◆ MLPepochs()

DRO::MLPepochs::MLPepochs ( cuint popID)

Definition at line 512 of file datareductionoperator.cpp.

Here is the call graph for this function:

◆ ~MLPepochs()

DRO::MLPepochs::~MLPepochs ( )
virtual

Definition at line 515 of file datareductionoperator.cpp.

Member Function Documentation

◆ getDataVectorInfo()

bool DRO::MLPepochs::getDataVectorInfo ( std::string & dataType,
unsigned int & dataSize,
unsigned int & vectorSize ) const
virtual

Implements DRO::DataReductionOperator.

Definition at line 525 of file datareductionoperator.cpp.

◆ getName()

std::string DRO::MLPepochs::getName ( ) const
virtual

Implements DRO::DataReductionOperator.

Definition at line 517 of file datareductionoperator.cpp.

◆ reduceData()

bool DRO::MLPepochs::reduceData ( const SpatialCell * cell,
char * buffer )
virtual

Reduce the data and write the data vector to the given vlsv output buffer.

Parameters
cellthe SpatialCell to reduce data out of
bufferBuffer in which the reduced data is written.
Returns
If true, DataReductionOperator reduced data successfully.

Reimplemented from DRO::DataReductionOperator.

Definition at line 519 of file datareductionoperator.cpp.

◆ reduceDiagnostic()

bool DRO::MLPepochs::reduceDiagnostic ( const SpatialCell * cell,
Real * result )
virtual

Reduce the data and write the data vector to the given variable. If the vector length is larger than one, memory gets corrupted. Note that this function is only used for writing into diagnostic files.

Parameters
cellthe SpatialCell to reduce data out of
bufferBuffer in which the reduced data is written.
Returns
If true, DataReductionOperator reduced data successfully.

Reimplemented from DRO::DataReductionOperator.

Definition at line 532 of file datareductionoperator.cpp.

◆ setSpatialCell()

bool DRO::MLPepochs::setSpatialCell ( const SpatialCell * cell)
virtual

Implements DRO::DataReductionOperator.

Definition at line 537 of file datareductionoperator.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ epochs

uint32_t DRO::MLPepochs::epochs
protected

Definition at line 242 of file datareductionoperator.h.

◆ popID

uint DRO::MLPepochs::popID
protected

Definition at line 243 of file datareductionoperator.h.

◆ popName

std::string DRO::MLPepochs::popName
protected

Definition at line 244 of file datareductionoperator.h.


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