Class to handle sampling of volume data. More...

#include <samplingdata.h>

Inheritance diagram for VolumeData< nDim, SolverType >:

Collaboration diagram for VolumeData< nDim, SolverType >:

Public Types
using	Base = SamplingData< nDim, SolverType >

Public Member Functions
	VolumeData (SolverType &solver_)

virtual	~VolumeData ()

MString	getBaseName () const override
	Return base name of derived class, e.g. used for naming properties and output file names. More...

void	indexXD (const MInt index, const MInt const nPoints, MInt indexXD)
	Convert 1D index into 2D/3D index. More...

MBool	isMpiRoot () const

MPI_Comm	mpiComm () const

SolverType &	solver ()
	Return reference to solver. More...

const SolverType &	solver () const

MInt	solverId () const

Public Member Functions inherited from SamplingData< nDim, SolverType >
	SamplingData (SolverType &solver)

void	init ()

void	save (MBool finalTimestep)

void	setInputOutputProperties ()

MBool	enabled () const

virtual MInt	loadInputFile (const MString NotUsed(inputFileName), const MInt NotUsed(fileNo), std::vector< MFloat > &NotUsed(coordinates))

virtual MString	getBaseName () const
	Return base name of derived class, e.g. used for naming properties and output file names. More...

Public Attributes
MBool	m_enabled

std::vector< SamplingDataSeries >	m_timeSeries
	Holds all properties and buffers for each input file. More...

Protected Member Functions
MBool	generatePoints () const override
	Always generate points. More...

MBool	hasInputDataFile (const MInt fileNo) const override
	Points are generated not read from file, just check for property 'volumeDataShape_*'. More...

MString	getInputDataFile (const MInt NotUsed(fileNo)) const

void	readAdditionalProperties (const MInt fileNo) override
	Read additional properties for volume sampling. More...

MInt	noSamplingPoints (const MInt fileNo) override
	Return number of volume sampling points. More...

void	getSamplingPoint (const MInt fileNo, const MInt pointId, MFloat *const coordinates) override
	Return sampling point coordinates. More...

Protected Member Functions inherited from SamplingData< nDim, SolverType >
void	init (SamplingDataSeries &timeSeries)

void	save (SamplingDataSeries &timeSeries, MBool finalTimeStep)
	Saves sampling data Saves all states of conservative variables at specified points. Also writes sampling data files in specified intervals. More...

virtual MBool	hasInputDataFile (const MInt fileNo) const
	Check if an input file exists, might be overwritten in derived class if points are generated. More...

virtual MBool	generatePoints () const
	Default behaviour for point generation which can be overwritten in derived class. More...

virtual MInt	noSamplingPoints (const MInt NotUsed(fileNo))
	Return the number of sampling points which are generated by the derived class (no input file) More...

virtual void	getSamplingPoint (const MInt NotUsed(fileNo), const MInt NotUsed(pointId), MFloat *const NotUsed(coordinates))
	Return the coordinates of the sampling point with the given id when generating points. More...

void	indexXD (const MInt index, const MInt const nPoints, MInt indexXD)
	Convert 1D index into 2D/3D index. More...

void	saveSamplingPointCoordinates (SamplingDataSeries &timeSeries)
	Save point coordinates of time series. More...

virtual void	readAdditionalProperties (const MInt NotUsed(fileNo))
	Read additional properties which are required by the derived class. More...

MInt	solverId () const

MBool	isMpiRoot () const

MPI_Comm	mpiComm () const

MInt	noVars () const
	Return total number of sampling variables. More...

MString	getFileBaseName () const
	Return base name of files for used sampling feature. More...

SolverType &	solver ()
	Return reference to solver. More...

const SolverType &	solver () const

Private Attributes
std::vector< MString >	m_volumeShape {}

std::vector< std::vector< MFloat > >	m_volumeParameterFloat {}

std::vector< std::vector< MInt > >	m_volumeParameterInt {}

Additional Inherited Members
Protected Attributes inherited from SamplingData< nDim, SolverType >
MBool	m_enabled = false

MBool	m_interpolatePointData

std::vector< SamplingDataSeries >	m_timeSeries {}
	Holds all properties and buffers for each input file. More...

std::vector< MInt >	m_solverSamplingVarIds {}
	List of sampling variables. More...

std::vector< MInt >	m_noSolverSamplingVars {}
	Number of variables for each sampling variable. More...

std::vector< std::vector< MString > >	m_solverSamplingVarNames {}
	List of variable names for each sampling variable. More...

Detailed Description

template<MInt nDim, class SolverType>
class VolumeData< nDim, SolverType >

Definition at line 220 of file samplingdata.h.

Member Typedef Documentation

◆ Base

template<MInt nDim, class SolverType >

using VolumeData< nDim, SolverType >::Base = SamplingData<nDim, SolverType>

Definition at line 222 of file samplingdata.h.

Constructor & Destructor Documentation

◆ VolumeData()

template<MInt nDim, class SolverType >

VolumeData< nDim, SolverType >::VolumeData ( SolverType & solver_ )

inline

Definition at line 233 of file samplingdata.h.

233: SamplingData<nDim, SolverType>(solver_) {}

SamplingData

This base class is responsible for the sampling data feature that provides the required general metho...

Definition: samplingdata.h:35

◆ ~VolumeData()

template<MInt nDim, class SolverType >

virtual VolumeData< nDim, SolverType >::~VolumeData ( )

inlinevirtual

Definition at line 234 of file samplingdata.h.

234{};

Member Function Documentation

◆ generatePoints()

template<MInt nDim, class SolverType >

MBool VolumeData< nDim, SolverType >::generatePoints ( ) const

inlineoverrideprotectedvirtual

Reimplemented from SamplingData< nDim, SolverType >.

Definition at line 240 of file samplingdata.h.

240{ return true; }

◆ getBaseName()

template<MInt nDim, class SolverType >

MString VolumeData< nDim, SolverType >::getBaseName ( ) const

inlineoverridevirtual

Reimplemented from SamplingData< nDim, SolverType >.

Definition at line 236 of file samplingdata.h.

236{ return "volume"; }

◆ getInputDataFile()

template<MInt nDim, class SolverType >

MString VolumeData< nDim, SolverType >::getInputDataFile ( const MInt NotUsedfileNo ) const

inlineprotected

Definition at line 253 of file samplingdata.h.

                                                             {
    return ""; // No input file, points are generated
  }

◆ getSamplingPoint()

template<MInt nDim, class SolverType >

void VolumeData< nDim, SolverType >::getSamplingPoint	(	const MInt	fileNo,
		const MInt	pointId,
		MFloat *const	coordinates
	)

overrideprotected

Definition at line 1390 of file samplingdata.h.

                                                                                                                    {
  TRACE();
 
  if(pointId < 0 || pointId > noSamplingPoints(fileNo)) {
    TERMM(1, "Invalid point id");
  }
 
  // Generate coordinates depending on volume shape
  std::vector<MInt> indexNd(3);
  if(m_volumeShape[fileNo] == "box") {
    // Points for box are created with [x,y,z] = [i,j,k] ordering, i.e., k varies the fastest
    indexXD(pointId, &m_volumeParameterInt[fileNo][0], &indexNd[0]);
 
    for(MInt i = 0; i < nDim; i++) {
      const MFloat minCoord = m_volumeParameterFloat[fileNo][i];
      const MFloat maxCoord = m_volumeParameterFloat[fileNo][nDim + i];
      const MFloat delta = (maxCoord - minCoord) / static_cast<MFloat>(m_volumeParameterInt[fileNo][i] - 1);
      coordinates[i] = minCoord + indexNd[i] * delta;
    }
  } else if(m_volumeShape[fileNo] == "cylinder") {
    /* TERMM(1, "TODO: test volume data sampling with cylinder shape generation"); */
    // ordering: z, r, phi
    // Note: center point (r=0) only appears once
    const MInt nPointsPerCirc = m_volumeParameterInt[fileNo][1] * m_volumeParameterInt[fileNo][2] + 1;
    indexNd[0] = floor(pointId / nPointsPerCirc); // z
 
    const MInt tmpIndex = pointId - indexNd[0] * nPointsPerCirc;
    indexNd[1] = ceil(static_cast<MFloat>(tmpIndex) / static_cast<MFloat>(m_volumeParameterInt[fileNo][2]));
    indexNd[2] = std::max((tmpIndex - 1) % m_volumeParameterInt[fileNo][2], 0);
 
    const MInt dir = m_volumeParameterInt[fileNo][3];
    const MInt dir2 = (dir == 0) ? 1 : 0;
    const MInt dir3 = 3 - dir - dir2;
 
    const MFloat* startPos = &m_volumeParameterFloat[fileNo][0];
    const MFloat nz = static_cast<MFloat>(m_volumeParameterInt[fileNo][0]);
    const MFloat dist_z = static_cast<MFloat>(indexNd[0]) * (startPos[3] - startPos[dir]) / (nz - 1);
 
    const MFloat r = m_volumeParameterFloat[fileNo][4];
    const MFloat nr = m_volumeParameterInt[fileNo][1];
    const MFloat dist_r = static_cast<MFloat>(indexNd[1]) * r / nr;
 
    const MFloat nphi = m_volumeParameterInt[fileNo][2];
    const MFloat phi = static_cast<MFloat>(indexNd[2]) * 2.0 * PI / nphi;
 
    coordinates[dir] = startPos[dir] + dist_z;
    coordinates[dir2] = startPos[dir2] + dist_r * sin(phi);
    coordinates[dir3] = startPos[dir3] + dist_r * cos(phi);
  } else {
    TERMM(1, "Unknown volume data shape: " + m_volumeShape[fileNo]);
  }
}

◆ hasInputDataFile()

template<MInt nDim, class SolverType >

MBool VolumeData< nDim, SolverType >::hasInputDataFile ( const MInt fileNo ) const

inlineoverrideprotectedvirtual

Reimplemented from SamplingData< nDim, SolverType >.

Definition at line 243 of file samplingdata.h.

                                                           {
    const MString propName = getBaseName() + "DataShape_" + std::to_string(fileNo);
    if(Context::propertyExists(propName, solverId())) {
      const MString shape = Context::getSolverProperty<MString>(propName, solverId(), AT_);
      return shape != "";
    } else {
      return false;
    }
  }

◆ indexXD()

template<MInt nDim, class SolverType >

void SamplingData< nDim, SolverType >::indexXD	(	const MInt	index,
		const MInt *const	nPoints,
		MInt *	indexXD
	)

Convert a one dimensional index into a 2D/3D index with the given number of points per direction (index of last dimension varies the fastest)

Definition at line 109 of file samplingdata.h.

                                                                                                       {
  const MInt noPoints2D = nPoints[0] * nPoints[1];
  const MInt maxNoPoints = (nDim == 2) ? noPoints2D : noPoints2D * nPoints[2];
  if(index < 0 || index >= maxNoPoints) {
    TERMM(1, "invalid index: " + std::to_string(index));
  }
 
  // Last index (varies fastest)
  indexXD[nDim - 1] = index % nPoints[nDim - 1];
  // First/second index in 2D/3D
  indexXD[nDim - 2] = ((index - indexXD[nDim - 1]) / nPoints[nDim - 1]) % nPoints[nDim - 2];
  IF_CONSTEXPR(nDim == 3) {
    // First index in 3D
    indexXD[0] = (index - indexXD[1] * nPoints[1] - indexXD[2]) / (nPoints[2] * nPoints[1]);
  }
}

◆ isMpiRoot()

template<MInt nDim, class SolverType >

MBool SamplingData< nDim, SolverType >::isMpiRoot ( ) const

inline

Definition at line 119 of file samplingdata.h.

119{ return m_solver.domainId() == 0; }

SamplingData::m_solver

SolverType & m_solver

Definition: samplingdata.h:150

◆ mpiComm()

template<MInt nDim, class SolverType >

MPI_Comm SamplingData< nDim, SolverType >::mpiComm ( ) const

inline

Definition at line 120 of file samplingdata.h.

120{ return m_solver.mpiComm(); }

◆ noSamplingPoints()

template<MInt nDim, class SolverType >

MInt VolumeData< nDim, SolverType >::noSamplingPoints ( const MInt fileNo )

overrideprotected

Definition at line 1367 of file samplingdata.h.

                                                                     {
  TRACE();
 
  MInt noPoints = 0;
  if(m_volumeShape[fileNo] == "box") {
    noPoints = 1;
    for(MInt i = 0; i < nDim; i++) {
      noPoints *= m_volumeParameterInt[fileNo][i];
    }
  } else if(m_volumeShape[fileNo] == "cylinder") {
    // nZ * (nPhi * nR + 1) // +1 for center point
    noPoints =
        m_volumeParameterInt[fileNo][0] * (m_volumeParameterInt[fileNo][1] * m_volumeParameterInt[fileNo][2] + 1);
  } else {
    TERMM(1, "Unknown volume data shape: " + m_volumeShape[fileNo]);
  }
 
  return noPoints;
}

◆ readAdditionalProperties()

template<MInt nDim, class SolverType >

void VolumeData< nDim, SolverType >::readAdditionalProperties ( const MInt fileNo )

overrideprotected

Definition at line 1309 of file samplingdata.h.

                                                                             {
  TRACE();
 
  const MString volumeShape =
      Context::getSolverProperty<MString>(getBaseName() + "DataShape_" + std::to_string(fileNo), solverId(), AT_);
 
  MInt noInputValuesFloat = -1;
  MInt noInputValuesInt = -1;
 
  if(volumeShape == "box") {
    // Box defined by two points and number of points in each spatial direction
    noInputValuesFloat = 2 * nDim;
    noInputValuesInt = nDim;
  } else if(volumeShape == "cylinder") {
    IF_CONSTEXPR(nDim == 2) { TERMM(1, "Cylinder shape not defined in 2D."); }
    // Cylinder defined by first center point, second center axial position and radius
    noInputValuesFloat = nDim + 2;
    // TODO labels:PP allow to generate non-equidistant points in radial direction to avoid that lots of
    // points are clustered in the center of the cylinder
    // Number of points in each direction: axial, radial, azimuthal; Cylinder axial direction
    // Note: given number of points in radial direction does not include center point
    noInputValuesInt = nDim + 1;
  } else {
    TERMM(1, "Unknown volume data shape: " + volumeShape);
  }
  m_volumeShape.push_back(volumeShape);
 
  if(noInputValuesFloat < 1 || noInputValuesInt < 1) {
    TERMM(1, "Invalid number of input values for volume data shape " + volumeShape + ": "
                 + std::to_string(noInputValuesFloat) + " " + std::to_string(noInputValuesInt));
  }
 
  m_log << "Volume data #" << fileNo << ": " << volumeShape << " with parameters";
 
  // Read float parameters
  std::vector<MFloat> paramFloat(noInputValuesFloat);
  for(MInt i = 0; i < noInputValuesFloat; i++) {
    paramFloat[i] = Context::getSolverProperty<MFloat>(getBaseName() + "DataParameterFloat_" + std::to_string(fileNo),
                                                       solverId(), AT_, i);
    m_log << " " << paramFloat[i];
  }
  m_volumeParameterFloat.push_back(paramFloat);
 
  // Read int parameters
  std::vector<MInt> paramInt(noInputValuesInt);
  for(MInt i = 0; i < noInputValuesInt; i++) {
    paramInt[i] = Context::getSolverProperty<MInt>(getBaseName() + "DataParameterInt_" + std::to_string(fileNo),
                                                   solverId(), AT_, i);
    m_log << " " << paramInt[i];
  }
  m_volumeParameterInt.push_back(paramInt);
 
  m_log << std::endl;
}

◆ solver() [1/2]

template<MInt nDim, class SolverType >

SolverType & SamplingData< nDim, SolverType >::solver ( )

inline

Definition at line 129 of file samplingdata.h.

129{ return m_solver; }

◆ solver() [2/2]

template<MInt nDim, class SolverType >

const SolverType & SamplingData< nDim, SolverType >::solver ( ) const

inline

Definition at line 130 of file samplingdata.h.

130{ return m_solver; }

◆ solverId()

template<MInt nDim, class SolverType >

MInt SamplingData< nDim, SolverType >::solverId ( ) const

inline

Definition at line 118 of file samplingdata.h.

118{ return m_solver.solverId(); }

Member Data Documentation

◆ m_enabled

template<MInt nDim, class SolverType >

MBool SamplingData< nDim, SolverType >::m_enabled

Definition at line 134 of file samplingdata.h.

◆ m_timeSeries

template<MInt nDim, class SolverType >

std::vector<SamplingDataSeries> SamplingData< nDim, SolverType >::m_timeSeries

Definition at line 138 of file samplingdata.h.

◆ m_volumeParameterFloat

template<MInt nDim, class SolverType >

std::vector<std::vector<MFloat> > VolumeData< nDim, SolverType >::m_volumeParameterFloat {}

private

Definition at line 266 of file samplingdata.h.

◆ m_volumeParameterInt

template<MInt nDim, class SolverType >

std::vector<std::vector<MInt> > VolumeData< nDim, SolverType >::m_volumeParameterInt {}

private

Definition at line 267 of file samplingdata.h.

◆ m_volumeShape

template<MInt nDim, class SolverType >

std::vector<MString> VolumeData< nDim, SolverType >::m_volumeShape {}

private

Storage for volume parameters (shape; floating point values, e.g. coordinates; integer parameters, i.e. number of points)

Definition at line 265 of file samplingdata.h.

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

/home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/POST/samplingdata.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ VolumeData()

◆ ~VolumeData()

Member Function Documentation

◆ generatePoints()

◆ getBaseName()

◆ getInputDataFile()

◆ getSamplingPoint()

◆ hasInputDataFile()

◆ indexXD()

◆ isMpiRoot()

◆ mpiComm()

◆ noSamplingPoints()

◆ readAdditionalProperties()

◆ solver() [1/2]

◆ solver() [2/2]

◆ solverId()

Member Data Documentation

◆ m_enabled

◆ m_timeSeries

◆ m_volumeParameterFloat

◆ m_volumeParameterInt

◆ m_volumeShape