Base class for the mesh zone readers. More...

#include <CMeshReaderBase.hpp>

Inheritance diagram for CMeshReaderBase:

Public Member Functions
	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	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.

Protected Attributes
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.

Detailed Description

Base class for the mesh zone readers.

Author: T. Economon

Constructor & Destructor Documentation

◆ CMeshReaderBase()

CMeshReaderBase::CMeshReaderBase	(	const CConfig *	val_config,
		unsigned short	val_iZone,
		unsigned short	val_nZone
	)

Constructor of the CMeshReaderBase class.

Parameters

[in]	val_config	- config object for the current zone.
[in]	val_iZone	- Current zone index.
[in]	val_nZone	- Total number of zones.

◆ ~CMeshReaderBase()

virtual CMeshReaderBase::~CMeshReaderBase ( )

virtualdefault

Member Function Documentation

◆ CopyMarkers()

void CMeshReaderBase::CopyMarkers ( const std::vector< std::string > & srcDstMarkers )

protected

Creates copies of some markers.

Parameters

[in] srcDstMarkers - List of marker names [src_1, dst_1, ..., src_n, dst_n].

◆ DetermineFacesVolumeElements()

void CMeshReaderBase::DetermineFacesVolumeElements ( vector< CFaceOfElement > & localFaces )

protected

Function, which determines the faces of the local volume elements.

Parameters

[out] localFaces - The faces of the locally stored volume elements.

◆ GetCornerPointsAllFaces()

void CMeshReaderBase::GetCornerPointsAllFaces	(	const unsigned long *	elemInfo,
		unsigned short &	numFaces,
		unsigned short	nPointsPerFace[],
		unsigned long	faceConn[6][4]
	)

protected

Get all the corner points of all the faces of the given element. It must.

Parameters

[in]	elemInfo	- Array, which contains the info of the given element.
[out]	nFaces	- Number of faces of the element.
[out]	nPointsPerFace	- Number of corner points for each of the faces.
[out]	faceConn	- Global IDs of the corner points of the faces.

◆ GetDimension()

unsigned short CMeshReaderBase::GetDimension ( ) const

inline

Get the physical dimension of the problem (2 or 3).

Returns: Physical dimension of the problem.

◆ GetGlobalPointIDs()

const vector< unsigned long > & CMeshReaderBase::GetGlobalPointIDs ( ) const

inline

Get the global IDs of the local points.

Returns: Reference to the vector containing the global points IDs.

◆ GetLocalPointCoordinates()

const vector< vector< passivedouble > > & CMeshReaderBase::GetLocalPointCoordinates ( ) const

inline

Get the local point coordinates (linearly partitioned).

Returns: Local point coordinates (linear partitioned).

◆ GetLocalVolumeElementConnectivity()

const vector< unsigned long > & CMeshReaderBase::GetLocalVolumeElementConnectivity ( ) const

inline

Get the local volume element connectivity (linearly partitioned).

Returns: Local volume element connectivity (linearly partitioned).

◆ GetMarkerNames()

const vector< string > & CMeshReaderBase::GetMarkerNames ( ) const

inline

Get the vector of string names for all markers in the mesh zone.

Returns: Vector of string names for all markers in the mesh zone.

◆ GetNumberOfGlobalElements()

unsigned long CMeshReaderBase::GetNumberOfGlobalElements ( ) const

inline

Get the number of global elements within the mesh file.

Returns: Number of global elements within the mesh file.

◆ GetNumberOfGlobalPoints()

unsigned long CMeshReaderBase::GetNumberOfGlobalPoints ( ) const

inline

Get the number of global grid points within the mesh file.

Returns: Number of global grid points within the mesh file.

◆ GetNumberOfLocalElements()

unsigned long CMeshReaderBase::GetNumberOfLocalElements ( ) const

inline

Get the number of local elements within the linear partition on this rank.

Returns: Number of local elements within the linear partition on this rank.

◆ GetNumberOfLocalPoints()

unsigned long CMeshReaderBase::GetNumberOfLocalPoints ( ) const

inline

Get the number of local grid points within the linear partition on this rank.

Returns: Number of local grid points within the linear partition on this rank.

◆ GetNumberOfMarkers()

unsigned long CMeshReaderBase::GetNumberOfMarkers ( ) const

inline

Get the total number of markers in the mesh zone.

Returns: Total number of markers in the mesh zone.

◆ GetNumberOfSurfaceElementsAllMarkers()

const vector< unsigned long > & CMeshReaderBase::GetNumberOfSurfaceElementsAllMarkers ( ) const

inline

Get the number surface elements for all markers.

Returns: Reference to the vector containing the number of surface elements for all markers.

◆ GetNumberOfSurfaceElementsForMarker()

unsigned long CMeshReaderBase::GetNumberOfSurfaceElementsForMarker ( int val_iMarker ) const

inline

Get the number surface elements for the specified marker.

Parameters

[in] val_iMarker - current marker index.

Returns: Number of surface elements for a marker.

◆ GetSurfaceElementConnectivityForMarker()

const vector< unsigned long > & CMeshReaderBase::GetSurfaceElementConnectivityForMarker ( int val_iMarker ) const

inline

Get the surface element connectivity for the specified marker. Only the master node owns the surface connectivity.

Parameters

[in] val_iMarker - current marker index.

Returns: Surface element connecitivity for a marker from the master rank.

Member Data Documentation

◆ config

const CConfig* CMeshReaderBase::config = nullptr

protected

Local pointer to the config parameter object.

◆ dimension

unsigned short CMeshReaderBase::dimension = 0

protected

Dimension of the problem (2 or 3).

◆ globalPointIDs

vector<unsigned long> CMeshReaderBase::globalPointIDs

protected

Vector holding the global IDs of the local grid points.

◆ localPointCoordinates

vector<vector<passivedouble> > CMeshReaderBase::localPointCoordinates

protected

Vector holding the coordinates from the mesh file for the local grid points. First index is dimension, second is point index.

◆ localVolumeElementConnectivity

vector<unsigned long> CMeshReaderBase::localVolumeElementConnectivity

protected

Vector containing the element connectivity from the mesh file for the local elements.

◆ markerNames

vector<string> CMeshReaderBase::markerNames

protected

String names for all markers in the mesh file.

◆ numberOfGlobalElements

unsigned long CMeshReaderBase::numberOfGlobalElements = 0

protected

Number of global elements within the mesh file.

◆ numberOfGlobalPoints

unsigned long CMeshReaderBase::numberOfGlobalPoints = 0

protected

Number of global grid points within the mesh file.

◆ numberOfLocalElements

unsigned long CMeshReaderBase::numberOfLocalElements

protected

Initial value:

=

0

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

◆ numberOfLocalPoints

unsigned long CMeshReaderBase::numberOfLocalPoints

protected

Initial value:

=

0

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

◆ numberOfLocalSurfaceElements

vector<unsigned long> CMeshReaderBase::numberOfLocalSurfaceElements

protected

Vector containing the number of local surface elements.

◆ numberOfMarkers

unsigned long CMeshReaderBase::numberOfMarkers = 0

protected

Total number of markers contained within the mesh file.

◆ rank

const int CMeshReaderBase::rank

protected

MPI Rank.

◆ size

const int CMeshReaderBase::size

protected

MPI Size.

◆ surfaceElementConnectivity

vector<vector<unsigned long> > CMeshReaderBase::surfaceElementConnectivity

protected

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.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CMeshReaderBase()

◆ ~CMeshReaderBase()

Member Function Documentation

◆ CopyMarkers()

◆ DetermineFacesVolumeElements()

◆ GetCornerPointsAllFaces()

◆ GetDimension()

◆ GetGlobalPointIDs()

◆ GetLocalPointCoordinates()

◆ GetLocalVolumeElementConnectivity()

◆ GetMarkerNames()

◆ GetNumberOfGlobalElements()

◆ GetNumberOfGlobalPoints()

◆ GetNumberOfLocalElements()

◆ GetNumberOfLocalPoints()

◆ GetNumberOfMarkers()

◆ GetNumberOfSurfaceElementsAllMarkers()

◆ GetNumberOfSurfaceElementsForMarker()

◆ GetSurfaceElementConnectivityForMarker()

Member Data Documentation

◆ config

◆ dimension

◆ globalPointIDs

◆ localPointCoordinates

◆ localVolumeElementConnectivity

◆ markerNames

◆ numberOfGlobalElements

◆ numberOfGlobalPoints

◆ numberOfLocalElements

◆ numberOfLocalPoints

◆ numberOfLocalSurfaceElements

◆ numberOfMarkers

◆ rank

◆ size

◆ surfaceElementConnectivity