vf::gpu::PlanarAverageProbe Class Reference

Computes spatial statistics across x, y or z-normal planes defined by planeNormal. The planes include all points of the domain at each respective position along that normal direction. The spatial statistics can additionally be averaged in time. The name phi is used to denote the scalar field. More...

#include <PlanarAverageProbe.h>

Inheritance diagram for vf::gpu::PlanarAverageProbe:

Classes
struct	LevelData

Public Types
enum class	Statistic { Means , Covariances , Skewness , Flatness }

Public Member Functions
	PlanarAverageProbe (SPtr< Parameter > para, SPtr< CudaMemoryManager > cudaMemoryManager, const std::string &outputPath, const std::string &probeName, uint tStartSampling, uint tStartTemporalAveraging, uint tBetweenSamples, uint tStartWritingOutput, uint tBetweenWriting, Axis planeNormal, bool computeTimeAverages, bool sampleScalar=false, bool sampleSubgridScaleFluxes=false)
	~PlanarAverageProbe () override
void	init () override
void	sample (int level, uint t) override
void	getTaggedFluidNodes (GridProvider *) override
LevelData *	getLevelData (int level)
void	addAllAvailableStatistics ()
void	addStatistic (Statistic statistic)
void	setFileNameToNOut ()
bool	getSampleScalar () const
Public Member Functions inherited from vf::gpu::Sampler
	Sampler (const std::string outputPath, const std::string probeName)
virtual	~Sampler ()=default

Additional Inherited Members
Protected Attributes inherited from vf::gpu::Sampler
std::string	outputPath
std::string	probeName

Detailed Description

Computes spatial statistics across x, y or z-normal planes defined by planeNormal. The planes include all points of the domain at each respective position along that normal direction. The spatial statistics can additionally be averaged in time. The name phi is used to denote the scalar field.

Definition at line 58 of file PlanarAverageProbe.h.

Member Enumeration Documentation

Statistic

enum class vf::gpu::PlanarAverageProbe::Statistic

strong

Enumerator
Means
Covariances
Skewness
Flatness

Definition at line 61 of file PlanarAverageProbe.h.

Constructor & Destructor Documentation

PlanarAverageProbe()

vf::gpu::PlanarAverageProbe::PlanarAverageProbe ( SPtr< Parameter >  para, SPtr< CudaMemoryManager >  cudaMemoryManager, const std::string &  outputPath, const std::string &  probeName, uint  tStartSampling, uint  tStartTemporalAveraging, uint  tBetweenSamples, uint  tStartWritingOutput, uint  tBetweenWriting, Axis  planeNormal, bool  computeTimeAverages, bool  sampleScalar = false, bool  sampleSubgridScaleFluxes = false  )

inline

Parameters

tStartSampling	The first timestep at which the probe samples planar averages.
tStartTemporalAveraging	The first timestep at which temporal averaging starts.
tBetweenSamples	The number of timesteps between samples.
tStartWritingOutput	The first timestep at which the probe writes output.
tBetweenWriting	The number of timesteps between writing output.
planeNormal	The normal direction of the planes along which the probe samples.
computeTimeAverages	If true, the probe computes time averages.
sampleScalar	If true, the probe samples statistics related to the scalar.
sampleSubgridScaleFluxes	If true, the probe samples sub-gridscale fluxes.

Definition at line 79 of file PlanarAverageProbe.h.

~PlanarAverageProbe()

vf::gpu::PlanarAverageProbe::~PlanarAverageProbe ( )

override

Member Function Documentation

addAllAvailableStatistics()

void vf::gpu::PlanarAverageProbe::addAllAvailableStatistics ( )

inline

Definition at line 114 of file PlanarAverageProbe.h.

addStatistic()

void vf::gpu::PlanarAverageProbe::addStatistic

(

Statistic

statistic

)

getLevelData()

LevelData * vf::gpu::PlanarAverageProbe::getLevelData ( int  level )

inline

Definition at line 110 of file PlanarAverageProbe.h.

getSampleScalar()

bool vf::gpu::PlanarAverageProbe::getSampleScalar ( ) const

inline

Definition at line 126 of file PlanarAverageProbe.h.

getTaggedFluidNodes()

void vf::gpu::PlanarAverageProbe::getTaggedFluidNodes ( GridProvider *  )

inlineoverridevirtual

Implements vf::gpu::Sampler.

Definition at line 109 of file PlanarAverageProbe.h.

init()

void vf::gpu::PlanarAverageProbe::init ( )

overridevirtual

Implements vf::gpu::Sampler.

sample()

void vf::gpu::PlanarAverageProbe::sample ( int  level, uint  t  )

overridevirtual

Implements vf::gpu::Sampler.

setFileNameToNOut()

void vf::gpu::PlanarAverageProbe::setFileNameToNOut ( )

inline

Definition at line 122 of file PlanarAverageProbe.h.

---

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

• src/gpu/core/Samplers/PlanarAverageProbe.h