#include <datareductionoperator.h>

Inheritance diagram for DRO::DataReductionOperator:

[legend]

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

Protected Attributes
std::string	unit
std::string	unitLaTeX
std::string	variableLaTeX
std::string	unitConversion

Detailed Description

DRO::DataReductionOperator defines a base class for reducing simulation data (six-dimensional distribution function) into more compact variables, e.g. scalar fields, which can be written into file(s) and visualized.

The intention is that each DRO::DataReductionOperator stores the reduced data into internal variables, whose values are written into a byte array when DRO::DataReductionOperator::appendReducedData is called.

If needed, a user can write his or her own DRO::DataReductionOperators, which are loaded when the simulation initializes.

Datareduction oeprators are not thread-safe, some of the more intensive ones are threaded within.

Definition at line 54 of file datareductionoperator.h.

Constructor & Destructor Documentation

◆ DataReductionOperator()

DRO::DataReductionOperator::DataReductionOperator ( )

DataReductionOperator base class constructor. The constructor is empty.

Definition at line 44 of file datareductionoperator.cpp.

Here is the caller graph for this function:

◆ ~DataReductionOperator()

DRO::DataReductionOperator::~DataReductionOperator ( )

virtual

DataReductionOperator base class virtual destructor. The destructor is empty.

Definition at line 47 of file datareductionoperator.cpp.

Member Function Documentation

◆ getDataVectorInfo()

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

pure virtual

Implemented in DRO::Blocks, DRO::BoundaryLayer, DRO::BoundaryType, DRO::DataReductionOperatorCellParams, DRO::DataReductionOperatorFsGrid, DRO::DataReductionOperatorIonosphereElement, DRO::DataReductionOperatorIonosphereNode, DRO::DataReductionOperatorIonosphereNodeInt, DRO::DataReductionOperatorMPIGridCell, DRO::DataReductionOperatorPopulations< T >, DRO::DataReductionOperatorPopulations< T >, DRO::DataReductionOperatorPopulations< T >, DRO::DataReductionOperatorPopulations< T >, DRO::DiagnosticFluxB, DRO::DiagnosticFluxE, DRO::MLPepochs, DRO::MLPerror, DRO::MPIrank, DRO::VariableBVol, DRO::VariableEffectiveSparsityThreshold, DRO::VariableEnergyDensity, DRO::VariableHeatFluxVector, DRO::VariableMuSpace, DRO::VariableNonMaxwellianity, DRO::VariablePrecipitationDiffFlux, DRO::VariablePrecipitationLineDiffFlux, DRO::VariablePressureSolver, DRO::VariablePTensorDiagonal, DRO::VariablePTensorNonthermalDiagonal, DRO::VariablePTensorNonthermalOffDiagonal, DRO::VariablePTensorOffDiagonal, DRO::VariablePTensorThermalDiagonal, DRO::VariablePTensorThermalOffDiagonal, DRO::VariableRhoNonthermal, DRO::VariableRhoThermal, DRO::VariableVNonthermal, and DRO::VariableVThermal.

◆ getName()

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

pure virtual

Implemented in DRO::Blocks, DRO::BoundaryLayer, DRO::BoundaryType, DRO::DataReductionOperatorCellParams, DRO::DataReductionOperatorFsGrid, DRO::DataReductionOperatorIonosphereElement, DRO::DataReductionOperatorIonosphereNode, DRO::DataReductionOperatorIonosphereNodeInt, DRO::DataReductionOperatorMPIGridCell, DRO::DataReductionOperatorPopulations< T >, DRO::DiagnosticFluxB, DRO::DiagnosticFluxE, DRO::MLPepochs, DRO::MLPerror, DRO::MPIrank, DRO::VariableBVol, DRO::VariableEffectiveSparsityThreshold, DRO::VariableEnergyDensity, DRO::VariableHeatFluxVector, DRO::VariableMuSpace, DRO::VariableNonMaxwellianity, DRO::VariablePrecipitationDiffFlux, DRO::VariablePrecipitationLineDiffFlux, DRO::VariablePressureSolver, DRO::VariablePTensorDiagonal, DRO::VariablePTensorNonthermalDiagonal, DRO::VariablePTensorNonthermalOffDiagonal, DRO::VariablePTensorOffDiagonal, DRO::VariablePTensorThermalDiagonal, DRO::VariablePTensorThermalOffDiagonal, DRO::VariableRhoNonthermal, DRO::VariableRhoThermal, DRO::VariableVNonthermal, and DRO::VariableVThermal.

Here is the caller graph for this function:

◆ getUnitMetadata()

virtual bool DRO::DataReductionOperator::getUnitMetadata	(	std::string &	_unit,
		std::string &	_unitLaTeX,
		std::string &	_variableLaTeX,
		std::string &	_unitConversion )

inlinevirtual

Definition at line 60 of file datareductionoperator.h.

◆ reduceData()

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

virtual

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

Parameters

cell	the SpatialCell to reduce data out of
buffer	Buffer in which the reduced data is written.

Returns: If true, DataReductionOperator reduced data successfully.

Reimplemented in DRO::Blocks, DRO::BoundaryLayer, DRO::BoundaryType, DRO::DataReductionOperatorCellParams, DRO::DataReductionOperatorFsGrid, DRO::DataReductionOperatorIonosphereElement, DRO::DataReductionOperatorIonosphereNode, DRO::DataReductionOperatorIonosphereNodeInt, DRO::DataReductionOperatorMPIGridCell, DRO::DataReductionOperatorPopulations< T >, DRO::MLPepochs, DRO::MLPerror, DRO::MPIrank, DRO::VariableBVol, DRO::VariableEffectiveSparsityThreshold, DRO::VariableEnergyDensity, DRO::VariableHeatFluxVector, DRO::VariableMuSpace, DRO::VariableNonMaxwellianity, DRO::VariablePrecipitationDiffFlux, DRO::VariablePrecipitationLineDiffFlux, DRO::VariablePressureSolver, DRO::VariablePTensorDiagonal, DRO::VariablePTensorNonthermalDiagonal, DRO::VariablePTensorNonthermalOffDiagonal, DRO::VariablePTensorOffDiagonal, DRO::VariablePTensorThermalDiagonal, DRO::VariablePTensorThermalOffDiagonal, DRO::VariableRhoNonthermal, DRO::VariableRhoThermal, DRO::VariableVNonthermal, and DRO::VariableVThermal.

Definition at line 54 of file datareductionoperator.cpp.

Here is the call graph for this function:

◆ reduceDiagnostic()

bool DRO::DataReductionOperator::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

cell	the SpatialCell to reduce data out of
buffer	Buffer in which the reduced data is written.

Returns: If true, DataReductionOperator reduced data successfully.

Reimplemented in DRO::Blocks, DRO::DataReductionOperatorCellParams, DRO::DataReductionOperatorFsGrid, DRO::DataReductionOperatorIonosphereElement, DRO::DataReductionOperatorIonosphereNode, DRO::DataReductionOperatorIonosphereNodeInt, DRO::DataReductionOperatorMPIGridCell, DRO::DataReductionOperatorPopulations< T >, DRO::DiagnosticFluxB, DRO::DiagnosticFluxE, DRO::MLPepochs, DRO::MLPerror, and DRO::VariableEffectiveSparsityThreshold.

Definition at line 68 of file datareductionoperator.cpp.

Here is the call graph for this function:

◆ setSpatialCell()

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

pure virtual

◆ setUnitMetadata()

virtual bool DRO::DataReductionOperator::setUnitMetadata	(	std::string &	_unit,
		std::string &	_unitLaTeX,
		std::string &	_variableLaTeX,
		std::string &	_unitConversion )

inlinevirtual

Definition at line 67 of file datareductionoperator.h.

Member Data Documentation

◆ unit

std::string DRO::DataReductionOperator::unit

protected

Definition at line 81 of file datareductionoperator.h.

◆ unitConversion

std::string DRO::DataReductionOperator::unitConversion

protected

Definition at line 84 of file datareductionoperator.h.

◆ unitLaTeX

std::string DRO::DataReductionOperator::unitLaTeX

protected

Definition at line 82 of file datareductionoperator.h.

◆ variableLaTeX

std::string DRO::DataReductionOperator::variableLaTeX

protected

Definition at line 83 of file datareductionoperator.h.

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

datareduction/datareductionoperator.h
datareduction/datareductionoperator.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DataReductionOperator()

◆ ~DataReductionOperator()

Member Function Documentation

◆ getDataVectorInfo()

◆ getName()

◆ getUnitMetadata()

◆ reduceData()

◆ reduceDiagnostic()

◆ setSpatialCell()

◆ setUnitMetadata()

Member Data Documentation

◆ unit

◆ unitConversion

◆ unitLaTeX

◆ variableLaTeX