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

#include <datareductionoperator.h>

Inheritance diagram for DRO::DiagnosticFluxB:
Collaboration diagram for DRO::DiagnosticFluxB:

Public Member Functions

 DiagnosticFluxB ()
virtual ~DiagnosticFluxB ()
virtual bool getDataVectorInfo (std::string &dataType, unsigned int &dataSize, unsigned int &vectorSize) const
virtual std::string getName () const
virtual bool reduceDiagnostic (const SpatialCell *cell, Real *result)
virtual bool setSpatialCell (const SpatialCell *cell)
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)
virtual bool reduceData (const SpatialCell *cell, char *buffer)

Additional Inherited Members

Protected Attributes inherited from DRO::DataReductionOperator
std::string unit
std::string unitLaTeX
std::string variableLaTeX
std::string unitConversion

Detailed Description

Definition at line 372 of file datareductionoperator.h.

Constructor & Destructor Documentation

◆ DiagnosticFluxB()

DRO::DiagnosticFluxB::DiagnosticFluxB ( )

◆ ~DiagnosticFluxB()

virtual DRO::DiagnosticFluxB::~DiagnosticFluxB ( )
virtual

Member Function Documentation

◆ getDataVectorInfo()

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

◆ getName()

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

◆ reduceDiagnostic()

virtual bool DRO::DiagnosticFluxB::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.

◆ setSpatialCell()

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

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