DRO::VariableEnergyDensity Class Reference

#include <datareductionoperator.h>

Inheritance diagram for DRO::VariableEnergyDensity:

Collaboration diagram for DRO::VariableEnergyDensity:

Public Member Functions
	VariableEnergyDensity (cuint popID)
	Energy density Calculates the energy density of particles in three bins: total energy density, above E1limit*solar wind energy, and above E2limit*solar wind energy Energy densities are given in eV/cm^3. Parameters that can be set in cfg file under [{species}_energydensity]:
virtual	~VariableEnergyDensity ()
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	writeParameters (vlsv::Writer &vlsvWriter)
Public Member Functions inherited from DRO::DataReductionOperatorHasParameters
	DataReductionOperatorHasParameters ()
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	reduceDiagnostic (const SpatialCell *cell, Real *result)

Protected Attributes
uint	popID
std::string	popName
Real	EDensity [3]
Real	solarwindenergy
Real	E1limit
Real	E2limit
Protected Attributes inherited from DRO::DataReductionOperator
std::string	unit
std::string	unitLaTeX
std::string	variableLaTeX
std::string	unitConversion

Detailed Description

Definition at line 556 of file datareductionoperator.h.

Constructor & Destructor Documentation

VariableEnergyDensity()

DRO::VariableEnergyDensity::VariableEnergyDensity

(

cuint

_popID

)

Energy density Calculates the energy density of particles in three bins: total energy density, above E1limit*solar wind energy, and above E2limit*solar wind energy Energy densities are given in eV/cm^3. Parameters that can be set in cfg file under [{species}_energydensity]:

• solarwindspeed [m/s],
• solarwindenergy [eV],
• limit1 [scalar, default: 5.],
• limit2 [scalar, default: 10.]. The energy thresholds are saved in bulk files as parameters:
• EnergyDensityESW (in eV),
• EnergyDensityELimit1 (as scalar multiplier of EnergyDensityESW),
• EnergyDensityELimit2 (as scalar multiplier of EnergyDensityESW).

Definition at line 1738 of file datareductionoperator.cpp.

Here is the call graph for this function:

~VariableEnergyDensity()

DRO::VariableEnergyDensity::~VariableEnergyDensity ( )

virtual

Definition at line 1745 of file datareductionoperator.cpp.

Member Function Documentation

getDataVectorInfo()

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

virtual

Implements DRO::DataReductionOperator.

Definition at line 1749 of file datareductionoperator.cpp.

getName()

std::string DRO::VariableEnergyDensity::getName ( ) const

virtual

Implements DRO::DataReductionOperator.

Definition at line 1747 of file datareductionoperator.cpp.

reduceData()

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

Definition at line 1756 of file datareductionoperator.cpp.

Here is the call graph for this function:

setSpatialCell()

bool DRO::VariableEnergyDensity::setSpatialCell ( const SpatialCell * cell )

virtual

Implements DRO::DataReductionOperator.

Definition at line 1807 of file datareductionoperator.cpp.

writeParameters()

bool DRO::VariableEnergyDensity::writeParameters ( vlsv::Writer & vlsvWriter )

virtual

Implements DRO::DataReductionOperatorHasParameters.

Definition at line 1814 of file datareductionoperator.cpp.

Here is the call graph for this function:

Member Data Documentation

E1limit

Real DRO::VariableEnergyDensity::E1limit

protected

Definition at line 572 of file datareductionoperator.h.

E2limit

Real DRO::VariableEnergyDensity::E2limit

protected

Definition at line 573 of file datareductionoperator.h.

EDensity

Real DRO::VariableEnergyDensity::EDensity[3]

protected

Definition at line 570 of file datareductionoperator.h.

popID

uint DRO::VariableEnergyDensity::popID

protected

Definition at line 568 of file datareductionoperator.h.

popName

std::string DRO::VariableEnergyDensity::popName

protected

Definition at line 569 of file datareductionoperator.h.

solarwindenergy

Real DRO::VariableEnergyDensity::solarwindenergy

protected

Definition at line 571 of file datareductionoperator.h.

---

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

• datareduction/datareductionoperator.h
• datareduction/datareductionoperator.cpp