OutputVTK Class Reference

#include <OutputVTK.h>

Inherits Output.

Collaboration diagram for OutputVTK:

Public Member Functions
	OutputVTK (std::string casTest, std::string run, tinyxml2::XMLElement *element, std::string fileName, Input *entree)
	OutputVTK (std::string nameRun, int fileNumberRestartMeshMapping, Input *input)
	~OutputVTK () override
void	initializeSpecificOutput () override
void	writeResults (Mesh *mesh, std::vector< Cell * > *cellsLvl) override
void	readResults (Mesh *mesh, std::vector< Cell * > *cellsLvl, int cpu=-1) override
	Read results of a previous simulation to resume from it.
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	writeResults (std::vector< CellInterface * > *)
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 ()
virtual void	initializeSpecificOutput (std::vector< CellInterface * > *)
void	readInfos ()
	Currently only used for OutputBoundaryMassflowGNU.
int	readNbCpu ()
	Read and return the number of cpu from the infoCalcul file of a performed simulation.
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	ReadPhysicalDataVTK (Mesh *mesh, std::vector< Cell * > *cellsLvl, tinyxml2::XMLElement *nodeCellData, std::string fileName="Unknown file")
std::string	createFilenameVTK (const char *name, Mesh *mesh=0, int proc=-1, int numFichier=-1, std::string nameVariable="defaut")
void	writeResultsVTK (Mesh *mesh, std::vector< Cell * > *cellsLvl)
void	writeCollectionVTK (Mesh *mesh)
void	writePhysicalDataVTK (Mesh *mesh, std::vector< Cell * > *cellsLvl, std::ofstream &fileStream)
void	writeMeshRectilinearVTK (Mesh *mesh, std::ofstream &fileStream)
void	writeMeshUnstructuredVTK (Mesh *mesh, std::vector< Cell * > *cellsLvl, std::ofstream &fileStream)
void	writeRectilinearVTKFileEnd (std::ofstream &fileStream)
void	writeUnstructuredVTKFileEnd (std::ofstream &fileStream)
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

Additional Inherited Members
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

OutputVTK() [1/2]

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

Here is the call graph for this function:

OutputVTK() [2/2]

OutputVTK::OutputVTK	(	std::string	nameRun,
		int	fileNumberRestartMeshMapping,
		Input *	input )

Here is the call graph for this function:

~OutputVTK()

OutputVTK::~OutputVTK ( )

override

Member Function Documentation

createFilenameVTK()

std::string OutputVTK::createFilenameVTK ( const char * name, Mesh * mesh = 0, int proc = -1, int numFichier = -1, std::string nameVariable = "defaut" )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

initializeSpecificOutput()

void OutputVTK::initializeSpecificOutput ( )

overridevirtual

Reimplemented from Output.

Here is the call graph for this function:

ReadPhysicalDataVTK()

void OutputVTK::ReadPhysicalDataVTK ( Mesh * mesh, std::vector< Cell * > * cellsLvl, tinyxml2::XMLElement * nodeCellData, std::string fileName = "Unknown file" )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

readResults()

void OutputVTK::readResults ( Mesh * , std::vector< Cell * > * , int = -1 )

overridevirtual

Read results of a previous simulation to resume from it.

Available for all mesh types if the same number of cpus is used between both simulations

Parameters

mesh	Mesh object of the current simulation in case of resume. Mesh object of a single partition of the previous simulation (either the same one as current or older one in case of mapping).
cellsLvl	Computationnal cells to be filled with results of previous simulation
cpu	Index of cpu file to read if provided (meshMappingRestart case), otherwise, the file associated with current cpu rank is readed (simulation resume case)

Reimplemented from Output.

Here is the call graph for this function:

writeCollectionVTK()

void OutputVTK::writeCollectionVTK ( Mesh * mesh )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

writeMeshRectilinearVTK()

void OutputVTK::writeMeshRectilinearVTK ( Mesh * mesh, std::ofstream & fileStream )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

writeMeshUnstructuredVTK()

void OutputVTK::writeMeshUnstructuredVTK ( Mesh * mesh, std::vector< Cell * > * cellsLvl, std::ofstream & fileStream )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

writePhysicalDataVTK()

void OutputVTK::writePhysicalDataVTK ( Mesh * mesh, std::vector< Cell * > * cellsLvl, std::ofstream & fileStream )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

writeRectilinearVTKFileEnd()

void OutputVTK::writeRectilinearVTKFileEnd ( std::ofstream & fileStream )

protected

Here is the caller graph for this function:

writeResults()

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

overridevirtual

Reimplemented from Output.

Here is the call graph for this function:

writeResultsVTK()

void OutputVTK::writeResultsVTK ( Mesh * mesh, std::vector< Cell * > * cellsLvl )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

writeUnstructuredVTKFileEnd()

void OutputVTK::writeUnstructuredVTKFileEnd ( std::ofstream & fileStream )

protected

Here is the caller graph for this function:

---

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

• /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/InputOutput/OutputVTK.h
• /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/InputOutput/OutputVTK.cpp