CCGNSFileWriter Class Reference

#include <CCGNSFileWriter.hpp>

Inheritance diagram for CCGNSFileWriter:

Public Member Functions
	CCGNSFileWriter (CParallelDataSorter *valDataSorter, bool isSurf=false, bool doublePrecision=false)
	Construct a file writer using field names and the data sorter.
void	WriteData (string val_filename) override
	Write sorted data to file in CGNS file format.
void	SetBoundaryMarkers (const CConfig *valConfig, const CGeometry *valGeometry, const CFVMDataSorter *volumeSorter)
	Add the boundaries to a volume file: one boundary section, BC and family per marker, named as the marker.
void	SetSurfaceMarkers (CConfig *valConfig, CGeometry *valGeometry)
	Write a surface file with one zone per plotted marker, named as the marker. The data of the surface sorter is sorted again for each marker when the file is written.
Public Member Functions inherited from CFileWriter
	CFileWriter (CParallelDataSorter *valDataSorter, string valFileExt)
	Construct a file writer using field names, the data sorter and the file extension.
	CFileWriter (string valFileExt)
	Construct a file writer using field names, file extension.
virtual	~CFileWriter ()
	Destructor.
su2double	GetBandwidth () const
	Get the bandwith used for the last writing.
su2double	GetFilesize () const
	Get the filesize of the last written file.
su2double	GetUsedTime () const
	Get the used time of the last file writing.

Static Public Attributes
static const string	fileExt = ".cgns"
	File extension.

Additional Inherited Members
Protected Member Functions inherited from CFileWriter
unsigned long	DetermineFilesize (std::string filename)
	Determine the file size.
bool	WriteMPIBinaryDataAll (const void *data, unsigned long sizeInBytes, unsigned long totalSizeInBytes, unsigned long offset)
	Collectively write a binary data array distributed over all processors to file using MPI I/O.
bool	WriteMPIBinaryData (const void *data, unsigned long sizeInBytes, unsigned short processor)
	Write a binary data array to a currently opened file using MPI I/O. Note: routine must be called collectively, although only one processor writes its data.
bool	WriteMPIString (const std::string &str, unsigned short processor)
	Write a string to a currently opened file using MPI I/O. Note: routine must be called collectively, although only one processor writes the string.
std::pair< unsigned long, unsigned long >	GetRankOffset (unsigned long localCount) const
	Get the position of the data of this rank in an array that holds the data of all ranks in rank order.
bool	WriteMPIStringAll (const std::string &str)
	Write a string of each rank to the file, one after the other in rank order.
bool	OpenMPIFile (string val_filename, bool append=false)
	Open a file to write using MPI I/O. Already existing file is deleted.
bool	CloseMPIFile ()
	Close a file using MPI I/O.
Protected Attributes inherited from CFileWriter
int	rank
	The MPI rank.
int	size
	The MPI size, aka the number of processors.
std::string	fileExt
	The file extension to be attached to the filename.
su2double	startTime
	Start time for time measurement
su2double	stopTime
	Stop time for time measurement
su2double	usedTime
	Used time for time measurement
su2double	bandwidth
	Used bandwidth
su2double	fileSize
	Size of the last written file
CParallelDataSorter *	dataSorter
	The parallel data sorter.
FILE *	fhw
	The file handle for writing.

Constructor & Destructor Documentation

CCGNSFileWriter()

CCGNSFileWriter::CCGNSFileWriter	(	CParallelDataSorter *	valDataSorter,
		bool	isSurf = false,
		bool	doublePrecision = false
	)

Construct a file writer using field names and the data sorter.

Parameters

[in]	valDataSorter	- The parallel sorted data to write.
[in]	isSurf	- True if it is a surface file.

Member Function Documentation

SetBoundaryMarkers()

void CCGNSFileWriter::SetBoundaryMarkers	(	const CConfig *	valConfig,
		const CGeometry *	valGeometry,
		const CFVMDataSorter *	volumeSorter
	)

Add the boundaries to a volume file: one boundary section, BC and family per marker, named as the marker.

Parameters

[in]	valConfig	- Definition of the problem.
[in]	valGeometry	- Geometrical definition of the problem.
[in]	volumeSorter	- The volume data sorter, to find the boundary elements owned by this rank.

SetSurfaceMarkers()

void CCGNSFileWriter::SetSurfaceMarkers	(	CConfig *	valConfig,
		CGeometry *	valGeometry
	)

Write a surface file with one zone per plotted marker, named as the marker. The data of the surface sorter is sorted again for each marker when the file is written.

Parameters

[in]	valConfig	- Definition of the problem.
[in]	valGeometry	- Geometrical definition of the problem.

WriteData()

void CCGNSFileWriter::WriteData ( string  val_filename )

overridevirtual

Write sorted data to file in CGNS file format.

Parameters

[in]

val_filename

- The name of the file.

Reimplemented from CFileWriter.

Member Data Documentation

fileExt

const string CCGNSFileWriter::fileExt = ".cgns"

static

File extension.

---

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

• SU2_CFD/include/output/filewriter/CCGNSFileWriter.hpp
• SU2_CFD/src/output/filewriter/CCGNSFileWriter.cpp