Base class for the reading of a native SU2 binary grid. More...

#include <CSU2BinaryMeshReaderBase.hpp>

Inheritance diagram for CSU2BinaryMeshReaderBase:

Public Member Functions
	CSU2BinaryMeshReaderBase (CConfig *val_config, unsigned short val_iZone, unsigned short val_nZone)
	Constructor of the CSU2BinaryMeshReaderBase class.

	~CSU2BinaryMeshReaderBase (void) override
	Destructor of the CSU2BinaryMeshReaderBase class.

Public Member Functions inherited from CSU2MeshReaderBase
	CSU2MeshReaderBase (CConfig *val_config, unsigned short val_iZone, unsigned short val_nZone)
	Constructor of the CSU2MeshReaderBase class.

	~CSU2MeshReaderBase (void) override
	Destructor of the CSU2MeshReaderBase class.

Public Member Functions inherited from CMeshReaderBase
	CMeshReaderBase (const CConfig *val_config, unsigned short val_iZone, unsigned short val_nZone)
	Constructor of the CMeshReaderBase class.

virtual	~CMeshReaderBase ()=default

unsigned short	GetDimension () const
	Get the physical dimension of the problem (2 or 3).

const vector< unsigned long > &	GetGlobalPointIDs () const
	Get the global IDs of the local points.

const vector< vector< passivedouble > > &	GetLocalPointCoordinates () const
	Get the local point coordinates (linearly partitioned).

const vector< unsigned long > &	GetSurfaceElementConnectivityForMarker (int val_iMarker) const
	Get the surface element connectivity for the specified marker. Only the master node owns the surface connectivity.

const vector< unsigned long > &	GetNumberOfSurfaceElementsAllMarkers () const
	Get the number surface elements for all markers.

unsigned long	GetNumberOfSurfaceElementsForMarker (int val_iMarker) const
	Get the number surface elements for the specified marker.

const vector< unsigned long > &	GetLocalVolumeElementConnectivity () const
	Get the local volume element connectivity (linearly partitioned).

unsigned long	GetNumberOfMarkers () const
	Get the total number of markers in the mesh zone.

const vector< string > &	GetMarkerNames () const
	Get the vector of string names for all markers in the mesh zone.

unsigned long	GetNumberOfLocalPoints () const
	Get the number of local grid points within the linear partition on this rank.

unsigned long	GetNumberOfGlobalPoints () const
	Get the number of global grid points within the mesh file.

unsigned long	GetNumberOfLocalElements () const
	Get the number of local elements within the linear partition on this rank.

unsigned long	GetNumberOfGlobalElements () const
	Get the number of global elements within the mesh file.

Protected Member Functions
void	ReadConnectivityType ()
	Reads the connectivity type used in the binary file and check if byte swapping must be applied.

void	ReadMetadata (CConfig *config)
	Reads all SU2 binary mesh metadata and checks for errors.

virtual void	ReadPointCoordinates ()
	Reads the grid points from an SU2 zone into linear partitions across all ranks.

virtual void	ReadVolumeElementConnectivity ()
	Reads the interior volume elements from one section of an SU2 zone into linear partitions across all ranks.

virtual void	ReadSurfaceElementConnectivity ()
	Reads the surface (boundary) elements from the SU2 zone.

void	FastForwardToMyZone ()
	Helper function to find the current zone in an SU2 binary mesh object.

uint64_t	ReadBinaryNEntities ()
	Function to read one entity of the connectivity type from the binary file.

template<typename T >
void	ReadBinaryData (T *data, const size_t nItems)
	Template function to read data from the binary file.

Protected Member Functions inherited from CMeshReaderBase
void	DetermineFacesVolumeElements (vector< CFaceOfElement > &localFaces)
	Function, which determines the faces of the local volume elements.

void	GetCornerPointsAllFaces (const unsigned long *elemInfo, unsigned short &numFaces, unsigned short nPointsPerFace[], unsigned long faceConn[6][4])
	Get all the corner points of all the faces of the given element. It must.

void	CopyMarkers (const std::vector< std::string > &srcDstMarkers)
	Creates copies of some markers.

Static Protected Member Functions
static int	FileSeek64 (FILE *file, int64_t offset, int whence)
	Portable, 64-bit safe replacement for fseek. Needed because binary SU2 grid files can exceed 2 GiB even on platforms where "long" is only 32 bits wide (e.g. Windows).

static int64_t	FileTell64 (FILE *file)
	Portable, 64-bit safe replacement for ftell.

Protected Attributes
FILE *	mesh_file
	File object for the SU2 binary mesh file.

bool	swap_bytes
	Whether or not byte swapping must be used.

int	size_conn_type
	Size, in bytes of the connectivity type.

Protected Attributes inherited from CSU2MeshReaderBase
const unsigned short	myZone
	Current SU2 zone index.

const unsigned short	nZones
	Total number of zones in the SU2 file.

const string	meshFilename
	Name of the SU2 ASCII mesh file being read.

bool	actuator_disk
	Boolean for whether we have an actuator disk to split.

unsigned long	ActDiskNewPoints
	Total number of new grid points to add due to actuator disk splitting.

su2double	Xloc = 0.0
	X-coordinate of the CG of the actuator disk surface.

su2double	Yloc = 0.0
	X-coordinate of the CG of the actuator disk surface.

su2double	Zloc = 0.0
	X-coordinate of the CG of the actuator disk surface.

vector< bool >	ActDisk_Bool
	Flag to identify the grid points on the actuator disk.

vector< unsigned long >	ActDiskPoint_Back
	Vector containing the global index for the new grid points added to the back of the actuator disk.

vector< unsigned long >	VolumePoint_Inv
	Vector containing the inverse mapping from the global index to the added point index for the actuator disk.

vector< su2double >	CoordXActDisk
	X-coordinates of the new grid points added by splitting the actuator disk (size = ActDiskNewPoints).

vector< su2double >	CoordYActDisk
	Y-coordinates of the new grid points added by splitting the actuator disk (size = ActDiskNewPoints).

vector< su2double >	CoordZActDisk
	Z-coordinates of the new grid points added by splitting the actuator disk (size = ActDiskNewPoints).

vector< su2double >	CoordXVolumePoint
	X-coordinates of the volume elements touching the actuator disk.

vector< su2double >	CoordYVolumePoint
	Y-coordinates of the volume elements touching the actuator disk.

vector< su2double >	CoordZVolumePoint
	Z-coordinates of the volume elements touching the actuator disk.

Protected Attributes inherited from CMeshReaderBase
const int	rank
	MPI Rank.

const int	size
	MPI Size.

const CConfig *	config = nullptr
	Local pointer to the config parameter object.

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

unsigned long	numberOfLocalPoints
	Number of local grid points within the linear partition on this rank.

unsigned long	numberOfGlobalPoints = 0
	Number of global grid points within the mesh file.

vector< vector< passivedouble > >	localPointCoordinates
	Vector holding the coordinates from the mesh file for the local grid points. First index is dimension, second is point index.

vector< unsigned long >	globalPointIDs
	Vector holding the global IDs of the local grid points.

unsigned long	numberOfLocalElements
	Number of local elements within the linear partition on this rank.

unsigned long	numberOfGlobalElements = 0
	Number of global elements within the mesh file.

vector< unsigned long >	localVolumeElementConnectivity
	Vector containing the element connectivity from the mesh file for the local elements.

unsigned long	numberOfMarkers = 0
	Total number of markers contained within the mesh file.

vector< string >	markerNames
	String names for all markers in the mesh file.

vector< unsigned long >	numberOfLocalSurfaceElements
	Vector containing the number of local surface elements.

vector< vector< unsigned long > >	surfaceElementConnectivity
	Vector containing the surface element connectivity from the mesh file on a per-marker basis. For FVM, only the master node reads and stores this connectivity.

Static Protected Attributes
static constexpr int	SU2_STRING_SIZE
	Size of the strings in the SU2 binary mesh file.

Detailed Description

Base class for the reading of a native SU2 binary grid.

Author: T. Economon, E. van der Weide

Constructor & Destructor Documentation

◆ CSU2BinaryMeshReaderBase()

CSU2BinaryMeshReaderBase::CSU2BinaryMeshReaderBase	(	CConfig *	val_config,
		unsigned short	val_iZone,
		unsigned short	val_nZone
	)

Constructor of the CSU2BinaryMeshReaderBase class.

◆ ~CSU2BinaryMeshReaderBase()

CSU2BinaryMeshReaderBase::~CSU2BinaryMeshReaderBase ( void )

overridedefault

Destructor of the CSU2BinaryMeshReaderBase class.

Member Function Documentation

◆ FastForwardToMyZone()

void CSU2BinaryMeshReaderBase::FastForwardToMyZone ( )

protected

Helper function to find the current zone in an SU2 binary mesh object.

◆ FileSeek64()

int CSU2BinaryMeshReaderBase::FileSeek64	(	FILE *	file,
		int64_t	offset,
		int	whence
	)

staticprotected

Portable, 64-bit safe replacement for fseek. Needed because binary SU2 grid files can exceed 2 GiB even on platforms where "long" is only 32 bits wide (e.g. Windows).

◆ FileTell64()

int64_t CSU2BinaryMeshReaderBase::FileTell64 ( FILE * file )

staticprotected

Portable, 64-bit safe replacement for ftell.

◆ ReadBinaryData()

template<typename T >

void CSU2BinaryMeshReaderBase::ReadBinaryData	(	T *	data,
		const size_t	nItems
	)

inlineprotected

Template function to read data from the binary file.

◆ ReadBinaryNEntities()

uint64_t CSU2BinaryMeshReaderBase::ReadBinaryNEntities ( )

protected

Function to read one entity of the connectivity type from the binary file.

Returns: uint64_t version of the the data.

◆ ReadConnectivityType()

void CSU2BinaryMeshReaderBase::ReadConnectivityType ( )

protected

Reads the connectivity type used in the binary file and check if byte swapping must be applied.

◆ ReadMetadata()

void CSU2BinaryMeshReaderBase::ReadMetadata ( CConfig * config )

protected

Reads all SU2 binary mesh metadata and checks for errors.

Parameters

[in] config - Problem configuration for the current zone.

◆ ReadPointCoordinates()

void CSU2BinaryMeshReaderBase::ReadPointCoordinates ( )

protectedvirtual

Reads the grid points from an SU2 zone into linear partitions across all ranks.

◆ ReadSurfaceElementConnectivity()

void CSU2BinaryMeshReaderBase::ReadSurfaceElementConnectivity ( )

protectedvirtual

Reads the surface (boundary) elements from the SU2 zone.

◆ ReadVolumeElementConnectivity()

void CSU2BinaryMeshReaderBase::ReadVolumeElementConnectivity ( )

protectedvirtual

Reads the interior volume elements from one section of an SU2 zone into linear partitions across all ranks.

TODO: Use a compressed format.

Member Data Documentation

◆ mesh_file

FILE* CSU2BinaryMeshReaderBase::mesh_file

protected

File object for the SU2 binary mesh file.

◆ size_conn_type

int CSU2BinaryMeshReaderBase::size_conn_type

protected

Size, in bytes of the connectivity type.

◆ SU2_STRING_SIZE

constexpr int CSU2BinaryMeshReaderBase::SU2_STRING_SIZE

staticconstexprprotected

Initial value:

=

SU2_BINARY_STRING_SIZE

const int SU2_BINARY_STRING_SIZE

Length of strings (e.g. marker names) used in the native SU2 binary mesh format. Shared by CSU2Binary...

Definition option_structure.hpp:263

Size of the strings in the SU2 binary mesh file.

◆ swap_bytes

bool CSU2BinaryMeshReaderBase::swap_bytes

protected

Whether or not byte swapping must be used.

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

Common/include/geometry/meshreader/CSU2BinaryMeshReaderBase.hpp
Common/src/geometry/meshreader/CSU2BinaryMeshReaderBase.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CSU2BinaryMeshReaderBase()

◆ ~CSU2BinaryMeshReaderBase()

Member Function Documentation

◆ FastForwardToMyZone()

◆ FileSeek64()

◆ FileTell64()

◆ ReadBinaryData()

◆ ReadBinaryNEntities()

◆ ReadConnectivityType()

◆ ReadMetadata()

◆ ReadPointCoordinates()

◆ ReadSurfaceElementConnectivity()

◆ ReadVolumeElementConnectivity()

Member Data Documentation

◆ mesh_file

◆ size_conn_type

◆ SU2_STRING_SIZE

◆ swap_bytes