vf::gpu::PrecursorWriter Class Reference

Probe writing planes of data to be used as inflow data in successor simulation using PrecursorBC The probe writes out yz-planes at a specific x position (. More...

#include <PrecursorWriter.h>

Inheritance diagram for vf::gpu::PrecursorWriter:

Classes
struct	PrecursorStruct

Public Types
enum class	OutputVariable { Velocities , Distributions }
enum class	OutputVariableTemperature { Temperature , Distributions }

Public Member Functions
	PrecursorWriter (SPtr< Parameter > para, SPtr< CudaMemoryManager > cudaMemoryManager, const std::string &outputPath, const std::string &probeName, real xPos, real yMin, real yMax, real zMin, real zMax, uint tStartWritingOutput, uint tSave, OutputVariable outputVariable, uint maxTimestepsPerFile=uint(1e4))
	PrecursorWriter (SPtr< Parameter > para, SPtr< CudaMemoryManager > cudaMemoryManager, const std::string &outputPath, const std::string &probeName, real xPos, real yMin, real yMax, real zMin, real zMax, uint tStartWritingOutput, uint tSave, OutputVariable outputVariable, OutputVariableTemperature tempOutputVariable, uint maxTimestepsPerFile=uint(1e4))
	~PrecursorWriter ()
void	init () override
void	sample (int level, uint t) override
void	getTaggedFluidNodes (GridProvider *gridProvider) override
OutputVariable	getOutputVariable ()
OutputVariableTemperature	getTempOutputVariable ()
PrecursorStruct *	getPrecursorStruct (int level)
std::string	makeFileName (int level, uint numberOfFilesWritten)
void	setWritePrecision (uint writePrecision)
Public Member Functions inherited from vf::gpu::Sampler
	Sampler (const std::string outputPath, const std::string probeName)
virtual	~Sampler ()=default

Static Public Attributes
static constexpr uint	dP00 = 0
static constexpr uint	dPP0 = 1
static constexpr uint	dPM0 = 2
static constexpr uint	dP0P = 3
static constexpr uint	dP0M = 4
static constexpr uint	dPPP = 5
static constexpr uint	dPMP = 6
static constexpr uint	dPPM = 7
static constexpr uint	dPMM = 8

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

Detailed Description

Probe writing planes of data to be used as inflow data in successor simulation using PrecursorBC The probe writes out yz-planes at a specific x position (.

Parameters

xPos	) of either velocity or distributions that can be read by PrecursorBC as inflow data.

Definition at line 61 of file PrecursorWriter.h.

Member Enumeration Documentation

OutputVariable

enum class vf::gpu::PrecursorWriter::OutputVariable

strong

Enumerator
Velocities
Distributions

Definition at line 64 of file PrecursorWriter.h.

OutputVariableTemperature

enum class vf::gpu::PrecursorWriter::OutputVariableTemperature

strong

Enumerator
Temperature
Distributions

Definition at line 65 of file PrecursorWriter.h.

Constructor & Destructor Documentation

PrecursorWriter() [1/2]

vf::gpu::PrecursorWriter::PrecursorWriter ( SPtr< Parameter >  para, SPtr< CudaMemoryManager >  cudaMemoryManager, const std::string &  outputPath, const std::string &  probeName, real  xPos, real  yMin, real  yMax, real  zMin, real  zMax, uint  tStartWritingOutput, uint  tSave, OutputVariable  outputVariable, uint  maxTimestepsPerFile = uint(1e4)  )

inline

Definition at line 67 of file PrecursorWriter.h.

PrecursorWriter() [2/2]

vf::gpu::PrecursorWriter::PrecursorWriter ( SPtr< Parameter >  para, SPtr< CudaMemoryManager >  cudaMemoryManager, const std::string &  outputPath, const std::string &  probeName, real  xPos, real  yMin, real  yMax, real  zMin, real  zMax, uint  tStartWritingOutput, uint  tSave, OutputVariable  outputVariable, OutputVariableTemperature  tempOutputVariable, uint  maxTimestepsPerFile = uint(1e4)  )

inline

Definition at line 79 of file PrecursorWriter.h.

~PrecursorWriter()

vf::gpu::PrecursorWriter::~PrecursorWriter

(

)

Member Function Documentation

getOutputVariable()

OutputVariable vf::gpu::PrecursorWriter::getOutputVariable ( )

inline

Definition at line 98 of file PrecursorWriter.h.

getPrecursorStruct()

PrecursorStruct * vf::gpu::PrecursorWriter::getPrecursorStruct ( int  level )

inline

Definition at line 121 of file PrecursorWriter.h.

getTaggedFluidNodes()

void vf::gpu::PrecursorWriter::getTaggedFluidNodes ( GridProvider *  gridProvider )

overridevirtual

Implements vf::gpu::Sampler.

getTempOutputVariable()

OutputVariableTemperature vf::gpu::PrecursorWriter::getTempOutputVariable ( )

inline

Definition at line 102 of file PrecursorWriter.h.

init()

void vf::gpu::PrecursorWriter::init ( )

overridevirtual

Implements vf::gpu::Sampler.

makeFileName()

std::string vf::gpu::PrecursorWriter::makeFileName	(	int	level,
		uint	numberOfFilesWritten
	)

sample()

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

overridevirtual

Implements vf::gpu::Sampler.

setWritePrecision()

void vf::gpu::PrecursorWriter::setWritePrecision ( uint  writePrecision )

inline

Definition at line 127 of file PrecursorWriter.h.

Member Data Documentation

dP00

constexpr uint vf::gpu::PrecursorWriter::dP00 = 0

staticconstexpr

Definition at line 132 of file PrecursorWriter.h.

dP0M

constexpr uint vf::gpu::PrecursorWriter::dP0M = 4

staticconstexpr

Definition at line 136 of file PrecursorWriter.h.

dP0P

constexpr uint vf::gpu::PrecursorWriter::dP0P = 3

staticconstexpr

Definition at line 135 of file PrecursorWriter.h.

dPM0

constexpr uint vf::gpu::PrecursorWriter::dPM0 = 2

staticconstexpr

Definition at line 134 of file PrecursorWriter.h.

dPMM

constexpr uint vf::gpu::PrecursorWriter::dPMM = 8

staticconstexpr

Definition at line 140 of file PrecursorWriter.h.

dPMP

constexpr uint vf::gpu::PrecursorWriter::dPMP = 6

staticconstexpr

Definition at line 138 of file PrecursorWriter.h.

dPP0

constexpr uint vf::gpu::PrecursorWriter::dPP0 = 1

staticconstexpr

Definition at line 133 of file PrecursorWriter.h.

dPPM

constexpr uint vf::gpu::PrecursorWriter::dPPM = 7

staticconstexpr

Definition at line 139 of file PrecursorWriter.h.

dPPP

constexpr uint vf::gpu::PrecursorWriter::dPPP = 5

staticconstexpr

Definition at line 137 of file PrecursorWriter.h.

---

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

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