Class for the marker profile reader of the finite volume solver (FVM). More...

#include <CMarkerProfileReaderFVM.hpp>

Public Member Functions
	CMarkerProfileReaderFVM (CGeometry val_geometry, CConfig val_config, string val_filename, unsigned short val_kind_marker, unsigned short val_number_vars, vector< string > val_columnNames, vector< string > val_columnValues)
	Constructor of the CMarkerProfileReaderFVM class.

	~CMarkerProfileReaderFVM (void)
	Destructor of the CMeshReaderFVM class.

unsigned long	GetNumberOfProfiles () const
	Get the number of profiles found within the input file.

const string &	GetTagForProfile (int val_iProfile) const
	Get the string tag for the marker where the profile is applied.

unsigned long	GetNumberOfRowsInProfile (int val_iProfile)
	Get the number of rows of data in a profile.

unsigned long	GetNumberOfColumnsInProfile (int val_iProfile)
	Get the number of columns of data in a profile.

const vector< passivedouble > &	GetDataForProfile (int val_iProfile) const
	Get the 1D vector of data for a profile from the input file.

vector< su2double >	GetColumnForProfile (int val_iProfile, unsigned short iCol) const
	Get the data for the specific column if interpolation being done.

Protected Attributes
int	rank
	MPI Rank.

int	size
	MPI Size.

CConfig *	config
	Local pointer to the config parameter object.

CGeometry *	geometry
	Local pointer to the geometry object.

unsigned short	dimension
	Dimension of the problem (2 or 3).

unsigned short	markerType
	Type of marker where the profiles are being applied.

unsigned short	numberOfVars
	Number of variables added to the number of coordinates to write each line in the template profile file.

unsigned long	numberOfProfiles
	Auxiliary structure for holding the number of markers in a profile file.

string	filename
	File name of the marker profile file.

vector< string >	columnNames
	string containing all the names of the columns, one for each marker

vector< string >	columnValues
	initial values for the profile, in string format

vector< string >	profileTags
	Auxiliary structure for holding the string names of the markers in a profile file.

vector< unsigned long >	numberOfRowsInProfile
	Auxiliary structure for holding the number of rows for a particular marker in a profile file.

vector< unsigned long >	numberOfColumnsInProfile
	Auxiliary structure for holding the number of columns for a particular marker in a profile file.

vector< string >	totalColumnNames
	Names of the columns for the profile, one for each inlet marker.

vector< string >	totalColumnValues
	Initial values for the profile, constructed from MARKER_INLET.

vector< vector< passivedouble > >	profileData
	Auxiliary structure for holding the data values from a profile file.

vector< vector< vector< su2double > > >	profileCoords
	Data structure for holding the merged inlet boundary coordinates from all ranks.

Detailed Description

Class for the marker profile reader of the finite volume solver (FVM).

Author: : T. Economon

Constructor & Destructor Documentation

◆ CMarkerProfileReaderFVM()

CMarkerProfileReaderFVM::CMarkerProfileReaderFVM	(	CGeometry *	val_geometry,
		CConfig *	val_config,
		string	val_filename,
		unsigned short	val_kind_marker,
		unsigned short	val_number_vars,
		vector< string >	val_columnNames,
		vector< string >	val_columnValues
	)

Constructor of the CMarkerProfileReaderFVM class.

Parameters

[in]	val_geometry	- Pointer to the current geometry
[in]	val_config	- Pointer to the current config structure
[in]	val_filename	- Name of the profile file to be read
[in]	val_kind_marker	- Type of marker where profile will be applied
[in]	val_number_vars	- Number of columns of profile data to be written to template file (excluding coordinates)

◆ ~CMarkerProfileReaderFVM()

CMarkerProfileReaderFVM::~CMarkerProfileReaderFVM ( void )

default

Destructor of the CMeshReaderFVM class.

Member Function Documentation

◆ GetColumnForProfile()

vector< su2double > CMarkerProfileReaderFVM::GetColumnForProfile	(	int	val_iProfile,
		unsigned short	iCol
	)		const

inline

Get the data for the specific column if interpolation being done.

Parameters

[in]	val_iProfile	- current profile index.
[in]	iCol	- the column whose data is required

Returns: the specific column data.

◆ GetDataForProfile()

const vector< passivedouble > & CMarkerProfileReaderFVM::GetDataForProfile ( int val_iProfile ) const

inline

Get the 1D vector of data for a profile from the input file.

Parameters

[in] val_iProfile - current profile index.

Returns: 1D vector of data for a profile from the input file.

◆ GetNumberOfColumnsInProfile()

unsigned long CMarkerProfileReaderFVM::GetNumberOfColumnsInProfile ( int val_iProfile )

inline

Get the number of columns of data in a profile.

Parameters

[in] val_iProfile - current profile index.

Returns: Number of columns of data in a profile.

◆ GetNumberOfProfiles()

unsigned long CMarkerProfileReaderFVM::GetNumberOfProfiles ( ) const

inline

Get the number of profiles found within the input file.

Returns: Number of profiles found within the input file.

◆ GetNumberOfRowsInProfile()

unsigned long CMarkerProfileReaderFVM::GetNumberOfRowsInProfile ( int val_iProfile )

inline

Get the number of rows of data in a profile.

Parameters

[in] val_iProfile - current profile index.

Returns: Number of rows of data in a profile.

◆ GetTagForProfile()

const string & CMarkerProfileReaderFVM::GetTagForProfile ( int val_iProfile ) const

inline

Get the string tag for the marker where the profile is applied.

Parameters

[in] val_iProfile - current profile index.

Returns: String tag for the marker where the profile is applied.

Member Data Documentation

◆ columnNames

vector<string> CMarkerProfileReaderFVM::columnNames

protected

string containing all the names of the columns, one for each marker

◆ columnValues

vector<string> CMarkerProfileReaderFVM::columnValues

protected

initial values for the profile, in string format

◆ config

CConfig* CMarkerProfileReaderFVM::config

protected

Local pointer to the config parameter object.

◆ dimension

unsigned short CMarkerProfileReaderFVM::dimension

protected

Dimension of the problem (2 or 3).

◆ filename

string CMarkerProfileReaderFVM::filename

protected

File name of the marker profile file.

◆ geometry

CGeometry* CMarkerProfileReaderFVM::geometry

protected

Local pointer to the geometry object.

◆ markerType

unsigned short CMarkerProfileReaderFVM::markerType

protected

Type of marker where the profiles are being applied.

◆ numberOfColumnsInProfile

vector<unsigned long> CMarkerProfileReaderFVM::numberOfColumnsInProfile

protected

Auxiliary structure for holding the number of columns for a particular marker in a profile file.

◆ numberOfProfiles

unsigned long CMarkerProfileReaderFVM::numberOfProfiles

protected

Auxiliary structure for holding the number of markers in a profile file.

◆ numberOfRowsInProfile

vector<unsigned long> CMarkerProfileReaderFVM::numberOfRowsInProfile

protected

Auxiliary structure for holding the number of rows for a particular marker in a profile file.

◆ numberOfVars

unsigned short CMarkerProfileReaderFVM::numberOfVars

protected

Number of variables added to the number of coordinates to write each line in the template profile file.

◆ profileCoords

vector<vector<vector<su2double> > > CMarkerProfileReaderFVM::profileCoords

protected

Data structure for holding the merged inlet boundary coordinates from all ranks.

◆ profileData

vector<vector<passivedouble> > CMarkerProfileReaderFVM::profileData

protected

Auxiliary structure for holding the data values from a profile file.

◆ profileTags

vector<string> CMarkerProfileReaderFVM::profileTags

protected

Auxiliary structure for holding the string names of the markers in a profile file.

◆ rank

int CMarkerProfileReaderFVM::rank

protected

MPI Rank.

◆ size

int CMarkerProfileReaderFVM::size

protected

MPI Size.

◆ totalColumnNames

vector<string> CMarkerProfileReaderFVM::totalColumnNames

protected

Names of the columns for the profile, one for each inlet marker.

◆ totalColumnValues

vector<string> CMarkerProfileReaderFVM::totalColumnValues

protected

Initial values for the profile, constructed from MARKER_INLET.

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

SU2_CFD/include/CMarkerProfileReaderFVM.hpp
SU2_CFD/src/CMarkerProfileReaderFVM.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CMarkerProfileReaderFVM()

◆ ~CMarkerProfileReaderFVM()

Member Function Documentation

◆ GetColumnForProfile()

◆ GetDataForProfile()

◆ GetNumberOfColumnsInProfile()

◆ GetNumberOfProfiles()

◆ GetNumberOfRowsInProfile()

◆ GetTagForProfile()

Member Data Documentation

◆ columnNames

◆ columnValues

◆ config

◆ dimension

◆ filename

◆ geometry

◆ markerType

◆ numberOfColumnsInProfile

◆ numberOfProfiles

◆ numberOfRowsInProfile

◆ numberOfVars

◆ profileCoords

◆ profileData

◆ profileTags

◆ rank

◆ size

◆ totalColumnNames

◆ totalColumnValues