File reader for look up tables. More...

#include <CFileReaderLUT.hpp>

Public Member Functions
const std::string &	GetVersionLUT () const
	Get table version as listed in input file.

const std::string &	GetVersionReader () const
	Get table reader version.

unsigned long	GetNPoints (std::size_t i_level=0) const
	Get number of data points at specific table level.

unsigned long	GetNTriangles (std::size_t i_level=0) const
	Get number of triangles at specific table level.

unsigned long	GetNHullPoints (std::size_t i_level=0) const
	Get number of hull points at specific table level.

unsigned long	GetNVariables () const
	Get number of variables for which data is stored in the table.

unsigned long	GetNLevels () const
	Get number of table levels.

const su2vector< std::string > &	GetNamesVar () const
	Get variable names for which data is stored in the table.

const su2activematrix &	GetTableData (std::size_t i_level=0) const
	Get table data at a specific level.

const su2matrix< unsigned long > &	GetTriangles (std::size_t i_level=0) const
	Get table connectivity at a specific level.

const su2vector< unsigned long > &	GetHull (std::size_t i_level=0) const
	Get hull node information at a specific table level.

su2double	GetTableLevel (std::size_t i_level) const
	Get table level value.

unsigned short	GetTableDim () const
	Get table dimension.

void	ReadRawLUT (const std::string &file_name)
	Read LUT file and store information.

Protected Member Functions
void	SkipToFlag (std::ifstream &file_stream, const std::string &current_line, const std::string &flag) const
	Searches for the position of flag in file_stream and sets the stream position of file_stream to that position.

bool	GetNextNonEmptyLine (std::ifstream &file_stream, std::string &line) const
	Extracts the next non-empty characters from file_stream and stores them into line.

bool	GetStrippedLine (std::ifstream &file_stream, std::string &line) const
	Extracts characters from file_stream, removes trailing control characters, and stores them into line.

Protected Attributes
int	rank

unsigned short	table_dim = 2

std::string	version_lut

std::string	version_reader

unsigned long	n_levels = 1

su2vector< unsigned long >	n_points

su2vector< unsigned long >	n_triangles

su2vector< unsigned long >	n_hull_points

unsigned long	n_variables

su2vector< su2double >	table_levels

su2vector< std::string >	names_var
	Holds the variable names stored in the table file. Order is in sync with tableFlamelet.

su2vector< su2activematrix >	table_data
	Holds all data stored in the table. First index addresses the variable while second index addresses the point.

su2vector< su2matrix< unsigned long > >	triangles

su2vector< su2vector< unsigned long > >	hull

Detailed Description

File reader for look up tables.

Member Function Documentation

◆ GetHull()

const su2vector< unsigned long > & CFileReaderLUT::GetHull ( std::size_t i_level = 0 ) const

inline

Get hull node information at a specific table level.

Parameters

[in] i_level - table level index.

Returns: hull node indices.

◆ GetNamesVar()

const su2vector< std::string > & CFileReaderLUT::GetNamesVar ( ) const

inline

Get variable names for which data is stored in the table.

◆ GetNextNonEmptyLine()

bool CFileReaderLUT::GetNextNonEmptyLine	(	std::ifstream &	file_stream,
		std::string &	line
	)		const

protected

Extracts the next non-empty characters from file_stream and stores them into line.

◆ GetNHullPoints()

unsigned long CFileReaderLUT::GetNHullPoints ( std::size_t i_level = 0 ) const

inline

Get number of hull points at specific table level.

Parameters

[in] i_level - table level index.

Returns: hull point count at table level.

◆ GetNLevels()

unsigned long CFileReaderLUT::GetNLevels ( ) const

inline

Get number of table levels.

◆ GetNPoints()

unsigned long CFileReaderLUT::GetNPoints ( std::size_t i_level = 0 ) const

inline

Get number of data points at specific table level.

Parameters

[in] i_level - table level index.

Returns: data point count at table level.

◆ GetNTriangles()

unsigned long CFileReaderLUT::GetNTriangles ( std::size_t i_level = 0 ) const

inline

Get number of triangles at specific table level.

Parameters

[in] i_level - table level index.

Returns: triangle count at table level.

◆ GetNVariables()

unsigned long CFileReaderLUT::GetNVariables ( ) const

inline

Get number of variables for which data is stored in the table.

◆ GetStrippedLine()

bool CFileReaderLUT::GetStrippedLine	(	std::ifstream &	file_stream,
		std::string &	line
	)		const

protected

Extracts characters from file_stream, removes trailing control characters, and stores them into line.

◆ GetTableData()

const su2activematrix & CFileReaderLUT::GetTableData ( std::size_t i_level = 0 ) const

inline

Get table data at a specific level.

Parameters

[in] i_level - table level index.

Returns: table data

◆ GetTableDim()

unsigned short CFileReaderLUT::GetTableDim ( ) const

inline

Get table dimension.

◆ GetTableLevel()

su2double CFileReaderLUT::GetTableLevel ( std::size_t i_level ) const

inline

Get table level value.

Parameters

[in] i_level - table level index.

Returns: value of the third controlling variable at table level.

◆ GetTriangles()

const su2matrix< unsigned long > & CFileReaderLUT::GetTriangles ( std::size_t i_level = 0 ) const

inline

Get table connectivity at a specific level.

Parameters

[in] i_level - table level index.

Returns: data connectivity

◆ GetVersionLUT()

const std::string & CFileReaderLUT::GetVersionLUT ( ) const

inline

Get table version as listed in input file.

◆ GetVersionReader()

const std::string & CFileReaderLUT::GetVersionReader ( ) const

inline

Get table reader version.

◆ ReadRawLUT()

void CFileReaderLUT::ReadRawLUT ( const std::string & file_name )

Read LUT file and store information.

Parameters

[in] file_name - LUT input file name.

◆ SkipToFlag()

void CFileReaderLUT::SkipToFlag	(	std::ifstream &	file_stream,
		const std::string &	current_line,
		const std::string &	flag
	)		const

protected

Searches for the position of flag in file_stream and sets the stream position of file_stream to that position.

Member Data Documentation

◆ hull

su2vector<su2vector<unsigned long> > CFileReaderLUT::hull

protected

◆ n_hull_points

su2vector<unsigned long> CFileReaderLUT::n_hull_points

protected

◆ n_levels

unsigned long CFileReaderLUT::n_levels = 1

protected

◆ n_points

su2vector<unsigned long> CFileReaderLUT::n_points

protected

◆ n_triangles

su2vector<unsigned long> CFileReaderLUT::n_triangles

protected

◆ n_variables

unsigned long CFileReaderLUT::n_variables

protected

◆ names_var

su2vector<std::string> CFileReaderLUT::names_var

protected

Holds the variable names stored in the table file. Order is in sync with tableFlamelet.

◆ rank

int CFileReaderLUT::rank

protected

◆ table_data

su2vector<su2activematrix> CFileReaderLUT::table_data

protected

Holds all data stored in the table. First index addresses the variable while second index addresses the point.

◆ table_dim

unsigned short CFileReaderLUT::table_dim = 2

protected

◆ table_levels

su2vector<su2double> CFileReaderLUT::table_levels

protected

◆ triangles

su2vector<su2matrix<unsigned long> > CFileReaderLUT::triangles

protected

◆ version_lut

std::string CFileReaderLUT::version_lut

protected

◆ version_reader

std::string CFileReaderLUT::version_reader

protected

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

Common/include/containers/CFileReaderLUT.hpp
Common/src/containers/CFileReaderLUT.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ GetHull()

◆ GetNamesVar()

◆ GetNextNonEmptyLine()

◆ GetNHullPoints()

◆ GetNLevels()

◆ GetNPoints()

◆ GetNTriangles()

◆ GetNVariables()

◆ GetStrippedLine()

◆ GetTableData()

◆ GetTableDim()

◆ GetTableLevel()

◆ GetTriangles()

◆ GetVersionLUT()

◆ GetVersionReader()

◆ ReadRawLUT()

◆ SkipToFlag()

Member Data Documentation

◆ hull

◆ n_hull_points

◆ n_levels

◆ n_points

◆ n_triangles

◆ n_variables

◆ names_var

◆ rank

◆ table_data

◆ table_dim

◆ table_levels

◆ triangles

◆ version_lut

◆ version_reader