#include <OutputGNU.h>

Inherits Output.

Inherited by OutputBoundaryGNU, OutputCutGNU, OutputGlobalGNU, and OutputProbeGNU.

Collaboration diagram for OutputGNU:

Public Member Functions
	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 () override
void	initializeSpecificOutput (std::vector< CellInterface * > *) override
void	writeResults (Mesh mesh, std::vector< Cell > *cellsLvl) 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 ()
virtual void	probeDisplacement (const double &)
virtual void	locateProbeInMesh (const TypeMeshContainer< Cell * > &, const int &, bool=false)
virtual Cell *	locateProbeInAMRSubMesh (std::vector< Cell * > *, const int &)
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	initializeOutputInfos ()
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	writeInfos ()
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 double	getNextTime ()
virtual bool	possesses ()
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

Protected Member Functions
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
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.

Constructor & Destructor Documentation

◆ OutputGNU() [1/3]

OutputGNU::OutputGNU ( )

Default constructor for specific output without specific needs.

Here is the caller graph for this function:

◆ OutputGNU() [2/3]

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

Main constructor for datasets.

Parameters

casTest	Test case name (defined in "main.xml")
nameRun	Folder to store results
element	XML outputMode element
fileName	Full path to main.xml of current test case
entree	Input pointer to access run pointer and its information

Here is the call graph for this function:

◆ OutputGNU() [3/3]

OutputGNU::OutputGNU ( tinyxml2::XMLElement * element )

Constructor for specific derived GNU outputs (boundary, probe, cut).

Parameters

element XML GNU output element to get stream precision

Here is the call graph for this function:

◆ ~OutputGNU()

OutputGNU::~OutputGNU ( )

override

Member Function Documentation

◆ createFilenameGNU()

std::string OutputGNU::createFilenameGNU	(	const char *	name,
		int	lvl = -1,
		int	proc = -1,
		int	numFichier = -1,
		std::string	nameVariable = "defaut" ) const

protected

Here is the caller graph for this function:

◆ formatVarNameStyle()

std::string OutputGNU::formatVarNameStyle ( std::string const & strToFormat ) const

protected

Here is the caller graph for this function:

◆ initializeSpecificOutput() [1/2]

void OutputGNU::initializeSpecificOutput ( )

inlineoverridevirtual

Reimplemented from Output.

Reimplemented in OutputProbeGNU.

◆ initializeSpecificOutput() [2/2]

void OutputGNU::initializeSpecificOutput ( std::vector< CellInterface * > * )

inlineoverridevirtual

Reimplemented from Output.

◆ printBlocGnuplot()

void OutputGNU::printBlocGnuplot	(	std::ofstream &	fileStream,
		int &	index,
		const int &	dim,
		bool	pause = true )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeResults() [1/2]

void OutputGNU::writeResults	(	Mesh *	mesh,
		std::vector< Cell * > *	cellsLvl )

overridevirtual

Reimplemented from Output.

Reimplemented in OutputProbeGNU.

Here is the call graph for this function:

◆ writeResults() [2/2]

void OutputGNU::writeResults ( std::vector< CellInterface * > * )

inlineoverridevirtual

Reimplemented from Output.

◆ writeScriptGnuplot() [1/2]

void OutputGNU::writeScriptGnuplot ( const int & dim )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeScriptGnuplot() [2/2]

void OutputGNU::writeScriptGnuplot ( const std::string & varName )

protected

Here is the call graph for this function:

◆ writeScriptGnuplotPDF()

void OutputGNU::writeScriptGnuplotPDF ( const int & dim )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_fileNamePDF

std::string OutputGNU::m_fileNamePDF

protected

◆ m_fileNameVisu

std::string OutputGNU::m_fileNameVisu

protected

◆ m_folderScriptGnuplot

std::string OutputGNU::m_folderScriptGnuplot

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ OutputGNU() [1/3]

◆ OutputGNU() [2/3]

◆ OutputGNU() [3/3]

◆ ~OutputGNU()

Member Function Documentation

◆ createFilenameGNU()

◆ formatVarNameStyle()

◆ initializeSpecificOutput() [1/2]

◆ initializeSpecificOutput() [2/2]

◆ printBlocGnuplot()

◆ writeResults() [1/2]

◆ writeResults() [2/2]

◆ writeScriptGnuplot() [1/2]

◆ writeScriptGnuplot() [2/2]

◆ writeScriptGnuplotPDF()

Member Data Documentation

◆ m_fileNamePDF

◆ m_fileNameVisu

◆ m_folderScriptGnuplot