A base class for VTK input output. More...

Inheritance diagram for bitpit::VTK:

[legend]

Collaboration diagram for bitpit::VTK:

[legend]

Public Member Functions
	VTK ()

	VTK (const std::string &, const std::string &)

template<class T >
VTKField &	addData (const std::string &, std::vector< T > &)

VTKField &	addData (const std::string &, VTKBaseStreamer *=nullptr)

template<class T >
VTKField &	addData (const std::string &, VTKFieldType, VTKLocation, std::vector< T > &)

template<class T >
VTKField &	addData (const std::string &, VTKFieldType, VTKLocation, VTKBaseStreamer *=nullptr)

VTKField &	addData (VTKField &&field)

void	disableData (const std::string &)

void	enableData (const std::string &)

const VTKField *	findData (const std::string &name) const

const VTKField *	findGeomData (const std::string &name) const

int	getCounter () const

std::vector< VTKField >::const_iterator	getDataBegin () const

std::size_t	getDataCount () const

std::vector< VTKField >::const_iterator	getDataEnd () const

std::string	getDirectory () const

std::vector< VTKField >::const_iterator	getGeomDataBegin () const

std::size_t	getGeomDataCount () const

std::vector< VTKField >::const_iterator	getGeomDataEnd () const

const std::string &	getHeaderType () const

std::string	getName () const

bool	hasData (const std::string &) const

void	incrementCounter ()

void	read ()

void	readData ()

virtual void	readMetaInformation ()=0

void	removeData (const std::string &)

void	setCodex (VTKFormat)

void	setCounter (int c_=0)

void	setDataCodex (VTKFormat)

void	setDirectory (const std::string &)

void	setGeomCodex (VTKFormat)

void	setGeomData (VTKField &&field)

void	setHeaderType (const std::string &)

void	setName (const std::string &)

void	setNames (const std::string &, const std::string &)

void	setParallel (uint16_t, uint16_t)

int	unsetCounter ()

void	write (const std::string &, VTKWriteMode writeMode, double time)

void	write (const std::string &, VTKWriteMode writeMode=VTKWriteMode::NO_INCREMENT)

void	write (VTKWriteMode writeMode, double time)

void	write (VTKWriteMode writeMode=VTKWriteMode::DEFAULT)

void	writeCollection () const

void	writeCollection (const std::string &outputName) const

virtual void	writeCollection (const std::string &outputName, const std::string &collectionName) const =0

void	writeTimeSeries (const std::string &outputName, const std::string &seriesName, double time) const

void	writeTimeSeries (const std::string &outputName, double time) const

void	writeTimeSeries (double time) const

Protected Member Functions
VTKField *	_findData (const std::string &name)

int	_findFieldIndex (const std::string &name, const std::vector< VTKField > &fields) const

VTKField *	_findGeomData (const std::string &name)

void	calcAppendedOffsets ()

virtual uint8_t	calcFieldComponents (const VTKField &) const =0

virtual uint64_t	calcFieldEntries (const VTKField &) const =0

virtual uint64_t	calcFieldSize (const VTKField &) const =0

void	checkAllFields ()

FileHandler	createCollectionHandler (const std::string &collectionName) const

virtual std::string	getCollectionExtension () const

VTKField *	getData (std::size_t id)

const VTKField *	getData (std::size_t id) const

virtual std::string	getExtension () const =0

std::vector< std::string >	getFieldNames (const std::vector< VTKField > &fields) const

VTKField *	getGeomData (std::size_t id)

const VTKField *	getGeomData (std::size_t id) const

bool	isAppendedActive () const

bool	isASCIIActive () const

bool	readDataArray (std::fstream &, VTKField &) const

void	readDataHeader (std::fstream &)

void	writeData ()

void	writeDataArray (std::fstream &, const VTKField &) const

void	writeDataHeader (std::fstream &, bool parallel=false) const

virtual void	writeMetaInformation () const =0

void	writePDataArray (std::fstream &, const VTKField &) const

Protected Attributes
uint64_t	m_cells

std::vector< VTKField >	m_data

VTKFormat	m_dataCodex

FileHandler	m_fh

VTKFormat	m_geomCodex

std::vector< VTKField >	m_geometry

std::string	m_headerType

VTKNativeStreamer	m_nativeStreamer

uint64_t	m_points

uint16_t	m_procs

uint16_t	m_rank

Detailed Description

A base class for VTK input output.

VTK provides all basic methods for reading and writing VTK files. ASCII and APPENDED mode are supported.

Definition at line 298 of file VTK.hpp.

Constructor & Destructor Documentation

◆ VTK() [1/2]

bitpit::VTK::VTK ( )

Default constructor referes to a serial VTK file with appended binary data.

Definition at line 48 of file VTK.cpp.

◆ VTK() [2/2]

bitpit::VTK::VTK	(	const std::string &	dir,
		const std::string &	name )

Constructor referes to a serial VTK file with appended binary data.

Parameters

[in]	dir	directory of file with final "/"
[in]	name	file name without suffix

Definition at line 72 of file VTK.cpp.

Member Function Documentation

◆ _findData()

VTKField * bitpit::VTK::_findData ( const std::string & name )

protected

Finds the data field with the specified name.

Parameters

[in] name name of field to be found

Returns: A pointer to the field with the specified name, if such a field does not exists a null pointer is returned.

Definition at line 490 of file VTK.cpp.

◆ _findFieldIndex()

int bitpit::VTK::_findFieldIndex	(	const std::string &	name,
		const std::vector< VTKField > &	fields ) const

protected

Finds the field with the specified name.

Parameters

[in]	name	name of field to be found
[in]	fields	is the list of fields among which the requested field will be searched

Returns: The index of the specified field, if such a field does not exists, -1 is returned.

Definition at line 588 of file VTK.cpp.

◆ _findGeomData()

VTKField * bitpit::VTK::_findGeomData ( const std::string & name )

protected

Finds the geometry field with the specified name.

Parameters

[in] name name of field to be found

Returns: A pointer to the field with the specified name, if such a field does not exists a null pointer is returned.

Definition at line 522 of file VTK.cpp.

◆ addData() [1/5]

template<class T >

VTKField & bitpit::VTK::addData	(	const std::string &	name,
		std::vector< T > &	data )

Adds data strored in std::vector<> to NativeStreamer

Template Parameters

T	type of std::vector<>

Parameters

[in]	name	name of data set
[in]	data	std::vector containing the data

Definition at line 34 of file VTK.tpp.

◆ addData() [2/5]

VTKField & bitpit::VTK::addData	(	const std::string &	name,
		VTKBaseStreamer *	streamer = nullptr )

Add user data for input or output. Codification will be set according to default value [appended] or to value set by VTK::setDataCodex( VTKFormat ) or VTK::setCodex( VTKFormat )

Parameters

[in]	name	name of field
[in]	streamer	data streamer

Definition at line 307 of file VTK.cpp.

◆ addData() [3/5]

template<class T >

VTKField & bitpit::VTK::addData	(	const std::string &	name,
		VTKFieldType	comp,
		VTKLocation	loc,
		std::vector< T > &	data )

Add user data for input or output. Codification will be set according to default value [appended] or to value set by VTK::setDataCodex( VTKFormat ) or VTK::setCodex( VTKFormat )

Template Parameters

T	type of std::vector<>

Parameters

[in]	name	name of field
[in]	comp	type of data field [ VTKFieldType::SCALAR/VECTOR/TENSOR ]
[in]	loc	location of data [VTKLocation::CELL/VTKLocationPOINT]
[in]	data	data

Definition at line 55 of file VTK.tpp.

◆ addData() [4/5]

template<class T >

VTKField & bitpit::VTK::addData	(	const std::string &	name,
		VTKFieldType	comp,
		VTKLocation	loc,
		VTKBaseStreamer *	streamer = nullptr )

Add user data for input or output. Codification will be set according to default value [appended] or to value set by VTK::setDataCodex( VTKFormat ) or VTK::setCodex( VTKFormat )

Template Parameters

T	type of data to be written or read

Parameters

[in]	name	name of field
[in]	comp	type of data field [ VTKFieldType::SCALAR/VECTOR/TENSOR ]
[in]	loc	location of data [VTKLocation::CELL/VTKLocationPOINT]
[in]	streamer	data streamer

Definition at line 76 of file VTK.tpp.

◆ addData() [5/5]

VTKField & bitpit::VTK::addData ( VTKField && field )

Add user data for input or output. Codification will be set according to default value [appended] or to value set by VTK::setDataCodex( VTKFormat ) or VTK::setCodex( VTKFormat )

Parameters

[in] field is the field that will be added

Definition at line 281 of file VTK.cpp.

◆ calcAppendedOffsets()

void bitpit::VTK::calcAppendedOffsets ( )

protected

Calculates the offsets of all geometry and data fields for appended output. Offsets are stored in each field.

Definition at line 635 of file VTK.cpp.

◆ calcFieldComponents()

virtual uint8_t bitpit::VTK::calcFieldComponents ( const VTKField & ) const

protectedpure virtual

Implemented in bitpit::VTKUnstructuredGrid, and bitpit::VTKRectilinearGrid.

◆ calcFieldEntries()

virtual uint64_t bitpit::VTK::calcFieldEntries ( const VTKField & ) const

protectedpure virtual

Implemented in bitpit::VTKUnstructuredGrid, and bitpit::VTKRectilinearGrid.

◆ calcFieldSize()

virtual uint64_t bitpit::VTK::calcFieldSize ( const VTKField & ) const

protectedpure virtual

Implemented in bitpit::VTKUnstructuredGrid, and bitpit::VTKRectilinearGrid.

◆ checkAllFields()

void bitpit::VTK::checkAllFields ( )

protected

Check all geometry fields and user data for available metadata. If metadata is missing field is disabled for writing or reading

Definition at line 675 of file VTK.cpp.

◆ createCollectionHandler()

FileHandler bitpit::VTK::createCollectionHandler ( const std::string & collectionName ) const

protected

Creates a handler for the collection.

Parameters

collectionName collection filename to be set for this output only

Definition at line 934 of file VTK.cpp.

◆ disableData()

void bitpit::VTK::disableData ( const std::string & name )

Disables field for reading and writing

Parameters

[in] name name of field to be disabled

Definition at line 386 of file VTK.cpp.

◆ enableData()

void bitpit::VTK::enableData ( const std::string & name )

Enables field for reading and writing

Parameters

[in] name name of field to be enabled

Definition at line 368 of file VTK.cpp.

◆ findData()

const VTKField * bitpit::VTK::findData ( const std::string & name ) const

Finds the data field with the specified name.

Parameters

[in] name name of field to be found

Returns: A constant pointer to the field with the specified name, if such a field does not exists a null pointer is returned.

Definition at line 474 of file VTK.cpp.

◆ findGeomData()

const VTKField * bitpit::VTK::findGeomData ( const std::string & name ) const

Finds the geometry field with the specified name.

Parameters

[in] name name of field to be found

Returns: A constant pointer to the field with the specified name, if such a field does not exists a null pointer is returned.

Definition at line 506 of file VTK.cpp.

◆ getCollectionExtension()

std::string bitpit::VTK::getCollectionExtension ( ) const

protectedvirtual

Gets the extension of the collection file for parallel output.

Returns: The extension of the collection file for parallel output.

Definition at line 1495 of file VTK.cpp.

◆ getCounter()

int bitpit::VTK::getCounter ( ) const

Returns the time index of the following file

Returns: counter

Definition at line 194 of file VTK.cpp.

◆ getData() [1/2]

VTKField * bitpit::VTK::getData ( std::size_t id )

protected

Gets a pointer to the data field with the specified index.

Parameters

[in] id index of the field

Returns: A pointer to the field with the specified index.

Definition at line 549 of file VTK.cpp.

◆ getData() [2/2]

const VTKField * bitpit::VTK::getData ( std::size_t id ) const

protected

Gets a constant pointer to the data field with the specified index.

Parameters

[in] id index of the field

Returns: A constant pointer to the field with the specified index.

Definition at line 537 of file VTK.cpp.

◆ getDataBegin()

std::vector< VTKField >::const_iterator bitpit::VTK::getDataBegin ( ) const

Get the a constant iterator pointing to the first data field.

Returns: a constant iterator pointing to the first data field.

Definition at line 418 of file VTK.cpp.

◆ getDataCount()

std::size_t bitpit::VTK::getDataCount ( ) const

Get the number of data fields.

Returns: the number of data

Definition at line 454 of file VTK.cpp.

◆ getDataEnd()

std::vector< VTKField >::const_iterator bitpit::VTK::getDataEnd ( ) const

Get the a constant iterator pointing to the past-the-element data field.

Returns: a constant iterator pointing to the past-the-element data field.

Definition at line 427 of file VTK.cpp.

◆ getDirectory()

std::string bitpit::VTK::getDirectory ( ) const

Get the directory where the VTK file will be saved

Returns: The directory where the VTK file will be saved.

Definition at line 148 of file VTK.cpp.

◆ getExtension()

virtual std::string bitpit::VTK::getExtension ( ) const

protectedpure virtual

Implemented in bitpit::VTKUnstructuredGrid, and bitpit::VTKRectilinearGrid.

◆ getFieldNames()

std::vector< std::string > bitpit::VTK::getFieldNames ( const std::vector< VTKField > & fields ) const

protected

Get the list of the names of the fields.

Returns: the list of the names of the fields.

Definition at line 403 of file VTK.cpp.

◆ getGeomData() [1/2]

VTKField * bitpit::VTK::getGeomData ( std::size_t id )

protected

Gets a pointer to the geometry field with the specified index.

Parameters

[in] id index of the field

Returns: A pointer to the field with the specified index.

Definition at line 573 of file VTK.cpp.

◆ getGeomData() [2/2]

const VTKField * bitpit::VTK::getGeomData ( std::size_t id ) const

protected

Gets a constant pointer to the geometry field with the specified index.

Parameters

[in] id index of the field

Returns: A constant pointer to the field with the specified index.

Definition at line 561 of file VTK.cpp.

◆ getGeomDataBegin()

std::vector< VTKField >::const_iterator bitpit::VTK::getGeomDataBegin ( ) const

Get the a constant iterator pointing to the first geometry field.

Returns: a constant iterator pointing to the first geometry field.

Definition at line 436 of file VTK.cpp.

◆ getGeomDataCount()

std::size_t bitpit::VTK::getGeomDataCount ( ) const

Get the number of geometry fields.

Returns: the number of geometry fields.

Definition at line 463 of file VTK.cpp.

◆ getGeomDataEnd()

std::vector< VTKField >::const_iterator bitpit::VTK::getGeomDataEnd ( ) const

Get the a constant iterator pointing to the past-the-element geometry field.

Returns: a constant iterator pointing to the past-the-element geometry field.

Definition at line 445 of file VTK.cpp.

◆ getHeaderType()

const std::string & bitpit::VTK::getHeaderType ( ) const

Get header type for appended binary output

Returns: header type ["UInt32"/"UInt64"]

Definition at line 99 of file VTK.cpp.

◆ getName()

std::string bitpit::VTK::getName ( ) const

Get the name of the VTK file

Returns: The name of the VTK file.

Definition at line 139 of file VTK.cpp.

◆ hasData()

bool bitpit::VTK::hasData ( const std::string & name ) const

Check if the VTK contains the specified user data

Parameters

[in] name name of field

Definition at line 352 of file VTK.cpp.

◆ incrementCounter()

void bitpit::VTK::incrementCounter ( )

Increment the time series' counter. If the time series is not active, it will be activated and the counter will be reset.

Definition at line 168 of file VTK.cpp.

◆ isAppendedActive()

bool bitpit::VTK::isAppendedActive ( ) const

protected

Check if the VTK file contains data in appended format.

Returns: True if the VTK file contains data in appended format, false otherwise.

Definition at line 603 of file VTK.cpp.

◆ isASCIIActive()

bool bitpit::VTK::isASCIIActive ( ) const

protected

Check if the VTK file contains data in ASCII format.

Returns: True if the VTK file contains data in ASCII format, false otherwise.

Definition at line 619 of file VTK.cpp.

◆ read()

void bitpit::VTK::read ( )

Reads entire VTK file (headers and data).

Definition at line 1234 of file VTK.cpp.

◆ readData()

void bitpit::VTK::readData ( )

Reads data only from VTK file

Definition at line 1245 of file VTK.cpp.

◆ readDataArray()

bool bitpit::VTK::readDataArray	(	std::fstream &	str,
		VTKField &	field ) const

protected

Reads data array information from stream and stores in field.

Parameters

[in]	str	output stream
[out]	field	field information

Definition at line 1468 of file VTK.cpp.

◆ readDataHeader()

void bitpit::VTK::readDataHeader ( std::fstream & str )

protected

Reads data headers from stream. All field information available in file are stored. All pre-existent fields not found in the header will be disabled.

Parameters

[in] str output stream

Definition at line 1370 of file VTK.cpp.

◆ readMetaInformation()

virtual void bitpit::VTK::readMetaInformation ( )

pure virtual

Implemented in bitpit::VTKUnstructuredGrid, and bitpit::VTKRectilinearGrid.

◆ removeData()

void bitpit::VTK::removeData ( const std::string & name )

Removes user data from input or output

Parameters

[in] name name of field to be removed

Definition at line 330 of file VTK.cpp.

◆ setCodex()

void bitpit::VTK::setCodex ( VTKFormat cod )

sets codex for geometry and data

Parameters

[in] cod codex for VTK output [VTKFormat::APPENDED/VTKFormatASCII]

Definition at line 228 of file VTK.cpp.

◆ setCounter()

void bitpit::VTK::setCounter ( int counter = 0 )

Activates output for time series. sets series to true first output index to input

Parameters

[in] counter first output index

Definition at line 157 of file VTK.cpp.

◆ setDataCodex()

void bitpit::VTK::setDataCodex ( VTKFormat cod )

sets codex for data only

Parameters

[in] cod codex for VTK output [VTKFormat::APPENDED/VTKFormatASCII]

Definition at line 251 of file VTK.cpp.

◆ setDirectory()

void bitpit::VTK::setDirectory ( const std::string & dir )

set directory for VTK file

Parameters

[in] dir directory of file with final "/"

Definition at line 129 of file VTK.cpp.

◆ setGeomCodex()

void bitpit::VTK::setGeomCodex ( VTKFormat cod )

sets codex for geometry only

Parameters

[in] cod codex for VTK output [VTKFormat::APPENDED/VTKFormatASCII]

Definition at line 239 of file VTK.cpp.

◆ setGeomData()

void bitpit::VTK::setGeomData ( VTKField && field )

Set the specified geometry field.

Parameters

[in] field is the field that will be set

Implemented in bitpit::VTKUnstructuredGrid, and bitpit::VTKRectilinearGrid.

Definition at line 263 of file VTK.cpp.

◆ setHeaderType()

void bitpit::VTK::setHeaderType ( const std::string & st )

set header type for appended binary output

Parameters

[in] st header type ["UInt32"/"UInt64"]

Definition at line 83 of file VTK.cpp.

◆ setName()

void bitpit::VTK::setName ( const std::string & name )

set name for VTK file

Parameters

[in] name file name without suffix

Examples: volcartesian_example_00001.cpp.

Definition at line 119 of file VTK.cpp.

◆ setNames()

void bitpit::VTK::setNames	(	const std::string &	dir,
		const std::string &	name )

set directory and name for VTK file

Parameters

[in]	dir	directory of file with final "/"
[in]	name	file name without suffix

Definition at line 108 of file VTK.cpp.

◆ setParallel()

void bitpit::VTK::setParallel	(	uint16_t	procs,
		uint16_t	rank )

Activates parallel output

Parameters

[in]	procs	number of processes
[in]	rank	my rank

Definition at line 205 of file VTK.cpp.

◆ unsetCounter()

int bitpit::VTK::unsetCounter ( )

De-activates output for time series.

Returns: last value of counter

Definition at line 182 of file VTK.cpp.

◆ write() [1/4]

void bitpit::VTK::write	(	const std::string &	name,
		VTKWriteMode	writeMode,
		double	time )

Writes entire VTK file (headers and data).

Parameters

[in]	name	filename to be set for this output only
[in]	writeMode	if writeMode == VTKWriteMode::DEFAULT the default write setting will be used according to setCounter(); if writeMode == VTKWriteMode::NO_SERIES no time stamp will be added and the counter will not be increased; if writeMode == VTKWriteMode::NO_INCREMENT the output file will have the same time stamp like the previous one ;
[in]	time	is the time associated with the file

Definition at line 775 of file VTK.cpp.

◆ write() [2/4]

void bitpit::VTK::write	(	const std::string &	name,
		VTKWriteMode	writeMode = VTKWriteMode::NO_INCREMENT )

Writes entire VTK file (headers and data).

Parameters

[in]	name	filename to be set for this output only
[in]	writeMode	if writeMode == VTKWriteMode::DEFAULT the default write setting will be used according to setCounter(); if writeMode == VTKWriteMode::NO_SERIES no time stamp will be added and the counter will not be increased; if writeMode == VTKWriteMode::NO_INCREMENT the output file will have the same time stamp like the previous one ;

Definition at line 758 of file VTK.cpp.

◆ write() [3/4]

void bitpit::VTK::write	(	VTKWriteMode	writeMode,
		double	time )

Writes entire VTK file (headers and data).

Parameters

[in]	writeMode	if writeMode == VTKWriteMode::DEFAULT the default write setting will be used according to setCounter(); if writeMode == VTKWriteMode::NO_SERIES no time stamp will be added and the counter will not be increased; if writeMode == VTKWriteMode::NO_INCREMENT the output file will have the same time stamp like the previous one ;
[in]	time	is the time associated with the file

Definition at line 704 of file VTK.cpp.

◆ write() [4/4]

void bitpit::VTK::write ( VTKWriteMode writeMode = VTKWriteMode::DEFAULT )

Writes entire VTK file (headers and data).

Parameters

[in] writeMode if writeMode == VTKWriteMode::DEFAULT the default write setting will be used according to setCounter(); if writeMode == VTKWriteMode::NO_SERIES no time stamp will be added and the counter will not be increased; if writeMode == VTKWriteMode::NO_INCREMENT the output file will have the same time stamp like the previous one ;

Definition at line 722 of file VTK.cpp.

◆ writeCollection() [1/3]

void bitpit::VTK::writeCollection ( ) const

Writes collection file for parallel output. Is called by rank 0 in VTK::Write()

Definition at line 789 of file VTK.cpp.

◆ writeCollection() [2/3]

void bitpit::VTK::writeCollection ( const std::string & outputName ) const

Writes collection file for parallel output. Is called by rank 0 in VTK::Write()

Parameters

outputName filename to be set for this output only

Definition at line 799 of file VTK.cpp.

◆ writeCollection() [3/3]

virtual void bitpit::VTK::writeCollection	(	const std::string &	outputName,
		const std::string &	collectionName ) const

pure virtual

Implemented in bitpit::VTKUnstructuredGrid, and bitpit::VTKRectilinearGrid.

◆ writeData()

void bitpit::VTK::writeData ( )

protected

Writes data only in VTK file

Definition at line 947 of file VTK.cpp.

◆ writeDataArray()

void bitpit::VTK::writeDataArray	(	std::fstream &	str,
		const VTKField &	field ) const

protected

Writes data array related to a field in strean

Parameters

[in]	str	output stream
[in]	field	field to be written

Definition at line 1212 of file VTK.cpp.

◆ writeDataHeader()

void bitpit::VTK::writeDataHeader	(	std::fstream &	str,
		bool	parallel = false ) const

protected

Writes data headers in strean

Parameters

[in]	str	output stream
[in]	parallel	flag for parallel data headers for collection files [true/false]

Definition at line 1146 of file VTK.cpp.

◆ writeMetaInformation()

virtual void bitpit::VTK::writeMetaInformation ( ) const

protectedpure virtual

Implemented in bitpit::VTKUnstructuredGrid, and bitpit::VTKRectilinearGrid.

◆ writePDataArray()

void bitpit::VTK::writePDataArray	(	std::fstream &	str,
		const VTKField &	field ) const

protected

Writes parallel data array related to a field in strean

Parameters

[in]	str	output stream
[in]	field	field to be written

Definition at line 1224 of file VTK.cpp.

◆ writeTimeSeries() [1/3]

void bitpit::VTK::writeTimeSeries	(	const std::string &	outputName,
		const std::string &	seriesName,
		double	time ) const

Writes time series file.

If the file doesn't exists or if this is the first data set of the series (i.e., the counter is equal to zero), the time series will be written from scratch and will contain only the current data set. Otherwise, the existing time series will be inspected and the current data set will be either added at the end of the series or will it will replace the entry with the same file name it such an entry exists.

Parameters

outputName	filename to be set for this output only
seriesName	series filename to be set for this output only
time	is the time associated with the data set

Definition at line 850 of file VTK.cpp.

◆ writeTimeSeries() [2/3]

void bitpit::VTK::writeTimeSeries	(	const std::string &	outputName,
		double	time ) const

Writes time series file.

If the file doesn't exists or if this is the first data set of the series (i.e., the counter is equal to zero), the time series will be written from scratch and will contain only the current data set. Otherwise, the existing time series will be inspected and the current data set will be either added at the end of the series or will it will replace the entry with the same file name it such an entry exists.

Parameters

outputName	filename to be set for this output only
time	is the time associated with the data set

Definition at line 832 of file VTK.cpp.

◆ writeTimeSeries() [3/3]

void bitpit::VTK::writeTimeSeries ( double time ) const

Writes time series file.

If the file doesn't exists or if this is the first data set of the series (i.e., the counter is equal to zero), the time series will be written from scratch and will contain only the current data set. Otherwise, the existing time series will be inspected and the current data set will be either added at the end of the series or will it will replace the entry with the same file name it such an entry exists.

Parameters

time	is the time associated with the data set

Definition at line 815 of file VTK.cpp.

Member Data Documentation

◆ m_cells

uint64_t bitpit::VTK::m_cells

protected

Number of Cells

Definition at line 303 of file VTK.hpp.

◆ m_data

std::vector<VTKField> bitpit::VTK::m_data

protected

Data fields

Definition at line 312 of file VTK.hpp.

◆ m_dataCodex

VTKFormat bitpit::VTK::m_dataCodex

protected

Data codex

Definition at line 313 of file VTK.hpp.

◆ m_fh

FileHandler bitpit::VTK::m_fh

protected

File_Handler for Input and Output

Definition at line 301 of file VTK.hpp.

◆ m_geomCodex

VTKFormat bitpit::VTK::m_geomCodex

protected

Geometry codex

Definition at line 310 of file VTK.hpp.

◆ m_geometry

std::vector<VTKField> bitpit::VTK::m_geometry

protected

Geometry fields

Definition at line 309 of file VTK.hpp.

◆ m_headerType

std::string bitpit::VTK::m_headerType

protected

UInt32 or UInt64_t

Definition at line 307 of file VTK.hpp.

◆ m_nativeStreamer

VTKNativeStreamer bitpit::VTK::m_nativeStreamer

protected

native streamer for streaming data stored in std::vector<>

Definition at line 315 of file VTK.hpp.

◆ m_points

uint64_t bitpit::VTK::m_points

protected

Number of vertices

Definition at line 302 of file VTK.hpp.

◆ m_procs

uint16_t bitpit::VTK::m_procs

protected

Number of parallel processes

Definition at line 304 of file VTK.hpp.

◆ m_rank

uint16_t bitpit::VTK::m_rank

protected

My process id

Definition at line 305 of file VTK.hpp.

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

src/IO/VTK.hpp
src/IO/VTK.cpp
src/IO/VTK.tpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VTK() [1/2]

◆ VTK() [2/2]

Member Function Documentation

◆ _findData()

◆ _findFieldIndex()

◆ _findGeomData()

◆ addData() [1/5]

◆ addData() [2/5]

◆ addData() [3/5]

◆ addData() [4/5]

◆ addData() [5/5]

◆ calcAppendedOffsets()

◆ calcFieldComponents()

◆ calcFieldEntries()

◆ calcFieldSize()

◆ checkAllFields()

◆ createCollectionHandler()

◆ disableData()

◆ enableData()

◆ findData()

◆ findGeomData()

◆ getCollectionExtension()

◆ getCounter()

◆ getData() [1/2]

◆ getData() [2/2]

◆ getDataBegin()

◆ getDataCount()

◆ getDataEnd()

◆ getDirectory()

◆ getExtension()

◆ getFieldNames()

◆ getGeomData() [1/2]

◆ getGeomData() [2/2]

◆ getGeomDataBegin()

◆ getGeomDataCount()

◆ getGeomDataEnd()

◆ getHeaderType()

◆ getName()

◆ hasData()

◆ incrementCounter()

◆ isAppendedActive()

◆ isASCIIActive()

◆ read()

◆ readData()

◆ readDataArray()

◆ readDataHeader()

◆ readMetaInformation()

◆ removeData()

◆ setCodex()

◆ setCounter()

◆ setDataCodex()

◆ setDirectory()

◆ setGeomCodex()

◆ setGeomData()

◆ setHeaderType()

◆ setName()

◆ setNames()

◆ setParallel()

◆ unsetCounter()

◆ write() [1/4]

◆ write() [2/4]

◆ write() [3/4]

◆ write() [4/4]

◆ writeCollection() [1/3]

◆ writeCollection() [2/3]

◆ writeCollection() [3/3]

◆ writeData()

◆ writeDataArray()

◆ writeDataHeader()

◆ writeMetaInformation()

◆ writePDataArray()

◆ writeTimeSeries() [1/3]

◆ writeTimeSeries() [2/3]

◆ writeTimeSeries() [3/3]

Member Data Documentation