Printing results for a probe in flow. More...

#include <OutputProbeGNU.h>

Collaboration diagram for OutputProbeGNU:

Public Member Functions
	OutputProbeGNU (std::string casTest, std::string run, tinyxml2::XMLElement element, std::string fileName, Input entree)
	Probe output constructor from a XML format reading.
	~OutputProbeGNU () override
void	probeDisplacement (const double &dt) override
void	locateProbeInMesh (const TypeMeshContainer< Cell * > &cells, const int &nbCells, bool localSeeking=false) override
Cell *	locateProbeInAMRSubMesh (std::vector< Cell * > *cells, const int &nbCells) override
void	initializeSpecificOutput () override
void	writeResults (Mesh , std::vector< Cell > *) override
void	initializeOutputInfos () override
void	writeInfos () override
double	getNextTime () override
bool	possesses () override
Public Member Functions inherited from OutputGNU
	OutputGNU ()
	Default constructor for specific output without specific needs.
	OutputGNU (std::string casTest, std::string run, tinyxml2::XMLElement element, std::string fileName, Input entree)
	Main constructor for datasets.
	OutputGNU (tinyxml2::XMLElement *element)
	Constructor for specific derived GNU outputs (boundary, probe, cut).
	~OutputGNU () override
void	initializeSpecificOutput (std::vector< CellInterface * > *) override
void	writeResults (std::vector< CellInterface * > *) override
Public Member Functions inherited from Output
	Output ()
	Default constructor for specific output without specific needs.
	Output (std::string casTest, std::string nameRun, tinyxml2::XMLElement element, std::string fileName, Input entree)
	Main constructor for datasets used for OutputVTK and OutputGNU according to outputMode.
	Output (std::string nameRun, int fileNumberRestartMeshMapping, Input *input)
	Constructor for datasets used for OutputVTK when mesh mapping restart option is activated.
	Output (tinyxml2::XMLElement *element)
	Constructor for specific derived GNU outputs (boundary, probe, cut).
virtual	~Output ()
void	copyInputFiles () const
void	initializeOutput (const Cell &cell)
void	initializeOutput (std::vector< CellInterface * > *cellInterfacesLvl)
	To initialize OutputBoundaryMassflowGNU.
void	initializeOutputMeshMapping (const Cell &cell)
	To initialize output for Mesh Mapping Restart.
virtual void	printTree (Mesh mesh, const std::vector< Cell > *cellsLvl, int m_resumeAMRsaveFreq) const
	Write 'meshInfo' file that stores for each cell its subdivision status (1 if subdivided, 0 if not).
virtual void	writeProgress ()
void	readInfos ()
	Currently only used for OutputBoundaryMassflowGNU.
int	readNbCpu ()
	Read and return the number of cpu from the infoCalcul file of a performed simulation.
virtual void	readResults (Mesh , std::vector< Cell > *, int=-1)
	Read results of a previous simulation to resume from it.
void	readDomainDecompostion (Mesh *mesh)
virtual void	readTree (Mesh mesh, TypeMeshContainer< Cell > cellsLvl, TypeMeshContainer< Cell > cellsLvlGhost, TypeMeshContainer< CellInterface > cellInterfacesLvl, const std::vector< AddPhys > &addPhys, int &nbCellsTotalAMR)
	Read 'meshInfo' file that stores for each cell its subdivision status (1 if subdivided, 0 if not).
virtual void	prepareErrorFiles () const
virtual void	writeErrorInFile (std::vector< Errors > &v, const int &ErrorType, const int &iteration, bool &warn) const
void	readTree_common (Mesh mesh, TypeMeshContainer< Cell > cellsLvl, TypeMeshContainer< Cell > cellsLvlGhost, TypeMeshContainer< CellInterface > cellInterfacesLvl, const std::vector< AddPhys > &addPhys, int &lvl)
	Refine ghost cells, update of persistent communications of cells lvl + 1, reconstruct arrays of cells and cell interfaces of lvl + 1.
int	getNumFile () const
virtual const void *	getTransferMode () const
	Get m_transfer_mode field. For OutputVTKHDF derived class only.
const std::string &	getFolderOutput ()
const TypeOutput &	getType () const
bool	getReducedOutput () const
std::string	outputPhaseName (int phase, std::string phaseName, std::string &eosName) const

Private Attributes
double	m_acqFreq
	Acquisition time frequency.
double	m_nextAcq
	Next acquisition time.
Cell *	m_cell
	Pointer to the level 0 cell containing the probe.
Cell *	m_cellAMR
	Pointer to the most refined cell containing the probe.
GeometricObject *	m_objet
	To store position.
bool *	m_possessesProbe
	True if the CPU possesses probe.

Additional Inherited Members
Protected Member Functions inherited from OutputGNU
void	writeScriptGnuplot (const int &dim)
void	writeScriptGnuplotPDF (const int &dim)
void	writeScriptGnuplot (const std::string &varName)
std::string	createFilenameGNU (const char *name, int lvl=-1, int proc=-1, int numFichier=-1, std::string nameVariable="defaut") const
void	printBlocGnuplot (std::ofstream &fileStream, int &index, const int &dim, bool pause=true)
std::string	formatVarNameStyle (std::string const &strToFormat) const
Protected Member Functions inherited from Output
void	printWritingInfo () const
void	saveInfos () const
std::string	createFilename (const char *name, int lvl=-1, int proc=-1, int numFichier=-1) const
void	writeDataset (std::vector< double > dataset, std::ofstream &fileStream, TypeData typeData) const
void	getDataset (std::istringstream &data, std::vector< double > &dataset) const
Protected Attributes inherited from OutputGNU
std::string	m_fileNameVisu
std::string	m_fileNamePDF
std::string	m_folderScriptGnuplot
Protected Attributes inherited from Output
Input *	m_input
	Pointer to input.
Run *	m_run
	Pointer to run.
TypeOutput	m_type
	Type of output.
std::string	m_simulationName
	Test case name (defined in "main.xml").
std::string	m_infoCalcul
	Filename to save useful info of computation.
std::string	m_treeStructure
	Filename for tree structure backup.
std::string	m_domainDecomposition
	Filename for domain decomposition backup.
std::string	m_fileNameResults
	Filename of result file.
std::string	m_filenameCollectionParaview
	Name of the collection containing the results files (for Paraview).
std::string	m_filenameCollectionVisIt
	Name of the collection containing the results files (for VisIt).
std::string	m_filenameVTKHDFTimeseries
	Name of the timeseries file containing the list of result files at vtkhdf format (for Paraview).
std::string	m_folderOutput
	Folder to store results.
std::string	m_folderSavesInput
	Folder to store a copy of input files.
std::string	m_folderDatasets
	Folder to save the datasets.
std::string	m_folderInfoMesh
	Folder to store mesh info.
std::string	m_folderCuts
	Cuts results folder location.
std::string	m_folderProbes
	Probes results folder location.
std::string	m_folderGlobalQuantities
	Global quantity (e.g. mass) results folder location.
std::string	m_folderBoundaries
	Boundaries flux results folder location.
std::string	m_fileCollectionParaview
	Chemin du file collection regroupant les fichiers resultats (for Paraview).
std::string	m_fileCollectionVisIt
	Chemin du file collection regroupant les fichiers resultats (for VisIt).
std::string	m_folderErrorsAndWarnings
	File path for errors and warnings.
bool	m_writeBinary
	Choice to write binary/ASCII (available for GNU and VTK outputs, GNU format only supports ASCII).
bool	m_splitData
	Choice print data in separate files.
int	m_precision
	Output files precision (number of digits) for GNU and VTK outputs //default: 6.
bool	m_reducedOutput
	Choice of reduced number of output variables when possible (depends on the model).
int	m_numFile
std::string	m_endianMode
int	m_nbCpusRestarted
	Number of CPUs of the simulation to be restarted.
Cell	m_cellRef
	Reference cell to extract variables name.

Detailed Description

Printing results for a probe in flow.

Constructor & Destructor Documentation

◆ OutputProbeGNU()

OutputProbeGNU::OutputProbeGNU	(	std::string	casTest,
		std::string	run,
		tinyxml2::XMLElement *	element,
		std::string	fileName,
		Input *	entree )

Probe output constructor from a XML format reading.

Reading data from XML file under the following format: ex: <probe name="sensor1"> <vertex x = "0.3" y = "0.05" z = "0.05" / > <timeControl acqFreq = "1e-5." / > </probe>

Parameters

casTest	Folder name of test case input files
run	Resutls folder name (defined in 'main.xml')
element	XML element to read for probe data
fileName	string name of readed XML file
entree	Pointer to corresponding run entry object

Here is the call graph for this function:

◆ ~OutputProbeGNU()

OutputProbeGNU::~OutputProbeGNU ( )

override

Member Function Documentation

◆ getNextTime()

double OutputProbeGNU::getNextTime ( )

inlineoverridevirtual

Reimplemented from Output.

◆ initializeOutputInfos()

void OutputProbeGNU::initializeOutputInfos ( )

inlineoverridevirtual

Reimplemented from Output.

◆ initializeSpecificOutput()

void OutputProbeGNU::initializeSpecificOutput ( )

overridevirtual

Reimplemented from OutputGNU.

Here is the call graph for this function:

◆ locateProbeInAMRSubMesh()

Cell * OutputProbeGNU::locateProbeInAMRSubMesh	(	std::vector< Cell * > *	cells,
		const int &	nbCells )

overridevirtual

Reimplemented from Output.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ locateProbeInMesh()

void OutputProbeGNU::locateProbeInMesh	(	const TypeMeshContainer< Cell * > &	cells,
		const int &	nbCells,
		bool	localSeeking = false )

overridevirtual

Reimplemented from Output.

Here is the caller graph for this function:

◆ possesses()

bool OutputProbeGNU::possesses ( )

inlineoverridevirtual

Reimplemented from Output.

◆ probeDisplacement()

void OutputProbeGNU::probeDisplacement ( const double & dt )

overridevirtual

Reimplemented from Output.

Here is the call graph for this function:

◆ writeInfos()

void OutputProbeGNU::writeInfos ( )

inlineoverridevirtual

Reimplemented from Output.

◆ writeResults()

void OutputProbeGNU::writeResults	(	Mesh *	,
		std::vector< Cell * > *	)

overridevirtual

Reimplemented from OutputGNU.

Here is the call graph for this function:

Member Data Documentation

◆ m_acqFreq

double OutputProbeGNU::m_acqFreq

private

Acquisition time frequency.

◆ m_cell

Cell* OutputProbeGNU::m_cell

private

Pointer to the level 0 cell containing the probe.

◆ m_cellAMR

Cell* OutputProbeGNU::m_cellAMR

private

Pointer to the most refined cell containing the probe.

◆ m_nextAcq

double OutputProbeGNU::m_nextAcq

private

Next acquisition time.

◆ m_objet

GeometricObject* OutputProbeGNU::m_objet

private

To store position.

◆ m_possessesProbe

bool* OutputProbeGNU::m_possessesProbe

private

True if the CPU possesses probe.

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

/home/runner/work/ECOGEN/ECOGEN/doc_sources/src/InputOutput/OutputProbeGNU.h
/home/runner/work/ECOGEN/ECOGEN/doc_sources/src/InputOutput/OutputProbeGNU.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OutputProbeGNU()

◆ ~OutputProbeGNU()

Member Function Documentation

◆ getNextTime()

◆ initializeOutputInfos()

◆ initializeSpecificOutput()

◆ locateProbeInAMRSubMesh()

◆ locateProbeInMesh()

◆ possesses()

◆ probeDisplacement()

◆ writeInfos()

◆ writeResults()

Member Data Documentation

◆ m_acqFreq

◆ m_cell

◆ m_cellAMR

◆ m_nextAcq

◆ m_objet

◆ m_possessesProbe