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

#include <datareductionoperator.h>

Inheritance diagram for DRO::VariablePrecipitationDiffFlux:
Collaboration diagram for DRO::VariablePrecipitationDiffFlux:

Public Member Functions

 VariablePrecipitationDiffFlux (cuint popID)
 Precipitation directional differential number flux (within loss cone) Evaluation of the precipitating differential flux (per population). In a selected number (default: 16) of logarithmically spaced energy bins, the average of V*V/mass is calculated within the loss cone of fixed angular opening (default: 10 deg). The differential flux is converted in part. / cm^2 / s / sr / eV (unit used by observers). Parameters that can be set in cfg file under [{species}_precipitation]: nChannels, emin [eV], emax [eV], lossConeAngle [deg] The energy channels are saved in bulk files as PrecipitationCentreEnergy{channel_number}.
virtual ~VariablePrecipitationDiffFlux ()
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
int nChannels
Real emin
Real emax
Real lossConeAngle
std::vector< Realchannels
std::vector< RealdataDiffFlux
Protected Attributes inherited from DRO::DataReductionOperator
std::string unit
std::string unitLaTeX
std::string variableLaTeX
std::string unitConversion

Detailed Description

Definition at line 577 of file datareductionoperator.h.

Constructor & Destructor Documentation

◆ VariablePrecipitationDiffFlux()

DRO::VariablePrecipitationDiffFlux::VariablePrecipitationDiffFlux ( cuint popID)

Precipitation directional differential number flux (within loss cone) Evaluation of the precipitating differential flux (per population). In a selected number (default: 16) of logarithmically spaced energy bins, the average of V*V/mass is calculated within the loss cone of fixed angular opening (default: 10 deg). The differential flux is converted in part. / cm^2 / s / sr / eV (unit used by observers). Parameters that can be set in cfg file under [{species}_precipitation]: nChannels, emin [eV], emax [eV], lossConeAngle [deg] The energy channels are saved in bulk files as PrecipitationCentreEnergy{channel_number}.

Definition at line 1381 of file datareductionoperator.cpp.

Here is the call graph for this function:

◆ ~VariablePrecipitationDiffFlux()

DRO::VariablePrecipitationDiffFlux::~VariablePrecipitationDiffFlux ( )
virtual

Definition at line 1391 of file datareductionoperator.cpp.

Member Function Documentation

◆ getDataVectorInfo()

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

Implements DRO::DataReductionOperator.

Definition at line 1395 of file datareductionoperator.cpp.

◆ getName()

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

Implements DRO::DataReductionOperator.

Definition at line 1393 of file datareductionoperator.cpp.

◆ reduceData()

bool DRO::VariablePrecipitationDiffFlux::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 1402 of file datareductionoperator.cpp.

Here is the call graph for this function:

◆ setSpatialCell()

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

Implements DRO::DataReductionOperator.

Definition at line 1491 of file datareductionoperator.cpp.

◆ writeParameters()

bool DRO::VariablePrecipitationDiffFlux::writeParameters ( vlsv::Writer & vlsvWriter)
virtual

Member Data Documentation

◆ channels

std::vector<Real> DRO::VariablePrecipitationDiffFlux::channels
protected

Definition at line 594 of file datareductionoperator.h.

◆ dataDiffFlux

std::vector<Real> DRO::VariablePrecipitationDiffFlux::dataDiffFlux
protected

Definition at line 594 of file datareductionoperator.h.

◆ emax

Real DRO::VariablePrecipitationDiffFlux::emax
protected

Definition at line 592 of file datareductionoperator.h.

◆ emin

Real DRO::VariablePrecipitationDiffFlux::emin
protected

Definition at line 592 of file datareductionoperator.h.

◆ lossConeAngle

Real DRO::VariablePrecipitationDiffFlux::lossConeAngle
protected

Definition at line 593 of file datareductionoperator.h.

◆ nChannels

int DRO::VariablePrecipitationDiffFlux::nChannels
protected

Definition at line 591 of file datareductionoperator.h.

◆ popID

uint DRO::VariablePrecipitationDiffFlux::popID
protected

Definition at line 589 of file datareductionoperator.h.

◆ popName

std::string DRO::VariablePrecipitationDiffFlux::popName
protected

Definition at line 590 of file datareductionoperator.h.


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