probes Class Reference

Handles the writing of data from probes placed in the domain. More...

#include "lib/io/probes.h"

Public Member Functions
	probes (const grid &mesh, std::vector< field > &pFields)
	Constructor of the probes class. More...
void	probeData (real time)
	Function to read the variables at the probe locations and return them. More...

Detailed Description

Handles the writing of data from probes placed in the domain.

The class places the probes in probesList provided by user through the parser class. It also provides an interface to the solver to read data from the probes.

Constructor & Destructor Documentation

probes()

probes::probes	(	const grid &	mesh,
		std::vector< field > &	pFields
	)

Constructor of the probes class.

     The constructor initializes the variables and parameters for writing probed data
     The header for the ProbeData.dat file is also written here.
     Depending on whether the run is 2D or 3D, the appropriate header is written.
     Finally, the MPIStruct datatype for transferring probed data across processors is also initialized.

Parameters

mesh	is a const reference to the global data contained in the grid class.
pFields	is a vector containing a list of references to all the fields which need to be probed.

Member Function Documentation

probeData()

void probes::probeData

(

real

time

)

Function to read the variables at the probe locations and return them.

     For each variable specified in the list of fields given to the constructor, obtain the value at the probe locations.

---

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

• lib/io/probes.h
• lib/io/probes.cc